Documentation ¶
Overview ¶
Package connectparticipant provides the client and types for making API requests to Amazon Connect Participant.
Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect enables customer contacts through voice or chat.
The APIs described here are used by chat participants, such as agents and customers.
See https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07 for more information on this service.
See connectparticipant package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/connectparticipant/
Using the Client ¶
To use Amazon Connect Participant with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Connect Participant client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/connectparticipant/#New
Index ¶
- Constants
- type ChatItemType
- type Client
- func (c *Client) CreateParticipantConnectionRequest(input *CreateParticipantConnectionInput) CreateParticipantConnectionRequest
- func (c *Client) DisconnectParticipantRequest(input *DisconnectParticipantInput) DisconnectParticipantRequest
- func (c *Client) GetTranscriptRequest(input *GetTranscriptInput) GetTranscriptRequest
- func (c *Client) SendEventRequest(input *SendEventInput) SendEventRequest
- func (c *Client) SendMessageRequest(input *SendMessageInput) SendMessageRequest
- type ConnectionCredentials
- type ConnectionType
- type CreateParticipantConnectionInput
- type CreateParticipantConnectionOutput
- type CreateParticipantConnectionRequest
- type CreateParticipantConnectionResponse
- type DisconnectParticipantInput
- type DisconnectParticipantOutput
- type DisconnectParticipantRequest
- type DisconnectParticipantResponse
- type GetTranscriptInput
- type GetTranscriptOutput
- type GetTranscriptPaginator
- type GetTranscriptRequest
- type GetTranscriptResponse
- type Item
- type ParticipantRole
- type ScanDirection
- type SendEventInput
- type SendEventOutput
- type SendEventRequest
- type SendEventResponse
- type SendMessageInput
- type SendMessageOutput
- type SendMessageRequest
- type SendMessageResponse
- type SortKey
- type StartPosition
- type Websocket
Constants ¶
const ( ServiceName = "Amazon Connect Participant" // Service's name ServiceID = "ConnectParticipant" // Service's identifier EndpointsID = "participant.connect" // Service's Endpoint identifier )
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You do not have sufficient access to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // This exception occurs when there is an internal failure in the Amazon Connect // service. ErrCodeInternalServerException = "InternalServerException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // // The request was denied due to request throttling. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // // The input fails to satisfy the constraints specified by Amazon Connect. ErrCodeValidationException = "ValidationException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChatItemType ¶
type ChatItemType string
const ( ChatItemTypeMessage ChatItemType = "MESSAGE" ChatItemTypeEvent ChatItemType = "EVENT" ChatItemTypeConnectionAck ChatItemType = "CONNECTION_ACK" )
Enum values for ChatItemType
func (ChatItemType) MarshalValue ¶
func (enum ChatItemType) MarshalValue() (string, error)
func (ChatItemType) MarshalValueBuf ¶
func (enum ChatItemType) MarshalValueBuf(b []byte) ([]byte, error)
type Client ¶
Client provides the API operation methods for making requests to Amazon Connect Participant. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := connectparticipant.New(myConfig)
func (*Client) CreateParticipantConnectionRequest ¶
func (c *Client) CreateParticipantConnectionRequest(input *CreateParticipantConnectionInput) CreateParticipantConnectionRequest
CreateParticipantConnectionRequest returns a request value for making API operation for Amazon Connect Participant Service.
Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.
The participant token is valid for the lifetime of the participant – until the they are part of a contact.
The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.
For chat, you need to publish the following on the established websocket connection:
{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.
// Example sending a request using CreateParticipantConnectionRequest. req := client.CreateParticipantConnectionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnection
func (*Client) DisconnectParticipantRequest ¶
func (c *Client) DisconnectParticipantRequest(input *DisconnectParticipantInput) DisconnectParticipantRequest
DisconnectParticipantRequest returns a request value for making API operation for Amazon Connect Participant Service.
Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
// Example sending a request using DisconnectParticipantRequest. req := client.DisconnectParticipantRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DisconnectParticipant
func (*Client) GetTranscriptRequest ¶
func (c *Client) GetTranscriptRequest(input *GetTranscriptInput) GetTranscriptRequest
GetTranscriptRequest returns a request value for making API operation for Amazon Connect Participant Service.
Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
// Example sending a request using GetTranscriptRequest. req := client.GetTranscriptRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetTranscript
func (*Client) SendEventRequest ¶
func (c *Client) SendEventRequest(input *SendEventInput) SendEventRequest
SendEventRequest returns a request value for making API operation for Amazon Connect Participant Service.
Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
// Example sending a request using SendEventRequest. req := client.SendEventRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendEvent
func (*Client) SendMessageRequest ¶
func (c *Client) SendMessageRequest(input *SendMessageInput) SendMessageRequest
SendMessageRequest returns a request value for making API operation for Amazon Connect Participant Service.
Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
// Example sending a request using SendMessageRequest. req := client.SendMessageRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendMessage
type ConnectionCredentials ¶
type ConnectionCredentials struct { // The connection token. ConnectionToken *string `min:"1" type:"string"` // The expiration of the token. // // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, // 2019-11-08T02:41:28.172Z. Expiry *string `type:"string"` // contains filtered or unexported fields }
Connection credentials.
func (ConnectionCredentials) MarshalFields ¶
func (s ConnectionCredentials) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ConnectionCredentials) String ¶
func (s ConnectionCredentials) String() string
String returns the string representation
type ConnectionType ¶
type ConnectionType string
const ( ConnectionTypeWebsocket ConnectionType = "WEBSOCKET" ConnectionTypeConnectionCredentials ConnectionType = "CONNECTION_CREDENTIALS" )
Enum values for ConnectionType
func (ConnectionType) MarshalValue ¶
func (enum ConnectionType) MarshalValue() (string, error)
func (ConnectionType) MarshalValueBuf ¶
func (enum ConnectionType) MarshalValueBuf(b []byte) ([]byte, error)
type CreateParticipantConnectionInput ¶
type CreateParticipantConnectionInput struct { // Participant Token as obtained from StartChatContact (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContactResponse.html) // API response. // // ParticipantToken is a required field ParticipantToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` // Type of connection information required. // // Type is a required field Type []ConnectionType `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (CreateParticipantConnectionInput) MarshalFields ¶
func (s CreateParticipantConnectionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateParticipantConnectionInput) String ¶
func (s CreateParticipantConnectionInput) String() string
String returns the string representation
func (*CreateParticipantConnectionInput) Validate ¶
func (s *CreateParticipantConnectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateParticipantConnectionOutput ¶
type CreateParticipantConnectionOutput struct { // Creates the participant's connection credentials. The authentication token // associated with the participant's connection. ConnectionCredentials *ConnectionCredentials `type:"structure"` // Creates the participant's websocket connection. Websocket *Websocket `type:"structure"` // contains filtered or unexported fields }
func (CreateParticipantConnectionOutput) MarshalFields ¶
func (s CreateParticipantConnectionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateParticipantConnectionOutput) String ¶
func (s CreateParticipantConnectionOutput) String() string
String returns the string representation
type CreateParticipantConnectionRequest ¶
type CreateParticipantConnectionRequest struct { *aws.Request Input *CreateParticipantConnectionInput Copy func(*CreateParticipantConnectionInput) CreateParticipantConnectionRequest }
CreateParticipantConnectionRequest is the request type for the CreateParticipantConnection API operation.
func (CreateParticipantConnectionRequest) Send ¶
func (r CreateParticipantConnectionRequest) Send(ctx context.Context) (*CreateParticipantConnectionResponse, error)
Send marshals and sends the CreateParticipantConnection API request.
type CreateParticipantConnectionResponse ¶
type CreateParticipantConnectionResponse struct { *CreateParticipantConnectionOutput // contains filtered or unexported fields }
CreateParticipantConnectionResponse is the response type for the CreateParticipantConnection API operation.
func (*CreateParticipantConnectionResponse) SDKResponseMetdata ¶
func (r *CreateParticipantConnectionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateParticipantConnection request.
type DisconnectParticipantInput ¶
type DisconnectParticipantInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` // The authentication token associated with the participant's connection. // // ConnectionToken is a required field ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DisconnectParticipantInput) MarshalFields ¶
func (s DisconnectParticipantInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DisconnectParticipantInput) String ¶
func (s DisconnectParticipantInput) String() string
String returns the string representation
func (*DisconnectParticipantInput) Validate ¶
func (s *DisconnectParticipantInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisconnectParticipantOutput ¶
type DisconnectParticipantOutput struct {
// contains filtered or unexported fields
}
func (DisconnectParticipantOutput) MarshalFields ¶
func (s DisconnectParticipantOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DisconnectParticipantOutput) String ¶
func (s DisconnectParticipantOutput) String() string
String returns the string representation
type DisconnectParticipantRequest ¶
type DisconnectParticipantRequest struct { *aws.Request Input *DisconnectParticipantInput Copy func(*DisconnectParticipantInput) DisconnectParticipantRequest }
DisconnectParticipantRequest is the request type for the DisconnectParticipant API operation.
func (DisconnectParticipantRequest) Send ¶
func (r DisconnectParticipantRequest) Send(ctx context.Context) (*DisconnectParticipantResponse, error)
Send marshals and sends the DisconnectParticipant API request.
type DisconnectParticipantResponse ¶
type DisconnectParticipantResponse struct { *DisconnectParticipantOutput // contains filtered or unexported fields }
DisconnectParticipantResponse is the response type for the DisconnectParticipant API operation.
func (*DisconnectParticipantResponse) SDKResponseMetdata ¶
func (r *DisconnectParticipantResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DisconnectParticipant request.
type GetTranscriptInput ¶
type GetTranscriptInput struct { // The authentication token associated with the participant's connection. // // ConnectionToken is a required field ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` // The contactId from the current contact chain for which transcript is needed. ContactId *string `min:"1" type:"string"` // The maximum number of results to return in the page. Default: 10. MaxResults *int64 `type:"integer"` // The pagination token. Use the value returned previously in the next subsequent // request to retrieve the next set of results. NextToken *string `min:"1" type:"string"` // The direction from StartPosition from which to retrieve message. Default: // BACKWARD when no StartPosition is provided, FORWARD with StartPosition. ScanDirection ScanDirection `type:"string" enum:"true"` // The sort order for the records. Default: DESCENDING. SortOrder SortKey `type:"string" enum:"true"` // A filtering option for where to start. StartPosition *StartPosition `type:"structure"` // contains filtered or unexported fields }
func (GetTranscriptInput) MarshalFields ¶
func (s GetTranscriptInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetTranscriptInput) String ¶
func (s GetTranscriptInput) String() string
String returns the string representation
func (*GetTranscriptInput) Validate ¶
func (s *GetTranscriptInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTranscriptOutput ¶
type GetTranscriptOutput struct { // The initial contact ID for the contact. InitialContactId *string `min:"1" type:"string"` // The pagination token. Use the value returned previously in the next subsequent // request to retrieve the next set of results. NextToken *string `min:"1" type:"string"` // The list of messages in the session. Transcript []Item `type:"list"` // contains filtered or unexported fields }
func (GetTranscriptOutput) MarshalFields ¶
func (s GetTranscriptOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetTranscriptOutput) String ¶
func (s GetTranscriptOutput) String() string
String returns the string representation
type GetTranscriptPaginator ¶
GetTranscriptPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetTranscriptPaginator ¶
func NewGetTranscriptPaginator(req GetTranscriptRequest) GetTranscriptPaginator
NewGetTranscriptRequestPaginator returns a paginator for GetTranscript. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetTranscriptRequest(input) p := connectparticipant.NewGetTranscriptRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetTranscriptPaginator) CurrentPage ¶
func (p *GetTranscriptPaginator) CurrentPage() *GetTranscriptOutput
type GetTranscriptRequest ¶
type GetTranscriptRequest struct { *aws.Request Input *GetTranscriptInput Copy func(*GetTranscriptInput) GetTranscriptRequest }
GetTranscriptRequest is the request type for the GetTranscript API operation.
func (GetTranscriptRequest) Send ¶
func (r GetTranscriptRequest) Send(ctx context.Context) (*GetTranscriptResponse, error)
Send marshals and sends the GetTranscript API request.
type GetTranscriptResponse ¶
type GetTranscriptResponse struct { *GetTranscriptOutput // contains filtered or unexported fields }
GetTranscriptResponse is the response type for the GetTranscript API operation.
func (*GetTranscriptResponse) SDKResponseMetdata ¶
func (r *GetTranscriptResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetTranscript request.
type Item ¶
type Item struct { // The time when the message or event was sent. // // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, // 2019-11-08T02:41:28.172Z. AbsoluteTime *string `min:"1" type:"string"` // The content of the message or event. Content *string `min:"1" type:"string"` // The type of content of the item. ContentType *string `min:"1" type:"string"` // The chat display name of the sender. DisplayName *string `min:"1" type:"string"` // The ID of the item. Id *string `min:"1" type:"string"` // The ID of the sender in the session. ParticipantId *string `min:"1" type:"string"` // The role of the sender. For example, is it a customer, agent, or system. ParticipantRole ParticipantRole `type:"string" enum:"true"` // Type of the item: message or event. Type ChatItemType `type:"string" enum:"true"` // contains filtered or unexported fields }
An item - message or event - that has been sent.
func (Item) MarshalFields ¶
func (s Item) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type ParticipantRole ¶
type ParticipantRole string
const ( ParticipantRoleAgent ParticipantRole = "AGENT" ParticipantRoleCustomer ParticipantRole = "CUSTOMER" ParticipantRoleSystem ParticipantRole = "SYSTEM" )
Enum values for ParticipantRole
func (ParticipantRole) MarshalValue ¶
func (enum ParticipantRole) MarshalValue() (string, error)
func (ParticipantRole) MarshalValueBuf ¶
func (enum ParticipantRole) MarshalValueBuf(b []byte) ([]byte, error)
type ScanDirection ¶
type ScanDirection string
const ( ScanDirectionForward ScanDirection = "FORWARD" ScanDirectionBackward ScanDirection = "BACKWARD" )
Enum values for ScanDirection
func (ScanDirection) MarshalValue ¶
func (enum ScanDirection) MarshalValue() (string, error)
func (ScanDirection) MarshalValueBuf ¶
func (enum ScanDirection) MarshalValueBuf(b []byte) ([]byte, error)
type SendEventInput ¶
type SendEventInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` // The authentication token associated with the participant's connection. // // ConnectionToken is a required field ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` // The content of the event to be sent (for example, message text). This is // not yet supported. Content *string `min:"1" type:"string"` // The content type of the request. Supported types are: // // * application/vnd.amazonaws.connect.event.typing // // * application/vnd.amazonaws.connect.event.connection.acknowledged // // ContentType is a required field ContentType *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (SendEventInput) MarshalFields ¶
func (s SendEventInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SendEventInput) String ¶
func (s SendEventInput) String() string
String returns the string representation
func (*SendEventInput) Validate ¶
func (s *SendEventInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendEventOutput ¶
type SendEventOutput struct { // The time when the event was sent. // // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, // 2019-11-08T02:41:28.172Z. AbsoluteTime *string `min:"1" type:"string"` // The ID of the response. Id *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (SendEventOutput) MarshalFields ¶
func (s SendEventOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SendEventOutput) String ¶
func (s SendEventOutput) String() string
String returns the string representation
type SendEventRequest ¶
type SendEventRequest struct { *aws.Request Input *SendEventInput Copy func(*SendEventInput) SendEventRequest }
SendEventRequest is the request type for the SendEvent API operation.
func (SendEventRequest) Send ¶
func (r SendEventRequest) Send(ctx context.Context) (*SendEventResponse, error)
Send marshals and sends the SendEvent API request.
type SendEventResponse ¶
type SendEventResponse struct { *SendEventOutput // contains filtered or unexported fields }
SendEventResponse is the response type for the SendEvent API operation.
func (*SendEventResponse) SDKResponseMetdata ¶
func (r *SendEventResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SendEvent request.
type SendMessageInput ¶
type SendMessageInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` // The authentication token associated with the connection. // // ConnectionToken is a required field ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` // The content of the message. // // Content is a required field Content *string `min:"1" type:"string" required:"true"` // The type of the content. Supported types are text/plain. // // ContentType is a required field ContentType *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (SendMessageInput) MarshalFields ¶
func (s SendMessageInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SendMessageInput) String ¶
func (s SendMessageInput) String() string
String returns the string representation
func (*SendMessageInput) Validate ¶
func (s *SendMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendMessageOutput ¶
type SendMessageOutput struct { // The time when the message was sent. // // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, // 2019-11-08T02:41:28.172Z. AbsoluteTime *string `min:"1" type:"string"` // The ID of the message. Id *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (SendMessageOutput) MarshalFields ¶
func (s SendMessageOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SendMessageOutput) String ¶
func (s SendMessageOutput) String() string
String returns the string representation
type SendMessageRequest ¶
type SendMessageRequest struct { *aws.Request Input *SendMessageInput Copy func(*SendMessageInput) SendMessageRequest }
SendMessageRequest is the request type for the SendMessage API operation.
func (SendMessageRequest) Send ¶
func (r SendMessageRequest) Send(ctx context.Context) (*SendMessageResponse, error)
Send marshals and sends the SendMessage API request.
type SendMessageResponse ¶
type SendMessageResponse struct { *SendMessageOutput // contains filtered or unexported fields }
SendMessageResponse is the response type for the SendMessage API operation.
func (*SendMessageResponse) SDKResponseMetdata ¶
func (r *SendMessageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SendMessage request.
type StartPosition ¶
type StartPosition struct { // The time in ISO format where to start. // // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, // 2019-11-08T02:41:28.172Z. AbsoluteTime *string `min:"1" type:"string"` // The ID of the message or event where to start. Id *string `min:"1" type:"string"` // The start position of the most recent message where you want to start. MostRecent *int64 `type:"integer"` // contains filtered or unexported fields }
A filtering option for where to start. For example, if you sent 100 messages, start with message 50.
func (StartPosition) MarshalFields ¶
func (s StartPosition) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (StartPosition) String ¶
func (s StartPosition) String() string
String returns the string representation
func (*StartPosition) Validate ¶
func (s *StartPosition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Websocket ¶
type Websocket struct { // The URL expiration timestamp in ISO date format. // // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, // 2019-11-08T02:41:28.172Z. ConnectionExpiry *string `type:"string"` // The URL of the websocket. Url *string `min:"1" type:"string"` // contains filtered or unexported fields }
The websocket for the participant's connection.
func (Websocket) MarshalFields ¶
func (s Websocket) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package connectparticipantiface provides an interface to enable mocking the Amazon Connect Participant Service service client for testing your code.
|
Package connectparticipantiface provides an interface to enable mocking the Amazon Connect Participant Service service client for testing your code. |