Glue / Client / list_data_quality_results

list_data_quality_results

Glue.Client.list_data_quality_results(**kwargs)

Returns all data quality execution results for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_data_quality_results(
    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'
            }
        },
        'JobName': 'string',
        'JobRunId': 'string',
        'StartedAfter': datetime(2015, 1, 1),
        'StartedBefore': datetime(2015, 1, 1),
        'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
        'DataQualityEvaluationConfig': 'string'
    },
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Filter (dict) –

    The filter criteria.

    • DataSource (dict) –

      Filter results by the specified data source. For example, retrieving all results for an Glue table.

      • 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.

    • JobName (string) –

      Filter results by the specified job name.

    • JobRunId (string) –

      Filter results by the specified job run ID.

    • StartedAfter (datetime) –

      Filter results by runs that started after this time.

    • StartedBefore (datetime) –

      Filter results by runs that started before this time.

    • 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.

  • NextToken (string) – A paginated token to offset the results.

  • MaxResults (integer) – The maximum number of results to return.

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'
                }
            },
            'JobName': 'string',
            'JobRunId': 'string',
            'StartedOn': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Results (list) –

      A list of DataQualityResultDescription objects.

      • (dict) –

        Describes a data quality result.

        • 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 name associated with the data quality result.

          • 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.

        • JobName (string) –

          The job name associated with the data quality result.

        • JobRunId (string) –

          The job run ID associated with the data quality result.

        • StartedOn (datetime) –

          The time that the run started for this data quality result.

    • NextToken (string) –

      A pagination token, if more results are available.

Exceptions