Documentation

Overview

    Package connectcontactlens provides the API client, operations, and parameter types for Amazon Connect Contact Lens.

    Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, by using speech transcription, natural language processing, and intelligent search capabilities. It performs sentiment analysis, detects issues, and enables you to automatically categorize contacts. Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent conversations. For more information, see Analyze conversations using Contact Lens (https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html) in the Amazon Connect Administrator Guide.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2020-08-21"
    View Source
    const ServiceID = "Connect Contact Lens"

    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 Contact Lens.

            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) ListRealtimeContactAnalysisSegments

                func (c *Client) ListRealtimeContactAnalysisSegments(ctx context.Context, params *ListRealtimeContactAnalysisSegmentsInput, optFns ...func(*Options)) (*ListRealtimeContactAnalysisSegmentsOutput, error)

                  Provides a list of analysis segments for a real-time analysis session.

                  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 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 ListRealtimeContactAnalysisSegmentsAPIClient

                          type ListRealtimeContactAnalysisSegmentsAPIClient interface {
                          	ListRealtimeContactAnalysisSegments(context.Context, *ListRealtimeContactAnalysisSegmentsInput, ...func(*Options)) (*ListRealtimeContactAnalysisSegmentsOutput, error)
                          }

                            ListRealtimeContactAnalysisSegmentsAPIClient is a client that implements the ListRealtimeContactAnalysisSegments operation.

                            type ListRealtimeContactAnalysisSegmentsInput

                            type ListRealtimeContactAnalysisSegmentsInput struct {
                            
                            	// The identifier of the contact.
                            	//
                            	// This member is required.
                            	ContactId *string
                            
                            	// The identifier of the Amazon Connect instance.
                            	//
                            	// This member is required.
                            	InstanceId *string
                            
                            	// The maximimum number of results to return per page.
                            	MaxResults int32
                            
                            	// The token for the next set of results. Use the value returned in the previous
                            	// response in the next request to retrieve the next set of results.
                            	NextToken *string
                            }

                            type ListRealtimeContactAnalysisSegmentsOutput

                            type ListRealtimeContactAnalysisSegmentsOutput struct {
                            
                            	// An analyzed transcript or category.
                            	//
                            	// This member is required.
                            	Segments []types.RealtimeContactAnalysisSegment
                            
                            	// If there are additional results, this is the token for the next set of results.
                            	// If response includes nextToken there are two possible scenarios:
                            	//
                            	// * There are
                            	// more segments so another call is required to get them.
                            	//
                            	// * There are no more
                            	// segments at this time, but more may be available later (real-time analysis is in
                            	// progress) so the client should call the operation again to get new segments.
                            	//
                            	// If
                            	// response does not include nextToken, the analysis is completed (successfully or
                            	// failed) and there are no more segments to retrieve.
                            	NextToken *string
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type ListRealtimeContactAnalysisSegmentsPaginator

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

                              ListRealtimeContactAnalysisSegmentsPaginator is a paginator for ListRealtimeContactAnalysisSegments

                              func NewListRealtimeContactAnalysisSegmentsPaginator

                                NewListRealtimeContactAnalysisSegmentsPaginator returns a new ListRealtimeContactAnalysisSegmentsPaginator

                                func (*ListRealtimeContactAnalysisSegmentsPaginator) HasMorePages

                                  HasMorePages returns a boolean indicating whether more pages are available

                                  func (*ListRealtimeContactAnalysisSegmentsPaginator) NextPage

                                    NextPage retrieves the next ListRealtimeContactAnalysisSegments page.

                                    type ListRealtimeContactAnalysisSegmentsPaginatorOptions

                                    type ListRealtimeContactAnalysisSegmentsPaginatorOptions struct {
                                    	// The maximimum number of results to return per page.
                                    	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
                                    }

                                      ListRealtimeContactAnalysisSegmentsPaginatorOptions is the paginator options for ListRealtimeContactAnalysisSegments

                                      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
                                      
                                      	// 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

                                        Directories

                                        Path Synopsis
                                        internal