:doc:`GlueDataBrew <../../databrew>` / Paginator / ListRecipes

***********
ListRecipes
***********



.. py:class:: GlueDataBrew.Paginator.ListRecipes

  ::

    
    paginator = client.get_paginator('list_recipes')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`GlueDataBrew.Client.list_recipes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRecipes>`_    


    **Request Syntax**
    ::

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

      Return only those recipes with a version identifier of ``LATEST_WORKING`` or ``LATEST_PUBLISHED``. If ``RecipeVersion`` is omitted, ``ListRecipes`` returns all of the ``LATEST_PUBLISHED`` recipe versions.

       

      Valid values: ``LATEST_WORKING`` | ``LATEST_PUBLISHED``

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Recipes': [
                {
                    'CreatedBy': 'string',
                    'CreateDate': datetime(2015, 1, 1),
                    'LastModifiedBy': 'string',
                    'LastModifiedDate': datetime(2015, 1, 1),
                    'ProjectName': 'string',
                    'PublishedBy': 'string',
                    'PublishedDate': datetime(2015, 1, 1),
                    'Description': 'string',
                    'Name': 'string',
                    'ResourceArn': 'string',
                    'Steps': [
                        {
                            'Action': {
                                'Operation': 'string',
                                'Parameters': {
                                    'string': 'string'
                                }
                            },
                            'ConditionExpressions': [
                                {
                                    'Condition': 'string',
                                    'Value': 'string',
                                    'TargetColumn': 'string'
                                },
                            ]
                        },
                    ],
                    'Tags': {
                        'string': 'string'
                    },
                    'RecipeVersion': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Recipes** *(list) --* 

          A list of recipes that are defined.

          
          

          - *(dict) --* 

            Represents one or more actions to be performed on a DataBrew dataset.

            
            

            - **CreatedBy** *(string) --* 

              The Amazon Resource Name (ARN) of the user who created the recipe.

              
            

            - **CreateDate** *(datetime) --* 

              The date and time that the recipe was created.

              
            

            - **LastModifiedBy** *(string) --* 

              The Amazon Resource Name (ARN) of the user who last modified the recipe.

              
            

            - **LastModifiedDate** *(datetime) --* 

              The last modification date and time of the recipe.

              
            

            - **ProjectName** *(string) --* 

              The name of the project that the recipe is associated with.

              
            

            - **PublishedBy** *(string) --* 

              The Amazon Resource Name (ARN) of the user who published the recipe.

              
            

            - **PublishedDate** *(datetime) --* 

              The date and time when the recipe was published.

              
            

            - **Description** *(string) --* 

              The description of the recipe.

              
            

            - **Name** *(string) --* 

              The unique name for the recipe.

              
            

            - **ResourceArn** *(string) --* 

              The Amazon Resource Name (ARN) for the recipe.

              
            

            - **Steps** *(list) --* 

              A list of steps that are defined by the recipe.

              
              

              - *(dict) --* 

                Represents a single step from a DataBrew recipe to be performed.

                
                

                - **Action** *(dict) --* 

                  The particular action to be performed in the recipe step.

                  
                  

                  - **Operation** *(string) --* 

                    The name of a valid DataBrew transformation to be performed on the data.

                    
                  

                  - **Parameters** *(dict) --* 

                    Contextual parameters for the transformation.

                    
                    

                    - *(string) --* 
                      

                      - *(string) --* 
                
              
              
                

                - **ConditionExpressions** *(list) --* 

                  One or more conditions that must be met for the recipe step to succeed.

                   

                  .. note::

                    

                    All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.

                    

                  
                  

                  - *(dict) --* 

                    Represents an individual condition that evaluates to true or false.

                     

                    Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.

                     

                    If a recipe requires more than one condition, then the recipe must specify multiple ``ConditionExpression`` elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.

                    
                    

                    - **Condition** *(string) --* 

                      A specific condition to apply to a recipe action. For more information, see `Recipe structure <https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure>`__ in the *Glue DataBrew Developer Guide*.

                      
                    

                    - **Value** *(string) --* 

                      A value that the condition must evaluate to for the condition to succeed.

                      
                    

                    - **TargetColumn** *(string) --* 

                      A column to apply this condition to.

                      
                
              
            
          
            

            - **Tags** *(dict) --* 

              Metadata tags that have been applied to the recipe.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **RecipeVersion** *(string) --* 

              The identifier for the version for the recipe. Must be one of the following:

               

              
              * Numeric version ( ``X.Y``) - ``X`` and ``Y`` stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both ``X`` and ``Y`` are required, and "0.0" isn't a valid version.
               
              * ``LATEST_WORKING`` - the most recent valid version being developed in a DataBrew project.
               
              * ``LATEST_PUBLISHED`` - the most recent published version.
              

              
        
      
    