libZSservicesZSamazonka-personalizeZSamazonka-personalize
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Personalize.Types.CampaignSummary

Description

 
Synopsis

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

Instances

Instances details
Eq CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

Read CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

Show CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

Generic CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

Associated Types

type Rep CampaignSummary :: Type -> Type #

NFData CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

Methods

rnf :: CampaignSummary -> () #

Hashable CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

FromJSON CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

type Rep CampaignSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.CampaignSummary

type Rep CampaignSummary = D1 ('MetaData "CampaignSummary" "Amazonka.Personalize.Types.CampaignSummary" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CampaignSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") '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 "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "campaignArn") '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:failureReason:CampaignSummary', campaignSummary_failureReason - If a campaign fails, the reason behind the failure.

$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

$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:creationDateTime:CampaignSummary', campaignSummary_creationDateTime - The date and time (in Unix time) that the campaign was created.

$sel:campaignArn:CampaignSummary', campaignSummary_campaignArn - The Amazon Resource Name (ARN) of the campaign.

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

If a campaign fails, the reason behind the failure.

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

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

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

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

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

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

The Amazon Resource Name (ARN) of the campaign.