Class: Aws::Pinpoint::Types::WriteJourneyRequest

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::WriteJourneyRequest

show all

Defined in:: gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Specifies the configuration and other settings for a journey.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#activities ⇒ Hash<String,Types::Activity>
A map that contains a set of Activity objects, one object for each activity in the journey.
#closed_days ⇒ Types::ClosedDays
The time when journey will stop sending messages.
#creation_date ⇒ String
The date, in ISO 8601 format, when the journey was created.
#journey_channel_settings ⇒ Types::JourneyChannelSettings
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
#last_modified_date ⇒ String
The date, in ISO 8601 format, when the journey was last modified.
#limits ⇒ Types::JourneyLimits
The messaging and entry limits for the journey.
#local_time ⇒ Boolean
Specifies whether the journey's scheduled start and end times use each participant's local time.
#name ⇒ String
The name of the journey.
#open_hours ⇒ Types::OpenHours
The time when journey allow to send messages.
#quiet_time ⇒ Types::QuietTime
The quiet time settings for the journey.
#refresh_frequency ⇒ String
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
#refresh_on_segment_update ⇒ Boolean
#schedule ⇒ Types::JourneySchedule
The schedule settings for the journey.
#sending_schedule ⇒ Boolean
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays).
#start_activity ⇒ String
The unique identifier for the first activity in the journey.
#start_condition ⇒ Types::StartCondition
The segment that defines which users are participants in the journey.
#state ⇒ String
The status of the journey.
#wait_for_quiet_time ⇒ Boolean

Instance Attribute Details

#activities ⇒ `Hash<String,Types::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.

Returns:

(Hash<String,Types::Activity>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#closed_days ⇒ `Types::ClosedDays`

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

Returns:

(Types::ClosedDays)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#journey_channel_settings ⇒ `Types::JourneyChannelSettings`

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

Returns:

(Types::JourneyChannelSettings)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#limits ⇒ `Types::JourneyLimits`

The messaging and entry limits for the journey.

Returns:

(Types::JourneyLimits)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#local_time ⇒ `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.

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#open_hours ⇒ `Types::OpenHours`

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

Returns:

(Types::OpenHours)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#quiet_time ⇒ `Types::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.

Returns:

(Types::QuietTime)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_frequency ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_on_segment_update ⇒ `Boolean`

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ `Types::JourneySchedule`

The schedule settings for the journey.

Returns:

(Types::JourneySchedule)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#sending_schedule ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#start_activity ⇒ `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.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#start_condition ⇒ `Types::StartCondition`

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

Returns:

(Types::StartCondition)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

#wait_for_quiet_time ⇒ `Boolean`

Returns:

(Boolean)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13353

class WriteJourneyRequest < Struct.new(
  :activities,
  :creation_date,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :wait_for_quiet_time,
  :refresh_on_segment_update,
  :journey_channel_settings,
  :sending_schedule,
  :open_hours,
  :closed_days)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Pinpoint::Types::WriteJourneyRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#activities ⇒ Hash<String,Types::Activity>

#closed_days ⇒ Types::ClosedDays

#creation_date ⇒ String

#journey_channel_settings ⇒ Types::JourneyChannelSettings

#last_modified_date ⇒ String

#limits ⇒ Types::JourneyLimits

#local_time ⇒ Boolean

#name ⇒ String

#open_hours ⇒ Types::OpenHours

#quiet_time ⇒ Types::QuietTime

#refresh_frequency ⇒ String

#refresh_on_segment_update ⇒ Boolean

#schedule ⇒ Types::JourneySchedule

#sending_schedule ⇒ Boolean

#start_activity ⇒ String

#start_condition ⇒ Types::StartCondition

#state ⇒ String

#wait_for_quiet_time ⇒ Boolean

#activities ⇒ `Hash<String,Types::Activity>`

#closed_days ⇒ `Types::ClosedDays`

#creation_date ⇒ `String`

#journey_channel_settings ⇒ `Types::JourneyChannelSettings`

#last_modified_date ⇒ `String`

#limits ⇒ `Types::JourneyLimits`

#local_time ⇒ `Boolean`

#name ⇒ `String`

#open_hours ⇒ `Types::OpenHours`

#quiet_time ⇒ `Types::QuietTime`

#refresh_frequency ⇒ `String`

#refresh_on_segment_update ⇒ `Boolean`

#schedule ⇒ `Types::JourneySchedule`

#sending_schedule ⇒ `Boolean`

#start_activity ⇒ `String`

#start_condition ⇒ `Types::StartCondition`

#state ⇒ `String`

#wait_for_quiet_time ⇒ `Boolean`