Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

DescribeRecommender - Amazon Personalize

DescribeRecommender

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

Request Syntax

{ "recommenderArn": "string" }

Request Parameters

The request accepts the following data in JSON format.

recommenderArn

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

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

Response Syntax

{ "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" } }

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.

recommender

The properties of the recommender.

Type: Recommender object

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

ResourceNotFoundException

Could not find the specified resource.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.