swf_record_activity_task_heartbeat: Used by activity workers to report to the service that the...

View source: R/swf_operations.R

swf_record_activity_task_heartbeatR Documentation

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress

Description

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.

See https://www.paws-r-sdk.com/docs/swf_record_activity_task_heartbeat/ for full documentation.

Usage

swf_record_activity_task_heartbeat(taskToken, details = NULL)

Arguments

taskToken

[required] The taskToken of the ActivityTask.

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.

details

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


paws.application.integration documentation built on Sept. 12, 2024, 6:11 a.m.