pinpoint journey quiet time

Integrating APNSChannel with Journeys for targeted campaigns

To integrate APNSChannel with AWS Pinpoint Journeys for targeted campaigns, you can use Pulumi with the AWS provider to define the necessary resources programmatically. AWS Pinpoint Journeys is a feature that allows you to create a series of messaging steps that are sent automatically to your audience segments. APNSChannel is the Apple Push Notification Service channel used to send push notifications to iOS devices.

In this Pulumi program, we will set up an APNSChannel and integrate it with AWS Pinpoint Journeys. Here's a step-by-step guide to what the program will do:

• We will start by creating a new project using AWS Pinpoint.
• Then, we will configure the APNSChannel with the necessary credentials, which you will need to obtain from the Apple Developer portal.
• We will create a segment to define the targeted audience for the campaign.
• Lastly, we will set up a Journey with a messaging step that targets the audience segment and utilizes the established APNSChannel for delivery.

Below is a TypeScript program that illustrates these steps:

Let's break down key parts of the program:

apnsChannelArgs : Here, you specify the APNS credentials required to establish the APNSChannel with AWS Pinpoint. You should replace the placeholder values with your actual APNS details from your Apple Developer account. It's recommended to use Pulumi's secrets management for sensitive credentials to ensure they are encrypted and managed securely.

segment : This part of the program defines the particular segment of users that you wish to target with your campaign. The criteria for the segment may include demographics, user attributes, or behaviors.

journey : This defines the journey the targeted segment of your audience will go through. A journey includes messaging steps with specific actions and schedules.

export : After creating these resources, we can export their identifiers if we want to reference them outside of Pulumi, such as in other systems or for validation purposes.

To run the above program, you'll need to install Pulumi CLI, configure AWS access on your machine, and then run pulumi up . The Pulumi CLI will handle the provisioning of the defined resources in AWS according to the configuration defined in your code.

Remember, before using real credentials or pushing the code to a repository, be sure to replace any sensitive information with placeholders or use environment variables and Pulumi's secrets management to keep your credentials secure.

• TS TypeScript
• JS JavaScript
• TF Terraform

AWS::Pinpoint::ApplicationSettings QuietTime

Specifies the start and end times that define a time range when messages aren't sent to endpoints.

To declare this entity in your Amazon CloudFormation template, use the following syntax:

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.

Required : Yes

Type : String

Update requires : No interruption

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.

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Pinpoint / Client / create_journey

create_journey #

Creates a journey for an application.

See also: AWS API Documentation

Request Syntax

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

Specifies the configuration and other settings for a journey.

Activities (dict) –

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. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

Specifies the configuration and other settings for an activity in a journey.

CUSTOM (dict) –

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

DeliveryUri (string) –

The destination to send the campaign or treatment to. This value can be one of the following:

The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

EndpointTypes (list) –

The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

MessageConfig (dict) –

Specifies the message data included in a custom channel message that’s sent to participants in a journey.

Data (string) –

The message content that’s passed to an AWS Lambda function or to a web hook.

NextActivity (string) –

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

TemplateName (string) –

The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

TemplateVersion (string) –

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.

ConditionalSplit (dict) –

The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

Condition (dict) –

The conditions that define the paths for the activity, and the relationship between the conditions.

Conditions (list) –

The conditions to evaluate for the activity.

Specifies a condition to evaluate for an activity in a journey.

EventCondition (dict) –

The dimension settings for the event that’s associated with the activity.

Dimensions (dict) –

The dimensions for the event filter to use for the activity.

Attributes (dict) –

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.

Specifies attribute-based criteria for including or excluding endpoints from a segment.

AttributeType (string) –

The type of segment dimension to use. Valid values are:

INCLUSIVE - endpoints that have attributes matching the values are included in the segment.

EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.

CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment.

BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.

AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.

ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.

BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Values (list) – [REQUIRED]

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

EventType (dict) –

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 .

DimensionType (string) –

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.

The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

Metrics (dict) –

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.

Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

ComparisonOperator (string) – [REQUIRED]

The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

Value (float) – [REQUIRED]

The value to compare.

MessageActivity (string) –

The message identifier (message_id) for the message to use when determining whether message events meet the condition.

SegmentCondition (dict) –

The segment that’s associated with the activity.

SegmentId (string) – [REQUIRED]

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

SegmentDimensions (dict) –

The dimension settings for the segment that’s associated with the activity.

One or more custom attributes to use as criteria for the segment.

Behavior (dict) –

The behavior-based criteria, such as how recently users have used your app, for the segment.

Recency (dict) –

The dimension settings that are based on how recently an endpoint was active.

Duration (string) – [REQUIRED]

The duration to use when determining whether an endpoint is active or inactive.

RecencyType (string) – [REQUIRED]

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren’t active within the specified duration are included in the segment.

Demographic (dict) –

The demographic-based criteria, such as device platform, for the segment.

