Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 .
- copyImage :: Text -> Text -> Text -> CopyImage
- data CopyImage
- ciClientToken :: Lens' CopyImage (Maybe Text)
- ciEncrypted :: Lens' CopyImage (Maybe Bool)
- ciKMSKeyId :: Lens' CopyImage (Maybe Text)
- ciDescription :: Lens' CopyImage (Maybe Text)
- ciDryRun :: Lens' CopyImage (Maybe Bool)
- ciName :: Lens' CopyImage Text
- ciSourceImageId :: Lens' CopyImage Text
- ciSourceRegion :: Lens' CopyImage Text
- copyImageResponse :: Int -> CopyImageResponse
- data CopyImageResponse
- coprsImageId :: Lens' CopyImageResponse (Maybe Text)
- coprsResponseStatus :: Lens' CopyImageResponse Int
Creating a Request
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 withKmsKeyId
. 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 aKmsKeyId
is specified, theEncrypted
flag must also be set. The CMK identifier may be provided in any of the following formats: * Key ID * Key alias, in the formalias/ExampleAlias
* ARN using key ID. The ID ARN contains thearn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, thekey
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 thearn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, thealias
namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1 :012345678910 :alias/ExampleAlias . AWS parsesKmsKeyId
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.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.
Contains the parameters for CopyImage.
See: copyImage
smart constructor.
Request Lenses
ciClientToken :: Lens' CopyImage (Maybe Text) Source #
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) Source #
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) Source #
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) Source #
A description for the new AMI in the destination region.
ciDryRun :: 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
.
ciSourceRegion :: Lens' CopyImage Text Source #
The name of the region that contains the AMI to copy.
Destructuring the Response
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 Source #
Contains the output of CopyImage.
See: copyImageResponse
smart constructor.
Response Lenses
coprsImageId :: Lens' CopyImageResponse (Maybe Text) Source #
The ID of the new AMI.
coprsResponseStatus :: Lens' CopyImageResponse Int Source #
- - | The response status code.