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

Description

Documentation

data JourneyLimits Source #

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

See: newJourneyLimits smart constructor.

Constructors

JourneyLimits'

Fields

messagesPerSecond :: Maybe Int
The maximum number of messages that the journey can send each second.
endpointReentryCap :: Maybe Int
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
endpointReentryInterval :: Maybe Text
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
dailyCap :: Maybe Int
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

Instances

Instances details

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

newJourneyLimits :: JourneyLimits Source #

Create a value of JourneyLimits 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:messagesPerSecond:JourneyLimits', journeyLimits_messagesPerSecond - The maximum number of messages that the journey can send each second.

$sel:endpointReentryCap:JourneyLimits', journeyLimits_endpointReentryCap - The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

$sel:endpointReentryInterval:JourneyLimits', journeyLimits_endpointReentryInterval - Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

$sel:dailyCap:JourneyLimits', journeyLimits_dailyCap - The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

journeyLimits_messagesPerSecond :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of messages that the journey can send each second.

journeyLimits_endpointReentryCap :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

journeyLimits_endpointReentryInterval :: Lens' JourneyLimits (Maybe Text) Source #

Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

journeyLimits_dailyCap :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.