Amazon Cognito · JSON Structure
User Pools Verification Message Template Type Structure
The template for verification messages.
Type: object
Properties: 6
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity
VerificationMessageTemplateType is a JSON Structure definition published by Amazon Cognito, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
SmsMessage
EmailMessage
EmailSubject
EmailMessageByLink
EmailSubjectByLink
DefaultEmailOption
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-verification-message-template-type-structure.json",
"name": "VerificationMessageTemplateType",
"description": "The template for verification messages.",
"type": "object",
"properties": {
"SmsMessage": {
"allOf": [
{
"$ref": "#/components/schemas/SmsVerificationMessageType"
},
{
"description": "The template for SMS messages that Amazon Cognito sends to your users."
}
]
},
"EmailMessage": {
"allOf": [
{
"$ref": "#/components/schemas/EmailVerificationMessageType"
},
{
"description": "The template for email messages that Amazon Cognito sends to your users. You can set an <code>EmailMessage</code> template only if the value of <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration."
}
]
},
"EmailSubject": {
"allOf": [
{
"$ref": "#/components/schemas/EmailVerificationSubjectType"
},
{
"description": "The subject line for the email message template. You can set an <code>EmailSubject</code> template only if the value of <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration."
}
]
},
"EmailMessageByLink": {
"allOf": [
{
"$ref": "#/components/schemas/EmailVerificationMessageByLinkType"
},
{
"description": "The email message template for sending a confirmation link to the user. You can set an <code>EmailMessageByLink</code> template only if the value of <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration."
}
]
},
"EmailSubjectByLink": {
"allOf": [
{
"$ref": "#/components/schemas/EmailVerificationSubjectByLinkType"
},
{
"description": "The subject line for the email message template for sending a confirmation link to the user. You can set an <code>EmailSubjectByLink</code> template only if the value of <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration."
}
]
},
"DefaultEmailOption": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultEmailOptionType"
},
{
"description": "The default email option."
}
]
}
}
}