VerificationMessageTemplateType
The template for verification messages.
Contents
- DefaultEmailOption
-
The default email option.
Type: String
Valid Values:
CONFIRM_WITH_LINK | CONFIRM_WITH_CODE
Required: No
- EmailMessage
-
The template for email messages that Amazon Cognito sends to your users. You can set an
EmailMessage
template only if the value of EmailSendingAccount isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.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
- EmailMessageByLink
-
The email message template for sending a confirmation link to the user. You can set an
EmailMessageByLink
template only if the value of EmailSendingAccount isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.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*]*##\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*
Required: No
- EmailSubject
-
The subject line for the email message template. You can set an
EmailSubject
template only if the value of EmailSendingAccount isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
Required: No
- EmailSubjectByLink
-
The subject line for the email message template for sending a confirmation link to the user. You can set an
EmailSubjectByLink
template only if the value of EmailSendingAccount isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
Required: No
- SmsMessage
-
The template for SMS messages that Amazon Cognito sends to your users.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 140.
Pattern:
.*\{####\}.*
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: