Amazonka.Pinpoint.Types.WriteCampaignRequest

Documentation

data WriteCampaignRequest

Specifies the configuration and other settings for a campaign.

See: newWriteCampaignRequest smart constructor.

Constructors

WriteCampaignRequest'

Fields

• additionalTreatments :: Maybe [WriteTreatmentResource]

  An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

• customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration

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

• description :: Maybe Text

  A custom description of the campaign.

• holdoutPercent :: Maybe Int

  The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

• hook :: Maybe CampaignHook

  The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

• isPaused :: Maybe Bool

  Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

• limits :: Maybe CampaignLimits

  The messaging limits for the campaign.

• messageConfiguration :: Maybe MessageConfiguration

  The message configuration settings for the campaign.

• name :: Maybe Text

  A custom name for the campaign.

• priority :: Maybe Int

  Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

• schedule :: Maybe Schedule

  The schedule settings for the campaign.

• segmentId :: Maybe Text

  The unique identifier for the segment to associate with the campaign.

• segmentVersion :: Maybe Int

  The version of the segment to associate with the campaign.

• templateConfiguration :: Maybe TemplateConfiguration

  The message template to use for the campaign.

• treatmentDescription :: Maybe Text

  A custom description of the default treatment for the campaign.

• treatmentName :: Maybe Text

  A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

• tags :: Maybe (HashMap Text Text)

  A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

Instances

ToJSON WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Methods

toJSON :: WriteCampaignRequest -> Value

toEncoding :: WriteCampaignRequest -> Encoding

toJSONList :: [WriteCampaignRequest] -> Value

toEncodingList :: [WriteCampaignRequest] -> Encoding

Generic WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Associated Types

type Rep WriteCampaignRequest :: Type -> Type

Methods

from :: WriteCampaignRequest -> Rep WriteCampaignRequest x

to :: Rep WriteCampaignRequest x -> WriteCampaignRequest

Read WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Methods

readsPrec :: Int -> ReadS WriteCampaignRequest

readList :: ReadS [WriteCampaignRequest]

readPrec :: ReadPrec WriteCampaignRequest

readListPrec :: ReadPrec [WriteCampaignRequest]

Show WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Methods

showsPrec :: Int -> WriteCampaignRequest -> ShowS

show :: WriteCampaignRequest -> String

showList :: [WriteCampaignRequest] -> ShowS

NFData WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Methods

rnf :: WriteCampaignRequest -> ()

Eq WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Methods

(==) :: WriteCampaignRequest -> WriteCampaignRequest -> Bool

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

Hashable WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Methods

hashWithSalt :: Int -> WriteCampaignRequest -> Int

hash :: WriteCampaignRequest -> Int

type Rep WriteCampaignRequest

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

type Rep WriteCampaignRequest = D1 ('MetaData "WriteCampaignRequest" "Amazonka.Pinpoint.Types.WriteCampaignRequest" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "WriteCampaignRequest'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "additionalTreatments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WriteTreatmentResource])) :*: S1 ('MetaSel ('Just "customDeliveryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDeliveryConfiguration))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "holdoutPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "hook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignHook)) :*: S1 ('MetaSel ('Just "isPaused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignLimits)) :*: S1 ('MetaSel ('Just "messageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageConfiguration))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule)) :*: S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "segmentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: 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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newWriteCampaignRequest :: WriteCampaignRequest

Create a value of WriteCampaignRequest 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:additionalTreatments:WriteCampaignRequest', writeCampaignRequest_additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

WriteCampaignRequest, writeCampaignRequest_customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

$sel:description:WriteCampaignRequest', writeCampaignRequest_description - A custom description of the campaign.

$sel:holdoutPercent:WriteCampaignRequest', writeCampaignRequest_holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

$sel:hook:WriteCampaignRequest', writeCampaignRequest_hook - The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

$sel:isPaused:WriteCampaignRequest', writeCampaignRequest_isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

$sel:limits:WriteCampaignRequest', writeCampaignRequest_limits - The messaging limits for the campaign.

WriteCampaignRequest, writeCampaignRequest_messageConfiguration - The message configuration settings for the campaign.

$sel:name:WriteCampaignRequest', writeCampaignRequest_name - A custom name for the campaign.

$sel:priority:WriteCampaignRequest', writeCampaignRequest_priority - Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

WriteCampaignRequest, writeCampaignRequest_schedule - The schedule settings for the campaign.

$sel:segmentId:WriteCampaignRequest', writeCampaignRequest_segmentId - The unique identifier for the segment to associate with the campaign.

$sel:segmentVersion:WriteCampaignRequest', writeCampaignRequest_segmentVersion - The version of the segment to associate with the campaign.

WriteCampaignRequest, writeCampaignRequest_templateConfiguration - The message template to use for the campaign.

WriteCampaignRequest, writeCampaignRequest_treatmentDescription - A custom description of the default treatment for the campaign.

WriteCampaignRequest, writeCampaignRequest_treatmentName - A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

$sel:tags:WriteCampaignRequest', writeCampaignRequest_tags - A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

writeCampaignRequest_additionalTreatments :: Lens' WriteCampaignRequest (Maybe [WriteTreatmentResource])

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

writeCampaignRequest_customDeliveryConfiguration :: Lens' WriteCampaignRequest (Maybe CustomDeliveryConfiguration)

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

writeCampaignRequest_description :: Lens' WriteCampaignRequest (Maybe Text)

A custom description of the campaign.

writeCampaignRequest_holdoutPercent :: Lens' WriteCampaignRequest (Maybe Int)

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

writeCampaignRequest_hook :: Lens' WriteCampaignRequest (Maybe CampaignHook)

The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

writeCampaignRequest_isPaused :: Lens' WriteCampaignRequest (Maybe Bool)

Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

writeCampaignRequest_limits :: Lens' WriteCampaignRequest (Maybe CampaignLimits)

The messaging limits for the campaign.

writeCampaignRequest_messageConfiguration :: Lens' WriteCampaignRequest (Maybe MessageConfiguration)

The message configuration settings for the campaign.

writeCampaignRequest_name :: Lens' WriteCampaignRequest (Maybe Text)

A custom name for the campaign.

writeCampaignRequest_priority :: Lens' WriteCampaignRequest (Maybe Int)

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

writeCampaignRequest_schedule :: Lens' WriteCampaignRequest (Maybe Schedule)

The schedule settings for the campaign.

writeCampaignRequest_segmentId :: Lens' WriteCampaignRequest (Maybe Text)

The unique identifier for the segment to associate with the campaign.

writeCampaignRequest_segmentVersion :: Lens' WriteCampaignRequest (Maybe Int)

The version of the segment to associate with the campaign.

writeCampaignRequest_templateConfiguration :: Lens' WriteCampaignRequest (Maybe TemplateConfiguration)

The message template to use for the campaign.

writeCampaignRequest_treatmentDescription :: Lens' WriteCampaignRequest (Maybe Text)

A custom description of the default treatment for the campaign.

writeCampaignRequest_treatmentName :: Lens' WriteCampaignRequest (Maybe Text)

A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

writeCampaignRequest_tags :: Lens' WriteCampaignRequest (Maybe (HashMap Text Text))

A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.