ListCopyJobs - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ListCopyJobs

Returns metadata about your copy jobs.

Request Syntax

GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ByAccountId

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

Pattern: ^[0-9]{12}$

ByCompleteAfter

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

ByCompleteBefore

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

ByCreatedAfter

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

ByCreatedBefore

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

ByDestinationVaultArn

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.

ByMessageCategory

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.

ByParentJobId

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

ByResourceArn

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

ByResourceType

Returns only backup jobs for the specified resources:

  • Aurora for Amazon Aurora

  • CloudFormation for Amazon 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 Amazon Storage Gateway

  • S3 for Amazon S3

  • Timestream for Amazon Timestream

  • VirtualMachine for virtual machines

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

ByState

Returns only copy jobs that are in the specified state.

Valid Values: CREATED | RUNNING | COMPLETED | FAILED | PARTIAL

MaxResults

The maximum number of items to be returned.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

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.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CopyJobs": [ { "AccountId": "string", "BackupSizeInBytes": number, "ChildJobsInState": { "string" : number }, "CompletionDate": number, "CompositeMemberIdentifier": "string", "CopyJobId": "string", "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "DestinationBackupVaultArn": "string", "DestinationRecoveryPointArn": "string", "IamRoleArn": "string", "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "SourceBackupVaultArn": "string", "SourceRecoveryPointArn": "string", "State": "string", "StatusMessage": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CopyJobs

An array of structures containing metadata about your copy jobs returned in JSON format.

Type: Array of CopyJob objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: