Skip to content

delete_gateway_rate_limit

Operation

delete_gateway_rate_limit

delete_gateway_rate_limit(request: DeleteGatewayRateLimitInput | DeleteGatewayRateLimitInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayRateLimitInputDict]) -> DeleteGatewayRateLimitOutput

Deletes a gateway rate limit.

Parameters:

Name Type Description Default
request DeleteGatewayRateLimitInput | DeleteGatewayRateLimitInputDict | 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[DeleteGatewayRateLimitInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayRateLimitOutput

An instance of DeleteGatewayRateLimitOutput.

delete_gateway_rate_limit async

delete_gateway_rate_limit(request: DeleteGatewayRateLimitInput | DeleteGatewayRateLimitInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayRateLimitInputDict]) -> DeleteGatewayRateLimitOutput

Deletes a gateway rate limit.

Parameters:

Name Type Description Default
request DeleteGatewayRateLimitInput | DeleteGatewayRateLimitInputDict | 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[DeleteGatewayRateLimitInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayRateLimitOutput

An instance of DeleteGatewayRateLimitOutput.

Input

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

DeleteGatewayRateLimitInputDict

Bases: TypedDict

Dictionary form of DeleteGatewayRateLimitInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The unique identifier of the gateway.

rate_limit_id instance-attribute
rate_limit_id: Required[str]

The unique identifier of the rate limit to delete.

DeleteGatewayRateLimitInput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayRateLimitInput structure.

Attributes

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

The unique identifier of the gateway.

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

The unique identifier of the rate limit to delete.

Output

DeleteGatewayRateLimitOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayRateLimitOutput structure.

Attributes

rate_limit_id instance-attribute
rate_limit_id: str

The unique identifier of the deleted rate limit.

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.

status instance-attribute
status: str

The current status of the rate limit deletion.