AppVersion (dict) –

The app version criteria for the segment.

Channel (dict) –

The channel criteria for the segment.

DeviceType (dict) –

The device type criteria for the segment.

Make (dict) –

The device make criteria for the segment.

Model (dict) –

The device model criteria for the segment.

Platform (dict) –

The device platform criteria for the segment.

Location (dict) –

The location-based criteria, such as region or GPS coordinates, for the segment.

Country (dict) –

The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

GPSPoint (dict) –

The GPS location and range for the segment.

Coordinates (dict) – [REQUIRED]

The GPS coordinates to measure distance from.

Latitude (float) – [REQUIRED]

The latitude coordinate of the location.

Longitude (float) – [REQUIRED]

The longitude coordinate of the location.

RangeInKilometers (float) –

The range, in kilometers, from the GPS coordinates.

One or more custom metrics to use as criteria for the segment.

UserAttributes (dict) –

One or more custom user attributes to use as criteria for the segment.

Operator (string) –

Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

EvaluationWaitTime (dict) –

The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

WaitFor (string) –

The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity’s conditions have been met or moving participants to the next activity in the journey.

WaitUntil (string) –

The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity’s conditions have been met or the activity moves participants to the next activity in the journey.

FalseActivity (string) –

The unique identifier for the activity to perform if the conditions aren’t met.

TrueActivity (string) –

The unique identifier for the activity to perform if the conditions are met.

Description (string) –

The custom description of the activity.

EMAIL (dict) –

The settings for an email activity. This type of activity sends an email message to participants.

Specifies the sender address for an email message that’s sent to participants in the journey.

FromAddress (string) –

The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

The unique identifier for the next activity to perform, after the message is sent.

The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

Holdout (dict) –

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

The unique identifier for the next activity to perform, after performing the holdout activity.

Percentage (integer) – [REQUIRED]

The percentage of participants who shouldn’t continue the journey.

To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

MultiCondition (dict) –

The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

Branches (list) –

The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

Specifies a condition to evaluate for an activity path in a journey.

The condition to evaluate for the activity path.

The unique identifier for the next activity to perform, after completing the activity for the path.

DefaultActivity (string) –

The unique identifier for the activity to perform for participants who don’t meet any of the conditions specified for other paths in the activity.

The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

PUSH (dict) –

The settings for a push notification activity. This type of activity sends a push notification to participants.

Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

TimeToLive (string) –

The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it’s sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn’t store or try to deliver the notification again.

This value doesn’t apply to messages that are sent through the Amazon Device Messaging (ADM) service.

The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

RandomSplit (dict) –

The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

Specifies the settings for a path in a random split activity in a journey.

Percentage (integer) –

The percentage of participants to send down the activity path.

To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

SMS (dict) –

The settings for an SMS activity. This type of activity sends a text message to participants.

Specifies the sender ID and message type for an SMS message that’s sent to participants in a journey.

MessageType (string) –

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren’t critical or time-sensitive, such as marketing messages).

OriginationNumber (string) –

The long code to send the SMS message from. This value should be one of the dedicated long codes that’s assigned to your AWS account. Although it isn’t required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

SenderId (string) –

The sender ID to display as the sender of the message on a recipient’s device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

EntityId (string) –

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

TemplateId (string) –

The template ID received from the regulatory body for sending SMS in your country.

The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

Wait (dict) –

The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

The unique identifier for the next activity to perform, after performing the wait activity.

WaitTime (dict) –

The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

ContactCenter (dict) –

The settings for a connect activity. This type of activity initiates a contact center call to participants.

The unique identifier for the next activity to perform after the this activity.

CreationDate (string) –

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

LastModifiedDate (string) –

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

Limits (dict) –

The messaging and entry limits for the journey.

DailyCap (integer) –

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

EndpointReentryCap (integer) –

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.

MessagesPerSecond (integer) –

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

EndpointReentryInterval (string) –

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.

TimeframeCap (dict) –

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

Cap (integer) –

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.

Days (integer) –

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

TotalCap (integer) –

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.

LocalTime (boolean) –

Specifies whether the journey’s scheduled start and end times use each participant’s local time. To base the schedule on each participant’s local time, set this value to true.

Name (string) – [REQUIRED]

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can’t contain any spaces.

QuietTime (dict) –

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.

End (string) –

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.

Start (string) –

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.

RefreshFrequency (string) –

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

Schedule (dict) –

The schedule settings for the journey.

EndTime (datetime) –

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

StartTime (datetime) –

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

Timezone (string) –

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.

StartActivity (string) –

The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

StartCondition (dict) –

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

The custom description of the condition.

EventStartCondition (dict) –

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

EventFilter (dict) –

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

Dimensions (dict) – [REQUIRED]

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

FilterType (string) – [REQUIRED]

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.

SegmentId (string) –

SegmentStartCondition (dict) –

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

State (string) –

The status of the journey. Valid values are:

