Skip to content

Create Campaign

personalize_create_campaign R Documentation

You incur campaign costs while it is active

Description

You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.

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 high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.

If your TPS increases beyond the 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. When your traffic reduces, capacity returns to the minProvisionedTPS.

You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

For more information about campaign costs, see Amazon Personalize pricing.

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

  • list_campaigns

  • describe_campaign

  • update_campaign

  • delete_campaign

Usage

personalize_create_campaign(name, solutionVersionArn, minProvisionedTPS,
  campaignConfig, tags)

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 trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in ⁠SolutionArn/$LATEST⁠ format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

minProvisionedTPS

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

campaignConfig

The configuration details of a campaign.

tags

A list of tags to apply to the 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"
    ),
    enableMetadataWithRecommendations = TRUE|FALSE,
    syncWithLatestSolutionVersion = TRUE|FALSE
  ),
  tags = list(
    list(
      tagKey = "string",
      tagValue = "string"
    )
  )
)