Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . personalize ]

update-campaign

Description

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.

Note

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.

Synopsis

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

Options

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Output

campaignArn -> (string)

The same campaign ARN as given in the request.