Personalize / Paginator / ListRecipes

ListRecipes

class Personalize.Paginator.ListRecipes

paginator = client.get_paginator('list_recipes')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Personalize.Client.list_recipes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    recipeProvider='SERVICE',
    domain='ECOMMERCE'|'VIDEO_ON_DEMAND',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• recipeProvider (string) – The default is SERVICE.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 to resume pagination.