Skip to content

Returns a presigned download URL for an attachment that is associated with a case communication

Description

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 add_attachments_to_set and attachments uploaded through get_attachment_upload_links. 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.

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

Usage

support_get_attachment_download_link(attachmentId, dryRun)

Arguments

  • attachmentId

[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 describe_communications or describe_cases.

  • dryRun

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.

Value

A list with the following syntax:

list(
  fileName = "string",
  downloadUrl = list(
    url = "string",
    expiryDate = "string"
  )
)

Request syntax

svc$get_attachment_download_link(
  attachmentId = "string",
  dryRun = TRUE|FALSE
)