AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
taskToken
is still making progress. The worker can also
(optionally) 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 does not in itself create an event in the workflow execution history.
However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut
event that contains the information from the last heartbeat generated by the activity
worker.
taskStartToCloseTimeout
of an activity type is the maximum
duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat
requests received. The taskStartToCloseTimeout
is also specified in RegisterActivityType.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:
Resource
element with the domain name to limit the action
to only specified domains.Action
element to allow or
deny permission to call this action.If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Namespace: Amazon.SimpleWorkflow.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class RecordActivityTaskHeartbeatRequest : AmazonSimpleWorkflowRequest IRequestEvents
The RecordActivityTaskHeartbeatRequest type exposes the following members
Name | Description | |
---|---|---|
RecordActivityTaskHeartbeatRequest() |
Name | Type | Description | |
---|---|---|---|
Details | System.String |
Gets and sets the property Details.
If specified, contains details about the progress of the task. |
|
TaskToken | System.String |
Gets and sets the property TaskToken.
The 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.
|
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8