data_quality_ruleset_evaluation_runs

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

Overview

Name	data_quality_ruleset_evaluation_runs
Type	Resource
Id	aws.glue.data_quality_ruleset_evaluation_runs

Fields

The following fields are returned by SELECT queries:

batch_get_data_quality_ruleset_evaluation_run

Name	Datatype	Description
runs	array	A list of evaluation run details for the requested run IDs.
runs_not_found	array	A list of run IDs that were not found.

get_data_quality_ruleset_evaluation_run

Name	Datatype	Description
additional_data_sources	object	A map of reference strings to additional data sources you can specify for an evaluation run.
additional_run_options	object	Additional run options you can specify for an evaluation run.
completed_on	string (date-time)	The date and time when this run was completed.
data_source	object	A data source (an Glue table) for which you want data quality results.
error_string	string	The error strings that are associated with the run.
execution_time	integer	The amount of time (in seconds) that the run consumed resources.
last_modified_on	string (date-time)	A timestamp. The last point in time when this data quality rule recommendation run was modified.
number_of_workers	integer	The number of G.1X workers to be used in the run. The default is 5.
result_ids	array	A list of result IDs for the data quality results for the run.
role	string	An IAM role supplied to encrypt the results of the run.
ruleset_names	array	A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.
run_id	string	The unique run identifier associated with this run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
started_on	string (date-time)	The date and time when this run started.
status	string	The status for this run. (STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED, TIMEOUT)
timeout	integer	The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

list_data_quality_ruleset_evaluation_runs

Name	Datatype	Description
next_token	string	A pagination token, if more results are available.
runs	array	A list of DataQualityRulesetEvaluationRunDescription objects representing data quality ruleset runs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_data_quality_ruleset_evaluation_run	select	region		Retrieves the details of multiple evaluation runs in a single request.
get_data_quality_ruleset_evaluation_run	select	region		Retrieves a specific run where a ruleset is evaluated against a data source.
list_data_quality_ruleset_evaluation_runs	select	region		Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.

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_ruleset_evaluation_run

Retrieves the details of multiple evaluation runs in a single request.

SELECT
runs,
runs_not_found
FROM aws.glue.data_quality_ruleset_evaluation_runs
WHERE region = '{{ region }}' -- required
;

get_data_quality_ruleset_evaluation_run

Retrieves a specific run where a ruleset is evaluated against a data source.

SELECT
additional_data_sources,
additional_run_options,
completed_on,
data_source,
error_string,
execution_time,
last_modified_on,
number_of_workers,
result_ids,
role,
ruleset_names,
run_id,
started_on,
status,
timeout
FROM aws.glue.data_quality_ruleset_evaluation_runs
WHERE region = '{{ region }}' -- required
;

list_data_quality_ruleset_evaluation_runs

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

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