Skip to content

Bedrock AgentCore Control  >  Operations  >  get_gateway_rate_limit

get_gateway_rate_limit

Operation

get_gateway_rate_limit async 

get_gateway_rate_limit(input: GetGatewayRateLimitInput, plugins: list[Plugin] | None = None) -> GetGatewayRateLimitOutput

Retrieves information about a gateway rate limit.

Parameters:

Name Type Description Default
input GetGatewayRateLimitInput

An instance of GetGatewayRateLimitInput.

 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
GetGatewayRateLimitOutput

An instance of GetGatewayRateLimitOutput.

Input

GetGatewayRateLimitInput dataclass

Dataclass for GetGatewayRateLimitInput structure.

Attributes

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

The unique identifier of the gateway.

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

The unique identifier of the rate limit to retrieve.

Output

GetGatewayRateLimitOutput dataclass

Shared fields for GatewayRateLimit responses.

Attributes

created_at instance-attribute 
created_at: datetime

The timestamp when the rate limit was created.

description class-attribute instance-attribute 
description: str | None = None

The human-readable description of the rate limit.

dimension_keys instance-attribute 
dimension_keys: list[str]

The ordered list of dimension key names that define the scope of this rate limit.

entries instance-attribute 
entries: list[LimitEntry]

The list of rule entries that map dimension values to rate configurations.

gateway_identifier instance-attribute 
gateway_identifier: str

The unique identifier of the gateway.

rate_limit_id instance-attribute 
rate_limit_id: str

The unique identifier of the rate limit.

status instance-attribute 
status: GatewayRateLimitStatus

The current status of the rate limit.

updated_at instance-attribute 
updated_at: datetime

The timestamp when the rate limit was last updated.