ConnectParticipant / Client / get_attachment

get_attachment

ConnectParticipant.Client.get_attachment(**kwargs)

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

ConnectionToken is used for invoking this API instead of ParticipantToken.

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

See also: AWS API Documentation

Request Syntax

response = client.get_attachment(
    AttachmentId='string',
    ConnectionToken='string',
    UrlExpiryInSeconds=123
)

Parameters:

• AttachmentId (string) –

  [REQUIRED]

  A unique identifier for the attachment.

• ConnectionToken (string) –

  [REQUIRED]

  The authentication token associated with the participant’s connection.

• UrlExpiryInSeconds (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Url': 'string',
    'UrlExpiry': 'string',
    'AttachmentSizeInBytes': 123
}

Response Structure

• (dict) –

  • Url (string) –

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

  • UrlExpiry (string) –

    The expiration time of the URL in ISO timestamp. It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

  • AttachmentSizeInBytes (integer) –

    The size of the attachment in bytes.

Exceptions

• ConnectParticipant.Client.exceptions.AccessDeniedException

• ConnectParticipant.Client.exceptions.InternalServerException

• ConnectParticipant.Client.exceptions.ThrottlingException

• ConnectParticipant.Client.exceptions.ValidationException