get_provisioned_limit async ¶

async def get_provisioned_limit(
    self,
    limit_definition: "capo_cognito_identity_provider.types.limit_definition_type.LimitDefinitionType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.get_provisioned_limit_response.GetProvisionedLimitResponse":
    """<p>Returns the current provisioned limit for a specific API category.</p> <note> <p>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.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>

    Args:
        limit_definition: <p>The limit to retrieve. Specify the limit class and the attributes that identify the limit.</p>

    Raises:
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Example get a provisioned limit
        The following example returns the provisioned limit for the UserAuthentication API category.

        >>> await client.get_provisioned_limit(limit_definition={'LimitClass': 'API_CATEGORY', 'Attributes': {'Category': 'UserAuthentication'}})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity_provider.types.get_provisioned_limit_request.GetProvisionedLimitRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.get_provisioned_limit_response.GetProvisionedLimitResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.get_provisioned_limit

        (
            output,
            http_response,
        ) = await capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.get_provisioned_limit.async_get_provisioned_limit(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetProvisionedLimit")
    )
    input_: capo_cognito_identity_provider.types.get_provisioned_limit_request.GetProvisionedLimitRequest = {
        "limit_definition": limit_definition
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output