ListRecommendersCommand

Suggest an Edit

Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). 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, ListRecommendersCommand } from "@aws-sdk/client-personalize"; // ES Modules import
// const { PersonalizeClient, ListRecommendersCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
const client = new PersonalizeClient(config);
const input = { // ListRecommendersRequest
  datasetGroupArn: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListRecommendersCommand(input);
const response = await client.send(command);
// { // ListRecommendersResponse
//   recommenders: [ // Recommenders
//     { // RecommenderSummary
//       name: "STRING_VALUE",
//       recommenderArn: "STRING_VALUE",
//       datasetGroupArn: "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,
//       },
//       status: "STRING_VALUE",
//       creationDateTime: new Date("TIMESTAMP"),
//       lastUpdatedDateTime: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListRecommendersCommand Input

See ListRecommendersCommandInput for more details

Parameter
Type
Description
datasetGroupArn
string | undefined

The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.

maxResults
number | undefined

The maximum number of recommenders to return.

nextToken
string | undefined

A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).

ListRecommendersCommand Output

See ListRecommendersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
nextToken
string | undefined

A token for getting the next set of recommenders (if they exist).

recommenders
RecommenderSummary[] | undefined

A list of the recommenders.

Throws

Name
Fault
Details
InvalidInputException
client

Provide a valid value for the field or parameter.

InvalidNextTokenException
client

The token is not valid.

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