AmazonCognitoIdentityProviderClient.GetProvisionedLimit Method (GetProvisionedLimitRequest)

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

Note:

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

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

Syntax

public virtual GetProvisionedLimitResponse GetProvisionedLimit(
         GetProvisionedLimitRequest request
)

Parameters

request: Type: Amazon.CognitoIdentityProvider.Model.GetProvisionedLimitRequest

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

Return Value

Type: GetProvisionedLimitResponse

The response from the GetProvisionedLimit 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.
TooManyRequestsException	This exception is thrown when the user has made too many requests for a given operation.

Examples

The following example returns the provisioned limit for the UserAuthentication API category.

Example get a provisioned limit


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

LimitType limit = response.Limit;

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

AmazonCognitoIdentityProviderClient.GetProvisionedLimit (GetProvisionedLimitRequest)

Method