Journey State - Amazon Pinpoint

Journey State

A journey is an automated workflow that performs a series of messaging activities for an Amazon Pinpoint application. The Journey State resource represents the status of a specific journey, including all of a journey's activities.

You can use this resource to cancel (stop) a journey or to retrieve information about the status and settings for a journey.

URI

/v1/apps/application-id/journeys/journey-id/state

HTTP Methods

PUT

Operation ID: UpdateJourneyState

Cancels (stops) an active journey.

Path Parameters
Name Type Required Description
journey-id String True

The unique identifier for the journey.

application-id String True

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

Header Parameters
Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses
Status Code Response Model Description
200 JourneyResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

413 MessageBody

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the Journey State resource.

Responses
Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example PUT

{ "State": enum }

Response Bodies

Example JourneyResponse

{ "Name": "string", "Schedule": { "StartTime": "string", "EndTime": "string", "Timezone": "string" }, "StartCondition": { "Description": "string", "eventStartCondition": { "eventFilter": { "Dimensions": { "EventType": { "DimensionType": enum, "Values": [ "string" ] }, "Attributes": { }, "Metrics": { } }, "FilterType": enum }, "segmentId": "string" }, "SegmentStartCondition": { "SegmentId": "string" } }, "Limits": { "DailyCap": integer, "MessagesPerSecond": integer, "EndpointReentryCap": integer }, "StartActivity": "string", "Activities": { }, "RefreshFrequency": "string", "QuietTime": { "Start": "string", "End": "string" }, "LocalTime": boolean, "CreationDate": "string", "LastModifiedDate": "string", "State": enum, "Id": "string", "ApplicationId": "string", "tags": { } }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Properties

Activity

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

Property Type Required Description
Description

string

False

The custom description of the activity.

ConditionalSplit

ConditionalSplitActivity

False

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.

Holdout

HoldoutActivity

False

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

MultiCondition

MultiConditionalSplitActivity

False

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.

RandomSplit

RandomSplitActivity

False

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.

Wait

WaitActivity

False

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.

EMAIL

EmailMessageActivity

False

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

SMS

SMSMessageActivity

False

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

PUSH

PushMessageActivity

False

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

CUSTOM

CustomMessageActivity

False

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

AttributeDimension

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

Property Type Required Description
AttributeType

string

Values: INCLUSIVE | EXCLUSIVE

False

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.

Values

Array of type string

True

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.

Condition

Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.

Property Type Required Description
Conditions

Array of type SimpleCondition

False

The conditions to evaluate for the activity.

Operator

string

Values: ALL | ANY

False

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.

ConditionalSplitActivity

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

Note

To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

Property Type Required Description
Condition

Condition

False

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

TrueActivity

string

False

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

FalseActivity

string

False

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

EvaluationWaitTime

WaitTime

False

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.

CustomMessageActivity

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

Property Type Required Description
MessageConfig

JourneyCustomMessage

False

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

NextActivity

string

False

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

DeliveryUri

string

False

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

Array of type string

Values: PUSH | GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | VOICE | EMAIL | BAIDU | CUSTOM

False

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.

TemplateName

string

False

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

False

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.

EmailMessageActivity

Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

Property Type Required Description
MessageConfig

JourneyEmailMessage

False

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

NextActivity

string

False

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

TemplateName

string

False

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.

TemplateVersion

string

False

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.

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.

EventCondition

Specifies the conditions to evaluate for an event that applies to an activity in a journey.

Property Type Required Description
Dimensions

EventDimensions

False

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

MessageActivity

string

False

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

EventDimensions

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

Property Type Required Description
EventType

SetDimension

False

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.

Attributes

object

False

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.

Metrics

object

False

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.

EventFilter

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

Property Type Required Description
Dimensions

EventDimensions

True

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

FilterType

string

Values: SYSTEM | ENDPOINT

True

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.

EventStartCondition

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

Property Type Required Description
eventFilter

EventFilter

False

The settings for the event that causes the activity to start.

segmentId

string

False

The unique identifier for the segment that's associated with the activity.

GPSCoordinates

Specifies the GPS coordinates of a location.

Property Type Required Description
Latitude

number

True

The latitude coordinate of the location.

Longitude

number

True

The longitude coordinate of the location.

GPSPointDimension

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

Property Type Required Description
Coordinates

GPSCoordinates

True

The GPS coordinates to measure distance from.

RangeInKilometers

number

False

The range, in kilometers, from the GPS coordinates.

HoldoutActivity

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

Property Type Required Description
Percentage

integer

True

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.

NextActivity

string

False

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

JourneyCustomMessage

Specifies the message content for a custom channel message that's sent to participants in a journey.

Property Type Required Description
Data

string

False

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

JourneyEmailMessage

Specifies the "From" address for an email message that's sent to participants in a journey.

Property Type Required Description
FromAddress

string

False

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

JourneyLimits

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

Property Type Required Description
DailyCap

integer

False

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

MessagesPerSecond

integer

False

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

EndpointReentryCap

integer

False

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.

JourneyPushMessage

Specifies the message configuration for a push notification that's sent to participants in a journey.

Property Type Required Description
TimeToLive

string

