DESCRIBEATTACHMENT()`¶

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

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.

DescribeAttachment can't return attachments larger than 5 MB. If the specified attachmentId refers to an attachment larger than 5 MB, the request fails with InvalidParameterValueException.

To download an attachment of any size, including attachments larger than 5 MB, use GetAttachmentDownloadLink. GetAttachmentDownloadLink returns an Amazon S3 presigned URL that you can use to download the attachment directly.

Method Signature¶

METHODS /AWS1/IF_SUP~DESCRIBEATTACHMENT
  IMPORTING
    !IV_ATTACHMENTID TYPE /AWS1/SUPATTACHMENTID OPTIONAL
    !IV_DRYRUN TYPE /AWS1/SUPNULLABLEBOOLEANTYPE OPTIONAL
  PREFERRED PARAMETER iv_attachmentid
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_supdescrattachmentrsp
  RAISING
    /AWS1/CX_SUPATTACHMENTIDNOTFND
    /AWS1/CX_SUPDSCATTACHMENTLMT00
    /AWS1/CX_SUPDRYRUNOPEXCEPTION
    /AWS1/CX_SUPINTERNALSERVERERR
    /AWS1/CX_SUPCLIENTEXC
    /AWS1/CX_SUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_attachmentid` `TYPE /AWS1/SUPATTACHMENTID` `/AWS1/SUPATTACHMENTID`¶

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

If the specified attachment is larger than 5 MB, this operation returns InvalidParameterValueException. To download attachments larger than 5 MB, use GetAttachmentDownloadLink.

Optional arguments:¶

`iv_dryrun` `TYPE /AWS1/SUPNULLABLEBOOLEANTYPE` `/AWS1/SUPNULLABLEBOOLEANTYPE`¶

Specifies whether to validate the request without actually retrieving the attachment. When set to true, the request is validated but no attachment content is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_supdescrattachmentrsp` `/AWS1/CL_SUPDESCRATTACHMENTRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describeattachment(
  iv_attachmentid = |string|
  iv_dryrun = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_attachment = lo_result->get_attachment( ).
  IF lo_attachment IS NOT INITIAL.
    lv_filename = lo_attachment->get_filename( ).
    lv_data = lo_attachment->get_data( ).
  ENDIF.
ENDIF.

/AWS1/IF_SUP=>DESCRIBEATTACHMENT()¶