Container for the parameters to the UpdateProvisionedLimit operation. 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
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.UpdateProvisionedLimitRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class UpdateProvisionedLimitRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The UpdateProvisionedLimitRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateProvisionedLimitRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
LimitDefinition | Amazon.CognitoIdentityProvider.Model.LimitDefinitionType |
Gets and sets the property LimitDefinition. The limit to update. Specify the limit class and the attributes that identify the limit. |
|
|
RequestedLimitValue | System.Nullable<System.Int32> |
Gets and sets the property RequestedLimitValue. The provisioned rate to set, in requests per second (RPS). |
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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer