LISTBACKUPPLANS()`¶

About ListBackupPlans¶

Lists the active backup plans for the account.

Method Signature¶

METHODS /AWS1/IF_BUP~LISTBACKUPPLANS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BUPMAXRESULTS OPTIONAL
    !IV_INCLUDEDELETED TYPE /AWS1/BUPBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_buplistbackupplansout
  RAISING
    /AWS1/CX_BUPINVPARAMVALUEEX
    /AWS1/CX_BUPMISSINGPARAMVALEX
    /AWS1/CX_BUPRESOURCENOTFOUNDEX
    /AWS1/CX_BUPSERVICEUNAVAILEX
    /AWS1/CX_BUPCLIENTEXC
    /AWS1/CX_BUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/BUPSTRING` `/AWS1/BUPSTRING`¶

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

`iv_maxresults` `TYPE /AWS1/BUPMAXRESULTS` `/AWS1/BUPMAXRESULTS`¶

The maximum number of items to be returned.

`iv_includedeleted` `TYPE /AWS1/BUPBOOLEAN` `/AWS1/BUPBOOLEAN`¶

A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_buplistbackupplansout` `/AWS1/CL_BUPLISTBACKUPPLANSOUT`¶

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->listbackupplans(
  iv_includedeleted = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_backupplanslist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_backupplanarn( ).
      lv_string = lo_row_1->get_backupplanid( ).
      lv_timestamp = lo_row_1->get_creationdate( ).
      lv_timestamp = lo_row_1->get_deletiondate( ).
      lv_string = lo_row_1->get_versionid( ).
      lv_backupplanname = lo_row_1->get_backupplanname( ).
      lv_string = lo_row_1->get_creatorrequestid( ).
      lv_timestamp = lo_row_1->get_lastexecutiondate( ).
      LOOP AT lo_row_1->get_advancedbackupsettings( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_resourcetype = lo_row_3->get_resourcetype( ).
          LOOP AT lo_row_3->get_backupoptions( ) into ls_row_4.
            lv_key = ls_row_4-key.
            lo_value = ls_row_4-value.
            IF lo_value IS NOT INITIAL.
              lv_backupoptionvalue = lo_value->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_BUP=>LISTBACKUPPLANS()¶