aws_sdk_cognitoidentityprovider/client/

admin_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 [`AdminSetUserMFAPreference`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`sms_mfa_settings(SmsMfaSettingsType)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::sms_mfa_settings) / [`set_sms_mfa_settings(Option<SmsMfaSettingsType>)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::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::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::software_token_mfa_settings) / [`set_software_token_mfa_settings(Option<SoftwareTokenMfaSettingsType>)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::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. This operation can set TOTP as a user's preferred MFA method before they register a TOTP authenticator.</p><br>
    ///   - [`email_mfa_settings(EmailMfaSettingsType)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::email_mfa_settings) / [`set_email_mfa_settings(Option<EmailMfaSettingsType>)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::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>
    ///   - [`username(impl Into<String>)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::set_username):<br>required: **true**<br><p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p><br>
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to set a user's MFA preferences.</p><br>
    /// - On success, responds with [`AdminSetUserMfaPreferenceOutput`](crate::operation::admin_set_user_mfa_preference::AdminSetUserMfaPreferenceOutput)
    /// - On failure, responds with [`SdkError<AdminSetUserMFAPreferenceError>`](crate::operation::admin_set_user_mfa_preference::AdminSetUserMFAPreferenceError)
    pub fn admin_set_user_mfa_preference(&self) -> crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder {
        crate::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder::new(self.handle.clone())
    }
}