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

CopyImage

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs 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.

ClientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Type: String

Required: No

Description

A description for the new AMI in the destination region.

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 snapshots of the copied image should be encrypted. The 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

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

Type: String

Required: No

Name

The name of the new AMI in the destination region.

Type: String

Required: Yes

SourceImageId

The ID of the AMI to copy.

Type: String

Required: Yes

SourceRegion

The name of the region that contains the AMI to copy.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

imageId

The ID of the new AMI.

Type: String

requestId

The ID of the request.

Type: String

Errors

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

Example

Example

This example request copies the AMI in us-west-2 with the ID ami-1a2b3c4d, naming the new AMI My-Standard-AMI.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=CopyImage &SourceRegion=us-west-2 &SourceImageId=ami-1a2b3c4d &Name=My-Standard-AMI &Description=This%20is%20the%20new%20version%20of%20My-Standard-AMI &ClientToken=550e8400-e29b-41d4-a716-446655440000 &AUTHPARAMS

Sample Response

Copy
<CopyImageResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>60bc441d-fa2c-494d-b155-5d6a3EXAMPLE</requestId> <imageId>ami-4d3c2b1a</imageId> </CopyImageResponse>

See Also

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