Amazon Personalize
Developer Guide

ListRecipes

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

Request Syntax

{ "maxResults": number, "nextToken": "string", "recipeProvider": "string" }

Request Parameters

The request accepts the following data in JSON format.

maxResults

The maximum number of recipes to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

Type: String

Length Constraints: Maximum length of 1300.

Required: No

recipeProvider

The default is SERVICE.

Type: String

Valid Values: SERVICE

Required: No

Response Syntax

{ "nextToken": "string", "recipes": [ { "creationDateTime": number, "lastUpdatedDateTime": number, "name": "string", "recipeArn": "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.

nextToken

A token for getting the next set of recipes.

Type: String

Length Constraints: Maximum length of 1300.

recipes

The list of available recipes.

Type: Array of RecipeSummary objects

Array Members: Maximum number of 100 items.

Errors

InvalidNextTokenException

The token is not valid.

HTTP Status Code: 400

See Also

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