Returns the current provisioned limit for a specific API category¶

Description¶

Returns the current provisioned limit for a specific API category.

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_get_provisioned_limit(LimitDefinition)

Arguments¶

• LimitDefinition

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

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$get_provisioned_limit(
  LimitDefinition = list(
    LimitClass = "API_CATEGORY",
    Attributes = list(
      "string"
    )
  )
)