Amazonka.Pinpoint.Types.CampaignResponse

Documentation

data CampaignResponse

Provides information about the status, configuration, and other settings for a campaign.

See: newCampaignResponse smart constructor.

Constructors

CampaignResponse'

Fields

• additionalTreatments :: Maybe [TreatmentResource]

  An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

• customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration

  The delivery configuration settings for sending the campaign through a custom channel.

• defaultState :: Maybe CampaignState

  The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

• description :: Maybe Text

  The 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 use 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 the campaign is paused. 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

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

• state :: Maybe CampaignState

  The current status of the campaign.

• templateConfiguration :: Maybe TemplateConfiguration

  The message template that’s used for the campaign.

• treatmentDescription :: Maybe Text

  The custom description of the default treatment for the campaign.

• treatmentName :: Maybe Text

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

• version :: Maybe Int

  The version number of the campaign.

• tags :: Maybe (HashMap Text Text)

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

• lastModifiedDate :: Text

  The date, in ISO 8601 format, when the campaign was last modified.

• creationDate :: Text

  The date, in ISO 8601 format, when the campaign was created.

• segmentId :: Text

  The unique identifier for the segment that's associated with the campaign.

• segmentVersion :: Int

  The version number of the segment that's associated with the campaign.

• id :: Text

  The unique identifier for the campaign.

• arn :: Text

  The Amazon Resource Name (ARN) of the campaign.

• applicationId :: Text

  The unique identifier for the application that the campaign applies to.

Instances

FromJSON CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Methods

parseJSON :: Value -> Parser CampaignResponse

parseJSONList :: Value -> Parser [CampaignResponse]

Generic CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Associated Types

type Rep CampaignResponse :: Type -> Type

Methods

from :: CampaignResponse -> Rep CampaignResponse x

to :: Rep CampaignResponse x -> CampaignResponse

Read CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Methods

readsPrec :: Int -> ReadS CampaignResponse

readList :: ReadS [CampaignResponse]

readPrec :: ReadPrec CampaignResponse

readListPrec :: ReadPrec [CampaignResponse]

Show CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Methods

showsPrec :: Int -> CampaignResponse -> ShowS

show :: CampaignResponse -> String

showList :: [CampaignResponse] -> ShowS

NFData CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Methods

rnf :: CampaignResponse -> ()

Eq CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Methods

(==) :: CampaignResponse -> CampaignResponse -> Bool

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

Hashable CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Methods

hashWithSalt :: Int -> CampaignResponse -> Int

hash :: CampaignResponse -> Int

type Rep CampaignResponse

Defined in Amazonka.Pinpoint.Types.CampaignResponse

