Amazon Elastic Compute Cloud

{'Encrypted': 'boolean', 'KmsKeyId': 'string'}

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. AMIs that use encrypted EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

Request Syntax

client.copy_image(
    DryRun=True|False,
    SourceRegion='string',
    SourceImageId='string',
    Name='string',
    Description='string',
    ClientToken='string',
    Encrypted=True|False,
    KmsKeyId='string'
)

type DryRun:

boolean

param 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 SourceRegion:

string

param SourceRegion:

[REQUIRED]

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

type SourceImageId:

string

param SourceImageId:

[REQUIRED]

The ID of the AMI to copy.

type Name:

string

param Name:

[REQUIRED]

The name of the new AMI in the destination region.

type Description:

string

param Description:

A description for the new AMI in the destination region.

type ClientToken:

string

param 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 Encrypted:

boolean

param 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 KmsKeyId:

string

param 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.

rtype:

dict

returns:

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

• (dict) --

  • ImageId (string) --

    The ID of the new AMI.