provisioned_limits

Creates, updates, deletes, gets or lists a provisioned_limits resource.

Overview

Name	provisioned_limits
Type	Resource
Id	aws.cognito_idp.provisioned_limits

Fields

The following fields are returned by SELECT queries:

get_provisioned_limit

Name	Datatype	Description
free_limit_value	integer	The default (free) limit value, in requests per second (RPS). This is the rate included at no additional cost.
limit_definition	object	The definition that identifies this limit, including the class and attributes.
provisioned_limit_value	integer	The provisioned limit value, in requests per second (RPS). This is the rate that Amazon Cognito currently enforces for your account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_provisioned_limit	select	region		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 Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
update_provisioned_limit	update	region, LimitDefinition, RequestedLimitValue		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 Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_provisioned_limit

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 Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

SELECT
free_limit_value,
limit_definition,
provisioned_limit_value
FROM aws.cognito_idp.provisioned_limits
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_provisioned_limit

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 Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

UPDATE aws.cognito_idp.provisioned_limits
SET 
LimitDefinition = '{{ LimitDefinition }}',
RequestedLimitValue = {{ RequestedLimitValue }}
WHERE 
region = '{{ region }}' --required
AND LimitDefinition = '{{ LimitDefinition }}' --required
AND RequestedLimitValue = '{{ RequestedLimitValue }}' --required
RETURNING
limit;