openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 48.5 kB

JSON

{"openapi":"3.0.0","info":{"version":"2018-09-07","x-release":"v4","title":"Amazon Connect Participant Service","description":"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.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"connectparticipant","x-aws-signingName":"execute-api","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/connectparticipant-2018-09-07.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/connect/"},"servers":[{"url":"http://participant.connect.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Connect Participant multi-region endpoint"},{"url":"https://participant.connect.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Connect Participant multi-region endpoint"},{"url":"http://participant.connect.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Connect Participant endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://participant.connect.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Connect Participant endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/participant/complete-attachment-upload#X-Amz-Bearer":{"post":{"operationId":"CompleteAttachmentUpload","description":"Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. <note> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>. </note> 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>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteAttachmentUploadResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"The authentication token associated with the participant's connection.","schema":{"type":"string","minLength":1,"maxLength":1000}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AttachmentIds","ClientToken"],"properties":{"AttachmentIds":{"description":"A list of unique identifiers for the attachments.","type":"array","items":{"$ref":"#/components/schemas/ArtifactId"},"minItems":1,"maxItems":1},"ClientToken":{"description":"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>.","type":"string","minLength":1,"maxLength":500}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/participant/connection#X-Amz-Bearer":{"post":{"operationId":"CreateParticipantConnection","description":"Creates the participant's connection. <note> <code>ParticipantToken</code> is used for invoking this API instead of <code>ConnectionToken</code>. </note> The participant token is valid for the lifetime of the participant – until they are part of a contact. The response URL for <code>WEBSOCKET</code> 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: <code>{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}</code> 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 <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 Amazon Connect Administrator Guide. Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits\">Feature specifications</a> in the Amazon Connect Administrator Guide. <note> 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>. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateParticipantConnectionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"This is a header parameter. The ParticipantToken as obtained from <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html\">StartChatContact</a> API response.","schema":{"type":"string","minLength":1,"maxLength":1000}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Type":{"description":"Type of connection information required. This can be omitted if <code>ConnectParticipant</code> is <code>true</code>.","type":"array","items":{"$ref":"#/components/schemas/ConnectionType"},"minItems":1},"ConnectParticipant":{"description":"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.","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/participant/disconnect#X-Amz-Bearer":{"post":{"operationId":"DisconnectParticipant","description":"Disconnects a participant. <note> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>. </note> 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>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisconnectParticipantResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"The authentication token associated with the participant's connection.","schema":{"type":"string","minLength":1,"maxLength":1000}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ClientToken":{"description":"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>.","type":"string","maxLength":500}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/participant/attachment#X-Amz-Bearer":{"post":{"operationId":"GetAttachment","description":"Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. <note> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>. </note> 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>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAttachmentResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"The authentication token associated with the participant's connection.","schema":{"type":"string","minLength":1,"maxLength":1000}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AttachmentId"],"properties":{"AttachmentId":{"description":"A unique identifier for the attachment.","type":"string","minLength":1,"maxLength":256}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/participant/transcript#X-Amz-Bearer":{"post":{"operationId":"GetTranscript","description":"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>. <note> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>. </note> 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>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTranscriptResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"The authentication token associated with the participant's connection.","schema":{"type":"string","minLength":1,"maxLength":1000}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ContactId":{"description":"The contactId from the current contact chain for which transcript is needed.","type":"string","minLength":1,"maxLength":256},"MaxResults":{"description":"The maximum number of results to return in the page. Default: 10. ","type":"integer","minimum":0,"maximum":100},"NextToken":{"description":"The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.","type":"string","minLength":1,"maxLength":1000},"ScanDirection":{"description":"The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition. ","type":"string","enum":["FORWARD","BACKWARD"]},"SortOrder":{"description":"The sort order for the records. Default: DESCENDING.","type":"string","enum":["DESCENDING","ASCENDING"]},"StartPosition":{"description":"A filtering option for where to start. For example, if you sent 100 messages, start with message 50. ","type":"object","properties":{"Id":{"allOf":[{"$ref":"#/components/schemas/ChatItemId"},{"description":"The ID of the message or event where to start. "}]},"AbsoluteTime":{"allOf":[{"$ref":"#/components/schemas/Instant"},{"description":"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":{"allOf":[{"$ref":"#/components/schemas/MostRecent"},{"description":"The start position of the most recent message where you want to start. "}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/participant/event#X-Amz-Bearer":{"post":{"operationId":"SendEvent","description":"Sends an event. <note> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>. </note> 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>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"The authentication token associated with the participant's connection.","schema":{"type":"string","minLength":1,"maxLength":1000}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ContentType"],"properties":{"ContentType":{"description":"The content type of the request. Supported types are: <ul> <li> application/vnd.amazonaws.connect.event.typing </li> <li> application/vnd.amazonaws.connect.event.connection.acknowledged </li> <li> application/vnd.amazonaws.connect.event.message.delivered </li> <li> application/vnd.amazonaws.connect.event.message.read </li> </ul>","type":"string","minLength":1,"maxLength":100},"Content":{"description":"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\\\"}\"","type":"string","minLength":1,"maxLength":16384},"ClientToken":{"description":"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>.","type":"string","maxLength":500}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/participant/message#X-Amz-Bearer":{"post":{"operationId":"SendMessage","description":"Sends a message. <note> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>. </note> 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>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"The authentication token associated with the connection.","schema":{"type":"string","minLength":1,"maxLength":1000}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ContentType","Content"],"properties":{"ContentType":{"description":"The type of the content. Supported types are <code>text/plain</code>, <code>text/markdown</code>, <code>application/json</code>, and <code>application/vnd.amazonaws.connect.message.interactive.response</code>.","type":"string","minLength":1,"maxLength":100},"Content":{"description":"The content of the message. <ul> <li> For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are Minimum of 1, Maximum of 1024. </li> <li> For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of 12000. </li> <li> For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length Constraints are Minimum of 1, Maximum of 12288. </li> </ul>","type":"string","minLength":1,"maxLength":16384},"ClientToken":{"description":"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>.","type":"string","maxLength":500}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/participant/start-attachment-upload#X-Amz-Bearer":{"post":{"operationId":"StartAttachmentUpload","description":"Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. <note> <code>ConnectionToken</code> is used for invoking this API instead of <code>ParticipantToken</code>. </note> 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>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartAttachmentUploadResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Bearer","in":"header","required":true,"description":"The authentication token associated with the participant's connection.","schema":{"type":"string","minLength":1,"maxLength":1000}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ContentType","AttachmentSizeInBytes","AttachmentName","ClientToken"],"properties":{"ContentType":{"description":"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 Amazon Connect Administrator Guide.","type":"string","minLength":1,"maxLength":255},"AttachmentSizeInBytes":{"description":"The size of the attachment in bytes.","type":"integer","minimum":1},"AttachmentName":{"description":"A case-sensitive name of the attachment being uploaded.","type":"string","minLength":1,"maxLength":256},"ClientToken":{"description":"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>.","type":"string","minLength":1,"maxLength":500}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CompleteAttachmentUploadResponse":{"type":"object","properties":{}},"ArtifactId":{"type":"string","minLength":1,"maxLength":256},"AccessDeniedException":{},"InternalServerException":{},"ThrottlingException":{},"ValidationException":{},"ServiceQuotaExceededException":{},"ConflictException":{},"CreateParticipantConnectionResponse":{"type":"object","properties":{"Websocket":{"allOf":[{"$ref":"#/components/schemas/Websocket"},{"description":"Creates the participant's websocket connection."}]},"ConnectionCredentials":{"allOf":[{"$ref":"#/components/schemas/ConnectionCredentials"},{"description":"Creates the participant's connection credentials. The authentication token associated with the participant's connection."}]}}},"ConnectionType":{"type":"string","enum":["WEBSOCKET","CONNECTION_CREDENTIALS"]},"DisconnectParticipantResponse":{"type":"object","properties":{}},"GetAttachmentResponse":{"type":"object","properties":{"Url":{"allOf":[{"$ref":"#/components/schemas/PreSignedAttachmentUrl"},{"description":"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>."}]},"UrlExpiry":{"allOf":[{"$ref":"#/components/schemas/ISO8601Datetime"},{"description":"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."}]}}},"GetTranscriptResponse":{"type":"object","properties":{"InitialContactId":{"allOf":[{"$ref":"#/components/schemas/ContactId"},{"description":"The initial contact ID for the contact. "}]},"Transcript":{"allOf":[{"$ref":"#/components/schemas/Transcript"},{"description":"The list of messages in the session."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"description":"The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results."}]}}},"ChatItemId":{"type":"string","minLength":1,"maxLength":256},"Instant":{"type":"string","minLength":1,"maxLength":100},"MostRecent":{"type":"integer","minimum":0,"maximum":100},"SendEventResponse":{"type":"object","properties":{"Id":{"allOf":[{"$ref":"#/components/schemas/ChatItemId"},{"description":"The ID of the response."}]},"AbsoluteTime":{"allOf":[{"$ref":"#/components/schemas/Instant"},{"description":"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."}]}}},"SendMessageResponse":{"type":"object","properties":{"Id":{"allOf":[{"$ref":"#/components/schemas/ChatItemId"},{"description":"The ID of the message."}]},"AbsoluteTime":{"allOf":[{"$ref":"#/components/schemas/Instant"},{"description":"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."}]}}},"StartAttachmentUploadResponse":{"type":"object","properties":{"AttachmentId":{"allOf":[{"$ref":"#/components/schemas/ArtifactId"},{"description":"A unique identifier for the attachment."}]},"UploadMetadata":{"allOf":[{"$ref":"#/components/schemas/UploadMetadata"},{"description":"Fields to be used while uploading the attachment."}]}}},"ArtifactStatus":{"type":"string","enum":["APPROVED","REJECTED","IN_PROGRESS"]},"AttachmentIdList":{"type":"array","items":{"$ref":"#/components/schemas/ArtifactId"},"minItems":1,"maxItems":1},"ContentType":{"type":"string","minLength":1,"maxLength":255},"AttachmentName":{"type":"string","minLength":1,"maxLength":256},"AttachmentItem":{"type":"object","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"},{"description":"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 Amazon Connect Administrator Guide."}]},"AttachmentId":{"allOf":[{"$ref":"#/components/schemas/ArtifactId"},{"description":"A unique identifier for the attachment."}]},"AttachmentName":{"allOf":[{"$ref":"#/components/schemas/AttachmentName"},{"description":"A case-sensitive name of the attachment being uploaded."}]},"Status":{"allOf":[{"$ref":"#/components/schemas/ArtifactStatus"},{"description":"Status of the attachment."}]}},"description":"The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded."},"AttachmentSizeInBytes":{"type":"integer","minimum":1},"Attachments":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentItem"}},"Bool":{"type":"boolean"},"ChatContent":{"type":"string","minLength":1,"maxLength":16384},"ChatContentType":{"type":"string","minLength":1,"maxLength":100},"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","maxLength":500},"NonEmptyClientToken":{"type":"string","minLength":1,"maxLength":500},"ParticipantToken":{"type":"string","minLength":1,"maxLength":1000},"CompleteAttachmentUploadRequest":{"type":"object","required":["AttachmentIds","ClientToken"],"title":"CompleteAttachmentUploadRequest","properties":{"AttachmentIds":{"allOf":[{"$ref":"#/components/schemas/AttachmentIdList"},{"description":"A list of unique identifiers for the attachments."}]},"ClientToken":{"allOf":[{"$ref":"#/components/schemas/NonEmptyClientToken"},{"description":"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>."}]}}},"ISO8601Datetime":{"type":"string"},"ConnectionCredentials":{"type":"object","properties":{"ConnectionToken":{"allOf":[{"$ref":"#/components/schemas/ParticipantToken"},{"description":"The connection token."}]},"Expiry":{"allOf":[{"$ref":"#/components/schemas/ISO8601Datetime"},{"description":"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."}]}},"description":"Connection credentials. "},"ConnectionTypeList":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionType"},"minItems":1},"ContactId":{"type":"string","minLength":1,"maxLength":256},"CreateParticipantConnectionRequest":{"type":"object","title":"CreateParticipantConnectionRequest","properties":{"Type":{"allOf":[{"$ref":"#/components/schemas/ConnectionTypeList"},{"description":"Type of connection information required. This can be omitted if <code>ConnectParticipant</code> is <code>true</code>."}]},"ConnectParticipant":{"allOf":[{"$ref":"#/components/schemas/Bool"},{"description":"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."}]}}},"Websocket":{"type":"object","properties":{"Url":{"allOf":[{"$ref":"#/components/schemas/PreSignedConnectionUrl"},{"description":"The URL of the websocket."}]},"ConnectionExpiry":{"allOf":[{"$ref":"#/components/schemas/ISO8601Datetime"},{"description":"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."}]}},"description":"The websocket for the participant's connection."},"DisconnectParticipantRequest":{"type":"object","title":"DisconnectParticipantRequest","properties":{"ClientToken":{"allOf":[{"$ref":"#/components/schemas/ClientToken"},{"description":"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>."}]}}},"DisplayName":{"type":"string","minLength":1,"maxLength":256},"GetAttachmentRequest":{"type":"object","required":["AttachmentId"],"title":"GetAttachmentRequest","properties":{"AttachmentId":{"allOf":[{"$ref":"#/components/schemas/ArtifactId"},{"description":"A unique identifier for the attachment."}]}}},"PreSignedAttachmentUrl":{"type":"string","minLength":1,"maxLength":2000},"MaxResults":{"type":"integer","minimum":0,"maximum":100},"NextToken":{"type":"string","minLength":1,"maxLength":1000},"ScanDirection":{"type":"string","enum":["FORWARD","BACKWARD"]},"SortKey":{"type":"string","enum":["DESCENDING","ASCENDING"]},"StartPosition":{"type":"object","properties":{"Id":{"allOf":[{"$ref":"#/components/schemas/ChatItemId"},{"description":"The ID of the message or event where to start. "}]},"AbsoluteTime":{"allOf":[{"$ref":"#/components/schemas/Instant"},{"description":"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":{"allOf":[{"$ref":"#/components/schemas/MostRecent"},{"description":"The start position of the most recent message where you want to start. "}]}},"description":"A filtering option for where to start. For example, if you sent 100 messages, start with message 50. "},"GetTranscriptRequest":{"type":"object","title":"GetTranscriptRequest","properties":{"ContactId":{"allOf":[{"$ref":"#/components/schemas/ContactId"},{"description":"The contactId from the current contact chain for which transcript is needed."}]},"MaxResults":{"allOf":[{"$ref":"#/components/schemas/MaxResults"},{"description":"The maximum number of results to return in the page. Default: 10. "}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/NextToken"},{"description":"The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results."}]},"ScanDirection":{"allOf":[{"$ref":"#/components/schemas/ScanDirection"},{"description":"The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition. "}]},"SortOrder":{"allOf":[{"$ref":"#/components/schemas/SortKey"},{"description":"The sort order for the records. Default: DESCENDING."}]},"StartPosition":{"allOf":[{"$ref":"#/components/schemas/StartPosition"},{"description":"A filtering option for where to start."}]}}},"Transcript":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"ParticipantId":{"type":"string","minLength":1,"maxLength":256},"ParticipantRole":{"type":"string","enum":["AGENT","CUSTOMER","SYSTEM"]},"MessageMetadata":{"type":"object","properties":{"MessageId":{"allOf":[{"$ref":"#/components/schemas/ChatItemId"},{"description":"The identifier of the message that contains the metadata information. "}]},"Receipts":{"allOf":[{"$ref":"#/components/schemas/Receipts"},{"description":"The list of receipt information for a message for different recipients."}]}},"description":"Contains metadata related to a message."},"Item":{"type":"object","properties":{"AbsoluteTime":{"allOf":[{"$ref":"#/components/schemas/Instant"},{"description":"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":{"allOf":[{"$ref":"#/components/schemas/ChatContent"},{"description":"The content of the message or event."}]},"ContentType":{"allOf":[{"$ref":"#/components/schemas/ChatContentType"},{"description":"The type of content of the item."}]},"Id":{"allOf":[{"$ref":"#/components/schemas/ChatItemId"},{"description":"The ID of the item."}]},"Type":{"allOf":[{"$ref":"#/components/schemas/ChatItemType"},{"description":"Type of the item: message or event. "}]},"ParticipantId":{"allOf":[{"$ref":"#/components/schemas/ParticipantId"},{"description":"The ID of the sender in the session."}]},"DisplayName":{"allOf":[{"$ref":"#/components/schemas/DisplayName"},{"description":"The chat display name of the sender."}]},"ParticipantRole":{"allOf":[{"$ref":"#/components/schemas/ParticipantRole"},{"description":"The role of the sender. For example, is it a customer, agent, or system."}]},"Attachments":{"allOf":[{"$ref":"#/components/schemas/Attachments"},{"description":"Provides information about the attachments."}]},"MessageMetadata":{"allOf":[{"$ref":"#/components/schemas/MessageMetadata"},{"description":"The metadata related to the message. Currently this supports only information related to message receipts."}]},"RelatedContactId":{"allOf":[{"$ref":"#/components/schemas/ContactId"},{"description":"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>."}]},"ContactId":{"allOf":[{"$ref":"#/components/schemas/ContactId"},{"description":"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."}]}},"description":"An item - message or event - that has been sent. "},"Receipts":{"type":"array","items":{"$ref":"#/components/schemas/Receipt"}},"PreSignedConnectionUrl":{"type":"string","minLength":1,"maxLength":2000},"Receipt":{"type":"object","properties":{"DeliveredTimestamp":{"allOf":[{"$ref":"#/components/schemas/Instant"},{"description":"The time when the message was delivered to the recipient."}]},"ReadTimestamp":{"allOf":[{"$ref":"#/components/schemas/Instant"},{"description":"The time when the message was read by the recipient."}]},"RecipientParticipantId":{"allOf":[{"$ref":"#/components/schemas/ParticipantId"},{"description":"The identifier of the recipient of the message. "}]}},"description":"The receipt for the message delivered to the recipient."},"SendEventRequest":{"type":"object","required":["ContentType"],"title":"SendEventRequest","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/ChatContentType"},{"description":"The content type of the request. Supported types are: <ul> <li> application/vnd.amazonaws.connect.event.typing </li> <li> application/vnd.amazonaws.connect.event.connection.acknowledged </li> <li> application/vnd.amazonaws.connect.event.message.delivered </li> <li> application/vnd.amazonaws.connect.event.message.read </li> </ul>"}]},"Content":{"allOf":[{"$ref":"#/components/schemas/ChatContent"},{"description":"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":{"allOf":[{"$ref":"#/components/schemas/ClientToken"},{"description":"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>."}]}}},"SendMessageRequest":{"type":"object","required":["ContentType","Content"],"title":"SendMessageRequest","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/ChatContentType"},{"description":"The type of the content. Supported types are <code>text/plain</code>, <code>text/markdown</code>, <code>application/json</code>, and <code>application/vnd.amazonaws.connect.message.interactive.response</code>."}]},"Content":{"allOf":[{"$ref":"#/components/schemas/ChatContent"},{"description":"The content of the message. <ul> <li> For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are Minimum of 1, Maximum of 1024. </li> <li> For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of 12000. </li> <li> For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length Constraints are Minimum of 1, Maximum of 12288. </li> </ul>"}]},"ClientToken":{"allOf":[{"$ref":"#/components/schemas/ClientToken"},{"description":"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>."}]}}},"StartAttachmentUploadRequest":{"type":"object","required":["ContentType","AttachmentSizeInBytes","AttachmentName","ClientToken"],"title":"StartAttachmentUploadRequest","properties":{"ContentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"},{"description":"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 Amazon Connect Administrator Guide."}]},"AttachmentSizeInBytes":{"allOf":[{"$ref":"#/components/schemas/AttachmentSizeInBytes"},{"description":"The size of the attachment in bytes."}]},"AttachmentName":{"allOf":[{"$ref":"#/components/schemas/AttachmentName"},{"description":"A case-sensitive name of the attachment being uploaded."}]},"ClientToken":{"allOf":[{"$ref":"#/components/schemas/NonEmptyClientToken"},{"description":"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>."}]}}},"UploadMetadata":{"type":"object","properties":{"Url":{"allOf":[{"$ref":"#/components/schemas/UploadMetadataUrl"},{"description":"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>."}]},"UrlExpiry":{"allOf":[{"$ref":"#/components/schemas/ISO8601Datetime"},{"description":"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":{"allOf":[{"$ref":"#/components/schemas/UploadMetadataSignedHeaders"},{"description":"The headers to be provided while uploading the file to the URL."}]}},"description":"Fields to be used while uploading the attachment."},"UploadMetadataUrl":{"type":"string","minLength":1,"maxLength":2000},"UploadMetadataSignedHeaders":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/UploadMetadataSignedHeadersValue"}},"UploadMetadataSignedHeadersValue":{"type":"string","minLength":1,"maxLength":256},"UploadMetadataSignedHeadersKey":{"type":"string","minLength":1,"maxLength":128}}},"security":[{"hmac":[]}]}