Skip to content

SmsMfaConfigType

Used by
Source code in docs_src/capo_cognito_identity_provider/types/sms_mfa_config_type.py 
12
13
14
15
16
17
18
19
20
class SmsMfaConfigType(TypedDict, closed=True):
    sms_authentication_message: NotRequired[
        "capo_cognito_identity_provider.types.sms_verification_message_type.SmsVerificationMessageType"
    ]
    """<p>The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the <code>{####}</code> placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.</p>"""
    sms_configuration: NotRequired[
        "capo_cognito_identity_provider.types.sms_configuration_type.SmsConfigurationType"
    ]
    """<p>User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p> <p>You can set <code>SmsConfiguration</code> in <code>CreateUserPool</code> and <code> UpdateUserPool</code>, or in <code>SetUserPoolMfaConfig</code>.</p>"""

sms_authentication_message instance-attribute 

sms_authentication_message: NotRequired[SmsVerificationMessageType]

The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.

sms_configuration instance-attribute 

sms_configuration: NotRequired[SmsConfigurationType]

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.