message_templates

Creates, updates, deletes, gets or lists a message_templates resource.

Overview

Name	message_templates
Type	Resource
Id	aws.qconnect.message_templates

Fields

The following fields are returned by SELECT queries:

get_message_template

Name	Datatype	Description
name	string	The name of the message template. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
attachments	array	The message template attachments.
attribute_types	array	The types of attributes contain the message template.
channel	string	The channel of the message template.
channel_subtype	string	The channel subtype this message template applies to. (EMAIL, SMS, WHATSAPP, PUSH)
content	object	The container of message template content.
created_time	string (date-time)	The timestamp when the message template was created.
default_attributes	object	The attributes that are used with the message template.
description	string	The description of the message template. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
grouping_configuration	object	The configuration information of the grouping of Amazon Q in Connect users.
is_active	boolean	Whether the version of the message template is activated.
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (pattern: <code>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}</code>)
knowledge_base_id	string	The identifier of the knowledge base. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
language	string	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	string	The Amazon Resource Name (ARN) of the user who last updated the message template data. (pattern: <code>arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+</code>)
last_modified_time	string (date-time)	The timestamp when the message template data was last modified.
message_template_arn	string	The Amazon Resource Name (ARN) of the message template. (pattern: <code>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}</code>)
message_template_content_sha_256	string	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. (pattern: <code>[a-zA-Z0-9]+</code>)
message_template_id	string	The identifier of the message template. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
source_configuration_summary	object	The source configuration summary of the message template.
tags	object	The tags used to organize, track, or control access for this resource.
version_number	integer (int64)	The version number of the message template version.

search_message_templates

Name	Datatype	Description
name	string	The name of the message template. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
channel	string	The channel of the message template.
channel_subtype	string	The channel subtype this message template applies to. (EMAIL, SMS, WHATSAPP, PUSH)
created_time	string (date-time)	The timestamp when the message template was created.
description	string	The description of the message template. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
grouping_configuration	object	The configuration information of the grouping of Amazon Q in Connect users.
is_active	boolean	Whether the version of the message template is activated.
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (pattern: <code>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}</code>)
knowledge_base_id	string	The identifier of the knowledge base. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
language	string	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	string	The Amazon Resource Name (ARN) of the user who last updated the message template data. (pattern: <code>arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+</code>)
last_modified_time	string (date-time)	The timestamp when the message template data was last modified.
message_template_arn	string	The Amazon Resource Name (ARN) of the message template. (pattern: <code>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}</code>)
message_template_id	string	The identifier of the message template. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
source_configuration_summary	object	The source configuration summary of the message template.
tags	object	The tags used to organize, track, or control access for this resource.
version_number	integer (int64)	The version number of the message template version.

list_message_templates

Name	Datatype	Description
name	string	The name of the message template. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
active_version_number	integer (int64)	The version number of the message template version that is activated.
channel	string	The channel this message template applies to.
channel_subtype	string	The channel subtype this message template applies to. (EMAIL, SMS, WHATSAPP, PUSH)
created_time	string (date-time)	The timestamp when the message template was created.
description	string	The description of the message template. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (pattern: <code>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}</code>)
knowledge_base_id	string	The identifier of the knowledge base. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
last_modified_by	string	The Amazon Resource Name (ARN) of the user who last updated the message template data. (pattern: <code>arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+</code>)
last_modified_time	string (date-time)	The timestamp when the message template data was last modified.
message_template_arn	string	The Amazon Resource Name (ARN) of the message template. (pattern: <code>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}</code>)
message_template_id	string	The identifier of the message template. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
source_configuration	object	The container of message template source configuration.
tags	object	The tags used to organize, track, or control access for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_message_template	select	message_template_id, knowledge_base_id, region		Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.
search_message_templates	select	knowledge_base_id, region	nextToken, maxResults	Searches for Amazon Q in Connect message templates in the specified knowledge base.
list_message_templates	select	knowledge_base_id, region	nextToken, maxResults	Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
create_message_template_attachment	insert	knowledge_base_id, message_template_id, region, contentDisposition, name, body		Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
create_message_template	insert	knowledge_base_id, region, channelSubtype		Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.
update_message_template	update	knowledge_base_id, message_template_id, region		Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.
delete_message_template_attachment	delete	knowledge_base_id, message_template_id, attachment_id, region		Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.
delete_message_template	delete	knowledge_base_id, message_template_id, region		Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.
render_message_template	exec	knowledge_base_id, message_template_id, region, attributes		Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
update_message_template_metadata	exec	knowledge_base_id, message_template_id, region		Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
attachment_id	string	The identifier of the attachment file.
knowledge_base_id	string	The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
message_template_id	string	The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

get_message_template

Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.

SELECT
name,
attachments,
attribute_types,
channel,
channel_subtype,
content,
created_time,
default_attributes,
description,
grouping_configuration,
is_active,
knowledge_base_arn,
knowledge_base_id,
language,
last_modified_by,
last_modified_time,
message_template_arn,
message_template_content_sha_256,
message_template_id,
source_configuration_summary,
tags,
version_number
FROM aws.qconnect.message_templates
WHERE message_template_id = '{{ message_template_id }}' -- required
AND knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
;

