Skip to content

aws.pinpoint.list_templates

Example SQL Queries

SELECT * FROM
aws.pinpoint.list_templates;

Description

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

Table Definition

Column NameColumn Data Type
next_token Input Column

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

VARCHAR
page_size Input Column

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

VARCHAR
prefix Input Column

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

VARCHAR
template_type Input Column

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
templates_response

Provides information about all the message templates that are associated with your Amazon Pinpoint account.

STRUCT(
"item" STRUCT(
"arn" VARCHAR,
"creation_date" VARCHAR,
"default_substitutions" VARCHAR,
"last_modified_date" VARCHAR,
"tags" MAP(VARCHAR, VARCHAR),
"template_description" VARCHAR,
"template_name" VARCHAR,
"template_type" VARCHAR,
"version" VARCHAR
)[],
"next_token" VARCHAR
)
Show child fields
templates_response.item[]
Show child fields
templates_response.item[].arn

The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

templates_response.item[].creation_date

The date, in ISO 8601 format, when the message template was created.

templates_response.item[].default_substitutions

The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templates_response.item[].last_modified_date

The date, in ISO 8601 format, when the message template was last modified.

templates_response.item[].tags

A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templates_response.item[].template_description

The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

templates_response.item[].template_name

The name of the message template.

templates_response.item[].template_type

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

templates_response.item[].version

The unique identifier, as an integer, for the active version of the message template.

templates_response.next_token

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.