{ "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.connectparticipant#ARN": { "type": "string" }, "com.amazonaws.connectparticipant#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectparticipant#Message", "traits": { "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.connectparticipant#AmazonConnectParticipantServiceLambda": { "type": "service", "version": "2018-09-07", "operations": [ { "target": "com.amazonaws.connectparticipant#CancelParticipantAuthentication" }, { "target": "com.amazonaws.connectparticipant#CompleteAttachmentUpload" }, { "target": "com.amazonaws.connectparticipant#CreateParticipantConnection" }, { "target": "com.amazonaws.connectparticipant#DescribeView" }, { "target": "com.amazonaws.connectparticipant#DisconnectParticipant" }, { "target": "com.amazonaws.connectparticipant#GetAttachment" }, { "target": "com.amazonaws.connectparticipant#GetAuthenticationUrl" }, { "target": "com.amazonaws.connectparticipant#GetTranscript" }, { "target": "com.amazonaws.connectparticipant#SendEvent" }, { "target": "com.amazonaws.connectparticipant#SendMessage" }, { "target": "com.amazonaws.connectparticipant#StartAttachmentUpload" } ], "traits": { "aws.api#service": { "sdkId": "ConnectParticipant", "arnNamespace": "connect", "cloudFormationName": "ConnectParticipant", "cloudTrailEventSource": "connectparticipant.amazonaws.com", "endpointPrefix": "participant.connect" }, "aws.auth#sigv4": { "name": "execute-api" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Use the Connect Customer Participant Service to manage participants (for example,\n agents, customers, and managers listening in), and to send messages and events within a\n chat contact. The APIs in the service enable the following: sending chat messages,\n attachment sharing, managing a participant's connection state and message events, and\n retrieving chat transcripts.
", "smithy.api#title": "Amazon Connect Participant Service", "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 ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "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://participant.connect-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://participant.connect.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://participant.connect-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://participant.connect.{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://participant.connect.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "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://participant.connect-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": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://participant.connect.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://participant.connect-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://participant.connect.{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://participant.connect.{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 us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://participant.connect-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://participant.connect-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://participant.connect.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://participant.connect.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://participant.connect-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://participant.connect-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://participant.connect.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://participant.connect.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://participant.connect.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://participant.connect.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://participant.connect-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://participant.connect.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://participant.connect.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://participant.connect.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://participant.connect-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://participant.connect.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://participant.connect-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://participant.connect.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.connectparticipant#ArtifactId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connectparticipant#ArtifactStatus": { "type": "enum", "members": { "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } } } }, "com.amazonaws.connectparticipant#AttachmentIdList": { "type": "list", "member": { "target": "com.amazonaws.connectparticipant#ArtifactId" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.connectparticipant#AttachmentItem": { "type": "structure", "members": { "ContentType": { "target": "com.amazonaws.connectparticipant#ContentType", "traits": { "smithy.api#documentation": "Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
" } }, "AttachmentId": { "target": "com.amazonaws.connectparticipant#ArtifactId", "traits": { "smithy.api#documentation": "A unique identifier for the attachment.
" } }, "AttachmentName": { "target": "com.amazonaws.connectparticipant#AttachmentName", "traits": { "smithy.api#documentation": "A case-sensitive name of the attachment being uploaded.
" } }, "Status": { "target": "com.amazonaws.connectparticipant#ArtifactStatus", "traits": { "smithy.api#documentation": "Status of the attachment.
" } } }, "traits": { "smithy.api#documentation": "The case-insensitive input to indicate standard MIME type that describes the format of the file\n that will be uploaded.
" } }, "com.amazonaws.connectparticipant#AttachmentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connectparticipant#AttachmentSizeInBytes": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.connectparticipant#Attachments": { "type": "list", "member": { "target": "com.amazonaws.connectparticipant#AttachmentItem" } }, "com.amazonaws.connectparticipant#Attendee": { "type": "structure", "members": { "AttendeeId": { "target": "com.amazonaws.connectparticipant#AttendeeId", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
" } }, "JoinToken": { "target": "com.amazonaws.connectparticipant#JoinToken", "traits": { "smithy.api#documentation": "The join token used by the Amazon Chime SDK attendee.
" } } }, "traits": { "smithy.api#documentation": "The attendee information, including attendee ID and join token.
" } }, "com.amazonaws.connectparticipant#AttendeeId": { "type": "string" }, "com.amazonaws.connectparticipant#AudioFeatures": { "type": "structure", "members": { "EchoReduction": { "target": "com.amazonaws.connectparticipant#MeetingFeatureStatus", "traits": { "smithy.api#documentation": "Makes echo reduction available to clients who connect to the meeting.
" } } }, "traits": { "smithy.api#documentation": "Has audio-specific configurations as the operating parameter for Echo Reduction.
" } }, "com.amazonaws.connectparticipant#AuthenticationUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2083 } } }, "com.amazonaws.connectparticipant#Bool": { "type": "boolean" }, "com.amazonaws.connectparticipant#CancelParticipantAuthentication": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#CancelParticipantAuthenticationRequest" }, "output": { "target": "com.amazonaws.connectparticipant#CancelParticipantAuthenticationResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Cancels the authentication session. The opted out branch of the Authenticate Customer\n flow block will be taken.
\nThe current supported channel is chat. This API is not supported for Apple\n Messages for Business, WhatsApp, or SMS chats.
\n\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/cancel-authentication", "code": 200 } } }, "com.amazonaws.connectparticipant#CancelParticipantAuthenticationRequest": { "type": "structure", "members": { "SessionId": { "target": "com.amazonaws.connectparticipant#SessionId", "traits": { "smithy.api#documentation": "The sessionId provided in the authenticationInitiated\n event.
The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#CancelParticipantAuthenticationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#ChatContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 } } }, "com.amazonaws.connectparticipant#ChatContentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.connectparticipant#ChatItemId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connectparticipant#ChatItemType": { "type": "enum", "members": { "TYPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TYPING" } }, "PARTICIPANT_JOINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTICIPANT_JOINED" } }, "PARTICIPANT_LEFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTICIPANT_LEFT" } }, "CHAT_ENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHAT_ENDED" } }, "TRANSFER_SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_SUCCEEDED" } }, "TRANSFER_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_FAILED" } }, "MESSAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MESSAGE" } }, "EVENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EVENT" } }, "ATTACHMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ATTACHMENT" } }, "CONNECTION_ACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONNECTION_ACK" } }, "MESSAGE_DELIVERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MESSAGE_DELIVERED" } }, "MESSAGE_READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MESSAGE_READ" } } } }, "com.amazonaws.connectparticipant#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.connectparticipant#CompleteAttachmentUpload": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#CompleteAttachmentUploadRequest" }, "output": { "target": "com.amazonaws.connectparticipant#CompleteAttachmentUploadResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#ConflictException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows you to confirm that the attachment has been uploaded using the pre-signed URL\n provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment\n with that identifier is already being uploaded.
\nFor security recommendations, see Connect Customer Chat security best practices.
\n\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/complete-attachment-upload", "code": 200 } } }, "com.amazonaws.connectparticipant#CompleteAttachmentUploadRequest": { "type": "structure", "members": { "AttachmentIds": { "target": "com.amazonaws.connectparticipant#AttachmentIdList", "traits": { "smithy.api#documentation": "A list of unique identifiers for the attachments.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.connectparticipant#NonEmptyClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#CompleteAttachmentUploadResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectparticipant#Reason", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The requested operation conflicts with the current state of a service resource\n associated with the request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.connectparticipant#ConnectionCredentials": { "type": "structure", "members": { "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The connection token.
" } }, "Expiry": { "target": "com.amazonaws.connectparticipant#ISO8601Datetime", "traits": { "smithy.api#documentation": "The expiration of the token.
\nIt's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.
" } } }, "traits": { "smithy.api#documentation": "Connection credentials.
" } }, "com.amazonaws.connectparticipant#ConnectionType": { "type": "enum", "members": { "WEBSOCKET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEBSOCKET" } }, "CONNECTION_CREDENTIALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONNECTION_CREDENTIALS" } }, "WEBRTC_CONNECTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEBRTC_CONNECTION" } } } }, "com.amazonaws.connectparticipant#ConnectionTypeList": { "type": "list", "member": { "target": "com.amazonaws.connectparticipant#ConnectionType" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.connectparticipant#ContactId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connectparticipant#ContentDisposition": { "type": "enum", "members": { "INLINE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INLINE" } }, "ATTACHMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ATTACHMENT" } } } }, "com.amazonaws.connectparticipant#ContentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.connectparticipant#CreateParticipantConnection": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#CreateParticipantConnectionRequest" }, "output": { "target": "com.amazonaws.connectparticipant#CreateParticipantConnectionResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates the participant's connection.
\nFor security recommendations, see Connect Customer Chat security best practices.
\nFor WebRTC security recommendations, see Connect Customer WebRTC security best practices.
\n\n ParticipantToken is used for invoking this API instead of\n ConnectionToken.
The participant token is valid for the lifetime of the participant \u2013 until they are\n part of a contact. For WebRTC participants, if they leave or are disconnected for 60\n seconds, a new participant needs to be created using the CreateParticipant API.
\n\n For WEBSOCKET Type:
The response URL for has a connect expiry timeout of 100s. Clients must manually\n connect to the returned websocket URL and subscribe to the desired topic.
\nFor chat, you need to publish the following on the established websocket\n connection:
\n\n {\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}\n
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,\n clients need to call this API again to obtain a new websocket URL and perform the same\n steps as before.
\nThe expiry time for the connection token is different than the\n ChatDurationInMinutes. Expiry time for the connection token is 1\n day.
\n For WEBRTC_CONNECTION Type:
The response includes connection data required for the client application to join the\n call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains\n Meeting and Attendee information needed to establish the media connection.
\nThe attendee join token in WebRTCConnection response is valid for the lifetime of the\n participant in the call. If a participant leaves or is disconnected for 60 seconds,\n their participant credentials will no longer be valid, and a new participant will need\n to be created to rejoin the call.
\n\n Message streaming support: This API can also be used\n together with the StartContactStreaming API to create a participant connection for chat\n contacts that are not using a websocket. For more information about message streaming,\n Enable real-time chat\n message streaming in the Amazon Connect Administrator\n Guide.
\n\n Multi-user web, in-app, video calling support:
\nFor WebRTC calls, this API is used in conjunction with the CreateParticipant API to\n enable multi-party calling. The StartWebRTCContact API creates the initial contact and\n routes it to an agent, while CreateParticipant adds additional participants to the\n ongoing call. For more information about multi-party WebRTC calls, see Enable multi-user web, in-app, and video calling in the Amazon Connect\n Administrator Guide.
\n\n Feature specifications: For information about feature\n specifications, such as the allowed number of open websocket connections per participant\n or maximum number of WebRTC participants, see Feature specifications in the Amazon Connect Administrator\n Guide.
\nThe Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
\nType of connection information required. If you need\n CONNECTION_CREDENTIALS along with marking participant as connected,\n pass CONNECTION_CREDENTIALS in Type.
This is a header parameter.
\nThe ParticipantToken as obtained from StartChatContact\n API response.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } }, "ConnectParticipant": { "target": "com.amazonaws.connectparticipant#Bool", "traits": { "smithy.api#documentation": "Amazon Connect Participant is used to mark the participant as connected for customer\n participant in message streaming, as well as for agent or manager participant in\n non-streaming chats.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#CreateParticipantConnectionResponse": { "type": "structure", "members": { "Websocket": { "target": "com.amazonaws.connectparticipant#Websocket", "traits": { "smithy.api#documentation": "Creates the participant's websocket connection.
" } }, "ConnectionCredentials": { "target": "com.amazonaws.connectparticipant#ConnectionCredentials", "traits": { "smithy.api#documentation": "Creates the participant's connection credentials. The authentication token associated\n with the participant's connection.
" } }, "WebRTCConnection": { "target": "com.amazonaws.connectparticipant#WebRTCConnection", "traits": { "smithy.api#documentation": "Creates the participant's WebRTC connection data required for the client application\n (mobile application or website) to connect to the call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#DescribeView": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#DescribeViewRequest" }, "output": { "target": "com.amazonaws.connectparticipant#DescribeViewResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ResourceNotFoundException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the view for the specified view token.
\nFor security recommendations, see Connect Customer Chat security best practices.
", "smithy.api#http": { "method": "GET", "uri": "/participant/views/{ViewToken}", "code": 200 } } }, "com.amazonaws.connectparticipant#DescribeViewRequest": { "type": "structure", "members": { "ViewToken": { "target": "com.amazonaws.connectparticipant#ViewToken", "traits": { "smithy.api#documentation": "An encrypted token originating from the interactive message of a ShowView block\n operation. Represents the desired view.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The connection token.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#DescribeViewResponse": { "type": "structure", "members": { "View": { "target": "com.amazonaws.connectparticipant#View", "traits": { "smithy.api#documentation": "A view resource object. Contains metadata and content necessary to render the\n view.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#DisconnectParticipant": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#DisconnectParticipantRequest" }, "output": { "target": "com.amazonaws.connectparticipant#DisconnectParticipantResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Disconnects a participant.
\nFor security recommendations, see Connect Customer Chat security best practices.
\n\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/disconnect", "code": 200 } } }, "com.amazonaws.connectparticipant#DisconnectParticipantRequest": { "type": "structure", "members": { "ClientToken": { "target": "com.amazonaws.connectparticipant#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#DisconnectParticipantResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#DisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connectparticipant#GetAttachment": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#GetAttachmentRequest" }, "output": { "target": "com.amazonaws.connectparticipant#GetAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Provides a pre-signed URL for download of a completed attachment. This is an\n asynchronous API for use with active contacts.
\nFor security recommendations, see Connect Customer Chat security best practices.
\nThe participant role CUSTOM_BOT is not permitted to access\n attachments customers may upload. An AccessDeniedException can\n indicate that the participant may be a CUSTOM_BOT, and it doesn't have\n access to attachments.
\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/attachment", "code": 200 } } }, "com.amazonaws.connectparticipant#GetAttachmentRequest": { "type": "structure", "members": { "AttachmentId": { "target": "com.amazonaws.connectparticipant#ArtifactId", "traits": { "smithy.api#documentation": "A unique identifier for the attachment.
", "smithy.api#required": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } }, "UrlExpiryInSeconds": { "target": "com.amazonaws.connectparticipant#URLExpiryInSeconds", "traits": { "smithy.api#documentation": "The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:\n yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } }, "UrlContentDisposition": { "target": "com.amazonaws.connectparticipant#ContentDisposition", "traits": { "smithy.api#documentation": "Specifies how a browser handles the file at the pre-signed URL. The following values\n are valid:
\nDisplays the file in the browser.
\nDownloads the file. This is the default behavior.
\nThis is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response \nto StartAttachmentUpload.
" } }, "UrlExpiry": { "target": "com.amazonaws.connectparticipant#ISO8601Datetime", "traits": { "smithy.api#documentation": "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.
" } }, "AttachmentSizeInBytes": { "target": "com.amazonaws.connectparticipant#AttachmentSizeInBytes", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The size of the attachment in bytes.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#GetAuthenticationUrl": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#GetAuthenticationUrlRequest" }, "output": { "target": "com.amazonaws.connectparticipant#GetAuthenticationUrlResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the AuthenticationUrl for the current authentication session for the\n AuthenticateCustomer flow block.
\nFor security recommendations, see Connect Customer Chat security best practices.
\nThis API can only be called within one minute of receiving the\n authenticationInitiated event.
\nThe current supported channel is chat. This API is not supported for Apple\n Messages for Business, WhatsApp, or SMS chats.
\n\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/authentication-url", "code": 200 } } }, "com.amazonaws.connectparticipant#GetAuthenticationUrlRequest": { "type": "structure", "members": { "SessionId": { "target": "com.amazonaws.connectparticipant#SessionId", "traits": { "smithy.api#documentation": "The sessionId provided in the authenticationInitiated event.
", "smithy.api#required": {} } }, "RedirectUri": { "target": "com.amazonaws.connectparticipant#RedirectURI", "traits": { "smithy.api#documentation": "The URL where the customer will be redirected after Amazon Cognito authorizes the\n user.
", "smithy.api#required": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#GetAuthenticationUrlResponse": { "type": "structure", "members": { "AuthenticationUrl": { "target": "com.amazonaws.connectparticipant#AuthenticationUrl", "traits": { "smithy.api#documentation": "The URL where the customer will sign in to the identity provider. This URL contains\n the authorize endpoint for the Cognito UserPool used in the authentication.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#GetTranscript": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#GetTranscriptRequest" }, "output": { "target": "com.amazonaws.connectparticipant#GetTranscriptResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves a transcript of the session, including details about any attachments. For\n information about accessing past chat contact transcripts for a persistent chat, see\n Enable persistent chat.
\nFor security recommendations, see Connect Customer Chat security best practices.
\nIf you have a process that consumes events in the transcript of an chat that has\n ended, note that chat transcripts contain the following event content types if the event\n has occurred during the chat session:
\n\n application/vnd.amazonaws.connect.event.participant.invited\n
\n application/vnd.amazonaws.connect.event.participant.joined\n
\n application/vnd.amazonaws.connect.event.participant.left\n
\n application/vnd.amazonaws.connect.event.chat.ended\n
\n application/vnd.amazonaws.connect.event.transfer.succeeded\n
\n application/vnd.amazonaws.connect.event.transfer.failed\n
\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/transcript", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.connectparticipant#GetTranscriptRequest": { "type": "structure", "members": { "ContactId": { "target": "com.amazonaws.connectparticipant#ContactId", "traits": { "smithy.api#documentation": "The contactId from the current contact chain for which transcript is needed.
" } }, "MaxResults": { "target": "com.amazonaws.connectparticipant#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return in the page. Default: 10.
" } }, "NextToken": { "target": "com.amazonaws.connectparticipant#NextToken", "traits": { "smithy.api#documentation": "The pagination token. Use the value returned previously in the next subsequent request\n to retrieve the next set of results.
" } }, "ScanDirection": { "target": "com.amazonaws.connectparticipant#ScanDirection", "traits": { "smithy.api#documentation": "The direction from StartPosition from which to retrieve message. Default: BACKWARD\n when no StartPosition is provided, FORWARD with StartPosition.
" } }, "SortOrder": { "target": "com.amazonaws.connectparticipant#SortKey", "traits": { "smithy.api#documentation": "The sort order for the records. Default: DESCENDING.
" } }, "StartPosition": { "target": "com.amazonaws.connectparticipant#StartPosition", "traits": { "smithy.api#documentation": "A filtering option for where to start.
" } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#GetTranscriptResponse": { "type": "structure", "members": { "InitialContactId": { "target": "com.amazonaws.connectparticipant#ContactId", "traits": { "smithy.api#documentation": "The initial contact ID for the contact.
" } }, "Transcript": { "target": "com.amazonaws.connectparticipant#Transcript", "traits": { "smithy.api#documentation": "The list of messages in the session.
" } }, "NextToken": { "target": "com.amazonaws.connectparticipant#NextToken", "traits": { "smithy.api#documentation": "The pagination token. Use the value returned previously in the next subsequent request\n to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#GuidString": { "type": "string", "traits": { "smithy.api#pattern": "^[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$" } }, "com.amazonaws.connectparticipant#ISO8601Datetime": { "type": "string" }, "com.amazonaws.connectparticipant#Instant": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.connectparticipant#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectparticipant#Message", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This exception occurs when there is an internal failure in the Amazon Connect service.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.connectparticipant#Item": { "type": "structure", "members": { "AbsoluteTime": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "The time when the message or event was sent.
\nIt's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.
" } }, "Content": { "target": "com.amazonaws.connectparticipant#ChatContent", "traits": { "smithy.api#documentation": "The content of the message or event.
" } }, "ContentType": { "target": "com.amazonaws.connectparticipant#ChatContentType", "traits": { "smithy.api#documentation": "The type of content of the item.
" } }, "Id": { "target": "com.amazonaws.connectparticipant#ChatItemId", "traits": { "smithy.api#documentation": "The ID of the item.
" } }, "Type": { "target": "com.amazonaws.connectparticipant#ChatItemType", "traits": { "smithy.api#documentation": "Type of the item: message or event.
" } }, "ParticipantId": { "target": "com.amazonaws.connectparticipant#ParticipantId", "traits": { "smithy.api#documentation": "The ID of the sender in the session.
" } }, "DisplayName": { "target": "com.amazonaws.connectparticipant#DisplayName", "traits": { "smithy.api#documentation": "The chat display name of the sender.
" } }, "ParticipantRole": { "target": "com.amazonaws.connectparticipant#ParticipantRole", "traits": { "smithy.api#documentation": "The role of the sender. For example, is it a customer, agent, or system.
" } }, "Attachments": { "target": "com.amazonaws.connectparticipant#Attachments", "traits": { "smithy.api#documentation": "Provides information about the attachments.
" } }, "MessageMetadata": { "target": "com.amazonaws.connectparticipant#MessageMetadata", "traits": { "smithy.api#documentation": "The metadata related to the message. Currently this supports only information related\n to message receipts.
" } }, "RelatedContactId": { "target": "com.amazonaws.connectparticipant#ContactId", "traits": { "smithy.api#documentation": "The contactId on which the transcript item was originally sent. This field is only\n populated for persistent chats when the transcript item is from the past chat session.\n For more information, see Enable persistent\n chat.
" } }, "ContactId": { "target": "com.amazonaws.connectparticipant#ContactId", "traits": { "smithy.api#documentation": "The contactId on which the transcript item was originally sent. This field is\n populated only when the transcript item is from the current chat session.
" } } }, "traits": { "smithy.api#documentation": "An item - message or event - that has been sent.
" } }, "com.amazonaws.connectparticipant#JoinToken": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.connectparticipant#MaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.connectparticipant#MeetingFeatureStatus": { "type": "enum", "members": { "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNAVAILABLE" } } } }, "com.amazonaws.connectparticipant#MeetingFeaturesConfiguration": { "type": "structure", "members": { "Audio": { "target": "com.amazonaws.connectparticipant#AudioFeatures", "traits": { "smithy.api#documentation": "The configuration settings for the audio features available to a meeting.
" } } }, "traits": { "smithy.api#documentation": "The configuration settings of the features available to a meeting.
" } }, "com.amazonaws.connectparticipant#Message": { "type": "string" }, "com.amazonaws.connectparticipant#MessageMetadata": { "type": "structure", "members": { "MessageId": { "target": "com.amazonaws.connectparticipant#ChatItemId", "traits": { "smithy.api#documentation": "The identifier of the message that contains the metadata information.
" } }, "Receipts": { "target": "com.amazonaws.connectparticipant#Receipts", "traits": { "smithy.api#documentation": "The list of receipt information for a message for different recipients.
" } }, "MessageProcessingStatus": { "target": "com.amazonaws.connectparticipant#MessageProcessingStatus", "traits": { "smithy.api#documentation": "The status of Message Processing for the message.
" } } }, "traits": { "smithy.api#documentation": "Contains metadata related to a message.
" } }, "com.amazonaws.connectparticipant#MessageProcessingMetadata": { "type": "structure", "members": { "MessageProcessingStatus": { "target": "com.amazonaws.connectparticipant#MessageProcessingStatus", "traits": { "smithy.api#documentation": "The status of Message Processing for the message.
" } } }, "traits": { "smithy.api#documentation": "Contains metadata for chat messages.
" } }, "com.amazonaws.connectparticipant#MessageProcessingStatus": { "type": "enum", "members": { "PROCESSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROCESSING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } } } }, "com.amazonaws.connectparticipant#MetadataUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.connectparticipant#MostRecent": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.connectparticipant#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.connectparticipant#NonEmptyClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.connectparticipant#ParticipantId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connectparticipant#ParticipantRole": { "type": "enum", "members": { "AGENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGENT" } }, "CUSTOMER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER" } }, "SYSTEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SYSTEM" } }, "CUSTOM_BOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM_BOT" } }, "SUPERVISOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPERVISOR" } } } }, "com.amazonaws.connectparticipant#ParticipantToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.connectparticipant#PreSignedAttachmentUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.connectparticipant#PreSignedConnectionUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.connectparticipant#Reason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.connectparticipant#Receipt": { "type": "structure", "members": { "DeliveredTimestamp": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "The time when the message was delivered to the recipient.
" } }, "ReadTimestamp": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "The time when the message was read by the recipient.
" } }, "RecipientParticipantId": { "target": "com.amazonaws.connectparticipant#ParticipantId", "traits": { "smithy.api#documentation": "The identifier of the recipient of the message.
" } } }, "traits": { "smithy.api#documentation": "The receipt for the message delivered to the recipient.
" } }, "com.amazonaws.connectparticipant#Receipts": { "type": "list", "member": { "target": "com.amazonaws.connectparticipant#Receipt" } }, "com.amazonaws.connectparticipant#RedirectURI": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.connectparticipant#ResourceId": { "type": "string" }, "com.amazonaws.connectparticipant#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectparticipant#Message" }, "ResourceId": { "target": "com.amazonaws.connectparticipant#ResourceId", "traits": { "smithy.api#documentation": "The identifier of the resource.
" } }, "ResourceType": { "target": "com.amazonaws.connectparticipant#ResourceType", "traits": { "smithy.api#documentation": "The type of Connect Customer resource.
" } } }, "traits": { "smithy.api#documentation": "The resource was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.connectparticipant#ResourceType": { "type": "enum", "members": { "CONTACT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTACT" } }, "CONTACT_FLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTACT_FLOW" } }, "INSTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSTANCE" } }, "PARTICIPANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTICIPANT" } }, "HIERARCHY_LEVEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIERARCHY_LEVEL" } }, "HIERARCHY_GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIERARCHY_GROUP" } }, "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER" } }, "PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHONE_NUMBER" } } } }, "com.amazonaws.connectparticipant#ScanDirection": { "type": "enum", "members": { "FORWARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FORWARD" } }, "BACKWARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKWARD" } } } }, "com.amazonaws.connectparticipant#SendEvent": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#SendEventRequest" }, "output": { "target": "com.amazonaws.connectparticipant#SendEventResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#ConflictException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "The application/vnd.amazonaws.connect.event.connection.acknowledged\n ContentType is no longer maintained since December 31, 2024. This event has been\n migrated to the CreateParticipantConnection API using the\n ConnectParticipant field.
Sends an event. Message receipts are not supported when there are more than two active\n participants in the chat. Using the SendEvent API for message receipts when a supervisor\n is barged-in will result in a conflict exception.
\nFor security recommendations, see Connect Customer Chat security best practices.
\n\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/event", "code": 200 } } }, "com.amazonaws.connectparticipant#SendEventRequest": { "type": "structure", "members": { "ContentType": { "target": "com.amazonaws.connectparticipant#ChatContentType", "traits": { "smithy.api#documentation": "The content type of the request. Supported types are:
\napplication/vnd.amazonaws.connect.event.typing
\napplication/vnd.amazonaws.connect.event.connection.acknowledged (is no longer\n maintained since December 31, 2024)
\napplication/vnd.amazonaws.connect.event.message.delivered
\napplication/vnd.amazonaws.connect.event.message.read
\nThe content of the event to be sent (for example, message text). For content related\n to message receipts, this is supported in the form of a JSON string.
\nSample Content: \"{\\\"messageId\\\":\\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\\"}\"
" } }, "ClientToken": { "target": "com.amazonaws.connectparticipant#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#SendEventResponse": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.connectparticipant#ChatItemId", "traits": { "smithy.api#documentation": "The ID of the response.
" } }, "AbsoluteTime": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "The time when the event was sent.
\nIt's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#SendMessage": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#SendMessageRequest" }, "output": { "target": "com.amazonaws.connectparticipant#SendMessageResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Sends a message.
\nFor security recommendations, see Connect Customer Chat security best practices.
\n\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/message", "code": 200 } } }, "com.amazonaws.connectparticipant#SendMessageRequest": { "type": "structure", "members": { "ContentType": { "target": "com.amazonaws.connectparticipant#ChatContentType", "traits": { "smithy.api#documentation": "The type of the content. Possible types are text/plain,\n text/markdown, application/json, and\n application/vnd.amazonaws.connect.message.interactive.response.\n
Supported types on the contact are configured through\n SupportedMessagingContentTypes on StartChatContact\n and StartOutboundChatContact.
For Apple Messages for Business, SMS, and WhatsApp Business Messaging contacts, only\n text/plain is supported.
The content of the message. Maximum of 16,384 bytes for all content types\n (text/plain, text/markdown, application/json,\n and application/vnd.amazonaws.connect.message.interactive.response).
Some messaging channels enforce lower limits. For channel-specific message size\n limits, see Chat message size limits by channel in the Amazon Connect Customer\n Administrator Guide.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.connectparticipant#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#SendMessageResponse": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.connectparticipant#ChatItemId", "traits": { "smithy.api#documentation": "The ID of the message.
" } }, "AbsoluteTime": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "The time when the message was sent.
\nIt's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.
" } }, "MessageMetadata": { "target": "com.amazonaws.connectparticipant#MessageProcessingMetadata", "traits": { "smithy.api#documentation": "Contains metadata for the message.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectparticipant#Message", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The number of attachments per contact exceeds the quota.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.connectparticipant#SessionId": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 } } }, "com.amazonaws.connectparticipant#SortKey": { "type": "enum", "members": { "DESCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESCENDING" } }, "ASCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASCENDING" } } } }, "com.amazonaws.connectparticipant#StartAttachmentUpload": { "type": "operation", "input": { "target": "com.amazonaws.connectparticipant#StartAttachmentUploadRequest" }, "output": { "target": "com.amazonaws.connectparticipant#StartAttachmentUploadResponse" }, "errors": [ { "target": "com.amazonaws.connectparticipant#AccessDeniedException" }, { "target": "com.amazonaws.connectparticipant#InternalServerException" }, { "target": "com.amazonaws.connectparticipant#ServiceQuotaExceededException" }, { "target": "com.amazonaws.connectparticipant#ThrottlingException" }, { "target": "com.amazonaws.connectparticipant#ValidationException" } ], "traits": { "smithy.api#documentation": "Provides a pre-signed Amazon S3 URL in response for uploading the file directly to\n S3.
\nFor security recommendations, see Connect Customer Chat security best practices.
\n\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.
", "smithy.api#http": { "method": "POST", "uri": "/participant/start-attachment-upload", "code": 200 } } }, "com.amazonaws.connectparticipant#StartAttachmentUploadRequest": { "type": "structure", "members": { "ContentType": { "target": "com.amazonaws.connectparticipant#ContentType", "traits": { "smithy.api#documentation": "Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
", "smithy.api#required": {} } }, "AttachmentSizeInBytes": { "target": "com.amazonaws.connectparticipant#AttachmentSizeInBytes", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The size of the attachment in bytes.
", "smithy.api#required": {} } }, "AttachmentName": { "target": "com.amazonaws.connectparticipant#AttachmentName", "traits": { "smithy.api#documentation": "A case-sensitive name of the attachment being uploaded.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.connectparticipant#NonEmptyClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { "smithy.api#documentation": "The authentication token associated with the participant's connection.
", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.connectparticipant#StartAttachmentUploadResponse": { "type": "structure", "members": { "AttachmentId": { "target": "com.amazonaws.connectparticipant#ArtifactId", "traits": { "smithy.api#documentation": "A unique identifier for the attachment.
" } }, "UploadMetadata": { "target": "com.amazonaws.connectparticipant#UploadMetadata", "traits": { "smithy.api#documentation": "The headers to be provided while uploading the file to the URL.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.connectparticipant#StartPosition": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.connectparticipant#ChatItemId", "traits": { "smithy.api#documentation": "The ID of the message or event where to start.
" } }, "AbsoluteTime": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "The time in ISO format where to start.
\nIt's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.
" } }, "MostRecent": { "target": "com.amazonaws.connectparticipant#MostRecent", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The start position of the most recent message where you want to start.
" } } }, "traits": { "smithy.api#documentation": "A filtering option for where to start. For example, if you sent 100 messages, start\n with message 50.
" } }, "com.amazonaws.connectparticipant#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectparticipant#Message", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.connectparticipant#Transcript": { "type": "list", "member": { "target": "com.amazonaws.connectparticipant#Item" } }, "com.amazonaws.connectparticipant#URI": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.connectparticipant#URLExpiryInSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 5, "max": 300 } } }, "com.amazonaws.connectparticipant#UploadMetadata": { "type": "structure", "members": { "Url": { "target": "com.amazonaws.connectparticipant#MetadataUrl", "traits": { "smithy.api#documentation": "This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response \nto StartAttachmentUpload.
" } }, "UrlExpiry": { "target": "com.amazonaws.connectparticipant#ISO8601Datetime", "traits": { "smithy.api#documentation": "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.
" } }, "HeadersToInclude": { "target": "com.amazonaws.connectparticipant#UrlMetadataSignedHeaders", "traits": { "smithy.api#documentation": "The headers to be provided while uploading the file to the URL.
" } } }, "traits": { "smithy.api#documentation": "Fields to be used while uploading the attachment.
" } }, "com.amazonaws.connectparticipant#UrlMetadataSignedHeaders": { "type": "map", "key": { "target": "com.amazonaws.connectparticipant#UrlMetadataSignedHeadersKey" }, "value": { "target": "com.amazonaws.connectparticipant#UrlMetadataSignedHeadersValue" } }, "com.amazonaws.connectparticipant#UrlMetadataSignedHeadersKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.connectparticipant#UrlMetadataSignedHeadersValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.connectparticipant#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connectparticipant#Reason", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by Amazon Connect.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.connectparticipant#View": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.connectparticipant#ViewId", "traits": { "smithy.api#documentation": "The identifier of the view.
" } }, "Arn": { "target": "com.amazonaws.connectparticipant#ARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the view.
" } }, "Name": { "target": "com.amazonaws.connectparticipant#ViewName", "traits": { "smithy.api#documentation": "The name of the view.
" } }, "Version": { "target": "com.amazonaws.connectparticipant#ViewVersion", "traits": { "smithy.api#documentation": "The current version of the view.
" } }, "Content": { "target": "com.amazonaws.connectparticipant#ViewContent", "traits": { "smithy.api#documentation": "View content containing all content necessary to render a view except for runtime\n input data.
" } } }, "traits": { "smithy.api#documentation": "A view resource object. Contains metadata and content necessary to render the\n view.
" } }, "com.amazonaws.connectparticipant#ViewAction": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@()']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()']*)$", "smithy.api#sensitive": {} } }, "com.amazonaws.connectparticipant#ViewActions": { "type": "list", "member": { "target": "com.amazonaws.connectparticipant#ViewAction" } }, "com.amazonaws.connectparticipant#ViewContent": { "type": "structure", "members": { "InputSchema": { "target": "com.amazonaws.connectparticipant#ViewInputSchema", "traits": { "smithy.api#documentation": "The schema representing the input data that the view template must be supplied to\n render.
" } }, "Template": { "target": "com.amazonaws.connectparticipant#ViewTemplate", "traits": { "smithy.api#documentation": "The view template representing the structure of the view.
" } }, "Actions": { "target": "com.amazonaws.connectparticipant#ViewActions", "traits": { "smithy.api#documentation": "A list of actions possible from the view
" } } }, "traits": { "smithy.api#documentation": "View content containing all content necessary to render a view except for runtime\n input data.
" } }, "com.amazonaws.connectparticipant#ViewId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-:\\/$]+$" } }, "com.amazonaws.connectparticipant#ViewInputSchema": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.connectparticipant#ViewName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@()']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()']*)$", "smithy.api#sensitive": {} } }, "com.amazonaws.connectparticipant#ViewTemplate": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.connectparticipant#ViewToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.connectparticipant#ViewVersion": { "type": "integer" }, "com.amazonaws.connectparticipant#WebRTCConnection": { "type": "structure", "members": { "Attendee": { "target": "com.amazonaws.connectparticipant#Attendee" }, "Meeting": { "target": "com.amazonaws.connectparticipant#WebRTCMeeting", "traits": { "smithy.api#documentation": "A meeting created using the Amazon Chime SDK.
" } } }, "traits": { "smithy.api#documentation": "Creates the participant\u2019s WebRTC connection data required for the client application\n (mobile or web) to connect to the call.
" } }, "com.amazonaws.connectparticipant#WebRTCMediaPlacement": { "type": "structure", "members": { "AudioHostUrl": { "target": "com.amazonaws.connectparticipant#URI", "traits": { "smithy.api#documentation": "The audio host URL.
" } }, "AudioFallbackUrl": { "target": "com.amazonaws.connectparticipant#URI", "traits": { "smithy.api#documentation": "The audio fallback URL.
" } }, "SignalingUrl": { "target": "com.amazonaws.connectparticipant#URI", "traits": { "smithy.api#documentation": "The signaling URL.
" } }, "EventIngestionUrl": { "target": "com.amazonaws.connectparticipant#URI", "traits": { "smithy.api#documentation": "The event ingestion URL to which you send client meeting events.
" } } }, "traits": { "smithy.api#documentation": "A set of endpoints used by clients to connect to the media service group for an\n Amazon Chime SDK meeting.
" } }, "com.amazonaws.connectparticipant#WebRTCMeeting": { "type": "structure", "members": { "MediaPlacement": { "target": "com.amazonaws.connectparticipant#WebRTCMediaPlacement", "traits": { "smithy.api#documentation": "The media placement for the meeting.
" } }, "MeetingFeatures": { "target": "com.amazonaws.connectparticipant#MeetingFeaturesConfiguration" }, "MeetingId": { "target": "com.amazonaws.connectparticipant#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
" } } }, "traits": { "smithy.api#documentation": "A meeting created using the Amazon Chime SDK.
" } }, "com.amazonaws.connectparticipant#Websocket": { "type": "structure", "members": { "Url": { "target": "com.amazonaws.connectparticipant#PreSignedConnectionUrl", "traits": { "smithy.api#documentation": "The URL of the websocket.
" } }, "ConnectionExpiry": { "target": "com.amazonaws.connectparticipant#ISO8601Datetime", "traits": { "smithy.api#documentation": "The URL expiration timestamp in ISO date format.
\nIt's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.
" } } }, "traits": { "smithy.api#documentation": "The websocket for the participant's connection.
" } } } }