/

POST

Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "ClientId": "string",
    "CompromisedCredentialsRiskConfiguration": {
        "EventFilter": [],
        "Actions": {
            "EventAction": "BLOCK"
        }
    },
    "AccountTakeoverRiskConfiguration": {
        "NotifyConfiguration": {
            "From": "string",
            "ReplyTo": "string",
            "SourceArn": "string",
            "BlockEmail": {
                "Subject": "string",
                "HtmlBody": "string",
                "TextBody": "string"
            },
            "NoActionEmail": {},
            "MfaEmail": {}
        },
        "Actions": {
            "LowAction": {
                "Notify": true,
                "EventAction": "BLOCK"
            },
            "MediumAction": {},
            "HighAction": {}
        }
    },
    "RiskExceptionConfiguration": {
        "BlockedIPRangeList": [],
        "SkippedIPRangeList": []
    }
}'

Response Example

200 - Example 1

{
    "RiskConfiguration": {
        "UserPoolId": "string",
        "ClientId": "string",
        "CompromisedCredentialsRiskConfiguration": {
            "EventFilter": [],
            "Actions": {
                "EventAction": "BLOCK"
            }
        },
        "AccountTakeoverRiskConfiguration": {
            "NotifyConfiguration": {
                "From": "string",
                "ReplyTo": "string",
                "SourceArn": "string",
                "BlockEmail": {
                    "Subject": "string",
                    "HtmlBody": "string",
                    "TextBody": "string"
                },
                "NoActionEmail": {},
                "MfaEmail": {}
            },
            "Actions": {
                "LowAction": {
                    "Notify": true,
                    "EventAction": "BLOCK"
                },
                "MediumAction": {},
                "HighAction": {}
            }
        },
        "RiskExceptionConfiguration": {
            "BlockedIPRangeList": [],
            "SkippedIPRangeList": []
        },
        "LastModifiedDate": "string"
    }
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserPoolAddOnNotEnabledException

🟠485CodeDeliveryFailureException

🟠486InvalidEmailRoleAccessPolicyException

🟠487InternalErrorException

Modified at 2023-08-15 07:11:07