View a markdown version of this page

AWS::Personalize::Campaign CampaignConfig - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Personalize::Campaign CampaignConfig

The configuration details of a campaign.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "EnableMetadataWithRecommendations" : Boolean,
  "ItemExplorationConfig" : {Key: Value, ...},
  "RankingInfluence" : {Key: Value, ...},
  "SyncWithLatestSolutionVersion" : Boolean
}

Properties

EnableMetadataWithRecommendations

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

Required: No

Type: Boolean

Update requires: No interruption

ItemExplorationConfig

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9]+$

Maximum: 1000

Update requires: No interruption

RankingInfluence

A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence. If not specified, both default to 0.0.

Required: No

Type: Object of Number

Pattern: ^(POPULARITY|FRESHNESS)$

Update requires: No interruption

SyncWithLatestSolutionVersion

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

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

Required: No

Type: Boolean

Update requires: No interruption