Class: Aws::Pinpoint::Types::JourneyResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#application_idString

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

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#closed_daysTypes::ClosedDays

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

Returns:



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#creation_dateString

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

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#idString

The unique identifier for the journey.

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#journey_channel_settingsTypes::JourneyChannelSettings

Amazon Resource Name (ARN) of the Connect Campaign.



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#last_modified_dateString

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

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#limitsTypes::JourneyLimits

The messaging and entry limits for the journey.



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#local_timeBoolean

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.

Returns:

  • (Boolean)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#nameString

The name of the journey.

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#open_hoursTypes::OpenHours

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

Returns:



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#quiet_timeTypes::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:



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#refresh_frequencyString

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

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

class JourneyResponse < Struct.new(
  :activities,
  :application_id,
  :creation_date,
  :id,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :tags,
  :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_updateBoolean

Returns:

  • (Boolean)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#scheduleTypes::JourneySchedule

The schedule settings for the journey.



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#sending_scheduleBoolean

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)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#start_activityString

The unique identifier for the first activity in the journey.

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#start_conditionTypes::StartCondition

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



12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#stateString

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.

  • PAUSED - The journey has been paused. Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete.

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

Returns:

  • (String)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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

#tagsHash<String,String>

This object is not used or supported.

Returns:

  • (Hash<String,String>)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

class JourneyResponse < Struct.new(
  :activities,
  :application_id,
  :creation_date,
  :id,
  :last_modified_date,
  :limits,
  :local_time,
  :name,
  :quiet_time,
  :refresh_frequency,
  :schedule,
  :start_activity,
  :start_condition,
  :state,
  :tags,
  :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_timeBoolean

Returns:

  • (Boolean)


12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12153

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