Sets the provisioned limit for a specific API category¶

Description¶

Sets the provisioned limit for a specific API category. The value must be between the default limit and your account-level maximum limit in Service Quotas.

Managed login user pools don't support adjustments to the UserAuthentication or UserFederation categories. To increase these limits, submit a Service Quotas increase request.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests
• Using the Amazon Cognito user pools API and user pool endpoints

Usage¶

cognitoidentityprovider_update_provisioned_limit(LimitDefinition,
  RequestedLimitValue)

Arguments¶

• LimitDefinition

[required] The limit to update. Specify the limit class and the attributes that identify the limit.

• RequestedLimitValue

[required] The provisioned rate to set, in requests per second (RPS).

Value¶

A list with the following syntax:

list(
  Limit = list(
    LimitDefinition = list(
      LimitClass = "API_CATEGORY",
      Attributes = list(
        "string"
      )
    ),
    ProvisionedLimitValue = 123,
    FreeLimitValue = 123
  )
)

Request syntax¶

svc$update_provisioned_limit(
  LimitDefinition = list(
    LimitClass = "API_CATEGORY",
    Attributes = list(
      "string"
    )
  ),
  RequestedLimitValue = 123
)