aws_personalize_campaign

account_id

Type: STRING

campaign_arn

Type: STRING
Provider name: campaignArn
Description: The Amazon Resource Name (ARN) of the campaign.

campaign_config

Type: STRUCT
Provider name: campaignConfig
Description: The configuration details of a campaign.

• enable_metadata_with_recommendations
  Type: BOOLEAN
  Provider name: enableMetadataWithRecommendations
  Description: 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.
  
• item_exploration_config
  Type: MAP_STRING_STRING
  Provider name: itemExplorationConfig
  Description: 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.
  
• sync_with_latest_solution_version
  Type: BOOLEAN
  Provider name: syncWithLatestSolutionVersion
  Description: 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.
  

creation_date_time

Type: TIMESTAMP
Provider name: creationDateTime
Description: The date and time (in Unix format) that the campaign was created.

failure_reason

Type: STRING
Provider name: failureReason
Description: If a campaign fails, the reason behind the failure.

last_updated_date_time

Type: TIMESTAMP
Provider name: lastUpdatedDateTime
Description: The date and time (in Unix format) that the campaign was last updated.

latest_campaign_update

Type: STRUCT
Provider name: latestCampaignUpdate

• campaign_config
  Type: STRUCT
  Provider name: campaignConfig
  
  • enable_metadata_with_recommendations
    Type: BOOLEAN
    Provider name: enableMetadataWithRecommendations
    Description: 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.
    
  • item_exploration_config
    Type: MAP_STRING_STRING
    Provider name: itemExplorationConfig
    Description: 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.
    
  • sync_with_latest_solution_version
    Type: BOOLEAN
    Provider name: syncWithLatestSolutionVersion
    Description: 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.
    
• creation_date_time
  Type: TIMESTAMP
  Provider name: creationDateTime
  Description: The date and time (in Unix time) that the campaign update was created.
  
• failure_reason
  Type: STRING
  Provider name: failureReason
  Description: If a campaign update fails, the reason behind the failure.
  
• last_updated_date_time
  Type: TIMESTAMP
  Provider name: lastUpdatedDateTime
  Description: The date and time (in Unix time) that the campaign update was last updated.
  
• min_provisioned_tps
  Type: INT32
  Provider name: minProvisionedTPS
  Description: Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
  
• solution_version_arn
  Type: STRING
  Provider name: solutionVersionArn
  Description: The Amazon Resource Name (ARN) of the deployed solution version.
  
• status
  Type: STRING
  Provider name: status
  Description: The status of the campaign update. A campaign update can be in one of the following states:
  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

min_provisioned_tps

Type: INT32
Provider name: minProvisionedTPS
Description: Specifies the requested minimum provisioned transactions (recommendations) per second. 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.

name

Type: STRING
Provider name: name
Description: The name of the campaign.

solution_version_arn

Type: STRING
Provider name: solutionVersionArn
Description: The Amazon Resource Name (ARN) of the solution version the campaign uses.

status

Type: STRING
Provider name: status
Description: The status of the campaign. A campaign can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
• DELETE PENDING > DELETE IN_PROGRESS

tags

Type: UNORDERED_LIST_STRING