ECS / Paginator / ListGatewayRoutes

ListGatewayRoutes

class ECS.Paginator.ListGatewayRoutes
paginator = client.get_paginator('list_gateway_routes')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    gateway='string',
    cluster='string',
    service='string',
    serviceContainerPortName='string',
    status=[
        'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • gateway (string) – The name or Amazon Resource Name (ARN) of a gateway to filter the results by.

  • cluster (string) – The name or Amazon Resource Name (ARN) of a cluster to filter the results by.

  • service (string) – The name or Amazon Resource Name (ARN) of a service to filter the results by. Because services can span clusters, a service name isn’t necessarily unique and can match multiple services.

  • serviceContainerPortName (string) – The name of a task definition container port to filter the results by.

  • status (list) –

    The gateway route status to filter the results by.

    • (string) –

      The status of a gateway route.

  • 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

{
    'gatewayRoutes': [
        {
            'gatewayRouteArn': 'string',
            'gatewayArn': 'string',
            'clusterArn': 'string',
            'serviceArn': 'string',
            'serviceContainerPortName': 'string',
            'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • gatewayRoutes (list) –

      The gateway routes that match the request.

      • (dict) –

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

        • gatewayRouteArn (string) –

          The Amazon Resource Name (ARN) of the gateway route.

        • gatewayArn (string) –

          The Amazon Resource Name (ARN) of the gateway.

        • clusterArn (string) –

          The Amazon Resource Name (ARN) of the cluster.

        • serviceArn (string) –

          The Amazon Resource Name (ARN) of the service.

        • serviceContainerPortName (string) –

          The task definition container port name that the route targets on the service.

        • status (string) –

          The status of the gateway route.

    • NextToken (string) –

      A token to resume pagination.