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

Description

Synopsis

data TreatmentResource = TreatmentResource' {
- customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
- state :: Maybe CampaignState
- schedule :: Maybe Schedule
- templateConfiguration :: Maybe TemplateConfiguration
- treatmentName :: Maybe Text
- treatmentDescription :: Maybe Text
- messageConfiguration :: Maybe MessageConfiguration
- id :: Text
- sizePercent :: Int
}
newTreatmentResource :: Text -> Int -> TreatmentResource
treatmentResource_customDeliveryConfiguration :: Lens' TreatmentResource (Maybe CustomDeliveryConfiguration)
treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState)
treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule)
treatmentResource_templateConfiguration :: Lens' TreatmentResource (Maybe TemplateConfiguration)
treatmentResource_treatmentName :: Lens' TreatmentResource (Maybe Text)
treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text)
treatmentResource_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration)
treatmentResource_id :: Lens' TreatmentResource Text
treatmentResource_sizePercent :: Lens' TreatmentResource Int

Documentation

data TreatmentResource Source #

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

See: newTreatmentResource smart constructor.

Constructors

TreatmentResource'

Fields

customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
state :: Maybe CampaignState
The current status of the treatment.
schedule :: Maybe Schedule
The schedule settings for the treatment.
templateConfiguration :: Maybe TemplateConfiguration
The message template to use for the treatment.
treatmentName :: Maybe Text
The custom name of the treatment.
treatmentDescription :: Maybe Text
The custom description of the treatment.
messageConfiguration :: Maybe MessageConfiguration
The message configuration settings for the treatment.
id :: Text
The unique identifier for the treatment.
sizePercent :: Int
The allocated percentage of users (segment members) that the treatment is sent to.

Instances

Instances details

Eq TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource Methods (==) :: TreatmentResource -> TreatmentResource -> Bool # (/=) :: TreatmentResource -> TreatmentResource -> Bool #
Read TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource Methods readsPrec :: Int -> ReadS TreatmentResource # readList :: ReadS [TreatmentResource] # readPrec :: ReadPrec TreatmentResource # readListPrec :: ReadPrec [TreatmentResource] #
Show TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource Methods showsPrec :: Int -> TreatmentResource -> ShowS # show :: TreatmentResource -> String # showList :: [TreatmentResource] -> ShowS #
Generic TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource Associated Types type Rep TreatmentResource :: Type -> Type # Methods from :: TreatmentResource -> Rep TreatmentResource x # to :: Rep TreatmentResource x -> TreatmentResource #
NFData TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource Methods rnf :: TreatmentResource -> () #
Hashable TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource Methods hashWithSalt :: Int -> TreatmentResource -> Int # hash :: TreatmentResource -> Int #
FromJSON TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource Methods parseJSON :: Value -> Parser TreatmentResource # parseJSONList :: Value -> Parser [TreatmentResource] #
type Rep TreatmentResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.TreatmentResource type Rep TreatmentResource = D1 ('MetaData "TreatmentResource" "Amazonka.Pinpoint.Types.TreatmentResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TreatmentResource'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customDeliveryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDeliveryConfiguration)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignState))) :: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule)) :: S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)))) :: ((S1 ('MetaSel ('Just "treatmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "treatmentDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "messageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageConfiguration)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sizePercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newTreatmentResource Source #

Arguments

:: Text	`$sel:id:TreatmentResource'`
-> Int	`$sel:sizePercent:TreatmentResource'`
-> TreatmentResource

Create a value of TreatmentResource 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:customDeliveryConfiguration:TreatmentResource', treatmentResource_customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

$sel:state:TreatmentResource', treatmentResource_state - The current status of the treatment.

$sel:schedule:TreatmentResource', treatmentResource_schedule - The schedule settings for the treatment.

$sel:templateConfiguration:TreatmentResource', treatmentResource_templateConfiguration - The message template to use for the treatment.

$sel:treatmentName:TreatmentResource', treatmentResource_treatmentName - The custom name of the treatment.

$sel:treatmentDescription:TreatmentResource', treatmentResource_treatmentDescription - The custom description of the treatment.

$sel:messageConfiguration:TreatmentResource', treatmentResource_messageConfiguration - The message configuration settings for the treatment.

$sel:id:TreatmentResource', treatmentResource_id - The unique identifier for the treatment.

$sel:sizePercent:TreatmentResource', treatmentResource_sizePercent - The allocated percentage of users (segment members) that the treatment is sent to.

treatmentResource_customDeliveryConfiguration :: Lens' TreatmentResource (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState) Source #

The current status of the treatment.

treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule) Source #

The schedule settings for the treatment.

treatmentResource_templateConfiguration :: Lens' TreatmentResource (Maybe TemplateConfiguration) Source #

The message template to use for the treatment.

treatmentResource_treatmentName :: Lens' TreatmentResource (Maybe Text) Source #

The custom name of the treatment.

treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text) Source #

The custom description of the treatment.

treatmentResource_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration) Source #

The message configuration settings for the treatment.

treatmentResource_id :: Lens' TreatmentResource Text Source #

The unique identifier for the treatment.

treatmentResource_sizePercent :: Lens' TreatmentResource Int Source #

The allocated percentage of users (segment members) that the treatment is sent to.