delete_etl_job

EtlJobsApi.delete_etl_job(id, role_id, delete_lineage=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete an ETL job

Deletes the Glue job, IAM role, S3 artifacts, and Amorphic metadata. Only the job owner can delete. If other resources depend on the job, deletion is blocked and DependentResources is returned.

Parameters:

  • id (str) – UUID v4 of the ETL job to delete. Invalid UUID format is rejected. (required)

  • role_id (str) – Amorphic role ID sent for authorization. Missing this header returns AUTH-1001. (required)

  • delete_lineage (str) – Set to true to also delete lineage associated with the job. Omit or set false to leave lineage in place. Compared case-insensitively.

  • _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: DELETE /jobs/{id}

Success (HTTP 200)

Job delete success message

Request / response example

{
  "Message": "Successfully deleted job."
}

Errors

Documented error codes: IPV-1002, GE-1008.

HTTP 400

Job cannot be deleted because of dependents, missing authorization, Glue delete failure, or invalid JobId. Dependent failures include DependentResources.

Other resources still depend on the job

{
  "Message": "There are schedules that depend on the ETL job. Remove the dependency inorder to delete the ETL job",
  "DependentResources": [
    {
      "ResourceType": "Jobs",
      "Resources": [
        {
          "JobName": "downstream_job",
          "JobId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
        }
      ]
    }
  ]
}

Job does not exist

{
  "Message": "IPV-1002 - Invalid JobId - 3fa85f64-5717-4562-b3fc-2c963f66afa6, resource not found."
}

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."
}