ConnectParticipant / Client / start_attachment_upload

start_attachment_upload#

ConnectParticipant.Client.start_attachment_upload(**kwargs)#

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

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.start_attachment_upload(
    ContentType='string',
    AttachmentSizeInBytes=123,
    AttachmentName='string',
    ClientToken='string',
    ConnectionToken='string'
)
Parameters:

  • ContentType (string) –

    [REQUIRED]

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

    [REQUIRED]

    The size of the attachment in bytes.

  • AttachmentName (string) –

    [REQUIRED]

    A case-sensitive name of the attachment being uploaded.

  • ClientToken (string) –

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • ConnectionToken (string) –

    [REQUIRED]

    The authentication token associated with the participant’s connection.

Return type:

dict

Returns:

Response Syntax

{
    'AttachmentId': 'string',
    'UploadMetadata': {
        'Url': 'string',
        'UrlExpiry': 'string',
        'HeadersToInclude': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • AttachmentId (string) –

      A unique identifier for the attachment.

    • UploadMetadata (dict) –

      The headers to be provided while uploading the file to the URL.

      • 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.

      • HeadersToInclude (dict) –

        The headers to be provided while uploading the file to the URL.

        • (string) –

          • (string) –

Exceptions