list_gateways¶
Operation¶
list_gateways
¶
list_gateways(request: ListGatewaysInput | ListGatewaysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewaysInputDict]) -> ListGatewaysOutput
Lists all gateways in the account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListGatewaysInput | ListGatewaysInputDict | 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[ListGatewaysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGatewaysOutput
|
An instance of |
list_gateways
async
¶
list_gateways(request: ListGatewaysInput | ListGatewaysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewaysInputDict]) -> ListGatewaysOutput
Lists all gateways in the account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListGatewaysInput | ListGatewaysInputDict | 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[ListGatewaysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGatewaysOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListGatewaysInputDict
¶
Bases: TypedDict
Dictionary form of ListGatewaysInput.
Attributes¶
ListGatewaysInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGatewaysInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
Output¶
ListGatewaysOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGatewaysOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the total number of results is greater than the maxResults value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.
response_metadata
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.