Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

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.

Creating a Request

reportTaskProgress Source #

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 - Key-value pairs that define the properties of the ReportTaskProgressInput object.
rtpTaskId - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask .

data ReportTaskProgress Source #

Contains the parameters for ReportTaskProgress.

See: reportTaskProgress smart constructor.

Instances

Eq ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods (==) :: ReportTaskProgress -> ReportTaskProgress -> Bool # (/=) :: ReportTaskProgress -> ReportTaskProgress -> Bool #
Data ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.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 Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods readsPrec :: Int -> ReadS ReportTaskProgress # readList :: ReadS [ReportTaskProgress] # readPrec :: ReadPrec ReportTaskProgress # readListPrec :: ReadPrec [ReportTaskProgress] #
Show ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods showsPrec :: Int -> ReportTaskProgress -> ShowS # show :: ReportTaskProgress -> String # showList :: [ReportTaskProgress] -> ShowS #
Generic ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Associated Types type Rep ReportTaskProgress :: Type -> Type # Methods from :: ReportTaskProgress -> Rep ReportTaskProgress x # to :: Rep ReportTaskProgress x -> ReportTaskProgress #
Hashable ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods hashWithSalt :: Int -> ReportTaskProgress -> Int # hash :: ReportTaskProgress -> Int #
ToJSON ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods toJSON :: ReportTaskProgress -> Value # toEncoding :: ReportTaskProgress -> Encoding # toJSONList :: [ReportTaskProgress] -> Value # toEncodingList :: [ReportTaskProgress] -> Encoding #
AWSRequest ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Associated Types type Rs ReportTaskProgress :: Type # Methods request :: ReportTaskProgress -> Request ReportTaskProgress # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ReportTaskProgress -> ClientResponse -> m (Response ReportTaskProgress) #
ToHeaders ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods toHeaders :: ReportTaskProgress -> [Header] #
ToPath ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods toPath :: ReportTaskProgress -> ByteString #
ToQuery ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods toQuery :: ReportTaskProgress -> QueryString #
NFData ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods rnf :: ReportTaskProgress -> () #
type Rep ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress type Rep ReportTaskProgress = D1 (MetaData "ReportTaskProgress" "Network.AWS.DataPipeline.ReportTaskProgress" "amazonka-datapipeline-1.6.1-3JyTLPZzwy0KRZE2VQaeKm" False) (C1 (MetaCons "ReportTaskProgress'" PrefixI True) (S1 (MetaSel (Just "_rtpFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Field])) :*: S1 (MetaSel (Just "_rtpTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs ReportTaskProgress Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress type Rs ReportTaskProgress = ReportTaskProgressResponse

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 #

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 - -- | The response status code.
rtprsCanceled - If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.

data ReportTaskProgressResponse Source #

Contains the output of ReportTaskProgress.

See: reportTaskProgressResponse smart constructor.

Instances

Eq ReportTaskProgressResponse Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods (==) :: ReportTaskProgressResponse -> ReportTaskProgressResponse -> Bool # (/=) :: ReportTaskProgressResponse -> ReportTaskProgressResponse -> Bool #
Data ReportTaskProgressResponse Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress 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 Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods readsPrec :: Int -> ReadS ReportTaskProgressResponse # readList :: ReadS [ReportTaskProgressResponse] # readPrec :: ReadPrec ReportTaskProgressResponse # readListPrec :: ReadPrec [ReportTaskProgressResponse] #
Show ReportTaskProgressResponse Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods showsPrec :: Int -> ReportTaskProgressResponse -> ShowS # show :: ReportTaskProgressResponse -> String # showList :: [ReportTaskProgressResponse] -> ShowS #
Generic ReportTaskProgressResponse Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Associated Types type Rep ReportTaskProgressResponse :: Type -> Type # Methods from :: ReportTaskProgressResponse -> Rep ReportTaskProgressResponse x # to :: Rep ReportTaskProgressResponse x -> ReportTaskProgressResponse #
NFData ReportTaskProgressResponse Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress Methods rnf :: ReportTaskProgressResponse -> () #
type Rep ReportTaskProgressResponse Source #
Instance details Defined in Network.AWS.DataPipeline.ReportTaskProgress type Rep ReportTaskProgressResponse = D1 (MetaData "ReportTaskProgressResponse" "Network.AWS.DataPipeline.ReportTaskProgress" "amazonka-datapipeline-1.6.1-3JyTLPZzwy0KRZE2VQaeKm" False) (C1 (MetaCons "ReportTaskProgressResponse'" PrefixI True) (S1 (MetaSel (Just "_rtprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_rtprsCanceled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))

Response Lenses

rtprsResponseStatus :: Lens' ReportTaskProgressResponse Int Source #

- | The response status code.

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.