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
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type HTTPClient
- type HTTPSignerV4
- type ListRealtimeContactAnalysisSegmentsAPIClient
- type ListRealtimeContactAnalysisSegmentsInput
- type ListRealtimeContactAnalysisSegmentsOutput
- type ListRealtimeContactAnalysisSegmentsPaginator
- type ListRealtimeContactAnalysisSegmentsPaginatorOptions
- type Options
- type ResolveEndpoint
Constants ¶
const ServiceAPIVersion = "2020-08-21"
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 ¶ added in v1.0.0
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 ¶
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 ¶
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 ¶ added in v1.1.0
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 HTTPSignerV4 ¶
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListRealtimeContactAnalysisSegmentsPaginator ¶
type ListRealtimeContactAnalysisSegmentsPaginator struct {
// contains filtered or unexported fields
}
ListRealtimeContactAnalysisSegmentsPaginator is a paginator for ListRealtimeContactAnalysisSegments
func NewListRealtimeContactAnalysisSegmentsPaginator ¶
func NewListRealtimeContactAnalysisSegmentsPaginator(client ListRealtimeContactAnalysisSegmentsAPIClient, params *ListRealtimeContactAnalysisSegmentsInput, optFns ...func(*ListRealtimeContactAnalysisSegmentsPaginatorOptions)) *ListRealtimeContactAnalysisSegmentsPaginator
NewListRealtimeContactAnalysisSegmentsPaginator returns a new ListRealtimeContactAnalysisSegmentsPaginator
func (*ListRealtimeContactAnalysisSegmentsPaginator) HasMorePages ¶
func (p *ListRealtimeContactAnalysisSegmentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRealtimeContactAnalysisSegmentsPaginator) NextPage ¶
func (p *ListRealtimeContactAnalysisSegmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRealtimeContactAnalysisSegmentsOutput, error)
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 configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // 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 // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string