{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.connectcontactlens#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectcontactlens#Message", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.connectcontactlens#AmazonConnectContactLens": { "type": "service", "version": "2020-08-21", "operations": [ { "target": "com.amazonaws.connectcontactlens#ListRealtimeContactAnalysisSegments" } ], "traits": { "aws.api#service": { "sdkId": "Connect Contact Lens", "arnNamespace": "connect", "cloudFormationName": "ConnectContactLens", "cloudTrailEventSource": "connectcontactlens.amazonaws.com", "endpointPrefix": "contact-lens" }, "aws.auth#sigv4": { "name": "connect" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "\n

Amazon Connect Contact Lens enables you to analyze conversations between customer and agents, by using\n speech transcription, natural language processing, and intelligent search capabilities.\n It performs sentiment analysis, detects issues, and enables you to automatically\n categorize contacts.

\n

Amazon Connect Contact Lens provides both real-time and post-call analytics of customer-agent\n conversations. For more information, see Analyze conversations\n using speech analytics in the Amazon Connect Administrator\n Guide.

", "smithy.api#title": "Amazon Connect Contact Lens", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://contact-lens-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://contact-lens-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://contact-lens.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://contact-lens.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://contact-lens-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://contact-lens-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://contact-lens.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://contact-lens.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://contact-lens.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://contact-lens.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://contact-lens.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://contact-lens.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.connectcontactlens#Categories": { "type": "structure", "members": { "MatchedCategories": { "target": "com.amazonaws.connectcontactlens#MatchedCategories", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The category rules that have been matched in the analyzed segment.

", "smithy.api#required": {} } }, "MatchedDetails": { "target": "com.amazonaws.connectcontactlens#MatchedDetails", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The category rule that was matched and when it occurred in the transcript.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Provides the category rules that are used to automatically categorize contacts based\n on uttered keywords and phrases.

" } }, "com.amazonaws.connectcontactlens#CategoriesAttributeAndCondition": { "type": "structure", "members": { "TagConditions": { "target": "com.amazonaws.connectcontactlens#TagAndConditionList", "traits": { "smithy.api#documentation": "

A list of tag conditions. All of the tag conditions must be met for the condition to\n match.

" } } }, "traits": { "smithy.api#documentation": "

A list of tag conditions that the filter evaluates together using AND logic. A\n category segment matches only when the tags on its rule satisfy every tag condition in\n the list.

" } }, "com.amazonaws.connectcontactlens#CategoriesAttributeFilter": { "type": "structure", "members": { "OrConditions": { "target": "com.amazonaws.connectcontactlens#CategoriesAttributeOrConditionList", "traits": { "smithy.api#documentation": "

A list of conditions that the filter evaluates using OR logic. A category segment\n matches when at least one of the conditions in the list is met.

" } }, "AndCondition": { "target": "com.amazonaws.connectcontactlens#CategoriesAttributeAndCondition", "traits": { "smithy.api#documentation": "

A condition that the filter evaluates using AND logic. A category segment matches only\n when all of the tag conditions in the condition are met.

" } }, "TagCondition": { "target": "com.amazonaws.connectcontactlens#TagCondition", "traits": { "smithy.api#documentation": "

A single tag condition that a category segment must match. The category's rule must\n have the specified tag.

" } } }, "traits": { "smithy.api#documentation": "

A filter that matches category segments based on the tags assigned to the rules that\n create the categories. Provide exactly one of OrConditions,\n AndCondition, or TagCondition.

" } }, "com.amazonaws.connectcontactlens#CategoriesAttributeOrConditionList": { "type": "list", "member": { "target": "com.amazonaws.connectcontactlens#CategoriesAttributeAndCondition" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.connectcontactlens#CategoryDetails": { "type": "structure", "members": { "PointsOfInterest": { "target": "com.amazonaws.connectcontactlens#PointsOfInterest", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The section of audio where the category rule was detected.

", "smithy.api#required": {} } }, "RuleId": { "target": "com.amazonaws.connectcontactlens#RuleId", "traits": { "smithy.api#documentation": "

The unique identifier of the rule that created the matched category.

" } } }, "traits": { "smithy.api#documentation": "

Provides information about the category rule that was matched.

" } }, "com.amazonaws.connectcontactlens#CategoryName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#CharacterOffset": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.connectcontactlens#CharacterOffsets": { "type": "structure", "members": { "BeginOffsetChar": { "target": "com.amazonaws.connectcontactlens#CharacterOffset", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The beginning of the issue.

", "smithy.api#required": {} } }, "EndOffsetChar": { "target": "com.amazonaws.connectcontactlens#CharacterOffset", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The end of the issue.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

For characters that were detected as issues, where they occur in the\n transcript.

" } }, "com.amazonaws.connectcontactlens#ContactId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#ExtractedInformation": { "type": "structure", "members": { "ExtractionDefinitionId": { "target": "com.amazonaws.connectcontactlens#ExtractionDefinitionId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the extraction definition that produced this result.

", "smithy.api#required": {} } }, "ExtractionDefinitionName": { "target": "com.amazonaws.connectcontactlens#ExtractionDefinitionName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the extraction definition that produced this result.

", "smithy.api#required": {} } }, "ExtractionDefinitionDisplayLabel": { "target": "com.amazonaws.connectcontactlens#ExtractionDefinitionDisplayLabel", "traits": { "smithy.api#documentation": "

The display label of the extraction definition that produced this result.

" } }, "ExtractedValues": { "target": "com.amazonaws.connectcontactlens#ExtractedInformationValues", "traits": { "smithy.api#documentation": "

The list of values extracted from the conversation for this extraction definition.\n This field is empty when a FailureCode is present.

" } }, "FailureCode": { "target": "com.amazonaws.connectcontactlens#ExtractedInformationFailureCode", "traits": { "smithy.api#documentation": "

If the information failed to be extracted, one of the following failure codes\n occurs:

\n " } } }, "traits": { "smithy.api#documentation": "

Segment containing information extracted from the conversation. Each segment\n represents the results for a single extraction definition.

" } }, "com.amazonaws.connectcontactlens#ExtractedInformationContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.connectcontactlens#ExtractedInformationFailureCode": { "type": "enum", "members": { "QUOTA_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUOTA_EXCEEDED" } }, "INSUFFICIENT_CONVERSATION_CONTENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSUFFICIENT_CONVERSATION_CONTENT" } }, "FAILED_SAFETY_GUIDELINES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_SAFETY_GUIDELINES" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_ERROR" } }, "MAX_PACKAGE_FEATURE_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_PACKAGE_FEATURE_ONLY" } } } }, "com.amazonaws.connectcontactlens#ExtractedInformationValue": { "type": "structure", "members": { "Content": { "target": "com.amazonaws.connectcontactlens#ExtractedInformationContent", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The text content of the extracted value.

", "smithy.api#required": {} } }, "PointsOfInterest": { "target": "com.amazonaws.connectcontactlens#PointsOfInterest", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The sections in the conversation that indicate where the extracted value was\n found.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An individual value extracted from the conversation, including its content and the\n locations where it was found.

" } }, "com.amazonaws.connectcontactlens#ExtractedInformationValues": { "type": "list", "member": { "target": "com.amazonaws.connectcontactlens#ExtractedInformationValue" } }, "com.amazonaws.connectcontactlens#ExtractionDefinitionDisplayLabel": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.connectcontactlens#ExtractionDefinitionId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#ExtractionDefinitionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#InstanceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#InternalServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectcontactlens#Message" } }, "traits": { "smithy.api#documentation": "

Request processing failed due to an error or failure with the service.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.connectcontactlens#InvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectcontactlens#Message" } }, "traits": { "smithy.api#documentation": "

The request is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.connectcontactlens#IssueDetected": { "type": "structure", "members": { "CharacterOffsets": { "target": "com.amazonaws.connectcontactlens#CharacterOffsets", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The offset for when the issue was detected in the segment.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Potential issues that are detected based on an artificial intelligence analysis of\n each turn in the conversation.

" } }, "com.amazonaws.connectcontactlens#IssuesDetected": { "type": "list", "member": { "target": "com.amazonaws.connectcontactlens#IssueDetected" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.connectcontactlens#LanguageCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#ListRealtimeContactAnalysisSegments": { "type": "operation", "input": { "target": "com.amazonaws.connectcontactlens#ListRealtimeContactAnalysisSegmentsRequest" }, "output": { "target": "com.amazonaws.connectcontactlens#ListRealtimeContactAnalysisSegmentsResponse" }, "errors": [ { "target": "com.amazonaws.connectcontactlens#AccessDeniedException" }, { "target": "com.amazonaws.connectcontactlens#InternalServiceException" }, { "target": "com.amazonaws.connectcontactlens#InvalidRequestException" }, { "target": "com.amazonaws.connectcontactlens#ResourceNotFoundException" }, { "target": "com.amazonaws.connectcontactlens#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

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

\n \n

Voice data is retained for 24 hours. You must invoke this API during that\n time.

\n
", "smithy.api#http": { "method": "POST", "uri": "/realtime-contact-analysis/analysis-segments", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.connectcontactlens#ListRealtimeContactAnalysisSegmentsRequest": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.connectcontactlens#InstanceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", "smithy.api#required": {} } }, "ContactId": { "target": "com.amazonaws.connectcontactlens#ContactId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the contact.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.connectcontactlens#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per page.

" } }, "NextToken": { "target": "com.amazonaws.connectcontactlens#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" } }, "ListFilter": { "target": "com.amazonaws.connectcontactlens#RealTimeContactAnalysisSegmentsFilter", "traits": { "smithy.api#documentation": "

A filter that limits the category segments returned by the operation. When provided,\n use CategoriesAttributeFilter to return only the category segments whose\n rules have tags that match the filter. This enforces tag-based access control on the\n categories that the caller can view.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectcontactlens#ListRealtimeContactAnalysisSegmentsResponse": { "type": "structure", "members": { "Segments": { "target": "com.amazonaws.connectcontactlens#RealtimeContactAnalysisSegments", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

An analyzed transcript or category.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.connectcontactlens#NextToken", "traits": { "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results. If response includes nextToken there are two possible\n scenarios:

\n \n

If response does not include nextToken, the analysis is completed\n (successfully or failed) and there are no more segments to retrieve.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectcontactlens#MatchedCategories": { "type": "list", "member": { "target": "com.amazonaws.connectcontactlens#CategoryName" }, "traits": { "smithy.api#length": { "min": 0, "max": 150 } } }, "com.amazonaws.connectcontactlens#MatchedDetails": { "type": "map", "key": { "target": "com.amazonaws.connectcontactlens#CategoryName" }, "value": { "target": "com.amazonaws.connectcontactlens#CategoryDetails" }, "traits": { "smithy.api#length": { "min": 0, "max": 150 } } }, "com.amazonaws.connectcontactlens#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.connectcontactlens#Message": { "type": "string" }, "com.amazonaws.connectcontactlens#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 131070 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#OffsetMillis": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.connectcontactlens#ParticipantId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#ParticipantRole": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#PointOfInterest": { "type": "structure", "members": { "BeginOffsetMillis": { "target": "com.amazonaws.connectcontactlens#OffsetMillis", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The beginning offset (in milliseconds) where the match was detected.

", "smithy.api#required": {} } }, "EndOffsetMillis": { "target": "com.amazonaws.connectcontactlens#OffsetMillis", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ending offset (in milliseconds) where the match was detected.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The section of the contact audio where a match was detected.

" } }, "com.amazonaws.connectcontactlens#PointsOfInterest": { "type": "list", "member": { "target": "com.amazonaws.connectcontactlens#PointOfInterest" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.connectcontactlens#PostContactSummary": { "type": "structure", "members": { "Content": { "target": "com.amazonaws.connectcontactlens#PostContactSummaryContent", "traits": { "smithy.api#documentation": "

The content of the summary.

" } }, "Status": { "target": "com.amazonaws.connectcontactlens#PostContactSummaryStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether the summary was successfully COMPLETED or FAILED to be generated.

", "smithy.api#required": {} } }, "FailureCode": { "target": "com.amazonaws.connectcontactlens#PostContactSummaryFailureCode", "traits": { "smithy.api#documentation": "

If the summary failed to be generated, one of the following failure codes\n occurs:

\n " } } }, "traits": { "smithy.api#documentation": "

Information about the post-contact summary.

" } }, "com.amazonaws.connectcontactlens#PostContactSummaryContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1762 } } }, "com.amazonaws.connectcontactlens#PostContactSummaryFailureCode": { "type": "enum", "members": { "QUOTA_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUOTA_EXCEEDED" } }, "INSUFFICIENT_CONVERSATION_CONTENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSUFFICIENT_CONVERSATION_CONTENT" } }, "FAILED_SAFETY_GUIDELINES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_SAFETY_GUIDELINES" } }, "INVALID_ANALYSIS_CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ANALYSIS_CONFIGURATION" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_ERROR" } } } }, "com.amazonaws.connectcontactlens#PostContactSummaryStatus": { "type": "enum", "members": { "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } } } }, "com.amazonaws.connectcontactlens#RealTimeContactAnalysisSegmentsFilter": { "type": "structure", "members": { "CategoriesAttributeFilter": { "target": "com.amazonaws.connectcontactlens#CategoriesAttributeFilter", "traits": { "smithy.api#documentation": "

A filter applied to category segments based on the tags of the rules that create the\n matched categories.

" } } }, "traits": { "smithy.api#documentation": "

A filter that restricts the segments returned by\n ListRealtimeContactAnalysisSegments. It supports filtering category\n segments by the tags on the rules that create them, which enforces tag-based access\n control on the categories a caller can view.

" } }, "com.amazonaws.connectcontactlens#RealtimeContactAnalysisSegment": { "type": "structure", "members": { "Transcript": { "target": "com.amazonaws.connectcontactlens#Transcript", "traits": { "smithy.api#documentation": "

The analyzed transcript.

" } }, "Categories": { "target": "com.amazonaws.connectcontactlens#Categories", "traits": { "smithy.api#documentation": "

The matched category rules.

" } }, "PostContactSummary": { "target": "com.amazonaws.connectcontactlens#PostContactSummary", "traits": { "smithy.api#documentation": "

Information about the post-contact summary.

" } }, "ExtractedInformation": { "target": "com.amazonaws.connectcontactlens#ExtractedInformation", "traits": { "smithy.api#documentation": "

The extracted information from the conversation.

" } } }, "traits": { "smithy.api#documentation": "

An analyzed segment for a real-time analysis session.

" } }, "com.amazonaws.connectcontactlens#RealtimeContactAnalysisSegments": { "type": "list", "member": { "target": "com.amazonaws.connectcontactlens#RealtimeContactAnalysisSegment" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.connectcontactlens#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectcontactlens#Message" } }, "traits": { "smithy.api#documentation": "

The specified resource was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.connectcontactlens#RuleId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.connectcontactlens#SentimentValue": { "type": "enum", "members": { "POSITIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POSITIVE" } }, "NEUTRAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NEUTRAL" } }, "NEGATIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NEGATIVE" } } } }, "com.amazonaws.connectcontactlens#TagAndConditionList": { "type": "list", "member": { "target": "com.amazonaws.connectcontactlens#TagCondition" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.connectcontactlens#TagComparisonType": { "type": "enum", "members": { "EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EQUALS" } }, "NOT_EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_EQUALS" } } } }, "com.amazonaws.connectcontactlens#TagCondition": { "type": "structure", "members": { "TagKey": { "target": "com.amazonaws.connectcontactlens#TagKey", "traits": { "smithy.api#documentation": "

The tag key in the tag condition.

" } }, "TagValue": { "target": "com.amazonaws.connectcontactlens#TagValue", "traits": { "smithy.api#documentation": "

The tag value in the tag condition.

" } }, "ComparisonType": { "target": "com.amazonaws.connectcontactlens#TagComparisonType", "traits": { "smithy.api#documentation": "

The comparison operator for the tag condition. Valid values: EQUALS |\n NOT_EQUALS.

" } } }, "traits": { "smithy.api#documentation": "

A tag condition that consists of a tag key, a tag value, and a comparison\n operator.

" } }, "com.amazonaws.connectcontactlens#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.connectcontactlens#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.connectcontactlens#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectcontactlens#Message", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The throttling limit has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.connectcontactlens#Transcript": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.connectcontactlens#TranscriptId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the transcript.

", "smithy.api#required": {} } }, "ParticipantId": { "target": "com.amazonaws.connectcontactlens#ParticipantId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the participant. Valid values are CUSTOMER or AGENT.

", "smithy.api#required": {} } }, "ParticipantRole": { "target": "com.amazonaws.connectcontactlens#ParticipantRole", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The role of participant. For example, is it a customer, agent, or system.

", "smithy.api#required": {} } }, "Content": { "target": "com.amazonaws.connectcontactlens#TranscriptContent", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The content of the transcript.

", "smithy.api#required": {} } }, "BeginOffsetMillis": { "target": "com.amazonaws.connectcontactlens#OffsetMillis", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The beginning offset in the contact for this transcript.

", "smithy.api#required": {} } }, "EndOffsetMillis": { "target": "com.amazonaws.connectcontactlens#OffsetMillis", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The end offset in the contact for this transcript.

", "smithy.api#required": {} } }, "Sentiment": { "target": "com.amazonaws.connectcontactlens#SentimentValue", "traits": { "smithy.api#documentation": "

The sentiment detected for this piece of transcript.

" } }, "IssuesDetected": { "target": "com.amazonaws.connectcontactlens#IssuesDetected", "traits": { "smithy.api#documentation": "

List of positions where issues were detected on the transcript.

" } }, "LanguageCode": { "target": "com.amazonaws.connectcontactlens#LanguageCode", "traits": { "smithy.api#documentation": "

The language code detected for this piece of transcript, for example, en-US.

" } } }, "traits": { "smithy.api#documentation": "

A list of messages in the session.

" } }, "com.amazonaws.connectcontactlens#TranscriptContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.connectcontactlens#TranscriptId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "\\S" } } } }