Skip to content
AWS for Query.Farm

aws.personalize.describe_recipe

Example SQL Queries

SELECT * FROM
aws.personalize.describe_recipe
WHERE
"recipe_arn" = 'VALUE';

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

Table Definition

Column NameColumn Data Type
recipe_arn Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
recipe

An object that describes the recipe.

STRUCT(
    "name" VARCHAR,
    "recipe_arn" VARCHAR,
    "algorithm_arn" VARCHAR,
    "feature_transformation_arn" VARCHAR,
    "status" VARCHAR,
    "description" VARCHAR,
    "creation_date_time" TIMESTAMP_S,
    "recipe_type" VARCHAR,
    "last_updated_date_time" TIMESTAMP_S
)
Show child fields
recipe.algorithm_arn

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

recipe.creation_date_time

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

recipe.description

The description of the recipe.

recipe.feature_transformation_arn

The ARN of the FeatureTransformation object.

recipe.last_updated_date_time

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

recipe.name

The name of the recipe.

recipe.recipe_arn

The Amazon Resource Name (ARN) of the recipe.

recipe.recipe_type

One of the following values:

  • PERSONALIZED_RANKING

  • RELATED_ITEMS

  • USER_PERSONALIZATION

recipe.status

The status of the recipe.