update_campaign

update_campaign(**kwargs)

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

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 on campaigns, see CreateCampaign.

See also: AWS API Documentation

Request Syntax

response = client.update_campaign(
    campaignArn='string',
    solutionVersionArn='string',
    minProvisionedTPS=123,
    campaignConfig={
        'itemExplorationConfig': {
            'string': 'string'
        }
    }
)

Parameters

• campaignArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the campaign.

• solutionVersionArn (string) -- The ARN of a new solution version to deploy.
• minProvisionedTPS (integer) -- Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
• 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) --

Return type

dict

Returns

Response Syntax

{
    'campaignArn': 'string'
}

Response Structure

• (dict) --

  • campaignArn (string) --

    The same campaign ARN as given in the request.

Exceptions

• Personalize.Client.exceptions.InvalidInputException
• Personalize.Client.exceptions.ResourceNotFoundException
• Personalize.Client.exceptions.ResourceInUseException