DESCRIBEBACKUPS()`¶

About DescribeBackups¶

Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.

Method Signature¶

METHODS /AWS1/IF_HS2~DESCRIBEBACKUPS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/HS2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/HS2BACKUPSMAXSIZE OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_HS2STRINGS_W=>TT_FILTERS OPTIONAL
    !IV_SHARED TYPE /AWS1/HS2BOOLEAN OPTIONAL
    !IV_SORTASCENDING TYPE /AWS1/HS2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_hs2descrbackupsrsp
  RAISING
    /AWS1/CX_HS2CLOUDHSMACCDENIE00
    /AWS1/CX_HS2CLOUDHSMINTERNAL00
    /AWS1/CX_HS2CLOUDHSMINVREQEX
    /AWS1/CX_HS2CLOUDHSMRESRCNOT00
    /AWS1/CX_HS2CLOUDHSMSERVICEEX
    /AWS1/CX_HS2CLOUDHSMTAGEX
    /AWS1/CX_HS2CLIENTEXC
    /AWS1/CX_HS2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/HS2NEXTTOKEN` `/AWS1/HS2NEXTTOKEN`¶

The NextToken value that you received in the previous response. Use this value to get more backups.

`iv_maxresults` `TYPE /AWS1/HS2BACKUPSMAXSIZE` `/AWS1/HS2BACKUPSMAXSIZE`¶

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

`it_filters` `TYPE /AWS1/CL_HS2STRINGS_W=>TT_FILTERS` `TT_FILTERS`¶

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

`iv_shared` `TYPE /AWS1/HS2BOOLEAN` `/AWS1/HS2BOOLEAN`¶

Describe backups that are shared with you.

By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

`iv_sortascending` `TYPE /AWS1/HS2BOOLEAN` `/AWS1/HS2BOOLEAN`¶

Designates whether or not to sort the return backups by ascending chronological order of generation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_hs2descrbackupsrsp` `/AWS1/CL_HS2DESCRBACKUPSRSP`¶

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->describebackups(
  it_filters = VALUE /aws1/cl_hs2strings_w=>tt_filters(
    (
      VALUE /aws1/cl_hs2strings_w=>ts_filters_maprow(
        key = |string|
        value = VALUE /aws1/cl_hs2strings_w=>tt_strings(
          ( new /aws1/cl_hs2strings_w( |string| ) )
        )
      )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_shared = ABAP_TRUE
  iv_sortascending = ABAP_TRUE
).

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_backups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_backupid = lo_row_1->get_backupid( ).
      lv_backuparn = lo_row_1->get_backuparn( ).
      lv_backupstate = lo_row_1->get_backupstate( ).
      lv_clusterid = lo_row_1->get_clusterid( ).
      lv_timestamp = lo_row_1->get_createtimestamp( ).
      lv_timestamp = lo_row_1->get_copytimestamp( ).
      lv_boolean = lo_row_1->get_neverexpires( ).
      lv_region = lo_row_1->get_sourceregion( ).
      lv_backupid = lo_row_1->get_sourcebackup( ).
      lv_clusterid = lo_row_1->get_sourcecluster( ).
      lv_timestamp = lo_row_1->get_deletetimestamp( ).
      LOOP AT lo_row_1->get_taglist( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_tagkey = lo_row_3->get_key( ).
          lv_tagvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_hsmtype = lo_row_1->get_hsmtype( ).
      lv_clustermode = lo_row_1->get_mode( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_HS2=>DESCRIBEBACKUPS()¶