list_gateways¶
Operation¶
async
¶
list_gateways(input: ListGatewaysInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
ListGatewaysInput
|
An instance of |
required |
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 |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGatewaysInput structure.
Attributes¶
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.
class-attribute
instance-attribute
¶
The gateway names to filter the results by. You can specify up to 10 names.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGatewaysOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
gateways: list[GatewaySummary] | None = ...
The list of gateways that match the request.
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.
class-attribute
instance-attribute
¶
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.