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

Amazonka.SWF.RespondActivityTaskFailed

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

Synopsis

Creating a Request

data RespondActivityTaskFailed Source #

See: newRespondActivityTaskFailed smart constructor.

Constructors

RespondActivityTaskFailed' 

Fields

  • reason :: Maybe Text

    Description of the error that may assist in diagnostics.

  • details :: Maybe Text

    Detailed information about the failure.

  • taskToken :: 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.

Instances

Instances details
Eq RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Read RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Show RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Generic RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Associated Types

type Rep RespondActivityTaskFailed :: Type -> Type #

NFData RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Hashable RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

ToJSON RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

AWSRequest RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

ToHeaders RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

ToPath RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

ToQuery RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailed = D1 ('MetaData "RespondActivityTaskFailed" "Amazonka.SWF.RespondActivityTaskFailed" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RespondActivityTaskFailed'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RespondActivityTaskFailed Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

newRespondActivityTaskFailed Source #

Create a value of RespondActivityTaskFailed with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:reason:RespondActivityTaskFailed', respondActivityTaskFailed_reason - Description of the error that may assist in diagnostics.

$sel:details:RespondActivityTaskFailed', respondActivityTaskFailed_details - Detailed information about the failure.

$sel:taskToken:RespondActivityTaskFailed', respondActivityTaskFailed_taskToken - 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.

Request Lenses

respondActivityTaskFailed_reason :: Lens' RespondActivityTaskFailed (Maybe Text) Source #

Description of the error that may assist in diagnostics.

respondActivityTaskFailed_taskToken :: 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

data RespondActivityTaskFailedResponse Source #

See: newRespondActivityTaskFailedResponse smart constructor.

Instances

Instances details
Eq RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Read RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Show RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Generic RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

Associated Types

type Rep RespondActivityTaskFailedResponse :: Type -> Type #

NFData RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailedResponse = D1 ('MetaData "RespondActivityTaskFailedResponse" "Amazonka.SWF.RespondActivityTaskFailed" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RespondActivityTaskFailedResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRespondActivityTaskFailedResponse :: RespondActivityTaskFailedResponse Source #

Create a value of RespondActivityTaskFailedResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.