Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . personalize ]

create-campaign

Description

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS ) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS , Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS , to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start with a low minProvisionedTPS , track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

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

To get the campaign status, call DescribeCampaign .

Note

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

  • ListCampaigns
  • DescribeCampaign
  • UpdateCampaign
  • DeleteCampaign

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--name (string)

A name for the new campaign. The campaign name must be unique within your account.

--solution-version-arn (string)

The Amazon Resource Name (ARN) of the 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 Amazon Resource Name (ARN) of the campaign.