Skip to content
AWS for Query.Farm

aws.personalize.describe_recommender

Example SQL Queries

SELECT * FROM
aws.personalize.describe_recommender
WHERE
"recommender_arn" = 'VALUE';

Description

Describes the given recommender, including its status.

A recommender can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

The modelMetrics key is null when the recommender is being created or deleted.

For more information on recommenders, see CreateRecommender.

Table Definition

Column NameColumn Data Type
recommender_arn Required Input Column

The Amazon Resource Name (ARN) of the recommender 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
recommender

The properties of the recommender.

STRUCT(
    "recommender_arn" VARCHAR,
    "dataset_group_arn" VARCHAR,
    "name" VARCHAR,
    "recipe_arn" VARCHAR,
    "recommender_config" STRUCT(
        "item_exploration_config" MAP(VARCHAR, VARCHAR),
        "min_recommendation_requests_per_second" BIGINT,
        "training_data_config" STRUCT(
            "excluded_dataset_columns" MAP(VARCHAR, VARCHAR[])
        ),
        "enable_metadata_with_recommendations" BOOLEAN
    ),
    "creation_date_time" TIMESTAMP_S,
    "last_updated_date_time" TIMESTAMP_S,
    "status" VARCHAR,
    "failure_reason" VARCHAR,
    "latest_recommender_update" STRUCT(
        "recommender_config" STRUCT(
            "item_exploration_config" MAP(VARCHAR, VARCHAR),
            "min_recommendation_requests_per_second" BIGINT,
            "training_data_config" STRUCT(
                "excluded_dataset_columns" MAP(VARCHAR, VARCHAR[])
            ),
            "enable_metadata_with_recommendations" BOOLEAN
        ),
        "creation_date_time" TIMESTAMP_S,
        "last_updated_date_time" TIMESTAMP_S,
        "status" VARCHAR,
        "failure_reason" VARCHAR
    ),
    "model_metrics" MAP(VARCHAR, DOUBLE)
)
Show child fields
recommender.creation_date_time

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

recommender.dataset_group_arn

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

recommender.failure_reason

If a recommender fails, the reason behind the failure.

recommender.last_updated_date_time

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

recommender.latest_recommender_update

Provides a summary of the latest updates to the recommender.

Show child fields
recommender.latest_recommender_update.creation_date_time

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

recommender.latest_recommender_update.failure_reason

If a recommender update fails, the reason behind the failure.

recommender.latest_recommender_update.last_updated_date_time

The date and time (in Unix time) that the recommender update was last updated.

recommender.latest_recommender_update.recommender_config

The configuration details of the recommender update.

Show child fields
recommender.latest_recommender_update.recommender_config.enable_metadata_with_recommendations

Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

recommender.latest_recommender_update.recommender_config.item_exploration_config

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).

recommender.latest_recommender_update.recommender_config.min_recommendation_requests_per_second

Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

recommender.latest_recommender_update.recommender_config.training_data_config

Specifies the training data configuration to use when creating a domain recommender.

Show child fields
recommender.latest_recommender_update.recommender_config.training_data_config.excluded_dataset_columns

Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

recommender.latest_recommender_update.status

The status of the recommender update.

A recommender can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

  • DELETE PENDING > DELETE IN_PROGRESS

recommender.model_metrics

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

recommender.name

The name of the recommender.

recommender.recipe_arn

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

recommender.recommender_arn

The Amazon Resource Name (ARN) of the recommender.

recommender.recommender_config

The configuration details of the recommender.

Show child fields
recommender.recommender_config.enable_metadata_with_recommendations

Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

recommender.recommender_config.item_exploration_config

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).

recommender.recommender_config.min_recommendation_requests_per_second

Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

recommender.recommender_config.training_data_config

Specifies the training data configuration to use when creating a domain recommender.

Show child fields
recommender.recommender_config.training_data_config.excluded_dataset_columns

Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

recommender.status

The status of the recommender.

A recommender can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

  • DELETE PENDING > DELETE IN_PROGRESS