/AWS1/CL_BUP=>LISTRESTOREJOBS()

About ListRestoreJobs

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Method Signature

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_byaccountid TYPE /AWS1/BUPACCOUNTID /AWS1/BUPACCOUNTID

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

iv_byresourcetype TYPE /AWS1/BUPRESOURCETYPE /AWS1/BUPRESOURCETYPE

Include this parameter to return only restore jobs for the specified resources:

• 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_bycreatedbefore TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only restore jobs that were created before the specified date.

iv_bycreatedafter TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only restore jobs that were created after the specified date.

iv_bystatus TYPE /AWS1/BUPRESTOREJOBSTATUS /AWS1/BUPRESTOREJOBSTATUS

Returns only restore jobs associated with the specified job status.

iv_bycompletebefore TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

iv_bycompleteafter TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

iv_byrestoretestingplanarn TYPE /AWS1/BUPARN /AWS1/BUPARN

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

RETURNING

oo_output TYPE REF TO /aws1/cl_buplistrestorejobsout /AWS1/CL_BUPLISTRESTOREJOBSOUT

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->/aws1/if_bup~listrestorejobs(
  iv_byaccountid = |string|
  iv_bycompleteafter = '20150101000000.0000000'
  iv_bycompletebefore = '20150101000000.0000000'
  iv_bycreatedafter = '20150101000000.0000000'
  iv_bycreatedbefore = '20150101000000.0000000'
  iv_byresourcetype = |string|
  iv_byrestoretestingplanarn = |string|
  iv_bystatus = |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_restorejobs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_accountid = lo_row_1->get_accountid( ).
      lv_string = lo_row_1->get_restorejobid( ).
      lv_arn = lo_row_1->get_recoverypointarn( ).
      lv_timestamp = lo_row_1->get_creationdate( ).
      lv_timestamp = lo_row_1->get_completiondate( ).
      lv_restorejobstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusmessage( ).
      lv_string = lo_row_1->get_percentdone( ).
      lv_long = lo_row_1->get_backupsizeinbytes( ).
      lv_iamrolearn = lo_row_1->get_iamrolearn( ).
      lv_long = lo_row_1->get_expectedcompletiontime00( ).
      lv_arn = lo_row_1->get_createdresourcearn( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_timestamp = lo_row_1->get_recpointcreationdate( ).
      lo_restorejobcreator = lo_row_1->get_createdby( ).
      IF lo_restorejobcreator IS NOT INITIAL.
        lv_arn = lo_restorejobcreator->get_restoretestingplanarn( ).
      ENDIF.
      lv_restorevalidationstatus = lo_row_1->get_validationstatus( ).
      lv_string = lo_row_1->get_validationstatusmessage( ).
      lv_restoredeletionstatus = lo_row_1->get_deletionstatus( ).
      lv_string = lo_row_1->get_deletionstatusmessage( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.