Network.AWS.SWF.RespondActivityTaskCanceled

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and 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.

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

Creating a Request

respondActivityTaskCanceled

Arguments

:: Text

rTaskToken

-> RespondActivityTaskCanceled

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

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

• rDetails
• rTaskToken

data RespondActivityTaskCanceled

See: respondActivityTaskCanceled smart constructor.

Instances

Eq RespondActivityTaskCanceled

Data RespondActivityTaskCanceled

Read RespondActivityTaskCanceled

Show RespondActivityTaskCanceled

Generic RespondActivityTaskCanceled

ToJSON RespondActivityTaskCanceled

AWSRequest RespondActivityTaskCanceled

ToPath RespondActivityTaskCanceled

ToHeaders RespondActivityTaskCanceled

ToQuery RespondActivityTaskCanceled

Typeable * RespondActivityTaskCanceled

type Rep RespondActivityTaskCanceled

type Rs RespondActivityTaskCanceled = RespondActivityTaskCanceledResponse

Request Lenses

rDetails :: Lens' RespondActivityTaskCanceled (Maybe Text)

Optional. Information about the cancellation.

rTaskToken :: Lens' RespondActivityTaskCanceled 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

respondActivityTaskCanceledResponse :: RespondActivityTaskCanceledResponse

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

data RespondActivityTaskCanceledResponse

See: respondActivityTaskCanceledResponse smart constructor.

Instances

Eq RespondActivityTaskCanceledResponse

Data RespondActivityTaskCanceledResponse

Read RespondActivityTaskCanceledResponse

Show RespondActivityTaskCanceledResponse

Generic RespondActivityTaskCanceledResponse

Typeable * RespondActivityTaskCanceledResponse

type Rep RespondActivityTaskCanceledResponse