aws_sdk_cognitoidentityprovider/client/

set_user_mfa_preference.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SetUserMFAPreference`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`sms_mfa_settings(SmsMfaSettingsType)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::sms_mfa_settings) / [`set_sms_mfa_settings(Option<SmsMfaSettingsType>)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::set_sms_mfa_settings):<br>required: **false**<br><p>User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.</p><br>
    ///   - [`software_token_mfa_settings(SoftwareTokenMfaSettingsType)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::software_token_mfa_settings) / [`set_software_token_mfa_settings(Option<SoftwareTokenMfaSettingsType>)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::set_software_token_mfa_settings):<br>required: **false**<br><p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. Users must register a TOTP authenticator before they set this as their preferred MFA method.</p><br>
    ///   - [`email_mfa_settings(EmailMfaSettingsType)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::email_mfa_settings) / [`set_email_mfa_settings(Option<EmailMfaSettingsType>)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::set_email_mfa_settings):<br>required: **false**<br><p>User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html"> Essentials tier</a> or higher.</p><br>
    ///   - [`access_token(impl Into<String>)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::access_token) / [`set_access_token(Option<String>)`](crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::set_access_token):<br>required: **true**<br><p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for <code>aws.cognito.signin.user.admin</code>.</p><br>
    /// - On success, responds with [`SetUserMfaPreferenceOutput`](crate::operation::set_user_mfa_preference::SetUserMfaPreferenceOutput)
    /// - On failure, responds with [`SdkError<SetUserMFAPreferenceError>`](crate::operation::set_user_mfa_preference::SetUserMFAPreferenceError)
    pub fn set_user_mfa_preference(&self) -> crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder {
        crate::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder::new(self.handle.clone())
    }
}