Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetProvisionedLimit

Returns the current provisioned limit for a specific API category.

For more information about adjustable API rate limits, see Managing provisioned limits.

Note

Amazon Cognito evaluates AWS 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

Request Syntax


{
   "LimitDefinition": { 
      "Attributes": { 
         "string" : "string" 
      },
      "LimitClass": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

LimitDefinition

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

Type: LimitDefinitionType object

Required: Yes

Response Syntax


{
   "Limit": { 
      "FreeLimitValue": number,
      "LimitDefinition": { 
         "Attributes": { 
            "string" : "string" 
         },
         "LimitClass": "string"
      },
      "ProvisionedLimitValue": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Limit

The provisioned and default limit values for the requested limit.

Type: LimitType object

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalErrorException

This exception is thrown when Amazon Cognito encounters an internal error.

message: The message returned when Amazon Cognito throws an internal error exception.

HTTP Status Code: 500

InvalidParameterException

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

message: The message returned when the Amazon Cognito service throws an invalid parameter exception.
reasonCode: The reason code of the exception.

HTTP Status Code: 400

NotAuthorizedException

This exception is thrown when a user isn't authorized.

message: The message returned when the Amazon Cognito service returns a not authorized exception.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service can't find the requested resource.

message: The message returned when the Amazon Cognito service returns a resource not found exception.

HTTP Status Code: 400

TooManyRequestsException

This exception is thrown when the user has made too many requests for a given operation.

message: The message returned when the Amazon Cognito service returns a too many requests exception.

HTTP Status Code: 400