Skip to content

CreateMessageTemplateRequest

Source code in docs_src/capo_qconnect/types/create_message_template_request.py
class CreateMessageTemplateRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    name: NotRequired["capo_qconnect.types.name.Name"]
    """<p>The name of the message template.</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>"""
    channel_subtype: "capo_qconnect.types.channel_subtype.ChannelSubtype"
    """<p>The channel subtype this message template applies to.</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: NotRequired[
        "capo_qconnect.types.message_template_source_configuration.MessageTemplateSourceConfiguration"
    ]
    """<p>The source configuration of the message template. Only set this argument for WHATSAPP channel subtype.</p>"""
    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>"""
    grouping_configuration: NotRequired[
        "capo_qconnect.types.grouping_configuration.GroupingConfiguration"
    ]
    client_token: NotRequired["capo_qconnect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

channel_subtype instance-attribute

channel_subtype: ChannelSubtype

The channel subtype this message template applies to.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

content instance-attribute

content: NotRequired[MessageTemplateContentProvider]

The content of the message template.

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_id instance-attribute

knowledge_base_id: UuidOrArn

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

name instance-attribute

name: NotRequired[Name]

The name of the message template.

source_configuration instance-attribute

source_configuration: NotRequired[MessageTemplateSourceConfiguration]

The source configuration of the message template. Only set this argument for WHATSAPP channel subtype.

tags instance-attribute

tags: NotRequired[Tags]

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