Table of Contents
A low-level client representing Amazon Personalize Runtime:
import boto3
client = boto3.client('personalize-runtime')
These are the available methods:
Check if an operation can be paginated.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.
Note
The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
See also: AWS API Documentation
Request Syntax
response = client.get_personalized_ranking(
campaignArn='string',
inputList=[
'string',
],
userId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
[REQUIRED]
A list of items (itemId's) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list.
[REQUIRED]
The user for which you want the campaign to provide a personalized ranking.
dict
Response Syntax
{
'personalizedRanking': [
{
'itemId': 'string'
},
]
}
Response Structure
(dict) --
personalizedRanking (list) --
A list of items in order of most likely interest to the user.
(dict) --
An object that identifies an item.
The and APIs return a list of PredictedItem s.
itemId (string) --
The recommended item ID.
Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:
Note
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.
See also: AWS API Documentation
Request Syntax
response = client.get_recommendations(
campaignArn='string',
itemId='string',
userId='string',
numResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
dict
Response Syntax
{
'itemList': [
{
'itemId': 'string'
},
]
}
Response Structure
(dict) --
itemList (list) --
A list of recommendations.
(dict) --
An object that identifies an item.
The and APIs return a list of PredictedItem s.
itemId (string) --
The recommended item ID.
Returns an object that can wait for some condition.
The available paginators are: