Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Personalize.Types.Campaign

Description

Synopsis

data Campaign = Campaign' {
- failureReason :: Maybe Text
- status :: Maybe Text
- lastUpdatedDateTime :: Maybe POSIX
- campaignConfig :: Maybe CampaignConfig
- latestCampaignUpdate :: Maybe CampaignUpdateSummary
- name :: Maybe Text
- minProvisionedTPS :: Maybe Natural
- creationDateTime :: Maybe POSIX
- campaignArn :: Maybe Text
- solutionVersionArn :: Maybe Text
}
newCampaign :: Campaign
campaign_failureReason :: Lens' Campaign (Maybe Text)
campaign_status :: Lens' Campaign (Maybe Text)
campaign_lastUpdatedDateTime :: Lens' Campaign (Maybe UTCTime)
campaign_campaignConfig :: Lens' Campaign (Maybe CampaignConfig)
campaign_latestCampaignUpdate :: Lens' Campaign (Maybe CampaignUpdateSummary)
campaign_name :: Lens' Campaign (Maybe Text)
campaign_minProvisionedTPS :: Lens' Campaign (Maybe Natural)
campaign_creationDateTime :: Lens' Campaign (Maybe UTCTime)
campaign_campaignArn :: Lens' Campaign (Maybe Text)
campaign_solutionVersionArn :: Lens' Campaign (Maybe Text)

Documentation

data Campaign Source #

Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.

See: newCampaign smart constructor.

Constructors

Campaign'

Fields

failureReason :: Maybe Text
If a campaign fails, the reason behind the failure.
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
lastUpdatedDateTime :: Maybe POSIX
The date and time (in Unix format) that the campaign was last updated.
campaignConfig :: Maybe CampaignConfig
The configuration details of a campaign.
latestCampaignUpdate :: Maybe CampaignUpdateSummary
name :: Maybe Text
The name of the campaign.
minProvisionedTPS :: Maybe Natural
Specifies the requested minimum provisioned transactions (recommendations) per second.
creationDateTime :: Maybe POSIX
The date and time (in Unix format) that the campaign was created.
campaignArn :: Maybe Text
The Amazon Resource Name (ARN) of the campaign.
solutionVersionArn :: Maybe Text
The Amazon Resource Name (ARN) of a specific version of the solution.

Instances

Instances details

Eq Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign Methods (==) :: Campaign -> Campaign -> Bool # (/=) :: Campaign -> Campaign -> Bool #
Read Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign Methods readsPrec :: Int -> ReadS Campaign # readList :: ReadS [Campaign] # readPrec :: ReadPrec Campaign # readListPrec :: ReadPrec [Campaign] #
Show Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign Methods showsPrec :: Int -> Campaign -> ShowS # show :: Campaign -> String # showList :: [Campaign] -> ShowS #
Generic Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign Associated Types type Rep Campaign :: Type -> Type # Methods from :: Campaign -> Rep Campaign x # to :: Rep Campaign x -> Campaign #
NFData Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign Methods rnf :: Campaign -> () #
Hashable Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign Methods hashWithSalt :: Int -> Campaign -> Int # hash :: Campaign -> Int #
FromJSON Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign Methods parseJSON :: Value -> Parser Campaign # parseJSONList :: Value -> Parser [Campaign] #
type Rep Campaign Source #
Instance details Defined in Amazonka.Personalize.Types.Campaign type Rep Campaign = D1 ('MetaData "Campaign" "Amazonka.Personalize.Types.Campaign" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "Campaign'" '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 "campaignConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignConfig)) :: S1 ('MetaSel ('Just "latestCampaignUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignUpdateSummary))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "minProvisionedTPS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "campaignArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "solutionVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newCampaign :: Campaign Source #

Create a value of Campaign 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:Campaign', campaign_failureReason - If a campaign fails, the reason behind the failure.

$sel:status:Campaign', campaign_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:Campaign', campaign_lastUpdatedDateTime - The date and time (in Unix format) that the campaign was last updated.

$sel:campaignConfig:Campaign', campaign_campaignConfig - The configuration details of a campaign.

$sel:latestCampaignUpdate:Campaign', campaign_latestCampaignUpdate - Undocumented member.

$sel:name:Campaign', campaign_name - The name of the campaign.

$sel:minProvisionedTPS:Campaign', campaign_minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second.

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

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

$sel:solutionVersionArn:Campaign', campaign_solutionVersionArn - The Amazon Resource Name (ARN) of a specific version of the solution.

campaign_failureReason :: Lens' Campaign (Maybe Text) Source #

If a campaign fails, the reason behind the failure.

campaign_status :: Lens' Campaign (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

campaign_lastUpdatedDateTime :: Lens' Campaign (Maybe UTCTime) Source #

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

campaign_campaignConfig :: Lens' Campaign (Maybe CampaignConfig) Source #

The configuration details of a campaign.

campaign_latestCampaignUpdate :: Lens' Campaign (Maybe CampaignUpdateSummary) Source #

Undocumented member.

campaign_name :: Lens' Campaign (Maybe Text) Source #

The name of the campaign.

campaign_minProvisionedTPS :: Lens' Campaign (Maybe Natural) Source #

Specifies the requested minimum provisioned transactions (recommendations) per second.

campaign_creationDateTime :: Lens' Campaign (Maybe UTCTime) Source #

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

campaign_campaignArn :: Lens' Campaign (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

campaign_solutionVersionArn :: Lens' Campaign (Maybe Text) Source #

The Amazon Resource Name (ARN) of a specific version of the solution.