Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

ImportSnapshot

Imports a disk into an EBS snapshot.

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 is UnauthorizedOperation.

Type: Boolean

Required: No

Encrypted

Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK 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 AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

Type: String

Required: No

RoleName

The name of the role to use when not using the default role, 'vmimport'.

Type: String

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

Errors

For information about the errors that are common to all actions, see Common Client Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: