Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CopySnapshot

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

Description

A description for the EBS snapshot.

Type: String

Required: No

DestinationRegion

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com).

Type: String

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

Encrypted

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Type: Boolean

Required: No

KmsKeyId

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Type: String

Required: No

PresignedUrl

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Type: String

Required: No

SourceRegion

The ID of the Region that contains the snapshot to be copied.

Type: String

Required: Yes

SourceSnapshotId

The ID of the EBS snapshot to copy.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

snapshotId

The ID of the new snapshot.

Type: String

Errors

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

Examples

Create copy of an unencrypted snapshot in the same Region as the original

This example request copies the snapshot in the us-west-1 Region with the ID snap-1234567890abcdef0.

Sample Request

https://ec2.amazonaws.com/?Action=CopySnapshot &SourceRegion=us-west-1 &SourceSnapshotId=snap-1234567890abcdef0 &Description=My_snapshot &AUTHPARAMS

Sample Response

<CopySnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>60bc441d-fa2c-494d-b155-5d6a3EXAMPLE</requestId> <snapshotId>snap-1234567890abcdef1</snapshotId> </CopySnapshotResponse<

Create a copy of an encrypted snapshot in a Region different from the original

This example request copies an encrypted snapshot in the us-west-1 Region to the us-east-1 Region with the ID snap-0987654321abcdef0.

Sample Request

https://ec2.amazonaws.com/?SourceSnapshotId=snap-005a01bf6eEXAMPLE &SourceRegion=us-west-1 &KmsKeyId=arn%3Aaws%3Akms%3Aus-west-2%3A210774411744%3Akey%2FfEXAMPLE-24bc-479b-a9da-7132eEXAMPLE &Action=CopySnapshot &Encrypted=true &DestinationRegion=us-east-1 &AUTHPARAMS

Sample Response

<CopySnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>256f6c57-6648-4544-a79a-35a03EXAMPLE</requestId> <snapshotId>snap-0987654321abcdef0</snapshotId> </CopySnapshotResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: