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

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). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during 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 non-default CMK with the KmsKeyId parameter.

Note

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

Note

Snapshots created by the CopySnapshot action 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.

Note

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

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

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Type: Boolean

Required: No

KmsKeyId

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

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: