Table Of Contents


User Guide

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

[ aws . personalize-runtime ]



Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:

  • RELATED_ITEMS - itemId required, userId not used
  • USER_PERSONALIZATION - itemId optional, userId required


Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--campaign-arn <value>
[--item-id <value>]
[--user-id <value>]
[--num-results <value>]
[--context <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--campaign-arn (string)

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

--item-id (string)

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

--user-id (string)

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

--num-results (integer)

The number of results to return. The default is 25. The maximum is 500.

--context (map)

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type. For more information, see Contextual Metadata.

Shorthand Syntax:


JSON Syntax:

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


itemList -> (list)

A list of recommendations sorted in ascending order by prediction score. There can be a maximum of 500 items in the list.


An object that identifies an item.

The and APIs return a list of PredictedItem s.

itemId -> (string)

The recommended item ID.