aws_sdk_cognitoidentityprovider/client/
describe_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 [`DescribeRiskConfiguration`](crate::operation::describe_risk_configuration::builders::DescribeRiskConfigurationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::describe_risk_configuration::builders::DescribeRiskConfigurationFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::describe_risk_configuration::builders::DescribeRiskConfigurationFluentBuilder::set_user_pool_id):<br>required: **true**<br><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><br>
7    ///   - [`client_id(impl Into<String>)`](crate::operation::describe_risk_configuration::builders::DescribeRiskConfigurationFluentBuilder::client_id) / [`set_client_id(Option<String>)`](crate::operation::describe_risk_configuration::builders::DescribeRiskConfigurationFluentBuilder::set_client_id):<br>required: **false**<br><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><br>
8    /// - On success, responds with [`DescribeRiskConfigurationOutput`](crate::operation::describe_risk_configuration::DescribeRiskConfigurationOutput) with field(s):
9    ///   - [`risk_configuration(Option<RiskConfigurationType>)`](crate::operation::describe_risk_configuration::DescribeRiskConfigurationOutput::risk_configuration): <p>The details of the requested risk configuration.</p>
10    /// - On failure, responds with [`SdkError<DescribeRiskConfigurationError>`](crate::operation::describe_risk_configuration::DescribeRiskConfigurationError)
11    pub fn describe_risk_configuration(&self) -> crate::operation::describe_risk_configuration::builders::DescribeRiskConfigurationFluentBuilder {
12        crate::operation::describe_risk_configuration::builders::DescribeRiskConfigurationFluentBuilder::new(self.handle.clone())
13    }
14}