Skip to content

list_gateway_routes

Operation

list_gateway_routes

list_gateway_routes(request: ListGatewayRoutesInput | ListGatewayRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayRoutesInputDict]) -> ListGatewayRoutesOutput

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.

Parameters:

Name Type Description Default
request ListGatewayRoutesInput | ListGatewayRoutesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListGatewayRoutesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayRoutesOutput

An instance of ListGatewayRoutesOutput.

list_gateway_routes async

list_gateway_routes(request: ListGatewayRoutesInput | ListGatewayRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayRoutesInputDict]) -> ListGatewayRoutesOutput

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.

Parameters:

Name Type Description Default
request ListGatewayRoutesInput | ListGatewayRoutesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListGatewayRoutesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayRoutesOutput

An instance of ListGatewayRoutesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListGatewayRoutesInputDict

Bases: TypedDict

Dictionary form of ListGatewayRoutesInput.

Attributes

cluster instance-attribute
cluster: str | None

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

gateway instance-attribute
gateway: str | None

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

max_results instance-attribute
max_results: int | None

The maximum number of results that the operation returns in a single page. The default is 100.

next_token instance-attribute
next_token: str | None

The nextToken value returned from a previous paginated request.

service instance-attribute
service: str | None

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.

service_container_port_name instance-attribute
service_container_port_name: str | None

The name of a task definition container port to filter the results by.

status instance-attribute
status: Sequence[str] | None

The gateway route status to filter the results by.

ListGatewayRoutesInput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayRoutesInput structure.

Attributes

cluster class-attribute instance-attribute
cluster: str | None = ...

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

gateway class-attribute instance-attribute
gateway: str | None = ...

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

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results that the operation returns in a single page. The default is 100.

next_token class-attribute instance-attribute
next_token: str | None = ...

The nextToken value returned from a previous paginated request.

service class-attribute instance-attribute
service: str | None = ...

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.

service_container_port_name class-attribute instance-attribute
service_container_port_name: str | None = ...

The name of a task definition container port to filter the results by.

status class-attribute instance-attribute
status: list[str] | None = ...

The gateway route status to filter the results by.

Output

ListGatewayRoutesOutput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayRoutesOutput structure.

Attributes

gateway_routes class-attribute instance-attribute
gateway_routes: list[GatewayRouteSummary] | None = ...

The gateway routes that match the request.

next_token class-attribute instance-attribute
next_token: str | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.