Skip to content

Respond Activity Task Completed

swf_respond_activity_task_completed R Documentation

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided)

Description

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task doesn't complete successfully, use respond_activity_task_failed instead. If the worker finds that the task is canceled through the canceled flag returned by record_activity_task_heartbeat, it should cancel the task, clean up and then call respond_activity_task_canceled.

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, respond_activity_task_canceled, respond_activity_task_failed, or the task has timed out.

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.

Usage

swf_respond_activity_task_completed(taskToken, result)

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.

result

The result of the activity task. It is a free form string that is implementation specific.

Value

An empty list.

Request syntax

svc$respond_activity_task_completed(
  taskToken = "string",
  result = "string"
)