ListRecommenderRecipes
Returns a list of available recommender recipes that can be used to create recommenders.
Request Syntax
GET /recommender-recipes?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of recommender recipes to return in the response. The default value is 100.
Valid Range: Minimum value of 10. Maximum value of 100.
- NextToken
-
A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RecommenderRecipes": [
{
"description": "string",
"name": "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.
- NextToken
-
A token to retrieve the next page of results. Null if there are no more results to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- RecommenderRecipes
-
A list of available recommender recipes and their properties.
Type: Array of RecommenderRecipe 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
- ThrottlingException
-
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
