v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472262334.5 KB

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

put/copy-jobs

Request body

RecoveryPointArnstring required

An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

SourceBackupVaultNamestring required

The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

DestinationBackupVaultArnstring required

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

IamRoleArnstring required

Specifies the IAM role ARN used to copy the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.

IdempotencyTokenstring

A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>StartCopyJob</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Response

Success

CopyJobIdstring

Uniquely identifies a copy job.

CreationDatestring date-time

The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

IsParentboolean

This is a returned boolean value indicating this is a parent (composite) copy job.