Documentation

Overview

    Package connectparticipant provides the API client, operations, and parameter types for Amazon Connect Participant Service.

    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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-09-07"
    View Source
    const ServiceID = "ConnectParticipant"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for Amazon Connect Participant Service.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CompleteAttachmentUpload

                func (c *Client) CompleteAttachmentUpload(ctx context.Context, params *CompleteAttachmentUploadInput, optFns ...func(*Options)) (*CompleteAttachmentUploadOutput, error)

                  Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

                  func (*Client) CreateParticipantConnection

                  func (c *Client) CreateParticipantConnection(ctx context.Context, params *CreateParticipantConnectionInput, optFns ...func(*Options)) (*CreateParticipantConnectionOutput, error)

                    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 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. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

                    func (*Client) DisconnectParticipant

                    func (c *Client) DisconnectParticipant(ctx context.Context, params *DisconnectParticipantInput, optFns ...func(*Options)) (*DisconnectParticipantOutput, error)

                      Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

                      func (*Client) GetAttachment

                      func (c *Client) GetAttachment(ctx context.Context, params *GetAttachmentInput, optFns ...func(*Options)) (*GetAttachmentOutput, error)

                        Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

                        func (*Client) GetTranscript

                        func (c *Client) GetTranscript(ctx context.Context, params *GetTranscriptInput, optFns ...func(*Options)) (*GetTranscriptOutput, error)

                          Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

                          func (*Client) SendEvent

                          func (c *Client) SendEvent(ctx context.Context, params *SendEventInput, optFns ...func(*Options)) (*SendEventOutput, error)

                            Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

                            func (*Client) SendMessage

                            func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optFns ...func(*Options)) (*SendMessageOutput, error)

                              Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

                              func (*Client) StartAttachmentUpload

                              func (c *Client) StartAttachmentUpload(ctx context.Context, params *StartAttachmentUploadInput, optFns ...func(*Options)) (*StartAttachmentUploadOutput, error)

                                Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

                                type CompleteAttachmentUploadInput

                                type CompleteAttachmentUploadInput struct {
                                
                                	// A list of unique identifiers for the attachments.
                                	//
                                	// This member is required.
                                	AttachmentIds []string
                                
                                	// A unique, case-sensitive identifier that you provide to ensure the idempotency
                                	// of the request.
                                	//
                                	// This member is required.
                                	ClientToken *string
                                
                                	// The authentication token associated with the participant's connection.
                                	//
                                	// This member is required.
                                	ConnectionToken *string
                                }

                                type CompleteAttachmentUploadOutput

                                type CompleteAttachmentUploadOutput struct {
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type CreateParticipantConnectionInput

                                type CreateParticipantConnectionInput struct {
                                
                                	// This is a header parameter. The Participant Token as obtained from
                                	// StartChatContact
                                	// (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html)
                                	// API response.
                                	//
                                	// This member is required.
                                	ParticipantToken *string
                                
                                	// Type of connection information required.
                                	//
                                	// This member is required.
                                	Type []types.ConnectionType
                                }

                                type CreateParticipantConnectionOutput

                                type CreateParticipantConnectionOutput struct {
                                
                                	// Creates the participant's connection credentials. The authentication token
                                	// associated with the participant's connection.
                                	ConnectionCredentials *types.ConnectionCredentials
                                
                                	// Creates the participant's websocket connection.
                                	Websocket *types.Websocket
                                
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type DisconnectParticipantInput

                                type DisconnectParticipantInput struct {
                                
                                	// The authentication token associated with the participant's connection.
                                	//
                                	// This member is required.
                                	ConnectionToken *string
                                
                                	// A unique, case-sensitive identifier that you provide to ensure the idempotency
                                	// of the request.
                                	ClientToken *string
                                }

                                type DisconnectParticipantOutput

                                type DisconnectParticipantOutput struct {
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type EndpointResolver

                                type EndpointResolver interface {
                                	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                }

                                  EndpointResolver interface for resolving service endpoints.

                                  func EndpointResolverFromURL

                                  func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                    EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                    type EndpointResolverFunc

                                    type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                      EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                      func (EndpointResolverFunc) ResolveEndpoint

                                      func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                      type EndpointResolverOptions

                                      type EndpointResolverOptions = internalendpoints.Options

                                        EndpointResolverOptions is the service endpoint resolver options

                                        type GetAttachmentInput

                                        type GetAttachmentInput struct {
                                        
                                        	// A unique identifier for the attachment.
                                        	//
                                        	// This member is required.
                                        	AttachmentId *string
                                        
                                        	// The authentication token associated with the participant's connection.
                                        	//
                                        	// This member is required.
                                        	ConnectionToken *string
                                        }

                                        type GetAttachmentOutput

                                        type GetAttachmentOutput struct {
                                        
                                        	// The pre-signed URL using which file would be downloaded from Amazon S3 by the
                                        	// API caller.
                                        	Url *string
                                        
                                        	// The expiration time of the URL in ISO timestamp. It's specified in ISO 8601
                                        	// format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
                                        	UrlExpiry *string
                                        
                                        	// Metadata pertaining to the operation's result.
                                        	ResultMetadata middleware.Metadata
                                        }

                                        type GetTranscriptAPIClient

                                        type GetTranscriptAPIClient interface {
                                        	GetTranscript(context.Context, *GetTranscriptInput, ...func(*Options)) (*GetTranscriptOutput, error)
                                        }

                                          GetTranscriptAPIClient is a client that implements the GetTranscript operation.

                                          type GetTranscriptInput

                                          type GetTranscriptInput struct {
                                          
                                          	// The authentication token associated with the participant's connection.
                                          	//
                                          	// This member is required.
                                          	ConnectionToken *string
                                          
                                          	// The contactId from the current contact chain for which transcript is needed.
                                          	ContactId *string
                                          
                                          	// The maximum number of results to return in the page. Default: 10.
                                          	MaxResults int32
                                          
                                          	// The pagination token. Use the value returned previously in the next subsequent
                                          	// request to retrieve the next set of results.
                                          	NextToken *string
                                          
                                          	// The direction from StartPosition from which to retrieve message. Default:
                                          	// BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
                                          	ScanDirection types.ScanDirection
                                          
                                          	// The sort order for the records. Default: DESCENDING.
                                          	SortOrder types.SortKey
                                          
                                          	// A filtering option for where to start.
                                          	StartPosition *types.StartPosition
                                          }

                                          type GetTranscriptOutput

                                          type GetTranscriptOutput struct {
                                          
                                          	// The initial contact ID for the contact.
                                          	InitialContactId *string
                                          
                                          	// The pagination token. Use the value returned previously in the next subsequent
                                          	// request to retrieve the next set of results.
                                          	NextToken *string
                                          
                                          	// The list of messages in the session.
                                          	Transcript []types.Item
                                          
                                          	// Metadata pertaining to the operation's result.
                                          	ResultMetadata middleware.Metadata
                                          }

                                          type GetTranscriptPaginator

                                          type GetTranscriptPaginator struct {
                                          	// contains filtered or unexported fields
                                          }

                                            GetTranscriptPaginator is a paginator for GetTranscript

                                            func NewGetTranscriptPaginator

                                            func NewGetTranscriptPaginator(client GetTranscriptAPIClient, params *GetTranscriptInput, optFns ...func(*GetTranscriptPaginatorOptions)) *GetTranscriptPaginator

                                              NewGetTranscriptPaginator returns a new GetTranscriptPaginator

                                              func (*GetTranscriptPaginator) HasMorePages

                                              func (p *GetTranscriptPaginator) HasMorePages() bool

                                                HasMorePages returns a boolean indicating whether more pages are available

                                                func (*GetTranscriptPaginator) NextPage

                                                func (p *GetTranscriptPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTranscriptOutput, error)

                                                  NextPage retrieves the next GetTranscript page.

                                                  type GetTranscriptPaginatorOptions

                                                  type GetTranscriptPaginatorOptions struct {
                                                  	// The maximum number of results to return in the page. Default: 10.
                                                  	Limit int32
                                                  
                                                  	// Set to true if pagination should stop if the service returns a pagination token
                                                  	// that matches the most recent token provided to the service.
                                                  	StopOnDuplicateToken bool
                                                  }

                                                    GetTranscriptPaginatorOptions is the paginator options for GetTranscript

                                                    type HTTPClient

                                                    type HTTPClient interface {
                                                    	Do(*http.Request) (*http.Response, error)
                                                    }

                                                    type HTTPSignerV4

                                                    type HTTPSignerV4 interface {
                                                    	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                    }

                                                    type IdempotencyTokenProvider

                                                    type IdempotencyTokenProvider interface {
                                                    	GetIdempotencyToken() (string, error)
                                                    }

                                                      IdempotencyTokenProvider interface for providing idempotency token

                                                      type Options

                                                      type Options struct {
                                                      	// Set of options to modify how an operation is invoked. These apply to all
                                                      	// operations invoked for this client. Use functional options on operation call to
                                                      	// modify this list for per operation behavior.
                                                      	APIOptions []func(*middleware.Stack) error
                                                      
                                                      	// Configures the events that will be sent to the configured logger.
                                                      	ClientLogMode aws.ClientLogMode
                                                      
                                                      	// The credentials object to use when signing requests.
                                                      	Credentials aws.CredentialsProvider
                                                      
                                                      	// The endpoint options to be used when attempting to resolve an endpoint.
                                                      	EndpointOptions EndpointResolverOptions
                                                      
                                                      	// The service endpoint resolver.
                                                      	EndpointResolver EndpointResolver
                                                      
                                                      	// Signature Version 4 (SigV4) Signer
                                                      	HTTPSignerV4 HTTPSignerV4
                                                      
                                                      	// Provides idempotency tokens values that will be automatically populated into
                                                      	// idempotent API operations.
                                                      	IdempotencyTokenProvider IdempotencyTokenProvider
                                                      
                                                      	// The logger writer interface to write logging messages to.
                                                      	Logger logging.Logger
                                                      
                                                      	// The region to send requests to. (Required)
                                                      	Region string
                                                      
                                                      	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                      	// failures. When nil the API client will use a default retryer.
                                                      	Retryer aws.Retryer
                                                      
                                                      	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                      	// implementation if nil.
                                                      	HTTPClient HTTPClient
                                                      }

                                                      func (Options) Copy

                                                      func (o Options) Copy() Options

                                                        Copy creates a clone where the APIOptions list is deep copied.

                                                        type ResolveEndpoint

                                                        type ResolveEndpoint struct {
                                                        	Resolver EndpointResolver
                                                        	Options  EndpointResolverOptions
                                                        }

                                                        func (*ResolveEndpoint) HandleSerialize

                                                        func (*ResolveEndpoint) ID

                                                        func (*ResolveEndpoint) ID() string

                                                        type SendEventInput

                                                        type SendEventInput struct {
                                                        
                                                        	// The authentication token associated with the participant's connection.
                                                        	//
                                                        	// This member is required.
                                                        	ConnectionToken *string
                                                        
                                                        	// The content type of the request. Supported types are:
                                                        	//
                                                        	// *
                                                        	// application/vnd.amazonaws.connect.event.typing
                                                        	//
                                                        	// *
                                                        	// application/vnd.amazonaws.connect.event.connection.acknowledged
                                                        	//
                                                        	// This member is required.
                                                        	ContentType *string
                                                        
                                                        	// A unique, case-sensitive identifier that you provide to ensure the idempotency
                                                        	// of the request.
                                                        	ClientToken *string
                                                        
                                                        	// The content of the event to be sent (for example, message text). This is not yet
                                                        	// supported.
                                                        	Content *string
                                                        }

                                                        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
                                                        
                                                        	// The ID of the response.
                                                        	Id *string
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type SendMessageInput

                                                        type SendMessageInput struct {
                                                        
                                                        	// The authentication token associated with the connection.
                                                        	//
                                                        	// This member is required.
                                                        	ConnectionToken *string
                                                        
                                                        	// The content of the message.
                                                        	//
                                                        	// This member is required.
                                                        	Content *string
                                                        
                                                        	// The type of the content. Supported types are text/plain.
                                                        	//
                                                        	// This member is required.
                                                        	ContentType *string
                                                        
                                                        	// A unique, case-sensitive identifier that you provide to ensure the idempotency
                                                        	// of the request.
                                                        	ClientToken *string
                                                        }

                                                        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
                                                        
                                                        	// The ID of the message.
                                                        	Id *string
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type StartAttachmentUploadInput

                                                        type StartAttachmentUploadInput struct {
                                                        
                                                        	// A case-sensitive name of the attachment being uploaded.
                                                        	//
                                                        	// This member is required.
                                                        	AttachmentName *string
                                                        
                                                        	// The size of the attachment in bytes.
                                                        	//
                                                        	// This member is required.
                                                        	AttachmentSizeInBytes int64
                                                        
                                                        	// A unique case sensitive identifier to support idempotency of request.
                                                        	//
                                                        	// This member is required.
                                                        	ClientToken *string
                                                        
                                                        	// The authentication token associated with the participant's connection.
                                                        	//
                                                        	// This member is required.
                                                        	ConnectionToken *string
                                                        
                                                        	// Describes the MIME file type of the attachment. For a list of supported file
                                                        	// types, see Feature specifications
                                                        	// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits)
                                                        	// in the Amazon Connect Administrator Guide.
                                                        	//
                                                        	// This member is required.
                                                        	ContentType *string
                                                        }

                                                        type StartAttachmentUploadOutput

                                                        type StartAttachmentUploadOutput struct {
                                                        
                                                        	// A unique identifier for the attachment.
                                                        	AttachmentId *string
                                                        
                                                        	// Fields to be used while uploading the attachment.
                                                        	UploadMetadata *types.UploadMetadata
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        Directories

                                                        Path Synopsis
                                                        internal