DRAFT - Saves the journey and doesn’t publish it.

ACTIVE - Saves and publishes the journey. Depending on the journey’s schedule, the journey starts running immediately or at the scheduled start time. If a journey’s status is ACTIVE, you can’t add, change, or remove activities from it.

PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.

WaitForQuietTime (boolean) –

Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

RefreshOnSegmentUpdate (boolean) –

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

JourneyChannelSettings (dict) –

The channel-specific configurations for the journey.

ConnectCampaignArn (string) –

Amazon Resource Name (ARN) of the Connect Campaign.

ConnectCampaignExecutionRoleArn (string) –

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

SendingSchedule (boolean) –

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

OpenHours (dict) –

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

Specifies the schedule settings for the email channel.

Day of a week when the rule will be applied. Valid values are [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

Open Hour Rules.

Open Hour Rule Details.

StartTime (string) –

The start of the scheduled time, in ISO 8601 format, when the channel can send messages.

EndTime (string) –

The end of the scheduled time, in ISO 8601 format, when the channel can’t send messages.

Specifies the schedule settings for the SMS channel.

Specifies the schedule settings for the push channel.

VOICE (dict) –

Specifies the schedule settings for the voice channel.

Specifies the schedule settings for the custom channel.

ClosedDays (dict) –

The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

EMAIL (list) –

Rules for the Email channel.

ClosedDays rule details.

Name (string) –

The name of the closed day rule.

StartDateTime (string) –

Start DateTime ISO 8601 format

EndDateTime (string) –

End DateTime ISO 8601 format

SMS (list) –

Rules for the SMS channel.

PUSH (list) –

Rules for the Push channel.

VOICE (list) –

Rules for the Voice channel.

CUSTOM (list) –

Rules for the Custom channel.

TimezoneEstimationMethods (list) –

An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

Response Syntax

Response structure.

The request succeeded and the specified resource was created.

JourneyResponse (dict) –

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

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.

Values (list) –

ComparisonOperator (string) –

Value (float) –

Duration (string) –

RecencyType (string) –

Coordinates (dict) –

Latitude (float) –

Longitude (float) –

ApplicationId (string) –

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

Id (string) –

The unique identifier for the journey.

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.

The name of the journey.

The unique identifier for the first activity in the journey.

FilterType (string) –

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.

tags (dict) –

This object is not used or supported.

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

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

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

Pinpoint.Client.exceptions.BadRequestException

Pinpoint.Client.exceptions.InternalServerErrorException

Pinpoint.Client.exceptions.PayloadTooLargeException

Pinpoint.Client.exceptions.ForbiddenException

Pinpoint.Client.exceptions.NotFoundException

Pinpoint.Client.exceptions.MethodNotAllowedException

Pinpoint.Client.exceptions.TooManyRequestsException

Amazon Pinpoint journeys

In Amazon Pinpoint, a journey is a customized, multi-step engagement experience. When you create a journey, you start by choosing a segment that defines which customers will participate in the journey. After that, you add the activities that customers pass through on their journeys. Activities can include sending messages or splitting customers into groups based on their attributes or behaviors.

There are several different types of journey activities, each with its own specific purpose. For example, you can add a Send email activity to your journey. When a customer arrives on this type of activity, they receive an email message. Another type of journey activity is the Multivariate split activity. When customers arrive on this type of activity, they are separated into multiple paths based on their segment membership or their interactions with previous journey activities. You can learn more about journey activities in Take a tour of journeys .

This chapter contains conceptual information about journeys in Amazon Pinpoint. It also contains information about creating, managing, testing, and publishing your journeys.

Topics in this section:

• Take a tour of journeys
• Create a journey
• Set up the journey entry activity
• Add activities to the journey
• Review and test a journey
• Publish a journey
• Pause, resume, or stop a journey
• View journey metrics
• Tips and best practices for journeys

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.

• The Quiet Time Journal
• Online Store

 Why You'll Love The Quiet Time Notebooks  

All in one place. Comprehensive devotional tools. Fill one up, get another.

Catherine Martin — Author of Six Secrets To A Powerful Quiet Time

Journaling is an experience with God.

You journal in the presence of God, to God, and for the glory of God, all within the framework of human language. Journaling is a spiritual journey of reflection and discovery, opening up the world of quiet time to deeper insight into God’s Word. Your journal should contain dialogue with God, insights about God, questions for God, complaints, goals, and ideas. Writing in your journal is a way of drawing near to remember God and find your refuge in Him.

Over the years, I have discovered certain disciplines of devotion in the Bible that help me become a participant, experiencing the character and person of the Lord in my own life. Biblical devotional disciplines include such things as prayer, Bible study, meditating on God’s Word, solitude, devotional reading, journaling, listening to God, submission to God, worship, and practical application. A quiet time plan embraces different devotional disciplines to draw you into God’s Word so you can hear Him speak and respond to Him in prayer.

Catherine Martin

Pouring Out Your Soul To The Lord

"I have poured out my soul before the Lord" — Hannah in 1 Samuel 1:15 NASB

Do you desire a spiritual journey of reflection and discovery, opening up the world of quiet time to deeper insight into God’s Word? Journaling pours out your soul to the Lord, making you receptive to the voice of God. In The Quiet Time Journal , author Catherine Martin presents favorite chapters from Six Secrets to a Powerful Quiet Time , Journal and Prayer Pages from The Quiet Time Notebook , and a personal quiet time, The Great Adventure . …

• Learn how to prepare your heart for quiet time with the Lord.
• Find out what it means to read and study God’s Word using The PRAYER Quiet Time Plan.
• Reflect on what you are learning in your quiet time by adoring God in prayer.

Writing in The Quiet Time Journal prepares your heart to meet with God and express your deepest spiritual insights. Will you pour out your soul to the Lord? Begin your great adventure. Write your spiritual legacy in The Quiet Time Journal — a testimony to God’s work in your life.

• Ex Libris, My Key Word & Verse
• Introduction Section
• Six Essential Chapters from Six Secrets To A Powerful Quiet Time
• Journal Pages [90] from The Quiet Time Notebook includes Journal Example Page
• Prayer Pages [90] from The Quiet Time Notebook includes Prayer Example Page
• How To Use The Quiet Time Journal
• Quiet Time — The Great Adventure from Six Secrets To A Powerful Quiet Time

Write your spiritual legacy!

Fill one up — get another, with typical spirit-led selective usage, the quiet time journal should last you a whole year.

Clean and Crisp Design

Each Journal page provides space for multiple dated entries, perhaps 5 per page.

User Friendly

Even if you fill one of the 90 Journal pages daily, there is space for 3 months of entries.

Plenty Of Space

Each Prayer page provides space for 5 dated entries, 450 entries per 90 pages.

A Renewable Resource

Pouring Out Your Soul to the Lord

Softcover book.

Quiet Time Ministries Press

Quiet Time Ministries

Charitable contribution.

One Time Gift

• Six Secrets To A Powerful Quiet Time

A 30–Day Journey Book

I believe the Quiet Time Notebook can be a useful tool for people at all levels of spiritual growth and maturity. It has the flexibility to be useful for all. I absolutely love it. I feel like it's a great way for me to organize notes and thoughts and be able to go back and reflect on things I've learned.

Jane D., Social Media Comment

5 Stars. Love this!

Ms. L. Legister, Amazon Book Review

I have learned to adapt the PRAYER format into my personal quiet time and as a result my quiet time with God is personal and rich.

Denyse Foster, Email Comment

I bought your Quiet Time Notebook online … I was impressed with how you have put together and organized the notebook. Your gifted writing ability, your "no nonsense" approach is refreshing. Thank you!

Debbie Berna, Email Comment

Hello, I just wanted to say that I got the Quiet Time Notebook … I am not only very pleased with the notebook itself but with the quick, timely manner in which it came. I have used many diffferent types of notebooks and journals during my quiet time but I just wanted you to know how impressed I am with yours. I will definitely be ordering again in the future.

I love my "QTM journals" and use them daily. Just wanted to take a moment today to let you know that your ministry has touched me and I greatly appreciate you!

Laura Caldwell, Social Media Comment

Key Quiet Time Notebook Resources

What Is A Quiet Time?

• Key Quiet Time Videos

 The biblical basis for quiet time. Even Jesus had a quiet time (Luke 5:16). Key to powerful quiet times?

Getting Started In Quiet Time

• Key Quiet Time Articles

Cath's quick start guide to powerful quiet times. Essential resources. A time, a place, & a plan. …

A Quiet Time With Catherine

A Real Time Quiet Time Video . Experience a live quiet time with Catherine Martin as your guide!

The PRAYER ™ Quiet Time Plan

Key devotional disciplines to enhance your quiet time. Easy-to-remember, easy-to-use, and … fun!

Shake Up Your Quiet Time!

Quiet time is an opportunity for a new beginning each day. … Philippians 3:13-14 NASB

Why You'll Love Quiet Time Studies

Perfect for individual study, prayer partners, small group Bible studies, or church campaigns.

• The Quiet Time Notebooks Series

The Quiet Time Journal — The PRAYER Quiet Time Plan

The Quiet Time Notebooks Series Book

Format: This Quiet Time Notebook Series book is organized into 6 sections:

Appendices: About The Author, Notes, and suggested Quiet Time Resources.

Details: Perfect Bound Trade Paperback 9.25 x 7.5 x 0.522 inches, English language, ISBN13: 978-0-9766886-6-2, 248 pages.

Publisher: Quiet Time Ministries Press, Second Edition 2012

• What are The Quiet Time Notebooks? All in one place. Comprehensive Bible devotional tools to enhance your quiet time based upon The P.R.A.Y.E.R.™ Quiet Time Plan™ introduced in Catherine’s signature work, Six Secrets To A Powerful Quiet Time.
• The Quiet Time Journal — The PRAYER Quiet Time Plan PDF Excerpt

The Quiet Time Notebook

The prayer quiet time plan.

The Devotional Bible Study Notebook

Quiet time devotional studies.

The Passionate Prayer Notebook

The passionate prayer growth plan, six secrets to a powerful quiet time — discovering radical intimacy with god.

Format: This A 30–Day Journey book is organized into 5 weeks, with 5 days of reading and response per week, and then a 6th day of personal quiet time experience with daily My Response pages with a key verse, an open ended question, and space to formulate your own response and weekly quiet times designed according to The P.R.A.Y.E.R.™ Quiet Time Plan™ introduced in Catherine’s signature work, Six Secrets To A Powerful Quiet Time. The devotional disciplines of The P.R.A.Y.E.R.™ Quiet Time Plan™ include devotional reading, Bible study, hymns and worship, meditation, word studies, journaling, prayers, and application of God’s word to your life. Weekly Viewer Guide message notes are included as companions to the DVD, M4V, MP3 multimedia.

Six Secrets To A Powerful Quiet Time draws from a rich variety of biblical resources teaching how to really have a quiet time. This signature work is filled with illustrations, biographical sketches of biblical heroes of faith, inspirational selections from great devotional writers, and personal insights from Catherine. It is fully complete for you or your group — a powerful catalyst for spiritual growth.

Appendices: Leader’s Guide Discussion Questions, A Quiet Time for Determining Your Life Goal and Life Verse , P.R.A.Y.E.R.™ Quiet Time Plan™ Resource Guide, Recommended Reading, Worksheet: Getting Started In Your Quiet Time , and End Notes for further reading.

Details: Trade Paperback 8.5 x 5.5 x 0.6 inches, English language, ISBN-13: 978-0976688693, 286 pages.

Publisher: Quiet Time Ministries Press, Second Edition 2013

• What are A 30–Day Journeys? Thirty Days of Guided Devotions — Inspirational and Instructional Reading, Daily My Response, and Weekly Quiet Times.
• Six Secrets To A Powerful Quiet Time — A 30–Day Journey PDF Excerpt

Quiet Time LIVE

Enriching your quiet time conferences.

In just one inspirational day of devotion, you and your group will learn how to really have a quiet time.

• Quiet Time Live Kit Promotional Resources.
• Enriching Your Quiet Time Participant Guide.
• A Quiet Time Experience with Catherine Martin.

Online Bible Studies

"the lord hears when i call to him".

God's greatest delight is that you know Him. And knowing Him is what brings ultimate enjoyment and fulfillment in life. Is knowing God your great desire?

Experience a live quiet time with Catherine Martin as your guide!

• A Quiet Time With Catherine SD480p DVD Video.
• A Quiet Time With Catherine Personal HD720p M4V Video.
• A Quiet Time With Catherine Leaders HD1080p M4V Video.

• Christian Books & Bibles
• Christian Living

Enjoy fast, free delivery, exclusive deals, and award-winning movies & TV shows with Prime Try Prime and start saving today with fast, free delivery

Amazon Prime includes:

Fast, FREE Delivery is available to Prime members. To join, select "Try Amazon Prime and start saving today with Fast, FREE Delivery" below the Add to Cart button.

• Cardmembers earn 5% Back at Amazon.com with a Prime Credit Card.
• Unlimited Free Two-Day Delivery
• Streaming of thousands of movies and TV shows with limited ads on Prime Video.
• A Kindle book to borrow for free each month - with no due dates
• Listen to over 2 million songs and hundreds of playlists
• Unlimited photo storage with anywhere access

Important:  Your credit card will NOT be charged when you start your free trial or if you cancel during the trial period. If you're happy with Amazon Prime, do nothing. At the end of the free trial, your membership will automatically upgrade to a monthly membership.

Download the free Kindle app and start reading Kindle books instantly on your smartphone, tablet, or computer - no Kindle device required .

Read instantly on your browser with Kindle for Web.

Using your mobile phone camera - scan the code below and download the Kindle app.

Follow the author

Image Unavailable

• To view this video download Flash Player

Pinpoint: Clarity for the Journey Paperback – March 25, 2024

Purchase options and add-ons.

• Print length 122 pages
• Language English
• Publication date March 25, 2024
• Reading age 16 - 18 years
• Dimensions 5.5 x 0.31 x 8.5 inches
• ISBN-13 979-8884737532
• See all details

Product details

• ASIN ‏ : ‎ B0CYNGJ8BG
• Publisher ‏ : ‎ Independently published (March 25, 2024)
• Language ‏ : ‎ English
• Paperback ‏ : ‎ 122 pages
• ISBN-13 ‏ : ‎ 979-8884737532
• Reading age ‏ : ‎ 16 - 18 years
• Item Weight ‏ : ‎ 7.5 ounces
• Dimensions ‏ : ‎ 5.5 x 0.31 x 8.5 inches
• #5,359 in Christian Self Help
• #10,232 in Christian Bible Study (Books)
• #13,919 in Christian Spiritual Growth (Books)

About the author

Tracy lynn ruhl.

Discover more of the author’s books, see similar authors, read author blogs and more

Customer reviews

Customer Reviews, including Product Star Ratings help customers to learn more about the product and decide whether it is the right product for them.

To calculate the overall star rating and percentage breakdown by star, we don’t use a simple average. Instead, our system considers things like how recent a review is and if the reviewer bought the item on Amazon. It also analyzed reviews to verify trustworthiness.

• Sort reviews by Top reviews Most recent Top reviews

Top review from the United States

There was a problem filtering reviews right now. please try again later..

• Amazon Newsletter
• About Amazon
• Accessibility
• Sustainability
• Press Center
• Investor Relations
• Amazon Devices
• Amazon Science
• Sell on Amazon
• Sell apps on Amazon
• Supply to Amazon
• Protect & Build Your Brand
• Become an Affiliate
• Become a Delivery Driver
• Start a Package Delivery Business
• Advertise Your Products
• Self-Publish with Us
• Become an Amazon Hub Partner
• › See More Ways to Make Money
• Amazon Visa
• Amazon Store Card
• Amazon Secured Card
• Amazon Business Card
• Shop with Points
• Credit Card Marketplace
• Reload Your Balance
• Amazon Currency Converter
• Your Account
• Your Orders
• Shipping Rates & Policies
• Amazon Prime
• Returns & Replacements
• Manage Your Content and Devices
• Recalls and Product Safety Alerts
• Conditions of Use
• Privacy Notice
• Consumer Health Data Privacy Disclosure
• Your Ads Privacy Choices

• AWS CLI 2.7.12 Command Reference »
• pinpoint »
• ← update-journey /
• update-push-template →

Table of Contents

• Description

Quick search

Did you find this page useful? Do you have a suggestion to improve the documentation? Give us feedback . If you would like to suggest an improvement or fix for the AWS CLI, check out our contributing guide on GitHub.

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

update-journey-state ¶

Description ¶.

Cancels (stops) an active journey.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

--application-id (string)

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

--journey-id (string)

The unique identifier for the journey.

--journey-state-request (structure)

Changes the status of a journey. State -> (string) The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey. After you cancel a journey, you can’t add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn’t perform any activities that haven’t started. When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

Shorthand Syntax:

JSON Syntax:

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton . If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input , prints a sample input JSON that can be used as an argument for --cli-input-json . Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml . If provided with the value output , it validates the command inputs and returns a sample output JSON for that command.

JourneyResponse -> (structure)

Provides information about the status, configuration, and other settings for a journey. Activities -> (map) 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. key -> (string) value -> (structure) Specifies the configuration and other settings for an activity in a journey. CUSTOM -> (structure) The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants. DeliveryUri -> (string) The destination to send the campaign or treatment to. This value can be one of the following: The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment. The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

EndpointTypes -> (list)

The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint. (string)

MessageConfig -> (structure)

Specifies the message data included in a custom channel message that’s sent to participants in a journey. Data -> (string) The message content that’s passed to an AWS Lambda function or to a web hook.

NextActivity -> (string)

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

TemplateName -> (string)

The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

TemplateVersion -> (string)

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource. If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.

ConditionalSplit -> (structure)

The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify. Condition -> (structure) The conditions that define the paths for the activity, and the relationship between the conditions. Conditions -> (list) The conditions to evaluate for the activity. (structure) Specifies a condition to evaluate for an activity in a journey. EventCondition -> (structure) The dimension settings for the event that’s associated with the activity. Dimensions -> (structure) The dimensions for the event filter to use for the activity. Attributes -> (map) 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. key -> (string) value -> (structure) Specifies attribute-based criteria for including or excluding endpoints from a segment. AttributeType -> (string) The type of segment dimension to use. Valid values are: INCLUSIVE - endpoints that have attributes matching the values are included in the segment. EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment. CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment. BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment. AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment. ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison. BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Values -> (list)

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values. (string)

EventType -> (structure)

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 . DimensionType -> (string) 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.

The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. (string)

Metrics -> (map)

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. key -> (string) value -> (structure) Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints. ComparisonOperator -> (string) The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

Value -> (double)

The value to compare.

MessageActivity -> (string)

The message identifier (message_id) for the message to use when determining whether message events meet the condition.

SegmentCondition -> (structure)

The segment that’s associated with the activity. SegmentId -> (string) The unique identifier for the segment to associate with the activity.

SegmentDimensions -> (structure)

The dimension settings for the segment that’s associated with the activity. Attributes -> (map) One or more custom attributes to use as criteria for the segment. key -> (string) value -> (structure) Specifies attribute-based criteria for including or excluding endpoints from a segment. AttributeType -> (string) The type of segment dimension to use. Valid values are: INCLUSIVE - endpoints that have attributes matching the values are included in the segment. EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment. CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment. BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment. AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment. ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison. BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Behavior -> (structure)

The behavior-based criteria, such as how recently users have used your app, for the segment. Recency -> (structure) The dimension settings that are based on how recently an endpoint was active. Duration -> (string) The duration to use when determining whether an endpoint is active or inactive.

RecencyType -> (string)

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren’t active within the specified duration are included in the segment.

Demographic -> (structure)

The demographic-based criteria, such as device platform, for the segment. AppVersion -> (structure) The app version criteria for the segment. DimensionType -> (string) 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.

Channel -> (structure)

The channel criteria for the segment. DimensionType -> (string) 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.

DeviceType -> (structure)

The device type criteria for the segment. DimensionType -> (string) 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.

Make -> (structure)

The device make criteria for the segment. DimensionType -> (string) 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.

Model -> (structure)

The device model criteria for the segment. DimensionType -> (string) 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.

Platform -> (structure)

The device platform criteria for the segment. DimensionType -> (string) 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.

Location -> (structure)

The location-based criteria, such as region or GPS coordinates, for the segment. Country -> (structure) The country or region code, in ISO 3166-1 alpha-2 format, for the segment. DimensionType -> (string) 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.

GPSPoint -> (structure)

The GPS location and range for the segment. Coordinates -> (structure) The GPS coordinates to measure distance from. Latitude -> (double) The latitude coordinate of the location.

Longitude -> (double)

The longitude coordinate of the location.

RangeInKilometers -> (double)

The range, in kilometers, from the GPS coordinates.

One or more custom metrics to use as criteria for the segment. key -> (string) value -> (structure) Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints. ComparisonOperator -> (string) The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

UserAttributes -> (map)

One or more custom user attributes to use as criteria for the segment. key -> (string) value -> (structure) Specifies attribute-based criteria for including or excluding endpoints from a segment. AttributeType -> (string) The type of segment dimension to use. Valid values are: INCLUSIVE - endpoints that have attributes matching the values are included in the segment. EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment. CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment. BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment. AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment. ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison. BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Operator -> (string)

Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

EvaluationWaitTime -> (structure)

The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met. WaitFor -> (string) The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity’s conditions have been met or moving participants to the next activity in the journey.

WaitUntil -> (string)

The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity’s conditions have been met or the activity moves participants to the next activity in the journey.

FalseActivity -> (string)

The unique identifier for the activity to perform if the conditions aren’t met.

TrueActivity -> (string)

The unique identifier for the activity to perform if the conditions are met.

Description -> (string)

The custom description of the activity.

EMAIL -> (structure)

The settings for an email activity. This type of activity sends an email message to participants. MessageConfig -> (structure) Specifies the sender address for an email message that’s sent to participants in the journey. FromAddress -> (string) The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

The unique identifier for the next activity to perform, after the message is sent.

The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource. If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.

Holdout -> (structure)

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants. NextActivity -> (string) The unique identifier for the next activity to perform, after performing the holdout activity.

Percentage -> (integer)

The percentage of participants who shouldn’t continue the journey. To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

MultiCondition -> (structure)

The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify. Branches -> (list) The paths for the activity, including the conditions for entering each path and the activity to perform for each path. (structure) Specifies a condition to evaluate for an activity path in a journey. Condition -> (structure) The condition to evaluate for the activity path. EventCondition -> (structure) The dimension settings for the event that’s associated with the activity. Dimensions -> (structure) The dimensions for the event filter to use for the activity. Attributes -> (map) 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. key -> (string) value -> (structure) Specifies attribute-based criteria for including or excluding endpoints from a segment. AttributeType -> (string) The type of segment dimension to use. Valid values are: INCLUSIVE - endpoints that have attributes matching the values are included in the segment. EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment. CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment. BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment. AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment. ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison. BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

The unique identifier for the next activity to perform, after completing the activity for the path.

DefaultActivity -> (string)

The unique identifier for the activity to perform for participants who don’t meet any of the conditions specified for other paths in the activity.

The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met. WaitFor -> (string) The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity’s conditions have been met or moving participants to the next activity in the journey.

PUSH -> (structure)

The settings for a push notification activity. This type of activity sends a push notification to participants. MessageConfig -> (structure) Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey. TimeToLive -> (string) The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it’s sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn’t store or try to deliver the notification again. This value doesn’t apply to messages that are sent through the Amazon Device Messaging (ADM) service.

The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource. If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.

RandomSplit -> (structure)

The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify. Branches -> (list) The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path. (structure) Specifies the settings for a path in a random split activity in a journey. NextActivity -> (string) The unique identifier for the next activity to perform, after completing the activity for the path.

The percentage of participants to send down the activity path. To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

SMS -> (structure)

The settings for an SMS activity. This type of activity sends a text message to participants. MessageConfig -> (structure) Specifies the sender ID and message type for an SMS message that’s sent to participants in a journey. MessageType -> (string) The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren’t critical or time-sensitive, such as marketing messages).

