Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" }, "CreateParticipantConnection": { "name": "CreateParticipantConnection", "http": { "method": "POST", "requestUri": "/participant/connection" }, "input": { "shape": "CreateParticipantConnectionRequest" }, "output": { "shape": "CreateParticipantConnectionResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" } ], "documentation": "Creates the participant's connection.
ParticipantToken is used for invoking this API instead of ConnectionToken.
The participant token is valid for the lifetime of the participant – until they are part of a contact.
The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.
For chat, you need to publish the following on the established websocket connection:
{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.
Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Retrieves the view for the specified view token.
" }, "DisconnectParticipant": { "name": "DisconnectParticipant", "http": { "method": "POST", "requestUri": "/participant/disconnect" }, "input": { "shape": "DisconnectParticipantRequest" }, "output": { "shape": "DisconnectParticipantResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" } ], "documentation": "Disconnects a participant.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" }, "GetAttachment": { "name": "GetAttachment", "http": { "method": "POST", "requestUri": "/participant/attachment" }, "input": { "shape": "GetAttachmentRequest" }, "output": { "shape": "GetAttachmentResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" } ], "documentation": "Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" }, "GetTranscript": { "name": "GetTranscript", "http": { "method": "POST", "requestUri": "/participant/transcript" }, "input": { "shape": "GetTranscriptRequest" }, "output": { "shape": "GetTranscriptResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" } ], "documentation": "Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat.
If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:
application/vnd.amazonaws.connect.event.participant.left
application/vnd.amazonaws.connect.event.participant.joined
application/vnd.amazonaws.connect.event.chat.ended
application/vnd.amazonaws.connect.event.transfer.succeeded
application/vnd.amazonaws.connect.event.transfer.failed
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" }, "SendEvent": { "name": "SendEvent", "http": { "method": "POST", "requestUri": "/participant/event" }, "input": { "shape": "SendEventRequest" }, "output": { "shape": "SendEventResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" }, { "shape": "ConflictException" } ], "documentation": "The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType will no longer be supported starting December 31, 2024. This event has been migrated to the CreateParticipantConnection API using the ConnectParticipant field.
Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" }, "SendMessage": { "name": "SendMessage", "http": { "method": "POST", "requestUri": "/participant/message" }, "input": { "shape": "SendMessageRequest" }, "output": { "shape": "SendMessageResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" } ], "documentation": "Sends a message.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" }, "StartAttachmentUpload": { "name": "StartAttachmentUpload", "http": { "method": "POST", "requestUri": "/participant/start-attachment-upload" }, "input": { "shape": "StartAttachmentUploadRequest" }, "output": { "shape": "StartAttachmentUploadResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" } }, "shapes": { "ARN": { "type": "string" }, "ArtifactId": { "type": "string", "max": 256, "min": 1 }, "ArtifactStatus": { "type": "string", "enum": [ "APPROVED", "REJECTED", "IN_PROGRESS" ] }, "AttachmentIdList": { "type": "list", "member": { "shape": "ArtifactId" }, "max": 1, "min": 1 }, "AttachmentItem": { "type": "structure", "members": { "ContentType": { "shape": "ContentType", "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": { "shape": "ArtifactId", "documentation": "A unique identifier for the attachment.
" }, "AttachmentName": { "shape": "AttachmentName", "documentation": "A case-sensitive name of the attachment being uploaded.
" }, "Status": { "shape": "ArtifactStatus", "documentation": "Status of the attachment.
" } }, "documentation": "The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.
" }, "AttachmentName": { "type": "string", "max": 256, "min": 1 }, "AttachmentSizeInBytes": { "type": "long", "min": 1 }, "Attachments": { "type": "list", "member": { "shape": "AttachmentItem" } }, "Bool": { "type": "boolean" }, "ChatContent": { "type": "string", "max": 16384, "min": 1 }, "ChatContentType": { "type": "string", "max": 100, "min": 1 }, "ChatItemId": { "type": "string", "max": 256, "min": 1 }, "ChatItemType": { "type": "string", "enum": [ "TYPING", "PARTICIPANT_JOINED", "PARTICIPANT_LEFT", "CHAT_ENDED", "TRANSFER_SUCCEEDED", "TRANSFER_FAILED", "MESSAGE", "EVENT", "ATTACHMENT", "CONNECTION_ACK", "MESSAGE_DELIVERED", "MESSAGE_READ" ] }, "ClientToken": { "type": "string", "max": 500 }, "CompleteAttachmentUploadRequest": { "type": "structure", "required": [ "AttachmentIds", "ClientToken", "ConnectionToken" ], "members": { "AttachmentIds": { "shape": "AttachmentIdList", "documentation": "A list of unique identifiers for the attachments.
" }, "ClientToken": { "shape": "NonEmptyClientToken", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken": true }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The authentication token associated with the participant's connection.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "CompleteAttachmentUploadResponse": { "type": "structure", "members": {} }, "ConnectionCredentials": { "type": "structure", "members": { "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The connection token.
" }, "Expiry": { "shape": "ISO8601Datetime", "documentation": "The expiration of the token.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } }, "documentation": "Connection credentials.
" }, "ConnectionType": { "type": "string", "enum": [ "WEBSOCKET", "CONNECTION_CREDENTIALS" ] }, "ConnectionTypeList": { "type": "list", "member": { "shape": "ConnectionType" }, "min": 1 }, "ContactId": { "type": "string", "max": 256, "min": 1 }, "ContentType": { "type": "string", "max": 255, "min": 1 }, "CreateParticipantConnectionRequest": { "type": "structure", "required": [ "ParticipantToken" ], "members": { "Type": { "shape": "ConnectionTypeList", "documentation": "Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.
This is a header parameter.
The ParticipantToken as obtained from StartChatContact API response.
", "location": "header", "locationName": "X-Amz-Bearer" }, "ConnectParticipant": { "shape": "Bool", "documentation": "Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.
" } } }, "CreateParticipantConnectionResponse": { "type": "structure", "members": { "Websocket": { "shape": "Websocket", "documentation": "Creates the participant's websocket connection.
" }, "ConnectionCredentials": { "shape": "ConnectionCredentials", "documentation": "Creates the participant's connection credentials. The authentication token associated with the participant's connection.
" } } }, "DescribeViewRequest": { "type": "structure", "required": [ "ViewToken", "ConnectionToken" ], "members": { "ViewToken": { "shape": "ViewToken", "documentation": "An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.
", "location": "uri", "locationName": "ViewToken" }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The connection token.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "DescribeViewResponse": { "type": "structure", "members": { "View": { "shape": "View", "documentation": "A view resource object. Contains metadata and content necessary to render the view.
" } } }, "DisconnectParticipantRequest": { "type": "structure", "required": [ "ConnectionToken" ], "members": { "ClientToken": { "shape": "ClientToken", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken": true }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The authentication token associated with the participant's connection.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "DisconnectParticipantResponse": { "type": "structure", "members": {} }, "DisplayName": { "type": "string", "max": 256, "min": 1 }, "GetAttachmentRequest": { "type": "structure", "required": [ "AttachmentId", "ConnectionToken" ], "members": { "AttachmentId": { "shape": "ArtifactId", "documentation": "A unique identifier for the attachment.
" }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The authentication token associated with the participant's connection.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "GetAttachmentResponse": { "type": "structure", "members": { "Url": { "shape": "PreSignedAttachmentUrl", "documentation": "This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
" }, "UrlExpiry": { "shape": "ISO8601Datetime", "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.
" } } }, "GetTranscriptRequest": { "type": "structure", "required": [ "ConnectionToken" ], "members": { "ContactId": { "shape": "ContactId", "documentation": "The contactId from the current contact chain for which transcript is needed.
" }, "MaxResults": { "shape": "MaxResults", "documentation": "The maximum number of results to return in the page. Default: 10.
", "box": true }, "NextToken": { "shape": "NextToken", "documentation": "The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
" }, "ScanDirection": { "shape": "ScanDirection", "documentation": "The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
" }, "SortOrder": { "shape": "SortKey", "documentation": "The sort order for the records. Default: DESCENDING.
" }, "StartPosition": { "shape": "StartPosition", "documentation": "A filtering option for where to start.
" }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The authentication token associated with the participant's connection.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "GetTranscriptResponse": { "type": "structure", "members": { "InitialContactId": { "shape": "ContactId", "documentation": "The initial contact ID for the contact.
" }, "Transcript": { "shape": "Transcript", "documentation": "The list of messages in the session.
" }, "NextToken": { "shape": "NextToken", "documentation": "The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
" } } }, "ISO8601Datetime": { "type": "string" }, "Instant": { "type": "string", "max": 100, "min": 1 }, "Item": { "type": "structure", "members": { "AbsoluteTime": { "shape": "Instant", "documentation": "The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" }, "Content": { "shape": "ChatContent", "documentation": "The content of the message or event.
" }, "ContentType": { "shape": "ChatContentType", "documentation": "The type of content of the item.
" }, "Id": { "shape": "ChatItemId", "documentation": "The ID of the item.
" }, "Type": { "shape": "ChatItemType", "documentation": "Type of the item: message or event.
" }, "ParticipantId": { "shape": "ParticipantId", "documentation": "The ID of the sender in the session.
" }, "DisplayName": { "shape": "DisplayName", "documentation": "The chat display name of the sender.
" }, "ParticipantRole": { "shape": "ParticipantRole", "documentation": "The role of the sender. For example, is it a customer, agent, or system.
" }, "Attachments": { "shape": "Attachments", "documentation": "Provides information about the attachments.
" }, "MessageMetadata": { "shape": "MessageMetadata", "documentation": "The metadata related to the message. Currently this supports only information related to message receipts.
" }, "RelatedContactId": { "shape": "ContactId", "documentation": "The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.
" }, "ContactId": { "shape": "ContactId", "documentation": "The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.
" } }, "documentation": "An item - message or event - that has been sent.
" }, "MaxResults": { "type": "integer", "max": 100, "min": 0 }, "MessageMetadata": { "type": "structure", "members": { "MessageId": { "shape": "ChatItemId", "documentation": "The identifier of the message that contains the metadata information.
" }, "Receipts": { "shape": "Receipts", "documentation": "The list of receipt information for a message for different recipients.
" } }, "documentation": "Contains metadata related to a message.
" }, "MostRecent": { "type": "integer", "max": 100, "min": 0 }, "NextToken": { "type": "string", "max": 1000, "min": 1 }, "NonEmptyClientToken": { "type": "string", "max": 500, "min": 1 }, "ParticipantId": { "type": "string", "max": 256, "min": 1 }, "ParticipantRole": { "type": "string", "enum": [ "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT", "SUPERVISOR" ] }, "ParticipantToken": { "type": "string", "max": 1000, "min": 1 }, "PreSignedAttachmentUrl": { "type": "string", "max": 2000, "min": 1 }, "PreSignedConnectionUrl": { "type": "string", "max": 2000, "min": 1 }, "Receipt": { "type": "structure", "members": { "DeliveredTimestamp": { "shape": "Instant", "documentation": "The time when the message was delivered to the recipient.
" }, "ReadTimestamp": { "shape": "Instant", "documentation": "The time when the message was read by the recipient.
" }, "RecipientParticipantId": { "shape": "ParticipantId", "documentation": "The identifier of the recipient of the message.
" } }, "documentation": "The receipt for the message delivered to the recipient.
" }, "Receipts": { "type": "list", "member": { "shape": "Receipt" } }, "ScanDirection": { "type": "string", "enum": [ "FORWARD", "BACKWARD" ] }, "SendEventRequest": { "type": "structure", "required": [ "ContentType", "ConnectionToken" ], "members": { "ContentType": { "shape": "ChatContentType", "documentation": "The content type of the request. Supported types are:
application/vnd.amazonaws.connect.event.typing
application/vnd.amazonaws.connect.event.connection.acknowledged (will be deprecated on December 31, 2024)
application/vnd.amazonaws.connect.event.message.delivered
application/vnd.amazonaws.connect.event.message.read
The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.
Sample Content: \"{\\\"messageId\\\":\\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\\"}\"
" }, "ClientToken": { "shape": "ClientToken", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken": true }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The authentication token associated with the participant's connection.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "SendEventResponse": { "type": "structure", "members": { "Id": { "shape": "ChatItemId", "documentation": "The ID of the response.
" }, "AbsoluteTime": { "shape": "Instant", "documentation": "The time when the event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } } }, "SendMessageRequest": { "type": "structure", "required": [ "ContentType", "Content", "ConnectionToken" ], "members": { "ContentType": { "shape": "ChatContentType", "documentation": "The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.
The content of the message.
For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken": true }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The authentication token associated with the connection.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "SendMessageResponse": { "type": "structure", "members": { "Id": { "shape": "ChatItemId", "documentation": "The ID of the message.
" }, "AbsoluteTime": { "shape": "Instant", "documentation": "The time when the message was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } } }, "SortKey": { "type": "string", "enum": [ "DESCENDING", "ASCENDING" ] }, "StartAttachmentUploadRequest": { "type": "structure", "required": [ "ContentType", "AttachmentSizeInBytes", "AttachmentName", "ClientToken", "ConnectionToken" ], "members": { "ContentType": { "shape": "ContentType", "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.
" }, "AttachmentSizeInBytes": { "shape": "AttachmentSizeInBytes", "documentation": "The size of the attachment in bytes.
" }, "AttachmentName": { "shape": "AttachmentName", "documentation": "A case-sensitive name of the attachment being uploaded.
" }, "ClientToken": { "shape": "NonEmptyClientToken", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken": true }, "ConnectionToken": { "shape": "ParticipantToken", "documentation": "The authentication token associated with the participant's connection.
", "location": "header", "locationName": "X-Amz-Bearer" } } }, "StartAttachmentUploadResponse": { "type": "structure", "members": { "AttachmentId": { "shape": "ArtifactId", "documentation": "A unique identifier for the attachment.
" }, "UploadMetadata": { "shape": "UploadMetadata", "documentation": "Fields to be used while uploading the attachment.
" } } }, "StartPosition": { "type": "structure", "members": { "Id": { "shape": "ChatItemId", "documentation": "The ID of the message or event where to start.
" }, "AbsoluteTime": { "shape": "Instant", "documentation": "The time in ISO format where to start.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" }, "MostRecent": { "shape": "MostRecent", "documentation": "The start position of the most recent message where you want to start.
" } }, "documentation": "A filtering option for where to start. For example, if you sent 100 messages, start with message 50.
" }, "Transcript": { "type": "list", "member": { "shape": "Item" } }, "UploadMetadata": { "type": "structure", "members": { "Url": { "shape": "UploadMetadataUrl", "documentation": "This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
" }, "UrlExpiry": { "shape": "ISO8601Datetime", "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": { "shape": "UploadMetadataSignedHeaders", "documentation": "The headers to be provided while uploading the file to the URL.
" } }, "documentation": "Fields to be used while uploading the attachment.
" }, "UploadMetadataSignedHeaders": { "type": "map", "key": { "shape": "UploadMetadataSignedHeadersKey" }, "value": { "shape": "UploadMetadataSignedHeadersValue" } }, "UploadMetadataSignedHeadersKey": { "type": "string", "max": 128, "min": 1 }, "UploadMetadataSignedHeadersValue": { "type": "string", "max": 256, "min": 1 }, "UploadMetadataUrl": { "type": "string", "max": 2000, "min": 1 }, "View": { "type": "structure", "members": { "Id": { "shape": "ViewId", "documentation": "The identifier of the view.
" }, "Arn": { "shape": "ARN", "documentation": "The Amazon Resource Name (ARN) of the view.
" }, "Name": { "shape": "ViewName", "documentation": "The name of the view.
" }, "Version": { "shape": "ViewVersion", "documentation": "The current version of the view.
" }, "Content": { "shape": "ViewContent", "documentation": "View content containing all content necessary to render a view except for runtime input data.
" } }, "documentation": "A view resource object. Contains metadata and content necessary to render the view.
" }, "ViewAction": { "type": "string", "max": 255, "min": 1, "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@()']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()']*)$", "sensitive": true }, "ViewActions": { "type": "list", "member": { "shape": "ViewAction" } }, "ViewContent": { "type": "structure", "members": { "InputSchema": { "shape": "ViewInputSchema", "documentation": "The schema representing the input data that the view template must be supplied to render.
" }, "Template": { "shape": "ViewTemplate", "documentation": "The view template representing the structure of the view.
" }, "Actions": { "shape": "ViewActions", "documentation": "A list of actions possible from the view
" } }, "documentation": "View content containing all content necessary to render a view except for runtime input data.
" }, "ViewId": { "type": "string", "max": 500, "min": 1, "pattern": "^[a-zA-Z0-9\\_\\-:\\/$]+$" }, "ViewInputSchema": { "type": "string", "sensitive": true }, "ViewName": { "type": "string", "max": 255, "min": 1, "pattern": "^([\\p{L}\\p{N}_.:\\/=+\\-@()']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()']*)$", "sensitive": true }, "ViewTemplate": { "type": "string", "sensitive": true }, "ViewToken": { "type": "string", "max": 1000, "min": 1 }, "ViewVersion": { "type": "integer" }, "Websocket": { "type": "structure", "members": { "Url": { "shape": "PreSignedConnectionUrl", "documentation": "The URL of the websocket.
" }, "ConnectionExpiry": { "shape": "ISO8601Datetime", "documentation": "The URL expiration timestamp in ISO date format.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } }, "documentation": "The websocket for the participant's connection.
" } }, "documentation": "Amazon Connect is an easy-to-use omnichannel cloud contact center service that enables companies of any size to deliver superior customer service at a lower cost. Amazon Connect communications capabilities make it easy for companies to deliver personalized interactions across communication channels, including chat.
Use the Amazon Connect Participant Service to manage participants (for example, agents, customers, and managers listening in), and to send messages and events within a chat contact. The APIs in the service enable the following: sending chat messages, attachment sharing, managing a participant's connection state and message events, and retrieving chat transcripts.
" }