EmailMfaConfigType
Sets or shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.
Contents
- Message
-
The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. The message must contain the
{####}placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.Type: String
Length Constraints: Minimum length of 6. Maximum length of 20000.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*Required: No
- Subject
-
The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.
Type: String
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: