Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.Types.CampaignState

Description

Synopsis

data CampaignState = CampaignState' {
- campaignStatus :: Maybe CampaignStatus
}
newCampaignState :: CampaignState
campaignState_campaignStatus :: Lens' CampaignState (Maybe CampaignStatus)

Documentation

data CampaignState Source #

Provides information about the status of a campaign.

See: newCampaignState smart constructor.

Constructors

CampaignState'
Fields campaignStatus :: Maybe CampaignStatus The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

Instances

Instances details

FromJSON CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState Methods parseJSON :: Value -> Parser CampaignState # parseJSONList :: Value -> Parser [CampaignState] #
Generic CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState Associated Types type Rep CampaignState :: Type -> Type # Methods from :: CampaignState -> Rep CampaignState x # to :: Rep CampaignState x -> CampaignState #
Read CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState Methods readsPrec :: Int -> ReadS CampaignState # readList :: ReadS [CampaignState] # readPrec :: ReadPrec CampaignState # readListPrec :: ReadPrec [CampaignState] #
Show CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState Methods showsPrec :: Int -> CampaignState -> ShowS # show :: CampaignState -> String # showList :: [CampaignState] -> ShowS #
NFData CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState Methods rnf :: CampaignState -> () #
Eq CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState Methods (==) :: CampaignState -> CampaignState -> Bool # (/=) :: CampaignState -> CampaignState -> Bool #
Hashable CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState Methods hashWithSalt :: Int -> CampaignState -> Int # hash :: CampaignState -> Int #
type Rep CampaignState Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignState type Rep CampaignState = D1 ('MetaData "CampaignState" "Amazonka.Pinpoint.Types.CampaignState" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "CampaignState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaignStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignStatus))))

newCampaignState :: CampaignState Source #

Create a value of CampaignState 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:campaignStatus:CampaignState', campaignState_campaignStatus - The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

campaignState_campaignStatus :: Lens' CampaignState (Maybe CampaignStatus) Source #

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.