data_quality_results

Creates, updates, deletes, gets or lists a data_quality_results resource.

Overview

Name	data_quality_results
Type	Resource
Id	aws.glue.data_quality_results

Fields

The following fields are returned by SELECT queries:

batch_get_data_quality_result

Name	Datatype	Description
results	array	A list of DataQualityResult objects representing the data quality results.
results_not_found	array	A list of result IDs for which results were not found.

get_data_quality_result

Name	Datatype	Description
aggregated_metrics	object	A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.
analyzer_results	array	A list of DataQualityAnalyzerResult objects representing the results for each analyzer.
completed_on	string (date-time)	The date and time when the run for this data quality result was completed.
data_source	object	A data source (an Glue table) for which you want data quality results.
evaluation_context	string	In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.
job_name	string	The job name associated with the data quality result, if any. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
job_run_id	string	The job run ID associated with the data quality result, if any. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
observations	array	A list of DataQualityObservation objects representing the observations generated after evaluating the rules and analyzers.
profile_id	string	The Profile ID for the data quality result. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
result_id	string	A unique result ID for the data quality result. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
rule_results	array	A list of DataQualityRuleResult objects representing the results for each rule.
ruleset_evaluation_run_id	string	The unique run ID associated with the ruleset evaluation. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
ruleset_name	string	The name of the ruleset associated with the data quality result. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
score	number (double)	An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
started_on	string (date-time)	The date and time when the run for this data quality result started.

list_data_quality_results

Name	Datatype	Description
next_token	string	A pagination token, if more results are available.
results	array	A list of DataQualityResultDescription objects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_data_quality_result	select	region		Retrieves a list of data quality results for the specified result IDs.
get_data_quality_result	select	region		Retrieves the result of a data quality rule evaluation.
list_data_quality_results	select	region		Returns all data quality execution results for your account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_data_quality_result

Retrieves a list of data quality results for the specified result IDs.

SELECT
results,
results_not_found
FROM aws.glue.data_quality_results
WHERE region = '{{ region }}' -- required
;

get_data_quality_result

Retrieves the result of a data quality rule evaluation.

SELECT
aggregated_metrics,
analyzer_results,
completed_on,
data_source,
evaluation_context,
job_name,
job_run_id,
observations,
profile_id,
result_id,
rule_results,
ruleset_evaluation_run_id,
ruleset_name,
score,
started_on
FROM aws.glue.data_quality_results
WHERE region = '{{ region }}' -- required
;

list_data_quality_results

Returns all data quality execution results for your account.

SELECT
next_token,
results
FROM aws.glue.data_quality_results
WHERE region = '{{ region }}' -- required
;