aws_sdk_cognitoidentityprovider/client/set_risk_configuration.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`SetRiskConfiguration`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`user_pool_id(impl Into<String>)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::set_user_pool_id):<br>required: **true**<br><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><br>
7 /// - [`client_id(impl Into<String>)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::client_id) / [`set_client_id(Option<String>)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::set_client_id):<br>required: **false**<br><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><br>
8 /// - [`compromised_credentials_risk_configuration(CompromisedCredentialsRiskConfigurationType)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::compromised_credentials_risk_configuration) / [`set_compromised_credentials_risk_configuration(Option<CompromisedCredentialsRiskConfigurationType>)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::set_compromised_credentials_risk_configuration):<br>required: **false**<br><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><br>
9 /// - [`account_takeover_risk_configuration(AccountTakeoverRiskConfigurationType)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::account_takeover_risk_configuration) / [`set_account_takeover_risk_configuration(Option<AccountTakeoverRiskConfigurationType>)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::set_account_takeover_risk_configuration):<br>required: **false**<br><p>The settings for automated responses and notification templates for adaptive authentication with threat protection.</p><br>
10 /// - [`risk_exception_configuration(RiskExceptionConfigurationType)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::risk_exception_configuration) / [`set_risk_exception_configuration(Option<RiskExceptionConfigurationType>)`](crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::set_risk_exception_configuration):<br>required: **false**<br><p>A set of IP-address overrides to threat protection. You can set up IP-address always-block and always-allow lists.</p><br>
11 /// - On success, responds with [`SetRiskConfigurationOutput`](crate::operation::set_risk_configuration::SetRiskConfigurationOutput) with field(s):
12 /// - [`risk_configuration(Option<RiskConfigurationType>)`](crate::operation::set_risk_configuration::SetRiskConfigurationOutput::risk_configuration): <p>The API response that contains the risk configuration that you set and the timestamp of the most recent change.</p>
13 /// - On failure, responds with [`SdkError<SetRiskConfigurationError>`](crate::operation::set_risk_configuration::SetRiskConfigurationError)
14 pub fn set_risk_configuration(&self) -> crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder {
15 crate::operation::set_risk_configuration::builders::SetRiskConfigurationFluentBuilder::new(self.handle.clone())
16 }
17}