| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DataPipeline.ReportTaskProgress
Description
Task runners call ReportTaskProgress when assigned a task to
acknowledge that it has the task. If the web service does not receive
this acknowledgement within 2 minutes, it assigns the task in a
subsequent PollForTask call. After this initial acknowledgement, the
task runner only needs to report progress every 15 minutes to maintain
its ownership of the task. You can change this reporting time from 15
minutes by specifying a reportProgressTimeout field in your pipeline.
If a task runner does not report its status after 5 minutes, AWS Data
Pipeline assumes that the task runner is unable to process the task and
reassigns the task in a subsequent response to PollForTask. Task runners
should call ReportTaskProgress every 60 seconds.
Synopsis
- data ReportTaskProgress = ReportTaskProgress' {}
- newReportTaskProgress :: Text -> ReportTaskProgress
- reportTaskProgress_fields :: Lens' ReportTaskProgress (Maybe [Field])
- reportTaskProgress_taskId :: Lens' ReportTaskProgress Text
- data ReportTaskProgressResponse = ReportTaskProgressResponse' {
- httpStatus :: Int
- canceled :: Bool
- newReportTaskProgressResponse :: Int -> Bool -> ReportTaskProgressResponse
- reportTaskProgressResponse_httpStatus :: Lens' ReportTaskProgressResponse Int
- reportTaskProgressResponse_canceled :: Lens' ReportTaskProgressResponse Bool
Creating a Request
data ReportTaskProgress Source #
Contains the parameters for ReportTaskProgress.
See: newReportTaskProgress smart constructor.
Constructors
| ReportTaskProgress' | |
Instances
newReportTaskProgress Source #
Arguments
| :: Text | |
| -> ReportTaskProgress |
Create a value of ReportTaskProgress with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fields:ReportTaskProgress', reportTaskProgress_fields - Key-value pairs that define the properties of the
ReportTaskProgressInput object.
$sel:taskId:ReportTaskProgress', reportTaskProgress_taskId - The ID of the task assigned to the task runner. This value is provided
in the response for PollForTask.
Request Lenses
reportTaskProgress_fields :: Lens' ReportTaskProgress (Maybe [Field]) Source #
Key-value pairs that define the properties of the ReportTaskProgressInput object.
reportTaskProgress_taskId :: Lens' ReportTaskProgress Text Source #
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
Destructuring the Response
data ReportTaskProgressResponse Source #
Contains the output of ReportTaskProgress.
See: newReportTaskProgressResponse smart constructor.
Constructors
| ReportTaskProgressResponse' | |
Fields
| |
Instances
newReportTaskProgressResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> ReportTaskProgressResponse |
Create a value of ReportTaskProgressResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ReportTaskProgressResponse', reportTaskProgressResponse_httpStatus - The response's http status code.
$sel:canceled:ReportTaskProgressResponse', reportTaskProgressResponse_canceled - If true, the calling task runner should cancel processing of the task.
The task runner does not need to call SetTaskStatus for canceled tasks.
Response Lenses
reportTaskProgressResponse_httpStatus :: Lens' ReportTaskProgressResponse Int Source #
The response's http status code.
reportTaskProgressResponse_canceled :: Lens' ReportTaskProgressResponse Bool Source #
If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.