Atomically creates or updates multiple rate limits for a gateway¶
Description¶
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.
Usage¶
Arguments¶
-
gatewayIdentifier[required] The unique identifier of the gateway.
-
clientTokenA 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.
-
rateLimits[required] The complete set of rate limits for this gateway. This operation replaces all existing rate limits in a single request. If the operation fails, no rate limits are changed.
Value¶
A list with the following syntax:
list(
rateLimits = list(
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$batch_put_gateway_rate_limits(
gatewayIdentifier = "string",
clientToken = "string",
rateLimits = list(
list(
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"
)
)
)
)
)
)
)