CANCELRETRIEVAL()`¶

About CancelRetrieval¶

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

Method Signature¶

METHODS /AWS1/IF_STG~CANCELRETRIEVAL
  IMPORTING
    !IV_GATEWAYARN TYPE /AWS1/STGGATEWAYARN OPTIONAL
    !IV_TAPEARN TYPE /AWS1/STGTAPEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_stgcancretrievalout
  RAISING
    /AWS1/CX_STGINTERNALSERVERERR
    /AWS1/CX_STGINVALIDGWREQUESTEX
    /AWS1/CX_STGCLIENTEXC
    /AWS1/CX_STGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_gatewayarn` `TYPE /AWS1/STGGATEWAYARN` `/AWS1/STGGATEWAYARN`¶

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

`iv_tapearn` `TYPE /AWS1/STGTAPEARN` `/AWS1/STGTAPEARN`¶

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_stgcancretrievalout` `/AWS1/CL_STGCANCRETRIEVALOUT`¶

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->cancelretrieval(
  iv_gatewayarn = |string|
  iv_tapearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_tapearn = lo_result->get_tapearn( ).
ENDIF.

To cancel virtual tape retrieval¶

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.

DATA(lo_result) = lo_client->cancelretrieval(
  iv_gatewayarn = |arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B|
  iv_tapearn = |arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4|
).

/AWS1/IF_STG=>CANCELRETRIEVAL()¶