<?php
// This file was auto-generated from sdk-root/src/data/connectparticipant/2018-09-07/docs-2.json
return [ 'version' => '2.0', 'service' => '<ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Participant_Service.html">Participant Service actions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Participant_Service.html">Participant Service data types</a> </p> </li> </ul> <p>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. </p> <p>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.</p>', 'operations' => [ 'CancelParticipantAuthentication' => '<p>Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.</p> <note> <p>The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.</p> </note> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'CompleteAttachmentUpload' => '<p>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.</p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'CreateParticipantConnection' => '<p>Creates the participant\'s connection. </p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <p>For WebRTC security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-webrtc-security">Amazon Connect WebRTC security best practices</a>. </p> <note> <p> <code>ParticipantToken</code> is used for invoking this API instead of <code>ConnectionToken</code>.</p> </note> <p>The participant token is valid for the lifetime of the participant – until they are part of a contact. For WebRTC participants, if they leave or are disconnected for 60 seconds, a new participant needs to be created using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateParticipant.html">CreateParticipant</a> API. </p> <p> <b>For <code>WEBSOCKET</code> Type</b>: </p> <p>The response URL for has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. </p> <p>For chat, you need to publish the following on the established websocket connection:</p> <p> <code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code> </p> <p>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.</p> <p>The expiry time for the connection token is different than the <code>ChatDurationInMinutes</code>. Expiry time for the connection token is 1 day.</p> <p> <b>For <code>WEBRTC_CONNECTION</code> Type</b>: </p> <p>The response includes connection data required for the client application to join the call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains Meeting and Attendee information needed to establish the media connection. </p> <p>The attendee join token in WebRTCConnection response is valid for the lifetime of the participant in the call. If a participant leaves or is disconnected for 60 seconds, their participant credentials will no longer be valid, and a new participant will need to be created to rejoin the call. </p> <p> <b>Message streaming support</b>: This API can also be used together with the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a> API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat message streaming</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p> <b>Multi-user web, in-app, video calling support</b>: </p> <p>For WebRTC calls, this API is used in conjunction with the CreateParticipant API to enable multi-party calling. The StartWebRTCContact API creates the initial contact and routes it to an agent, while CreateParticipant adds additional participants to the ongoing call. For more information about multi-party WebRTC calls, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-multiuser-inapp.html">Enable multi-user web, in-app, and video calling</a> in the <i>Amazon Connect Administrator Guide</i>. </p> <p> <b>Feature specifications</b>: For information about feature specifications, such as the allowed number of open websocket connections per participant or maximum number of WebRTC participants, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>. </p> <note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p> </note>', 'DescribeView' => '<p>Retrieves the view for the specified view token.</p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>', 'DisconnectParticipant' => '<p>Disconnects a participant. </p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'GetAttachment' => '<p>Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.</p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <note> <ul> <li> <p>The participant role <code>CUSTOM_BOT</code> is not permitted to access attachments customers may upload. An <code>AccessDeniedException</code> can indicate that the participant may be a CUSTOM_BOT, and it doesn\'t have access to attachments.</p> </li> <li> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </li> </ul> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'GetAuthenticationUrl' => '<p>Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. </p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p> <note> <ul> <li> <p>This API can only be called within one minute of receiving the authenticationInitiated event.</p> </li> <li> <p>The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.</p> </li> </ul> </note> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'GetTranscript' => '<p>Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>. </p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <p>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:</p> <ul> <li> <p> <code>application/vnd.amazonaws.connect.event.participant.invited</code> </p> </li> <li> <p> <code>application/vnd.amazonaws.connect.event.participant.joined</code> </p> </li> <li> <p> <code>application/vnd.amazonaws.connect.event.participant.left</code> </p> </li> <li> <p> <code>application/vnd.amazonaws.connect.event.chat.ended</code> </p> </li> <li> <p> <code>application/vnd.amazonaws.connect.event.transfer.succeeded</code> </p> </li> <li> <p> <code>application/vnd.amazonaws.connect.event.transfer.failed</code> </p> </li> </ul> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'SendEvent' => '<note> <p>The <code>application/vnd.amazonaws.connect.event.connection.acknowledged</code> ContentType is no longer maintained since December 31, 2024. This event has been migrated to the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API using the <code>ConnectParticipant</code> field.</p> </note> <p>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.</p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'SendMessage' => '<p>Sends a message.</p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', 'StartAttachmentUpload' => '<p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.</p> <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p> <note> <p> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>.</p> </note> <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>.</p>', ], 'shapes' => [ 'ARN' => [ 'base' => NULL, 'refs' => [ 'View$Arn' => '<p>The Amazon Resource Name (ARN) of the view.</p>', ], ], 'AccessDeniedException' => [ 'base' => '<p>You do not have sufficient access to perform this action.</p>', 'refs' => [], ], 'ArtifactId' => [ 'base' => NULL, 'refs' => [ 'AttachmentIdList$member' => NULL, 'AttachmentItem$AttachmentId' => '<p>A unique identifier for the attachment.</p>', 'GetAttachmentRequest$AttachmentId' => '<p>A unique identifier for the attachment.</p>', 'StartAttachmentUploadResponse$AttachmentId' => '<p>A unique identifier for the attachment.</p>', ], ], 'ArtifactStatus' => [ 'base' => NULL, 'refs' => [ 'AttachmentItem$Status' => '<p>Status of the attachment.</p>', ], ], 'AttachmentIdList' => [ 'base' => NULL, 'refs' => [ 'CompleteAttachmentUploadRequest$AttachmentIds' => '<p>A list of unique identifiers for the attachments.</p>', ], ], 'AttachmentItem' => [ 'base' => '<p>The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.</p>', 'refs' => [ 'Attachments$member' => NULL, ], ], 'AttachmentName' => [ 'base' => NULL, 'refs' => [ 'AttachmentItem$AttachmentName' => '<p>A case-sensitive name of the attachment being uploaded.</p>', 'StartAttachmentUploadRequest$AttachmentName' => '<p>A case-sensitive name of the attachment being uploaded.</p>', ], ], 'AttachmentSizeInBytes' => [ 'base' => NULL, 'refs' => [ 'GetAttachmentResponse$AttachmentSizeInBytes' => '<p>The size of the attachment in bytes.</p>', 'StartAttachmentUploadRequest$AttachmentSizeInBytes' => '<p>The size of the attachment in bytes.</p>', ], ], 'Attachments' => [ 'base' => NULL, 'refs' => [ 'Item$Attachments' => '<p>Provides information about the attachments.</p>', ], ], 'Attendee' => [ 'base' => '<p>The attendee information, including attendee ID and join token.</p>', 'refs' => [ 'WebRTCConnection$Attendee' => NULL, ], ], 'AttendeeId' => [ 'base' => NULL, 'refs' => [ 'Attendee$AttendeeId' => '<p>The Amazon Chime SDK attendee ID.</p>', ], ], 'AudioFeatures' => [ 'base' => '<p>Has audio-specific configurations as the operating parameter for Echo Reduction.</p>', 'refs' => [ 'MeetingFeaturesConfiguration$Audio' => '<p>The configuration settings for the audio features available to a meeting.</p>', ], ], 'AuthenticationUrl' => [ 'base' => NULL, 'refs' => [ 'GetAuthenticationUrlResponse$AuthenticationUrl' => '<p>The URL where the customer will sign in to the identity provider. This URL contains the authorize endpoint for the Cognito UserPool used in the authentication.</p>', ], ], 'Bool' => [ 'base' => NULL, 'refs' => [ 'CreateParticipantConnectionRequest$ConnectParticipant' => '<p>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.</p>', ], ], 'CancelParticipantAuthenticationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelParticipantAuthenticationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ChatContent' => [ 'base' => NULL, 'refs' => [ 'Item$Content' => '<p>The content of the message or event.</p>', 'SendEventRequest$Content' => '<p>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.</p> <p>Sample Content: "{\\"messageId\\":\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\"}"</p>', 'SendMessageRequest$Content' => '<p>The content of the message. </p> <ul> <li> <p>For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are Minimum of 1, Maximum of 1024. </p> </li> <li> <p>For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of 12000. </p> </li> <li> <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length Constraints are Minimum of 1, Maximum of 12288.</p> </li> </ul>', ], ], 'ChatContentType' => [ 'base' => NULL, 'refs' => [ 'Item$ContentType' => '<p>The type of content of the item.</p>', 'SendEventRequest$ContentType' => '<p>The content type of the request. Supported types are:</p> <ul> <li> <p>application/vnd.amazonaws.connect.event.typing</p> </li> <li> <p>application/vnd.amazonaws.connect.event.connection.acknowledged (is no longer maintained since December 31, 2024) </p> </li> <li> <p>application/vnd.amazonaws.connect.event.message.delivered</p> </li> <li> <p>application/vnd.amazonaws.connect.event.message.read</p> </li> </ul>', 'SendMessageRequest$ContentType' => '<p>The type of the content. Possible types are <code>text/plain</code>, <code>text/markdown</code>, <code>application/json</code>, and <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p> <p>Supported types on the contact are configured through <code>SupportedMessagingContentTypes</code> on <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a> and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html">StartOutboundChatContact</a>.</p> <p> For Apple Messages for Business, SMS, and WhatsApp Business Messaging contacts, only <code>text/plain</code> is supported.</p>', ], ], 'ChatItemId' => [ 'base' => NULL, 'refs' => [ 'Item$Id' => '<p>The ID of the item.</p>', 'MessageMetadata$MessageId' => '<p>The identifier of the message that contains the metadata information. </p>', 'SendEventResponse$Id' => '<p>The ID of the response.</p>', 'SendMessageResponse$Id' => '<p>The ID of the message.</p>', 'StartPosition$Id' => '<p>The ID of the message or event where to start. </p>', ], ], 'ChatItemType' => [ 'base' => NULL, 'refs' => [ 'Item$Type' => '<p>Type of the item: message or event. </p>', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'DisconnectParticipantRequest$ClientToken' => '<p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>', 'SendEventRequest$ClientToken' => '<p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>', 'SendMessageRequest$ClientToken' => '<p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>', ], ], 'CompleteAttachmentUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CompleteAttachmentUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConflictException' => [ 'base' => '<p>The requested operation conflicts with the current state of a service resource associated with the request. </p>', 'refs' => [], ], 'ConnectionCredentials' => [ 'base' => '<p>Connection credentials. </p>', 'refs' => [ 'CreateParticipantConnectionResponse$ConnectionCredentials' => '<p>Creates the participant\'s connection credentials. The authentication token associated with the participant\'s connection.</p>', ], ], 'ConnectionType' => [ 'base' => NULL, 'refs' => [ 'ConnectionTypeList$member' => NULL, ], ], 'ConnectionTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateParticipantConnectionRequest$Type' => '<p>Type of connection information required. If you need <code>CONNECTION_CREDENTIALS</code> along with marking participant as connected, pass <code>CONNECTION_CREDENTIALS</code> in <code>Type</code>.</p>', ], ], 'ContactId' => [ 'base' => NULL, 'refs' => [ 'GetTranscriptRequest$ContactId' => '<p>The contactId from the current contact chain for which transcript is needed.</p>', 'GetTranscriptResponse$InitialContactId' => '<p>The initial contact ID for the contact. </p>', 'Item$RelatedContactId' => '<p>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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>', 'Item$ContactId' => '<p>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.</p>', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'AttachmentItem$ContentType' => '<p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>', 'StartAttachmentUploadRequest$ContentType' => '<p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>', ], ], 'CreateParticipantConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateParticipantConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeViewRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeViewResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisconnectParticipantRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisconnectParticipantResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'Item$DisplayName' => '<p>The chat display name of the sender.</p>', ], ], 'GetAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAuthenticationUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAuthenticationUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTranscriptRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTranscriptResponse' => [ 'base' => NULL, 'refs' => [], ], 'GuidString' => [ 'base' => NULL, 'refs' => [ 'WebRTCMeeting$MeetingId' => '<p>The Amazon Chime SDK meeting ID.</p>', ], ], 'ISO8601Datetime' => [ 'base' => NULL, 'refs' => [ 'ConnectionCredentials$Expiry' => '<p>The expiration of the token.</p> <p>It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>', 'GetAttachmentResponse$UrlExpiry' => '<p>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.</p>', 'UploadMetadata$UrlExpiry' => '<p>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.</p>', 'Websocket$ConnectionExpiry' => '<p>The URL expiration timestamp in ISO date format.</p> <p>It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>', ], ], 'Instant' => [ 'base' => NULL, 'refs' => [ 'Item$AbsoluteTime' => '<p>The time when the message or event was sent.</p> <p>It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>', 'Receipt$DeliveredTimestamp' => '<p>The time when the message was delivered to the recipient.</p>', 'Receipt$ReadTimestamp' => '<p>The time when the message was read by the recipient.</p>', 'SendEventResponse$AbsoluteTime' => '<p>The time when the event was sent.</p> <p>It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>', 'SendMessageResponse$AbsoluteTime' => '<p>The time when the message was sent.</p> <p>It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>', 'StartPosition$AbsoluteTime' => '<p>The time in ISO format where to start.</p> <p>It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>', ], ], 'InternalServerException' => [ 'base' => '<p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>', 'refs' => [], ], 'Item' => [ 'base' => '<p>An item - message or event - that has been sent. </p>', 'refs' => [ 'Transcript$member' => NULL, ], ], 'JoinToken' => [ 'base' => NULL, 'refs' => [ 'Attendee$JoinToken' => '<p>The join token used by the Amazon Chime SDK attendee.</p>', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'GetTranscriptRequest$MaxResults' => '<p>The maximum number of results to return in the page. Default: 10. </p>', ], ], 'MeetingFeatureStatus' => [ 'base' => NULL, 'refs' => [ 'AudioFeatures$EchoReduction' => '<p>Makes echo reduction available to clients who connect to the meeting.</p>', ], ], 'MeetingFeaturesConfiguration' => [ 'base' => '<p>The configuration settings of the features available to a meeting.</p>', 'refs' => [ 'WebRTCMeeting$MeetingFeatures' => NULL, ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'InternalServerException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, ], ], 'MessageMetadata' => [ 'base' => '<p>Contains metadata related to a message.</p>', 'refs' => [ 'Item$MessageMetadata' => '<p>The metadata related to the message. Currently this supports only information related to message receipts.</p>', ], ], 'MostRecent' => [ 'base' => NULL, 'refs' => [ 'StartPosition$MostRecent' => '<p>The start position of the most recent message where you want to start. </p>', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetTranscriptRequest$NextToken' => '<p>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</p>', 'GetTranscriptResponse$NextToken' => '<p>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</p>', ], ], 'NonEmptyClientToken' => [ 'base' => NULL, 'refs' => [ 'CompleteAttachmentUploadRequest$ClientToken' => '<p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>', 'StartAttachmentUploadRequest$ClientToken' => '<p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>', ], ], 'ParticipantId' => [ 'base' => NULL, 'refs' => [ 'Item$ParticipantId' => '<p>The ID of the sender in the session.</p>', 'Receipt$RecipientParticipantId' => '<p>The identifier of the recipient of the message. </p>', ], ], 'ParticipantRole' => [ 'base' => NULL, 'refs' => [ 'Item$ParticipantRole' => '<p>The role of the sender. For example, is it a customer, agent, or system.</p>', ], ], 'ParticipantToken' => [ 'base' => NULL, 'refs' => [ 'CancelParticipantAuthenticationRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', 'CompleteAttachmentUploadRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', 'ConnectionCredentials$ConnectionToken' => '<p>The connection token.</p>', 'CreateParticipantConnectionRequest$ParticipantToken' => '<p>This is a header parameter.</p> <p>The ParticipantToken as obtained from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a> API response.</p>', 'DescribeViewRequest$ConnectionToken' => '<p>The connection token.</p>', 'DisconnectParticipantRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', 'GetAttachmentRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', 'GetAuthenticationUrlRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', 'GetTranscriptRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', 'SendEventRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', 'SendMessageRequest$ConnectionToken' => '<p>The authentication token associated with the connection.</p>', 'StartAttachmentUploadRequest$ConnectionToken' => '<p>The authentication token associated with the participant\'s connection.</p>', ], ], 'PreSignedAttachmentUrl' => [ 'base' => NULL, 'refs' => [ 'GetAttachmentResponse$Url' => '<p>This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html">StartAttachmentUpload</a>.</p>', ], ], 'PreSignedConnectionUrl' => [ 'base' => NULL, 'refs' => [ 'Websocket$Url' => '<p>The URL of the websocket.</p>', ], ], 'Reason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'Receipt' => [ 'base' => '<p>The receipt for the message delivered to the recipient.</p>', 'refs' => [ 'Receipts$member' => NULL, ], ], 'Receipts' => [ 'base' => NULL, 'refs' => [ 'MessageMetadata$Receipts' => '<p>The list of receipt information for a message for different recipients.</p>', ], ], 'RedirectURI' => [ 'base' => NULL, 'refs' => [ 'GetAuthenticationUrlRequest$RedirectUri' => '<p>The URL where the customer will be redirected after Amazon Cognito authorizes the user.</p>', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$ResourceId' => '<p>The identifier of the resource.</p>', ], ], 'ResourceNotFoundException' => [ 'base' => '<p>The resource was not found.</p>', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$ResourceType' => '<p>The type of Amazon Connect resource.</p>', ], ], 'ScanDirection' => [ 'base' => NULL, 'refs' => [ 'GetTranscriptRequest$ScanDirection' => '<p>The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition. </p>', ], ], 'SendEventRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendEventResponse' => [ 'base' => NULL, 'refs' => [], ], 'SendMessageRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendMessageResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServiceQuotaExceededException' => [ 'base' => '<p>The number of attachments per contact exceeds the quota.</p>', 'refs' => [], ], 'SessionId' => [ 'base' => NULL, 'refs' => [ 'CancelParticipantAuthenticationRequest$SessionId' => '<p>The <code>sessionId</code> provided in the <code>authenticationInitiated</code> event.</p>', 'GetAuthenticationUrlRequest$SessionId' => '<p>The sessionId provided in the authenticationInitiated event.</p>', ], ], 'SortKey' => [ 'base' => NULL, 'refs' => [ 'GetTranscriptRequest$SortOrder' => '<p>The sort order for the records. Default: DESCENDING.</p>', ], ], 'StartAttachmentUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAttachmentUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartPosition' => [ 'base' => '<p>A filtering option for where to start. For example, if you sent 100 messages, start with message 50. </p>', 'refs' => [ 'GetTranscriptRequest$StartPosition' => '<p>A filtering option for where to start.</p>', ], ], 'ThrottlingException' => [ 'base' => '<p>The request was denied due to request throttling.</p>', 'refs' => [], ], 'Transcript' => [ 'base' => NULL, 'refs' => [ 'GetTranscriptResponse$Transcript' => '<p>The list of messages in the session.</p>', ], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'WebRTCMediaPlacement$AudioHostUrl' => '<p>The audio host URL.</p>', 'WebRTCMediaPlacement$AudioFallbackUrl' => '<p>The audio fallback URL.</p>', 'WebRTCMediaPlacement$SignalingUrl' => '<p>The signaling URL.</p>', 'WebRTCMediaPlacement$EventIngestionUrl' => '<p>The event ingestion URL to which you send client meeting events.</p>', ], ], 'URLExpiryInSeconds' => [ 'base' => NULL, 'refs' => [ 'GetAttachmentRequest$UrlExpiryInSeconds' => '<p>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.</p>', ], ], 'UploadMetadata' => [ 'base' => '<p>Fields to be used while uploading the attachment.</p>', 'refs' => [ 'StartAttachmentUploadResponse$UploadMetadata' => '<p>The headers to be provided while uploading the file to the URL.</p>', ], ], 'UploadMetadataSignedHeaders' => [ 'base' => NULL, 'refs' => [ 'UploadMetadata$HeadersToInclude' => '<p>The headers to be provided while uploading the file to the URL.</p>', ], ], 'UploadMetadataSignedHeadersKey' => [ 'base' => NULL, 'refs' => [ 'UploadMetadataSignedHeaders$key' => NULL, ], ], 'UploadMetadataSignedHeadersValue' => [ 'base' => NULL, 'refs' => [ 'UploadMetadataSignedHeaders$value' => NULL, ], ], 'UploadMetadataUrl' => [ 'base' => NULL, 'refs' => [ 'UploadMetadata$Url' => '<p>This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html">StartAttachmentUpload</a>.</p>', ], ], 'ValidationException' => [ 'base' => '<p>The input fails to satisfy the constraints specified by Amazon Connect.</p>', 'refs' => [], ], 'View' => [ 'base' => '<p>A view resource object. Contains metadata and content necessary to render the view.</p>', 'refs' => [ 'DescribeViewResponse$View' => '<p>A view resource object. Contains metadata and content necessary to render the view.</p>', ], ], 'ViewAction' => [ 'base' => NULL, 'refs' => [ 'ViewActions$member' => NULL, ], ], 'ViewActions' => [ 'base' => NULL, 'refs' => [ 'ViewContent$Actions' => '<p>A list of actions possible from the view</p>', ], ], 'ViewContent' => [ 'base' => '<p>View content containing all content necessary to render a view except for runtime input data.</p>', 'refs' => [ 'View$Content' => '<p>View content containing all content necessary to render a view except for runtime input data.</p>', ], ], 'ViewId' => [ 'base' => NULL, 'refs' => [ 'View$Id' => '<p>The identifier of the view.</p>', ], ], 'ViewInputSchema' => [ 'base' => NULL, 'refs' => [ 'ViewContent$InputSchema' => '<p>The schema representing the input data that the view template must be supplied to render.</p>', ], ], 'ViewName' => [ 'base' => NULL, 'refs' => [ 'View$Name' => '<p>The name of the view.</p>', ], ], 'ViewTemplate' => [ 'base' => NULL, 'refs' => [ 'ViewContent$Template' => '<p>The view template representing the structure of the view.</p>', ], ], 'ViewToken' => [ 'base' => NULL, 'refs' => [ 'DescribeViewRequest$ViewToken' => '<p>An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.</p>', ], ], 'ViewVersion' => [ 'base' => NULL, 'refs' => [ 'View$Version' => '<p>The current version of the view.</p>', ], ], 'WebRTCConnection' => [ 'base' => '<p>Creates the participant’s WebRTC connection data required for the client application (mobile or web) to connect to the call.</p>', 'refs' => [ 'CreateParticipantConnectionResponse$WebRTCConnection' => '<p>Creates the participant\'s WebRTC connection data required for the client application (mobile application or website) to connect to the call. </p>', ], ], 'WebRTCMediaPlacement' => [ 'base' => '<p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>', 'refs' => [ 'WebRTCMeeting$MediaPlacement' => '<p>The media placement for the meeting.</p>', ], ], 'WebRTCMeeting' => [ 'base' => '<p>A meeting created using the Amazon Chime SDK.</p>', 'refs' => [ 'WebRTCConnection$Meeting' => '<p>A meeting created using the Amazon Chime SDK.</p>', ], ], 'Websocket' => [ 'base' => '<p>The websocket for the participant\'s connection.</p>', 'refs' => [ 'CreateParticipantConnectionResponse$Websocket' => '<p>Creates the participant\'s websocket connection.</p>', ], ], ],];
