Amazonka.Pinpoint.Types.TreatmentResource

Documentation

data TreatmentResource

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.

• messageConfiguration :: Maybe MessageConfiguration

  The message configuration settings for the treatment.

• schedule :: Maybe Schedule

  The schedule settings for the treatment.

• state :: Maybe CampaignState

  The current status of the treatment.

• templateConfiguration :: Maybe TemplateConfiguration

  The message template to use for the treatment.

• treatmentDescription :: Maybe Text

  The custom description of the treatment.

• treatmentName :: Maybe Text

  The custom name of 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

FromJSON TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Methods

parseJSON :: Value -> Parser TreatmentResource

parseJSONList :: Value -> Parser [TreatmentResource]

Generic TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Associated Types

type Rep TreatmentResource :: Type -> Type

Methods

from :: TreatmentResource -> Rep TreatmentResource x

to :: Rep TreatmentResource x -> TreatmentResource

Read TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Methods

readsPrec :: Int -> ReadS TreatmentResource

readList :: ReadS [TreatmentResource]

readPrec :: ReadPrec TreatmentResource

readListPrec :: ReadPrec [TreatmentResource]

Show TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Methods

showsPrec :: Int -> TreatmentResource -> ShowS

show :: TreatmentResource -> String

showList :: [TreatmentResource] -> ShowS

NFData TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Methods

rnf :: TreatmentResource -> ()

Eq TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Methods

(==) :: TreatmentResource -> TreatmentResource -> Bool

(/=) :: TreatmentResource -> TreatmentResource -> Bool

Hashable TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Methods

hashWithSalt :: Int -> TreatmentResource -> Int

hash :: TreatmentResource -> Int

type Rep TreatmentResource

Defined in Amazonka.Pinpoint.Types.TreatmentResource

type Rep TreatmentResource = D1 ('MetaData "TreatmentResource" "Amazonka.Pinpoint.Types.TreatmentResource" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "TreatmentResource'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customDeliveryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDeliveryConfiguration)) :*: S1 ('MetaSel ('Just "messageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageConfiguration))) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignState)))) :*: ((S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)) :*: S1 ('MetaSel ('Just "treatmentDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "treatmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sizePercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newTreatmentResource

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:messageConfiguration:TreatmentResource', treatmentResource_messageConfiguration - The message configuration settings for the treatment.

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

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

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

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

$sel:treatmentName:TreatmentResource', treatmentResource_treatmentName - The custom name of 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)

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_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration)

The message configuration settings for the treatment.

treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule)

The schedule settings for the treatment.

treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState)

The current status of the treatment.

treatmentResource_templateConfiguration :: Lens' TreatmentResource (Maybe TemplateConfiguration)

The message template to use for the treatment.

treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text)

The custom description of the treatment.

treatmentResource_treatmentName :: Lens' TreatmentResource (Maybe Text)

The custom name of the treatment.

treatmentResource_id :: Lens' TreatmentResource Text

The unique identifier for the treatment.

treatmentResource_sizePercent :: Lens' TreatmentResource Int

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