Skip to content

/AWS1/IF_BUP=>LISTINDEXEDRECOVERYPOINTS()

About ListIndexedRecoveryPoints

This operation returns a list of recovery points that have an associated index, belonging to the specified account.

Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.

Method Signature

METHODS /AWS1/IF_BUP~LISTINDEXEDRECOVERYPOINTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BUPMAXRESULTS OPTIONAL
    !IV_SOURCERESOURCEARN TYPE /AWS1/BUPARN OPTIONAL
    !IV_CREATEDBEFORE TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_CREATEDAFTER TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/BUPRESOURCETYPE OPTIONAL
    !IV_INDEXSTATUS TYPE /AWS1/BUPINDEXSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_buplistidxedrecptsout
  RAISING
    /AWS1/CX_BUPINVPARAMVALUEEX
    /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 recovery points.

For example, if a request is made to return MaxResults number of indexed recovery points, 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 resource list items to be returned.

iv_sourceresourcearn TYPE /AWS1/BUPARN /AWS1/BUPARN

A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

iv_createdbefore TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only indexed recovery points that were created before the specified date.

iv_createdafter TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only indexed recovery points that were created after the specified date.

iv_resourcetype TYPE /AWS1/BUPRESOURCETYPE /AWS1/BUPRESOURCETYPE

Returns a list of indexed recovery points for the specified resource type(s).

Accepted values include:

  • EBS for Amazon Elastic Block Store

  • S3 for Amazon Simple Storage Service (Amazon S3)

iv_indexstatus TYPE /AWS1/BUPINDEXSTATUS /AWS1/BUPINDEXSTATUS

Include this parameter to filter the returned list by the indicated statuses.

Accepted values: PENDING | ACTIVE | FAILED | DELETING

A recovery point with an index that has the status of ACTIVE can be included in a search.

RETURNING

oo_output TYPE REF TO /aws1/cl_buplistidxedrecptsout /AWS1/CL_BUPLISTIDXEDRECPTSOUT

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->listindexedrecoverypoints(
  iv_createdafter = '20150101000000.0000000'
  iv_createdbefore = '20150101000000.0000000'
  iv_indexstatus = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourcetype = |string|
  iv_sourceresourcearn = |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_indexedrecoverypoints( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_recoverypointarn( ).
      lv_arn = lo_row_1->get_sourceresourcearn( ).
      lv_arn = lo_row_1->get_iamrolearn( ).
      lv_timestamp = lo_row_1->get_backupcreationdate( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_timestamp = lo_row_1->get_indexcreationdate( ).
      lv_indexstatus = lo_row_1->get_indexstatus( ).
      lv_string = lo_row_1->get_indexstatusmessage( ).
      lv_arn = lo_row_1->get_backupvaultarn( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.