AmazonCognitoIdentityProviderClient.UpdateProvisionedLimit Method (UpdateProvisionedLimitRequest)

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateProvisionedLimitAsync.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public virtual UpdateProvisionedLimitResponse UpdateProvisionedLimit(
         UpdateProvisionedLimitRequest request
)

Parameters

request: Type: Amazon.CognitoIdentityProvider.Model.UpdateProvisionedLimitRequest

Container for the necessary parameters to execute the UpdateProvisionedLimit service method.

Return Value

Type: UpdateProvisionedLimitResponse

The response from the UpdateProvisionedLimit service method, as returned by CognitoIdentityProvider.

Exceptions

Exception	Condition
InternalErrorException	This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException	This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException	This exception is thrown when a user isn't authorized.
ResourceNotFoundException	This exception is thrown when the Amazon Cognito service can't find the requested resource.
ServiceQuotaExceededException	The request exceeded your account's service quota. To increase your limit, use or submit a Service Quotas increase request.
TooManyRequestsException	This exception is thrown when the user has made too many requests for a given operation.

Examples

The following example sets the provisioned limit for the UserAuthentication API category to 300 RPS.

Example update a provisioned limit


var client = new AmazonCognitoIdentityProviderClient();
var response = client.UpdateProvisionedLimit(new UpdateProvisionedLimitRequest 
{
    LimitDefinition = new LimitDefinitionType {
        Attributes = new Dictionary<string, string> {
            { "Category", "UserAuthentication" }
        },
        LimitClass = "API_CATEGORY"
    },
    RequestedLimitValue = 300
});

LimitType limit = response.Limit;

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

AmazonCognitoIdentityProviderClient.UpdateProvisionedLimit (UpdateProvisionedLimitRequest)

Method