CognitoIdentityProvider / Client / update_provisioned_limit

update_provisioned_limit

CognitoIdentityProvider.Client.update_provisioned_limit(**kwargs)

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.update_provisioned_limit(
    LimitDefinition={
        'LimitClass': 'API_CATEGORY',
        'Attributes': {
            'string': 'string'
        }
    },
    RequestedLimitValue=123
)
Parameters:

  • LimitDefinition (dict) –

    [REQUIRED]

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

    • LimitClass (string) – [REQUIRED]

      The class of the limit. For API rate limits, this is API_CATEGORY.

    • Attributes (dict) – [REQUIRED]

      The attributes that identify the specific limit. For API rate limits, specify the Category key with a value like UserAuthentication or UserCreation.

      • (string) –

        • (string) –

  • RequestedLimitValue (integer) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Limit': {
        'LimitDefinition': {
            'LimitClass': 'API_CATEGORY',
            'Attributes': {
                'string': 'string'
            }
        },
        'ProvisionedLimitValue': 123,
        'FreeLimitValue': 123
    }
}

Response Structure

  • (dict) –

    • Limit (dict) –

      The updated provisioned and default limit values.

      • LimitDefinition (dict) –

        The definition that identifies this limit, including the class and attributes.

        • LimitClass (string) –

          The class of the limit. For API rate limits, this is API_CATEGORY.

        • Attributes (dict) –

          The attributes that identify the specific limit. For API rate limits, specify the Category key with a value like UserAuthentication or UserCreation.

          • (string) –

            • (string) –

      • ProvisionedLimitValue (integer) –

        The provisioned limit value, in requests per second (RPS). This is the rate that Amazon Cognito currently enforces for your account.

      • FreeLimitValue (integer) –

        The default (free) limit value, in requests per second (RPS). This is the rate included at no additional cost.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.ServiceQuotaExceededException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException