trigger_data_pipeline_execution¶

DataPipelinesApi.trigger_data_pipeline_execution(id, role_id, trigger_data_pipeline_execution_request_body=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Trigger a data pipeline execution

Starts a new execution. Requires editor access (skipped for super-admin). PipelineStatus must be empty/blank (legacy) or create_complete / update_complete (DP-1038). Glue optional body ExecutionProperties (string map; DP-1040 if invalid). AI requires InputString in the body or DefaultExecutionProperties (DP-1038). Glue also rejects datasource flows in a bad state (DP-1040 / DP-1044).

Parameters:

id (str) – DataPipelineId. (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)
trigger_data_pipeline_execution_request_body (TriggerDataPipelineExecutionRequestBody)
_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:

TriggerDataPipelineExecutionResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: POST /data-pipelines/{id}/executions

Request¶

The request body is optional.

Glue run with execution properties

{
  "ExecutionProperties": {
    "run_date": "2026-08-01"
  }
}

AI Flow InputString

{
  "InputString": "Summarize last quarter orders"
}

Success (HTTP 200)¶

Execution started. Message text differs for Glue vs AI.

Glue execution started

{
  "ExecutionId": "wr_abc123",
  "Message": "Successfully triggered the data pipeline execution"
}

AI Flow execution started

{
  "ExecutionId": "exec-ai-001",
  "Message": "Successfully triggered the AI Flow data pipeline execution"
}

Errors¶

Documented error codes: DP-1038, DP-1040, DP-1044, 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.

PipelineStatus is not complete

{
  "Message": "DP-1038 - Data pipeline is not ready for execution (expected no status or create_complete / update_complete)."
}

AI Flow missing InputString

{
  "Message": "DP-1038 - No InputString found in DefaultExecutionProperties or request body"
}

Glue ExecutionProperties not a dict of strings

{
  "Message": "DP-1040 - Invalid execution properties: Execution properties must be a dictionary"
}

Advanced dataload datasource disabled

{
  "Message": "DP-1044 - Data Pipeline cannot be executed as, Advanced dataload datasource is currently disabled. Please enable it and try again"
}

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