Skip to content

/AWS1/IF_TSI=>LISTDBBACKUPS()

About ListDbBackups

Returns a list of Timestream for InfluxDB backups.

Method Signature

METHODS /AWS1/IF_TSI~LISTDBBACKUPS
  IMPORTING
    !IV_DBRESOURCEID TYPE /AWS1/TSIDBRESOURCEID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/TSINEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/TSIMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tsilistdbbkupsoutput
  RAISING
    /AWS1/CX_TSIACCESSDENIEDEX
    /AWS1/CX_TSIINTERNALSERVEREX
    /AWS1/CX_TSIRESOURCENOTFOUNDEX
    /AWS1/CX_TSITHROTTLINGEX
    /AWS1/CX_TSIVALIDATIONEX
    /AWS1/CX_TSICLIENTEXC
    /AWS1/CX_TSISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_dbresourceid TYPE /AWS1/TSIDBRESOURCEID /AWS1/TSIDBRESOURCEID

The identifier of the DB instance or DB cluster to list backups for. If not specified, returns all backups in the account and region.

iv_nexttoken TYPE /AWS1/TSINEXTTOKEN /AWS1/TSINEXTTOKEN

The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

iv_maxresults TYPE /AWS1/TSIMAXRESULTS /AWS1/TSIMAXRESULTS

The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

RETURNING

oo_output TYPE REF TO /aws1/cl_tsilistdbbkupsoutput /AWS1/CL_TSILISTDBBKUPSOUTPUT

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->listdbbackups(
  iv_dbresourceid = |string|
  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.
  LOOP AT lo_result->get_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_dbbackupid = lo_row_1->get_id( ).
      lv_dbbackupname = lo_row_1->get_name( ).
      lv_arn = lo_row_1->get_arn( ).
      lv_dbbackupstatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_date = lo_row_1->get_expiresafter( ).
      lv_dbresourceid = lo_row_1->get_dbresourceid( ).
      lv_dbbackuptype = lo_row_1->get_type( ).
      lv_enginetype = lo_row_1->get_enginetype( ).
      lv_resourcedeploymenttype = lo_row_1->get_deploymenttype( ).
      lv_kmskeyid = lo_row_1->get_kmskeyid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.