2026/11/09 - AWS Glue - 5 new 6 updated api methods
Changes We are releasing five new APIs to allow customers to enable Catalog-level data quality monitoring in AWS Glue Data Catalog, a new feature to perform data quality evaluation on collections of GDC tables selected by the customer, on a schedule or event-driven basis, using a custom or managed ruleset.
Updates a data quality evaluation configuration. Fields that you don't specify keep their current values.
See also: AWS API Documentation
Request Syntax
client.update_data_quality_evaluation_config(
Name='string',
DataSource={
'GlueTables': {
'CatalogId': 'string',
'DatabaseName': 'string',
'TableNamePattern': 'string',
'PreProcessingQuery': 'string',
'ConnectionName': 'string',
'AdditionalOptions': {
'string': 'string'
}
}
},
RulesetName='string',
ManagedRulesetName='SIMPLE'|'ADVANCED',
Triggers=[
'ONCE'|'SCHEDULE'|'METADATA_CHANGE',
],
ScheduleExpression='string',
StartAt=datetime(2015, 1, 1),
EndAt=datetime(2015, 1, 1),
PauseRuns=True|False,
Role='string',
NumberOfWorkers=123,
Timeout=123,
AdditionalRunOptions={
'CloudWatchMetricsEnabled': True|False,
'ResultsS3Prefix': 'string',
'CompositeRuleEvaluationMethod': 'COLUMN'|'ROW',
'RowLevelResults': {
'MaxRowsToWrite': 123,
'ResultType': 'ALL'|'PASSED_ONLY'|'FAILED_ONLY',
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ProfilingResults': {
'WriteProfilingResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
},
'DistributionResults': {
'WriteDistributionResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
}
},
'ObservationScope': 'ALL'|'NONE',
'ObservationMode': 'SCHEDULED'|'FIXED',
'DataQualityRuleResults': {
'WriteDataQualityRuleResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ObservationResults': {
'WriteObservationResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'CustomLogGroupPrefix': 'string'
},
AdditionalDataSources={
'string': {
'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'
}
}
}
)
string
[REQUIRED]
The name of the data quality evaluation configuration to update.
dict
The database or table that the configuration applies to. Replaces the current data source.
GlueTables (dict) --
The Glue Data Catalog tables that the configuration applies to.
CatalogId (string) -- [REQUIRED]
A unique identifier for the Glue Data Catalog.
DatabaseName (string) --
A database name in the Glue Data Catalog.
TableNamePattern (string) --
For the CATALOG and DATABASE levels, a glob pattern, such as orders_*, that selects tables. If you don't specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.
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.
For the CATALOG and DATABASE levels, use the {{DATABASE_NAME}} and {{TABLE_NAME}} placeholders, which are filled in for each table.
ConnectionName (string) --
The name of the connection to the Glue Data Catalog.
AdditionalOptions (dict) --
Options for reading the table. The following keys are 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) --
string
The name of a Data Quality Definition Language (DQDL) ruleset, containing analyzers, rules, or both, to evaluate tables with. You create the ruleset using the CreateDataQualityRuleset API. Specify either RulesetName or ManagedRulesetName, not both.
string
A built-in ruleset, SIMPLE or ADVANCED, that profiles each table.
list
When the configuration evaluates tables. Replaces the current triggers. Choose from the following triggers:
ONCE
Evaluates each table one time, including when tables are added to a database or catalog.
SCHEDULE
Evaluates each table on the cron or rate expression in ScheduleExpression, between the optional StartAt and EndAt times.
METADATA_CHANGE
Evaluates a table whenever its Glue Data Catalog metadata changes, such as a schema change or an Apache Iceberg commit.
(string) --
string
A cron or rate expression, in UTC, for the SCHEDULE trigger, for example cron(0 6 * * ? *). The schedule can run at most once an hour.
datetime
The time from which the schedule runs, inclusive.
datetime
The time at which the schedule stops running, exclusive.
boolean
Specifies whether to pause the configuration. While paused, the configuration evaluates nothing, including tables added to the catalog or database.
string
The IAM role that evaluations assume. You can specify the role name or the role Amazon Resource Name (ARN). The role needs the trust policy and permissions described for CreateDataQualityEvaluationConfig.
integer
The number of G.1X workers to be used in the run. The default is 5.
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).
dict
Additional run options you can specify for an evaluation run.
CloudWatchMetricsEnabled (boolean) --
Specifies whether to enable CloudWatch metrics.
ResultsS3Prefix (string) --
Prefix for Amazon S3 to store results.
CompositeRuleEvaluationMethod (string) --
Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
RowLevelResults (dict) --
The configuration for writing row-level evaluation results to a Glue Data Catalog table.
MaxRowsToWrite (integer) --
The maximum number of rows to write in the results.
ResultType (string) --
The result type to include in the row-level results output.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ProfilingResults (dict) --
The configuration for writing profiling results to a Glue Data Catalog table.
WriteProfilingResultsEnabled (boolean) --
Set to true to write profiling results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the profiling results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
DistributionResults (dict) --
The configuration for writing distribution results.
WriteDistributionResultsEnabled (boolean) --
Set to true to write distribution results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the distribution results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationScope (string) --
The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.
ObservationMode (string) --
The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.
DataQualityRuleResults (dict) --
The configuration for writing rule results to a Glue Data Catalog table.
WriteDataQualityRuleResultsEnabled (boolean) --
Set to true to write data quality rule results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the rule results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationResults (dict) --
The configuration for writing observation results to a Glue Data Catalog table.
WriteObservationResultsEnabled (boolean) --
Set to true to write observation results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the observation results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
CustomLogGroupPrefix (string) --
A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.
dict
A map of reference strings to additional data sources you can specify for an evaluation run.
(string) --
(dict) --
A data source (an Glue table) for which you want data quality results.
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.
dict
Response Syntax
{
'Name': 'string',
'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'Level': 'CATALOG'|'DATABASE'|'TABLE',
'DataSource': {
'GlueTables': {
'CatalogId': 'string',
'DatabaseName': 'string',
'TableNamePattern': 'string',
'PreProcessingQuery': 'string',
'ConnectionName': 'string',
'AdditionalOptions': {
'string': 'string'
}
}
},
'RulesetName': 'string',
'ManagedRulesetName': 'SIMPLE'|'ADVANCED',
'Triggers': [
'ONCE'|'SCHEDULE'|'METADATA_CHANGE',
],
'ScheduleExpression': 'string',
'StartAt': datetime(2015, 1, 1),
'EndAt': datetime(2015, 1, 1),
'PauseRuns': True|False,
'Role': 'string',
'NumberOfWorkers': 123,
'Timeout': 123,
'AdditionalRunOptions': {
'CloudWatchMetricsEnabled': True|False,
'ResultsS3Prefix': 'string',
'CompositeRuleEvaluationMethod': 'COLUMN'|'ROW',
'RowLevelResults': {
'MaxRowsToWrite': 123,
'ResultType': 'ALL'|'PASSED_ONLY'|'FAILED_ONLY',
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ProfilingResults': {
'WriteProfilingResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
},
'DistributionResults': {
'WriteDistributionResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
}
},
'ObservationScope': 'ALL'|'NONE',
'ObservationMode': 'SCHEDULED'|'FIXED',
'DataQualityRuleResults': {
'WriteDataQualityRuleResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ObservationResults': {
'WriteObservationResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'CustomLogGroupPrefix': 'string'
},
'AdditionalDataSources': {
'string': {
'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'
}
}
}
}
Response Structure
(dict) --
Name (string) --
The name of the data quality evaluation configuration.
EvaluationRunMode (string) --
The evaluation run mode of the configuration's results, which is EVALUATION_CONFIG.
CreatedOn (datetime) --
The time when the configuration was created.
LastModifiedOn (datetime) --
The time when the configuration was last modified.
Level (string) --
The Glue Data Catalog hierarchical level that the configuration applies to.
DataSource (dict) --
The catalog, database, or table that the configuration applies to.
GlueTables (dict) --
The Glue Data Catalog tables that the configuration applies to.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
DatabaseName (string) --
A database name in the Glue Data Catalog.
TableNamePattern (string) --
For the CATALOG and DATABASE levels, a glob pattern, such as orders_*, that selects tables. If you don't specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.
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.
For the CATALOG and DATABASE levels, use the {{DATABASE_NAME}} and {{TABLE_NAME}} placeholders, which are filled in for each table.
ConnectionName (string) --
The name of the connection to the Glue Data Catalog.
AdditionalOptions (dict) --
Options for reading the table. The following keys are 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) --
RulesetName (string) --
The name of the data quality ruleset that tables are evaluated with.
ManagedRulesetName (string) --
The built-in ruleset that tables are evaluated with.
Triggers (list) --
When the configuration evaluates tables:
ONCE
Each table is evaluated one time, including when tables are added to a database or catalog.
SCHEDULE
Each table is evaluated on the cron or rate expression in ScheduleExpression.
METADATA_CHANGE
A table is evaluated whenever its Glue Data Catalog metadata changes.
(string) --
ScheduleExpression (string) --
The cron or rate expression, in UTC, for the SCHEDULE trigger.
StartAt (datetime) --
The time from which the schedule runs, inclusive.
EndAt (datetime) --
The time at which the schedule stops running, exclusive.
PauseRuns (boolean) --
Specifies whether evaluations are paused.
Role (string) --
The Amazon Resource Name (ARN) of the IAM role that evaluation runs assume.
NumberOfWorkers (integer) --
The number of G.1X workers to be used in the run. The default is 5.
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).
AdditionalRunOptions (dict) --
Additional run options you can specify for an evaluation run.
CloudWatchMetricsEnabled (boolean) --
Specifies whether to enable CloudWatch metrics.
ResultsS3Prefix (string) --
Prefix for Amazon S3 to store results.
CompositeRuleEvaluationMethod (string) --
Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
RowLevelResults (dict) --
The configuration for writing row-level evaluation results to a Glue Data Catalog table.
MaxRowsToWrite (integer) --
The maximum number of rows to write in the results.
ResultType (string) --
The result type to include in the row-level results output.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ProfilingResults (dict) --
The configuration for writing profiling results to a Glue Data Catalog table.
WriteProfilingResultsEnabled (boolean) --
Set to true to write profiling results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the profiling results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
DistributionResults (dict) --
The configuration for writing distribution results.
WriteDistributionResultsEnabled (boolean) --
Set to true to write distribution results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the distribution results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationScope (string) --
The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.
ObservationMode (string) --
The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.
DataQualityRuleResults (dict) --
The configuration for writing rule results to a Glue Data Catalog table.
WriteDataQualityRuleResultsEnabled (boolean) --
Set to true to write data quality rule results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the rule results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationResults (dict) --
The configuration for writing observation results to a Glue Data Catalog table.
WriteObservationResultsEnabled (boolean) --
Set to true to write observation results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the observation results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
CustomLogGroupPrefix (string) --
A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.
AdditionalDataSources (dict) --
A map of reference strings to additional data sources you can specify for an evaluation run.
(string) --
(dict) --
A data source (an Glue table) for which you want data quality results.
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.
Lists the data quality evaluation configurations in your account, optionally filtered by level.
See also: AWS API Documentation
Request Syntax
client.list_data_quality_evaluation_configs(
Level='CATALOG'|'DATABASE'|'TABLE',
MaxResults=123,
NextToken='string'
)
string
Lists only the configurations that apply to this level.
integer
The maximum number of results to return.
string
A paginated token to offset the results. If you don't specify a token, the operation returns results starting from the beginning of the list.
dict
Response Syntax
{
'DataQualityEvaluationConfigs': [
{
'Name': 'string',
'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'Level': 'CATALOG'|'DATABASE'|'TABLE',
'DataSource': {
'GlueTables': {
'CatalogId': 'string',
'DatabaseName': 'string',
'TableNamePattern': 'string'
}
},
'RulesetName': 'string',
'ManagedRulesetName': 'SIMPLE'|'ADVANCED',
'PauseRuns': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DataQualityEvaluationConfigs (list) --
A list of DataQualityEvaluationConfigListDetails objects.
(dict) --
Describes a data quality evaluation configuration.
Name (string) --
The name of the data quality evaluation configuration.
EvaluationRunMode (string) --
The evaluation run mode of the configuration's results, which is EVALUATION_CONFIG.
CreatedOn (datetime) --
The time when the configuration was created.
LastModifiedOn (datetime) --
The time when the configuration was last modified.
Level (string) --
The Glue Data Catalog hierarchical level that the configuration applies to.
DataSource (dict) --
The catalog, database, or table that the configuration applies to.
GlueTables (dict) --
The Glue Data Catalog tables that the configuration applies to.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
DatabaseName (string) --
A database name in the Glue Data Catalog.
TableNamePattern (string) --
For the CATALOG and DATABASE levels, a glob pattern, such as orders_*, that selects tables. If you don't specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.
RulesetName (string) --
The name of the data quality ruleset that tables are evaluated with.
ManagedRulesetName (string) --
The built-in ruleset that tables are evaluated with.
PauseRuns (boolean) --
Specifies whether evaluations are paused.
NextToken (string) --
A pagination token, if more results are available.
Retrieves a data quality evaluation configuration.
See also: AWS API Documentation
Request Syntax
client.get_data_quality_evaluation_config(
Name='string'
)
string
[REQUIRED]
The name of the data quality evaluation configuration.
dict
Response Syntax
{
'Name': 'string',
'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
'CreatedOn': datetime(2015, 1, 1),
'LastModifiedOn': datetime(2015, 1, 1),
'Level': 'CATALOG'|'DATABASE'|'TABLE',
'DataSource': {
'GlueTables': {
'CatalogId': 'string',
'DatabaseName': 'string',
'TableNamePattern': 'string',
'PreProcessingQuery': 'string',
'ConnectionName': 'string',
'AdditionalOptions': {
'string': 'string'
}
}
},
'RulesetName': 'string',
'ManagedRulesetName': 'SIMPLE'|'ADVANCED',
'Triggers': [
'ONCE'|'SCHEDULE'|'METADATA_CHANGE',
],
'ScheduleExpression': 'string',
'StartAt': datetime(2015, 1, 1),
'EndAt': datetime(2015, 1, 1),
'PauseRuns': True|False,
'Role': 'string',
'NumberOfWorkers': 123,
'Timeout': 123,
'AdditionalRunOptions': {
'CloudWatchMetricsEnabled': True|False,
'ResultsS3Prefix': 'string',
'CompositeRuleEvaluationMethod': 'COLUMN'|'ROW',
'RowLevelResults': {
'MaxRowsToWrite': 123,
'ResultType': 'ALL'|'PASSED_ONLY'|'FAILED_ONLY',
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ProfilingResults': {
'WriteProfilingResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
},
'DistributionResults': {
'WriteDistributionResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
}
},
'ObservationScope': 'ALL'|'NONE',
'ObservationMode': 'SCHEDULED'|'FIXED',
'DataQualityRuleResults': {
'WriteDataQualityRuleResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ObservationResults': {
'WriteObservationResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'CustomLogGroupPrefix': 'string'
},
'AdditionalDataSources': {
'string': {
'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'
}
}
}
}
Response Structure
(dict) --
Name (string) --
The name of the data quality evaluation configuration.
EvaluationRunMode (string) --
The evaluation run mode of the configuration's results, which is EVALUATION_CONFIG.
CreatedOn (datetime) --
The time when the configuration was created.
LastModifiedOn (datetime) --
The time when the configuration was last modified.
Level (string) --
The Glue Data Catalog hierarchical level that the configuration applies to.
DataSource (dict) --
The catalog, database, or table that the configuration applies to.
GlueTables (dict) --
The Glue Data Catalog tables that the configuration applies to.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
DatabaseName (string) --
A database name in the Glue Data Catalog.
TableNamePattern (string) --
For the CATALOG and DATABASE levels, a glob pattern, such as orders_*, that selects tables. If you don't specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.
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.
For the CATALOG and DATABASE levels, use the {{DATABASE_NAME}} and {{TABLE_NAME}} placeholders, which are filled in for each table.
ConnectionName (string) --
The name of the connection to the Glue Data Catalog.
AdditionalOptions (dict) --
Options for reading the table. The following keys are 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) --
RulesetName (string) --
The name of the data quality ruleset that tables are evaluated with.
ManagedRulesetName (string) --
The built-in ruleset that tables are evaluated with.
Triggers (list) --
When the configuration evaluates tables:
ONCE
Each table is evaluated one time, including when tables are added to a database or catalog.
SCHEDULE
Each table is evaluated on the cron or rate expression in ScheduleExpression.
METADATA_CHANGE
A table is evaluated whenever its Glue Data Catalog metadata changes.
(string) --
ScheduleExpression (string) --
The cron or rate expression, in UTC, for the SCHEDULE trigger.
StartAt (datetime) --
The time from which the schedule runs, inclusive.
EndAt (datetime) --
The time at which the schedule stops running, exclusive.
PauseRuns (boolean) --
Specifies whether evaluations are paused.
Role (string) --
The Amazon Resource Name (ARN) of the IAM role that evaluation runs assume.
NumberOfWorkers (integer) --
The number of G.1X workers to be used in the run. The default is 5.
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).
AdditionalRunOptions (dict) --
Additional run options you can specify for an evaluation run.
CloudWatchMetricsEnabled (boolean) --
Specifies whether to enable CloudWatch metrics.
ResultsS3Prefix (string) --
Prefix for Amazon S3 to store results.
CompositeRuleEvaluationMethod (string) --
Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
RowLevelResults (dict) --
The configuration for writing row-level evaluation results to a Glue Data Catalog table.
MaxRowsToWrite (integer) --
The maximum number of rows to write in the results.
ResultType (string) --
The result type to include in the row-level results output.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ProfilingResults (dict) --
The configuration for writing profiling results to a Glue Data Catalog table.
WriteProfilingResultsEnabled (boolean) --
Set to true to write profiling results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the profiling results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
DistributionResults (dict) --
The configuration for writing distribution results.
WriteDistributionResultsEnabled (boolean) --
Set to true to write distribution results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the distribution results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationScope (string) --
The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.
ObservationMode (string) --
The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.
DataQualityRuleResults (dict) --
The configuration for writing rule results to a Glue Data Catalog table.
WriteDataQualityRuleResultsEnabled (boolean) --
Set to true to write data quality rule results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the rule results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationResults (dict) --
The configuration for writing observation results to a Glue Data Catalog table.
WriteObservationResultsEnabled (boolean) --
Set to true to write observation results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the observation results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
CustomLogGroupPrefix (string) --
A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.
AdditionalDataSources (dict) --
A map of reference strings to additional data sources you can specify for an evaluation run.
(string) --
(dict) --
A data source (an Glue table) for which you want data quality results.
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.
Creates a data quality evaluation configuration, which evaluates the data quality of a collection of tables in the Glue Data Catalog once, on a schedule, or when table metadata changes. A configuration applies to a catalog, a database, or a single table, and evaluates every table in scope, including tables added later, without per-table setup.
When configurations at more than one level apply to the same table, the most specific configuration applies. Each table is evaluated at most once an hour, whichever triggers you choose.
See also: AWS API Documentation
Request Syntax
client.create_data_quality_evaluation_config(
Name='string',
Level='CATALOG'|'DATABASE'|'TABLE',
DataSource={
'GlueTables': {
'CatalogId': 'string',
'DatabaseName': 'string',
'TableNamePattern': 'string',
'PreProcessingQuery': 'string',
'ConnectionName': 'string',
'AdditionalOptions': {
'string': 'string'
}
}
},
RulesetName='string',
ManagedRulesetName='SIMPLE'|'ADVANCED',
Triggers=[
'ONCE'|'SCHEDULE'|'METADATA_CHANGE',
],
ScheduleExpression='string',
StartAt=datetime(2015, 1, 1),
EndAt=datetime(2015, 1, 1),
Role='string',
NumberOfWorkers=123,
Timeout=123,
AdditionalRunOptions={
'CloudWatchMetricsEnabled': True|False,
'ResultsS3Prefix': 'string',
'CompositeRuleEvaluationMethod': 'COLUMN'|'ROW',
'RowLevelResults': {
'MaxRowsToWrite': 123,
'ResultType': 'ALL'|'PASSED_ONLY'|'FAILED_ONLY',
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ProfilingResults': {
'WriteProfilingResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
},
'DistributionResults': {
'WriteDistributionResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
}
},
'ObservationScope': 'ALL'|'NONE',
'ObservationMode': 'SCHEDULED'|'FIXED',
'DataQualityRuleResults': {
'WriteDataQualityRuleResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'ObservationResults': {
'WriteObservationResultsEnabled': True|False,
'CatalogTableConfig': {
'DatabaseName': 'string',
'TableName': 'string',
'S3Location': 'string',
'CatalogId': 'string'
}
},
'CustomLogGroupPrefix': 'string'
},
AdditionalDataSources={
'string': {
'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'
}
}
},
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
A name for the data quality evaluation configuration. The name must be unique within your account.
string
[REQUIRED]
The Glue Data Catalog hierarchical level that the configuration applies to. Valid values are CATALOG, DATABASE, and TABLE.
dict
[REQUIRED]
The catalog, database, or table that the configuration applies to, as specified by Level.
GlueTables (dict) --
The Glue Data Catalog tables that the configuration applies to.
CatalogId (string) -- [REQUIRED]
A unique identifier for the Glue Data Catalog.
DatabaseName (string) --
A database name in the Glue Data Catalog.
TableNamePattern (string) --
For the CATALOG and DATABASE levels, a glob pattern, such as orders_*, that selects tables. If you don't specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.
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.
For the CATALOG and DATABASE levels, use the {{DATABASE_NAME}} and {{TABLE_NAME}} placeholders, which are filled in for each table.
ConnectionName (string) --
The name of the connection to the Glue Data Catalog.
AdditionalOptions (dict) --
Options for reading the table. The following keys are 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) --
string
The name of a Data Quality Definition Language (DQDL) ruleset, containing analyzers, rules, or both, to evaluate tables with. You create the ruleset using the CreateDataQualityRuleset API. Specify either RulesetName or ManagedRulesetName, not both.
string
A built-in ruleset that profiles each table, used when RulesetName is not set. The default is SIMPLE. Choose from the following built-in rulesets:
SIMPLE
Row count and column count, completeness, minimum, and maximum for every column, mean, sum, and standard deviation for numeric columns, and column length for string columns.
ADVANCED
Every statistic in SIMPLE, plus distribution, uniqueness, and distinct values count.
list
When the configuration evaluates tables. You can choose one or more triggers, and each table is evaluated at most once an hour. The default is ONCE. Choose from the following triggers:
ONCE
Evaluates each table one time, including when tables are added to a database or catalog.
SCHEDULE
Evaluates each table on the cron or rate expression in ScheduleExpression, between the optional StartAt and EndAt times.
METADATA_CHANGE
Evaluates a table whenever its Glue Data Catalog metadata changes, such as a schema change or an Apache Iceberg commit.
(string) --
string
A cron or rate expression, in UTC, for the SCHEDULE trigger, for example cron(0 6 * * ? *). The schedule can run at most once an hour.
datetime
The time from which the schedule runs, inclusive.
datetime
The time at which the schedule stops running, exclusive.
string
[REQUIRED]
The IAM role that evaluations assume. You can specify the role name or the role Amazon Resource Name (ARN).
The role must allow the glue.amazonaws.com service principal to assume it, and needs permissions to read the catalog ( glue:GetCatalog, glue:GetDatabase, glue:GetTable, glue:SearchTables, and glue:GetPartitions), read and create rulesets ( glue:GetDataQualityRuleset and glue:CreateDataQualityRuleset), start evaluations ( glue:StartDataQualityRulesetEvaluationRun, glue:PublishDataQuality, and iam:PassRole on the role itself), read the tables' data in Amazon S3, and write logs to Amazon CloudWatch Logs. If a catalog-level or database-level configuration applies to an Amazon S3 Tables catalog, the role also needs s3tables:ListTableBuckets and s3tables:ListTables. If you use Lake Formation, the role needs the DESCRIBE permission on the tables.
integer
The number of G.1X workers to be used in the run. The default is 5.
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).
dict
Additional run options you can specify for an evaluation run.
CloudWatchMetricsEnabled (boolean) --
Specifies whether to enable CloudWatch metrics.
ResultsS3Prefix (string) --
Prefix for Amazon S3 to store results.
CompositeRuleEvaluationMethod (string) --
Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
RowLevelResults (dict) --
The configuration for writing row-level evaluation results to a Glue Data Catalog table.
MaxRowsToWrite (integer) --
The maximum number of rows to write in the results.
ResultType (string) --
The result type to include in the row-level results output.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ProfilingResults (dict) --
The configuration for writing profiling results to a Glue Data Catalog table.
WriteProfilingResultsEnabled (boolean) --
Set to true to write profiling results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the profiling results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
DistributionResults (dict) --
The configuration for writing distribution results.
WriteDistributionResultsEnabled (boolean) --
Set to true to write distribution results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the distribution results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationScope (string) --
The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.
ObservationMode (string) --
The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.
DataQualityRuleResults (dict) --
The configuration for writing rule results to a Glue Data Catalog table.
WriteDataQualityRuleResultsEnabled (boolean) --
Set to true to write data quality rule results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the rule results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
ObservationResults (dict) --
The configuration for writing observation results to a Glue Data Catalog table.
WriteObservationResultsEnabled (boolean) --
Set to true to write observation results.
CatalogTableConfig (dict) --
The Glue Data Catalog table configuration for storing the observation results.
DatabaseName (string) --
The name of the database in the Glue Data Catalog.
TableName (string) --
The name of the table in the Glue Data Catalog.
S3Location (string) --
The Amazon S3 location for storing the results.
CatalogId (string) --
A unique identifier for the Glue Data Catalog.
CustomLogGroupPrefix (string) --
A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.
dict
A map of reference strings to additional data sources you can specify for an evaluation run.
(string) --
(dict) --
A data source (an Glue table) for which you want data quality results.
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.
dict
A list of tags applied to the data quality evaluation configuration.
(string) --
(string) --
string
A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Name': 'string',
'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG'
}
Response Structure
(dict) --
Name (string) --
The name of the data quality evaluation configuration.
EvaluationRunMode (string) --
The evaluation run mode of the configuration's results, which is EVALUATION_CONFIG.
Deletes a data quality evaluation configuration.
See also: AWS API Documentation
Request Syntax
client.delete_data_quality_evaluation_config(
Name='string'
)
string
[REQUIRED]
The name of the data quality evaluation configuration to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Results': {'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}}
Retrieves a list of data quality results for the specified result IDs.
See also: AWS API Documentation
Request Syntax
client.batch_get_data_quality_result(
ResultIds=[
'string',
]
)
list
[REQUIRED]
A list of unique result IDs for the data quality results.
(string) --
dict
Response Syntax
{
'Results': [
{
'ResultId': 'string',
'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
'DataQualityEvaluationConfig': 'string',
'ProfileId': 'string',
'Score': 123.0,
'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'
}
},
'RulesetName': 'string',
'EvaluationContext': 'string',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobName': 'string',
'JobRunId': 'string',
'RulesetEvaluationRunId': 'string',
'RuleResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'Result': 'PASS'|'FAIL'|'ERROR',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedRule': 'string',
'RuleMetrics': {
'string': 123.0
},
'Labels': {
'string': 'string'
}
},
],
'AnalyzerResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedDistributions': {
'string': {
'BinEdges': [
'string',
],
'Count': [
123,
],
'DataType': 'string'
}
}
},
],
'Observations': [
{
'Description': 'string',
'MetricBasedObservation': {
'MetricName': 'string',
'StatisticId': 'string',
'MetricValues': {
'ActualValue': 123.0,
'ExpectedValue': 123.0,
'LowerLimit': 123.0,
'UpperLimit': 123.0
},
'NewRules': [
'string',
]
}
},
],
'AggregatedMetrics': {
'TotalRowsProcessed': 123.0,
'TotalRowsPassed': 123.0,
'TotalRowsFailed': 123.0,
'TotalRulesProcessed': 123.0,
'TotalRulesPassed': 123.0,
'TotalRulesFailed': 123.0
}
},
],
'ResultsNotFound': [
'string',
]
}
Response Structure
(dict) --
Results (list) --
A list of DataQualityResult objects representing the data quality results.
(dict) --
Describes a data quality result.
ResultId (string) --
A unique result ID for the 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.
ProfileId (string) --
The Profile ID for the data quality result.
Score (float) --
An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
DataSource (dict) --
The table associated with the data quality result, if any.
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.
RulesetName (string) --
The name of the ruleset associated with the data quality result.
EvaluationContext (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.
StartedOn (datetime) --
The date and time when this data quality run started.
CompletedOn (datetime) --
The date and time when this data quality run completed.
JobName (string) --
The job name associated with the data quality result, if any.
JobRunId (string) --
The job run ID associated with the data quality result, if any.
RulesetEvaluationRunId (string) --
The unique run ID for the ruleset evaluation for this data quality result.
RuleResults (list) --
A list of DataQualityRuleResult objects representing the results for each rule.
(dict) --
Describes the result of the evaluation of a data quality rule.
Name (string) --
The name of the data quality rule.
Description (string) --
A description of the data quality rule.
EvaluationMessage (string) --
An evaluation message.
Result (string) --
A pass or fail status for the rule.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the rule.
(string) --
(float) --
EvaluatedRule (string) --
The evaluated rule.
RuleMetrics (dict) --
A map containing metrics associated with the evaluation of the rule based on row-level results.
(string) --
(float) --
Labels (dict) --
A map containing labels assigned to the data quality rule.
(string) --
(string) --
AnalyzerResults (list) --
A list of DataQualityAnalyzerResult objects representing the results for each analyzer.
(dict) --
Describes the result of the evaluation of a data quality analyzer.
Name (string) --
The name of the data quality analyzer.
Description (string) --
A description of the data quality analyzer.
EvaluationMessage (string) --
An evaluation message.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the analyzer.
(string) --
(float) --
EvaluatedDistributions (dict) --
A map of distribution metrics associated with the evaluation of the analyzer.
(string) --
(dict) --
The distribution data for a statistic.
BinEdges (list) --
The bin edge values for the distribution.
(string) --
Count (list) --
The frequency count for each bin in the distribution.
(integer) --
DataType (string) --
The data type of the column for the distribution.
Observations (list) --
A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.
(dict) --
Describes the observation generated after evaluating the rules and analyzers.
Description (string) --
A description of the data quality observation.
MetricBasedObservation (dict) --
An object of type MetricBasedObservation representing the observation that is based on evaluated data quality metrics.
MetricName (string) --
The name of the data quality metric used for generating the observation.
StatisticId (string) --
The Statistic ID.
MetricValues (dict) --
An object of type DataQualityMetricValues representing the analysis of the data quality metric value.
ActualValue (float) --
The actual value of the data quality metric.
ExpectedValue (float) --
The expected value of the data quality metric according to the analysis of historical data.
LowerLimit (float) --
The lower limit of the data quality metric value according to the analysis of historical data.
UpperLimit (float) --
The upper limit of the data quality metric value according to the analysis of historical data.
NewRules (list) --
A list of new data quality rules generated as part of the observation based on the data quality metric value.
(string) --
AggregatedMetrics (dict) --
A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.
TotalRowsProcessed (float) --
The total number of rows that were processed during the data quality evaluation.
TotalRowsPassed (float) --
The total number of rows that passed all applicable data quality rules.
TotalRowsFailed (float) --
The total number of rows that failed one or more data quality rules.
TotalRulesProcessed (float) --
The total number of data quality rules that were evaluated.
TotalRulesPassed (float) --
The total number of data quality rules that passed their evaluation criteria.
TotalRulesFailed (float) --
The total number of data quality rules that failed their evaluation criteria.
ResultsNotFound (list) --
A list of result IDs for which results were not found.
(string) --
{'Results': {'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}}
Retrieves a list of data quality results for the specified result IDs. You can specify up to 100 result IDs in a single request.
See also: AWS API Documentation
Request Syntax
client.batch_get_data_quality_result_v2(
ResultIds=[
'string',
]
)
list
[REQUIRED]
A list of unique result IDs for the data quality results.
(string) --
dict
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'
}
},
'Dimensions': {
'string': 'string'
},
'Tags': {
'string': 'string'
},
'ExecutionStartedOn': datetime(2015, 1, 1),
'ExecutionCompletedOn': datetime(2015, 1, 1),
'ResultPublishedOn': datetime(2015, 1, 1),
'Score': 123.0,
'RuleResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'Result': 'PASS'|'FAIL'|'ERROR',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedRule': 'string',
'RuleMetrics': {
'string': 123.0
},
'Labels': {
'string': 'string'
}
},
],
'AnalyzerResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedDistributions': {
'string': {
'BinEdges': [
'string',
],
'Count': [
123,
],
'DataType': 'string'
}
}
},
],
'Observations': [
{
'Description': 'string',
'MetricBasedObservation': {
'MetricName': 'string',
'StatisticId': 'string',
'MetricValues': {
'ActualValue': 123.0,
'ExpectedValue': 123.0,
'LowerLimit': 123.0,
'UpperLimit': 123.0
},
'NewRules': [
'string',
]
}
},
],
'EvaluationContext': 'string',
'Descriptors': {
'string': 'string'
},
'AggregatedMetrics': {
'TotalRowsProcessed': 123.0,
'TotalRowsPassed': 123.0,
'TotalRowsFailed': 123.0,
'TotalRulesProcessed': 123.0,
'TotalRulesPassed': 123.0,
'TotalRulesFailed': 123.0
},
'RulesetName': 'string'
},
],
'ResultsNotFound': [
'string',
]
}
Response Structure
(dict) --
Results (list) --
A list of DataQualityResultV2Item objects representing the data quality results.
(dict) --
Describes a data quality result returned by BatchGetDataQualityResultV2.
ResultId (string) --
A unique result ID for the 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 associated with the data quality result, if any.
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.
Dimensions (dict) --
A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.
(string) --
(string) --
Tags (dict) --
A map of tags associated with the data quality result.
(string) --
(string) --
ExecutionStartedOn (datetime) --
The date and time when this data quality run started.
ExecutionCompletedOn (datetime) --
The date and time when this data quality run completed.
ResultPublishedOn (datetime) --
The date and time when this data quality result was published.
Score (float) --
An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
RuleResults (list) --
A list of DataQualityRuleResult objects representing the results for each rule.
(dict) --
Describes the result of the evaluation of a data quality rule.
Name (string) --
The name of the data quality rule.
Description (string) --
A description of the data quality rule.
EvaluationMessage (string) --
An evaluation message.
Result (string) --
A pass or fail status for the rule.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the rule.
(string) --
(float) --
EvaluatedRule (string) --
The evaluated rule.
RuleMetrics (dict) --
A map containing metrics associated with the evaluation of the rule based on row-level results.
(string) --
(float) --
Labels (dict) --
A map containing labels assigned to the data quality rule.
(string) --
(string) --
AnalyzerResults (list) --
A list of DataQualityAnalyzerResult objects representing the results for each analyzer.
(dict) --
Describes the result of the evaluation of a data quality analyzer.
Name (string) --
The name of the data quality analyzer.
Description (string) --
A description of the data quality analyzer.
EvaluationMessage (string) --
An evaluation message.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the analyzer.
(string) --
(float) --
EvaluatedDistributions (dict) --
A map of distribution metrics associated with the evaluation of the analyzer.
(string) --
(dict) --
The distribution data for a statistic.
BinEdges (list) --
The bin edge values for the distribution.
(string) --
Count (list) --
The frequency count for each bin in the distribution.
(integer) --
DataType (string) --
The data type of the column for the distribution.
Observations (list) --
A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.
(dict) --
Describes the observation generated after evaluating the rules and analyzers.
Description (string) --
A description of the data quality observation.
MetricBasedObservation (dict) --
An object of type MetricBasedObservation representing the observation that is based on evaluated data quality metrics.
MetricName (string) --
The name of the data quality metric used for generating the observation.
StatisticId (string) --
The Statistic ID.
MetricValues (dict) --
An object of type DataQualityMetricValues representing the analysis of the data quality metric value.
ActualValue (float) --
The actual value of the data quality metric.
ExpectedValue (float) --
The expected value of the data quality metric according to the analysis of historical data.
LowerLimit (float) --
The lower limit of the data quality metric value according to the analysis of historical data.
UpperLimit (float) --
The upper limit of the data quality metric value according to the analysis of historical data.
NewRules (list) --
A list of new data quality rules generated as part of the observation based on the data quality metric value.
(string) --
EvaluationContext (string) --
The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.
Descriptors (dict) --
A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.
(string) --
(string) --
AggregatedMetrics (dict) --
A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.
TotalRowsProcessed (float) --
The total number of rows that were processed during the data quality evaluation.
TotalRowsPassed (float) --
The total number of rows that passed all applicable data quality rules.
TotalRowsFailed (float) --
The total number of rows that failed one or more data quality rules.
TotalRulesProcessed (float) --
The total number of data quality rules that were evaluated.
TotalRulesPassed (float) --
The total number of data quality rules that passed their evaluation criteria.
TotalRulesFailed (float) --
The total number of data quality rules that failed their evaluation criteria.
RulesetName (string) --
The name of the ruleset associated with the data quality result.
ResultsNotFound (list) --
A list of result IDs for which results were not found.
(string) --
{'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}
Retrieves the result of a data quality rule evaluation.
See also: AWS API Documentation
Request Syntax
client.get_data_quality_result(
ResultId='string'
)
string
[REQUIRED]
A unique result ID for the data quality result.
dict
Response Syntax
{
'ResultId': 'string',
'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
'DataQualityEvaluationConfig': 'string',
'ProfileId': 'string',
'Score': 123.0,
'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'
}
},
'RulesetName': 'string',
'EvaluationContext': 'string',
'StartedOn': datetime(2015, 1, 1),
'CompletedOn': datetime(2015, 1, 1),
'JobName': 'string',
'JobRunId': 'string',
'RulesetEvaluationRunId': 'string',
'RuleResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'Result': 'PASS'|'FAIL'|'ERROR',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedRule': 'string',
'RuleMetrics': {
'string': 123.0
},
'Labels': {
'string': 'string'
}
},
],
'AnalyzerResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedDistributions': {
'string': {
'BinEdges': [
'string',
],
'Count': [
123,
],
'DataType': 'string'
}
}
},
],
'Observations': [
{
'Description': 'string',
'MetricBasedObservation': {
'MetricName': 'string',
'StatisticId': 'string',
'MetricValues': {
'ActualValue': 123.0,
'ExpectedValue': 123.0,
'LowerLimit': 123.0,
'UpperLimit': 123.0
},
'NewRules': [
'string',
]
}
},
],
'AggregatedMetrics': {
'TotalRowsProcessed': 123.0,
'TotalRowsPassed': 123.0,
'TotalRowsFailed': 123.0,
'TotalRulesProcessed': 123.0,
'TotalRulesPassed': 123.0,
'TotalRulesFailed': 123.0
}
}
Response Structure
(dict) --
The response for the data quality result.
ResultId (string) --
A unique result ID for the 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.
ProfileId (string) --
The Profile ID for the data quality result.
Score (float) --
An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
DataSource (dict) --
The table associated with the data quality result, if any.
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.
RulesetName (string) --
The name of the ruleset associated with the data quality result.
EvaluationContext (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.
StartedOn (datetime) --
The date and time when the run for this data quality result started.
CompletedOn (datetime) --
The date and time when the run for this data quality result was completed.
JobName (string) --
The job name associated with the data quality result, if any.
JobRunId (string) --
The job run ID associated with the data quality result, if any.
RulesetEvaluationRunId (string) --
The unique run ID associated with the ruleset evaluation.
RuleResults (list) --
A list of DataQualityRuleResult objects representing the results for each rule.
(dict) --
Describes the result of the evaluation of a data quality rule.
Name (string) --
The name of the data quality rule.
Description (string) --
A description of the data quality rule.
EvaluationMessage (string) --
An evaluation message.
Result (string) --
A pass or fail status for the rule.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the rule.
(string) --
(float) --
EvaluatedRule (string) --
The evaluated rule.
RuleMetrics (dict) --
A map containing metrics associated with the evaluation of the rule based on row-level results.
(string) --
(float) --
Labels (dict) --
A map containing labels assigned to the data quality rule.
(string) --
(string) --
AnalyzerResults (list) --
A list of DataQualityAnalyzerResult objects representing the results for each analyzer.
(dict) --
Describes the result of the evaluation of a data quality analyzer.
Name (string) --
The name of the data quality analyzer.
Description (string) --
A description of the data quality analyzer.
EvaluationMessage (string) --
An evaluation message.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the analyzer.
(string) --
(float) --
EvaluatedDistributions (dict) --
A map of distribution metrics associated with the evaluation of the analyzer.
(string) --
(dict) --
The distribution data for a statistic.
BinEdges (list) --
The bin edge values for the distribution.
(string) --
Count (list) --
The frequency count for each bin in the distribution.
(integer) --
DataType (string) --
The data type of the column for the distribution.
Observations (list) --
A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.
(dict) --
Describes the observation generated after evaluating the rules and analyzers.
Description (string) --
A description of the data quality observation.
MetricBasedObservation (dict) --
An object of type MetricBasedObservation representing the observation that is based on evaluated data quality metrics.
MetricName (string) --
The name of the data quality metric used for generating the observation.
StatisticId (string) --
The Statistic ID.
MetricValues (dict) --
An object of type DataQualityMetricValues representing the analysis of the data quality metric value.
ActualValue (float) --
The actual value of the data quality metric.
ExpectedValue (float) --
The expected value of the data quality metric according to the analysis of historical data.
LowerLimit (float) --
The lower limit of the data quality metric value according to the analysis of historical data.
UpperLimit (float) --
The upper limit of the data quality metric value according to the analysis of historical data.
NewRules (list) --
A list of new data quality rules generated as part of the observation based on the data quality metric value.
(string) --
AggregatedMetrics (dict) --
A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.
TotalRowsProcessed (float) --
The total number of rows that were processed during the data quality evaluation.
TotalRowsPassed (float) --
The total number of rows that passed all applicable data quality rules.
TotalRowsFailed (float) --
The total number of rows that failed one or more data quality rules.
TotalRulesProcessed (float) --
The total number of data quality rules that were evaluated.
TotalRulesPassed (float) --
The total number of data quality rules that passed their evaluation criteria.
TotalRulesFailed (float) --
The total number of data quality rules that failed their evaluation criteria.
{'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}
Retrieves the result of a data quality rule evaluation published from any supported data platform.
See also: AWS API Documentation
Request Syntax
client.get_data_quality_result_v2(
ResultId='string'
)
string
[REQUIRED]
A unique result ID for the data quality result.
dict
Response Syntax
{
'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'
}
},
'ProfileId': 'string',
'Dimensions': {
'string': 'string'
},
'Tags': {
'string': 'string'
},
'ExecutionStartedOn': datetime(2015, 1, 1),
'ExecutionCompletedOn': datetime(2015, 1, 1),
'ResultPublishedOn': datetime(2015, 1, 1),
'Score': 123.0,
'RuleResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'Result': 'PASS'|'FAIL'|'ERROR',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedRule': 'string',
'RuleMetrics': {
'string': 123.0
},
'Labels': {
'string': 'string'
}
},
],
'AnalyzerResults': [
{
'Name': 'string',
'Description': 'string',
'EvaluationMessage': 'string',
'EvaluatedMetrics': {
'string': 123.0
},
'EvaluatedDistributions': {
'string': {
'BinEdges': [
'string',
],
'Count': [
123,
],
'DataType': 'string'
}
}
},
],
'Observations': [
{
'Description': 'string',
'MetricBasedObservation': {
'MetricName': 'string',
'StatisticId': 'string',
'MetricValues': {
'ActualValue': 123.0,
'ExpectedValue': 123.0,
'LowerLimit': 123.0,
'UpperLimit': 123.0
},
'NewRules': [
'string',
]
}
},
],
'EvaluationContext': 'string',
'Descriptors': {
'string': 'string'
},
'AggregatedMetrics': {
'TotalRowsProcessed': 123.0,
'TotalRowsPassed': 123.0,
'TotalRowsFailed': 123.0,
'TotalRulesProcessed': 123.0,
'TotalRulesPassed': 123.0,
'TotalRulesFailed': 123.0
},
'RulesetName': 'string'
}
Response Structure
(dict) --
ResultId (string) --
A unique result ID for the 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 associated with the data quality result, if any.
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.
ProfileId (string) --
The Profile ID for the data quality result.
Dimensions (dict) --
A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.
(string) --
(string) --
Tags (dict) --
A map of tags associated with the data quality result.
(string) --
(string) --
ExecutionStartedOn (datetime) --
The date and time when this data quality run started.
ExecutionCompletedOn (datetime) --
The date and time when this data quality run completed.
ResultPublishedOn (datetime) --
The date and time when this data quality result was published.
Score (float) --
An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
RuleResults (list) --
A list of DataQualityRuleResult objects representing the results for each rule.
(dict) --
Describes the result of the evaluation of a data quality rule.
Name (string) --
The name of the data quality rule.
Description (string) --
A description of the data quality rule.
EvaluationMessage (string) --
An evaluation message.
Result (string) --
A pass or fail status for the rule.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the rule.
(string) --
(float) --
EvaluatedRule (string) --
The evaluated rule.
RuleMetrics (dict) --
A map containing metrics associated with the evaluation of the rule based on row-level results.
(string) --
(float) --
Labels (dict) --
A map containing labels assigned to the data quality rule.
(string) --
(string) --
AnalyzerResults (list) --
A list of DataQualityAnalyzerResult objects representing the results for each analyzer.
(dict) --
Describes the result of the evaluation of a data quality analyzer.
Name (string) --
The name of the data quality analyzer.
Description (string) --
A description of the data quality analyzer.
EvaluationMessage (string) --
An evaluation message.
EvaluatedMetrics (dict) --
A map of metrics associated with the evaluation of the analyzer.
(string) --
(float) --
EvaluatedDistributions (dict) --
A map of distribution metrics associated with the evaluation of the analyzer.
(string) --
(dict) --
The distribution data for a statistic.
BinEdges (list) --
The bin edge values for the distribution.
(string) --
Count (list) --
The frequency count for each bin in the distribution.
(integer) --
DataType (string) --
The data type of the column for the distribution.
Observations (list) --
A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.
(dict) --
Describes the observation generated after evaluating the rules and analyzers.
Description (string) --
A description of the data quality observation.
MetricBasedObservation (dict) --
An object of type MetricBasedObservation representing the observation that is based on evaluated data quality metrics.
MetricName (string) --
The name of the data quality metric used for generating the observation.
StatisticId (string) --
The Statistic ID.
MetricValues (dict) --
An object of type DataQualityMetricValues representing the analysis of the data quality metric value.
ActualValue (float) --
The actual value of the data quality metric.
ExpectedValue (float) --
The expected value of the data quality metric according to the analysis of historical data.
LowerLimit (float) --
The lower limit of the data quality metric value according to the analysis of historical data.
UpperLimit (float) --
The upper limit of the data quality metric value according to the analysis of historical data.
NewRules (list) --
A list of new data quality rules generated as part of the observation based on the data quality metric value.
(string) --
EvaluationContext (string) --
The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.
Descriptors (dict) --
A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.
(string) --
(string) --
AggregatedMetrics (dict) --
A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.
TotalRowsProcessed (float) --
The total number of rows that were processed during the data quality evaluation.
TotalRowsPassed (float) --
The total number of rows that passed all applicable data quality rules.
TotalRowsFailed (float) --
The total number of rows that failed one or more data quality rules.
TotalRulesProcessed (float) --
The total number of data quality rules that were evaluated.
TotalRulesPassed (float) --
The total number of data quality rules that passed their evaluation criteria.
TotalRulesFailed (float) --
The total number of data quality rules that failed their evaluation criteria.
RulesetName (string) --
The name of the ruleset associated with the data quality result.
{'Filter': {'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}}
Response {'Results': {'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}}
Returns all data quality execution results for your account.
See also: AWS API Documentation
Request Syntax
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
)
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.
string
A paginated token to offset the results.
integer
The maximum number of results to return.
dict
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.
{'Filter': {'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}}
Response {'Results': {'DataQualityEvaluationConfig': 'string',
'EvaluationRunMode': 'ON_DEMAND | EVALUATION_CONFIG'}}
Returns a paginated list of data quality execution results for your account, filtered by the specified criteria. Use the NextToken parameter to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_data_quality_results_v2(
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'
}
},
'PublishedAfter': datetime(2015, 1, 1),
'PublishedBefore': datetime(2015, 1, 1),
'Dimensions': {
'string': 'string'
},
'EvaluationContext': 'string',
'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
'DataQualityEvaluationConfig': 'string'
},
NextToken='string',
MaxResults=123
)
dict
The filter criteria.
DataSource (dict) --
The data source used to filter the results. For example, you can retrieve all results for an Glue table. DatabaseName and TableName are required. If you omit CatalogId, the catalog of the calling account is used.
When you filter by data source, a page of results can be empty but still include a NextToken. Keep requesting pages until NextToken is absent.
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.
PublishedAfter (datetime) --
The time after which to include published results.
PublishedBefore (datetime) --
The time before which to include published results.
Dimensions (dict) --
The platform dimensions to filter results by.
(string) --
(string) --
EvaluationContext (string) --
The evaluation context to filter results by.
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.
string
A pagination token to retrieve the next page of results.
integer
The maximum number of results to return. If you don't specify a value, the operation uses the default number of results.
dict
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'
}
},
'ResultPublishedOn': datetime(2015, 1, 1),
'Dimensions': {
'string': 'string'
},
'EvaluationContext': 'string',
'Descriptors': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Results (list) --
A list of DataQualityResultsV2Description objects.
(dict) --
Describes a data quality result returned by ListDataQualityResultsV2.
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 associated with the data quality result, if any.
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.
ResultPublishedOn (datetime) --
The date and time when this data quality result was published.
Dimensions (dict) --
A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.
(string) --
(string) --
EvaluationContext (string) --
The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.
Descriptors (dict) --
A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.
(string) --
(string) --
NextToken (string) --
A pagination token, if more results are available.