:doc:`Glue <../../glue>` / Client / list_data_quality_ruleset_evaluation_runs

*****************************************
list_data_quality_ruleset_evaluation_runs
*****************************************



.. py:method:: Glue.Client.list_data_quality_ruleset_evaluation_runs(**kwargs)

  

  Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/ListDataQualityRulesetEvaluationRuns>`_  


  **Request Syntax**
  ::

    response = client.list_data_quality_ruleset_evaluation_runs(
        Filter={
            'DataSource': {
                'GlueTable': {
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'CatalogId': 'string',
                    'ConnectionName': 'string',
                    'AdditionalOptions': {
                        'string': 'string'
                    }
                },
                'DataQualityGlueTable': {
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'CatalogId': 'string',
                    'ConnectionName': 'string',
                    'AdditionalOptions': {
                        'string': 'string'
                    },
                    'PreProcessingQuery': 'string'
                }
            },
            'StartedBefore': datetime(2015, 1, 1),
            'StartedAfter': datetime(2015, 1, 1)
        },
        NextToken='string',
        MaxResults=123
    )
    
  :type Filter: dict
  :param Filter: 

    The filter criteria.

    

  
    - **DataSource** *(dict) --* **[REQUIRED]** 

      Filter based on a data source (an Glue table) associated with the run.

      

    
      - **GlueTable** *(dict) --* 

        An Glue table.

        

      
        - **DatabaseName** *(string) --* **[REQUIRED]** 

          A database name in the Glue Data Catalog.

          

        
        - **TableName** *(string) --* **[REQUIRED]** 

          A table name in the Glue Data Catalog.

          

        
        - **CatalogId** *(string) --* 

          A unique identifier for the Glue Data Catalog.

          

        
        - **ConnectionName** *(string) --* 

          The name of the connection to the Glue Data Catalog.

          

        
        - **AdditionalOptions** *(dict) --* 

          Additional options for the table. Currently there are two keys supported:

           

          
          * ``pushDownPredicate``: to filter on partitions without having to list and read all the files in your dataset.
           
          * ``catalogPartitionPredicate``: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
          

          

        
          - *(string) --* 

          
            - *(string) --* 

            
      
    
      
      - **DataQualityGlueTable** *(dict) --* 

        An Glue table for Data Quality Operations.

        

      
        - **DatabaseName** *(string) --* **[REQUIRED]** 

          A database name in the Glue Data Catalog.

          

        
        - **TableName** *(string) --* **[REQUIRED]** 

          A table name in the Glue Data Catalog.

          

        
        - **CatalogId** *(string) --* 

          A unique identifier for the Glue Data Catalog.

          

        
        - **ConnectionName** *(string) --* 

          The name of the connection to the Glue Data Catalog.

          

        
        - **AdditionalOptions** *(dict) --* 

          Additional options for the table. Currently there are two keys supported:

           

          
          * ``pushDownPredicate``: to filter on partitions without having to list and read all the files in your dataset.
           
          * ``catalogPartitionPredicate``: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
          

          

        
          - *(string) --* 

          
            - *(string) --* 

            
      
    
        - **PreProcessingQuery** *(string) --* 

          SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog, before running the Data Quality Operation.

          

        
      
    
    - **StartedBefore** *(datetime) --* 

      Filter results by runs that started before this time.

      

    
    - **StartedAfter** *(datetime) --* 

      Filter results by runs that started after this time.

      

    
  
  :type NextToken: string
  :param NextToken: 

    A paginated token to offset the results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return.

    

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

    
    ::

      {
          'Runs': [
              {
                  'RunId': 'string',
                  'Status': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
                  'StartedOn': datetime(2015, 1, 1),
                  'DataSource': {
                      'GlueTable': {
                          'DatabaseName': 'string',
                          'TableName': 'string',
                          'CatalogId': 'string',
                          'ConnectionName': 'string',
                          'AdditionalOptions': {
                              'string': 'string'
                          }
                      },
                      'DataQualityGlueTable': {
                          'DatabaseName': 'string',
                          'TableName': 'string',
                          'CatalogId': 'string',
                          'ConnectionName': 'string',
                          'AdditionalOptions': {
                              'string': 'string'
                          },
                          'PreProcessingQuery': 'string'
                      }
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Runs** *(list) --* 

        A list of ``DataQualityRulesetEvaluationRunDescription`` objects representing data quality ruleset runs.

        
        

        - *(dict) --* 

          Describes the result of a data quality ruleset evaluation run.

          
          

          - **RunId** *(string) --* 

            The unique run identifier associated with this run.

            
          

          - **Status** *(string) --* 

            The status for this run.

            
          

          - **StartedOn** *(datetime) --* 

            The date and time when the run started.

            
          

          - **DataSource** *(dict) --* 

            The data source (an Glue table) associated with the run.

            
            

            - **GlueTable** *(dict) --* 

              An Glue table.

              
              

              - **DatabaseName** *(string) --* 

                A database name in the Glue Data Catalog.

                
              

              - **TableName** *(string) --* 

                A table name in the Glue Data Catalog.

                
              

              - **CatalogId** *(string) --* 

                A unique identifier for the Glue Data Catalog.

                
              

              - **ConnectionName** *(string) --* 

                The name of the connection to the Glue Data Catalog.

                
              

              - **AdditionalOptions** *(dict) --* 

                Additional options for the table. Currently there are two keys supported:

                 

                
                * ``pushDownPredicate``: to filter on partitions without having to list and read all the files in your dataset.
                 
                * ``catalogPartitionPredicate``: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
                

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
          
            

            - **DataQualityGlueTable** *(dict) --* 

              An Glue table for Data Quality Operations.

              
              

              - **DatabaseName** *(string) --* 

                A database name in the Glue Data Catalog.

                
              

              - **TableName** *(string) --* 

                A table name in the Glue Data Catalog.

                
              

              - **CatalogId** *(string) --* 

                A unique identifier for the Glue Data Catalog.

                
              

              - **ConnectionName** *(string) --* 

                The name of the connection to the Glue Data Catalog.

                
              

              - **AdditionalOptions** *(dict) --* 

                Additional options for the table. Currently there are two keys supported:

                 

                
                * ``pushDownPredicate``: to filter on partitions without having to list and read all the files in your dataset.
                 
                * ``catalogPartitionPredicate``: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
                

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **PreProcessingQuery** *(string) --* 

                SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog, before running the Data Quality Operation.

                
          
        
      
    
      

      - **NextToken** *(string) --* 

        A pagination token, if more results are available.

        
  
  **Exceptions**
  
  *   :py:class:`Glue.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Glue.Client.exceptions.OperationTimeoutException`

  
  *   :py:class:`Glue.Client.exceptions.InternalServiceException`

  