search_message_templates

Searches for Amazon Q in Connect message templates in the specified knowledge base.

SELECT
name,
channel,
channel_subtype,
created_time,
description,
grouping_configuration,
is_active,
knowledge_base_arn,
knowledge_base_id,
language,
last_modified_by,
last_modified_time,
message_template_arn,
message_template_id,
source_configuration_summary,
tags,
version_number
FROM aws.qconnect.message_templates
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

list_message_templates

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

SELECT
name,
active_version_number,
channel,
channel_subtype,
created_time,
description,
knowledge_base_arn,
knowledge_base_id,
last_modified_by,
last_modified_time,
message_template_arn,
message_template_id,
source_configuration,
tags
FROM aws.qconnect.message_templates
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_message_template_attachment

Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

INSERT INTO aws.qconnect.message_templates (
contentDisposition,
name,
body,
clientToken,
knowledge_base_id,
message_template_id,
region
)
SELECT 
'{{ contentDisposition }}' /* required */,
'{{ name }}' /* required */,
'{{ body }}' /* required */,
'{{ clientToken }}',
'{{ knowledge_base_id }}',
'{{ message_template_id }}',
'{{ region }}'
RETURNING
attachment
;

create_message_template

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

INSERT INTO aws.qconnect.message_templates (
name,
content,
description,
channelSubtype,
language,
sourceConfiguration,
defaultAttributes,
groupingConfiguration,
clientToken,
tags,
knowledge_base_id,
region
)
SELECT 
'{{ name }}',
'{{ content }}',
'{{ description }}',
'{{ channelSubtype }}' /* required */,
'{{ language }}',
'{{ sourceConfiguration }}',
'{{ defaultAttributes }}',
'{{ groupingConfiguration }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ knowledge_base_id }}',
'{{ region }}'
RETURNING
message_template
;

Manifest

