/AWS1/IF_BUP=>LISTRECPOINTSBYBACKUPVAULT()

About ListRecoveryPointsByBackupVault

Returns detailed information about the recovery points stored in a backup vault.

Method Signature

METHODS /AWS1/IF_BUP~LISTRECPOINTSBYBACKUPVAULT
  IMPORTING
    !IV_BACKUPVAULTNAME TYPE /AWS1/BUPBACKUPVAULTNAME OPTIONAL
    !IV_BACKUPVAULTACCOUNTID TYPE /AWS1/BUPACCOUNTID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BUPMAXRESULTS OPTIONAL
    !IV_BYRESOURCEARN TYPE /AWS1/BUPARN OPTIONAL
    !IV_BYRESOURCETYPE TYPE /AWS1/BUPRESOURCETYPE OPTIONAL
    !IV_BYBACKUPPLANID TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_BYCREATEDBEFORE TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYCREATEDAFTER TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYPARENTRECOVERYPOINTARN TYPE /AWS1/BUPARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_buplstrecptsbybacku01
  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

Required arguments:

iv_backupvaultname TYPE /AWS1/BUPBACKUPVAULTNAME /AWS1/BUPBACKUPVAULTNAME

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

Backup vault name might not be available when a supported service creates the backup.

Optional arguments:

iv_backupvaultaccountid TYPE /AWS1/BUPACCOUNTID /AWS1/BUPACCOUNTID

This parameter will sort the list of recovery points by account ID.

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_byresourcearn TYPE /AWS1/BUPARN /AWS1/BUPARN

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

iv_byresourcetype TYPE /AWS1/BUPRESOURCETYPE /AWS1/BUPRESOURCETYPE

Returns only recovery points that match the specified resource type(s):

• Aurora for Amazon Aurora

• CloudFormation for CloudFormation

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• DynamoDB for Amazon DynamoDB

• EBS for Amazon Elastic Block Store

• EC2 for Amazon Elastic Compute Cloud

• EFS for Amazon Elastic File System

• FSx for Amazon FSx

• Neptune for Amazon Neptune

• RDS for Amazon Relational Database Service

• Redshift for Amazon Redshift

• S3 for Amazon Simple Storage Service (Amazon S3)

• SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances

• Storage Gateway for Storage Gateway

• Timestream for Amazon Timestream

• VirtualMachine for VMware virtual machines

iv_bybackupplanid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

Returns only recovery points that match the specified backup plan ID.

iv_bycreatedbefore TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only recovery points that were created before the specified timestamp.

iv_bycreatedafter TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only recovery points that were created after the specified timestamp.

iv_byparentrecoverypointarn TYPE /AWS1/BUPARN /AWS1/BUPARN

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

RETURNING

oo_output TYPE REF TO /aws1/cl_buplstrecptsbybacku01 /AWS1/CL_BUPLSTRECPTSBYBACKU01

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->listrecpointsbybackupvault(
  iv_backupvaultaccountid = |string|
  iv_backupvaultname = |string|
  iv_bybackupplanid = |string|
  iv_bycreatedafter = '20150101000000.0000000'
  iv_bycreatedbefore = '20150101000000.0000000'
  iv_byparentrecoverypointarn = |string|
  iv_byresourcearn = |string|
  iv_byresourcetype = |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.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_recoverypoints( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_recoverypointarn( ).
      lv_backupvaultname = lo_row_1->get_backupvaultname( ).
      lv_arn = lo_row_1->get_backupvaultarn( ).
      lv_arn = lo_row_1->get_sourcebackupvaultarn( ).
      lv_arn = lo_row_1->get_resourcearn( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lo_recoverypointcreator = lo_row_1->get_createdby( ).
      IF lo_recoverypointcreator IS NOT INITIAL.
        lv_string = lo_recoverypointcreator->get_backupplanid( ).
        lv_arn = lo_recoverypointcreator->get_backupplanarn( ).
        lv_string = lo_recoverypointcreator->get_backupplanname( ).
        lv_string = lo_recoverypointcreator->get_backupplanversion( ).
        lv_string = lo_recoverypointcreator->get_backupruleid( ).
        lv_string = lo_recoverypointcreator->get_backuprulename( ).
        lv_string = lo_recoverypointcreator->get_backuprulecron( ).
        lv_string = lo_recoverypointcreator->get_backupruletimezone( ).
      ENDIF.
      lv_iamrolearn = lo_row_1->get_iamrolearn( ).
      lv_recoverypointstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusmessage( ).
      lv_timestamp = lo_row_1->get_creationdate( ).
      lv_timestamp = lo_row_1->get_initiationdate( ).
      lv_timestamp = lo_row_1->get_completiondate( ).
      lv_long = lo_row_1->get_backupsizeinbytes( ).
      lo_calculatedlifecycle = lo_row_1->get_calculatedlifecycle( ).
      IF lo_calculatedlifecycle IS NOT INITIAL.
        lv_timestamp = lo_calculatedlifecycle->get_movetocoldstorageat( ).
        lv_timestamp = lo_calculatedlifecycle->get_deleteat( ).
      ENDIF.
      lo_lifecycle = lo_row_1->get_lifecycle( ).
      IF lo_lifecycle IS NOT INITIAL.
        lv_long = lo_lifecycle->get_movetocoldstrgafterdays( ).
        lv_long = lo_lifecycle->get_deleteafterdays( ).
        lv_boolean = lo_lifecycle->get_optintoarchiveforsuppe00( ).
      ENDIF.
      lv_arn = lo_row_1->get_encryptionkeyarn( ).
      lv_boolean2 = lo_row_1->get_isencrypted( ).
      lv_timestamp = lo_row_1->get_lastrestoretime( ).
      lv_arn = lo_row_1->get_parentrecoverypointarn( ).
      lv_string = lo_row_1->get_compositememberid( ).
      lv_boolean2 = lo_row_1->get_isparent( ).
      lv_string = lo_row_1->get_resourcename( ).
      lv_vaulttype = lo_row_1->get_vaulttype( ).
      lv_indexstatus = lo_row_1->get_indexstatus( ).
      lv_string = lo_row_1->get_indexstatusmessage( ).
      lv_encryptionkeytype = lo_row_1->get_encryptionkeytype( ).
    ENDIF.
  ENDLOOP.
ENDIF.