Network.AWS.SWF.RespondActivityTaskCompleted

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 does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

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.

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 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.

See: AWS API Reference for RespondActivityTaskCompleted.

Creating a Request

respondActivityTaskCompleted

Arguments

:: Text

ratcTaskToken

-> RespondActivityTaskCompleted

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

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

• ratcResult
• ratcTaskToken

data RespondActivityTaskCompleted

See: respondActivityTaskCompleted smart constructor.

Instances

Eq RespondActivityTaskCompleted

Data RespondActivityTaskCompleted

Read RespondActivityTaskCompleted

Show RespondActivityTaskCompleted

Generic RespondActivityTaskCompleted

ToJSON RespondActivityTaskCompleted

AWSRequest RespondActivityTaskCompleted

ToPath RespondActivityTaskCompleted

ToHeaders RespondActivityTaskCompleted

ToQuery RespondActivityTaskCompleted

Typeable * RespondActivityTaskCompleted

type Rep RespondActivityTaskCompleted

type Rs RespondActivityTaskCompleted = RespondActivityTaskCompletedResponse

Request Lenses

ratcResult :: Lens' RespondActivityTaskCompleted (Maybe Text)

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

ratcTaskToken :: Lens' RespondActivityTaskCompleted Text

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.

Destructuring the Response

respondActivityTaskCompletedResponse :: RespondActivityTaskCompletedResponse

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

data RespondActivityTaskCompletedResponse

See: respondActivityTaskCompletedResponse smart constructor.

Instances

Eq RespondActivityTaskCompletedResponse

Data RespondActivityTaskCompletedResponse

Read RespondActivityTaskCompletedResponse

Show RespondActivityTaskCompletedResponse

Generic RespondActivityTaskCompletedResponse

Typeable * RespondActivityTaskCompletedResponse

type Rep RespondActivityTaskCompletedResponse