Amazonka.Personalize.CreateCampaign

Creates a campaign that deploys 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

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.

• tags :: Maybe [Tag]

  A list of tags to apply to the campaign.

• 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

ToJSON CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

toJSON :: CreateCampaign -> Value

toEncoding :: CreateCampaign -> Encoding

toJSONList :: [CreateCampaign] -> Value

toEncodingList :: [CreateCampaign] -> Encoding

ToHeaders CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

toHeaders :: CreateCampaign -> [Header]

ToPath CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

toPath :: CreateCampaign -> ByteString

ToQuery CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

toQuery :: CreateCampaign -> QueryString

AWSRequest CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Associated Types

type AWSResponse CreateCampaign

Methods

request :: (Service -> Service) -> CreateCampaign -> Request CreateCampaign

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCampaign -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCampaign)))

Generic CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Associated Types

type Rep CreateCampaign :: Type -> Type

Methods

from :: CreateCampaign -> Rep CreateCampaign x

to :: Rep CreateCampaign x -> CreateCampaign

Read CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

readsPrec :: Int -> ReadS CreateCampaign

readList :: ReadS [CreateCampaign]

readPrec :: ReadPrec CreateCampaign

readListPrec :: ReadPrec [CreateCampaign]

Show CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

showsPrec :: Int -> CreateCampaign -> ShowS

show :: CreateCampaign -> String

showList :: [CreateCampaign] -> ShowS

NFData CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

rnf :: CreateCampaign -> ()

Eq CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

(==) :: CreateCampaign -> CreateCampaign -> Bool

(/=) :: CreateCampaign -> CreateCampaign -> Bool

Hashable CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

Methods

hashWithSalt :: Int -> CreateCampaign -> Int

hash :: CreateCampaign -> Int

type AWSResponse CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

type AWSResponse CreateCampaign = CreateCampaignResponse

type Rep CreateCampaign

Defined in Amazonka.Personalize.CreateCampaign

type Rep CreateCampaign = D1 ('MetaData "CreateCampaign" "Amazonka.Personalize.CreateCampaign" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "solutionVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateCampaign

Arguments

:: Text

CreateCampaign

-> Text

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:

CreateCampaign, createCampaign_campaignConfig - The configuration details of a campaign.

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

$sel:tags:CreateCampaign', createCampaign_tags - A list of tags to apply to the campaign.

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

CreateCampaign, createCampaign_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version to deploy.

Request Lenses

createCampaign_campaignConfig :: Lens' CreateCampaign (Maybe CampaignConfig)

The configuration details of a campaign.

createCampaign_minProvisionedTPS :: Lens' CreateCampaign (Maybe Natural)

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

createCampaign_tags :: Lens' CreateCampaign (Maybe [Tag])

A list of tags to apply to the campaign.

createCampaign_name :: Lens' CreateCampaign Text

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

createCampaign_solutionVersionArn :: Lens' CreateCampaign Text

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

Destructuring the Response

data CreateCampaignResponse

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

Generic CreateCampaignResponse

Defined in Amazonka.Personalize.CreateCampaign

Associated Types

type Rep CreateCampaignResponse :: Type -> Type

Methods

from :: CreateCampaignResponse -> Rep CreateCampaignResponse x

to :: Rep CreateCampaignResponse x -> CreateCampaignResponse

Read CreateCampaignResponse

Defined in Amazonka.Personalize.CreateCampaign

Methods

readsPrec :: Int -> ReadS CreateCampaignResponse

readList :: ReadS [CreateCampaignResponse]

readPrec :: ReadPrec CreateCampaignResponse

readListPrec :: ReadPrec [CreateCampaignResponse]

Show CreateCampaignResponse

Defined in Amazonka.Personalize.CreateCampaign

Methods

showsPrec :: Int -> CreateCampaignResponse -> ShowS

show :: CreateCampaignResponse -> String

showList :: [CreateCampaignResponse] -> ShowS

NFData CreateCampaignResponse

Defined in Amazonka.Personalize.CreateCampaign

Methods

rnf :: CreateCampaignResponse -> ()

Eq CreateCampaignResponse

Defined in Amazonka.Personalize.CreateCampaign

Methods

(==) :: CreateCampaignResponse -> CreateCampaignResponse -> Bool

(/=) :: CreateCampaignResponse -> CreateCampaignResponse -> Bool

type Rep CreateCampaignResponse

Defined in Amazonka.Personalize.CreateCampaign

type Rep CreateCampaignResponse = D1 ('MetaData "CreateCampaignResponse" "Amazonka.Personalize.CreateCampaign" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" '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

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:

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)

The Amazon Resource Name (ARN) of the campaign.

createCampaignResponse_httpStatus :: Lens' CreateCampaignResponse Int

The response's http status code.