amazonka-stepfunctions-1.4.5: Amazon Step Functions 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.StepFunctions.SendTaskHeartbeat

Contents

Description

Used by workers to report to the service that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history will contain an ActivityTimedOut event.

Synopsis

Creating a Request

sendTaskHeartbeat #

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

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

  • sthTaskToken - The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

data SendTaskHeartbeat #

See: sendTaskHeartbeat smart constructor.

Instances

Eq SendTaskHeartbeat # 
Data SendTaskHeartbeat # 

Methods

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

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

toConstr :: SendTaskHeartbeat -> Constr #

dataTypeOf :: SendTaskHeartbeat -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SendTaskHeartbeat -> SendTaskHeartbeat #

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

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

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

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

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

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

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

Read SendTaskHeartbeat # 
Show SendTaskHeartbeat # 
Generic SendTaskHeartbeat # 
Hashable SendTaskHeartbeat # 
ToJSON SendTaskHeartbeat # 
NFData SendTaskHeartbeat # 

Methods

rnf :: SendTaskHeartbeat -> () #

AWSRequest SendTaskHeartbeat # 
ToQuery SendTaskHeartbeat # 
ToPath SendTaskHeartbeat # 
ToHeaders SendTaskHeartbeat # 
type Rep SendTaskHeartbeat # 
type Rep SendTaskHeartbeat = D1 (MetaData "SendTaskHeartbeat" "Network.AWS.StepFunctions.SendTaskHeartbeat" "amazonka-stepfunctions-1.4.5-Jw6S5ByJLFY5UX1mivZUjA" True) (C1 (MetaCons "SendTaskHeartbeat'" PrefixI True) (S1 (MetaSel (Just Symbol "_sthTaskToken") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs SendTaskHeartbeat # 

Request Lenses

sthTaskToken :: Lens' SendTaskHeartbeat Text #

The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

Destructuring the Response

sendTaskHeartbeatResponse #

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

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

data SendTaskHeartbeatResponse #

See: sendTaskHeartbeatResponse smart constructor.

Instances

Eq SendTaskHeartbeatResponse # 
Data SendTaskHeartbeatResponse # 

Methods

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

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

toConstr :: SendTaskHeartbeatResponse -> Constr #

dataTypeOf :: SendTaskHeartbeatResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SendTaskHeartbeatResponse -> SendTaskHeartbeatResponse #

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

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

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

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

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

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

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

Read SendTaskHeartbeatResponse # 
Show SendTaskHeartbeatResponse # 
Generic SendTaskHeartbeatResponse # 
NFData SendTaskHeartbeatResponse # 
type Rep SendTaskHeartbeatResponse # 
type Rep SendTaskHeartbeatResponse = D1 (MetaData "SendTaskHeartbeatResponse" "Network.AWS.StepFunctions.SendTaskHeartbeat" "amazonka-stepfunctions-1.4.5-Jw6S5ByJLFY5UX1mivZUjA" True) (C1 (MetaCons "SendTaskHeartbeatResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_sthrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

sthrsResponseStatus :: Lens' SendTaskHeartbeatResponse Int #

  • - | The response status code.