Skip to content

Set Task Status

datapipeline_set_task_status R Documentation

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status

Description

Task runners call set_task_status 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 set_task_status for tasks that are canceled by the web service during a call to report_task_progress.

Usage

datapipeline_set_task_status(taskId, taskStatus, errorId, errorMessage,
  errorStackTrace)

Arguments

taskId

[required] The ID of the task assigned to the task runner. This value is provided in the response for poll_for_task.

taskStatus

[required] If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

errorId

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.

errorMessage

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.

errorStackTrace

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.

Value

An empty list.

Request syntax

svc$set_task_status(
  taskId = "string",
  taskStatus = "FINISHED"|"FAILED"|"FALSE",
  errorId = "string",
  errorMessage = "string",
  errorStackTrace = "string"
)