amazonka-datapipeline-1.4.0: Amazon Data Pipeline SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DataPipeline.ReportTaskProgress

Contents

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

Creating a Request

reportTaskProgress Source

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

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

Request Lenses

rtpFields :: Lens' ReportTaskProgress [Field] Source

Key-value pairs that define the properties of the ReportTaskProgressInput object.

rtpTaskId :: 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

reportTaskProgressResponse Source

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

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

Response Lenses

rtprsCanceled :: 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.