/AWS1/CL_EC2=>COPYIMAGE()
¶
About CopyImage¶
Initiates an AMI copy operation. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
When you copy an AMI from one Region to another, the destination Region is the current Region.
When you copy an AMI from a Region to an Outpost, specify the ARN of the Outpost as the destination. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region or the key that you specify. Outposts do not support unencrypted snapshots.
For information about the prerequisites when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
The name of the new AMI in the destination Region.
IV_SOURCEIMAGEID
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
The ID of the AMI to copy.
IV_SOURCEREGION
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
The name of the Region that contains the AMI to copy.
Optional arguments:¶
IV_CLIENTTOKEN
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
IV_DESCRIPTION
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
A description for the new AMI in the destination Region.
IV_ENCRYPTED
TYPE /AWS1/EC2BOOLEAN
/AWS1/EC2BOOLEAN
¶
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 KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using
KmsKeyId
. For more information, see Use encryption with EBS-backed AMIs in the Amazon EC2 User Guide.
IV_KMSKEYID
TYPE /AWS1/EC2KMSKEYID
/AWS1/EC2KMSKEYID
¶
The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to
true
.You can specify a KMS key 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.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified KMS key must exist in the destination Region.
Amazon EBS does not support asymmetric KMS keys.
IV_DESTINATIONOUTPOSTARN
TYPE /AWS1/EC2STRING
/AWS1/EC2STRING
¶
The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
IV_COPYIMAGETAGS
TYPE /AWS1/EC2BOOLEAN
/AWS1/EC2BOOLEAN
¶
Indicates whether to include your user-defined AMI tags when copying the AMI.
The following tags will not be copied:
System tags (prefixed with
aws:
)For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts
Default: Your user-defined AMI tags are not copied.
IT_TAGSPECIFICATIONS
TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST
TT_TAGSPECIFICATIONLIST
¶
The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.
To tag the new AMI, the value for
ResourceType
must beimage
.To tag the new snapshots, the value for
ResourceType
must besnapshot
. The same tag is applied to all the new snapshots.If you specify other values for
ResourceType
, the request fails.To tag an AMI or snapshot after it has been created, see CreateTags.
IV_DRYRUN
TYPE /AWS1/EC2BOOLEAN
/AWS1/EC2BOOLEAN
¶
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
.