data_quality_rule_recommendation_runs

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

Overview

Name	data_quality_rule_recommendation_runs
Type	Resource
Id	aws.glue.data_quality_rule_recommendation_runs

Fields

The following fields are returned by SELECT queries:

get_data_quality_rule_recommendation_run

Name	Datatype	Description
additional_run_options	object	Additional run options you can specify for a recommendation run.
completed_on	string (date-time)	The date and time when this run was completed.
created_ruleset_name	string	The name of the ruleset that was created by the run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
data_quality_security_configuration	string	The name of the security configuration created with the data quality encryption option. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
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.
recommended_ruleset	string	When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
role	string	An IAM role supplied to encrypt the results of the run.
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_rule_recommendation_runs

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_quality_rule_recommendation_run	select	region		Gets the specified recommendation run that was used to generate rules.
list_data_quality_rule_recommendation_runs	select	region		Lists the recommendation runs meeting the filter criteria.

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

get_data_quality_rule_recommendation_run

Gets the specified recommendation run that was used to generate rules.

SELECT
additional_run_options,
completed_on,
created_ruleset_name,
data_quality_security_configuration,
data_source,
error_string,
execution_time,
last_modified_on,
number_of_workers,
recommended_ruleset,
role,
run_id,
started_on,
status,
timeout
FROM aws.glue.data_quality_rule_recommendation_runs
WHERE region = '{{ region }}' -- required
;

list_data_quality_rule_recommendation_runs

Lists the recommendation runs meeting the filter criteria.

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