GETATTACHMENTDOWNLOADLINK()`¶

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

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.

Method Signature¶

METHODS /AWS1/IF_SUP~GETATTACHMENTDOWNLOADLINK
  IMPORTING
    !IV_ATTACHMENTID TYPE /AWS1/SUPATTACHMENTID OPTIONAL
    !IV_DRYRUN TYPE /AWS1/SUPNULLABLEBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_supgetatmtdwnlinkrsp
  RAISING
    /AWS1/CX_SUPATTACHMENTIDNOTFND
    /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 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.

Optional arguments:¶

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

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_supgetatmtdwnlinkrsp` `/AWS1/CL_SUPGETATMTDWNLINKRSP`¶

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->getattachmentdownloadlink(
  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.
  lv_filename = lo_result->get_filename( ).
  lo_downloadurl = lo_result->get_downloadurl( ).
  IF lo_downloadurl IS NOT INITIAL.
    lv_httpsurl = lo_downloadurl->get_url( ).
    lv_validateddatetime = lo_downloadurl->get_expirydate( ).
  ENDIF.
ENDIF.

/AWS1/IF_SUP=>GETATTACHMENTDOWNLOADLINK()¶