[ aws . personalize ]



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 API.


You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--campaign-arn <value>
[--solution-version-arn <value>]
[--min-provisioned-tps <value>]
[--campaign-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--campaign-arn (string)

The Amazon Resource Name (ARN) of the campaign.

--solution-version-arn (string)

The ARN of a new solution version to deploy.

--min-provisioned-tps (integer)

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

--campaign-config (structure)

The configuration details of a campaign.

itemExplorationConfig -> (map)

A string to string map specifying 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.

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

  "itemExplorationConfig": {"string": "string"

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


campaignArn -> (string)

The same campaign ARN as given in the request.