False

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.

JourneyResponse

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

Property Type Required Description
Name

string

True

The name of the journey.

Schedule

JourneySchedule

False

The schedule settings for the journey.

StartCondition

StartCondition

False

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

Limits

JourneyLimits

False

The messaging and entry limits for the journey.

StartActivity

string

False

The unique identifier for the first activity in the journey.

Activities

object

False

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.

RefreshFrequency

string

False

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

QuietTime

QuietTime

False

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.

LocalTime

boolean

False

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.

CreationDate

string

False

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

LastModifiedDate

string

False

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

State

string

Values: DRAFT | ACTIVE | COMPLETED | CANCELLED | CLOSED

False

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.

Id

string

True

The unique identifier for the journey.

ApplicationId

string

True

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

tags

object

False

This object is not used or supported.

JourneySMSMessage

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

Property Type Required Description
SenderId

string

False

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.

MessageType

string

Values: TRANSACTIONAL | PROMOTIONAL

False

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

JourneySchedule

Specifies the schedule settings for a journey.

Property Type Required Description
StartTime

string

False

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

EndTime

string

False

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

Timezone

string

False

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.

JourneyStateRequest

Changes the status of a journey.

Property Type Required Description
State

string

Values: DRAFT | ACTIVE | COMPLETED | CANCELLED | CLOSED

False

The status of the journey. Currently, the only supported value is 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.

MessageBody

Provides information about an API request or response.

Property Type Required Description
RequestID

string

False

The unique identifier for the request or response.

Message

string

False

The message that's returned from the API.

MetricDimension

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

Property Type Required Description
ComparisonOperator

string

True

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

number

True

The value to compare.

MultiConditionalBranch

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

Property Type Required Description
Condition

SimpleCondition

False

The condition to evaluate for the activity path.

NextActivity

string

False

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

MultiConditionalSplitActivity

Specifies the settings for a multivariate split activity in a journey. 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.

Note

To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

Property Type Required Description
Branches

Array of type MultiConditionalBranch

False

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

DefaultActivity

string

False

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.

EvaluationWaitTime

WaitTime

False

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

PushMessageActivity

Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

Property Type Required Description
MessageConfig

JourneyPushMessage

False

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

NextActivity

string

False

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

TemplateName

string

False

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.

TemplateVersion

string

False

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.

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.

QuietTime

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

Property Type Required Description
Start

string

False

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.

End

string

False

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.

RandomSplitActivity

Specifies the settings for a random split activity in a journey. 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.

Property Type Required Description
Branches

Array of type RandomSplitEntry

False

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

RandomSplitEntry

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

Property Type Required Description
Percentage

integer

False

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.

NextActivity

string

False

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

RecencyDimension

Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

Property Type Required Description
RecencyType

string

Values: ACTIVE | INACTIVE

True

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.

Duration

string

Values: HR_24 | DAY_7 | DAY_14 | DAY_30

True

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

SMSMessageActivity

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

Property Type Required Description
MessageConfig

JourneySMSMessage

False

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

NextActivity

string

False

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

TemplateName

string

False

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.

TemplateVersion

string

False

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.

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.

SegmentBehaviors

Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.

Property Type Required Description
Recency

RecencyDimension

False

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

SegmentCondition

Specifies a segment to associate with an activity in a journey.

Property Type Required Description
SegmentId

string

True

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

SegmentDemographics

Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.

Property Type Required Description
Channel

SetDimension

False

The channel criteria for the segment.

Platform

SetDimension

False

The device platform criteria for the segment.

DeviceType

SetDimension

False

The device type criteria for the segment.

AppVersion

SetDimension

False

The app version criteria for the segment.

Make

SetDimension

False

The device make criteria for the segment.

Model

SetDimension

False

The device model criteria for the segment.

SegmentDimensions

Specifies the dimension settings for a segment.

Property Type Required Description
Demographic

SegmentDemographics

False

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

Location

SegmentLocation

False

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

Behavior

SegmentBehaviors

False

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

Attributes

object

False

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

Metrics

object

False

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

UserAttributes

object

False

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

SegmentLocation

Specifies geographical dimension settings for a segment.

Property Type Required Description
Country

SetDimension

False

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

GPSPoint

GPSPointDimension

False

The GPS location and range for the segment.

SetDimension

Specifies the dimension type and values for a segment dimension.

Property Type Required Description
DimensionType

string

Values: INCLUSIVE | EXCLUSIVE

False

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.

Values

Array of type string

True

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.

SimpleCondition

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

Property Type Required Description
segmentDimensions

SegmentDimensions

False

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

SegmentCondition

SegmentCondition

False

The segment that's associated with the activity.

EventCondition

EventCondition

False

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

StartCondition

Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

Property Type Required Description
Description

string

False

The custom description of the condition.

eventStartCondition

EventStartCondition

False

This property is not supported.

SegmentStartCondition

SegmentCondition

False

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

WaitActivity

Specifies the settings for a wait activity in a journey. 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.

Property Type Required Description
WaitTime

WaitTime

False

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

NextActivity

string

False

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

WaitTime

Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.

Property Type Required Description
WaitFor

string

False

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

False

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.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

UpdateJourneyState