| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
DescribeBundleTasks
Description
Describes one or more of your bundling tasks.
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.
Request Parameters
BundleId.nOne or more bundle task IDs.
Type: String
Default: If no ID is specified, all bundle tasks are described.
Required: No
Filter.n.NameThe name of a filter. See the Supported Filters section for a list of supported filter names.
Type: String
Default: None
Required: No
Filter.n.Value.mA value for the filter. See the Supported Filters section for a list of supported values for each filter.
Type: String
Default: None
Required: No
Supported Filters
You can specify filters so that the response includes information for only certain bundle tasks.
For example, you can use a filter to specify that you're interested in the bundle tasks in the complete state. You can specify multiple values for a filter. The response includes information for a bundle task only if it matches at least one of the filter values that you specified.
You can specify multiple filters; for example, specify bundles that are stored in a specific Amazon S3 bucket and are in the complete state. The response includes information for a bundle task only if it matches all the filters that you specified. If there's no match, no special message is returned, the response is simply empty.
You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) 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 are the available filters.
bundle-idThe ID of the bundle task.
Type: String
error-codeIf the task failed, the error code returned.
Type: String
error-messageIf the task failed, the error message returned.
Type: String
instance-idThe ID of the instance that was bundled.
Type: String
progressThe level of task completion, as a percentage (for example, 20%).
Type: String
s3-bucketThe Amazon S3 bucket to store the AMI.
Type: String
s3-prefixThe beginning of the AMI name.
Type: String
start-timeThe time the task started (for example, 2008-09-15T17:15:20.000Z).
Type: DateTime
stateThe state of the task.
Type: String
Valid values:
pending|waiting-for-shutdown|bundling|storing|cancelling|complete|failedupdate-timeThe time of the most recent update for the task (for example, 2008-09-15T17:15:20.000Z).
Type: DateTime
Response Elements
The following elements are returned in a
DescribeBundleTasksResponse element.
requestIdThe ID of the request.
Type: xsd:string
bundleInstanceTasksSetA list of bundle tasks, each one wrapped in an
itemelement.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/2013-02-01/">
<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>myawsbucket</bucket>
<prefix>winami</prefix>
</S3>
</storage>
<progress>20%</progress>
</item>
<bundleInstanceTasksSet>
</DescribeBundleTasksResponse>Example Request
This example filters the response to include only bundle tasks whose state is either complete or failed, and in addition are targeted for the Amazon S3 bucket called myawsbucket.
https://ec2.amazonaws.com/?Action=DescribeBundleTasks &Filter.1.Name=s3-bucket &Filter.1.Value.1=myawsbucket &Filter.2.Name=state &Filter.2.Name.1=complete &Filter.2.Name.2=failed &AUTHPARAMS
