Amazon Elastic Compute Cloud
CLI Reference (API Version 2013-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

ec2-upload-disk-image

Description

Deprecated. Instead, use the ec2-import-instance and ec2-import-volume commands (included in the command line tools as of 2011-09-15) to create the import task and upload the image to Amazon EC2. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

Uploads the disk image associated with an import instance or an import volume task ID. Amazon EC2 supports import of VMDK, RAW, and VHD disk images.

If the upload task doesn't complete, use ec2-resume-import to resume the import from where it was interrupted.

The short version of this command is ec2udi.

Syntax

ec2-upload-disk-image -t task_id -o owner -w secret_key [-x days] [--user-threads threads] [--part-size partsize] [--dry-run] [--dont-verify-format] disk_image

Options

NameDescription

disk_image

The local file name of the disk image that you want to upload.

Type: String

Default: None

Required: Yes

Example: WinSvr8-32-disk1.vmdk

-t, --task task_id

The conversion task ID for the upload.

Type: String

Default: None

Required: Yes

Example: -t import-i-ffvko9js

-o, --owner-akid access_key_id

The access key ID of the bucket owner.

Type: String

Default: None

Required: Yes

Example: AKIAIOSFODNN7EXAMPLE

-w, --owner-sak secret_access_key

The secret access key of the bucket owner.

Type: String

Default: None

Required: Yes

Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

-x, --expires days

The validity period for the signed Amazon S3 URLs that allow Amazon EC2 to access your file.

Type: String

Default: 30 days

Required: No

Example: -x 10

--user-threads threads

The maximum number of threads to concurrently upload the file with.

Type: String

Default: 20

Required: No

Example: --user-threads 15

--part-size partsize

The size of each individual file part (in MB) that will be uploaded. The file will be split into multiple parts at most as large as the partsize parameter.

Type: String

Default: 8

Required: No

Example: --part-size 3

--dry-run

Does not upload the file, only validates that the disk image matches a known type.

Type: None

Default: None

Required: No

Example: --dry-run

--dont-verify-format

Does not verify the file format. We don't recommend this option because it can result in a failed conversion.

Type: None

Default: None

Required: No

Example: --dont-verify-format

Common Options

OptionDescription

--region REGION

Overrides the region specified by the EC2_URL environment variable and the URL specified by the -U option.

Default: The value of the EC2_URL environment variable, or us-east-1 if EC2_URL isn't set.

Example: --region eu-west-1

-U, --url URL

The uniform resource locator (URL) of the Amazon EC2 web service entry point.

Default: The value of the EC2_URL environment variable, or https://ec2.amazonaws.com if EC2_URL isn't set.

Example: -U https://ec2.amazonaws.com

-K, --private-key EC2-PRIVATE-KEY

The private key that identifies you to Amazon EC2. For more information, see Tell the Tools Who You Are.

Default: The value of the EC2_PRIVATE_KEY environment variable. If EC2_PRIVATE_KEY isn't set, you must specify this option.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate that identifies you to Amazon EC2.

Default: The value of the EC2_CERT environment variable. If EC2_CERT isn't set, you must specify this option.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-O, --aws-access-key AWS_ACCESS_KEY

The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are.

Default: The value of the AWS_ACCESS_KEY environment variable. If AWS_ACCESS_KEY isn't set, you must specify this option.

Example: -O AKIAIOSFODNN7EXAMPLE

Note

For more information, see the following section, Deprecated Options.

-W, --aws-secret-key AWS_SECRET_KEY

The secret access key associated with your AWS account.

Default: The value of the AWS_SECRET_KEY environment variable. If AWS_SECRET_KEY isn't set, you must specify this option.

Example: -W wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Note

For more information, see the following section, Deprecated Options.

-T, --security-token TOKEN AWS_DELEGATION_TOKEN

The AWS delegation token.

Default: The value of the environment variable (if set).

--connection-timeout TIMEOUT

The connection timeout, in seconds.

Example: --connection-timeout 30

--request-timeout TIMEOUT

The request timeout, in seconds.

Example: --request-timeout 45

-v, --verbose

Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API.

-H, --headers

Includes column headers in the command output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Omits tags for tagged resources.

--debug

Displays internal debugging information. This can assist us when helping you troubleshooting problems.

-?, --help, -h

Displays usage information for the command.

-

Reads arguments from standard input. This is useful when piping the output from one command to the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Deprecated Options

For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.

OptionDescription

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

Output

This command returns the following information:

  • The disk image size and format

  • The converted volume size

  • The EBS volume size

  • The percentage of the upload completed

Amazon EC2 command line tools display errors on stderr.

Example

Example Request

This example uploads the corresponding disk image of the Windows Server 2008 (32-bit) VM you want to migrate.

PROMPT>ec2-upload-disk-image ./WinSvr8-32-disk1.vmdk -t import-i-ffvko9js -o AKIAIOSFODNN7EXAMPLE -w wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY