/AWS1/IF_BUP=>LISTCOPYJOBS()

About ListCopyJobs

Returns metadata about your copy jobs.

Method Signature

METHODS /AWS1/IF_BUP~LISTCOPYJOBS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BUPMAXRESULTS OPTIONAL
    !IV_BYRESOURCEARN TYPE /AWS1/BUPARN OPTIONAL
    !IV_BYSTATE TYPE /AWS1/BUPCOPYJOBSTATE OPTIONAL
    !IV_BYCREATEDBEFORE TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYCREATEDAFTER TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYRESOURCETYPE TYPE /AWS1/BUPRESOURCETYPE OPTIONAL
    !IV_BYDESTINATIONVAULTARN TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_BYACCOUNTID TYPE /AWS1/BUPACCOUNTID OPTIONAL
    !IV_BYCOMPLETEBEFORE TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYCOMPLETEAFTER TYPE /AWS1/BUPTIMESTAMP OPTIONAL
    !IV_BYPARENTJOBID TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_BYMESSAGECATEGORY TYPE /AWS1/BUPSTRING OPTIONAL
    !IV_BYSOURCERECOVERYPOINTARN TYPE /AWS1/BUPSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_buplistcopyjobsoutput
  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 copy jobs that match the specified resource Amazon Resource Name (ARN).

iv_bystate TYPE /AWS1/BUPCOPYJOBSTATE /AWS1/BUPCOPYJOBSTATE

Returns only copy jobs that are in the specified state.

iv_bycreatedbefore TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

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

iv_bycreatedafter TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

Returns only copy 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

• EKS for Amazon Elastic Kubernetes Service

• 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_bydestinationvaultarn TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

iv_byaccountid TYPE /AWS1/BUPACCOUNTID /AWS1/BUPACCOUNTID

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

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_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 for a list of accepted strings.

The the value ANY returns count of all message categories.

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

iv_bysourcerecoverypointarn TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

Filters copy jobs by the specified source recovery point ARN.

RETURNING

oo_output TYPE REF TO /aws1/cl_buplistcopyjobsoutput /AWS1/CL_BUPLISTCOPYJOBSOUTPUT

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->listcopyjobs(
  iv_byaccountid = |string|
  iv_bycompleteafter = '20150101000000.0000000'
  iv_bycompletebefore = '20150101000000.0000000'
  iv_bycreatedafter = '20150101000000.0000000'
  iv_bycreatedbefore = '20150101000000.0000000'
  iv_bydestinationvaultarn = |string|
  iv_bymessagecategory = |string|
  iv_byparentjobid = |string|
  iv_byresourcearn = |string|
  iv_byresourcetype = |string|
  iv_bysourcerecoverypointarn = |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_copyjobs( ) 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_copyjobid( ).
      lv_arn = lo_row_1->get_sourcebackupvaultarn( ).
      lv_arn = lo_row_1->get_sourcerecoverypointarn( ).
      lv_arn = lo_row_1->get_dstbackupvaultarn( ).
      lv_string = lo_row_1->get_destinationvaulttype( ).
      lv_string = lo_row_1->get_dstvaultlockstate( ).
      lv_arn = lo_row_1->get_dstrecoverypointarn( ).
      lv_arn = lo_row_1->get_dstencryptionkeyarn( ).
      lo_lifecycle = lo_row_1->get_dstrecoverypointlc( ).
      IF lo_lifecycle IS NOT INITIAL.
        lv_long = lo_lifecycle->get_movetocoldstrgafterdays( ).
        lv_long = lo_lifecycle->get_deleteafterdays( ).
        lv_boolean = lo_lifecycle->get_optintoarchiveforsuppe00( ).
        lv_lifecycledeleteaftereve = lo_lifecycle->get_deleteafterevent( ).
      ENDIF.
      lv_arn = lo_row_1->get_resourcearn( ).
      lv_timestamp = lo_row_1->get_creationdate( ).
      lv_timestamp = lo_row_1->get_completiondate( ).
      lv_copyjobstate = lo_row_1->get_state( ).
      lv_string = lo_row_1->get_statusmessage( ).
      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_string = lo_row_1->get_createdbybackupjobid( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_string = lo_row_1->get_parentjobid( ).
      lv_boolean2 = lo_row_1->get_isparent( ).
      lv_string = lo_row_1->get_compositememberid( ).
      lv_long = lo_row_1->get_numberofchildjobs( ).
      LOOP AT lo_row_1->get_childjobsinstate( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_long = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_resourcename( ).
      lv_string = lo_row_1->get_messagecategory( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.