Skip to content

GetDataQualityResultResponse

Source code in docs_src/capo_glue/types/get_data_quality_result_response.py
class GetDataQualityResultResponse(TypedDict, closed=True):
    result_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>A unique result ID for the data quality result.</p>"""
    profile_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The Profile ID for the data quality result.</p>"""
    score: NotRequired["capo_glue.types.generic_bounded_double.GenericBoundedDouble"]
    """<p>An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.</p>"""
    data_source: NotRequired["capo_glue.types.data_source.DataSource"]
    """<p>The table associated with the data quality result, if any.</p>"""
    ruleset_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the ruleset associated with the data quality result.</p>"""
    evaluation_context: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>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 <code>evaluationContext</code> can differentiate the nodes.</p>"""
    started_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when the run for this data quality result started.</p>"""
    completed_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when the run for this data quality result was completed.</p>"""
    job_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The job name associated with the data quality result, if any.</p>"""
    job_run_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The job run ID associated with the data quality result, if any.</p>"""
    ruleset_evaluation_run_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The unique run ID associated with the ruleset evaluation.</p>"""
    rule_results: NotRequired[
        "capo_glue.types.data_quality_rule_results.DataQualityRuleResults"
    ]
    """<p>A list of <code>DataQualityRuleResult</code> objects representing the results for each rule.</p>"""
    analyzer_results: NotRequired[
        "capo_glue.types.data_quality_analyzer_results.DataQualityAnalyzerResults"
    ]
    """<p>A list of <code>DataQualityAnalyzerResult</code> objects representing the results for each analyzer.</p>"""
    observations: NotRequired[
        "capo_glue.types.data_quality_observations.DataQualityObservations"
    ]
    """<p>A list of <code>DataQualityObservation</code> objects representing the anomaly detection observations generated after evaluating the rules and analyzers.</p>"""
    aggregated_metrics: NotRequired[
        "capo_glue.types.data_quality_aggregated_metrics.DataQualityAggregatedMetrics"
    ]
    """<p> A summary of <code>DataQualityAggregatedMetrics</code> objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results. </p>"""

aggregated_metrics instance-attribute

aggregated_metrics: NotRequired[DataQualityAggregatedMetrics]

A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.

analyzer_results instance-attribute

analyzer_results: NotRequired[DataQualityAnalyzerResults]

A list of DataQualityAnalyzerResult objects representing the results for each analyzer.

completed_on instance-attribute

completed_on: NotRequired[Timestamp]

The date and time when the run for this data quality result was completed.

data_source instance-attribute

data_source: NotRequired[DataSource]

The table associated with the data quality result, if any.

evaluation_context instance-attribute

evaluation_context: NotRequired[GenericString]

In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.

job_name instance-attribute

job_name: NotRequired[NameString]

The job name associated with the data quality result, if any.

job_run_id instance-attribute

job_run_id: NotRequired[HashString]

The job run ID associated with the data quality result, if any.

observations instance-attribute

observations: NotRequired[DataQualityObservations]

A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.

profile_id instance-attribute

profile_id: NotRequired[HashString]

The Profile ID for the data quality result.

result_id instance-attribute

result_id: NotRequired[HashString]

A unique result ID for the data quality result.

rule_results instance-attribute

rule_results: NotRequired[DataQualityRuleResults]

A list of DataQualityRuleResult objects representing the results for each rule.

ruleset_evaluation_run_id instance-attribute

ruleset_evaluation_run_id: NotRequired[HashString]

The unique run ID associated with the ruleset evaluation.

ruleset_name instance-attribute

ruleset_name: NotRequired[NameString]

The name of the ruleset associated with the data quality result.

score instance-attribute

score: NotRequired[GenericBoundedDouble]

An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

started_on instance-attribute

started_on: NotRequired[Timestamp]

The date and time when the run for this data quality result started.