Documentation

Specifies the configuration and other settings for a journey.

See: newWriteJourneyRequest smart constructor.

Create a value of WriteJourneyRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activities:WriteJourneyRequest', writeJourneyRequest_activities - A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

$sel:closedDays:WriteJourneyRequest', writeJourneyRequest_closedDays - The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

$sel:creationDate:WriteJourneyRequest', writeJourneyRequest_creationDate - The date, in ISO 8601 format, when the journey was created.

$sel:journeyChannelSettings:WriteJourneyRequest', writeJourneyRequest_journeyChannelSettings - The channel-specific configurations for the journey.

$sel:lastModifiedDate:WriteJourneyRequest', writeJourneyRequest_lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.

$sel:limits:WriteJourneyRequest', writeJourneyRequest_limits - The messaging and entry limits for the journey.

$sel:localTime:WriteJourneyRequest', writeJourneyRequest_localTime - 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.

$sel:openHours:WriteJourneyRequest', writeJourneyRequest_openHours - The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.

$sel:quietTime:WriteJourneyRequest', writeJourneyRequest_quietTime - 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.

$sel:refreshFrequency:WriteJourneyRequest', writeJourneyRequest_refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

$sel:refreshOnSegmentUpdate:WriteJourneyRequest', writeJourneyRequest_refreshOnSegmentUpdate - Specifies whether a journey should be refreshed on segment update.

$sel:schedule:WriteJourneyRequest', writeJourneyRequest_schedule - The schedule settings for the journey.

$sel:sendingSchedule:WriteJourneyRequest', writeJourneyRequest_sendingSchedule - Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)

$sel:startActivity:WriteJourneyRequest', writeJourneyRequest_startActivity - 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.

$sel:startCondition:WriteJourneyRequest', writeJourneyRequest_startCondition - The segment that defines which users are participants in the journey.

$sel:state:WriteJourneyRequest', writeJourneyRequest_state - 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.

$sel:waitForQuietTime:WriteJourneyRequest', writeJourneyRequest_waitForQuietTime - Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

$sel:name:WriteJourneyRequest', writeJourneyRequest_name - 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.

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.

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

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

The channel-specific configurations for the journey.

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

The messaging and entry limits for the journey.

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.

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

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.

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

Specifies whether a journey should be refreshed on segment update.

The schedule settings for the journey.

Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)

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.

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

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.

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

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.