Network.AWS.DataPipeline.ReportTaskProgress

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.

Creating a Request

reportTaskProgress

Arguments

:: Text

rtpTaskId

-> ReportTaskProgress

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:

• rtpFields
• rtpTaskId

data ReportTaskProgress

Contains the parameters for ReportTaskProgress.

See: reportTaskProgress smart constructor.

Instances

Eq ReportTaskProgress

Methods

(==) :: ReportTaskProgress -> ReportTaskProgress -> Bool

(/=) :: ReportTaskProgress -> ReportTaskProgress -> Bool

Data ReportTaskProgress

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReportTaskProgress -> c ReportTaskProgress

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReportTaskProgress

toConstr :: ReportTaskProgress -> Constr

dataTypeOf :: ReportTaskProgress -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReportTaskProgress)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReportTaskProgress)

gmapT :: (forall b. Data b => b -> b) -> ReportTaskProgress -> ReportTaskProgress

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskProgress -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskProgress -> r

gmapQ :: (forall d. Data d => d -> u) -> ReportTaskProgress -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReportTaskProgress -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReportTaskProgress -> m ReportTaskProgress

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskProgress -> m ReportTaskProgress

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskProgress -> m ReportTaskProgress

Read ReportTaskProgress

Methods

readsPrec :: Int -> ReadS ReportTaskProgress

readList :: ReadS [ReportTaskProgress]

readPrec :: ReadPrec ReportTaskProgress

readListPrec :: ReadPrec [ReportTaskProgress]

Show ReportTaskProgress

Methods

showsPrec :: Int -> ReportTaskProgress -> ShowS

show :: ReportTaskProgress -> String

showList :: [ReportTaskProgress] -> ShowS

Generic ReportTaskProgress

Associated Types

type Rep ReportTaskProgress :: * -> *

Methods

from :: ReportTaskProgress -> Rep ReportTaskProgress x

to :: Rep ReportTaskProgress x -> ReportTaskProgress

Hashable ReportTaskProgress

Methods

hashWithSalt :: Int -> ReportTaskProgress -> Int

hash :: ReportTaskProgress -> Int

NFData ReportTaskProgress

Methods

rnf :: ReportTaskProgress -> ()

AWSRequest ReportTaskProgress

Associated Types

type Rs ReportTaskProgress :: *

Methods

request :: ReportTaskProgress -> Request ReportTaskProgress

response :: MonadResource m => Logger -> Service -> Proxy * ReportTaskProgress -> ClientResponse -> m (Response ReportTaskProgress)

ToPath ReportTaskProgress

Methods

toPath :: ReportTaskProgress -> ByteString

ToHeaders ReportTaskProgress

Methods

toHeaders :: ReportTaskProgress -> [Header]

ToQuery ReportTaskProgress

Methods

toQuery :: ReportTaskProgress -> QueryString

ToJSON ReportTaskProgress

Methods

toJSON :: ReportTaskProgress -> Value

toEncoding :: ReportTaskProgress -> Encoding

type Rep ReportTaskProgress

type Rep ReportTaskProgress = D1 (MetaData "ReportTaskProgress" "Network.AWS.DataPipeline.ReportTaskProgress" "amazonka-datapipeline-1.4.4-9e3h85rN2zC7dIfmiWKUK4" False) (C1 (MetaCons "ReportTaskProgress'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtpFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Field]))) (S1 (MetaSel (Just Symbol "_rtpTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs ReportTaskProgress

type Rs ReportTaskProgress = ReportTaskProgressResponse

Request Lenses

rtpFields :: Lens' ReportTaskProgress [Field]

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

rtpTaskId :: Lens' ReportTaskProgress Text

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

Destructuring the Response

reportTaskProgressResponse

Arguments

:: Int

rtprsResponseStatus

-> Bool

rtprsCanceled

-> ReportTaskProgressResponse

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:

• rtprsResponseStatus
• rtprsCanceled

data ReportTaskProgressResponse

Contains the output of ReportTaskProgress.

See: reportTaskProgressResponse smart constructor.

Instances

Eq ReportTaskProgressResponse

Methods

(==) :: ReportTaskProgressResponse -> ReportTaskProgressResponse -> Bool

(/=) :: ReportTaskProgressResponse -> ReportTaskProgressResponse -> Bool

Data ReportTaskProgressResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReportTaskProgressResponse -> c ReportTaskProgressResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReportTaskProgressResponse

toConstr :: ReportTaskProgressResponse -> Constr

dataTypeOf :: ReportTaskProgressResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReportTaskProgressResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReportTaskProgressResponse)

gmapT :: (forall b. Data b => b -> b) -> ReportTaskProgressResponse -> ReportTaskProgressResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskProgressResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskProgressResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ReportTaskProgressResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReportTaskProgressResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReportTaskProgressResponse -> m ReportTaskProgressResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskProgressResponse -> m ReportTaskProgressResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskProgressResponse -> m ReportTaskProgressResponse

Read ReportTaskProgressResponse

Methods

readsPrec :: Int -> ReadS ReportTaskProgressResponse

readList :: ReadS [ReportTaskProgressResponse]

readPrec :: ReadPrec ReportTaskProgressResponse

readListPrec :: ReadPrec [ReportTaskProgressResponse]

Show ReportTaskProgressResponse

Methods

showsPrec :: Int -> ReportTaskProgressResponse -> ShowS

show :: ReportTaskProgressResponse -> String

showList :: [ReportTaskProgressResponse] -> ShowS

Generic ReportTaskProgressResponse

Associated Types

type Rep ReportTaskProgressResponse :: * -> *

Methods

from :: ReportTaskProgressResponse -> Rep ReportTaskProgressResponse x

to :: Rep ReportTaskProgressResponse x -> ReportTaskProgressResponse

NFData ReportTaskProgressResponse

Methods

rnf :: ReportTaskProgressResponse -> ()

type Rep ReportTaskProgressResponse

type Rep ReportTaskProgressResponse = D1 (MetaData "ReportTaskProgressResponse" "Network.AWS.DataPipeline.ReportTaskProgress" "amazonka-datapipeline-1.4.4-9e3h85rN2zC7dIfmiWKUK4" False) (C1 (MetaCons "ReportTaskProgressResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_rtprsCanceled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))

Response Lenses

rtprsResponseStatus :: Lens' ReportTaskProgressResponse Int

The response status code.

rtprsCanceled :: Lens' ReportTaskProgressResponse Bool

If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.