View a markdown version of this page

GatewayRateLimitDetail - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GatewayRateLimitDetail

Contains detailed information about a gateway rate limit, including its configuration and current status.

Contents

createdAt

The timestamp when the rate limit was created.

Type: Timestamp

Required: Yes

dimensionKeys

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: (targetName|toolName|qualifiedModelId|\$\.context\.iam\.principal|\$\.context\.iam\.sourceIdentity|\$\.context\.jwt\.[a-zA-Z_][a-zA-Z0-9_\-\.]{0,61}[a-zA-Z0-9_])

Required: Yes

entries

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

Type: Array of LimitEntry objects

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Required: Yes

gatewayIdentifier

The unique identifier of the gateway.

Type: String

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

Required: Yes

rateLimitId

The unique identifier of the rate limit.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [a-zA-Z0-9][a-zA-Z0-9\-_\.]{0,62}[a-zA-Z0-9]

Required: Yes

status

The current status of the rate limit.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING

Required: Yes

updatedAt

The timestamp when the rate limit was last updated.

Type: Timestamp

Required: Yes

description

The human-readable description of the rate limit.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 512.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: