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

Invokes the ImportImage operation against Amazon Elastic Compute Cloud.

Syntax

Import-EC2Image
-Architecture <String>
-ClientToken <String>
-ClientData_Comment <String>
-Description <String>
-DiskContainer <ImageDiskContainer[]>
-Hypervisor <String>
-LicenseType <String>
-Platform <String>
-RoleName <String>
-ClientData_UploadEnd <DateTime>
-ClientData_UploadSize <Double>
-ClientData_UploadStart <DateTime>
-Force <SwitchParameter>

Description

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.

Parameters

-Architecture <String>
The architecture of the virtual machine.Valid values: i386 | x86_64
Required?False
Position?Named
Accept pipeline input?False
-ClientData_Comment <String>
A user-defined comment about the disk upload.
Required?False
Position?Named
Accept pipeline input?False
-ClientData_UploadEnd <DateTime>
The time that the disk upload ends.
Required?False
Position?Named
Accept pipeline input?False
-ClientData_UploadSize <Double>
The size of the uploaded disk image, in GiB.
Required?False
Position?Named
Accept pipeline input?False
-ClientData_UploadStart <DateTime>
The time that the disk upload starts.
Required?False
Position?Named
Accept pipeline input?False
-ClientToken <String>
The token to enable idempotency for VM import requests.
Required?False
Position?Named
Accept pipeline input?False
-Description <String>
A description string for the import image task.
Required?False
Position?Named
Accept pipeline input?False
-DiskContainer <ImageDiskContainer[]>
Information about the disk containers.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-Hypervisor <String>
The target hypervisor platform.Valid values: xen
Required?False
Position?Named
Accept pipeline input?False
-LicenseType <String>
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 | BYOL
Required?False
Position?Named
Accept pipeline input?False
-Platform <String>
The operating system of the virtual machine.Valid values: Windows | Linux
Required?False
Position?Named
Accept pipeline input?False
-RoleName <String>
The name of the role to use when not using the default role, 'vmimport'.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a 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

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

PS C:\> $parms = @{
"ClientToken"="idempotencyToken"
"Description"="Windows 2008 Standard Image Import"
"Platform"="Windows"
"LicenseType"="AWS"
}

PS C:\> 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.

Supported Version

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