list_recipes

list_recipes(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_recipes(
    recipeProvider='SERVICE',
    nextToken='string',
    maxResults=123,
    domain='ECOMMERCE'|'VIDEO_ON_DEMAND'
)

Parameters

• recipeProvider (string) -- The default is SERVICE .
• nextToken (string) -- A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
• maxResults (integer) -- The maximum number of recipes to return.
• domain (string) -- Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

Return type

dict

Returns

Response Syntax

{
    'recipes': [
        {
            'name': 'string',
            'recipeArn': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • recipes (list) --

    The list of available recipes.

    • (dict) --

      Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.

      • name (string) --

        The name of the recipe.

      • recipeArn (string) --

        The Amazon Resource Name (ARN) of the recipe.

      • status (string) --

        The status of the recipe.

      • creationDateTime (datetime) --

        The date and time (in Unix time) that the recipe was created.

      • lastUpdatedDateTime (datetime) --

        The date and time (in Unix time) that the recipe was last updated.

      • domain (string) --

        The domain of the recipe (if the recipe is a Domain dataset group use case).

  • nextToken (string) --

    A token for getting the next set of recipes.

Exceptions

• Personalize.Client.exceptions.InvalidNextTokenException
• Personalize.Client.exceptions.InvalidInputException