DESCRIBETAPES()`¶

About DescribeTapes¶

Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.

The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit field in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of tapes.

Method Signature¶

METHODS /AWS1/IF_STG~DESCRIBETAPES
  IMPORTING
    !IV_GATEWAYARN TYPE /AWS1/STGGATEWAYARN OPTIONAL
    !IT_TAPEARNS TYPE /AWS1/CL_STGTAPEARNS_W=>TT_TAPEARNS OPTIONAL
    !IV_MARKER TYPE /AWS1/STGMARKER OPTIONAL
    !IV_LIMIT TYPE /AWS1/STGPOSITIVEINTOBJECT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_stgdescrtapesoutput
  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`¶

GatewayARN

Optional arguments:¶

`it_tapearns` `TYPE /AWS1/CL_STGTAPEARNS_W=>TT_TAPEARNS` `TT_TAPEARNS`¶

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

`iv_marker` `TYPE /AWS1/STGMARKER` `/AWS1/STGMARKER`¶

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

`iv_limit` `TYPE /AWS1/STGPOSITIVEINTOBJECT` `/AWS1/STGPOSITIVEINTOBJECT`¶

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_stgdescrtapesoutput` `/AWS1/CL_STGDESCRTAPESOUTPUT`¶

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->describetapes(
  it_tapearns = VALUE /aws1/cl_stgtapearns_w=>tt_tapearns(
    ( new /aws1/cl_stgtapearns_w( |string| ) )
  )
  iv_gatewayarn = |string|
  iv_limit = 123
  iv_marker = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_tapes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_tapearn = lo_row_1->get_tapearn( ).
      lv_tapebarcode = lo_row_1->get_tapebarcode( ).
      lv_time = lo_row_1->get_tapecreateddate( ).
      lv_tapesize = lo_row_1->get_tapesizeinbytes( ).
      lv_tapestatus = lo_row_1->get_tapestatus( ).
      lv_vtldevicearn = lo_row_1->get_vtldevice( ).
      lv_doubleobject = lo_row_1->get_progress( ).
      lv_tapeusage = lo_row_1->get_tapeusedinbytes( ).
      lv_kmskey = lo_row_1->get_kmskey( ).
      lv_poolid = lo_row_1->get_poolid( ).
      lv_boolean2 = lo_row_1->get_worm( ).
      lv_time = lo_row_1->get_retentionstartdate( ).
      lv_time = lo_row_1->get_poolentrydate( ).
    ENDIF.
  ENDLOOP.
  lv_marker = lo_result->get_marker( ).
ENDIF.

To describe virtual tape(s) associated with gateway¶

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes.

DATA(lo_result) = lo_client->describetapes(
  it_tapearns = VALUE /aws1/cl_stgtapearns_w=>tt_tapearns(
    ( new /aws1/cl_stgtapearns_w( |arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1| ) )
    ( new /aws1/cl_stgtapearns_w( |arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0| ) )
  )
  iv_gatewayarn = |arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B|
  iv_limit = 2
  iv_marker = |1|
).

/AWS1/IF_STG=>DESCRIBETAPES()¶