/AWS1/IF_STG=>DELETETAPEARCHIVE()

About DeleteTapeArchive

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

Method Signature

METHODS /AWS1/IF_STG~DELETETAPEARCHIVE
  IMPORTING
    !IV_TAPEARN TYPE /AWS1/STGTAPEARN OPTIONAL
    !IV_BYPASSGOVERNANCERETENTION TYPE /AWS1/STGBOOLEAN2 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_stgdeltapearchiveout
  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_tapearn TYPE /AWS1/STGTAPEARN /AWS1/STGTAPEARN

The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).

Optional arguments:

iv_bypassgovernanceretention TYPE /AWS1/STGBOOLEAN2 /AWS1/STGBOOLEAN2

Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.

RETURNING

oo_output TYPE REF TO /aws1/cl_stgdeltapearchiveout /AWS1/CL_STGDELTAPEARCHIVEOUT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

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->deletetapearchive(
  iv_bypassgovernanceretention = ABAP_TRUE
  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 delete a virtual tape from the shelf (VTS)

Deletes the specified virtual tape from the virtual tape shelf (VTS).

DATA(lo_result) = lo_client->deletetapearchive( iv_tapearn = |arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0| ) .