Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListCopyJobs

Returns metadata about your copy jobs.

Request Syntax


GET /copy-jobs/?createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&nextToken=NextToken&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

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.

ByResourceArn

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

ByResourceType

Returns only backup jobs for the specified resources:

EBS for Amazon Elastic Block Store
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Storage Gateway for AWS Storage Gateway

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

ByState

Returns only copy jobs that are in the specified state.

Valid Values: CREATED | RUNNING | COMPLETED | FAILED

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": [ 
      { 
         "BackupSizeInBytes": number,
         "CompletionDate": number,
         "CopyJobId": "string",
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "DestinationBackupVaultArn": "string",
         "DestinationRecoveryPointArn": "string",
         "IamRoleArn": "string",
         "ResourceArn": "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

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