Menu
AWS Support
API Reference (API Version 2013-04-15)

DescribeAttachment

Returns the attachment that has the specified ID. 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.

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

The attachment content and file name.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: