/AWS1/CL_PZZCAMPAIGNCONFIG

The configuration details of a campaign.

CONSTRUCTOR

IMPORTING

Optional arguments:

it_itemexplorationconfig TYPE /AWS1/CL_PZZHYPERPARAMETERS_W=>TT_HYPERPARAMETERS TT_HYPERPARAMETERS

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.

iv_enbmetwithrecommendations TYPE /AWS1/PZZBOOLEAN /AWS1/PZZBOOLEAN

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.

iv_syncwithlatestsolutionvrs TYPE /AWS1/PZZBOOLEAN /AWS1/PZZBOOLEAN

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.

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_ITEMEXPLORATIONCONFIG()	Getter for ITEMEXPLORATIONCONFIG, with configurable default
ASK_ITEMEXPLORATIONCONFIG()	Getter for ITEMEXPLORATIONCONFIG w/ exceptions if field has
HAS_ITEMEXPLORATIONCONFIG()	Determine if ITEMEXPLORATIONCONFIG has a value

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.

Accessible with the following methods

Method	Description
GET_ENBMETWTHRECOMMENDATIONS()	Getter for ENABLEMETWITHRECOMMENDATIONS, with configurable d
ASK_ENBMETWTHRECOMMENDATIONS()	Getter for ENABLEMETWITHRECOMMENDATIONS w/ exceptions if fie
HAS_ENBMETWTHRECOMMENDATIONS()	Determine if ENABLEMETWITHRECOMMENDATIONS has a value

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.

Accessible with the following methods

Method	Description
GET_SYNCWITHLATSTSOLUTIONVRS()	Getter for SYNCWITHLATESTSOLUTIONVRS, with configurable defa
ASK_SYNCWITHLATSTSOLUTIONVRS()	Getter for SYNCWITHLATESTSOLUTIONVRS w/ exceptions if field
HAS_SYNCWITHLATSTSOLUTIONVRS()	Determine if SYNCWITHLATESTSOLUTIONVRS has a value