pinpoint/aws.sdk.kotlin.services.pinpoint.model/WriteJourneyRequest

WriteJourneyRequest

class WriteJourneyRequest

Specifies the configuration and other settings for a journey.

Types

Builder

class Builder

Companion

object Companion

Properties

activities

val activities: Map<String, Activity>?

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.

closedDays

val closedDays: ClosedDays?

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

creationDate

val creationDate: String?

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

journeyChannelSettings

val journeyChannelSettings: JourneyChannelSettings?

The channel-specific configurations for the journey.

lastModifiedDate

val lastModifiedDate: String?

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

limits

val limits: JourneyLimits?

The messaging and entry limits for the journey.

localTime

val 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

val name: String?

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.

openHours

val openHours: OpenHours?

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

quietTime

val quietTime: 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:

refreshFrequency

val refreshFrequency: String?

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

refreshOnSegmentUpdate

val refreshOnSegmentUpdate: Boolean?

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

schedule

val schedule: JourneySchedule?

The schedule settings for the journey.

sendingSchedule

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

startActivity

val 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

val startCondition: StartCondition?

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

state

val state: State?

The status of the journey. Valid values are:

timezoneEstimationMethods

val timezoneEstimationMethods: List<TimezoneEstimationMethodsElement>?

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.

waitForQuietTime

val waitForQuietTime: Boolean?

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

Functions

copy

inline fun copy(block: WriteJourneyRequest.Builder.() -> Unit = {}): WriteJourneyRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String