DescribeRecommender - Amazon Personalize
请求语法请求参数响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

DescribeRecommender

描述给定的推荐器，包括其状态。

推荐器可处于以下一种状态：

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE - 或 - CREATE FAILED

  • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

  • DELETE PENDING > DELETE IN_PROGRESS

当 status 为 CREATE FAILED 时，响应将包含 failureReason 键，该键描述了原因。

创建或删除推荐器时，modelMetrics 键为空。

有关推荐人的更多信息，请参阅CreateRecommender。

请求语法

{
   "recommenderArn": "string"
}

请求参数

请求接受采用 JSON 格式的以下数据。

recommenderArn

要描述的推荐器的 Amazon 资源名称 (ARN)。

类型：字符串

长度约束：最大长度为 256。

模式：arn:([a-z\d-]+):personalize:.*:.*:.+

必需：是

响应语法

{
   "recommender": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "latestRecommenderUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      },
      "modelMetrics": { 
         "string" : number 
      },
      "name": "string",
      "recipeArn": "string",
      "recommenderArn": "string",
      "recommenderConfig": { 
         "enableMetadataWithRecommendations": boolean,
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "minRecommendationRequestsPerSecond": number,
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "status": "string"
   }
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

recommender

推荐器的属性。

类型：Recommender 对象

错误

InvalidInputException

为字段或参数提供有效值。

HTTP 状态代码：400

ResourceNotFoundException

找不到指定的资源。

HTTP 状态代码：400

另请参阅

有关以特定语言之一使用此 API 的更多信息 Amazon SDKs，请参阅以下内容：