OriginationNumber -> (string)

The long code to send the SMS message from. This value should be one of the dedicated long codes that’s assigned to your AWS account. Although it isn’t required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

SenderId -> (string)

The sender ID to display as the sender of the message on a recipient’s device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

EntityId -> (string)

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

TemplateId -> (string)

The template ID received from the regulatory body for sending SMS in your country.

The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versionsresource. If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.

Wait -> (structure)

The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey. NextActivity -> (string) The unique identifier for the next activity to perform, after performing the wait activity.

WaitTime -> (structure)

The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey. WaitFor -> (string) The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity’s conditions have been met or moving participants to the next activity in the journey.

ContactCenter -> (structure)

The settings for a connect activity. This type of activity initiates a contact center call to participants. NextActivity -> (string) The unique identifier for the next activity to perform after the this activity.

ApplicationId -> (string)

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

CreationDate -> (string)

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

Id -> (string)

LastModifiedDate -> (string)

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

Limits -> (structure)

The messaging and entry limits for the journey. DailyCap -> (integer) The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

EndpointReentryCap -> (integer)

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.

MessagesPerSecond -> (integer)

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

EndpointReentryInterval -> (string)

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.

LocalTime -> (boolean)

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.

Name -> (string)

The name of the journey.

QuietTime -> (structure)

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. End -> (string) 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.

