AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) ImportImage API operation.

Syntax

Import-EC2Image
-Architecture <String>
-BootMode <BootModeValues>
-ClientData_Comment <String>
-Description <String>
-DiskContainer <ImageDiskContainer[]>
-Encrypted <Boolean>
-Hypervisor <String>
-KmsKeyId <String>
-LicenseSpecification <ImportImageLicenseConfigurationRequest[]>
-LicenseType <String>
-Platform <String>
-RoleName <String>
-TagSpecification <TagSpecification[]>
-ClientData_UtcUploadEnd <DateTime>
-ClientData_UploadSize <Double>
-ClientData_UtcUploadStart <DateTime>
-UsageOperation <String>
-ClientToken <String>
-ClientData_UploadEnd <DateTime>
-ClientData_UploadStart <DateTime>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide. Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized. For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

Parameters

-Architecture <String>
The architecture of the virtual machine.Valid values: i386 | x86_64
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BootMode <BootModeValues>
The boot mode of the virtual machine.The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientData_Comment <String>
A user-defined comment about the disk upload.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientData_UploadEnd <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use UploadEndUtc instead. Setting either UploadEnd or UploadEndUtc results in both UploadEnd and UploadEndUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. UploadEnd is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.The time that the disk upload ends.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientData_UploadSize <Double>
The size of the uploaded disk image, in GiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientData_UploadStart <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use UploadStartUtc instead. Setting either UploadStart or UploadStartUtc results in both UploadStart and UploadStartUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. UploadStart is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.The time that the disk upload starts.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientData_UtcUploadEnd <DateTime>
The time that the disk upload ends.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientData_UtcUploadStart <DateTime>
The time that the disk upload starts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The token to enable idempotency for VM import requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description string for the import image task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DiskContainer <ImageDiskContainer[]>
Information about the disk containers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiskContainers
-Encrypted <Boolean>
Specifies whether the destination AMI 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hypervisor <String>
The target hypervisor platform.Valid values: xen
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
An identifier for the symmetric KMS key to use when creating the encrypted AMI. 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
  • 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, the key 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, the alias 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 AMI is being copied to.Amazon EBS does not support asymmetric KMS keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LicenseSpecification <ImportImageLicenseConfigurationRequest[]>
The ARNs of the license configurations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLicenseSpecifications
-LicenseType <String>
The license type to be used for the Amazon Machine Image (AMI) after importing.Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Platform <String>
The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.Valid values: Windows | Linux
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleName <String>
The name of the role to use when not using the default role, 'vmimport'.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ImportImageResponse). Specifying the name of a property of type Amazon.EC2.Model.ImportImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagSpecification <TagSpecification[]>
The tags to apply to the import image task during creation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications
-UsageOperation <String>
The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.ImportImageResponse
This cmdlet returns an Amazon.EC2.Model.ImportImageResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

$container = New-Object Amazon.EC2.Model.ImageDiskContainer
$container.Format="VMDK"
$container.UserBucket = New-Object Amazon.EC2.Model.UserBucket
$container.UserBucket.S3Bucket = "myVirtualMachineImages"
$container.UserBucket.S3Key = "Win_2008_Server_Standard_SP2_64-bit-disk1.vmdk"

$parms = @{
    "ClientToken"="idempotencyToken"
    "Description"="Windows 2008 Standard Image Import"
    "Platform"="Windows"
    "LicenseType"="AWS"
}

Import-EC2Image -DiskContainer $container @parms 

Architecture    : 
Description     : Windows 2008 Standard Image
Hypervisor      : 
ImageId         : 
ImportTaskId    : import-ami-abcdefgh
LicenseType     : AWS
Platform        : Windows
Progress        : 2
SnapshotDetails : {}
Status          : active
StatusMessage   : pending
This example imports a single-disk virtual machine image from the specified Amazon S3 bucket to Amazon EC2 with an idempotency token.
The example requires that a VM Import Service Role with the default name 'vmimport' exists, with a policy allowing Amazon EC2 access to the specified bucket, as explained in the VM Import Prequisites topic. To use a custom role, specify the role name using the -RoleName parameter.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z