Outposts / Paginator / ListCapacityTasks

ListCapacityTasks

class Outposts.Paginator.ListCapacityTasks

paginator = client.get_paginator('list_capacity_tasks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Outposts.Client.list_capacity_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OutpostIdentifierFilter='string',
    CapacityTaskStatusFilter=[
        'REQUESTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'CANCELLED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OutpostIdentifierFilter (string) – Filters the results by an Outpost ID or an Outpost ARN.

• CapacityTaskStatusFilter (list) –

  A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION.

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

{
    'CapacityTasks': [
        {
            'CapacityTaskId': 'string',
            'OutpostId': 'string',
            'OrderId': 'string',
            'CapacityTaskStatus': 'REQUESTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'CANCELLED',
            'CreationDate': datetime(2015, 1, 1),
            'CompletionDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • CapacityTasks (list) –

    Lists all the capacity tasks.

    • (dict) –

      The summary of the capacity task.

      • CapacityTaskId (string) –

        The ID of the specified capacity task.

      • OutpostId (string) –

        The ID of the Outpost associated with the specified capacity task.

      • OrderId (string) –

        The ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

      • CapacityTaskStatus (string) –

        The status of the capacity task.

      • CreationDate (datetime) –

        The date that the specified capacity task was created.

      • CompletionDate (datetime) –

        The date that the specified capacity task successfully ran.

      • LastModifiedDate (datetime) –

        The date that the specified capacity was last modified.