stop_data_quality_check_execution

DataQualityChecksApi.stop_data_quality_check_execution(run_id, id, role_id, operation=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

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”. 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:

  • run_id (str) – Run ID to stop. (required)

  • id (str) – Parent data quality check ID. (required)

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

  • operation (str) – Must be stop to request termination of the 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:

StopDataQualityCheckRunResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /data-quality-checks/{id}/runs/{run_id}

Success (HTTP 200)

Run stop requested successfully.

Request / response example

{
  "Message": "Data quality check run stopped successfully"
}

Errors

Documented error codes: GE-1034, EMF-1001, GE-1044.

HTTP 400

Invalid input or unsupported operation. Codes include GE-1034, IPV-*, AUTH-*.

HTTP 422

Run not found. Body is {“Message”: “Data quality check run with id {run_id} doesn’t exist.”} without a CODE prefix.

runMissing

{
  "Message": "Data quality check run with id r1r2r3r4-e5f6-7890-abcd-ef1234567890 doesn't exist."
}

HTTP 500

Unexpected failure (EMF-1001 wrapping GE-1044).