Support / Client / get_attachment_download_link

get_attachment_download_link

Support.Client.get_attachment_download_link(**kwargs)

Returns a presigned download URL for an attachment that is associated with a case communication. The download link works for an attachment of any size, including attachments added through AddAttachmentsToSet and attachments uploaded through GetAttachmentUploadLinks. The download URL is time-limited and expires at the date and time indicated in the downloadUrl response field. Download the attachment from the URL before it expires.

Note

• You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you’re in an Amazon Web Services Region that doesn’t offer one of these Amazon Web Services Support plans, or if you haven’t transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.

• If you call the Amazon Web Services Support API from an account that doesn’t have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

See also: AWS API Documentation

Request Syntax

response = client.get_attachment_download_link(
    attachmentId='string',
    dryRun=True|False
)

Parameters:

• attachmentId (string) –

  [REQUIRED]

  The unique identifier of the attachment for which to retrieve a download link. Attachment IDs are returned in the AttachmentDetails objects in the attachments field of a Communication returned by DescribeCommunications or DescribeCases.

• dryRun (boolean) – Specifies whether to validate the request without actually returning a download link. When set to true, the request is validated but no URL is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Return type:

dict

Returns:

Response Syntax

{
    'fileName': 'string',
    'downloadUrl': {
        'url': 'string',
        'expiryDate': 'string'
    }
}

Response Structure

• (dict) –

  • fileName (string) –

    The name of the attachment file, including the file extension.

  • downloadUrl (dict) –

    The presigned download URL and the date and time the URL expires.

    • url (string) –

      The presigned HTTPS URL that you can use to download the attachment. Download URLs are served from downloadv1.attachments.support.{region}.amazonaws.com. The downloadv1 prefix is subject to change.

    • expiryDate (string) –

      The date and time, in ISO-8601 format, when the presigned URL expires. Download the attachment before this time.

Exceptions

• Support.Client.exceptions.AttachmentIdNotFound

• Support.Client.exceptions.InternalServerError

• Support.Client.exceptions.DryRunOperationException