run_data_quality_check

DataQualityChecksApi.run_data_quality_check(id, role_id, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

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. GE-1034 when a run/recommendation is already RUNNING/STARTING, when recommendation is requested but AreAutoConstraintSuggestionsEnabled is false, or when a normal run has no DqConstraints. Missing check is IPV-1002 (HTTP 400), not 404. This Lambda maps InvalidInputException, UnauthorizedUserException, GenericFailureException, ClientError, and ParamValidationError to HTTP 400. Missing run rows return HTTP 422. Uncaught exceptions return HTTP 500 (EMF-1001 wrapping GE-1044).

Parameters:

  • id (str) – Data quality check ID to run. (required)

  • role_id (str) – Amorphic role ID the request is authorized against. (required)

  • action (str) – Optional action. When set to run-recommendation, starts the recommendation job instead of a normal ruleset evaluation run. Omit for a standard DQ check run.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

str

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /data-quality-checks/{id}/runs

Success (HTTP 200)

Run or recommendation job triggered. Body is a JSON-encoded string message (not an object).

Errors

HTTP 400

Missing/invalid parameters or authorization failure. Codes include IPV-*, AUTH-*, GE-*.

HTTP 500

Backend/generic failure. Body is {“Message”: “<CODE> - <text>”}.