Skip to content

ECS  >  Operations  >  list_gateways

list_gateways

Operation

list_gateways async

list_gateways(request: ListGatewaysInput | ListGatewaysInputDict, /, *, plugins: list[Plugin] | None = None) -> ListGatewaysOutput
list_gateways(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewaysInputDict]) -> ListGatewaysOutput

Returns a list of gateways in your account. You can filter the results by gateway 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
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

Returns:

Type Description
ListGatewaysOutput

An instance of ListGatewaysOutput.

Input

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

Model

ListGatewaysInput dataclass

Bases: _SerdeShape

Dataclass for ListGatewaysInput structure.

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

The maximum number of gateway results that ListGateways returns in a single page. The default is 100.

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

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

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

The nextToken value returned from a previous paginated ListGateways request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results.

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

The gateway statuses to filter the results by.

Dictionaries

ListGatewaysInputDict

Bases: TypedDict

Dictionary form of ListGatewaysInput.

Attributes
max_results instance-attribute
max_results: int | None

The maximum number of gateway results that ListGateways returns in a single page. The default is 100.

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

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

next_token instance-attribute
next_token: str | None

The nextToken value returned from a previous paginated ListGateways request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results.

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

The gateway statuses to filter the results by.

Output

ListGatewaysOutput dataclass

Bases: _SerdeShape

Dataclass for ListGatewaysOutput structure.

Attributes

gateways class-attribute instance-attribute
gateways: list[GatewaySummary] | None = ...

The list of gateways that match the request.

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

The nextToken value to include in a future ListGateways request. When the results of a ListGateways request exceed maxResults, this value can be used 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.