Amazon Cognito · Schema
MessageTemplateType
The message template structure.
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity
Properties
| Name | Type | Description |
|---|---|---|
| SMSMessage | object | |
| EmailMessage | object | |
| EmailSubject | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-message-template-type-schema.json",
"title": "MessageTemplateType",
"description": "The message template structure.",
"type": "object",
"properties": {
"SMSMessage": {
"allOf": [
{
"$ref": "#/components/schemas/SmsVerificationMessageType"
},
{
"description": "The message template for SMS messages."
}
]
},
"EmailMessage": {
"allOf": [
{
"$ref": "#/components/schemas/EmailVerificationMessageType"
},
{
"description": "The message template for email messages. EmailMessage is allowed only if <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is DEVELOPER. "
}
]
},
"EmailSubject": {
"allOf": [
{
"$ref": "#/components/schemas/EmailVerificationSubjectType"
},
{
"description": "The subject line for email messages. EmailSubject is allowed only if <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is DEVELOPER. "
}
]
}
}
}