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.
Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted
backing snapshots
remain unencrypted, unless you set Encrypted
during the copy operation. You cannot create an unencrypted
copy of an encrypted backing snapshot.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI 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 isUnauthorizedOperation
.Type: Boolean
Required: No
- Encrypted
-
Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using
KmsKeyId
. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.Type: Boolean
Required: No
- KmsKeyId
-
The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to
true
.You can specify a CMK using any of the following:
-
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
-
Key alias. For example, alias/ExampleAlias.
-
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
-
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified CMK must exist in the destination Region.
Amazon EBS does not support asymmetric CMKs.
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 client error codes.
Examples
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
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
<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: