amazonka-stepfunctions-1.4.5: Amazon Step Functions SDK.

Copyright(c) 2013-2016 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.StepFunctions.GetActivityTask

Contents

Description

Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result, that is, the taskToken returned is an empty string.

Important: Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

Synopsis

Creating a Request

getActivityTask #

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

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

  • gatWorkerName - An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history.
  • gatActivityARN - The Amazon Resource Name (ARN) of the activity to retrieve tasks from.

data GetActivityTask #

See: getActivityTask smart constructor.

Instances

Eq GetActivityTask # 
Data GetActivityTask # 

Methods

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

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

toConstr :: GetActivityTask -> Constr #

dataTypeOf :: GetActivityTask -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetActivityTask # 
Show GetActivityTask # 
Generic GetActivityTask # 
Hashable GetActivityTask # 
ToJSON GetActivityTask # 
NFData GetActivityTask # 

Methods

rnf :: GetActivityTask -> () #

AWSRequest GetActivityTask # 
ToQuery GetActivityTask # 
ToPath GetActivityTask # 
ToHeaders GetActivityTask # 
type Rep GetActivityTask # 
type Rep GetActivityTask = D1 (MetaData "GetActivityTask" "Network.AWS.StepFunctions.GetActivityTask" "amazonka-stepfunctions-1.4.5-Jw6S5ByJLFY5UX1mivZUjA" False) (C1 (MetaCons "GetActivityTask'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gatWorkerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gatActivityARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetActivityTask # 

Request Lenses

gatWorkerName :: Lens' GetActivityTask (Maybe Text) #

An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history.

gatActivityARN :: Lens' GetActivityTask Text #

The Amazon Resource Name (ARN) of the activity to retrieve tasks from.

Destructuring the Response

getActivityTaskResponse #

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

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

  • gatrsInput - The JSON input data for the task.
  • gatrsTaskToken - A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat , SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.
  • gatrsResponseStatus - -- | The response status code.

data GetActivityTaskResponse #

See: getActivityTaskResponse smart constructor.

Instances

Eq GetActivityTaskResponse # 
Data GetActivityTaskResponse # 

Methods

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

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

toConstr :: GetActivityTaskResponse -> Constr #

dataTypeOf :: GetActivityTaskResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetActivityTaskResponse # 
Show GetActivityTaskResponse # 
Generic GetActivityTaskResponse # 
NFData GetActivityTaskResponse # 

Methods

rnf :: GetActivityTaskResponse -> () #

type Rep GetActivityTaskResponse # 
type Rep GetActivityTaskResponse = D1 (MetaData "GetActivityTaskResponse" "Network.AWS.StepFunctions.GetActivityTask" "amazonka-stepfunctions-1.4.5-Jw6S5ByJLFY5UX1mivZUjA" False) (C1 (MetaCons "GetActivityTaskResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gatrsInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gatrsTaskToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gatrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gatrsInput :: Lens' GetActivityTaskResponse (Maybe Text) #

The JSON input data for the task.

gatrsTaskToken :: Lens' GetActivityTaskResponse (Maybe Text) #

A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat , SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.

gatrsResponseStatus :: Lens' GetActivityTaskResponse Int #

  • - | The response status code.