Skip to content

Returns a list of recommenders in the specified domain

Description

Returns a list of recommenders in the specified domain.

Usage

customerprofiles_list_recommenders(DomainName, MaxResults, NextToken)

Arguments

  • DomainName

[required] The unique name of the domain.

  • MaxResults

The maximum number of recommenders to return in the response. The default value is 100.

  • NextToken

A token received from a previous ListRecommenders call to retrieve the next page of results.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Recommenders = list(
    list(
      RecommenderName = "string",
      RecipeName = "recommended-for-you"|"similar-items"|"frequently-paired-items"|"popular-items"|"trending-now"|"personalized-ranking",
      RecommenderSchemaName = "string",
      RecommenderConfig = list(
        EventsConfig = list(
          EventParametersList = list(
            list(
              EventType = "string",
              EventValueThreshold = 123.0,
              EventWeight = 123.0
            )
          )
        ),
        TrainingFrequency = 123,
        InferenceConfig = list(
          MinProvisionedTPS = 123
        ),
        IncludedColumns = list(
          list(
            "string"
          )
        ),
        ExcludedColumns = list(
          list(
            "string"
          )
        ),
        DiversityConfig = list(
          DiversityColumns = list(
            list(
              Name = "string",
              CapType = "PERCENTAGE"|"VALUE",
              Target = "string"
            )
          )
        )
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Description = "string",
      Status = "PENDING"|"IN_PROGRESS"|"ACTIVE"|"FAILED"|"STOPPING"|"INACTIVE"|"STARTING"|"DELETING",
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        "string"
      ),
      FailureReason = "string",
      LatestRecommenderUpdate = list(
        RecommenderConfig = list(
          EventsConfig = list(
            EventParametersList = list(
              list(
                EventType = "string",
                EventValueThreshold = 123.0,
                EventWeight = 123.0
              )
            )
          ),
          TrainingFrequency = 123,
          InferenceConfig = list(
            MinProvisionedTPS = 123
          ),
          IncludedColumns = list(
            list(
              "string"
            )
          ),
          ExcludedColumns = list(
            list(
              "string"
            )
          ),
          DiversityConfig = list(
            DiversityColumns = list(
              list(
                Name = "string",
                CapType = "PERCENTAGE"|"VALUE",
                Target = "string"
              )
            )
          )
        ),
        Status = "PENDING"|"IN_PROGRESS"|"ACTIVE"|"FAILED"|"STOPPING"|"INACTIVE"|"STARTING"|"DELETING",
        CreatedAt = as.POSIXct(
          "2015-01-01"
        ),
        LastUpdatedAt = as.POSIXct(
          "2015-01-01"
        ),
        FailureReason = "string",
        RecommenderVersionName = "string"
      )
    )
  )
)

Request syntax

svc$list_recommenders(
  DomainName = "string",
  MaxResults = 123,
  NextToken = "string"
)