:doc:`Personalize <../../personalize>` / Client / list_recipes

************
list_recipes
************



.. py:method:: Personalize.Client.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 <https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes>`_  


  **Request Syntax**
  ::

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

    The default is ``SERVICE``.

    

  
  :type nextToken: string
  :param nextToken: 

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

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of recipes to return.

    

  
  :type domain: string
  :param domain: 

    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.

    

  
  
  :rtype: 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 <https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html>`__ 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**
  
  *   :py:class:`Personalize.Client.exceptions.InvalidNextTokenException`

  
  *   :py:class:`Personalize.Client.exceptions.InvalidInputException`

  