trigger_error_diagnosis

EtlJobsApi.trigger_error_diagnosis(id, executionid, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Trigger AI error diagnosis for a failed execution

Starts async diagnosis. The execution must be failed, error, or timeout, and ErrorDiagnosisStatus must not already be diagnosing or completed. No request body. Requires AI services and Jobs AI.

Parameters:

  • id (str) – UUID of the parent ETL job. (required)

  • executionid (str) – Glue JobRun / execution ID to diagnose. (required)

  • role_id (str) – Amorphic role ID sent for authorization. Missing this header returns AUTH-1001. (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:

MessageResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /jobs/{id}/executions/{executionid}/diagnosis

Success (HTTP 200)

Diagnosis started. Message is “Error diagnosis process has been triggered successfully”.

Request / response example

{
  "Message": "Error diagnosis process has been triggered successfully"
}

Errors

Documented error codes: GE-1008.

HTTP 400

Execution is not in a failed state, diagnosis already running or completed, AI not configured, or insufficient access.

Execution is not failed/error/timeout

{
  "Message": "Error diagnosis can only be performed on failed executions. Current state: succeeded"
}

Diagnosis already in progress or completed

{
  "Message": "Job execution is already being diagnosed. Current status: diagnosing"
}

HTTP 500

Uncaught backend failure. Typical Message is “GE-1008 - Could not complete the request. Please try again.”

Request / response example

{
  "Message": "GE-1008 - Could not complete the request. Please try again."
}