describe_recipe

Personalize.Client.describe_recipe(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_recipe(
    recipeArn='string'
)

Parameters

recipeArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the recipe to describe.

Return type

dict

Returns

Response Syntax

{
    'recipe': {
        'name': 'string',
        'recipeArn': 'string',
        'algorithmArn': 'string',
        'featureTransformationArn': 'string',
        'status': 'string',
        'description': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'recipeType': 'string',
        'lastUpdatedDateTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --
  • recipe (dict) --

    An object that describes the recipe.

    • name (string) --

      The name of the recipe.

    • recipeArn (string) --

      The Amazon Resource Name (ARN) of the recipe.

    • algorithmArn (string) --

      The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.

    • featureTransformationArn (string) --

      The ARN of the FeatureTransformation object.

    • status (string) --

      The status of the recipe.

    • description (string) --

      The description of the recipe.

    • creationDateTime (datetime) --

      The date and time (in Unix format) that the recipe was created.

    • recipeType (string) --

      One of the following values:

      • PERSONALIZED_RANKING
      • RELATED_ITEMS
      • USER_PERSONALIZATION
    • lastUpdatedDateTime (datetime) --

      The date and time (in Unix format) that the recipe was last updated.

Exceptions

• Personalize.Client.exceptions.InvalidInputException
• Personalize.Client.exceptions.ResourceNotFoundException