message_template_versions

Creates, updates, deletes or gets a message_template_version resource or lists message_template_versions in a region

Overview

Name	message_template_versions
Type	Resource
Description	A version for the specified customer-managed message template within the specified knowledge base.
Id	awscc.wisdom.message_template_versions

Fields

get (all properties)

Name	Datatype	Description
message_template_arn	string	The unqualified Amazon Resource Name (ARN) of the message template.
message_template_version_arn	string	The unqualified Amazon Resource Name (ARN) of the message template version.
message_template_content_sha256	string	The content SHA256 of the message template.
message_template_version_number	number	Current version number of the message template.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
message_template_version_arn	string	The unqualified Amazon Resource Name (ARN) of the message template version.
region	string	AWS region.

For more information, see AWS::Wisdom::MessageTemplateVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	message_template_versions	INSERT	MessageTemplateArn, region
delete_resource	message_template_versions	DELETE	Identifier, region
update_resource	message_template_versions	UPDATE	Identifier, PatchDocument, region
list_resources	message_template_versions_list_only	SELECT	region
get_resource	message_template_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual message_template_version.

SELECT
  region,
  message_template_arn,
  message_template_version_arn,
  message_template_content_sha256,
  message_template_version_number
FROM awscc.wisdom.message_template_versions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ message_template_version_arn }}';

list (identifiers only)

Lists all message_template_versions in a region.

SELECT
  region,
  message_template_version_arn
FROM awscc.wisdom.message_template_versions_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new message_template_version resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.wisdom.message_template_versions (
  MessageTemplateArn,
  region
)
SELECT
  '{{ message_template_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.wisdom.message_template_versions (
  MessageTemplateArn,
  MessageTemplateContentSha256,
  region
)
SELECT
  '{{ message_template_arn }}',
  '{{ message_template_content_sha256 }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: message_template_version
    props:
      - name: message_template_arn
        value: '{{ message_template_arn }}'
      - name: message_template_content_sha256
        value: '{{ message_template_content_sha256 }}'

UPDATE example

Use the following StackQL query and manifest file to update a message_template_version resource, using stack-deploy.

/*+ update */
UPDATE awscc.wisdom.message_template_versions
SET PatchDocument = string('{{ {
    "MessageTemplateContentSha256": message_template_content_sha256
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ message_template_version_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.wisdom.message_template_versions
WHERE
  Identifier = '{{ message_template_version_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the message_template_versions resource, the following permissions are required:

Create

wisdom:CreateMessageTemplateVersion,
wisdom:ListMessageTemplateVersions

Delete

wisdom:DeleteMessageTemplate

Update

wisdom:CreateMessageTemplateVersion

List

wisdom:ListMessageTemplateVersions

Read

wisdom:GetMessageTemplate