Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198974.1 KB

Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>.

post/#X-Amz-Target=DataPipeline.SetTaskStatus

Headers

X-Amz-Target'DataPipeline.SetTaskStatus' required

Request body

taskIdstring required

The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.

taskStatus'FINISHED' | 'FAILED' | 'FALSE' required

If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false.

errorIdstring

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

errorMessagestring

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

errorStackTracestring

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Response

Success

SetTaskStatusOutput required

Contains the output of SetTaskStatus.