describe_risk_configuration ¶

def describe_risk_configuration(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
    client_id: Optional[
        "capo_cognito_identity_provider.types.client_id_type.ClientIdType"
    ] = None,
) -> "capo_cognito_identity_provider.types.describe_risk_configuration_response.DescribeRiskConfigurationResponse":
    """<p>Given an app client or user pool ID where threat protection is configured, describes the risk configuration. This operation returns details about adaptive authentication, compromised credentials, and IP-address allow- and denylists. For more information about threat protection, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html">Threat protection</a>.</p>

    Args:
        user_pool_id: <p>The ID of the user pool with the risk configuration that you want to inspect. You can apply default risk configuration at the user pool level and further customize it from user pool defaults at the app-client level. Specify <code>ClientId</code> to inspect client-level configuration, or <code>UserPoolId</code> to inspect pool-level configuration.</p>
        client_id: <p>The ID of the app client with the risk configuration that you want to inspect. You can apply default risk configuration at the user pool level and further customize it from user pool defaults at the app-client level. Specify <code>ClientId</code> to inspect client-level configuration, or <code>UserPoolId</code> to inspect pool-level configuration.</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.operation_not_enabled_exception.OperationNotEnabledException: <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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.user_pool_add_on_not_enabled_exception.UserPoolAddOnNotEnabledException: <p>This exception is thrown when user pool add-ons aren't enabled.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity_provider.types.describe_risk_configuration_request.DescribeRiskConfigurationRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.describe_risk_configuration_response.DescribeRiskConfigurationResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_risk_configuration

        output, http_response = (
            capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_risk_configuration.describe_risk_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_cognito_identity_provider.types.describe_risk_configuration_request.DescribeRiskConfigurationRequest",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.describe_risk_configuration_request

        return capo_cognito_identity_provider.types.describe_risk_configuration_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_cognito_identity_provider.types.describe_risk_configuration_response.DescribeRiskConfigurationResponse",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.describe_risk_configuration_response

        return capo_cognito_identity_provider.types.describe_risk_configuration_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeRiskConfiguration",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_cognito_identity_provider.types.describe_risk_configuration_request.DescribeRiskConfigurationRequest = {
        "user_pool_id": user_pool_id
    }
    if client_id is not None:
        input_["client_id"] = client_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output