GET

/copy-jobs/

http://backup.{region}.amazonaws.com/copy-jobs/

Returns metadata about your copy jobs.

Access Token Required: API Key

Query Params

nextTokenstring

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.

maxResultsinteger

The maximum number of items to be returned.

resourceArnstring

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

statestring

Returns only copy jobs that are in the specified state.

Allowed:

createdBeforestring

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

createdAfterstring

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

resourceTypestring

Returns only backup jobs for the specified resources: <ul> <li> <code>Aurora</code> for Amazon Aurora </li> <li> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility) </li> <li> <code>DynamoDB</code> for Amazon DynamoDB </li> <li> <code>EBS</code> for Amazon Elastic Block Store </li> <li> <code>EC2</code> for Amazon Elastic Compute Cloud </li> <li> <code>EFS</code> for Amazon Elastic File System </li> <li> <code>FSx</code> for Amazon FSx </li> <li> <code>Neptune</code> for Amazon Neptune </li> <li> <code>RDS</code> for Amazon Relational Database Service </li> <li> <code>Storage Gateway</code> for Storage Gateway </li> <li> <code>S3</code> for Amazon S3 </li> <li> <code>VirtualMachine</code> for virtual machines </li> </ul>

destinationVaultArnstring

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

accountIdstring

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

completeBeforestring

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

completeAfterstring

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

parentJobIdstring

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

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://backup.{region}.amazonaws.com/copy-jobs/' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET