Skip to content

SMSMfaSettingsType

Used by
Source code in docs_src/capo_cognito_identity_provider/types/sms_mfa_settings_type.py 
11
12
13
14
15
class SMSMfaSettingsType(TypedDict, closed=True):
    enabled: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>Specifies whether SMS message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.</p>"""
    preferred_mfa: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds. </p>"""

enabled instance-attribute 

enabled: BooleanType

Specifies whether SMS message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

preferred_mfa instance-attribute 

preferred_mfa: BooleanType

Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.