Skip to content

/AWS1/CL_BUP=>LISTCOPYJOBS()

About ListCopyJobs

Returns metadata about your copy jobs.

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_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

  • FSx for Amazon FSx

  • Neptune for Amazon Neptune

  • Redshift for Amazon Redshift

  • RDS for Amazon Relational Database Service

  • SAP HANA on Amazon EC2 for SAP HANA databases

  • Storage Gateway for Storage Gateway

  • S3 for Amazon S3

  • Timestream for Amazon Timestream

  • VirtualMachine for 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: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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_BUPLISTCOPYJOBSOUTPUT /AWS1/CL_BUPLISTCOPYJOBSOUTPUT