/AWS1/IF_BUP=>LISTBACKUPJOBS()

About ListBackupJobs

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

Method Signature

METHODS /AWS1/IF_BUP~LISTBACKUPJOBS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BUPMAXRESULTS OPTIONAL
    !IV_BYRESOURCEARN TYPE /AWS1/BUPARN OPTIONAL
    !IV_BYSTATE TYPE /AWS1/BUPBACKUPJOBSTATE OPTIONAL
    !IV_BYBACKUPVAULTNAME TYPE /AWS1/BUPBACKUPVAULTNAME OPTIONAL
    !IV_BYCREATEDBEFORE TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYCREATEDAFTER TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYRESOURCETYPE TYPE /AWS1/BUPRESOURCETYPE OPTIONAL
    !IV_BYACCOUNTID TYPE /AWS1/BUPACCOUNTID OPTIONAL
    !IV_BYCOMPLETEAFTER TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYCOMPLETEBEFORE TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYPARENTJOBID TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_BYMESSAGECATEGORY TYPE /AWS1/BUPSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_buplistbackupjobsout
  RAISING
    /AWS1/CX_BUPINVPARAMVALUEEX
    /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_byresourcearn TYPE /AWS1/BUPARN /AWS1/BUPARN

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

iv_bystate TYPE /AWS1/BUPBACKUPJOBSTATE /AWS1/BUPBACKUPJOBSTATE

Returns only backup jobs that are in the specified state.

Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message.

To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

GET /backup-jobs/?state=COMPLETED

GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED

iv_bybackupvaultname TYPE /AWS1/BUPBACKUPVAULTNAME /AWS1/BUPBACKUPVAULTNAME

Returns only backup jobs that will be stored in the specified backup vault. 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.

iv_bycreatedbefore TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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

iv_bycreatedafter TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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

iv_byresourcetype TYPE /AWS1/BUPRESOURCETYPE /AWS1/BUPRESOURCETYPE

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

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

If used from an Organizations management account, passing * returns all jobs across the organization.

iv_bycompleteafter TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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

iv_bycompletebefore TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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

iv_byparentjobid TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

This is a filter to list child (nested) jobs based on parent job ID.

iv_bymessagecategory TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters.

View Monitoring

The wildcard () returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

RETURNING

oo_output TYPE REF TO /aws1/cl_buplistbackupjobsout /AWS1/CL_BUPLISTBACKUPJOBSOUT

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->listbackupjobs(
  iv_byaccountid = |string|
  iv_bybackupvaultname = |string|
  iv_bycompleteafter = '20150101000000.0000000'
  iv_bycompletebefore = '20150101000000.0000000'
  iv_bycreatedafter = '20150101000000.0000000'
  iv_bycreatedbefore = '20150101000000.0000000'
  iv_bymessagecategory = |string|
  iv_byparentjobid = |string|
  iv_byresourcearn = |string|
  iv_byresourcetype = |string|
  iv_bystate = |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_backupjobs( ) 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_backupjobid( ).
      lv_backupvaultname = lo_row_1->get_backupvaultname( ).
      lv_arn = lo_row_1->get_backupvaultarn( ).
      lv_string = lo_row_1->get_vaulttype( ).
      lv_string = lo_row_1->get_vaultlockstate( ).
      lv_arn = lo_row_1->get_recoverypointarn( ).
      lo_lifecycle = lo_row_1->get_recoverypointlifecycle( ).
      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_arn = lo_row_1->get_resourcearn( ).
      lv_timestamp = lo_row_1->get_creationdate( ).
      lv_timestamp = lo_row_1->get_completiondate( ).
      lv_backupjobstate = lo_row_1->get_state( ).
      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( ).
      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_timestamp = lo_row_1->get_expectedcompletiondate( ).
      lv_timestamp = lo_row_1->get_startby( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_long = lo_row_1->get_bytestransferred( ).
      LOOP AT lo_row_1->get_backupoptions( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_backupoptionvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_backuptype( ).
      lv_string = lo_row_1->get_parentjobid( ).
      lv_boolean2 = lo_row_1->get_isparent( ).
      lv_string = lo_row_1->get_resourcename( ).
      lv_timestamp = lo_row_1->get_initiationdate( ).
      lv_string = lo_row_1->get_messagecategory( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.