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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- ClientData
-
The client-specific data.
Type: ClientData object
Required: No
- ClientToken
-
Token to enable idempotency for VM import requests.
Type: String
Required: No
- Description
-
The description string for the import snapshot task.
Type: String
Required: No
- DiskContainer
-
Information about the disk container.
Type: SnapshotDiskContainer object
Required: No
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- 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.Type: Boolean
Required: No
- 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
KmsKeyIdis specified, theEncryptedflag must also be set.The KMS key identifier may be provided in any of the following formats:
-
Key ID
-
Key alias
-
ARN using key ID. The ID ARN contains the
arn:aws:kmsnamespace, followed by the Region of the key, the AWS account ID of the key owner, thekeynamespace, 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:kmsnamespace, followed by the Region of the key, the AWS account ID of the key owner, thealiasnamespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses
KmsKeyIdasynchronously, 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.
Type: String
Required: No
-
- RoleName
-
The name of the role to use when not using the default role, 'vmimport'.
Type: String
Required: No
- TagSpecification.N
-
The tags to apply to the import snapshot task during creation.
Type: Array of TagSpecification objects
Required: No
Response Elements
The following elements are returned by the service.
- description
-
A description of the import snapshot task.
Type: String
- importTaskId
-
The ID of the import snapshot task.
Type: String
- requestId
-
The ID of the request.
Type: String
- snapshotTaskDetail
-
Information about the import snapshot task.
Type: SnapshotTaskDetail object
- tagSet
-
Any tags assigned to the import snapshot task.
Type: Array of Tag objects
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
