BedrockAgentCoreControl / Paginator / ListGatewayRateLimits

ListGatewayRateLimits

class BedrockAgentCoreControl.Paginator.ListGatewayRateLimits

paginator = client.get_paginator('list_gateway_rate_limits')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BedrockAgentCoreControl.Client.list_gateway_rate_limits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    gatewayIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• gatewayIdentifier (string) –

  [REQUIRED]

  The unique identifier of the gateway.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'rateLimits': [
        {
            'rateLimitId': 'string',
            'gatewayIdentifier': 'string',
            'description': 'string',
            'dimensionKeys': [
                'string',
            ],
            'entries': [
                {
                    'dimensions': {
                        'string': 'string'
                    },
                    'requests': [
                        {
                            'rate': 123.0,
                            'period': 'second'|'minute'
                        },
                    ],
                    'tokens': [
                        {
                            'rate': 123.0,
                            'period': 'second'|'minute'
                        },
                    ],
                    'connections': [
                        {
                            'rate': 123.0,
                            'period': 'second'|'minute'
                        },
                    ]
                },
            ],
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • rateLimits (list) –

    The list of rate limits for the gateway.

    • (dict) –

      Shared fields for GatewayRateLimit responses

      • rateLimitId (string) –

        Limit identifier. Optional on Create (system-generates if not provided by customer). Always present in responses.

      • gatewayIdentifier (string) –

        The unique identifier of the gateway.

      • description (string) –

        Optional human-readable description for this limit.

      • dimensionKeys (list) –

        Ordered list of dimension key names defining the scope of a limit

        • (string) –

          A dimension key specifying the scope dimension for rate limiting. Allowed values: “targetName”, “toolName”, “qualifiedModelId”, or context-path expressions: “$.context.iam.principal”, “$.context.iam.sourceIdentity”, “$.context.jwt.” where is a JWT claim name (e.g., “$.context.jwt.sub”). Validated server-side to enforce allowed prefixes and patterns.

      • entries (list) –

        List of rule entries within a limit

        • (dict) –

          A single rule entry within a limit, mapping dimension values to rate configurations

          • dimensions (dict) –

            Map of dimension name to dimension value, matching the parent limit’s dimensionKeys. Keys must exactly match the dimensionKeys. Values may be “” as a wildcard. “” may only appear at trailing positions (based on dimensionKeys ordering).

            • (string) –

              A dimension key specifying the scope dimension for rate limiting. Allowed values: “targetName”, “toolName”, “qualifiedModelId”, or context-path expressions: “$.context.iam.principal”, “$.context.iam.sourceIdentity”, “$.context.jwt.” where is a JWT claim name (e.g., “$.context.jwt.sub”). Validated server-side to enforce allowed prefixes and patterns.

              • (string) –

                A dimension value in a rule entry (exact value or “*” wildcard)

          • requests (list) –

            Request rate limits (RPS or RPM). Limited to 1 entry for now.

            • (dict) –

              Rate configuration for a metric (requests or tokens)

              • rate (float) –

                The rate value for the limit. For request limits, this is the number of requests allowed per period. For token limits, this is the number of tokens allowed per period. For connection limits, this is the number of concurrent connections allowed.

              • period (string) –

                Time period for rate limiting

          • tokens (list) –

            Token rate limits (TPM). Limited to 1 entry for now. — P1

            • (dict) –

              Rate configuration for a metric (requests or tokens)

              • rate (float) –

                The rate value for the limit. For request limits, this is the number of requests allowed per period. For token limits, this is the number of tokens allowed per period. For connection limits, this is the number of concurrent connections allowed.

              • period (string) –

                Time period for rate limiting

          • connections (list) –

            Connection rate limits (per second only). Limited to 1 entry for now. — P2

            • (dict) –

              Rate configuration for a metric (requests or tokens)

              • rate (float) –

                The rate value for the limit. For request limits, this is the number of requests allowed per period. For token limits, this is the number of tokens allowed per period. For connection limits, this is the number of concurrent connections allowed.

              • period (string) –

                Time period for rate limiting

      • status (string) –

        Status of a gateway limit

      • createdAt (datetime) –

        The timestamp when the rate limit was created.

      • updatedAt (datetime) –

        The timestamp when the rate limit was last updated.

  • NextToken (string) –

    A token to resume pagination.