Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRecommenders

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.

Request Syntax


{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

datasetGroupArn

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.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Required: No

maxResults

The maximum number of recommenders to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

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

Type: String

Length Constraints: Maximum length of 1500.

Pattern: \p{ASCII}{0,1500}

Required: No

Response Syntax


{
   "nextToken": "string",
   "recommenders": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "recommenderArn": "string",
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

Length Constraints: Maximum length of 1500.

Pattern: \p{ASCII}{0,1500}

recommenders

A list of the recommenders.

Type: Array of RecommenderSummary objects

Array Members: Maximum number of 100 items.

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

InvalidNextTokenException

The token is not valid.

HTTP Status Code: 400