StartCopyJob
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
Request Syntax
PUT /copy-jobs HTTP/1.1
Content-type: application/json
{
"DestinationBackupVaultArn": "string
",
"IamRoleArn": "string
",
"IdempotencyToken": "string
",
"Lifecycle": {
"DeleteAfterDays": number
,
"MoveToColdStorageAfterDays": number
,
"OptInToArchiveForSupportedResources": boolean
},
"RecoveryPointArn": "string
",
"SourceBackupVaultName": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- DestinationBackupVaultArn
-
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.Type: String
Required: Yes
- IamRoleArn
-
Specifies the IAM role ARN used to copy the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.Type: String
Required: Yes
- IdempotencyToken
-
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartCopyJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.Type: String
Required: No
- Lifecycle
-
Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Amazon Backup ignores this expression for other resource types.
To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for
MoveToColdStorageAfterDays
andDeleteAfterDays
.Type: Lifecycle object
Required: No
- RecoveryPointArn
-
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.
Type: String
Required: Yes
- SourceBackupVaultName
-
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 Region where they are created.
Type: String
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CopyJobId": "string",
"CreationDate": number,
"IsParent": boolean
}
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.
- CopyJobId
-
Uniquely identifies a copy job.
Type: String
- CreationDate
-
The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- IsParent
-
This is a returned boolean value indicating this is a parent (composite) copy job.
Type: Boolean
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
- InvalidRequestException
-
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
HTTP Status Code: 400
- LimitExceededException
-
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
HTTP Status Code: 400
- MissingParameterValueException
-
Indicates that a required parameter is missing.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource that is required for the action doesn't exist.
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: