Skip to content
AWS for Query.Farm

aws.pinpoint.get_in_app_template

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_in_app_template
WHERE
"template_name" = 'VALUE';

Description

Retrieves the content and settings of a message template for messages sent through the in-app channel.

Table Definition

Column NameColumn Data Type
template_name Required Input Column

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

VARCHAR
version Input Column

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

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
in_app_template_response

In-App Template Response.

STRUCT(
    "arn" VARCHAR,
    "content" STRUCT(
        "background_color" VARCHAR,
        "body_config" STRUCT(
            "alignment" VARCHAR,
            "body" VARCHAR,
            "text_color" VARCHAR
        ),
        "header_config" STRUCT(
            "alignment" VARCHAR,
            "header" VARCHAR,
            "text_color" VARCHAR
        ),
        "image_url" VARCHAR,
        "primary_btn" STRUCT(
            "android" STRUCT(
                "button_action" VARCHAR,
                "link" VARCHAR
            ),
            "default_config" STRUCT(
                "background_color" VARCHAR,
                "border_radius" BIGINT,
                "button_action" VARCHAR,
                "link" VARCHAR,
                "text" VARCHAR,
                "text_color" VARCHAR
            ),
            "ios" STRUCT(
                "button_action" VARCHAR,
                "link" VARCHAR
            ),
            "web" STRUCT(
                "button_action" VARCHAR,
                "link" VARCHAR
            )
        ),
        "secondary_btn" STRUCT(
            "android" STRUCT(
                "button_action" VARCHAR,
                "link" VARCHAR
            ),
            "default_config" STRUCT(
                "background_color" VARCHAR,
                "border_radius" BIGINT,
                "button_action" VARCHAR,
                "link" VARCHAR,
                "text" VARCHAR,
                "text_color" VARCHAR
            ),
            "ios" STRUCT(
                "button_action" VARCHAR,
                "link" VARCHAR
            ),
            "web" STRUCT(
                "button_action" VARCHAR,
                "link" VARCHAR
            )
        )
    )[],
    "creation_date" VARCHAR,
    "custom_config" MAP(VARCHAR, VARCHAR),
    "last_modified_date" VARCHAR,
    "layout" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "template_description" VARCHAR,
    "template_name" VARCHAR,
    "template_type" VARCHAR,
    "version" VARCHAR
)
Show child fields
in_app_template_response.arn

The resource arn of the template.

in_app_template_response.content[]
Show child fields
in_app_template_response.content[].background_color

The background color for the message.

in_app_template_response.content[].body_config

The configuration for the message body.

Show child fields
in_app_template_response.content[].body_config.alignment

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

in_app_template_response.content[].body_config.body

Message Body.

in_app_template_response.content[].body_config.text_color

The text color.

in_app_template_response.content[].header_config

The configuration for the message header.

Show child fields
in_app_template_response.content[].header_config.alignment

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

in_app_template_response.content[].header_config.header

Message Header.

in_app_template_response.content[].header_config.text_color

The text color.

in_app_template_response.content[].image_url

The image url for the background of message.

in_app_template_response.content[].primary_btn

The first button inside the message.

Show child fields
in_app_template_response.content[].primary_btn.android

Default button content.

Show child fields
in_app_template_response.content[].primary_btn.android.button_action

Action triggered by the button.

in_app_template_response.content[].primary_btn.android.link

Button destination.

in_app_template_response.content[].primary_btn.default_config

Default button content.

Show child fields
in_app_template_response.content[].primary_btn.default_config.background_color

The background color of the button.

in_app_template_response.content[].primary_btn.default_config.border_radius

The border radius of the button.

in_app_template_response.content[].primary_btn.default_config.button_action

Action triggered by the button.

in_app_template_response.content[].primary_btn.default_config.link

Button destination.

in_app_template_response.content[].primary_btn.default_config.text

Button text.

in_app_template_response.content[].primary_btn.default_config.text_color

The text color of the button.

in_app_template_response.content[].primary_btn.ios

Default button content.

Show child fields
in_app_template_response.content[].primary_btn.ios.button_action

Action triggered by the button.

in_app_template_response.content[].primary_btn.ios.link

Button destination.

in_app_template_response.content[].primary_btn.web

Default button content.

Show child fields
in_app_template_response.content[].primary_btn.web.button_action

Action triggered by the button.

in_app_template_response.content[].primary_btn.web.link

Button destination.

in_app_template_response.content[].secondary_btn

The second button inside message.

Show child fields
in_app_template_response.content[].secondary_btn.android

Default button content.

Show child fields
in_app_template_response.content[].secondary_btn.android.button_action

Action triggered by the button.

in_app_template_response.content[].secondary_btn.android.link

Button destination.

in_app_template_response.content[].secondary_btn.default_config

Default button content.

Show child fields
in_app_template_response.content[].secondary_btn.default_config.background_color

The background color of the button.

in_app_template_response.content[].secondary_btn.default_config.border_radius

The border radius of the button.

in_app_template_response.content[].secondary_btn.default_config.button_action

Action triggered by the button.

in_app_template_response.content[].secondary_btn.default_config.link

Button destination.

in_app_template_response.content[].secondary_btn.default_config.text

Button text.

in_app_template_response.content[].secondary_btn.default_config.text_color

The text color of the button.

in_app_template_response.content[].secondary_btn.ios

Default button content.

Show child fields
in_app_template_response.content[].secondary_btn.ios.button_action

Action triggered by the button.

in_app_template_response.content[].secondary_btn.ios.link

Button destination.

in_app_template_response.content[].secondary_btn.web

Default button content.

Show child fields
in_app_template_response.content[].secondary_btn.web.button_action

Action triggered by the button.

in_app_template_response.content[].secondary_btn.web.link

Button destination.

in_app_template_response.creation_date

The creation date of the template.

in_app_template_response.custom_config

Custom config to be sent to client.

in_app_template_response.last_modified_date

The last modified date of the template.

in_app_template_response.layout

The layout of the message.

in_app_template_response.tags

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

in_app_template_response.template_description

The description of the template.

in_app_template_response.template_name

The name of the template.

in_app_template_response.template_type

The type of the template.

in_app_template_response.version

The version id of the template.