Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetAttachmentDownloadLink

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 AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan to use the AWS Support API. If you're in an AWS Region that doesn't offer one of these AWS Support plans, or if you haven't transitioned to one of these plans, you can use the AWS Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
If you call the AWS Support API from an account that doesn't have an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Request Syntax


{
   "attachmentId": "string",
   "dryRun": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

attachmentId

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.

Type: String

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.

Type: Boolean

Response Syntax


{
   "downloadUrl": { 
      "expiryDate": "string",
      "url": "string"
   },
   "fileName": "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.

downloadUrl

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

Type: DownloadUrl object

fileName

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

Type: String

Errors

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

AttachmentIdNotFound

An attachment with the specified ID could not be found.

message: An attachment with the specified ID could not be found.

HTTP Status Code: 400

DryRunOperationException

The request was valid, but the operation wasn't performed because dryRun was set to true.

HTTP Status Code: 400

InternalServerError

An internal server error occurred.

message: An internal server error occurred.

HTTP Status Code: 500