list-gateway-rate-limits¶

Description¶

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

Synopsis¶

  list-gateway-rate-limits
--gateway-identifier <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--gateway-identifier (string) [required]

The unique identifier of the gateway.

Constraints:

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

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

rateLimits -> (list)

The list of rate limits for the gateway.

(structure)

Shared fields for GatewayRateLimit responses

rateLimitId -> (string) [required]

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

Constraints:

min: 2

max: 64

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

gatewayIdentifier -> (string) [required]

The unique identifier of the gateway.

Constraints:

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

description -> (string)

Optional human-readable description for this limit.

Constraints:

min: 0

max: 512

dimensionKeys -> (list) [required]

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

Constraints:

min: 1

max: 10

(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.

Constraints:

min: 1

max: 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_])

entries -> (list) [required]

List of rule entries within a limit

Constraints:

min: 1

max: 1000

(structure)

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

dimensions -> (map) [required]

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).

Constraints:

min: 1

max: 10

key -> (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.

Constraints:

min: 1

max: 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_])

value -> (string)

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

Constraints:

min: 1

max: 256

requests -> (list)

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

Constraints:

min: 1

max: 1

(structure)

Rate configuration for a metric (requests or tokens)

rate -> (double) [required]

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.

Constraints:

min: 0

max: 10000000

period -> (string) [required]

Time period for rate limiting

Possible values:

second

minute

tokens -> (list)

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

Constraints:

min: 1

max: 1

(structure)

Rate configuration for a metric (requests or tokens)

rate -> (double) [required]

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.

Constraints:

min: 0

max: 10000000

period -> (string) [required]

Time period for rate limiting

Possible values:

second

minute

connections -> (list)

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

Constraints:

min: 1

max: 1

(structure)

Rate configuration for a metric (requests or tokens)

rate -> (double) [required]

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.

Constraints:

min: 0

max: 10000000

period -> (string) [required]

Time period for rate limiting

Possible values:

second

minute

status -> (string) [required]

Status of a gateway limit

Possible values:

CREATING

ACTIVE

UPDATING

DELETING

createdAt -> (timestamp) [required]

The timestamp when the rate limit was created.

updatedAt -> (timestamp) [required]

The timestamp when the rate limit was last updated.

nextToken -> (string)

The token for the next page of results. If this value is absent, there are no more results to retrieve.

Constraints:

min: 1

max: 2048

pattern: \S*

Table of Contents

Feedback

User Guide