Support / Client / describe_attachment

describe_attachment#

Support.Client.describe_attachment(**kwargs)#

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 Amazon Web Services Support API.

  • If you call the Amazon Web Services 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 Amazon Web Services Support.

See also: AWS API Documentation

Request Syntax

response = client.describe_attachment(
    attachmentId='string'
)
Parameters:

attachmentId (string) –

[REQUIRED]

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

Return type:

dict

Returns:

Response Syntax

{
    'attachment': {
        'fileName': 'string',
        'data': b'bytes'
    }
}

Response Structure

  • (dict) –

    The content and file name of the attachment returned by the DescribeAttachment operation.

    • attachment (dict) –

      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.

      • fileName (string) –

        The name of the attachment file.

      • data (bytes) –

        The content of the attachment file.

Exceptions

  • Support.Client.exceptions.InternalServerError

  • Support.Client.exceptions.DescribeAttachmentLimitExceeded

  • Support.Client.exceptions.AttachmentIdNotFound