Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.CopyImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates the copy of an AMI. 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.

To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. 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.

To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.

Synopsis

data CopyImage = CopyImage' {
- clientToken :: Maybe Text
- copyImageTags :: Maybe Bool
- description :: Maybe Text
- destinationOutpostArn :: Maybe Text
- dryRun :: Maybe Bool
- encrypted :: Maybe Bool
- kmsKeyId :: Maybe Text
- name :: Text
- sourceImageId :: Text
- sourceRegion :: Text
}
newCopyImage :: Text -> Text -> Text -> CopyImage
copyImage_clientToken :: Lens' CopyImage (Maybe Text)
copyImage_copyImageTags :: Lens' CopyImage (Maybe Bool)
copyImage_description :: Lens' CopyImage (Maybe Text)
copyImage_destinationOutpostArn :: Lens' CopyImage (Maybe Text)
copyImage_dryRun :: Lens' CopyImage (Maybe Bool)
copyImage_encrypted :: Lens' CopyImage (Maybe Bool)
copyImage_kmsKeyId :: Lens' CopyImage (Maybe Text)
copyImage_name :: Lens' CopyImage Text
copyImage_sourceImageId :: Lens' CopyImage Text
copyImage_sourceRegion :: Lens' CopyImage Text
data CopyImageResponse = CopyImageResponse' {
- imageId :: Maybe Text
- httpStatus :: Int
}
newCopyImageResponse :: Int -> CopyImageResponse
copyImageResponse_imageId :: Lens' CopyImageResponse (Maybe Text)
copyImageResponse_httpStatus :: Lens' CopyImageResponse Int

Creating a Request

data CopyImage Source #

Contains the parameters for CopyImage.

See: newCopyImage smart constructor.

Constructors

CopyImage'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
copyImageTags :: Maybe Bool
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.
description :: Maybe Text
A description for the new AMI in the destination Region.
destinationOutpostArn :: Maybe Text
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 EC2 User Guide.
dryRun :: Maybe Bool
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.
encrypted :: Maybe Bool
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 Amazon EBS encryption in the Amazon EC2 User Guide.
kmsKeyId :: Maybe Text
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.
name :: Text
The name of the new AMI in the destination Region.
sourceImageId :: Text
The ID of the AMI to copy.
sourceRegion :: Text
The name of the Region that contains the AMI to copy.

Instances

Instances details

