stop_data_pipeline_execution

DataPipelinesApi.stop_data_pipeline_execution(executionid, id, operation, role_id, resume_data_pipeline_execution_request_body=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Stop or resume a data pipeline execution

Requires editor access and query operation=stop|resume (IPV-1051 if missing, IPV-1041 if invalid). stop is allowed only when ExecutionStatus is RUNNING (DP-1012 otherwise) and returns Message “Successfully stopped the data pipeline”. resume requires a body NodeNames array (GE-1001 if empty), matching Graph (DP-1015), and at least one named node that ran (DP-1016). Resume is blocked for RUNNING/STOPPING (DP-1012). Resume success includes a new ExecutionId.

Parameters:

  • executionid (str) – DataPipelineExecutionId (Glue workflow run id or AI flow execution id). (required)

  • id (str) – DataPipelineId. (required)

  • operation (str) – stop the current run, or resume from named nodes. (required)

  • role_id (str) – Amorphic role ID the request is authorized against. Must be a role the user belongs to. Lambda returns AUTH-1001 (HTTP 403 on v2-dataPipelines, HTTP 400 on v2-downloadLogs) if missing after gateway validation. (required)

  • resume_data_pipeline_execution_request_body (ResumeDataPipelineExecutionRequestBody)

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

StopDataPipelineExecution200Response

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /data-pipelines/{id}/executions/{executionid}

Request

The request body is optional.

Nodes to resume from

{
  "NodeNames": [
    "enrich_orders"
  ]
}

Success (HTTP 200)

StopDataPipelineExecutionResponse or ResumeDataPipelineExecutionResponse.

Stop accepted

{
  "Message": "Successfully stopped the data pipeline"
}

Resume created a new execution

{
  "Message": "Successfully resumed execution of data pipeline 'orders_enrichment_flow' with id 'wr_new456'",
  "ExecutionId": "wr_new456"
}

Errors

Documented error codes: IPV-1051, IPV-1041, DP-1012, DP-1015, GE-1001, DP-1016, AUTH-1001, GE-1044.

HTTP 400

API Gateway request validation (missing required parameters such as role_id). Lambda InvalidInputException from this function is HTTP 403.

Gateway rejected missing required header

{
  "Message": "Invalid request"
}

HTTP 403

Invalid input or unauthorized.

operation query missing

{
  "Message": "IPV-1051 - Missing operation in request query"
}

operation not stop or resume

{
  "Message": "IPV-1041 - Invalid parameter - pause, allowed values/keys are stop, resume"
}

Execution is not RUNNING

{
  "Message": "DP-1012 - Cannot stop a data pipeline with execution status - COMPLETED."
}

Resume of an older graph

{
  "Message": "DP-1015 - Cannot resume an older data pipeline execution that does match current data pipeline!"
}

Resume without NodeNames

{
  "Message": "GE-1001 - Invalid input body. Missing field NodeNames in request body"
}

Named nodes were not in the run

{
  "Message": "DP-1016 - At least one of the nodes ['enrich_orders'] should have an instance of execution in the data pipeline execution to be resumed."
}

Missing role_id

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

HTTP 500

Backend failure (GenericFailureException, InconsistentMetadataException, or unexpected GE-1044).

Unhandled exception

{
  "Message": "GE-1044 - Unexpected error - An unexpected error occurred."
}