Skip to content
AWS for Query.Farm

aws.pinpoint.get_journey

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_journey
WHERE
"journey_id" = 'VALUE'
AND "application_id" = 'VALUE';

Description

Retrieves information about the status, configuration, and other settings for a journey.

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
journey_id Required Input Column

The unique identifier for the journey.

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
journey_response

Provides information about the status, configuration, and other settings for a journey.

STRUCT(
    "activities" MAP(VARCHAR, STRUCT(
            "custom" STRUCT(
                "delivery_uri" VARCHAR,
                "endpoint_types" VARCHAR[],
                "message_config" STRUCT(
                    "data" VARCHAR
                ),
                "next_activity" VARCHAR,
                "template_name" VARCHAR,
                "template_version" VARCHAR
            ),
            "conditional_split" STRUCT(
                "condition" STRUCT(
                    "conditions" STRUCT(
                        "event_condition" 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
                                    ))
                            ),
                            "message_activity" VARCHAR
                        ),
                        "segment_condition" STRUCT(
                            "segment_id" VARCHAR
                        ),
                        "segment_dimensions" STRUCT(
                            "attributes" MAP(VARCHAR, STRUCT(
                                    "attribute_type" VARCHAR,
                                    "values" VARCHAR[]
                                )),
                            "behavior" STRUCT(
                                "recency" STRUCT(
                                    "duration" VARCHAR,
                                    "recency_type" VARCHAR
                                )
                            ),
                            "demographic" STRUCT(
                                "app_version" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "channel" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "device_type" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "make" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "model" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "platform" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                )
                            ),
                            "location" STRUCT(
                                "country" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "gps_point" STRUCT(
                                    "coordinates" STRUCT(
                                        "latitude" DOUBLE,
                                        "longitude" DOUBLE
                                    ),
                                    "range_in_kilometers" DOUBLE
                                )
                            ),
                            "metrics" MAP(VARCHAR, STRUCT(
                                    "comparison_operator" VARCHAR,
                                    "value" DOUBLE
                                )),
                            "user_attributes" MAP(VARCHAR, STRUCT(
                                    "attribute_type" VARCHAR,
                                    "values" VARCHAR[]
                                ))
                        )
                    )[],
                    "operator" VARCHAR
                ),
                "evaluation_wait_time" STRUCT(
                    "wait_for" VARCHAR,
                    "wait_until" VARCHAR
                ),
                "false_activity" VARCHAR,
                "true_activity" VARCHAR
            ),
            "description" VARCHAR,
            "email" STRUCT(
                "message_config" STRUCT(
                    "from_address" VARCHAR
                ),
                "next_activity" VARCHAR,
                "template_name" VARCHAR,
                "template_version" VARCHAR
            ),
            "holdout" STRUCT(
                "next_activity" VARCHAR,
                "percentage" BIGINT
            ),
            "multi_condition" STRUCT(
                "branches" STRUCT(
                    "condition" STRUCT(
                        "event_condition" 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
                                    ))
                            ),
                            "message_activity" VARCHAR
                        ),
                        "segment_condition" STRUCT(
                            "segment_id" VARCHAR
                        ),
                        "segment_dimensions" STRUCT(
                            "attributes" MAP(VARCHAR, STRUCT(
                                    "attribute_type" VARCHAR,
                                    "values" VARCHAR[]
                                )),
                            "behavior" STRUCT(
                                "recency" STRUCT(
                                    "duration" VARCHAR,
                                    "recency_type" VARCHAR
                                )
                            ),
                            "demographic" STRUCT(
                                "app_version" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "channel" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "device_type" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "make" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "model" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "platform" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                )
                            ),
                            "location" STRUCT(
                                "country" STRUCT(
                                    "dimension_type" VARCHAR,
                                    "values" VARCHAR[]
                                ),
                                "gps_point" STRUCT(
                                    "coordinates" STRUCT(
                                        "latitude" DOUBLE,
                                        "longitude" DOUBLE
                                    ),
                                    "range_in_kilometers" DOUBLE
                                )
                            ),
                            "metrics" MAP(VARCHAR, STRUCT(
                                    "comparison_operator" VARCHAR,
                                    "value" DOUBLE
                                )),
                            "user_attributes" MAP(VARCHAR, STRUCT(
                                    "attribute_type" VARCHAR,
                                    "values" VARCHAR[]
                                ))
                        )
                    ),
                    "next_activity" VARCHAR
                )[],
                "default_activity" VARCHAR,
                "evaluation_wait_time" STRUCT(
                    "wait_for" VARCHAR,
                    "wait_until" VARCHAR
                )
            ),
            "push" STRUCT(
                "message_config" STRUCT(
                    "time_to_live" VARCHAR
                ),
                "next_activity" VARCHAR,
                "template_name" VARCHAR,
                "template_version" VARCHAR
            ),
            "random_split" STRUCT(
                "branches" STRUCT(
                    "next_activity" VARCHAR,
                    "percentage" BIGINT
                )[]
            ),
            "sms" STRUCT(
                "message_config" STRUCT(
                    "message_type" VARCHAR,
                    "origination_number" VARCHAR,
                    "sender_id" VARCHAR,
                    "entity_id" VARCHAR,
                    "template_id" VARCHAR
                ),
                "next_activity" VARCHAR,
                "template_name" VARCHAR,
                "template_version" VARCHAR
            ),
            "wait" STRUCT(
                "next_activity" VARCHAR,
                "wait_time" STRUCT(
                    "wait_for" VARCHAR,
                    "wait_until" VARCHAR
                )
            ),
            "contact_center" STRUCT(
                "next_activity" VARCHAR
            )
        )),
    "application_id" VARCHAR,
    "creation_date" VARCHAR,
    "id" VARCHAR,
    "last_modified_date" VARCHAR,
    "limits" STRUCT(
        "daily_cap" BIGINT,
        "endpoint_reentry_cap" BIGINT,
        "messages_per_second" BIGINT,
        "endpoint_reentry_interval" VARCHAR,
        "timeframe_cap" STRUCT(
            "cap" BIGINT,
            "days" BIGINT
        ),
        "total_cap" BIGINT
    ),
    "local_time" BOOLEAN,
    "name" VARCHAR,
    "quiet_time" STRUCT(
        "end" VARCHAR,
        "start" VARCHAR
    ),
    "refresh_frequency" VARCHAR,
    "schedule" STRUCT(
        "end_time" TIMESTAMP_S,
        "start_time" TIMESTAMP_S,
        "timezone" VARCHAR
    ),
    "start_activity" VARCHAR,
    "start_condition" STRUCT(
        "description" VARCHAR,
        "event_start_condition" STRUCT(
            "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
            ),
            "segment_id" VARCHAR
        ),
        "segment_start_condition" STRUCT(
            "segment_id" VARCHAR
        )
    ),
    "state" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "wait_for_quiet_time" BOOLEAN,
    "refresh_on_segment_update" BOOLEAN,
    "journey_channel_settings" STRUCT(
        "connect_campaign_arn" VARCHAR,
        "connect_campaign_execution_role_arn" VARCHAR
    ),
    "sending_schedule" BOOLEAN,
    "open_hours" STRUCT(
        "email" MAP(VARCHAR, STRUCT(
                "start_time" VARCHAR,
                "end_time" VARCHAR
            )[]),
        "sms" MAP(VARCHAR, STRUCT(
                "start_time" VARCHAR,
                "end_time" VARCHAR
            )[]),
        "push" MAP(VARCHAR, STRUCT(
                "start_time" VARCHAR,
                "end_time" VARCHAR
            )[]),
        "voice" MAP(VARCHAR, STRUCT(
                "start_time" VARCHAR,
                "end_time" VARCHAR
            )[]),
        "custom" MAP(VARCHAR, STRUCT(
                "start_time" VARCHAR,
                "end_time" VARCHAR
            )[])
    ),
    "closed_days" STRUCT(
        "email" STRUCT(
            "name" VARCHAR,
            "start_date_time" VARCHAR,
            "end_date_time" VARCHAR
        )[],
        "sms" STRUCT(
            "name" VARCHAR,
            "start_date_time" VARCHAR,
            "end_date_time" VARCHAR
        )[],
        "push" STRUCT(
            "name" VARCHAR,
            "start_date_time" VARCHAR,
            "end_date_time" VARCHAR
        )[],
        "voice" STRUCT(
            "name" VARCHAR,
            "start_date_time" VARCHAR,
            "end_date_time" VARCHAR
        )[],
        "custom" STRUCT(
            "name" VARCHAR,
            "start_date_time" VARCHAR,
            "end_date_time" VARCHAR
        )[]
    ),
    "timezone_estimation_methods" VARCHAR[]
)
Show child fields
journey_response.activities

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

