Creates a rate limit for a gateway¶

Description¶

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.

Usage¶

bedrockagentcorecontrol_create_gateway_rate_limit(gatewayIdentifier,
  clientToken, rateLimitId, description, dimensionKeys, entries)

Arguments¶

gatewayIdentifier

[required] The unique identifier of the gateway to create the rate limit for.
clientToken

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
rateLimitId

An optional customer-defined identifier for the rate limit. If not provided, the system generates one.
description

An optional human-readable description for this rate limit. If not provided, the rate limit is created without a description.
dimensionKeys

[required] The ordered list of dimension key names that define the scope of this rate limit. Must be unique per gateway—no two rate limits can share the same dimension keys.
entries

[required] The rule entries that map dimension values to rate configurations.

Value¶

A list with the following syntax:

list(
  rateLimitId = "string",
  gatewayIdentifier = "string",
  description = "string",
  dimensionKeys = list(
    "string"
  ),
  entries = list(
    list(
      dimensions = list(
        "string"
      ),
      requests = list(
        list(
          rate = 123.0,
          period = "second"|"minute"
        )
      ),
      tokens = list(
        list(
          rate = 123.0,
          period = "second"|"minute"
        )
      ),
      connections = list(
        list(
          rate = 123.0,
          period = "second"|"minute"
        )
      )
    )
  ),
  status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$create_gateway_rate_limit(
  gatewayIdentifier = "string",
  clientToken = "string",
  rateLimitId = "string",
  description = "string",
  dimensionKeys = list(
    "string"
  ),
  entries = list(
    list(
      dimensions = list(
        "string"
      ),
      requests = list(
        list(
          rate = 123.0,
          period = "second"|"minute"
        )
      ),
      tokens = list(
        list(
          rate = 123.0,
          period = "second"|"minute"
        )
      ),
      connections = list(
        list(
          rate = 123.0,
          period = "second"|"minute"
        )
      )
    )
  )
)