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

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

Overview

Specifies the configuration and other settings for a journey.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ String

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

Returns:

  • (String) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ String

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

Returns:

  • (String) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#limits ⇒ Types::JourneyLimits

The messaging and entry limits for the journey.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_on_segment_update ⇒ Boolean

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

Returns:

  • (Boolean) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::JourneySchedule

The schedule settings for the journey.

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#sending_schedule ⇒ Boolean

Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

Returns:

  • (Boolean) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#start_condition ⇒ Types::StartCondition

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

Returns:



14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  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 <link linkend=“apps-application-id-journeys-journey-id-state” />

Journey State</link> resource.

Returns:

  • (String) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#timezone_estimation_methods ⇒ Array<String>

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.

  • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

  • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

    <note markdown=“1”>POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

    </note>

[1]: docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html

Returns:

  • (Array<String>) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end

#wait_for_quiet_time ⇒ Boolean

Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.

Returns:

  • (Boolean) 


14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14001

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,
  :timezone_estimation_methods)
  SENSITIVE = []
  include Aws::Structure
end