Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAttachment

Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

Note

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API.
If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Request Syntax


{
   "attachmentId": "string"
}

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 ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

Type: String

Response Syntax


{
   "attachment": { 
      "data": blob,
      "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.

attachment

This object includes the attachment content and file name.

In the previous response syntax, the value for the data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

Type: Attachment object

Errors

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

AttachmentIdNotFound

An attachment with the specified ID could not be found.

HTTP Status Code: 400

DescribeAttachmentLimitExceeded

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

HTTP Status Code: 400

InternalServerError

An internal server error occurred.

HTTP Status Code: 500