MessageTemplateData
The data of a message template.
Contents
- channelSubtype
-
The channel subtype this message template applies to.
Type: String
Valid Values:
EMAIL | SMSRequired: Yes
- content
-
The content of the message template.
Type: MessageTemplateContentProvider object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- createdTime
-
The timestamp when the message template was created.
Type: Timestamp
Required: Yes
- knowledgeBaseArn
-
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern:
^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
- knowledgeBaseId
-
The identifier of the knowledge base.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- lastModifiedBy
-
The Amazon Resource Name (ARN) of the user who last updated the message template data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$Required: Yes
- lastModifiedTime
-
The timestamp when the message template data was last modified.
Type: Timestamp
Required: Yes
- messageTemplateArn
-
The Amazon Resource Name (ARN) of the message template.
Type: String
Pattern:
^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$Required: Yes
- messageTemplateContentSha256
-
The checksum value of the message template content that is referenced by the
$LATESTqualifier. It can be returned inMessageTemplateDataorExtendedMessageTemplateData. It’s calculated by content, language,defaultAttributesandAttachmentsof the message template.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]+$Required: Yes
- messageTemplateId
-
The identifier of the message template.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- name
-
The name of the message template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: Yes
- attributeTypes
-
The types of attributes that the message template contains.
Type: Array of strings
Valid Values:
SYSTEM | AGENT | CUSTOMER_PROFILE | CUSTOMRequired: No
- defaultAttributes
-
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.
Type: MessageTemplateAttributes object
Required: No
- description
-
The description of the message template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: No
- groupingConfiguration
-
The configuration information of the grouping of Amazon Q in Connect users.
Type: GroupingConfiguration object
Required: No
- language
-
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_TWType: String
Length Constraints: Minimum length of 2. Maximum length of 5.
Required: No
-
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
