Skip to content
AWS for Query.Farm

aws.pinpoint.get_in_app_messages

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_in_app_messages
WHERE
"application_id" = 'VALUE'
AND "endpoint_id" = 'VALUE';

Description

Retrieves the in-app messages targeted for the provided endpoint ID.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

VARCHAR
endpoint_id Required Input Column

The unique identifier for the endpoint.

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_messages_response

Get in-app messages response object.

STRUCT(
    "in_app_message_campaigns" STRUCT(
        "campaign_id" VARCHAR,
        "daily_cap" BIGINT,
        "in_app_message" STRUCT(
            "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
                    )
                )
            )[],
            "custom_config" MAP(VARCHAR, VARCHAR),
            "layout" VARCHAR
        ),
        "priority" BIGINT,
        "schedule" STRUCT(
            "end_date" VARCHAR,
            "event_filter" STRUCT(
                "dimensions" STRUCT(
                    "attributes" MAP(VARCHAR, STRUCT(
                            "attribute_type" VARCHAR,
                            "values" VARCHAR[]
                        )),
                    "event_type" STRUCT(
                        "dimension_type" VARCHAR,
                        "values" VARCHAR[]
                    ),
                    "metrics" MAP(VARCHAR, STRUCT(
                            "comparison_operator" VARCHAR,
                            "value" DOUBLE
                        ))
                ),
                "filter_type" VARCHAR
            ),
            "quiet_time" STRUCT(
                "end" VARCHAR,
                "start" VARCHAR
            )
        ),
        "session_cap" BIGINT,
        "total_cap" BIGINT,
        "treatment_id" VARCHAR
    )[]
)
Show child fields
in_app_messages_response.in_app_message_campaigns[]
Show child fields
in_app_messages_response.in_app_message_campaigns[].campaign_id

Campaign id of the corresponding campaign.

in_app_messages_response.in_app_message_campaigns[].daily_cap

Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

in_app_messages_response.in_app_message_campaigns[].in_app_message

In-app message content with all fields required for rendering an in-app message.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[]
Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].background_color

The background color for the message.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].body_config

The configuration for the message body.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].body_config.alignment

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

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].body_config.body

Message Body.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].body_config.text_color

The text color.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].header_config

The configuration for the message header.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].header_config.alignment

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

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].header_config.header

Message Header.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].header_config.text_color

The text color.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].image_url

The image url for the background of message.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn

The first button inside the message.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.android

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.android.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.android.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.default_config

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.default_config.background_color

The background color of the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.default_config.border_radius

The border radius of the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.default_config.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.default_config.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.default_config.text

Button text.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.default_config.text_color

The text color of the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.ios

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.ios.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.ios.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.web

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.web.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].primary_btn.web.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn

The second button inside message.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.android

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.android.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.android.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.default_config

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.default_config.background_color

The background color of the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.default_config.border_radius

The border radius of the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.default_config.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.default_config.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.default_config.text

Button text.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.default_config.text_color

The text color of the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.ios

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.ios.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.ios.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.web

Default button content.

Show child fields
in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.web.button_action

Action triggered by the button.

in_app_messages_response.in_app_message_campaigns[].in_app_message.content[].secondary_btn.web.link

Button destination.

in_app_messages_response.in_app_message_campaigns[].in_app_message.custom_config

Custom config to be sent to SDK.

in_app_messages_response.in_app_message_campaigns[].in_app_message.layout

The layout of the message.

in_app_messages_response.in_app_message_campaigns[].priority

Priority of the in-app message.

in_app_messages_response.in_app_message_campaigns[].schedule

Schedule of the campaign.

Show child fields
in_app_messages_response.in_app_message_campaigns[].schedule.end_date

The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.

in_app_messages_response.in_app_message_campaigns[].schedule.event_filter

The event filter the SDK has to use to show the in-app message in the application.

Show child fields
in_app_messages_response.in_app_message_campaigns[].schedule.event_filter.dimensions

The dimension settings of the event filter for the campaign.

Show child fields
in_app_messages_response.in_app_message_campaigns[].schedule.event_filter.dimensions.attributes

One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

in_app_messages_response.in_app_message_campaigns[].schedule.event_filter.dimensions.event_type

The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

Show child fields
in_app_messages_response.in_app_message_campaigns[].schedule.event_filter.dimensions.event_type.dimension_type

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

in_app_messages_response.in_app_message_campaigns[].schedule.event_filter.dimensions.event_type.values[]
in_app_messages_response.in_app_message_campaigns[].schedule.event_filter.dimensions.metrics

One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

in_app_messages_response.in_app_message_campaigns[].schedule.event_filter.filter_type

The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

in_app_messages_response.in_app_message_campaigns[].schedule.quiet_time

Time during which the in-app message should not be shown to the user.

Show child fields
in_app_messages_response.in_app_message_campaigns[].schedule.quiet_time.end

The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

in_app_messages_response.in_app_message_campaigns[].schedule.quiet_time.start

The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

in_app_messages_response.in_app_message_campaigns[].session_cap

Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

in_app_messages_response.in_app_message_campaigns[].total_cap

Total cap which controls the number of times an in-app message can be shown to the endpoint.

in_app_messages_response.in_app_message_campaigns[].treatment_id

Treatment id of the campaign.