Amazon Elastic Compute Cloud
CLI Reference (API Version 2011-12-15)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

ec2-describe-bundle-tasks

Description

Describes current bundling tasks.

[Note]Note

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use the ec2-register command with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

You can filter the results to return information only about tasks that match criteria you specify. For example, you could filter the results to return only the tasks whose state is complete. You can specify multiple values for a filter. A bundle task must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the bundle is stored in a particular Amazon S3 bucket and the state is complete). The result includes information for a particular bundle task only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following table shows the available filters.

Filter Name Description

bundle-id

ID of the bundle task.

Type: String

error-code

If the task failed, the error code returned.

Type: String

error-message

If the task failed, the error message returned.

Type: String

instance-id

ID of the instance that was bundled.

Type: String

progress

Level of task completion, in percent (e.g., 20%).

Type: String

s3-bucket

Amazon S3 bucket where the AMI will be stored.

Type: String

s3-prefix

Beginning of the AMI name.

Type: String

start-time

Time the task started, e.g., 2008-09-15T17:15:20.000Z.

Type: xsd:dateTime

state

State of the task.

Type: String

Valid Values: pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed

update-time

Time of the most recent update for the task, e.g., 2008-09-15T17:15:20.000Z.

Type: xsd:dateTime

The short version of this command is ec2dbun.

Syntax

ec2-describe-bundle-tasks [bundle ...] [[--filter name=value] ...]

Options

NameDescriptionRequired

bundle

The ID of the bundle task to describe.

Type: String

Default: Describes all bundle tasks, or only those otherwise specified.

Example: bun-cla432a3

No

--filter name=value

A filter for limiting the results. See the preceding table for a list of allowed filter names and values. If you're using the command line tools on a Windows system, you might need to use quotation marks (i.e., "name=value").

Type: String

Default: Describes all your bundle tasks, or only those otherwise specified.

Example: --filter "state=pending"

No

Common Options

OptionDescription

--region REGION

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

Default: The EC2_URL environment variable, or us-east-1 if the environment variable is not set.

Example: --region eu-west-1

-U, --url URL

URL is the uniform resource locator of the Amazon EC2 web service entry point.

Default: The EC2_URL environment variable, or https://ec2.amazonaws.com if the environment variable is not set.

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

-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-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.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-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem

--connection-timeout TIMEOUT

Specifies a connection timeout (in seconds).

Example: --connection-timeout 30

--request-timeout TIMEOUT

Specifies a request timeout (in seconds).

Example: --request-timeout 45

-v, --verbose

Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.

-H, --headers

Displays column headers in the output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Do not display tags for tagged resources.

--debug

Prints internal debugging information. This is useful to assist us when troubleshooting problems.

-?, --help, -h

Displays Help.

-

If - is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another.

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

Output

The command returns a table that contains the following information:

  • BUNDLE identifier

  • ID of the bundle

  • ID of the instance

  • Bucket name

  • Prefix

  • Start time

  • Update time

  • State (pending, waiting-for-shutdown, bundling, storing, cancelling, complete, failed)

  • Progress in % if state is "bundling"

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example describes the status of the bun-c1a540a8 bundle task.

PROMPT> ec2-describe-bundle-tasks bun-c1a540a8
BUNDLE bun-c1a540a8  i-2674d22r  mybucket  winami  2008-09-15T17:15:20.000Z  2008-09-15T17:15:20.000Z  bundling  3%

Example Request

This example filters the results to display only bundle tasks whose state is either complete or failed, and in addition are targeted for the Amazon S3 bucket called mybucket.

PROMPT> ec2-describe-bundle-tasks --filter "s3-bucket=mybucket" --filter "state=complete" --filter "state=failed"
BUNDLE bun-1a2b3c4d  i-8765abcd  mybucket  linuxami  2008-09-14T08:32:43.000Z  2008-09-14T08:32:43.000Z  complete