| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.DataPipeline.SetTaskStatus
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.
See: AWS API Reference for SetTaskStatus.
- setTaskStatus :: Text -> TaskStatus -> SetTaskStatus
- data SetTaskStatus
- stsErrorStackTrace :: Lens' SetTaskStatus (Maybe Text)
- stsErrorId :: Lens' SetTaskStatus (Maybe Text)
- stsErrorMessage :: Lens' SetTaskStatus (Maybe Text)
- stsTaskId :: Lens' SetTaskStatus Text
- stsTaskStatus :: Lens' SetTaskStatus TaskStatus
- setTaskStatusResponse :: Int -> SetTaskStatusResponse
- data SetTaskStatusResponse
- stsrsResponseStatus :: Lens' SetTaskStatusResponse Int
Creating a Request
Arguments
| :: Text | |
| -> TaskStatus | |
| -> 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:
data SetTaskStatus Source
Contains the parameters for SetTaskStatus.
See: setTaskStatus smart constructor.
Instances
Request Lenses
stsErrorStackTrace :: Lens' SetTaskStatus (Maybe Text) Source
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 :: Lens' SetTaskStatus (Maybe Text) Source
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 :: Lens' SetTaskStatus (Maybe Text) Source
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 :: Lens' SetTaskStatus Text Source
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
stsTaskStatus :: Lens' SetTaskStatus TaskStatus Source
If FINISHED, the task successfully completed. If FAILED, the task
ended unsuccessfully. Preconditions use false.
Destructuring the Response
Arguments
| :: Int | |
| -> 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:
data SetTaskStatusResponse Source
Contains the output of SetTaskStatus.
See: setTaskStatusResponse smart constructor.
Response Lenses
stsrsResponseStatus :: Lens' SetTaskStatusResponse Int Source
The response status code.