SWF / Client / respond_activity_task_canceled
Used by workers to tell the service that the ActivityTask identified by the
taskTokenwas successfully canceled. Additional
detailscan be provided using the
details(if provided) appear in the
ActivityTaskCanceledevent added to the workflow history.
Only use this operation if the
canceledflag of a RecordActivityTaskHeartbeat request returns
trueand if the activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
Resourceelement with the domain name to limit the action to only specified domains.
Actionelement 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
causeparameter 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.
See also: AWS API Documentation
response = client.respond_activity_task_canceled( taskToken='string', details='string' )
taskToken (string) –
taskTokenof the ActivityTask.
taskTokenis generated by the service and should be treated as an opaque value. If the task is passed to another process, its
taskTokenmust also be passed. This enables it to provide its progress and respond with results.
details (string) – Information about the cancellation.