Struct SetUserMfaPreferenceInput 

#[non_exhaustive]
pub struct SetUserMfaPreferenceInput {
    pub sms_mfa_settings: Option<SmsMfaSettingsType>,
    pub software_token_mfa_settings: Option<SoftwareTokenMfaSettingsType>,
    pub email_mfa_settings: Option<EmailMfaSettingsType>,
    pub access_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sms_mfa_settings: Option<SmsMfaSettingsType>

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

software_token_mfa_settings: Option<SoftwareTokenMfaSettingsType>

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.

email_mfa_settings: Option<EmailMfaSettingsType>

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 Essentials tier or higher.

access_token: Option<String>

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Implementations

impl SetUserMfaPreferenceInput

pub fn sms_mfa_settings(&self) -> Option<&SmsMfaSettingsType>

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

pub fn software_token_mfa_settings( &self, ) -> Option<&SoftwareTokenMfaSettingsType>

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.

pub fn email_mfa_settings(&self) -> Option<&EmailMfaSettingsType>

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 Essentials tier or higher.

pub fn access_token(&self) -> Option<&str>

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

impl SetUserMfaPreferenceInput

pub fn builder() -> SetUserMfaPreferenceInputBuilder

Creates a new builder-style object to manufacture SetUserMfaPreferenceInput.

Trait Implementations

impl Clone for SetUserMfaPreferenceInput

fn clone(&self) -> SetUserMfaPreferenceInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SetUserMfaPreferenceInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SetUserMfaPreferenceInput

fn eq(&self, other: &SetUserMfaPreferenceInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SetUserMfaPreferenceInput