v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466276261.1 KB

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

post/#X-Amz-Target=AmazonPersonalize.CreateCampaign

Headers

X-Amz-Target'AmazonPersonalize.CreateCampaign' required

Request body

namestring required

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

solutionVersionArnstring required

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

minProvisionedTPSinteger

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

Response

Success

campaignArnstring

The Amazon Resource Name (ARN) of the campaign.