# Description fields are for documentation purposes
- name: message_templates
props:
  - name: knowledge_base_id
    value: "{{ knowledge_base_id }}"
    description: Required parameter for the message_templates resource.
  - name: message_template_id
    value: "{{ message_template_id }}"
    description: Required parameter for the message_templates resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the message_templates resource.
  - name: contentDisposition
    value: "{{ contentDisposition }}"
    valid_values: ['ATTACHMENT']
  - name: name
    value: "{{ name }}"
  - name: body
    value: "{{ body }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: content
    description: |
      The container of message template content.
    value:
      email:
        subject: "{{ subject }}"
        body:
          plainText:
            content: "{{ content }}"
          html:
            content: "{{ content }}"
        headers:
          - name: "{{ name }}"
            value: "{{ value }}"
      sms:
        body:
          plainText:
            content: "{{ content }}"
      whatsApp:
        data: "{{ data }}"
      push:
        adm:
          title_: "{{ title_ }}"
          body:
            content: "{{ content }}"
          action: "{{ action }}"
          sound: "{{ sound }}"
          url: "{{ url }}"
          imageUrl: "{{ imageUrl }}"
          imageIconUrl: "{{ imageIconUrl }}"
          smallImageIconUrl: "{{ smallImageIconUrl }}"
          rawContent:
            content: "{{ content }}"
        apns:
          title_: "{{ title_ }}"
          body:
            content: "{{ content }}"
          action: "{{ action }}"
          sound: "{{ sound }}"
          url: "{{ url }}"
          mediaUrl: "{{ mediaUrl }}"
          rawContent:
            content: "{{ content }}"
        fcm:
          title_: "{{ title_ }}"
          body:
            content: "{{ content }}"
          action: "{{ action }}"
          sound: "{{ sound }}"
          url: "{{ url }}"
          imageUrl: "{{ imageUrl }}"
          imageIconUrl: "{{ imageIconUrl }}"
          smallImageIconUrl: "{{ smallImageIconUrl }}"
          rawContent:
            content: "{{ content }}"
        baidu:
          title_: "{{ title_ }}"
          body:
            content: "{{ content }}"
          action: "{{ action }}"
          sound: "{{ sound }}"
          url: "{{ url }}"
          imageUrl: "{{ imageUrl }}"
          imageIconUrl: "{{ imageIconUrl }}"
          smallImageIconUrl: "{{ smallImageIconUrl }}"
          rawContent:
            content: "{{ content }}"
  - name: description
    value: "{{ description }}"
  - name: channelSubtype
    value: "{{ channelSubtype }}"
    valid_values: ['EMAIL', 'SMS', 'WHATSAPP', 'PUSH']
  - name: language
    value: "{{ language }}"
  - name: sourceConfiguration
    description: |
      The container of message template source configuration.
    value:
      whatsApp:
        businessAccountId: "{{ businessAccountId }}"
        templateId: "{{ templateId }}"
        components:
          - "{{ components }}"
  - name: defaultAttributes
    description: |
      The attributes that are used with the message template.
    value:
      systemAttributes:
        name: "{{ name }}"
        customerEndpoint:
          address: "{{ address }}"
        systemEndpoint:
          address: "{{ address }}"
      agentAttributes:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
      customerProfileAttributes:
        profileId: "{{ profileId }}"
        profileARN: "{{ profileARN }}"
        firstName: "{{ firstName }}"
        middleName: "{{ middleName }}"
        lastName: "{{ lastName }}"
        accountNumber: "{{ accountNumber }}"
        emailAddress: "{{ emailAddress }}"
        phoneNumber: "{{ phoneNumber }}"
        additionalInformation: "{{ additionalInformation }}"
        partyType: "{{ partyType }}"
        businessName: "{{ businessName }}"
        birthDate: "{{ birthDate }}"
        gender: "{{ gender }}"
        mobilePhoneNumber: "{{ mobilePhoneNumber }}"
        homePhoneNumber: "{{ homePhoneNumber }}"
        businessPhoneNumber: "{{ businessPhoneNumber }}"
        businessEmailAddress: "{{ businessEmailAddress }}"
        address1: "{{ address1 }}"
        address2: "{{ address2 }}"
        address3: "{{ address3 }}"
        address4: "{{ address4 }}"
        city: "{{ city }}"
        county: "{{ county }}"
        country: "{{ country }}"
        postalCode: "{{ postalCode }}"
        province: "{{ province }}"
        state: "{{ state }}"
        shippingAddress1: "{{ shippingAddress1 }}"
        shippingAddress2: "{{ shippingAddress2 }}"
        shippingAddress3: "{{ shippingAddress3 }}"
        shippingAddress4: "{{ shippingAddress4 }}"
        shippingCity: "{{ shippingCity }}"
        shippingCounty: "{{ shippingCounty }}"
        shippingCountry: "{{ shippingCountry }}"
        shippingPostalCode: "{{ shippingPostalCode }}"
        shippingProvince: "{{ shippingProvince }}"
        shippingState: "{{ shippingState }}"
        mailingAddress1: "{{ mailingAddress1 }}"
        mailingAddress2: "{{ mailingAddress2 }}"
        mailingAddress3: "{{ mailingAddress3 }}"
        mailingAddress4: "{{ mailingAddress4 }}"
        mailingCity: "{{ mailingCity }}"
        mailingCounty: "{{ mailingCounty }}"
        mailingCountry: "{{ mailingCountry }}"
        mailingPostalCode: "{{ mailingPostalCode }}"
        mailingProvince: "{{ mailingProvince }}"
        mailingState: "{{ mailingState }}"
        billingAddress1: "{{ billingAddress1 }}"
        billingAddress2: "{{ billingAddress2 }}"
        billingAddress3: "{{ billingAddress3 }}"
        billingAddress4: "{{ billingAddress4 }}"
        billingCity: "{{ billingCity }}"
        billingCounty: "{{ billingCounty }}"
        billingCountry: "{{ billingCountry }}"
        billingPostalCode: "{{ billingPostalCode }}"
        billingProvince: "{{ billingProvince }}"
        billingState: "{{ billingState }}"
        custom: "{{ custom }}"
      customAttributes: "{{ customAttributes }}"
  - name: groupingConfiguration
    description: |
      The configuration information of the grouping of Amazon Q in Connect users.
    value:
      criteria: "{{ criteria }}"
      values:
        - "{{ values }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_message_template

Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.

UPDATE aws.qconnect.message_templates
SET 
content = '{{ content }}',
language = '{{ language }}',
sourceConfiguration = '{{ sourceConfiguration }}',
defaultAttributes = '{{ defaultAttributes }}'
WHERE 
knowledge_base_id = '{{ knowledge_base_id }}' --required
AND message_template_id = '{{ message_template_id }}' --required
AND region = '{{ region }}' --required
RETURNING
message_template;

DELETE examples

delete_message_template_attachment

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.

DELETE FROM aws.qconnect.message_templates
WHERE knowledge_base_id = '{{ knowledge_base_id }}' --required
AND message_template_id = '{{ message_template_id }}' --required
AND attachment_id = '{{ attachment_id }}' --required
AND region = '{{ region }}' --required
;

delete_message_template

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

DELETE FROM aws.qconnect.message_templates
WHERE knowledge_base_id = '{{ knowledge_base_id }}' --required
AND message_template_id = '{{ message_template_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

render_message_template

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

EXEC aws.qconnect.message_templates.render_message_template 
@knowledge_base_id='{{ knowledge_base_id }}' --required, 
@message_template_id='{{ message_template_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"attributes": "{{ attributes }}"
}'
;

update_message_template_metadata

Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

EXEC aws.qconnect.message_templates.update_message_template_metadata 
@knowledge_base_id='{{ knowledge_base_id }}' --required, 
@message_template_id='{{ message_template_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"name": "{{ name }}", 
"description": "{{ description }}", 
"groupingConfiguration": "{{ groupingConfiguration }}"
}'
;