Skip to content

SetRiskConfigurationRequest

Source code in docs_src/capo_cognito_identity_provider/types/set_risk_configuration_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class SetRiskConfigurationRequest(TypedDict, closed=True):
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool where you want to set a risk configuration. If you include <code>UserPoolId</code> in your request, don't include <code>ClientId</code>. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. When you include both <code>ClientId</code> and <code>UserPoolId</code>, Amazon Cognito maps the configuration to the app client only.</p>"""
    client_id: NotRequired[
        "capo_cognito_identity_provider.types.client_id_type.ClientIdType"
    ]
    """<p>The ID of the app client where you want to set a risk configuration. If <code>ClientId</code> is null, then the risk configuration is mapped to <code>UserPoolId</code>. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.</p> <p>When you include a <code>ClientId</code> parameter, Amazon Cognito maps the configuration to the app client. When you include both <code>ClientId</code> and <code>UserPoolId</code>, Amazon Cognito maps the configuration to the app client only.</p>"""
    compromised_credentials_risk_configuration: NotRequired[
        "capo_cognito_identity_provider.types.compromised_credentials_risk_configuration_type.CompromisedCredentialsRiskConfigurationType"
    ]
    """<p>The configuration of automated reactions to detected compromised credentials. Includes settings for blocking future sign-in requests and for the types of password-submission events you want to monitor.</p>"""
    account_takeover_risk_configuration: NotRequired[
        "capo_cognito_identity_provider.types.account_takeover_risk_configuration_type.AccountTakeoverRiskConfigurationType"
    ]
    """<p>The settings for automated responses and notification templates for adaptive authentication with threat protection.</p>"""
    risk_exception_configuration: NotRequired[
        "capo_cognito_identity_provider.types.risk_exception_configuration_type.RiskExceptionConfigurationType"
    ]
    """<p>A set of IP-address overrides to threat protection. You can set up IP-address always-block and always-allow lists.</p>"""

account_takeover_risk_configuration instance-attribute 

account_takeover_risk_configuration: NotRequired[AccountTakeoverRiskConfigurationType]

The settings for automated responses and notification templates for adaptive authentication with threat protection.

client_id instance-attribute 

client_id: NotRequired[ClientIdType]

The ID of the app client where you want to set a risk configuration. If ClientId is null, then the risk configuration is mapped to UserPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

When you include a ClientId parameter, Amazon Cognito maps the configuration to the app client. When you include both ClientId and UserPoolId, Amazon Cognito maps the configuration to the app client only.

compromised_credentials_risk_configuration instance-attribute 

compromised_credentials_risk_configuration: NotRequired[
    CompromisedCredentialsRiskConfigurationType
]

The configuration of automated reactions to detected compromised credentials. Includes settings for blocking future sign-in requests and for the types of password-submission events you want to monitor.

risk_exception_configuration instance-attribute 

risk_exception_configuration: NotRequired[RiskExceptionConfigurationType]

A set of IP-address overrides to threat protection. You can set up IP-address always-block and always-allow lists.

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

The ID of the user pool where you want to set a risk configuration. If you include UserPoolId in your request, don't include ClientId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. When you include both ClientId and UserPoolId, Amazon Cognito maps the configuration to the app client only.