Network.AWS.StepFunctions.SendTaskHeartbeat

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 contains an ActivityTimedOut event.

Creating a Request

sendTaskHeartbeat

Arguments

:: Text

sthTaskToken

-> 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 'GetActivityTaskOutput$taskToken' ).

data SendTaskHeartbeat

See: sendTaskHeartbeat smart constructor.

Instances

Eq SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

(==) :: SendTaskHeartbeat -> SendTaskHeartbeat -> Bool

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

Data SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.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

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

readsPrec :: Int -> ReadS SendTaskHeartbeat

readList :: ReadS [SendTaskHeartbeat]

readPrec :: ReadPrec SendTaskHeartbeat

readListPrec :: ReadPrec [SendTaskHeartbeat]

Show SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

showsPrec :: Int -> SendTaskHeartbeat -> ShowS

show :: SendTaskHeartbeat -> String

showList :: [SendTaskHeartbeat] -> ShowS

Generic SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Associated Types

type Rep SendTaskHeartbeat :: Type -> Type

Methods

from :: SendTaskHeartbeat -> Rep SendTaskHeartbeat x

to :: Rep SendTaskHeartbeat x -> SendTaskHeartbeat

Hashable SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

hashWithSalt :: Int -> SendTaskHeartbeat -> Int

hash :: SendTaskHeartbeat -> Int

ToJSON SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

toJSON :: SendTaskHeartbeat -> Value

toEncoding :: SendTaskHeartbeat -> Encoding

toJSONList :: [SendTaskHeartbeat] -> Value

toEncodingList :: [SendTaskHeartbeat] -> Encoding

AWSRequest SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Associated Types

type Rs SendTaskHeartbeat :: Type

Methods

request :: SendTaskHeartbeat -> Request SendTaskHeartbeat

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SendTaskHeartbeat -> ClientResponse -> m (Response SendTaskHeartbeat)

ToHeaders SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

toHeaders :: SendTaskHeartbeat -> [Header]

ToPath SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

toPath :: SendTaskHeartbeat -> ByteString

ToQuery SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

toQuery :: SendTaskHeartbeat -> QueryString

NFData SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

rnf :: SendTaskHeartbeat -> ()

type Rep SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

type Rep SendTaskHeartbeat = D1 (MetaData "SendTaskHeartbeat" "Network.AWS.StepFunctions.SendTaskHeartbeat" "amazonka-stepfunctions-1.6.1-2PTLha96w99Qwy2XlD0kq" True) (C1 (MetaCons "SendTaskHeartbeat'" PrefixI True) (S1 (MetaSel (Just "_sthTaskToken") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs SendTaskHeartbeat

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

type Rs SendTaskHeartbeat = SendTaskHeartbeatResponse

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 'GetActivityTaskOutput$taskToken' ).

Destructuring the Response

sendTaskHeartbeatResponse

Arguments

:: Int

sthrsResponseStatus

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

• sthrsResponseStatus - -- | The response status code.

data SendTaskHeartbeatResponse

See: sendTaskHeartbeatResponse smart constructor.

Instances

Eq SendTaskHeartbeatResponse

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

(==) :: SendTaskHeartbeatResponse -> SendTaskHeartbeatResponse -> Bool

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

Data SendTaskHeartbeatResponse

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

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

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

readsPrec :: Int -> ReadS SendTaskHeartbeatResponse

readList :: ReadS [SendTaskHeartbeatResponse]

readPrec :: ReadPrec SendTaskHeartbeatResponse

readListPrec :: ReadPrec [SendTaskHeartbeatResponse]

Show SendTaskHeartbeatResponse

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

showsPrec :: Int -> SendTaskHeartbeatResponse -> ShowS

show :: SendTaskHeartbeatResponse -> String

showList :: [SendTaskHeartbeatResponse] -> ShowS

Generic SendTaskHeartbeatResponse

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Associated Types

type Rep SendTaskHeartbeatResponse :: Type -> Type

Methods

from :: SendTaskHeartbeatResponse -> Rep SendTaskHeartbeatResponse x

to :: Rep SendTaskHeartbeatResponse x -> SendTaskHeartbeatResponse

NFData SendTaskHeartbeatResponse

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

Methods

rnf :: SendTaskHeartbeatResponse -> ()

type Rep SendTaskHeartbeatResponse

Defined in Network.AWS.StepFunctions.SendTaskHeartbeat

type Rep SendTaskHeartbeatResponse = D1 (MetaData "SendTaskHeartbeatResponse" "Network.AWS.StepFunctions.SendTaskHeartbeat" "amazonka-stepfunctions-1.6.1-2PTLha96w99Qwy2XlD0kq" True) (C1 (MetaCons "SendTaskHeartbeatResponse'" PrefixI True) (S1 (MetaSel (Just "_sthrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

sthrsResponseStatus :: Lens' SendTaskHeartbeatResponse Int

• - | The response status code.