gateway_rate_limits

Creates, updates, deletes, gets or lists a gateway_rate_limits resource.

Overview

Name	gateway_rate_limits
Type	Resource
Id	aws.bedrock_agentcore_control.gateway_rate_limits

Fields

The following fields are returned by SELECT queries:

get_gateway_rate_limit

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the rate limit was created.
description	string	An optional human-readable description for a gateway limit.
dimension_keys	array	An ordered list of dimension key names defining the scope of a limit.
entries	array	A list of rule entries within a limit.
gateway_identifier	string	The unique identifier of the gateway. (pattern: <code>([0-9a-z][-]?){1,100}-[0-9a-z]{10}</code>)
rate_limit_id	string	The limit identifier. Optional on create (the system generates it if not provided by the customer). Always present in responses. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9]</code>)
status	string	The current status of the rate limit. (CREATING, ACTIVE, UPDATING, DELETING)
updated_at	string (date-time)	The timestamp when the rate limit was last updated.

list_gateway_rate_limits

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the rate limit was created.
description	string	The human-readable description of the rate limit.
dimension_keys	array	The ordered list of dimension key names that define the scope of this rate limit.
entries	array	The list of rule entries that map dimension values to rate configurations.
gateway_identifier	string	The unique identifier of the gateway. (pattern: <code>([0-9a-z][-]?){1,100}-[0-9a-z]{10}</code>)
rate_limit_id	string	The unique identifier of the rate limit. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9]</code>)
status	string	The current status of the rate limit. (CREATING, ACTIVE, UPDATING, DELETING)
updated_at	string (date-time)	The timestamp when the rate limit was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_gateway_rate_limit	select	gateway_identifier, rate_limit_id, region		Retrieves information about a gateway rate limit.
list_gateway_rate_limits	select	gateway_identifier, region	maxResults, nextToken	Lists all rate limits for a gateway. Results are paginated. Use the nextToken parameter to retrieve additional results.
create_gateway_rate_limit	insert	gateway_identifier, region, dimensionKeys, entries		Creates a rate limit for a gateway. Rate limits define throttling rules for each dimension that control request rates, token consumption rates, and concurrent connections through the gateway.
update_gateway_rate_limit	update	gateway_identifier, rate_limit_id, region, entries		Updates the entries of a gateway rate limit. The dimension keys are immutable after creation.
delete_gateway_rate_limit	delete	gateway_identifier, rate_limit_id, region		Deletes a gateway rate limit.
batch_put_gateway_rate_limits	exec	gateway_identifier, region, rateLimits		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
gateway_identifier	string	The unique identifier of the gateway.
rate_limit_id	string	The unique identifier of the rate limit to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	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.
nextToken	string	The token to use to retrieve the next page of results. Use the value returned in a previous ListGatewayRateLimits response.

SELECT examples

get_gateway_rate_limit

Retrieves information about a gateway rate limit.

SELECT
created_at,
description,
dimension_keys,
entries,
gateway_identifier,
rate_limit_id,
status,
updated_at
FROM aws.bedrock_agentcore_control.gateway_rate_limits
WHERE gateway_identifier = '{{ gateway_identifier }}' -- required
AND rate_limit_id = '{{ rate_limit_id }}' -- required
AND region = '{{ region }}' -- required
;

list_gateway_rate_limits

Lists all rate limits for a gateway. Results are paginated. Use the nextToken parameter to retrieve additional results.

SELECT
created_at,
description,
dimension_keys,
entries,
gateway_identifier,
rate_limit_id,
status,
updated_at
FROM aws.bedrock_agentcore_control.gateway_rate_limits
WHERE gateway_identifier = '{{ gateway_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_gateway_rate_limit

Creates a rate limit for a gateway. Rate limits define throttling rules for each dimension that control request rates, token consumption rates, and concurrent connections through the gateway.

INSERT INTO aws.bedrock_agentcore_control.gateway_rate_limits (
clientToken,
rateLimitId,
description,
dimensionKeys,
entries,
gateway_identifier,
region
)
SELECT 
'{{ clientToken }}',
'{{ rateLimitId }}',
'{{ description }}',
'{{ dimensionKeys }}' /* required */,
'{{ entries }}' /* required */,
'{{ gateway_identifier }}',
'{{ region }}'
RETURNING
created_at,
description,
dimension_keys,
entries,
gateway_identifier,
rate_limit_id,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: gateway_rate_limits
props:
  - name: gateway_identifier
    value: "{{ gateway_identifier }}"
    description: Required parameter for the gateway_rate_limits resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the gateway_rate_limits resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: rateLimitId
    value: "{{ rateLimitId }}"
    description: |
      The limit identifier. Optional on create (the system generates it if not provided by the customer). Always present in responses.
  - name: description
    value: "{{ description }}"
    description: |
      An optional human-readable description for a gateway limit.
  - name: dimensionKeys
    value:
      - "{{ dimensionKeys }}"
    description: |
      An ordered list of dimension key names defining the scope of a limit.
  - name: entries
    description: |
      A list of rule entries within a limit.
    value:
      - dimensions: "{{ dimensions }}"
        requests: "{{ requests }}"
        tokens: "{{ tokens }}"
        connections: "{{ connections }}"

UPDATE examples

update_gateway_rate_limit

Updates the entries of a gateway rate limit. The dimension keys are immutable after creation.

UPDATE aws.bedrock_agentcore_control.gateway_rate_limits
SET 
description = '{{ description }}',
entries = '{{ entries }}'
WHERE 
gateway_identifier = '{{ gateway_identifier }}' --required
AND rate_limit_id = '{{ rate_limit_id }}' --required
AND region = '{{ region }}' --required
AND entries = '{{ entries }}' --required
RETURNING
created_at,
description,
dimension_keys,
entries,
gateway_identifier,
rate_limit_id,
status,
updated_at;

DELETE examples

delete_gateway_rate_limit

Deletes a gateway rate limit.

DELETE FROM aws.bedrock_agentcore_control.gateway_rate_limits
WHERE gateway_identifier = '{{ gateway_identifier }}' --required
AND rate_limit_id = '{{ rate_limit_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

batch_put_gateway_rate_limits

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.

EXEC aws.bedrock_agentcore_control.gateway_rate_limits.batch_put_gateway_rate_limits 
@gateway_identifier='{{ gateway_identifier }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"clientToken": "{{ clientToken }}", 
"rateLimits": "{{ rateLimits }}"
}'
;