Skip to main content

recommender_recipes

Creates, updates, deletes, gets or lists a recommender_recipes resource.

Overview

Namerecommender_recipes
TypeResource
Idaws.customer_profiles.recommender_recipes

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the recommender recipe. (recommended-for-you, similar-items, frequently-paired-items, popular-items, trending-now, personalized-ranking)
descriptionstringA description of the recommender recipe's purpose and functionality.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_recommender_recipesselectregionmax-results, next-tokenReturns a list of available recommender recipes that can be used to create recommenders.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
max-resultsintegerThe maximum number of recommender recipes to return in the response. The default value is 100.
next-tokenstringA token received from a previous ListRecommenderRecipes call to retrieve the next page of results.

SELECT examples

Returns a list of available recommender recipes that can be used to create recommenders.

SELECT
name,
description
FROM aws.customer_profiles.recommender_recipes
WHERE region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;