list_gateway_rate_limits¶
Operation¶
list_gateway_rate_limits
¶
list_gateway_rate_limits(request: ListGatewayRateLimitsInput | ListGatewayRateLimitsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayRateLimitsInputDict]) -> ListGatewayRateLimitsOutput
Lists all rate limits for a gateway. Results are paginated. Use the
nextToken parameter to retrieve additional results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListGatewayRateLimitsInput | ListGatewayRateLimitsInputDict | 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[ListGatewayRateLimitsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGatewayRateLimitsOutput
|
An instance of |
list_gateway_rate_limits
async
¶
list_gateway_rate_limits(request: ListGatewayRateLimitsInput | ListGatewayRateLimitsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayRateLimitsInputDict]) -> ListGatewayRateLimitsOutput
Lists all rate limits for a gateway. Results are paginated. Use the
nextToken parameter to retrieve additional results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListGatewayRateLimitsInput | ListGatewayRateLimitsInputDict | 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[ListGatewayRateLimitsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGatewayRateLimitsOutput
|
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.
ListGatewayRateLimitsInputDict
¶
Bases: TypedDict
Dictionary form of ListGatewayRateLimitsInput.
Attributes¶
gateway_identifier
instance-attribute
¶
The unique identifier of the gateway.
ListGatewayRateLimitsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGatewayRateLimitsInput structure.
Attributes¶
gateway_identifier
class-attribute
instance-attribute
¶
gateway_identifier: str | None = ...
The unique identifier of the gateway.
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¶
ListGatewayRateLimitsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGatewayRateLimitsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token for the next page of results. If this value is absent, there are no more results to retrieve.
rate_limits
instance-attribute
¶
rate_limits: list[GatewayRateLimitDetail]
The list of rate limits for the gateway.
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.