SmsMfaConfigType
The configuration of multi-factor authentication (MFA) with SMS messages in a user pool.
This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.
Contents
- SmsAuthenticationMessage
-
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.Type: String
Length Constraints: Minimum length of 6. Maximum length of 140.
Pattern:
.*\{####\}.*Required: No
- SmsConfiguration
-
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account.
You can set
SmsConfigurationinCreateUserPoolandUpdateUserPool, or inSetUserPoolMfaConfig.Type: SmsConfigurationType object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
