Describe Recommender

personalize_describe_recommender

R Documentation

Describes the given recommender, including its status

Description

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

Usage

personalize_describe_recommender(recommenderArn)

Arguments

recommenderArn

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

Value

A list with the following syntax:

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

Request syntax

svc$describe_recommender(
  recommenderArn = "string"
)