Start -> (string)

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.

RefreshFrequency -> (string)

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

Schedule -> (structure)

The schedule settings for the journey. EndTime -> (timestamp) The scheduled time, in ISO 8601 format, when the journey ended or will end.

StartTime -> (timestamp)

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

Timezone -> (string)

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.

StartActivity -> (string)

The unique identifier for the first activity in the journey.

StartCondition -> (structure)

The segment that defines which users are participants in the journey. Description -> (string) The custom description of the condition.

EventStartCondition -> (structure)

Specifies the settings for an event that causes a journey activity to start. EventFilter -> (structure) Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed. Dimensions -> (structure) The dimensions for the event filter to use for the campaign or the journey activity. Attributes -> (map) 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. key -> (string) value -> (structure) Specifies attribute-based criteria for including or excluding endpoints from a segment. AttributeType -> (string) The type of segment dimension to use. Valid values are: INCLUSIVE - endpoints that have attributes matching the values are included in the segment. EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment. CONTAINS - endpoints that have attributes’ substrings match the values are included in the segment. BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment. AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment. ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison. BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

FilterType -> (string)

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.

SegmentId -> (string)

SegmentStartCondition -> (structure)

The segment that’s associated with the first activity in the journey. This segment determines which users are participants in the journey. SegmentId -> (string) The unique identifier for the segment to associate with the activity.

