EC2 / Waiter / StoreImageTaskComplete

StoreImageTaskComplete#

class EC2.Waiter.StoreImageTaskComplete#
waiter = client.get_waiter('store_image_task_complete')
wait(**kwargs)#

Polls EC2.Client.describe_store_image_tasks() every 5 seconds until a successful state is reached. An error is raised after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    ImageIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
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) –

  • NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • MaxResults (integer) –

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

    You cannot specify this parameter and the ImageIds parameter in the same call.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 5

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 40

Returns:

None