List Recommenders

personalize_list_recommenders

R Documentation

Returns a list of recommenders in a given Domain dataset group

Description

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

Usage

personalize_list_recommenders(datasetGroupArn, nextToken, maxResults)

Arguments

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.

nextToken

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

maxResults

The maximum number of recommenders to return.

Value

A list with the following syntax:

list(
  recommenders = list(
    list(
      name = "string",
      recommenderArn = "string",
      datasetGroupArn = "string",
      recipeArn = "string",
      recommenderConfig = list(
        itemExplorationConfig = list(
          "string"
        ),
        minRecommendationRequestsPerSecond = 123,
        trainingDataConfig = list(
          excludedDatasetColumns = list(
            list(
              "string"
            )
          )
        ),
        enableMetadataWithRecommendations = TRUE|FALSE
      ),
      status = "string",
      creationDateTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_recommenders(
  datasetGroupArn = "string",
  nextToken = "string",
  maxResults = 123
)