State -> (string)

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.

tags -> (map)

This object is not used or supported. key -> (string) value -> (string)

WaitForQuietTime -> (boolean)

Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

RefreshOnSegmentUpdate -> (boolean)

Specifies whether a journey should be refreshed on segment update.

JourneyChannelSettings -> (structure)

The channel-specific configurations for the journey. ConnectCampaignArn -> (string) Amazon Resource Name (ARN) of the Connect Campaign.

ConnectCampaignExecutionRoleArn -> (string)

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

• Bahasa Indonesia
• Sign out of AWS Builder ID
• AWS Management Console
• Account Settings
• Billing & Cost Management
• Security Credentials
• AWS Personal Health Dashboard
• Support Center
• Expert Help
• Knowledge Center
• AWS Support Overview
• AWS re:Post

Gunkao Pinpoint journeys now supports time zone estimation for endpoints

Posted On: Jun 26, 2023

Gunkao Pinpoint journeys now offers organizations the ability to estimate local time zone and allows them to contact customers at convenient times. Journeys are customized, multi-step engagement experience to send customer communication across channels such as SMS, email, push notifications, and voice.

Time zone is used in Gunkao Pinpoint journeys to determine when to contact customers based on an endpoint’s local time and to respect quiet time rules for when messages should not be sent. An endpoint represents a destination that messages can be sent to, such as a mobile device, email address, or phone number. With the new feature, organizations can now estimate time zones of customers using the endpoint’s phone number, postal code, or both. For example, if a recipient’s phone number has a 312 area code, the recipient will receive messages in central time zone. This new feature will help the organizations to reach more customers through an Gunkao Pinpoint journey.

The time zone estimation feature is available in the following AWS Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (London).

For more information, see Time zone estimation the Gunkao Pinpoint User Guide.

Ending Support for Internet Explorer