recipes

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

Overview

Name	recipes
Type	Resource
Id	aws.personalize.recipes

Fields

The following fields are returned by SELECT queries:

describe_recipe

Name	Datatype	Description
name	string	The name of the recipe. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
algorithm_arn	string	The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
creation_date_time	string (date-time)	The date and time (in Unix format) that the recipe was created.
description	string	The description of the recipe.
feature_transformation_arn	string	The ARN of the FeatureTransformation object. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
last_updated_date_time	string (date-time)	The date and time (in Unix format) that the recipe was last updated.
recipe_arn	string	The Amazon Resource Name (ARN) of the recipe. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
recipe_type	string	One of the following values: PERSONALIZED_RANKING RELATED_ITEMS USER_PERSONALIZATION
status	string	The status of the recipe.

list_recipes

Name	Datatype	Description
name	string	The name of the recipe. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
creation_date_time	string (date-time)	The date and time (in Unix time) that the recipe was created.
domain	string	The domain of the recipe (if the recipe is a Domain dataset group use case). (ECOMMERCE, VIDEO_ON_DEMAND)
last_updated_date_time	string (date-time)	The date and time (in Unix time) that the recipe was last updated.
recipe_arn	string	The Amazon Resource Name (ARN) of the recipe. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
status	string	The status of the recipe.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_recipe	select	region		Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
list_recipes	select	region		Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_recipe

Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

SELECT
name,
algorithm_arn,
creation_date_time,
description,
feature_transformation_arn,
last_updated_date_time,
recipe_arn,
recipe_type,
status
FROM aws.personalize.recipes
WHERE region = '{{ region }}' -- required
;

list_recipes

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

SELECT
name,
creation_date_time,
domain,
last_updated_date_time,
recipe_arn,
status
FROM aws.personalize.recipes
WHERE region = '{{ region }}' -- required
;