Network.AWS.EC2.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 about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide .

Creating a Request

copyImage

Arguments

:: Text

ciName

-> Text

ciSourceImageId

-> Text

ciSourceRegion

-> CopyImage

Creates a value of CopyImage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ciClientToken - 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 .
• ciEncrypted - 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 .
• ciKMSKeyId - An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. 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. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: * Key ID * Key alias, in the form alias/ExampleAlias * ARN using key ID. The ID 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 . * ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1 :012345678910 :alias/ExampleAlias . AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified CMK must exist in the region that the snapshot is being copied to.
• ciDescription - A description for the new AMI in the destination region.
• ciDryRun - 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 .
• ciName - The name of the new AMI in the destination region.
• ciSourceImageId - The ID of the AMI to copy.
• ciSourceRegion - The name of the region that contains the AMI to copy.

data CopyImage

Contains the parameters for CopyImage.

See: copyImage smart constructor.

Instances

Eq CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

(==) :: CopyImage -> CopyImage -> Bool

(/=) :: CopyImage -> CopyImage -> Bool

Data CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CopyImage -> c CopyImage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CopyImage

toConstr :: CopyImage -> Constr

dataTypeOf :: CopyImage -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CopyImage)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CopyImage)

gmapT :: (forall b. Data b => b -> b) -> CopyImage -> CopyImage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CopyImage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CopyImage -> r

gmapQ :: (forall d. Data d => d -> u) -> CopyImage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CopyImage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CopyImage -> m CopyImage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CopyImage -> m CopyImage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CopyImage -> m CopyImage

Read CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

readsPrec :: Int -> ReadS CopyImage

readList :: ReadS [CopyImage]

readPrec :: ReadPrec CopyImage

readListPrec :: ReadPrec [CopyImage]

Show CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

showsPrec :: Int -> CopyImage -> ShowS

show :: CopyImage -> String

showList :: [CopyImage] -> ShowS

Generic CopyImage

Defined in Network.AWS.EC2.CopyImage

Associated Types

type Rep CopyImage :: Type -> Type

Methods

from :: CopyImage -> Rep CopyImage x

to :: Rep CopyImage x -> CopyImage

Hashable CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

hashWithSalt :: Int -> CopyImage -> Int

hash :: CopyImage -> Int

AWSRequest CopyImage

Defined in Network.AWS.EC2.CopyImage

Associated Types

type Rs CopyImage :: Type

Methods

request :: CopyImage -> Request CopyImage

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CopyImage -> ClientResponse -> m (Response CopyImage)

ToHeaders CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

toHeaders :: CopyImage -> [Header]

ToPath CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

toPath :: CopyImage -> ByteString

ToQuery CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

toQuery :: CopyImage -> QueryString

NFData CopyImage

Defined in Network.AWS.EC2.CopyImage

Methods

rnf :: CopyImage -> ()

type Rep CopyImage

Defined in Network.AWS.EC2.CopyImage

type Rep CopyImage = D1 (MetaData "CopyImage" "Network.AWS.EC2.CopyImage" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "CopyImage'" PrefixI True) (((S1 (MetaSel (Just "_ciClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ciEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_ciKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ciDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_ciDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_ciName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_ciSourceImageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ciSourceRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CopyImage

Defined in Network.AWS.EC2.CopyImage

type Rs CopyImage = CopyImageResponse

Request Lenses

ciClientToken :: Lens' CopyImage (Maybe Text)

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 .

ciEncrypted :: Lens' CopyImage (Maybe Bool)

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 .

ciKMSKeyId :: Lens' CopyImage (Maybe Text)

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. 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. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: * Key ID * Key alias, in the form alias/ExampleAlias * ARN using key ID. The ID 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 . * ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1 :012345678910 :alias/ExampleAlias . AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified CMK must exist in the region that the snapshot is being copied to.

ciDescription :: Lens' CopyImage (Maybe Text)

A description for the new AMI in the destination region.

ciDryRun :: Lens' CopyImage (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 .

ciName :: Lens' CopyImage Text

The name of the new AMI in the destination region.

ciSourceImageId :: Lens' CopyImage Text

The ID of the AMI to copy.

ciSourceRegion :: Lens' CopyImage Text

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

Destructuring the Response

copyImageResponse

Arguments

:: Int

coprsResponseStatus

-> CopyImageResponse

Creates a value of CopyImageResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• coprsImageId - The ID of the new AMI.
• coprsResponseStatus - -- | The response status code.

data CopyImageResponse

Contains the output of CopyImage.

See: copyImageResponse smart constructor.

Instances

Eq CopyImageResponse

Defined in Network.AWS.EC2.CopyImage

Methods

(==) :: CopyImageResponse -> CopyImageResponse -> Bool

(/=) :: CopyImageResponse -> CopyImageResponse -> Bool

Data CopyImageResponse

Defined in Network.AWS.EC2.CopyImage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CopyImageResponse -> c CopyImageResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CopyImageResponse

toConstr :: CopyImageResponse -> Constr

dataTypeOf :: CopyImageResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CopyImageResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CopyImageResponse)

gmapT :: (forall b. Data b => b -> b) -> CopyImageResponse -> CopyImageResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CopyImageResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CopyImageResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CopyImageResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CopyImageResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CopyImageResponse -> m CopyImageResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CopyImageResponse -> m CopyImageResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CopyImageResponse -> m CopyImageResponse

Read CopyImageResponse

Defined in Network.AWS.EC2.CopyImage

Methods

readsPrec :: Int -> ReadS CopyImageResponse

readList :: ReadS [CopyImageResponse]

readPrec :: ReadPrec CopyImageResponse

readListPrec :: ReadPrec [CopyImageResponse]

Show CopyImageResponse

Defined in Network.AWS.EC2.CopyImage

Methods

showsPrec :: Int -> CopyImageResponse -> ShowS

show :: CopyImageResponse -> String

showList :: [CopyImageResponse] -> ShowS

Generic CopyImageResponse

Defined in Network.AWS.EC2.CopyImage

Associated Types

type Rep CopyImageResponse :: Type -> Type

Methods

from :: CopyImageResponse -> Rep CopyImageResponse x

to :: Rep CopyImageResponse x -> CopyImageResponse

NFData CopyImageResponse

Defined in Network.AWS.EC2.CopyImage

Methods

rnf :: CopyImageResponse -> ()

type Rep CopyImageResponse

Defined in Network.AWS.EC2.CopyImage

type Rep CopyImageResponse = D1 (MetaData "CopyImageResponse" "Network.AWS.EC2.CopyImage" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "CopyImageResponse'" PrefixI True) (S1 (MetaSel (Just "_coprsImageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_coprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

coprsImageId :: Lens' CopyImageResponse (Maybe Text)

The ID of the new AMI.

coprsResponseStatus :: Lens' CopyImageResponse Int

• - | The response status code.