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

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@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 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

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:

  • ratfReason - Description of the error that may assist in diagnostics.
  • ratfDetails - Detailed information about the failure.
  • ratfTaskToken - The taskToken of the ActivityTask . Important: 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.

data RespondActivityTaskFailed Source #

See: respondActivityTaskFailed smart constructor.

Instances
Eq RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Data RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RespondActivityTaskFailed -> c RespondActivityTaskFailed #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RespondActivityTaskFailed #

toConstr :: RespondActivityTaskFailed -> Constr #

dataTypeOf :: RespondActivityTaskFailed -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RespondActivityTaskFailed) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RespondActivityTaskFailed) #

gmapT :: (forall b. Data b => b -> b) -> RespondActivityTaskFailed -> RespondActivityTaskFailed #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskFailed -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskFailed -> r #

gmapQ :: (forall d. Data d => d -> u) -> RespondActivityTaskFailed -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RespondActivityTaskFailed -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RespondActivityTaskFailed -> m RespondActivityTaskFailed #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskFailed -> m RespondActivityTaskFailed #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskFailed -> m RespondActivityTaskFailed #

Read RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Show RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Generic RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Associated Types

type Rep RespondActivityTaskFailed :: Type -> Type #

Hashable RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

ToJSON RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

AWSRequest RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Associated Types

type Rs RespondActivityTaskFailed :: Type #

ToHeaders RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

ToPath RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

ToQuery RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

NFData RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailed = D1 (MetaData "RespondActivityTaskFailed" "Network.AWS.SWF.RespondActivityTaskFailed" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "RespondActivityTaskFailed'" PrefixI True) (S1 (MetaSel (Just "_ratfReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ratfDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ratfTaskToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs RespondActivityTaskFailed Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Request Lenses

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

Description of the error that may assist in diagnostics.

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

Detailed information about the failure.

ratfTaskToken :: Lens' RespondActivityTaskFailed Text Source #

The taskToken of the ActivityTask . Important: 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.

data RespondActivityTaskFailedResponse Source #

See: respondActivityTaskFailedResponse smart constructor.

Instances
Eq RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Data RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RespondActivityTaskFailedResponse -> c RespondActivityTaskFailedResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RespondActivityTaskFailedResponse #

toConstr :: RespondActivityTaskFailedResponse -> Constr #

dataTypeOf :: RespondActivityTaskFailedResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RespondActivityTaskFailedResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RespondActivityTaskFailedResponse) #

gmapT :: (forall b. Data b => b -> b) -> RespondActivityTaskFailedResponse -> RespondActivityTaskFailedResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskFailedResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskFailedResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> RespondActivityTaskFailedResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RespondActivityTaskFailedResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RespondActivityTaskFailedResponse -> m RespondActivityTaskFailedResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskFailedResponse -> m RespondActivityTaskFailedResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskFailedResponse -> m RespondActivityTaskFailedResponse #

Read RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Show RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Generic RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

Associated Types

type Rep RespondActivityTaskFailedResponse :: Type -> Type #

NFData RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailedResponse Source # 
Instance details

Defined in Network.AWS.SWF.RespondActivityTaskFailed

type Rep RespondActivityTaskFailedResponse = D1 (MetaData "RespondActivityTaskFailedResponse" "Network.AWS.SWF.RespondActivityTaskFailed" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "RespondActivityTaskFailedResponse'" PrefixI False) (U1 :: Type -> Type))