Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateSnapshotCopyConfiguration

Creates a snapshot copy configuration that lets you copy snapshots to another AWS Region.

Request Syntax


{
   "destinationKmsKeyId": "string",
   "destinationRegion": "string",
   "namespaceName": "string",
   "snapshotRetentionPeriod": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

destinationKmsKeyId

The KMS key to use to encrypt your snapshots in the destination AWS Region.

Type: String

Required: No

destinationRegion

The destination AWS Region that you want to copy snapshots to.

Type: String

Required: Yes

namespaceName

The name of the namespace to copy snapshots from.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-z0-9-]+$

Required: Yes

snapshotRetentionPeriod

The retention period of the snapshots that you copy to the destination AWS Region.

Type: Integer

Required: No

Response Syntax


{
   "snapshotCopyConfiguration": { 
      "destinationKmsKeyId": "string",
      "destinationRegion": "string",
      "namespaceName": "string",
      "snapshotCopyConfigurationArn": "string",
      "snapshotCopyConfigurationId": "string",
      "snapshotRetentionPeriod": number
   }
}

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.

snapshotCopyConfiguration

The snapshot copy configuration object that is returned.

Type: SnapshotCopyConfiguration object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ServiceQuotaExceededException

The service limit was exceeded.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400