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) ImportSnapshot API operation.

Syntax

Import-EC2Snapshot
-ClientData_Comment <String>
-Description <String>
-DiskContainer_Description <String>
-Encrypted <Boolean>
-DiskContainer_Format <String>
-KmsKeyId <String>
-RoleName <String>
-DiskContainer_S3Bucket <String>
-DiskContainer_S3Key <String>
-TagSpecification <TagSpecification[]>
-ClientData_UtcUploadEnd <DateTime>
-ClientData_UploadSize <Double>
-ClientData_UtcUploadStart <DateTime>
-DiskContainer_Url <String>
-ClientToken <String>
-ClientData_UploadEnd <DateTime>
-ClientData_UploadStart <DateTime>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

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.

Parameters

-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>
Token to enable idempotency for VM import requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description string for the import snapshot task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DiskContainer_Description <String>
The description of the disk image being imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DiskContainer_Format <String>
The format of the disk image being imported.Valid values: VHD | VMDK | RAW
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DiskContainer_S3Bucket <String>
The name of the Amazon S3 bucket where the disk image is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiskContainer_UserBucket_S3Bucket
-DiskContainer_S3Key <String>
The file name of the disk image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiskContainer_UserBucket_S3Key
-DiskContainer_Url <String>
The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encrypted <Boolean>
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.
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)
-KmsKeyId <String>
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 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 snapshot is being copied to.Amazon EBS does not support asymmetric KMS keys.
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.ImportSnapshotResponse). Specifying the name of a property of type Amazon.EC2.Model.ImportSnapshotResponse 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 snapshot task during creation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications

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.ImportSnapshotResponse
This cmdlet returns an Amazon.EC2.Model.ImportSnapshotResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

$parms = @{
    "ClientToken"="idempotencyToken"
    "Description"="Disk Image Import"
    "DiskContainer_Description" = "Data disk"
    "DiskContainer_Format" = "VMDK"
    "DiskContainer_S3Bucket" = "myVirtualMachineImages"
    "DiskContainer_S3Key" = "datadiskimage.vmdk"
}

Import-EC2Snapshot @parms 

Description            ImportTaskId               SnapshotTaskDetail                                                          
-----------------      --------------------       ------------------                                                          
Disk Image Import      import-snap-abcdefgh       Amazon.EC2.Model.SnapshotTaskDetail
This example imports a VM disk image of format 'VMDK' to an Amazon EBS snapshot. The example requires a VM Import Service Role with the default name 'vmimport', 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