Skip to content

batch_put_gateway_rate_limits

Operation

batch_put_gateway_rate_limits

batch_put_gateway_rate_limits(request: BatchPutGatewayRateLimitsInput | BatchPutGatewayRateLimitsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[BatchPutGatewayRateLimitsInputDict]) -> BatchPutGatewayRateLimitsOutput

Atomically creates or updates multiple rate limits for a gateway. The operation updates existing limits with matching keys and creates new limits for new keys. If the operation fails, the service applies no changes. Retry the request after resolving the issue.

Parameters:

Name Type Description Default
request BatchPutGatewayRateLimitsInput | BatchPutGatewayRateLimitsInputDict | 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[BatchPutGatewayRateLimitsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
BatchPutGatewayRateLimitsOutput

An instance of BatchPutGatewayRateLimitsOutput.

batch_put_gateway_rate_limits async

batch_put_gateway_rate_limits(request: BatchPutGatewayRateLimitsInput | BatchPutGatewayRateLimitsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[BatchPutGatewayRateLimitsInputDict]) -> BatchPutGatewayRateLimitsOutput

Atomically creates or updates multiple rate limits for a gateway. The operation updates existing limits with matching keys and creates new limits for new keys. If the operation fails, the service applies no changes. Retry the request after resolving the issue.

Parameters:

Name Type Description Default
request BatchPutGatewayRateLimitsInput | BatchPutGatewayRateLimitsInputDict | 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[BatchPutGatewayRateLimitsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
BatchPutGatewayRateLimitsOutput

An instance of BatchPutGatewayRateLimitsOutput.

Input

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

BatchPutGatewayRateLimitsInputDict

Bases: TypedDict

Dictionary form of BatchPutGatewayRateLimitsInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The unique identifier of the gateway.

rate_limits instance-attribute

The complete set of rate limits for this gateway. This operation replaces all existing rate limits in a single request. If the operation fails, no rate limits are changed.

BatchPutGatewayRateLimitsInput dataclass

Bases: _SerdeShape

Dataclass for BatchPutGatewayRateLimitsInput structure.

Attributes

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

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

The unique identifier of the gateway.

rate_limits class-attribute instance-attribute
rate_limits: list[BatchPutLimitEntry] | None = ...

The complete set of rate limits for this gateway. This operation replaces all existing rate limits in a single request. If the operation fails, no rate limits are changed.

Output

BatchPutGatewayRateLimitsOutput dataclass

Bases: _SerdeShape

Dataclass for BatchPutGatewayRateLimitsOutput structure.

Attributes

rate_limits instance-attribute

The resulting set of rate limits after the batch operation.

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.