EvaluateDataQuality class - AWS Glue

EvaluateDataQuality class

AWS Glue Data Quality is in preview release for AWS Glue and is subject to change.

Evaluates a data quality ruleset against a DynamicFrame and returns a new DynamicFrame with results of the evaluation.


The following example code demonstrates how to evaluate data quality for a DynamicFrame and then view the data quality results.

from awsglue.transforms import * from pyspark.context import SparkContext from awsglue.context import GlueContext from awsgluedq.transforms import EvaluateDataQuality #Create Glue context sc = SparkContext.getOrCreate() glueContext = GlueContext(sc) # Define DynamicFrame legislatorsAreas = glueContext.create_dynamic_frame.from_catalog( database="legislators", table_name="areas_json") # Create data quality ruleset ruleset = """Rules = [ColumnExists "id", IsComplete "id"]""" # Evaluate data quality dqResults = EvaluateDataQuality.apply( frame=legislatorsAreas, ruleset=ruleset, publishing_options={ "dataQualityEvaluationContext": "legislatorsAreas", "enableDataQualityCloudWatchMetrics": True, "enableDataQualityResultsPublishing": True, "resultsS3Prefix": "DOC-EXAMPLE-BUCKET1", }, ) # Inspect data quality results dqResults.printSchema() dqResults.toDF().show()
root |-- Rule: string |-- Outcome: string |-- FailureReason: string |-- EvaluatedMetrics: map | |-- keyType: string | |-- valueType: double +-----------------------+-------+-------------+---------------------------------------+ |Rule |Outcome|FailureReason|EvaluatedMetrics | +-----------------------+-------+-------------+---------------------------------------+ |ColumnExists "id" |Passed |null |{} | |IsComplete "id" |Passed |null |{Column.first_name.Completeness -> 1.0}| +-----------------------+-------+-------------+---------------------------------------+


__call__(frame, ruleset, publishing_options = {})

  • frame – The DynamicFrame that you want evaluate the data quality of.

  • ruleset – A Data Quality Definition Language (DQDL) ruleset in string format. To learn more about DQDL, see the Data Quality Definition Language (DQDL) guide.

  • publishing_options – A dictionary that specifies the following options for publishing evaluation results and metrics:

    • dataQualityEvaluationContext – A string that specifies the namespace under which AWS Glue should publish Amazon CloudWatch metrics and the data quality results. The aggregated metrics appear in CloudWatch, while the full results appear in the AWS Glue Studio interface.

      • Required: No

      • Default value: default_context

    • enableDataQualityCloudWatchMetrics – Specifies whether the results of the data quality evaluation should be published to CloudWatch. You specify a namespace for the metrics using the dataQualityEvaluationContext option.

      • Required: No

      • Default value: False

    • enableDataQualityResultsPublishing – Specifies whether the data quality results should be visible on the Data Quality tab in the AWS Glue Studio interface.

      • Required: No

      • Default value: True

    • resultsS3Prefix – Specifies the Amazon S3 location where AWS Glue can write the data quality evaluation results.

      • Required: No

      • Default value: "" (empty string)

apply(cls, *args, **kwargs)

Inherited from GlueTransform apply.


Inherited from GlueTransform name.


Inherited from GlueTransform describeArgs.


Inherited from GlueTransform describeReturn.


Inherited from GlueTransform describeTransform.


Inherited from GlueTransform describeErrors.


Inherited from GlueTransform describe.