Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetRecommender

Retrieves a recommender.

Request Syntax


GET /domains/DomainName/recommenders/RecommenderName?training-metrics-count=TrainingMetricsCount HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

RecommenderName

The name of the recommender.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

TrainingMetricsCount

The number of training metrics to retrieve for the recommender.

Valid Range: Minimum value of 0. Maximum value of 5.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "FailureReason": "string",
   "LastUpdatedAt": number,
   "LatestRecommenderUpdate": { 
      "CreatedAt": number,
      "FailureReason": "string",
      "LastUpdatedAt": number,
      "RecommenderConfig": { 
         "EventsConfig": { 
            "EventParametersList": [ 
               { 
                  "EventType": "string",
                  "EventValueThreshold": number
               }
            ]
         },
         "TrainingFrequency": number
      },
      "Status": "string"
   },
   "RecommenderConfig": { 
      "EventsConfig": { 
         "EventParametersList": [ 
            { 
               "EventType": "string",
               "EventValueThreshold": number
            }
         ]
      },
      "TrainingFrequency": number
   },
   "RecommenderName": "string",
   "RecommenderRecipeName": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TrainingMetrics": [ 
      { 
         "Metrics": { 
            "string" : number 
         },
         "Time": number
      }
   ]
}

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.

CreatedAt

The timestamp of when the recommender was created.

Type: Timestamp

Description

A detailed description of the recommender providing information about its purpose and functionality.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

FailureReason

If the recommender fails, provides the reason for the failure.

Type: String

LastUpdatedAt

The timestamp of when the recommender was edited.

Type: Timestamp

LatestRecommenderUpdate

Information about the most recent update performed on the recommender, including status and timestamp.

Type: RecommenderUpdate object

RecommenderConfig

The configuration settings for the recommender, including parameters and settings that define its behavior.

Type: RecommenderConfig object

RecommenderName

The name of the recommender.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

RecommenderRecipeName

The name of the recipe used by the recommender to generate recommendations.

Type: String

Valid Values: recommended-for-you | similar-items | frequently-paired-items | popular-items | trending-now

Status

The current status of the recommender, indicating whether it is active, creating, updating, or in another state.

Type: String

Tags

The tags used to organize, track, or control access for this resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

TrainingMetrics

A set of metrics that provide information about the recommender's training performance and accuracy.

Type: Array of TrainingMetrics objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429