amazonka-swf-1.3.6: Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SWF.RespondActivityTaskFailed

Contents

Description

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

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

Synopsis

Creating a Request

respondActivityTaskFailed Source

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

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

Request Lenses

ratfReason :: Lens' RespondActivityTaskFailed (Maybe Text) Source

Description of the error that may assist in diagnostics.

ratfDetails :: Lens' RespondActivityTaskFailed (Maybe Text) Source

Optional. Detailed information about the failure.

ratfTaskToken :: Lens' RespondActivityTaskFailed Text Source

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

respondActivityTaskFailedResponse :: RespondActivityTaskFailedResponse Source

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