Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetAttachment

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

For security recommendations, see Amazon Connect Chat security best practices.

Note

The participant role CUSTOM_BOT is not permitted to access attachments customers may upload. An AccessDeniedException can indicate that the participant may be a CUSTOM_BOT, and it doesn't have access to attachments.
ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Request Syntax


POST /participant/attachment HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "AttachmentId": "string",
   "UrlExpiryInSeconds": number
}

URI Request Parameters

The request uses the following URI parameters.

ConnectionToken

The authentication token associated with the participant's connection.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

Request Body

The request accepts the following data in JSON format.

AttachmentId

A unique identifier for the attachment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

UrlExpiryInSeconds

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.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 300.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AttachmentSizeInBytes": number,
   "Url": "string",
   "UrlExpiry": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AttachmentSizeInBytes

The size of the attachment in bytes.

Type: Long

Valid Range: Minimum value of 1.

Url

This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

UrlExpiry

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the Amazon Connect service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by Amazon Connect.

HTTP Status Code: 400