ECS / Paginator / ListGateways

ListGateways

class ECS.Paginator.ListGateways

paginator = client.get_paginator('list_gateways')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_gateways().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    names=[
        'string',
    ],
    status=[
        'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• names (list) –

  The gateway names to filter the results by. You can specify up to 10 names.

  • (string) –

• status (list) –

  The gateway statuses to filter the results by.

  • (string) –

    The status of a gateway.

• 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

{
    'gateways': [
        {
            'gatewayArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETED',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • gateways (list) –

    The list of gateways that match the request.

    • (dict) –

      A summary of a gateway that is returned by the ListGateways operation.

      • gatewayArn (string) –

        The Amazon Resource Name (ARN) of the gateway.

      • name (string) –

        The name of the gateway.

      • status (string) –

        The status of the gateway.

      • createdAt (datetime) –

        The Unix timestamp for the time when the gateway was created.

  • NextToken (string) –

    A token to resume pagination.