journey_response.application_id

The unique identifier for the application that the journey applies to.

journey_response.closed_days

The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

Show child fields
journey_response.closed_days.custom[]
Show child fields
journey_response.closed_days.custom[].end_date_time

End DateTime ISO 8601 format

journey_response.closed_days.custom[].name

The name of the closed day rule.

journey_response.closed_days.custom[].start_date_time

Start DateTime ISO 8601 format

journey_response.closed_days.email[]
Show child fields
journey_response.closed_days.email[].end_date_time

End DateTime ISO 8601 format

journey_response.closed_days.email[].name

The name of the closed day rule.

journey_response.closed_days.email[].start_date_time

Start DateTime ISO 8601 format

journey_response.closed_days.push[]
Show child fields
journey_response.closed_days.push[].end_date_time

End DateTime ISO 8601 format

journey_response.closed_days.push[].name

The name of the closed day rule.

journey_response.closed_days.push[].start_date_time

Start DateTime ISO 8601 format

journey_response.closed_days.sms[]
Show child fields
journey_response.closed_days.sms[].end_date_time

End DateTime ISO 8601 format

journey_response.closed_days.sms[].name

The name of the closed day rule.

journey_response.closed_days.sms[].start_date_time

Start DateTime ISO 8601 format

journey_response.closed_days.voice[]
Show child fields
journey_response.closed_days.voice[].end_date_time

