ECS / Client / list_gateway_routes

list_gateway_routes

ECS.Client.list_gateway_routes(**kwargs)

Returns a list of gateway routes. A gateway route represents the association between a service and a gateway and the service-specific infrastructure the gateway manages for it. You can filter the results by gateway, cluster, service, container port name, and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

See also: AWS API Documentation

Request Syntax

response = client.list_gateway_routes(
    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',
    ],
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – The maximum number of results that the operation returns in a single page. The default is 100.

  • nextToken (string) – The nextToken value returned from a previous paginated request.

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

      The nextToken value to include in a future request to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions