DescribeRecommenderCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PersonalizeClient, DescribeRecommenderCommand } from "@aws-sdk/client-personalize"; // ES Modules import
// const { PersonalizeClient, DescribeRecommenderCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
const client = new PersonalizeClient(config);
const input = { // DescribeRecommenderRequest
  recommenderArn: "STRING_VALUE", // required
};
const command = new DescribeRecommenderCommand(input);
const response = await client.send(command);
// { // DescribeRecommenderResponse
//   recommender: { // Recommender
//     recommenderArn: "STRING_VALUE",
//     datasetGroupArn: "STRING_VALUE",
//     name: "STRING_VALUE",
//     recipeArn: "STRING_VALUE",
//     recommenderConfig: { // RecommenderConfig
//       itemExplorationConfig: { // HyperParameters
//         "<keys>": "STRING_VALUE",
//       },
//       minRecommendationRequestsPerSecond: Number("int"),
//       trainingDataConfig: { // TrainingDataConfig
//         excludedDatasetColumns: { // ExcludedDatasetColumns
//           "<keys>": [ // ColumnNamesList
//             "STRING_VALUE",
//           ],
//         },
//       },
//       enableMetadataWithRecommendations: true || false,
//     },
//     creationDateTime: new Date("TIMESTAMP"),
//     lastUpdatedDateTime: new Date("TIMESTAMP"),
//     status: "STRING_VALUE",
//     failureReason: "STRING_VALUE",
//     latestRecommenderUpdate: { // RecommenderUpdateSummary
//       recommenderConfig: {
//         itemExplorationConfig: {
//           "<keys>": "STRING_VALUE",
//         },
//         minRecommendationRequestsPerSecond: Number("int"),
//         trainingDataConfig: {
//           excludedDatasetColumns: {
//             "<keys>": [
//               "STRING_VALUE",
//             ],
//           },
//         },
//         enableMetadataWithRecommendations: true || false,
//       },
//       creationDateTime: new Date("TIMESTAMP"),
//       lastUpdatedDateTime: new Date("TIMESTAMP"),
//       status: "STRING_VALUE",
//       failureReason: "STRING_VALUE",
//     },
//     modelMetrics: { // Metrics
//       "<keys>": Number("double"),
//     },
//   },
// };

DescribeRecommenderCommand Input

See DescribeRecommenderCommandInput for more details

Parameter
Type
Description
recommenderArn
Required
string | undefined

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

DescribeRecommenderCommand Output

See DescribeRecommenderCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
recommender
Recommender | undefined

The properties of the recommender.

Throws

Name
Fault
Details
InvalidInputException
client

Provide a valid value for the field or parameter.

ResourceNotFoundException
client

Could not find the specified resource.

PersonalizeServiceException
Base exception class for all service exceptions from Personalize service.