Personalize / Client / update_campaign

update_campaign#

Personalize.Client.update_campaign(**kwargs)#

Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign’s minProvisionedTPS, or modify your campaign’s configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

To update a campaign to start automatically using the latest solution version, specify the following:

  • For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/$LATEST format.

  • In the campaignConfig, set syncWithLatestSolutionVersion to true.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

Note

You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.

For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.

See also: AWS API Documentation

Request Syntax

response = client.update_campaign(
    campaignArn='string',
    solutionVersionArn='string',
    minProvisionedTPS=123,
    campaignConfig={
        'itemExplorationConfig': {
            'string': 'string'
        },
        'enableMetadataWithRecommendations': True|False,
        'syncWithLatestSolutionVersion': True|False
    }
)
Parameters:
  • campaignArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the campaign.

  • solutionVersionArn (string) –

    The Amazon Resource Name (ARN) of a new model to deploy. 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 (integer) – 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 (dict) –

    The configuration details of a campaign.

    • itemExplorationConfig (dict) –

      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.

      • (string) –

        • (string) –

    • enableMetadataWithRecommendations (boolean) –

      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.

    • syncWithLatestSolutionVersion (boolean) –

      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.

Return type:

dict

Returns:

Response Syntax

{
    'campaignArn': 'string'
}

Response Structure

  • (dict) –

    • campaignArn (string) –

      The same campaign ARN as given in the request.

Exceptions