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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

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

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

ListCampaigns
DescribeCampaign
UpdateCampaign
DeleteCampaign

Creating a Request

data CreateCampaign Source #

See: newCreateCampaign smart constructor.

Constructors

CreateCampaign'

Fields

campaignConfig :: Maybe CampaignConfig
The configuration details of a campaign.
minProvisionedTPS :: Maybe Natural
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
name :: Text
A name for the new campaign. The campaign name must be unique within your account.
solutionVersionArn :: Text
The Amazon Resource Name (ARN) of the solution version to deploy.

Instances

Instances details

Eq CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods (==) :: CreateCampaign -> CreateCampaign -> Bool # (/=) :: CreateCampaign -> CreateCampaign -> Bool #
Read CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods readsPrec :: Int -> ReadS CreateCampaign # readList :: ReadS [CreateCampaign] # readPrec :: ReadPrec CreateCampaign # readListPrec :: ReadPrec [CreateCampaign] #
Show CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods showsPrec :: Int -> CreateCampaign -> ShowS # show :: CreateCampaign -> String # showList :: [CreateCampaign] -> ShowS #
Generic CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Associated Types type Rep CreateCampaign :: Type -> Type # Methods from :: CreateCampaign -> Rep CreateCampaign x # to :: Rep CreateCampaign x -> CreateCampaign #
NFData CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods rnf :: CreateCampaign -> () #
Hashable CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods hashWithSalt :: Int -> CreateCampaign -> Int # hash :: CreateCampaign -> Int #
ToJSON CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods toJSON :: CreateCampaign -> Value # toEncoding :: CreateCampaign -> Encoding # toJSONList :: [CreateCampaign] -> Value # toEncodingList :: [CreateCampaign] -> Encoding #
AWSRequest CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Associated Types type AWSResponse CreateCampaign # Methods request :: CreateCampaign -> Request CreateCampaign # response :: MonadResource m => Logger -> Service -> Proxy CreateCampaign -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCampaign))) #
ToHeaders CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods toHeaders :: CreateCampaign -> [Header] #
ToPath CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods toPath :: CreateCampaign -> ByteString #
ToQuery CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods toQuery :: CreateCampaign -> QueryString #
type Rep CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign type Rep CreateCampaign = D1 ('MetaData "CreateCampaign" "Amazonka.Personalize.CreateCampaign" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateCampaign'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "campaignConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignConfig)) :: S1 ('MetaSel ('Just "minProvisionedTPS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "solutionVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateCampaign Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign type AWSResponse CreateCampaign = CreateCampaignResponse

newCreateCampaign Source #

Arguments

:: Text	`$sel:name:CreateCampaign'`
-> Text	`$sel:solutionVersionArn:CreateCampaign'`
-> CreateCampaign

Create a value of CreateCampaign 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:campaignConfig:CreateCampaign', createCampaign_campaignConfig - The configuration details of a campaign.

$sel:minProvisionedTPS:CreateCampaign', createCampaign_minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

$sel:name:CreateCampaign', createCampaign_name - A name for the new campaign. The campaign name must be unique within your account.

$sel:solutionVersionArn:CreateCampaign', createCampaign_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version to deploy.

Request Lenses

createCampaign_campaignConfig :: Lens' CreateCampaign (Maybe CampaignConfig) Source #

The configuration details of a campaign.

createCampaign_minProvisionedTPS :: Lens' CreateCampaign (Maybe Natural) Source #

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

createCampaign_name :: Lens' CreateCampaign Text Source #

A name for the new campaign. The campaign name must be unique within your account.

createCampaign_solutionVersionArn :: Lens' CreateCampaign Text Source #

The Amazon Resource Name (ARN) of the solution version to deploy.

Destructuring the Response

data CreateCampaignResponse Source #

See: newCreateCampaignResponse smart constructor.

Constructors

CreateCampaignResponse'
Fields campaignArn :: Maybe Text The Amazon Resource Name (ARN) of the campaign. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods (==) :: CreateCampaignResponse -> CreateCampaignResponse -> Bool # (/=) :: CreateCampaignResponse -> CreateCampaignResponse -> Bool #
Read CreateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods readsPrec :: Int -> ReadS CreateCampaignResponse # readList :: ReadS [CreateCampaignResponse] # readPrec :: ReadPrec CreateCampaignResponse # readListPrec :: ReadPrec [CreateCampaignResponse] #
Show CreateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods showsPrec :: Int -> CreateCampaignResponse -> ShowS # show :: CreateCampaignResponse -> String # showList :: [CreateCampaignResponse] -> ShowS #
Generic CreateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Associated Types type Rep CreateCampaignResponse :: Type -> Type # Methods from :: CreateCampaignResponse -> Rep CreateCampaignResponse x # to :: Rep CreateCampaignResponse x -> CreateCampaignResponse #
NFData CreateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign Methods rnf :: CreateCampaignResponse -> () #
type Rep CreateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.CreateCampaign type Rep CreateCampaignResponse = D1 ('MetaData "CreateCampaignResponse" "Amazonka.Personalize.CreateCampaign" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateCampaignResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaignArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCampaignResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateCampaignResponse'`
-> CreateCampaignResponse

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

$sel:httpStatus:CreateCampaignResponse', createCampaignResponse_httpStatus - The response's http status code.

Response Lenses

createCampaignResponse_campaignArn :: Lens' CreateCampaignResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

createCampaignResponse_httpStatus :: Lens' CreateCampaignResponse Int Source #

The response's http status code.