Skip to content

MessageTemplateType

Source code in docs_src/capo_cognito_identity_provider/types/message_template_type.py
class MessageTemplateType(TypedDict, closed=True):
    sms_message: NotRequired[
        "capo_cognito_identity_provider.types.sms_invite_message_type.SmsInviteMessageType"
    ]
    """<p>The message template for SMS messages.</p>"""
    email_message: NotRequired[
        "capo_cognito_identity_provider.types.email_invite_message_type.EmailInviteMessageType"
    ]
    """<p>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. </p>"""
    email_subject: NotRequired[
        "capo_cognito_identity_provider.types.email_verification_subject_type.EmailVerificationSubjectType"
    ]
    """<p>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. </p>"""

email_message instance-attribute

email_message: NotRequired[EmailInviteMessageType]

The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

email_subject instance-attribute

email_subject: NotRequired[EmailVerificationSubjectType]

The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

sms_message instance-attribute

sms_message: NotRequired[SmsInviteMessageType]

The message template for SMS messages.