Amazon Elastic Compute Cloud
API 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...

DescribeBundleTasks

Description

Describes current bundling tasks for Amazon S3-backed Windows instances.

[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 RegisterImage action 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

Request Parameters

NameDescriptionRequired

BundleId.n

One or more bundle task IDs.

Type: String

Default: If no ID is specified, all bundle tasks are described.

No

Filter.n.Name

Name of a filter. See the preceding table for a list of allowed filter names.

Type: String

Default: None

No

Filter.n.Value.m

A value for the filter. See the preceding table for a list of allowed values for each filter.

Type: String

Default: None

No

Response Elements

The elements in the following table are wrapped in a DescribeBundleTasksResponse structure.

NameDescription

requestId

The ID of the request.

Type: xsd:string

bundleInstanceTasksSet

A list of bundle tasks. Each task's information is wrapped in an item element.

Type: BundleInstanceTaskType

Examples

Example Request

This example describes the status of the bun-57a5403e bundle task.

https://ec2.amazonaws.com/?Action=DescribeBundleTasks
&bundleId.1=bun-c1a540a8
&AUTHPARAMS

Example Response

<DescribeBundleTasksResponse xmlns="http://ec2.amazonaws.com/doc/2011-12-15/">
   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> 
   <bundleInstanceTasksSet>
      <item>
         <instanceId>i-12345678</instanceId>
         <bundleId>bun-c1a540a8</bundleId>
         <state>cancelling</state>
         <startTime>2008-10-07T11:41:50.000Z</startTime>
         <updateTime>2008-10-07T11:51:50.000Z</updateTime>
         <storage>
            <S3>
               <bucket>mybucket</bucket>
               <prefix>winami</prefix>
            </S3>
         </storage>
         <progress>20%</progress>
      </item>
   <bundleInstanceTasksSet>
</DescribeBundleTasksResponse>

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.

https://ec2.amazonaws.com/?Action=DescribeBundleTasks
&Filter.1.Name=s3-bucket
&Filter.1.Value.1=mybucket
&Filter.2.Name=state
&Filter.2.Name.1=complete
&Filter.2.Name.2=failed
&AUTHPARAMS