delete_data_quality_check

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

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). 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 delete. (required)

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

  • _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:

DeleteDataQualityCheckResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: DELETE /data-quality-checks/{id}

Success (HTTP 200)

Data quality check deleted successfully.

Request / response example

{
  "Message": "Successfully deleted data quality check."
}

Errors

Documented error codes: IPV-1002, AUTH-1002, AUTH-1012, GE-1034, GE-1008.

HTTP 400

Invalid input, authorization failure, RUNNING run, Glue/Dynamo failures (GenericFailureException), or DependentResources block. Codes include IPV-1002, AUTH-1002, AUTH-1012, GE-1034, GE-1008. DependentResources response Message is not code-prefixed.

HTTP 500

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