Glue / Paginator / ListDataQualityResultsV2

ListDataQualityResultsV2¶

class Glue.Paginator.ListDataQualityResultsV2¶

paginator = client.get_paginator('list_data_quality_results_v2')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Glue.Client.list_data_quality_results_v2().

Request Syntax

response_iterator = paginator.paginate(
    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'
            }
        },
        'PublishedAfter': datetime(2015, 1, 1),
        'PublishedBefore': datetime(2015, 1, 1),
        'Dimensions': {
            'string': 'string'
        },
        'EvaluationContext': 'string',
        'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
        'DataQualityEvaluationConfig': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Filter (dict) –
The filter criteria.
- DataSource (dict) –
  
  The data source used to filter the results. For example, you can retrieve all results for an Glue table. DatabaseName and TableName are required. If you omit CatalogId, the catalog of the calling account is used.
  
  When you filter by data source, a page of results can be empty but still include a NextToken. Keep requesting pages until NextToken is absent.
  - 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.
- PublishedAfter (datetime) –
  
  The time after which to include published results.
- PublishedBefore (datetime) –
  
  The time before which to include published results.
- Dimensions (dict) –
  
  The platform dimensions to filter results by.
  - (string) –
    - (string) –
- EvaluationContext (string) –
  
  The evaluation context to filter results by.
- EvaluationRunMode (string) –
  
  Filter results by how their evaluation run started: ON_DEMAND or EVALUATION_CONFIG. Results that no evaluation run produced match neither value.
- DataQualityEvaluationConfig (string) –
  
  Filter results by the evaluation configuration name which started the evaluation run.
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

{
    'Results': [
        {
            'ResultId': 'string',
            'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
            'DataQualityEvaluationConfig': 'string',
            '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'
                }
            },
            'ResultPublishedOn': datetime(2015, 1, 1),
            'Dimensions': {
                'string': 'string'
            },
            'EvaluationContext': 'string',
            'Descriptors': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

(dict) –
- Results (list) –
  
  A list of DataQualityResultsV2Description objects.
  - (dict) –
    
    Describes a data quality result returned by ListDataQualityResultsV2.
    - ResultId (string) –
      
      The unique result ID for this data quality result.
    - EvaluationRunMode (string) –
      
      How the evaluation run that produced the result started: ON_DEMAND for a run started by StartDataQualityRulesetEvaluationRun, or EVALUATION_CONFIG for a run started by a data quality evaluation configuration. Not returned for results that no evaluation run produced, such as results from any ETL job.
    - DataQualityEvaluationConfig (string) –
      
      The name of the data quality evaluation configuration that started the evaluation run, returned when EvaluationRunMode is EVALUATION_CONFIG.
    - DataSource (dict) –
      
      The table associated with the data quality result, if any.
      - 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.
    - ResultPublishedOn (datetime) –
      
      The date and time when this data quality result was published.
    - Dimensions (dict) –
      
      A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.
      - (string) –
        
        (string) –
    - EvaluationContext (string) –
      
      The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.
    - Descriptors (dict) –
      
      A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.
      - (string) –
        
        (string) –