Skip to content

Describe Recipe

personalize_describe_recipe R Documentation

Describes a recipe

Description

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 create_solution API. create_solution 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.

Usage

personalize_describe_recipe(recipeArn)

Arguments

recipeArn

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

Value

A list with the following syntax: 

list(
  recipe = list(
    name = "string",
    recipeArn = "string",
    algorithmArn = "string",
    featureTransformationArn = "string",
    status = "string",
    description = "string",
    creationDateTime = as.POSIXct(
      "2015-01-01"
    ),
    recipeType = "string",
    lastUpdatedDateTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$describe_recipe(
  recipeArn = "string"
)