Network.AWS.SWF.RecordActivityTaskHeartbeat

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true .

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType .

This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

Important: If the cancelRequested flag returns true , a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled . Otherwise, it should ignore the cancellation request.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide .

Creating a Request

recordActivityTaskHeartbeat

Arguments

:: Text

rathTaskToken

-> RecordActivityTaskHeartbeat

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

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

• rathDetails - If specified, contains details about the progress of the task.
• rathTaskToken - The taskToken of the ActivityTask . Important: taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

data RecordActivityTaskHeartbeat

See: recordActivityTaskHeartbeat smart constructor.

Instances

Eq RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

(==) :: RecordActivityTaskHeartbeat -> RecordActivityTaskHeartbeat -> Bool

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

Data RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

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

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

toConstr :: RecordActivityTaskHeartbeat -> Constr

dataTypeOf :: RecordActivityTaskHeartbeat -> DataType

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

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

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

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

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

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

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

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

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

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

Read RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

readsPrec :: Int -> ReadS RecordActivityTaskHeartbeat

readList :: ReadS [RecordActivityTaskHeartbeat]

readPrec :: ReadPrec RecordActivityTaskHeartbeat

readListPrec :: ReadPrec [RecordActivityTaskHeartbeat]

Show RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

showsPrec :: Int -> RecordActivityTaskHeartbeat -> ShowS

show :: RecordActivityTaskHeartbeat -> String

showList :: [RecordActivityTaskHeartbeat] -> ShowS

Generic RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Associated Types

type Rep RecordActivityTaskHeartbeat :: Type -> Type

Methods

from :: RecordActivityTaskHeartbeat -> Rep RecordActivityTaskHeartbeat x

to :: Rep RecordActivityTaskHeartbeat x -> RecordActivityTaskHeartbeat

Hashable RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

hashWithSalt :: Int -> RecordActivityTaskHeartbeat -> Int

hash :: RecordActivityTaskHeartbeat -> Int

ToJSON RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

toJSON :: RecordActivityTaskHeartbeat -> Value

toEncoding :: RecordActivityTaskHeartbeat -> Encoding

toJSONList :: [RecordActivityTaskHeartbeat] -> Value

toEncodingList :: [RecordActivityTaskHeartbeat] -> Encoding

AWSRequest RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Associated Types

type Rs RecordActivityTaskHeartbeat :: Type

Methods

request :: RecordActivityTaskHeartbeat -> Request RecordActivityTaskHeartbeat

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

ToHeaders RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

toHeaders :: RecordActivityTaskHeartbeat -> [Header]

ToPath RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

toPath :: RecordActivityTaskHeartbeat -> ByteString

ToQuery RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

toQuery :: RecordActivityTaskHeartbeat -> QueryString

NFData RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

rnf :: RecordActivityTaskHeartbeat -> ()

type Rep RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

type Rep RecordActivityTaskHeartbeat = D1 (MetaData "RecordActivityTaskHeartbeat" "Network.AWS.SWF.RecordActivityTaskHeartbeat" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "RecordActivityTaskHeartbeat'" PrefixI True) (S1 (MetaSel (Just "_rathDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rathTaskToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs RecordActivityTaskHeartbeat

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

type Rs RecordActivityTaskHeartbeat = RecordActivityTaskHeartbeatResponse

Request Lenses

rathDetails :: Lens' RecordActivityTaskHeartbeat (Maybe Text)

If specified, contains details about the progress of the task.

rathTaskToken :: Lens' RecordActivityTaskHeartbeat Text

The taskToken of the ActivityTask . Important: taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Destructuring the Response

recordActivityTaskHeartbeatResponse

Arguments

:: Int

rathrsResponseStatus

-> Bool

rathrsCancelRequested

-> RecordActivityTaskHeartbeatResponse

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

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

• rathrsResponseStatus - -- | The response status code.
• rathrsCancelRequested - Set to true if cancellation of the task is requested.

data RecordActivityTaskHeartbeatResponse

Status information about an activity task.

See: recordActivityTaskHeartbeatResponse smart constructor.

Instances

Eq RecordActivityTaskHeartbeatResponse

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

(==) :: RecordActivityTaskHeartbeatResponse -> RecordActivityTaskHeartbeatResponse -> Bool

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

Data RecordActivityTaskHeartbeatResponse

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

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

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

toConstr :: RecordActivityTaskHeartbeatResponse -> Constr

dataTypeOf :: RecordActivityTaskHeartbeatResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read RecordActivityTaskHeartbeatResponse

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

readsPrec :: Int -> ReadS RecordActivityTaskHeartbeatResponse

readList :: ReadS [RecordActivityTaskHeartbeatResponse]

readPrec :: ReadPrec RecordActivityTaskHeartbeatResponse

readListPrec :: ReadPrec [RecordActivityTaskHeartbeatResponse]

Show RecordActivityTaskHeartbeatResponse

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

showsPrec :: Int -> RecordActivityTaskHeartbeatResponse -> ShowS

show :: RecordActivityTaskHeartbeatResponse -> String

showList :: [RecordActivityTaskHeartbeatResponse] -> ShowS

Generic RecordActivityTaskHeartbeatResponse

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Associated Types

type Rep RecordActivityTaskHeartbeatResponse :: Type -> Type

Methods

from :: RecordActivityTaskHeartbeatResponse -> Rep RecordActivityTaskHeartbeatResponse x

to :: Rep RecordActivityTaskHeartbeatResponse x -> RecordActivityTaskHeartbeatResponse

NFData RecordActivityTaskHeartbeatResponse

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

Methods

rnf :: RecordActivityTaskHeartbeatResponse -> ()

type Rep RecordActivityTaskHeartbeatResponse

Defined in Network.AWS.SWF.RecordActivityTaskHeartbeat

type Rep RecordActivityTaskHeartbeatResponse = D1 (MetaData "RecordActivityTaskHeartbeatResponse" "Network.AWS.SWF.RecordActivityTaskHeartbeat" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "RecordActivityTaskHeartbeatResponse'" PrefixI True) (S1 (MetaSel (Just "_rathrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_rathrsCancelRequested") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))

Response Lenses

rathrsResponseStatus :: Lens' RecordActivityTaskHeartbeatResponse Int

• - | The response status code.

rathrsCancelRequested :: Lens' RecordActivityTaskHeartbeatResponse Bool

Set to true if cancellation of the task is requested.