EC2 / Paginator / DescribeStoreImageTasks

DescribeStoreImageTasks

class EC2.Paginator.DescribeStoreImageTasks

paginator = client.get_paginator('describe_store_image_tasks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_store_image_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ImageIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ImageIds (list) –

  The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

  • (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.

  • task-state - Returns tasks in a certain state ( InProgress | Completed | Failed)

  • bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

  Note

  When you specify the ImageIds parameter, any filters that you specify are ignored. To use the filters, you must remove the ImageIds parameter.

  • (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) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'StoreImageTaskResults': [
        {
            'AmiId': 'string',
            'TaskStartTime': datetime(2015, 1, 1),
            'Bucket': 'string',
            'S3objectKey': 'string',
            'ProgressPercentage': 123,
            'StoreTaskState': 'string',
            'StoreTaskFailureReason': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • StoreImageTaskResults (list) –

    The information about the AMI store tasks.

    • (dict) –

      The information about the AMI store task, including the progress of the task.

      • AmiId (string) –

        The ID of the AMI that is being stored.

      • TaskStartTime (datetime) –

        The time the task started.

      • Bucket (string) –

        The name of the Amazon S3 bucket that contains the stored AMI object.

      • S3objectKey (string) –

        The name of the stored AMI object in the bucket.

      • ProgressPercentage (integer) –

        The progress of the task as a percentage.

      • StoreTaskState (string) –

        The state of the store task ( InProgress, Completed, or Failed).

      • StoreTaskFailureReason (string) –

        If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.