ToHeaders CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods toHeaders :: CopyImage -> [Header] #
ToPath CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods toPath :: CopyImage -> ByteString #
ToQuery CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods toQuery :: CopyImage -> QueryString #
AWSRequest CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Associated Types type AWSResponse CopyImage # Methods request :: (Service -> Service) -> CopyImage -> Request CopyImage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CopyImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CopyImage))) #
Generic CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Associated Types type Rep CopyImage :: Type -> Type # Methods from :: CopyImage -> Rep CopyImage x # to :: Rep CopyImage x -> CopyImage #
Read CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods readsPrec :: Int -> ReadS CopyImage # readList :: ReadS [CopyImage] # readPrec :: ReadPrec CopyImage # readListPrec :: ReadPrec [CopyImage] #
Show CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods showsPrec :: Int -> CopyImage -> ShowS # show :: CopyImage -> String # showList :: [CopyImage] -> ShowS #
NFData CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods rnf :: CopyImage -> () #
Eq CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods (==) :: CopyImage -> CopyImage -> Bool # (/=) :: CopyImage -> CopyImage -> Bool #
Hashable CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods hashWithSalt :: Int -> CopyImage -> Int # hash :: CopyImage -> Int #
type AWSResponse CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage type AWSResponse CopyImage = CopyImageResponse
type Rep CopyImage Source #
Instance details Defined in Amazonka.EC2.CopyImage type Rep CopyImage = D1 ('MetaData "CopyImage" "Amazonka.EC2.CopyImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CopyImage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "copyImageTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "destinationOutpostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sourceImageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCopyImage Source #

Arguments

:: Text	`CopyImage`
-> Text	`$sel:sourceImageId:CopyImage'`
-> Text	`$sel:sourceRegion:CopyImage'`
-> CopyImage

Create a value of CopyImage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CopyImage, copyImage_clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

$sel:copyImageTags:CopyImage', copyImage_copyImageTags - 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.

CopyImage, copyImage_description - A description for the new AMI in the destination Region.

$sel:destinationOutpostArn:CopyImage', copyImage_destinationOutpostArn - 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 EC2 User Guide.

$sel:dryRun:CopyImage', copyImage_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.

CopyImage, copyImage_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 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 Amazon EBS encryption in the Amazon EC2 User Guide.

CopyImage, copyImage_kmsKeyId - 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.

CopyImage, copyImage_name - The name of the new AMI in the destination Region.

$sel:sourceImageId:CopyImage', copyImage_sourceImageId - The ID of the AMI to copy.

$sel:sourceRegion:CopyImage', copyImage_sourceRegion - The name of the Region that contains the AMI to copy.

Request Lenses

copyImage_clientToken :: Lens' CopyImage (Maybe Text) Source #

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

copyImage_copyImageTags :: Lens' CopyImage (Maybe Bool) Source #

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.

copyImage_description :: Lens' CopyImage (Maybe Text) Source #

A description for the new AMI in the destination Region.

copyImage_destinationOutpostArn :: Lens' CopyImage (Maybe Text) Source #

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 EC2 User Guide.

copyImage_dryRun :: Lens' CopyImage (Maybe Bool) Source #

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.

copyImage_encrypted :: Lens' CopyImage (Maybe Bool) Source #

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 Amazon EBS encryption in the Amazon EC2 User Guide.

copyImage_kmsKeyId :: Lens' CopyImage (Maybe Text) Source #

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.

copyImage_name :: Lens' CopyImage Text Source #

The name of the new AMI in the destination Region.

copyImage_sourceImageId :: Lens' CopyImage Text Source #

The ID of the AMI to copy.

copyImage_sourceRegion :: Lens' CopyImage Text Source #

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

Destructuring the Response

data CopyImageResponse Source #

Contains the output of CopyImage.

See: newCopyImageResponse smart constructor.

Constructors

CopyImageResponse'
Fields imageId :: Maybe Text The ID of the new AMI. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CopyImageResponse Source #
Instance details Defined in Amazonka.EC2.CopyImage Associated Types type Rep CopyImageResponse :: Type -> Type # Methods from :: CopyImageResponse -> Rep CopyImageResponse x # to :: Rep CopyImageResponse x -> CopyImageResponse #
Read CopyImageResponse Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods readsPrec :: Int -> ReadS CopyImageResponse # readList :: ReadS [CopyImageResponse] # readPrec :: ReadPrec CopyImageResponse # readListPrec :: ReadPrec [CopyImageResponse] #
Show CopyImageResponse Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods showsPrec :: Int -> CopyImageResponse -> ShowS # show :: CopyImageResponse -> String # showList :: [CopyImageResponse] -> ShowS #
NFData CopyImageResponse Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods rnf :: CopyImageResponse -> () #
Eq CopyImageResponse Source #
Instance details Defined in Amazonka.EC2.CopyImage Methods (==) :: CopyImageResponse -> CopyImageResponse -> Bool # (/=) :: CopyImageResponse -> CopyImageResponse -> Bool #
type Rep CopyImageResponse Source #
Instance details Defined in Amazonka.EC2.CopyImage type Rep CopyImageResponse = D1 ('MetaData "CopyImageResponse" "Amazonka.EC2.CopyImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CopyImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCopyImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:CopyImageResponse'`
-> CopyImageResponse

Create a value of CopyImageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CopyImageResponse, copyImageResponse_imageId - The ID of the new AMI.

$sel:httpStatus:CopyImageResponse', copyImageResponse_httpStatus - The response's http status code.

Response Lenses

copyImageResponse_imageId :: Lens' CopyImageResponse (Maybe Text) Source #

The ID of the new AMI.

copyImageResponse_httpStatus :: Lens' CopyImageResponse Int Source #

The response's http status code.