Network.AWS.StepFunctions.GetActivityTask

Used by workers to retrieve a task (with the specified activity ARN) which has been 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 returns a taskToken with a null 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).

Creating a Request

getActivityTask

Arguments

:: Text

gatActivityARN

-> 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 - You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
• gatActivityARN - The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity .)

data GetActivityTask

See: getActivityTask smart constructor.

Instances

Eq GetActivityTask

Methods

(==) :: GetActivityTask -> GetActivityTask -> Bool

(/=) :: GetActivityTask -> GetActivityTask -> Bool

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

Methods

readsPrec :: Int -> ReadS GetActivityTask

readList :: ReadS [GetActivityTask]

readPrec :: ReadPrec GetActivityTask

readListPrec :: ReadPrec [GetActivityTask]

Show GetActivityTask

Methods

showsPrec :: Int -> GetActivityTask -> ShowS

show :: GetActivityTask -> String

showList :: [GetActivityTask] -> ShowS

Generic GetActivityTask

Associated Types

type Rep GetActivityTask :: * -> *

Methods

from :: GetActivityTask -> Rep GetActivityTask x

to :: Rep GetActivityTask x -> GetActivityTask

Hashable GetActivityTask

Methods

hashWithSalt :: Int -> GetActivityTask -> Int

hash :: GetActivityTask -> Int

ToJSON GetActivityTask

Methods

toJSON :: GetActivityTask -> Value

toEncoding :: GetActivityTask -> Encoding

toJSONList :: [GetActivityTask] -> Value

toEncodingList :: [GetActivityTask] -> Encoding

NFData GetActivityTask

Methods

rnf :: GetActivityTask -> ()

AWSRequest GetActivityTask

Associated Types

type Rs GetActivityTask :: *

Methods

request :: GetActivityTask -> Request GetActivityTask

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetActivityTask -> ClientResponse -> m (Response GetActivityTask)

ToHeaders GetActivityTask

Methods

toHeaders :: GetActivityTask -> [Header]

ToPath GetActivityTask

Methods

toPath :: GetActivityTask -> ByteString

ToQuery GetActivityTask

Methods

toQuery :: GetActivityTask -> QueryString

type Rep GetActivityTask

type Rep GetActivityTask = D1 * (MetaData "GetActivityTask" "Network.AWS.StepFunctions.GetActivityTask" "amazonka-stepfunctions-1.6.0-9oIncLN4t9xDN3HGh7dGqV" 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

type Rs GetActivityTask = GetActivityTaskResponse

Request Lenses

gatWorkerName :: Lens' GetActivityTask (Maybe Text)

You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is 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 (assigned when you create the task using CreateActivity .)

Destructuring the Response

getActivityTaskResponse

Arguments

:: Int

gatrsResponseStatus

-> 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 string that contains 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

Methods

(==) :: GetActivityTaskResponse -> GetActivityTaskResponse -> Bool

(/=) :: GetActivityTaskResponse -> GetActivityTaskResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS GetActivityTaskResponse

readList :: ReadS [GetActivityTaskResponse]

readPrec :: ReadPrec GetActivityTaskResponse

readListPrec :: ReadPrec [GetActivityTaskResponse]

Show GetActivityTaskResponse

Methods

showsPrec :: Int -> GetActivityTaskResponse -> ShowS

show :: GetActivityTaskResponse -> String

showList :: [GetActivityTaskResponse] -> ShowS

Generic GetActivityTaskResponse

Associated Types

type Rep GetActivityTaskResponse :: * -> *

Methods

from :: GetActivityTaskResponse -> Rep GetActivityTaskResponse x

to :: Rep GetActivityTaskResponse x -> GetActivityTaskResponse

NFData GetActivityTaskResponse

Methods

rnf :: GetActivityTaskResponse -> ()

type Rep GetActivityTaskResponse

type Rep GetActivityTaskResponse = D1 * (MetaData "GetActivityTaskResponse" "Network.AWS.StepFunctions.GetActivityTask" "amazonka-stepfunctions-1.6.0-9oIncLN4t9xDN3HGh7dGqV" 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 DecidedStrict) (Rec0 * Int)))))

Response Lenses

gatrsInput :: Lens' GetActivityTaskResponse (Maybe Text)

The string that contains 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.