End DateTime ISO 8601 format

journey_response.closed_days.voice[].name

The name of the closed day rule.

journey_response.closed_days.voice[].start_date_time

Start DateTime ISO 8601 format

journey_response.creation_date

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

journey_response.id

The unique identifier for the journey.

journey_response.journey_channel_settings

The channel-specific configurations for the journey.

Show child fields
journey_response.journey_channel_settings.connect_campaign_arn

Amazon Resource Name (ARN) of the Connect Campaign.

journey_response.journey_channel_settings.connect_campaign_execution_role_arn

IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.

journey_response.last_modified_date

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

journey_response.limits

The messaging and entry limits for the journey.

Show child fields
journey_response.limits.daily_cap

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

journey_response.limits.endpoint_reentry_cap

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

journey_response.limits.endpoint_reentry_interval

Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

journey_response.limits.messages_per_second

The maximum number of messages that the journey can send each second.

journey_response.limits.timeframe_cap

The number of messages that an endpoint can receive during the specified timeframe.

Show child fields
journey_response.limits.timeframe_cap.cap

The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.

journey_response.limits.timeframe_cap.days

The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.

journey_response.limits.total_cap

The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

journey_response.local_time

Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

journey_response.name

The name of the journey.

journey_response.open_hours

The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.

Show child fields
journey_response.open_hours.custom

Specifies the schedule settings for the custom channel.

journey_response.open_hours.email

Specifies the schedule settings for the email channel.

journey_response.open_hours.push

Specifies the schedule settings for the push channel.

journey_response.open_hours.sms

Specifies the schedule settings for the SMS channel.

journey_response.open_hours.voice

Specifies the schedule settings for the voice channel.

journey_response.quiet_time

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

  • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

  • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

Show child fields
journey_response.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.

journey_response.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.

journey_response.refresh_frequency

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

journey_response.refresh_on_segment_update

Indicates whether the journey participants should be refreshed when a segment is updated.

journey_response.schedule

The schedule settings for the journey.

Show child fields
journey_response.schedule.end_time

The scheduled time, in ISO 8601 format, when the journey ended or will end.

journey_response.schedule.start_time

The scheduled time, in ISO 8601 format, when the journey began or will begin.

journey_response.schedule.timezone

The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

journey_response.sending_schedule

Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

journey_response.start_activity

The unique identifier for the first activity in the journey.

journey_response.start_condition

The segment that defines which users are participants in the journey.

Show child fields
journey_response.start_condition.description

The custom description of the condition.

journey_response.start_condition.event_start_condition

Specifies the settings for an event that causes a journey activity to start.

Show child fields
journey_response.start_condition.event_start_condition.event_filter

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

Show child fields
journey_response.start_condition.event_start_condition.event_filter.dimensions

The dimensions for the event filter to use for the campaign or the journey activity.

Show child fields
journey_response.start_condition.event_start_condition.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.

journey_response.start_condition.event_start_condition.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
journey_response.start_condition.event_start_condition.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.

journey_response.start_condition.event_start_condition.event_filter.dimensions.event_type.values[]
journey_response.start_condition.event_start_condition.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.

journey_response.start_condition.event_start_condition.event_filter.filter_type

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

journey_response.start_condition.event_start_condition.segment_id
journey_response.start_condition.segment_start_condition

The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

Show child fields
journey_response.start_condition.segment_start_condition.segment_id

The unique identifier for the segment to associate with the activity.

journey_response.state

The current status of the journey. Possible values are:

  • DRAFT - The journey is being developed and hasn't been published yet.

  • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

  • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.

  • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.

  • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.

journey_response.tags

This object is not used or supported.

journey_response.timezone_estimation_methods[]
journey_response.wait_for_quiet_time

Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.