CustomerProfiles / Client / list_recommender_recipes

list_recommender_recipes¶

CustomerProfiles.Client.list_recommender_recipes(**kwargs)¶

Returns a list of available recommender recipes that can be used to create recommenders.

Request Syntax

response = client.list_recommender_recipes(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of recommender recipes to return in the response. The default value is 100.
NextToken (string) – A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- NextToken (string) –
  
  A token to retrieve the next page of results. Null if there are no more results to retrieve.
- 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.

Exceptions

CustomerProfiles.Client.exceptions.InternalServerException
CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.AccessDeniedException