DataPipeline / Client / set_task_status

set_task_status#

DataPipeline.Client.set_task_status(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.set_task_status(
    taskId='string',
    taskStatus='FINISHED'|'FAILED'|'FALSE',
    errorId='string',
    errorMessage='string',
    errorStackTrace='string'
)
Parameters:

  • taskId (string) –

    [REQUIRED]

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

  • taskStatus (string) –

    [REQUIRED]

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

  • errorId (string) – 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 (string) – 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 (string) – 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    Contains the output of SetTaskStatus.

Exceptions

  • DataPipeline.Client.exceptions.InternalServiceError

  • DataPipeline.Client.exceptions.TaskNotFoundException

  • DataPipeline.Client.exceptions.InvalidRequestException

  • DataPipeline.Client.exceptions.PipelineNotFoundException

  • DataPipeline.Client.exceptions.PipelineDeletedException