EC2 / Client / describe_bundle_tasks

describe_bundle_tasks

EC2.Client.describe_bundle_tasks(**kwargs)

Describes the specified bundle tasks or all of your bundle 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 RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

Note

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

See also: AWS API Documentation

Request Syntax

response = client.describe_bundle_tasks(
    BundleIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

• BundleIds (list) –

  The bundle task IDs.

  Default: Describes all your bundle tasks.

  • (string) –

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

• Filters (list) –

  The filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task ( pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'BundleTasks': [
        {
            'InstanceId': 'string',
            'BundleId': 'string',
            'State': 'pending'|'waiting-for-shutdown'|'bundling'|'storing'|'cancelling'|'complete'|'failed',
            'StartTime': datetime(2015, 1, 1),
            'UpdateTime': datetime(2015, 1, 1),
            'Storage': {
                'S3': {
                    'AWSAccessKeyId': 'string',
                    'Bucket': 'string',
                    'Prefix': 'string',
                    'UploadPolicy': b'bytes',
                    'UploadPolicySignature': 'string'
                }
            },
            'Progress': 'string',
            'BundleTaskError': {
                'Code': 'string',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • BundleTasks (list) –

    Information about the bundle tasks.

    • (dict) –

      Describes a bundle task.

      • InstanceId (string) –

        The ID of the instance associated with this bundle task.

      • BundleId (string) –

        The ID of the bundle task.

      • State (string) –

        The state of the task.

      • StartTime (datetime) –

        The time this task started.

      • UpdateTime (datetime) –

        The time of the most recent update for the task.

      • Storage (dict) –

        The Amazon S3 storage locations.

        • S3 (dict) –

          An Amazon S3 storage location.

          • AWSAccessKeyId (string) –

            The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Amazon Web Services accounts in the Account ManagementReference Guide.

          • Bucket (string) –

            The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

          • Prefix (string) –

            The beginning of the file name of the AMI.

          • UploadPolicy (bytes) –

            An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

          • UploadPolicySignature (string) –

            The signature of the JSON document.

      • Progress (string) –

        The level of task completion, as a percent (for example, 20%).

      • BundleTaskError (dict) –

        If the task fails, a description of the error.

        • Code (string) –

          The error code.

        • Message (string) –

          The error message.