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

Description

Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.

Status

A recommender 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 recommender status, call DescribeRecommender .

Note

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

Related APIs

  • ListRecommenders
  • DescribeRecommender
  • UpdateRecommender
  • DeleteRecommender

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-recommender
--name <value>
--dataset-group-arn <value>
--recipe-arn <value>
[--recommender-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the recommender.

--dataset-group-arn (string)

The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.

--recipe-arn (string)

The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases .

--recommender-config (structure)

The configuration details of the recommender.

itemExplorationConfig -> (map)

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 recommenders generate personalized recommendations for a user (not popular items or similar items).

key -> (string)

value -> (string)

Shorthand Syntax:

itemExplorationConfig={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "itemExplorationConfig": {"string": "string"
    ...}
}

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

recommenderArn -> (string)

The Amazon Resource Name (ARN) of the recommender.