Skip to content

MessageTemplateData

Source code in docs_src/capo_qconnect/types/message_template_data.py
class MessageTemplateData(TypedDict, closed=True):
    message_template_arn: "capo_qconnect.types.arn_with_qualifier.ArnWithQualifier"
    """<p>The Amazon Resource Name (ARN) of the message template.</p>"""
    message_template_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the message template.</p>"""
    knowledge_base_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the knowledge base.</p>"""
    knowledge_base_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the knowledge base.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the message template.</p>"""
    channel: NotRequired["capo_qconnect.types.channel.Channel"]
    """<p>The channel of the message template.</p>"""
    channel_subtype: "capo_qconnect.types.channel_subtype.ChannelSubtype"
    """<p>The channel subtype this message template applies to.</p>"""
    created_time: "datetime.datetime"
    """<p>The timestamp when the message template was created.</p>"""
    last_modified_time: "datetime.datetime"
    """<p>The timestamp when the message template data was last modified.</p>"""
    last_modified_by: "capo_qconnect.types.generic_arn.GenericArn"
    """<p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>"""
    content: NotRequired[
        "capo_qconnect.types.message_template_content_provider.MessageTemplateContentProvider"
    ]
    """<p>The content of the message template.</p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description of the message template.</p>"""
    language: NotRequired["capo_qconnect.types.language_code.LanguageCode"]
    """<p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>"""
    source_configuration_summary: NotRequired[
        "capo_qconnect.types.message_template_source_configuration_summary.MessageTemplateSourceConfigurationSummary"
    ]
    """<p>The source configuration summary of the message template.</p>"""
    grouping_configuration: NotRequired[
        "capo_qconnect.types.grouping_configuration.GroupingConfiguration"
    ]
    default_attributes: NotRequired[
        "capo_qconnect.types.message_template_attributes.MessageTemplateAttributes"
    ]
    """<p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>"""
    attribute_types: NotRequired[
        "capo_qconnect.types.message_template_attribute_type_list.MessageTemplateAttributeTypeList"
    ]
    """<p>The types of attributes that the message template contains.</p>"""
    message_template_content_sha256: "capo_qconnect.types.message_template_content_sha256.MessageTemplateContentSha256"
    """<p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

attribute_types instance-attribute

attribute_types: NotRequired[MessageTemplateAttributeTypeList]

The types of attributes that the message template contains.

channel instance-attribute

channel: NotRequired[Channel]

The channel of the message template.

channel_subtype instance-attribute

channel_subtype: ChannelSubtype

The channel subtype this message template applies to.

content instance-attribute

content: NotRequired[MessageTemplateContentProvider]

The content of the message template.

created_time instance-attribute

created_time: datetime

The timestamp when the message template was created.

default_attributes instance-attribute

default_attributes: NotRequired[MessageTemplateAttributes]

An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.

description instance-attribute

description: NotRequired[Description]

The description of the message template.

grouping_configuration instance-attribute

grouping_configuration: NotRequired[GroupingConfiguration]

knowledge_base_arn instance-attribute

knowledge_base_arn: Arn

The Amazon Resource Name (ARN) of the knowledge base.

knowledge_base_id instance-attribute

knowledge_base_id: Uuid

The identifier of the knowledge base.

language instance-attribute

language: NotRequired[LanguageCode]

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

last_modified_by instance-attribute

last_modified_by: GenericArn

The Amazon Resource Name (ARN) of the user who last updated the message template data.

last_modified_time instance-attribute

last_modified_time: datetime

The timestamp when the message template data was last modified.

message_template_arn instance-attribute

message_template_arn: ArnWithQualifier

The Amazon Resource Name (ARN) of the message template.

message_template_content_sha256 instance-attribute

message_template_content_sha256: MessageTemplateContentSha256

The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.

message_template_id instance-attribute

message_template_id: Uuid

The identifier of the message template.

name instance-attribute

name: Name

The name of the message template.

source_configuration_summary instance-attribute

source_configuration_summary: NotRequired[MessageTemplateSourceConfigurationSummary]

The source configuration summary of the message template.

tags instance-attribute

tags: NotRequired[Tags]

The tags used to organize, track, or control access for this resource.