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

Description

Synopsis

data HoldoutActivity = HoldoutActivity' {
- nextActivity :: Maybe Text
- percentage :: Int
}
newHoldoutActivity :: Int -> HoldoutActivity
holdoutActivity_nextActivity :: Lens' HoldoutActivity (Maybe Text)
holdoutActivity_percentage :: Lens' HoldoutActivity Int

Documentation

data HoldoutActivity Source #

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

See: newHoldoutActivity smart constructor.

Constructors

HoldoutActivity'

Fields

nextActivity :: Maybe Text
The unique identifier for the next activity to perform, after performing the holdout activity.
percentage :: Int
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

Instances

Instances details

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

newHoldoutActivity Source #

Arguments

:: Int	`$sel:percentage:HoldoutActivity'`
-> HoldoutActivity

Create a value of HoldoutActivity 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:nextActivity:HoldoutActivity', holdoutActivity_nextActivity - The unique identifier for the next activity to perform, after performing the holdout activity.

$sel:percentage:HoldoutActivity', holdoutActivity_percentage - The percentage of participants who shouldn't continue the journey.

To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

holdoutActivity_nextActivity :: Lens' HoldoutActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after performing the holdout activity.

holdoutActivity_percentage :: Lens' HoldoutActivity Int Source #

The percentage of participants who shouldn't continue the journey.

To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.