Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.WriteJourneyRequest

Description

Synopsis

data WriteJourneyRequest = WriteJourneyRequest' {
- state :: Maybe State
- lastModifiedDate :: Maybe Text
- schedule :: Maybe JourneySchedule
- localTime :: Maybe Bool
- activities :: Maybe (HashMap Text Activity)
- refreshOnSegmentUpdate :: Maybe Bool
- limits :: Maybe JourneyLimits
- waitForQuietTime :: Maybe Bool
- quietTime :: Maybe QuietTime
- startActivity :: Maybe Text
- creationDate :: Maybe Text
- startCondition :: Maybe StartCondition
- refreshFrequency :: Maybe Text
- name :: Text
}
newWriteJourneyRequest :: Text -> WriteJourneyRequest
writeJourneyRequest_state :: Lens' WriteJourneyRequest (Maybe State)
writeJourneyRequest_lastModifiedDate :: Lens' WriteJourneyRequest (Maybe Text)
writeJourneyRequest_schedule :: Lens' WriteJourneyRequest (Maybe JourneySchedule)
writeJourneyRequest_localTime :: Lens' WriteJourneyRequest (Maybe Bool)
writeJourneyRequest_activities :: Lens' WriteJourneyRequest (Maybe (HashMap Text Activity))
writeJourneyRequest_refreshOnSegmentUpdate :: Lens' WriteJourneyRequest (Maybe Bool)
writeJourneyRequest_limits :: Lens' WriteJourneyRequest (Maybe JourneyLimits)
writeJourneyRequest_waitForQuietTime :: Lens' WriteJourneyRequest (Maybe Bool)
writeJourneyRequest_quietTime :: Lens' WriteJourneyRequest (Maybe QuietTime)
writeJourneyRequest_startActivity :: Lens' WriteJourneyRequest (Maybe Text)
writeJourneyRequest_creationDate :: Lens' WriteJourneyRequest (Maybe Text)
writeJourneyRequest_startCondition :: Lens' WriteJourneyRequest (Maybe StartCondition)
writeJourneyRequest_refreshFrequency :: Lens' WriteJourneyRequest (Maybe Text)
writeJourneyRequest_name :: Lens' WriteJourneyRequest Text

Documentation

data WriteJourneyRequest Source #

Specifies the configuration and other settings for a journey.

See: newWriteJourneyRequest smart constructor.

Constructors

WriteJourneyRequest'

Fields

