ImportImage
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image 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.
- Architecture
-
The architecture of the virtual machine.
Valid values:
i386|x86_64Type: String
Required: No
- ClientData
-
The client-specific data.
Type: ClientData object
Required: No
- ClientToken
-
The token to enable idempotency for VM import requests.
Type: String
Required: No
- Description
-
A description string for the import image task.
Type: String
Required: No
- DiskContainer.N
-
Information about the disk containers.
Type: Array of ImageDiskContainer objects
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
- Hypervisor
-
The target hypervisor platform.
Valid values:
xenType: String
Required: No
- LicenseType
-
The license type to be used for the Amazon Machine Image (AMI) after importing.
Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
Valid values:
AWS|BYOLType: String
Required: No
- Platform
-
The operating system of the virtual machine.
Valid values:
Windows|LinuxType: 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.
- architecture
-
The architecture of the virtual machine.
Type: String
- description
-
A description of the import task.
Type: String
- hypervisor
-
The target hypervisor of the import task.
Type: String
- imageId
-
The ID of the Amazon Machine Image (AMI) created by the import task.
Type: String
- importTaskId
-
The task ID of the import image task.
Type: String
- licenseType
-
The license type of the virtual machine.
Type: String
- platform
-
The operating system of the virtual machine.
Type: String
- progress
-
The progress of the task.
Type: String
- requestId
-
The ID of the request.
Type: String
- snapshotDetailSet
-
Information about the snapshots.
Type: Array of SnapshotDetail objects
- status
-
A brief status of the task.
Type: String
- statusMessage
-
A detailed status message of the import task.
Type: String
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:
