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 |
Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
Synopsis
- data ImportSnapshot = ImportSnapshot' {}
- newImportSnapshot :: ImportSnapshot
- importSnapshot_clientData :: Lens' ImportSnapshot (Maybe ClientData)
- importSnapshot_clientToken :: Lens' ImportSnapshot (Maybe Text)
- importSnapshot_description :: Lens' ImportSnapshot (Maybe Text)
- importSnapshot_diskContainer :: Lens' ImportSnapshot (Maybe SnapshotDiskContainer)
- importSnapshot_dryRun :: Lens' ImportSnapshot (Maybe Bool)
- importSnapshot_encrypted :: Lens' ImportSnapshot (Maybe Bool)
- importSnapshot_kmsKeyId :: Lens' ImportSnapshot (Maybe Text)
- importSnapshot_roleName :: Lens' ImportSnapshot (Maybe Text)
- importSnapshot_tagSpecifications :: Lens' ImportSnapshot (Maybe [TagSpecification])
- data ImportSnapshotResponse = ImportSnapshotResponse' {}
- newImportSnapshotResponse :: Int -> ImportSnapshotResponse
- importSnapshotResponse_description :: Lens' ImportSnapshotResponse (Maybe Text)
- importSnapshotResponse_importTaskId :: Lens' ImportSnapshotResponse (Maybe Text)
- importSnapshotResponse_snapshotTaskDetail :: Lens' ImportSnapshotResponse (Maybe SnapshotTaskDetail)
- importSnapshotResponse_tags :: Lens' ImportSnapshotResponse (Maybe [Tag])
- importSnapshotResponse_httpStatus :: Lens' ImportSnapshotResponse Int
Creating a Request
data ImportSnapshot Source #
See: newImportSnapshot
smart constructor.
ImportSnapshot' | |
|
Instances
newImportSnapshot :: ImportSnapshot Source #
Create a value of ImportSnapshot
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:
$sel:clientData:ImportSnapshot'
, importSnapshot_clientData
- The client-specific data.
ImportSnapshot
, importSnapshot_clientToken
- Token to enable idempotency for VM import requests.
ImportSnapshot
, importSnapshot_description
- The description string for the import snapshot task.
$sel:diskContainer:ImportSnapshot'
, importSnapshot_diskContainer
- Information about the disk container.
$sel:dryRun:ImportSnapshot'
, importSnapshot_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
.
ImportSnapshot
, importSnapshot_encrypted
- Specifies whether the destination snapshot of the imported image should
be encrypted. The default KMS key for EBS is used unless you specify a
non-default KMS key using KmsKeyId
. For more information, see
Amazon EBS Encryption
in the Amazon Elastic Compute Cloud User Guide.
ImportSnapshot
, importSnapshot_kmsKeyId
- An identifier for the symmetric KMS key to use when creating the
encrypted snapshot. This parameter is only required if you want to use a
non-default KMS key; if this parameter is not specified, the default KMS
key for EBS is used. If a KmsKeyId
is specified, the Encrypted
flag
must also be set.
The KMS key identifier may be provided in any of the following formats:
- Key ID
- Key alias. The alias ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - ARN using key ID. The ID ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thekey
namespace, and then the key 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 key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services 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 KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
$sel:roleName:ImportSnapshot'
, importSnapshot_roleName
- The name of the role to use when not using the default role,
'vmimport'.
ImportSnapshot
, importSnapshot_tagSpecifications
- The tags to apply to the import snapshot task during creation.
Request Lenses
importSnapshot_clientData :: Lens' ImportSnapshot (Maybe ClientData) Source #
The client-specific data.
importSnapshot_clientToken :: Lens' ImportSnapshot (Maybe Text) Source #
Token to enable idempotency for VM import requests.
importSnapshot_description :: Lens' ImportSnapshot (Maybe Text) Source #
The description string for the import snapshot task.
importSnapshot_diskContainer :: Lens' ImportSnapshot (Maybe SnapshotDiskContainer) Source #
Information about the disk container.
importSnapshot_dryRun :: Lens' ImportSnapshot (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
.
importSnapshot_encrypted :: Lens' ImportSnapshot (Maybe Bool) Source #
Specifies whether the destination snapshot of the imported image should
be encrypted. The default KMS key for EBS is used unless you specify a
non-default KMS key using KmsKeyId
. For more information, see
Amazon EBS Encryption
in the Amazon Elastic Compute Cloud User Guide.
importSnapshot_kmsKeyId :: Lens' ImportSnapshot (Maybe Text) Source #
An identifier for the symmetric KMS key to use when creating the
encrypted snapshot. This parameter is only required if you want to use a
non-default KMS key; if this parameter is not specified, the default KMS
key for EBS is used. If a KmsKeyId
is specified, the Encrypted
flag
must also be set.
The KMS key identifier may be provided in any of the following formats:
- Key ID
- Key alias. The alias ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - ARN using key ID. The ID ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thekey
namespace, and then the key 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 key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services 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 KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
importSnapshot_roleName :: Lens' ImportSnapshot (Maybe Text) Source #
The name of the role to use when not using the default role, 'vmimport'.
importSnapshot_tagSpecifications :: Lens' ImportSnapshot (Maybe [TagSpecification]) Source #
The tags to apply to the import snapshot task during creation.
Destructuring the Response
data ImportSnapshotResponse Source #
See: newImportSnapshotResponse
smart constructor.
ImportSnapshotResponse' | |
|
Instances
newImportSnapshotResponse Source #
Create a value of ImportSnapshotResponse
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:
ImportSnapshot
, importSnapshotResponse_description
- A description of the import snapshot task.
ImportSnapshotResponse
, importSnapshotResponse_importTaskId
- The ID of the import snapshot task.
ImportSnapshotResponse
, importSnapshotResponse_snapshotTaskDetail
- Information about the import snapshot task.
ImportSnapshotResponse
, importSnapshotResponse_tags
- Any tags assigned to the import snapshot task.
$sel:httpStatus:ImportSnapshotResponse'
, importSnapshotResponse_httpStatus
- The response's http status code.
Response Lenses
importSnapshotResponse_description :: Lens' ImportSnapshotResponse (Maybe Text) Source #
A description of the import snapshot task.
importSnapshotResponse_importTaskId :: Lens' ImportSnapshotResponse (Maybe Text) Source #
The ID of the import snapshot task.
importSnapshotResponse_snapshotTaskDetail :: Lens' ImportSnapshotResponse (Maybe SnapshotTaskDetail) Source #
Information about the import snapshot task.
importSnapshotResponse_tags :: Lens' ImportSnapshotResponse (Maybe [Tag]) Source #
Any tags assigned to the import snapshot task.
importSnapshotResponse_httpStatus :: Lens' ImportSnapshotResponse Int Source #
The response's http status code.