state :: Maybe State
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.
lastModifiedDate :: Maybe Text
The date, in ISO 8601 format, when the journey was last modified.
schedule :: Maybe JourneySchedule
The schedule settings for the journey.
localTime :: Maybe Bool
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.
activities :: Maybe (HashMap Text 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.
refreshOnSegmentUpdate :: Maybe Bool
Specifies whether a journey should be refreshed on segment update.
limits :: Maybe JourneyLimits
The messaging and entry limits for the journey.
waitForQuietTime :: Maybe Bool
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
quietTime :: Maybe 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.
startActivity :: Maybe Text
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.
creationDate :: Maybe Text
The date, in ISO 8601 format, when the journey was created.
startCondition :: Maybe StartCondition
The segment that defines which users are participants in the journey.
refreshFrequency :: Maybe Text
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
name :: Text
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.

Instances

Instances details

Eq WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest Methods (==) :: WriteJourneyRequest -> WriteJourneyRequest -> Bool # (/=) :: WriteJourneyRequest -> WriteJourneyRequest -> Bool #
Read WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest Methods readsPrec :: Int -> ReadS WriteJourneyRequest # readList :: ReadS [WriteJourneyRequest] # readPrec :: ReadPrec WriteJourneyRequest # readListPrec :: ReadPrec [WriteJourneyRequest] #
Show WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest Methods showsPrec :: Int -> WriteJourneyRequest -> ShowS # show :: WriteJourneyRequest -> String # showList :: [WriteJourneyRequest] -> ShowS #
Generic WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest Associated Types type Rep WriteJourneyRequest :: Type -> Type # Methods from :: WriteJourneyRequest -> Rep WriteJourneyRequest x # to :: Rep WriteJourneyRequest x -> WriteJourneyRequest #
NFData WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest Methods rnf :: WriteJourneyRequest -> () #
Hashable WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest Methods hashWithSalt :: Int -> WriteJourneyRequest -> Int # hash :: WriteJourneyRequest -> Int #
ToJSON WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest Methods toJSON :: WriteJourneyRequest -> Value # toEncoding :: WriteJourneyRequest -> Encoding # toJSONList :: [WriteJourneyRequest] -> Value # toEncodingList :: [WriteJourneyRequest] -> Encoding #
type Rep WriteJourneyRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest type Rep WriteJourneyRequest = D1 ('MetaData "WriteJourneyRequest" "Amazonka.Pinpoint.Types.WriteJourneyRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WriteJourneyRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State)) :: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneySchedule)))) :: ((S1 ('MetaSel ('Just "localTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "activities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Activity)))) :: (S1 ('MetaSel ('Just "refreshOnSegmentUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyLimits))))) :: ((S1 ('MetaSel ('Just "waitForQuietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime)) :: S1 ('MetaSel ('Just "startActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartCondition))) :: (S1 ('MetaSel ('Just "refreshFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newWriteJourneyRequest Source #

Arguments

:: Text	`$sel:name:WriteJourneyRequest'`
-> WriteJourneyRequest

Create a value of WriteJourneyRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:state:WriteJourneyRequest', writeJourneyRequest_state - 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.

$sel:lastModifiedDate:WriteJourneyRequest', writeJourneyRequest_lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.

$sel:schedule:WriteJourneyRequest', writeJourneyRequest_schedule - The schedule settings for the journey.

$sel:localTime:WriteJourneyRequest', writeJourneyRequest_localTime - 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.

$sel:activities:WriteJourneyRequest', writeJourneyRequest_activities - 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.

$sel:refreshOnSegmentUpdate:WriteJourneyRequest', writeJourneyRequest_refreshOnSegmentUpdate - Specifies whether a journey should be refreshed on segment update.

$sel:limits:WriteJourneyRequest', writeJourneyRequest_limits - The messaging and entry limits for the journey.

$sel:waitForQuietTime:WriteJourneyRequest', writeJourneyRequest_waitForQuietTime - Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

$sel:quietTime:WriteJourneyRequest', writeJourneyRequest_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.

$sel:startActivity:WriteJourneyRequest', writeJourneyRequest_startActivity - 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.

$sel:creationDate:WriteJourneyRequest', writeJourneyRequest_creationDate - The date, in ISO 8601 format, when the journey was created.

$sel:startCondition:WriteJourneyRequest', writeJourneyRequest_startCondition - The segment that defines which users are participants in the journey.

$sel:refreshFrequency:WriteJourneyRequest', writeJourneyRequest_refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

$sel:name:WriteJourneyRequest', writeJourneyRequest_name - 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.

writeJourneyRequest_state :: Lens' WriteJourneyRequest (Maybe State) Source #

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.

writeJourneyRequest_lastModifiedDate :: Lens' WriteJourneyRequest (Maybe Text) Source #

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

writeJourneyRequest_schedule :: Lens' WriteJourneyRequest (Maybe JourneySchedule) Source #

The schedule settings for the journey.

writeJourneyRequest_localTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #

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.

writeJourneyRequest_activities :: Lens' WriteJourneyRequest (Maybe (HashMap Text Activity)) Source #

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.

writeJourneyRequest_refreshOnSegmentUpdate :: Lens' WriteJourneyRequest (Maybe Bool) Source #

Specifies whether a journey should be refreshed on segment update.

writeJourneyRequest_limits :: Lens' WriteJourneyRequest (Maybe JourneyLimits) Source #

The messaging and entry limits for the journey.

writeJourneyRequest_waitForQuietTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #

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

writeJourneyRequest_quietTime :: Lens' WriteJourneyRequest (Maybe QuietTime) Source #

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.

writeJourneyRequest_startActivity :: Lens' WriteJourneyRequest (Maybe Text) Source #

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.

writeJourneyRequest_creationDate :: Lens' WriteJourneyRequest (Maybe Text) Source #

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

writeJourneyRequest_startCondition :: Lens' WriteJourneyRequest (Maybe StartCondition) Source #

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

writeJourneyRequest_refreshFrequency :: Lens' WriteJourneyRequest (Maybe Text) Source #

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

writeJourneyRequest_name :: Lens' WriteJourneyRequest Text Source #

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.