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

Description

Synopsis

data JourneyStateRequest = JourneyStateRequest' {
- state :: Maybe State
}
newJourneyStateRequest :: JourneyStateRequest
journeyStateRequest_state :: Lens' JourneyStateRequest (Maybe State)

Documentation

data JourneyStateRequest Source #

Changes the status of a journey.

See: newJourneyStateRequest smart constructor.

Constructors

JourneyStateRequest'

Fields

state :: Maybe State
The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

Instances

Instances details

Eq JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest Methods (==) :: JourneyStateRequest -> JourneyStateRequest -> Bool # (/=) :: JourneyStateRequest -> JourneyStateRequest -> Bool #
Read JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest Methods readsPrec :: Int -> ReadS JourneyStateRequest # readList :: ReadS [JourneyStateRequest] # readPrec :: ReadPrec JourneyStateRequest # readListPrec :: ReadPrec [JourneyStateRequest] #
Show JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest Methods showsPrec :: Int -> JourneyStateRequest -> ShowS # show :: JourneyStateRequest -> String # showList :: [JourneyStateRequest] -> ShowS #
Generic JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest Associated Types type Rep JourneyStateRequest :: Type -> Type # Methods from :: JourneyStateRequest -> Rep JourneyStateRequest x # to :: Rep JourneyStateRequest x -> JourneyStateRequest #
NFData JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest Methods rnf :: JourneyStateRequest -> () #
Hashable JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest Methods hashWithSalt :: Int -> JourneyStateRequest -> Int # hash :: JourneyStateRequest -> Int #
ToJSON JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest Methods toJSON :: JourneyStateRequest -> Value # toEncoding :: JourneyStateRequest -> Encoding # toJSONList :: [JourneyStateRequest] -> Value # toEncodingList :: [JourneyStateRequest] -> Encoding #
type Rep JourneyStateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.JourneyStateRequest type Rep JourneyStateRequest = D1 ('MetaData "JourneyStateRequest" "Amazonka.Pinpoint.Types.JourneyStateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyStateRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State))))

newJourneyStateRequest :: JourneyStateRequest Source #

Create a value of JourneyStateRequest 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:JourneyStateRequest', journeyStateRequest_state - The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED

If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

journeyStateRequest_state :: Lens' JourneyStateRequest (Maybe State) Source #

The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED

If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.