amazonka-datapipeline-1.6.1: Amazon Data Pipeline SDK.

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

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 .

Synopsis

# Creating a Request

Arguments

 :: Text stsTaskId -> TaskStatus stsTaskStatus -> SetTaskStatus

Creates a value of SetTaskStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stsErrorStackTrace - 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.
• stsErrorId - 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.
• stsErrorMessage - 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.
• stsTaskId - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask .
• stsTaskStatus - If FINISHED , the task successfully completed. If FAILED , the task ended unsuccessfully. Preconditions use false.

See: setTaskStatus smart constructor.

Instances

# Request Lenses

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.

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.

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.

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

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

# Destructuring the Response

Arguments

 :: Int stsrsResponseStatus -> SetTaskStatusResponse

Creates a value of SetTaskStatusResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stsrsResponseStatus - -- | The response status code.

See: setTaskStatusResponse smart constructor.