stop_etl_job_execution

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

Stop a running ETL job execution

Invokes Glue stop for an execution in starting or running state. Executions in any other state are rejected.

Parameters:

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

  • id (str) – UUID of the parent ETL job. (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: PUT /jobs/{id}/executions/{executionid}

Success (HTTP 200)

Stop invoked. Message is “Invoked command to stop the execution(s)”.

Request / response example

{
  "Message": "Invoked command to stop the execution(s)"
}

Errors

Documented error codes: GE-1008.

HTTP 400

Execution is not starting or running, missing job, or insufficient access. Typical Message is “Job cannot be stopped as it is in {state} state”.

Request / response example

{
  "Message": "Job cannot be stopped as it is in succeeded state"
}

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