Skip to content

DataQualityRulesetEvaluationRun

Source code in docs_src/capo_glue/types/data_quality_ruleset_evaluation_run.py
class DataQualityRulesetEvaluationRun(TypedDict, closed=True):
    run_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The unique run identifier associated with this run.</p>"""
    data_source: NotRequired["capo_glue.types.data_source.DataSource"]
    role: NotRequired["capo_glue.types.role_string.RoleString"]
    """<p>An IAM role supplied to encrypt the results of the run.</p>"""
    number_of_workers: NotRequired["capo_glue.types.nullable_integer.NullableInteger"]
    """<p>The number of <code>G.1X</code> workers to be used in the run. The default is 5.</p>"""
    timeout: NotRequired["capo_glue.types.timeout.Timeout"]
    """<p>The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"""
    additional_run_options: NotRequired[
        "capo_glue.types.data_quality_evaluation_run_additional_run_options.DataQualityEvaluationRunAdditionalRunOptions"
    ]
    status: NotRequired["capo_glue.types.task_status_type.TaskStatusType"]
    """<p>The status for this run.</p>"""
    error_string: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The error strings that are associated with the run.</p>"""
    started_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when this run started.</p>"""
    last_modified_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>A timestamp. The last point in time when this run was modified.</p>"""
    completed_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when this run was completed.</p>"""
    execution_time: "capo_glue.types.execution_time.ExecutionTime"
    """<p>The amount of time (in seconds) that the run consumed resources.</p>"""
    ruleset_names: NotRequired["capo_glue.types.ruleset_names.RulesetNames"]
    """<p>A list of ruleset names for the run.</p>"""
    result_ids: NotRequired[
        "capo_glue.types.data_quality_result_id_list.DataQualityResultIdList"
    ]
    """<p>A list of result IDs for the data quality results for the run.</p>"""
    additional_data_sources: NotRequired[
        "capo_glue.types.data_source_map.DataSourceMap"
    ]
    """<p>A map of reference strings to additional data sources you can specify for an evaluation run.</p>"""

additional_data_sources instance-attribute

additional_data_sources: NotRequired[DataSourceMap]

A map of reference strings to additional data sources you can specify for an evaluation run.

additional_run_options instance-attribute

additional_run_options: NotRequired[DataQualityEvaluationRunAdditionalRunOptions]

completed_on instance-attribute

completed_on: NotRequired[Timestamp]

The date and time when this run was completed.

data_source instance-attribute

data_source: NotRequired[DataSource]

error_string instance-attribute

error_string: NotRequired[GenericString]

The error strings that are associated with the run.

execution_time instance-attribute

execution_time: ExecutionTime

The amount of time (in seconds) that the run consumed resources.

last_modified_on instance-attribute

last_modified_on: NotRequired[Timestamp]

A timestamp. The last point in time when this run was modified.

number_of_workers instance-attribute

number_of_workers: NotRequired[NullableInteger]

The number of G.1X workers to be used in the run. The default is 5.

result_ids instance-attribute

result_ids: NotRequired[DataQualityResultIdList]

A list of result IDs for the data quality results for the run.

role instance-attribute

role: NotRequired[RoleString]

An IAM role supplied to encrypt the results of the run.

ruleset_names instance-attribute

ruleset_names: NotRequired[RulesetNames]

A list of ruleset names for the run.

run_id instance-attribute

run_id: NotRequired[HashString]

The unique run identifier associated with this run.

started_on instance-attribute

started_on: NotRequired[Timestamp]

The date and time when this run started.

status instance-attribute

status: NotRequired[TaskStatusType]

The status for this run.

timeout instance-attribute

timeout: NotRequired[Timeout]

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).