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.Personalize.Types.CampaignSummary

Description

Documentation

data CampaignSummary Source #

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

See: newCampaignSummary smart constructor.

Constructors

CampaignSummary'

Fields

campaignArn :: Maybe Text
The Amazon Resource Name (ARN) of the campaign.
creationDateTime :: Maybe POSIX
The date and time (in Unix time) that the campaign was created.
failureReason :: Maybe Text
If a campaign fails, the reason behind the failure.
lastUpdatedDateTime :: Maybe POSIX
The date and time (in Unix time) that the campaign was last updated.
name :: Maybe Text
The name of the campaign.
status :: Maybe Text
The status of the campaign.
A campaign can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS

Instances

Instances details

FromJSON CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary Methods parseJSON :: Value -> Parser CampaignSummary # parseJSONList :: Value -> Parser [CampaignSummary] #
Generic CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary Associated Types type Rep CampaignSummary :: Type -> Type # Methods from :: CampaignSummary -> Rep CampaignSummary x # to :: Rep CampaignSummary x -> CampaignSummary #
Read CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary Methods readsPrec :: Int -> ReadS CampaignSummary # readList :: ReadS [CampaignSummary] # readPrec :: ReadPrec CampaignSummary # readListPrec :: ReadPrec [CampaignSummary] #
Show CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary Methods showsPrec :: Int -> CampaignSummary -> ShowS # show :: CampaignSummary -> String # showList :: [CampaignSummary] -> ShowS #
NFData CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary Methods rnf :: CampaignSummary -> () #
Eq CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary Methods (==) :: CampaignSummary -> CampaignSummary -> Bool # (/=) :: CampaignSummary -> CampaignSummary -> Bool #
Hashable CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary Methods hashWithSalt :: Int -> CampaignSummary -> Int # hash :: CampaignSummary -> Int #
type Rep CampaignSummary Source #
Instance details Defined in Amazonka.Personalize.Types.CampaignSummary type Rep CampaignSummary = D1 ('MetaData "CampaignSummary" "Amazonka.Personalize.Types.CampaignSummary" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CampaignSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "campaignArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCampaignSummary :: CampaignSummary Source #

Create a value of CampaignSummary 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:campaignArn:CampaignSummary', campaignSummary_campaignArn - The Amazon Resource Name (ARN) of the campaign.

$sel:creationDateTime:CampaignSummary', campaignSummary_creationDateTime - The date and time (in Unix time) that the campaign was created.

$sel:failureReason:CampaignSummary', campaignSummary_failureReason - If a campaign fails, the reason behind the failure.

$sel:lastUpdatedDateTime:CampaignSummary', campaignSummary_lastUpdatedDateTime - The date and time (in Unix time) that the campaign was last updated.

$sel:name:CampaignSummary', campaignSummary_name - The name of the campaign.

$sel:status:CampaignSummary', campaignSummary_status - The status of the campaign.

A campaign can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS

campaignSummary_campaignArn :: Lens' CampaignSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

campaignSummary_creationDateTime :: Lens' CampaignSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the campaign was created.

campaignSummary_failureReason :: Lens' CampaignSummary (Maybe Text) Source #

If a campaign fails, the reason behind the failure.

campaignSummary_lastUpdatedDateTime :: Lens' CampaignSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the campaign was last updated.

campaignSummary_name :: Lens' CampaignSummary (Maybe Text) Source #

The name of the campaign.

campaignSummary_status :: Lens' CampaignSummary (Maybe Text) Source #

The status of the campaign.

A campaign can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS