CustomerProfiles / Paginator / ListRecommenderRecipes

ListRecommenderRecipes¶

class CustomerProfiles.Paginator.ListRecommenderRecipes¶

paginator = client.get_paginator('list_recommender_recipes')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CustomerProfiles.Client.list_recommender_recipes().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'RecommenderRecipes': [
        {
            'name': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now',
            'description': 'string'
        },
    ]
}

Response Structure

(dict) –
- RecommenderRecipes (list) –
  
  A list of available recommender recipes and their properties.
  - (dict) –
    
    Defines the algorithm and approach used to generate recommendations.
    - name (string) –
      
      The name of the recommender recipe.
    - description (string) –
      
      A description of the recommender recipe’s purpose and functionality.