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

Inherits:
Struct
  • Object
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

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. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

Returns:



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_daysTypes::ClosedDays

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

Returns:



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_dateString

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

Returns:

  • (String)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_settingsTypes::JourneyChannelSettings

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



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_dateString

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

Returns:

  • (String)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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

#limitsTypes::JourneyLimits

The messaging and entry limits for the journey.



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_timeBoolean

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)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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

#nameString

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)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_hoursTypes::OpenHours

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

Returns:



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_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:



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_frequencyString

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

Returns:

  • (String)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_updateBoolean

Returns:

  • (Boolean)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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

#scheduleTypes::JourneySchedule

The schedule settings for the journey.



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_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)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_activityString

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)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_conditionTypes::StartCondition

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



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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

#stateString

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)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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_timeBoolean

Returns:

  • (Boolean)


13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
# 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