Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

personalize_create_campaign

Creates a campaign by deploying a solution version


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, to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start 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 describe_campaign.

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

Related APIs

Usage

personalize_create_campaign(name, solutionVersionArn, minProvisionedTPS,
  campaignConfig)

Arguments

name

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

solutionVersionArn

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

minProvisionedTPS

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

campaignConfig

The configuration details of a campaign.

Value

A list with the following syntax:

list(
  campaignArn = "string"
)

Request syntax

svc$create_campaign(
  name = "string",
  solutionVersionArn = "string",
  minProvisionedTPS = 123,
  campaignConfig = list(
    itemExplorationConfig = list(
      "string"
    )
  )
)

paws.machine.learning

Amazon Web Services Machine Learning Services

v0.1.11
Apache License (>= 2.0)
Authors
David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.