Data Quality Checks

APIs related to data quality check functionality

📄️ Create a data quality check

Creates a data quality check for an existing dataset. DatasetId is required. At least one of AreAutoConstraintSuggestionsEnabled=true or a non-empty DqConstraints list must be provided.

📄️ Delete a data quality check

Deletes the data quality check identified by id. Caller must have owner AccessType on the related dataset (AUTH-1012 otherwise). On success Message is 'Successfully deleted data quality check.' Deletion is blocked while any run has RunStatus RUNNING (GE-1034) or when DependentResources exist (HTTP 400 with uncoded Message and DependentResources, typically Schedules).

📄️ Get data quality check details

Returns the data quality check item for id, including AccessType and current recommendation/auto-suggestion fields when available. Missing check returns IPV-1002 (HTTP 400). When auto suggestions are enabled and RecommendationJobId is set, GET may call Glue and refresh RecommendationJobRunStatus / AutoConstraintSuggestions (often a Glue ruleset string) and persist updates. Non UUID-v4 path ids can raise an uncaught ValueError and return HTTP 500.

📄️ Update a data quality check

Updates AreAutoConstraintSuggestionsEnabled and/or DqConstraints for the check. Only those two body fields are accepted; other keys are rejected (GE-1034). After merge, the check must still have auto suggestions enabled or at least one constraint.

📄️ List data quality check runs

Returns a paginated list of runs for the data quality check id. Before listing, the handler refreshes run status from Glue and may update DynamoDB run rows. Caller needs any dataset AccessType.

📄️ Trigger a data quality check run

Starts a ruleset evaluation run for the check, or triggers a Glue recommendation job when action=run-recommendation. Requires editor AccessType on the dataset. Response body is a JSON-encoded string message: 'Data quality check run triggered successfully' for normal runs, or 'Data quality rule recommendation job triggered successfully' for action=run-recommendation.

📄️ Get data quality check run details

Returns the run item for run_id after verifying the parent check id exists and the caller has dataset access. The run is loaded by DataQualityCheckRunId only (parent id is not compared to the run row). Missing check -> IPV-1002 (HTTP 400). Missing run -> HTTP 422 with Message 'Data quality check run with id {{run_id}} doesn't exist.' (no CODE prefix). If Message is absent on the stored item it is set to 'NA'.

📄️ Stop a data quality check run

Stops a RUNNING data quality check execution when operation=stop. Any dataset AccessType including read-only may stop (AUTH-1002 if no access). Missing run returns HTTP 422 with Message 'Data quality check run with id {run_id} doesn't exist.' Non-RUNNING status returns GE-1034 'Cannot stop a dq check with run status - {status}'. Missing/invalid operation returns GE-1034 'Either missing query_params or invalid operation'. Glue cancel failures return GenericFailureException as HTTP 400 (for example GE-1002). On success Message is 'Data quality check run stopped successfully'.