Network.AWS.SWF.PollForActivityTask

Used by workers to get an ActivityTask from the specified activity taskList . This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. 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 an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

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

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.
• Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

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 .

Creating a Request

pollForActivityTask

Arguments

:: Text

pfatDomain

-> TaskList

pfatTaskList

-> PollForActivityTask

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

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

• pfatIdentity - Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
• pfatDomain - The name of the domain that contains the task lists being polled.
• pfatTaskList - Specifies the task list to poll for activity tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f-u009f ). Also, it must not contain the literal string arn .

data PollForActivityTask

See: pollForActivityTask smart constructor.

Instances

Eq PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

(==) :: PollForActivityTask -> PollForActivityTask -> Bool

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

Data PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

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

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

toConstr :: PollForActivityTask -> Constr

dataTypeOf :: PollForActivityTask -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PollForActivityTask -> PollForActivityTask

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

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

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

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

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

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

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

Read PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

readsPrec :: Int -> ReadS PollForActivityTask

readList :: ReadS [PollForActivityTask]

readPrec :: ReadPrec PollForActivityTask

readListPrec :: ReadPrec [PollForActivityTask]

Show PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

showsPrec :: Int -> PollForActivityTask -> ShowS

show :: PollForActivityTask -> String

showList :: [PollForActivityTask] -> ShowS

Generic PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Associated Types

type Rep PollForActivityTask :: Type -> Type

Methods

from :: PollForActivityTask -> Rep PollForActivityTask x

to :: Rep PollForActivityTask x -> PollForActivityTask

Hashable PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

hashWithSalt :: Int -> PollForActivityTask -> Int

hash :: PollForActivityTask -> Int

ToJSON PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

toJSON :: PollForActivityTask -> Value

toEncoding :: PollForActivityTask -> Encoding

toJSONList :: [PollForActivityTask] -> Value

toEncodingList :: [PollForActivityTask] -> Encoding

AWSRequest PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Associated Types

type Rs PollForActivityTask :: Type

Methods

request :: PollForActivityTask -> Request PollForActivityTask

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

ToHeaders PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

toHeaders :: PollForActivityTask -> [Header]

ToPath PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

toPath :: PollForActivityTask -> ByteString

ToQuery PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

toQuery :: PollForActivityTask -> QueryString

NFData PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

Methods

rnf :: PollForActivityTask -> ()

type Rep PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

type Rep PollForActivityTask = D1 (MetaData "PollForActivityTask" "Network.AWS.SWF.PollForActivityTask" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "PollForActivityTask'" PrefixI True) (S1 (MetaSel (Just "_pfatIdentity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pfatDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pfatTaskList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TaskList))))

type Rs PollForActivityTask

Defined in Network.AWS.SWF.PollForActivityTask

type Rs PollForActivityTask = PollForActivityTaskResponse

Request Lenses

pfatIdentity :: Lens' PollForActivityTask (Maybe Text)

Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

pfatDomain :: Lens' PollForActivityTask Text

The name of the domain that contains the task lists being polled.

pfatTaskList :: Lens' PollForActivityTask TaskList

Specifies the task list to poll for activity tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f-u009f ). Also, it must not contain the literal string arn .

Destructuring the Response

pollForActivityTaskResponse

Arguments

:: Int

pfatrsResponseStatus

-> Integer

pfatrsStartedEventId

-> PollForActivityTaskResponse

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

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

• pfatrsActivityType - The type of this activity task.
• pfatrsActivityId - The unique ID of the task.
• pfatrsInput - The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.
• pfatrsTaskToken - The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
• pfatrsWorkflowExecution - The workflow execution that started this activity task.
• pfatrsResponseStatus - -- | The response status code.
• pfatrsStartedEventId - The ID of the ActivityTaskStarted event recorded in the history.

data PollForActivityTaskResponse

Unit of work sent to an activity worker.

See: pollForActivityTaskResponse smart constructor.

Instances

Eq PollForActivityTaskResponse

Defined in Network.AWS.SWF.PollForActivityTask

Methods

(==) :: PollForActivityTaskResponse -> PollForActivityTaskResponse -> Bool

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

Data PollForActivityTaskResponse

Defined in Network.AWS.SWF.PollForActivityTask

Methods

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

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

toConstr :: PollForActivityTaskResponse -> Constr

dataTypeOf :: PollForActivityTaskResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PollForActivityTaskResponse -> PollForActivityTaskResponse

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

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

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

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

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

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

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

Read PollForActivityTaskResponse

Defined in Network.AWS.SWF.PollForActivityTask

Methods

readsPrec :: Int -> ReadS PollForActivityTaskResponse

readList :: ReadS [PollForActivityTaskResponse]

readPrec :: ReadPrec PollForActivityTaskResponse

readListPrec :: ReadPrec [PollForActivityTaskResponse]

Show PollForActivityTaskResponse

Defined in Network.AWS.SWF.PollForActivityTask

Methods

showsPrec :: Int -> PollForActivityTaskResponse -> ShowS

show :: PollForActivityTaskResponse -> String

showList :: [PollForActivityTaskResponse] -> ShowS

Generic PollForActivityTaskResponse

Defined in Network.AWS.SWF.PollForActivityTask

Associated Types

type Rep PollForActivityTaskResponse :: Type -> Type

Methods

from :: PollForActivityTaskResponse -> Rep PollForActivityTaskResponse x

to :: Rep PollForActivityTaskResponse x -> PollForActivityTaskResponse

NFData PollForActivityTaskResponse

Defined in Network.AWS.SWF.PollForActivityTask

Methods

rnf :: PollForActivityTaskResponse -> ()

type Rep PollForActivityTaskResponse

Defined in Network.AWS.SWF.PollForActivityTask

type Rep PollForActivityTaskResponse = D1 (MetaData "PollForActivityTaskResponse" "Network.AWS.SWF.PollForActivityTask" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "PollForActivityTaskResponse'" PrefixI True) ((S1 (MetaSel (Just "_pfatrsActivityType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ActivityType)) :*: (S1 (MetaSel (Just "_pfatrsActivityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pfatrsInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pfatrsTaskToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pfatrsWorkflowExecution") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowExecution))) :*: (S1 (MetaSel (Just "_pfatrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_pfatrsStartedEventId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer)))))

Response Lenses

pfatrsActivityType :: Lens' PollForActivityTaskResponse (Maybe ActivityType)

The type of this activity task.

pfatrsActivityId :: Lens' PollForActivityTaskResponse (Maybe Text)

The unique ID of the task.

pfatrsInput :: Lens' PollForActivityTaskResponse (Maybe Text)

The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

pfatrsTaskToken :: Lens' PollForActivityTaskResponse (Maybe Text)

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

pfatrsWorkflowExecution :: Lens' PollForActivityTaskResponse (Maybe WorkflowExecution)

The workflow execution that started this activity task.

pfatrsResponseStatus :: Lens' PollForActivityTaskResponse Int

• - | The response status code.

pfatrsStartedEventId :: Lens' PollForActivityTaskResponse Integer

The ID of the ActivityTaskStarted event recorded in the history.