func SentimentValue_Values() []string
SentimentValue_Values returns all elements of the SentimentValue enum
type AccessDeniedException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
You do not have sufficient access to perform this action.
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Categories struct {
// The category rules that have been matched in the analyzed segment.
//
// MatchedCategories is a required field
MatchedCategories []*string `type:"list" required:"true"`
// The category rule that was matched and when it occurred in the transcript.
//
// MatchedDetails is a required field
MatchedDetails map[string]*CategoryDetails `type:"map" required:"true"`
// contains filtered or unexported fields
}
Provides the category rules that are used to automatically categorize contacts based on uttered keywords and phrases.
func (s Categories) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Categories) SetMatchedCategories(v []*string) *Categories
SetMatchedCategories sets the MatchedCategories field's value.
func (s *Categories) SetMatchedDetails(v map[string]*CategoryDetails) *Categories
SetMatchedDetails sets the MatchedDetails field's value.
func (s Categories) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CategoryDetails struct {
// The section of audio where the category rule was detected.
//
// PointsOfInterest is a required field
PointsOfInterest []*PointOfInterest `type:"list" required:"true"`
// contains filtered or unexported fields
}
Provides information about the category rule that was matched.
func (s CategoryDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CategoryDetails) SetPointsOfInterest(v []*PointOfInterest) *CategoryDetails
SetPointsOfInterest sets the PointsOfInterest field's value.
func (s CategoryDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CharacterOffsets struct {
// The beginning of the issue.
//
// BeginOffsetChar is a required field
BeginOffsetChar *int64 `type:"integer" required:"true"`
// The end of the issue.
//
// EndOffsetChar is a required field
EndOffsetChar *int64 `type:"integer" required:"true"`
// contains filtered or unexported fields
}
For characters that were detected as issues, where they occur in the transcript.
func (s CharacterOffsets) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CharacterOffsets) SetBeginOffsetChar(v int64) *CharacterOffsets
SetBeginOffsetChar sets the BeginOffsetChar field's value.
func (s *CharacterOffsets) SetEndOffsetChar(v int64) *CharacterOffsets
SetEndOffsetChar sets the EndOffsetChar field's value.
func (s CharacterOffsets) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConnectContactLens struct {
*client.Client
}
ConnectContactLens provides the API operation methods for making requests to Amazon Connect Contact Lens. See this package's package overview docs for details on the service.
ConnectContactLens methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *ConnectContactLens
New creates a new instance of the ConnectContactLens client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession())
// Create a ConnectContactLens client from just a session.
svc := connectcontactlens.New(mySession)
// Create a ConnectContactLens client with additional configuration
svc := connectcontactlens.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *ConnectContactLens) ListRealtimeContactAnalysisSegments(input *ListRealtimeContactAnalysisSegmentsInput) (*ListRealtimeContactAnalysisSegmentsOutput, error)
ListRealtimeContactAnalysisSegments API operation for Amazon Connect Contact Lens.
Provides a list of analysis segments for a real-time analysis session.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Connect Contact Lens's API operation ListRealtimeContactAnalysisSegments for usage and error information.
Returned Error Types:
InvalidRequestException The request is not valid.
AccessDeniedException You do not have sufficient access to perform this action.
ResourceNotFoundException The specified resource was not found.
InternalServiceException Request processing failed due to an error or failure with the service.
ThrottlingException The throttling limit has been exceeded.
func (c *ConnectContactLens) ListRealtimeContactAnalysisSegmentsPages(input *ListRealtimeContactAnalysisSegmentsInput, fn func(*ListRealtimeContactAnalysisSegmentsOutput, bool) bool) error
ListRealtimeContactAnalysisSegmentsPages iterates over the pages of a ListRealtimeContactAnalysisSegments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListRealtimeContactAnalysisSegments method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListRealtimeContactAnalysisSegments operation.
pageNum := 0
err := client.ListRealtimeContactAnalysisSegmentsPages(params,
func(page *connectcontactlens.ListRealtimeContactAnalysisSegmentsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *ConnectContactLens) ListRealtimeContactAnalysisSegmentsPagesWithContext(ctx aws.Context, input *ListRealtimeContactAnalysisSegmentsInput, fn func(*ListRealtimeContactAnalysisSegmentsOutput, bool) bool, opts ...request.Option) error
ListRealtimeContactAnalysisSegmentsPagesWithContext same as ListRealtimeContactAnalysisSegmentsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *ConnectContactLens) ListRealtimeContactAnalysisSegmentsRequest(input *ListRealtimeContactAnalysisSegmentsInput) (req *request.Request, output *ListRealtimeContactAnalysisSegmentsOutput)
ListRealtimeContactAnalysisSegmentsRequest generates a "aws/request.Request" representing the client's request for the ListRealtimeContactAnalysisSegments operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListRealtimeContactAnalysisSegments for more information on using the ListRealtimeContactAnalysisSegments API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListRealtimeContactAnalysisSegmentsRequest method.
req, resp := client.ListRealtimeContactAnalysisSegmentsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *ConnectContactLens) ListRealtimeContactAnalysisSegmentsWithContext(ctx aws.Context, input *ListRealtimeContactAnalysisSegmentsInput, opts ...request.Option) (*ListRealtimeContactAnalysisSegmentsOutput, error)
ListRealtimeContactAnalysisSegmentsWithContext is the same as ListRealtimeContactAnalysisSegments with the addition of the ability to pass a context and additional request options.
See ListRealtimeContactAnalysisSegments for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type InternalServiceException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
Request processing failed due to an error or failure with the service.
func (s *InternalServiceException) Code() string
Code returns the exception type name.
func (s *InternalServiceException) Error() string
func (s InternalServiceException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalServiceException) Message() string
Message returns the exception's message.
func (s *InternalServiceException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServiceException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServiceException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalServiceException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidRequestException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The request is not valid.
func (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
func (s InvalidRequestException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidRequestException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type IssueDetected struct {
// The offset for when the issue was detected in the segment.
//
// CharacterOffsets is a required field
CharacterOffsets *CharacterOffsets `type:"structure" required:"true"`
// contains filtered or unexported fields
}
Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
func (s IssueDetected) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IssueDetected) SetCharacterOffsets(v *CharacterOffsets) *IssueDetected
SetCharacterOffsets sets the CharacterOffsets field's value.
func (s IssueDetected) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListRealtimeContactAnalysisSegmentsInput struct {
// The identifier of the contact.
//
// ContactId is a required field
ContactId *string `min:"1" type:"string" required:"true"`
// The identifier of the Amazon Connect instance.
//
// InstanceId is a required field
InstanceId *string `min:"1" type:"string" required:"true"`
// The maximimum number of results to return per page.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListRealtimeContactAnalysisSegmentsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListRealtimeContactAnalysisSegmentsInput) SetContactId(v string) *ListRealtimeContactAnalysisSegmentsInput
SetContactId sets the ContactId field's value.
func (s *ListRealtimeContactAnalysisSegmentsInput) SetInstanceId(v string) *ListRealtimeContactAnalysisSegmentsInput
SetInstanceId sets the InstanceId field's value.
func (s *ListRealtimeContactAnalysisSegmentsInput) SetMaxResults(v int64) *ListRealtimeContactAnalysisSegmentsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListRealtimeContactAnalysisSegmentsInput) SetNextToken(v string) *ListRealtimeContactAnalysisSegmentsInput
SetNextToken sets the NextToken field's value.
func (s ListRealtimeContactAnalysisSegmentsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListRealtimeContactAnalysisSegmentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListRealtimeContactAnalysisSegmentsOutput struct {
// 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 `min:"1" type:"string"`
// An analyzed transcript or category.
//
// Segments is a required field
Segments []*RealtimeContactAnalysisSegment `type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListRealtimeContactAnalysisSegmentsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListRealtimeContactAnalysisSegmentsOutput) SetNextToken(v string) *ListRealtimeContactAnalysisSegmentsOutput
SetNextToken sets the NextToken field's value.
func (s *ListRealtimeContactAnalysisSegmentsOutput) SetSegments(v []*RealtimeContactAnalysisSegment) *ListRealtimeContactAnalysisSegmentsOutput
SetSegments sets the Segments field's value.
func (s ListRealtimeContactAnalysisSegmentsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PointOfInterest struct {
// The beginning offset in milliseconds where the category rule was detected.
//
// BeginOffsetMillis is a required field
BeginOffsetMillis *int64 `type:"integer" required:"true"`
// The ending offset in milliseconds where the category rule was detected.
//
// EndOffsetMillis is a required field
EndOffsetMillis *int64 `type:"integer" required:"true"`
// contains filtered or unexported fields
}
The section of the contact audio where that category rule was detected.
func (s PointOfInterest) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PointOfInterest) SetBeginOffsetMillis(v int64) *PointOfInterest
SetBeginOffsetMillis sets the BeginOffsetMillis field's value.
func (s *PointOfInterest) SetEndOffsetMillis(v int64) *PointOfInterest
SetEndOffsetMillis sets the EndOffsetMillis field's value.
func (s PointOfInterest) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RealtimeContactAnalysisSegment struct {
// The matched category rules.
Categories *Categories `type:"structure"`
// The analyzed transcript.
Transcript *Transcript `type:"structure"`
// contains filtered or unexported fields
}
An analyzed segment for a real-time analysis session.
func (s RealtimeContactAnalysisSegment) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RealtimeContactAnalysisSegment) SetCategories(v *Categories) *RealtimeContactAnalysisSegment
SetCategories sets the Categories field's value.
func (s *RealtimeContactAnalysisSegment) SetTranscript(v *Transcript) *RealtimeContactAnalysisSegment
SetTranscript sets the Transcript field's value.
func (s RealtimeContactAnalysisSegment) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The specified resource was not found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The throttling limit has been exceeded.
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Transcript struct {
// The beginning offset in the contact for this transcript.
//
// BeginOffsetMillis is a required field
BeginOffsetMillis *int64 `type:"integer" required:"true"`
// The content of the transcript.
//
// Content is a required field
Content *string `min:"1" type:"string" required:"true"`
// The end offset in the contact for this transcript.
//
// EndOffsetMillis is a required field
EndOffsetMillis *int64 `type:"integer" required:"true"`
// The identifier of the transcript.
//
// Id is a required field
Id *string `min:"1" type:"string" required:"true"`
// List of positions where issues were detected on the transcript.
IssuesDetected []*IssueDetected `type:"list"`
// The identifier of the participant.
//
// ParticipantId is a required field
ParticipantId *string `min:"1" type:"string" required:"true"`
// The role of participant. For example, is it a customer, agent, or system.
//
// ParticipantRole is a required field
ParticipantRole *string `min:"1" type:"string" required:"true"`
// The sentiment of the detected for this piece of transcript.
//
// Sentiment is a required field
Sentiment *string `type:"string" required:"true" enum:"SentimentValue"`
// contains filtered or unexported fields
}
A list of messages in the session.
func (s Transcript) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Transcript) SetBeginOffsetMillis(v int64) *Transcript
SetBeginOffsetMillis sets the BeginOffsetMillis field's value.
func (s *Transcript) SetContent(v string) *Transcript
SetContent sets the Content field's value.
func (s *Transcript) SetEndOffsetMillis(v int64) *Transcript
SetEndOffsetMillis sets the EndOffsetMillis field's value.
func (s *Transcript) SetId(v string) *Transcript
SetId sets the Id field's value.
func (s *Transcript) SetIssuesDetected(v []*IssueDetected) *Transcript
SetIssuesDetected sets the IssuesDetected field's value.
func (s *Transcript) SetParticipantId(v string) *Transcript
SetParticipantId sets the ParticipantId field's value.
func (s *Transcript) SetParticipantRole(v string) *Transcript
SetParticipantRole sets the ParticipantRole field's value.
func (s *Transcript) SetSentiment(v string) *Transcript
SetSentiment sets the Sentiment field's value.
func (s Transcript) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".