type Rep CampaignResponse = D1 ('MetaData "CampaignResponse" "Amazonka.Pinpoint.Types.CampaignResponse" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "CampaignResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "additionalTreatments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TreatmentResource])) :*: (S1 ('MetaSel ('Just "customDeliveryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDeliveryConfiguration)) :*: S1 ('MetaSel ('Just "defaultState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignState)))) :*: (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 "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 "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :*: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "segmentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCampaignResponse

Arguments

:: Text

$sel:lastModifiedDate:CampaignResponse'

-> Text

$sel:creationDate:CampaignResponse'

-> Text

$sel:segmentId:CampaignResponse'

-> Int

$sel:segmentVersion:CampaignResponse'

-> Text

CampaignResponse

-> Text

$sel:arn:CampaignResponse'

-> Text

$sel:applicationId:CampaignResponse'

-> CampaignResponse

Create a value of CampaignResponse 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:CampaignResponse', campaignResponse_additionalTreatments - An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

CampaignResponse, campaignResponse_customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel.

$sel:defaultState:CampaignResponse', campaignResponse_defaultState - The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

$sel:description:CampaignResponse', campaignResponse_description - The custom description of the campaign.

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

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

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

$sel:limits:CampaignResponse', campaignResponse_limits - The messaging limits for the campaign.

CampaignResponse, campaignResponse_messageConfiguration - The message configuration settings for the campaign.

$sel:name:CampaignResponse', campaignResponse_name - The name of the campaign.

$sel:priority:CampaignResponse', campaignResponse_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.

CampaignResponse, campaignResponse_schedule - The schedule settings for the campaign.

CampaignResponse, campaignResponse_state - The current status of the campaign.

CampaignResponse, campaignResponse_templateConfiguration - The message template that’s used for the campaign.

CampaignResponse, campaignResponse_treatmentDescription - The custom description of the default treatment for the campaign.

CampaignResponse, campaignResponse_treatmentName - The 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:version:CampaignResponse', campaignResponse_version - The version number of the campaign.

$sel:tags:CampaignResponse', campaignResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

$sel:lastModifiedDate:CampaignResponse', campaignResponse_lastModifiedDate - The date, in ISO 8601 format, when the campaign was last modified.

$sel:creationDate:CampaignResponse', campaignResponse_creationDate - The date, in ISO 8601 format, when the campaign was created.

$sel:segmentId:CampaignResponse', campaignResponse_segmentId - The unique identifier for the segment that's associated with the campaign.

$sel:segmentVersion:CampaignResponse', campaignResponse_segmentVersion - The version number of the segment that's associated with the campaign.

CampaignResponse, campaignResponse_id - The unique identifier for the campaign.

$sel:arn:CampaignResponse', campaignResponse_arn - The Amazon Resource Name (ARN) of the campaign.

$sel:applicationId:CampaignResponse', campaignResponse_applicationId - The unique identifier for the application that the campaign applies to.

campaignResponse_additionalTreatments :: Lens' CampaignResponse (Maybe [TreatmentResource])

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

campaignResponse_customDeliveryConfiguration :: Lens' CampaignResponse (Maybe CustomDeliveryConfiguration)

The delivery configuration settings for sending the campaign through a custom channel.

campaignResponse_defaultState :: Lens' CampaignResponse (Maybe CampaignState)

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

campaignResponse_description :: Lens' CampaignResponse (Maybe Text)

The custom description of the campaign.

campaignResponse_holdoutPercent :: Lens' CampaignResponse (Maybe Int)

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

campaignResponse_hook :: Lens' CampaignResponse (Maybe CampaignHook)

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

campaignResponse_isPaused :: Lens' CampaignResponse (Maybe Bool)

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

campaignResponse_limits :: Lens' CampaignResponse (Maybe CampaignLimits)

The messaging limits for the campaign.

campaignResponse_messageConfiguration :: Lens' CampaignResponse (Maybe MessageConfiguration)

The message configuration settings for the campaign.

campaignResponse_name :: Lens' CampaignResponse (Maybe Text)

The name of the campaign.

campaignResponse_priority :: Lens' CampaignResponse (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.

campaignResponse_schedule :: Lens' CampaignResponse (Maybe Schedule)

The schedule settings for the campaign.

campaignResponse_state :: Lens' CampaignResponse (Maybe CampaignState)

The current status of the campaign.

campaignResponse_templateConfiguration :: Lens' CampaignResponse (Maybe TemplateConfiguration)

The message template that’s used for the campaign.

campaignResponse_treatmentDescription :: Lens' CampaignResponse (Maybe Text)

The custom description of the default treatment for the campaign.

campaignResponse_treatmentName :: Lens' CampaignResponse (Maybe Text)

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

campaignResponse_version :: Lens' CampaignResponse (Maybe Int)

The version number of the campaign.

campaignResponse_tags :: Lens' CampaignResponse (Maybe (HashMap Text Text))

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

campaignResponse_lastModifiedDate :: Lens' CampaignResponse Text

The date, in ISO 8601 format, when the campaign was last modified.

campaignResponse_creationDate :: Lens' CampaignResponse Text

The date, in ISO 8601 format, when the campaign was created.

campaignResponse_segmentId :: Lens' CampaignResponse Text

The unique identifier for the segment that's associated with the campaign.

campaignResponse_segmentVersion :: Lens' CampaignResponse Int

The version number of the segment that's associated with the campaign.

campaignResponse_id :: Lens' CampaignResponse Text

The unique identifier for the campaign.

campaignResponse_arn :: Lens' CampaignResponse Text

The Amazon Resource Name (ARN) of the campaign.

campaignResponse_applicationId :: Lens' CampaignResponse Text

The unique identifier for the application that the campaign applies to.