DESCRIBEATCHMTUPLOADSTATUS()`¶

About DescribeAttachmentUploadStatus¶

Returns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks. Use this operation to track where an upload is in the workflow. While parts are still being uploaded and reported through CompleteAttachmentUpload, the uploadStatus is attachment-not-ready and uploadProgress reports the total number of parts and how many have been completed so far. After every part has been reported and the service finishes processing the upload asynchronously, the uploadStatus becomes attachment-ready and the uploadId can be attached to a case through CreateCase or AddCommunicationToCase.

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~DESCRIBEATCHMTUPLOADSTATUS
  IMPORTING
    !IV_UPLOADID TYPE /AWS1/SUPUPLOADID OPTIONAL
    !IV_DRYRUN TYPE /AWS1/SUPNULLABLEBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_supdscatmtupstatusrsp
  RAISING
    /AWS1/CX_SUPDRYRUNOPEXCEPTION
    /AWS1/CX_SUPINTERNALSERVERERR
    /AWS1/CX_SUPUPLOADIDNOTFOUND
    /AWS1/CX_SUPCLIENTEXC
    /AWS1/CX_SUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_uploadid` `TYPE /AWS1/SUPUPLOADID` `/AWS1/SUPUPLOADID`¶

The unique identifier for the upload. The uploadId is returned by GetAttachmentUploadLinks when you initiate the upload.

Optional arguments:¶

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

Specifies whether to validate the request without actually returning upload status. When set to true, the request is validated but no status 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_supdscatmtupstatusrsp` `/AWS1/CL_SUPDSCATMTUPSTATUSRSP`¶

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->describeatchmtuploadstatus(
  iv_dryrun = ABAP_TRUE
  iv_uploadid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uploadstatus = lo_result->get_uploadstatus( ).
  lv_filename = lo_result->get_filename( ).
  lo_uploadprogress = lo_result->get_uploadprogress( ).
  IF lo_uploadprogress IS NOT INITIAL.
    lv_fieldintegervalue = lo_uploadprogress->get_totalparts( ).
    lv_fieldintegervalue = lo_uploadprogress->get_completedpartscount( ).
  ENDIF.
ENDIF.

/AWS1/IF_SUP=>DESCRIBEATCHMTUPLOADSTATUS()¶