Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.DataPipeline.PollForTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.

If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.

Synopsis

Creating a Request

pollForTask Source #

Arguments

:: Text	`pftWorkerGroup`
-> PollForTask

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

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

pftHostname - The public DNS name of the calling task runner.
pftInstanceIdentity - Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id . For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.
pftWorkerGroup - The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask . There are no wildcard values permitted in workerGroup ; the string must be an exact, case-sensitive, match.

data PollForTask Source #

Contains the parameters for PollForTask.

See: pollForTask smart constructor.

Instances

Eq PollForTask Source #
Methods (==) :: PollForTask -> PollForTask -> Bool # (/=) :: PollForTask -> PollForTask -> Bool #
Data PollForTask Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PollForTask -> c PollForTask # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PollForTask # toConstr :: PollForTask -> Constr # dataTypeOf :: PollForTask -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c PollForTask) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PollForTask) # gmapT :: (forall b. Data b => b -> b) -> PollForTask -> PollForTask # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PollForTask -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PollForTask -> r # gmapQ :: (forall d. Data d => d -> u) -> PollForTask -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PollForTask -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PollForTask -> m PollForTask # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForTask -> m PollForTask # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForTask -> m PollForTask #
Read PollForTask Source #
Methods readsPrec :: Int -> ReadS PollForTask # readList :: ReadS [PollForTask] # readPrec :: ReadPrec PollForTask # readListPrec :: ReadPrec [PollForTask] #
Show PollForTask Source #
Methods showsPrec :: Int -> PollForTask -> ShowS # show :: PollForTask -> String # showList :: [PollForTask] -> ShowS #
Generic PollForTask Source #
Associated Types type Rep PollForTask :: * -> * # Methods from :: PollForTask -> Rep PollForTask x # to :: Rep PollForTask x -> PollForTask #
Hashable PollForTask Source #
Methods hashWithSalt :: Int -> PollForTask -> Int # hash :: PollForTask -> Int #
ToJSON PollForTask Source #
Methods toJSON :: PollForTask -> Value # toEncoding :: PollForTask -> Encoding # toJSONList :: [PollForTask] -> Value # toEncodingList :: [PollForTask] -> Encoding #
NFData PollForTask Source #
Methods rnf :: PollForTask -> () #
AWSRequest PollForTask Source #
Associated Types type Rs PollForTask :: * # Methods request :: PollForTask -> Request PollForTask # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * PollForTask -> ClientResponse -> m (Response PollForTask) #
ToHeaders PollForTask Source #
Methods toHeaders :: PollForTask -> [Header] #
ToPath PollForTask Source #
Methods toPath :: PollForTask -> ByteString #
ToQuery PollForTask Source #
Methods toQuery :: PollForTask -> QueryString #
type Rep PollForTask Source #
type Rep PollForTask = D1 * (MetaData "PollForTask" "Network.AWS.DataPipeline.PollForTask" "amazonka-datapipeline-1.6.0-kGxEPwUUMy5Qs3ShWYQqJ" False) (C1 * (MetaCons "PollForTask'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_pftHostname") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_pftInstanceIdentity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe InstanceIdentity))) (S1 * (MetaSel (Just Symbol "_pftWorkerGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs PollForTask Source #
type Rs PollForTask = PollForTaskResponse

Request Lenses

pftHostname :: Lens' PollForTask (Maybe Text) Source #

The public DNS name of the calling task runner.

pftInstanceIdentity :: Lens' PollForTask (Maybe InstanceIdentity) Source #

Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id . For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

pftWorkerGroup :: Lens' PollForTask Text Source #

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask . There are no wildcard values permitted in workerGroup ; the string must be an exact, case-sensitive, match.

Destructuring the Response

pollForTaskResponse Source #

Arguments

:: Int	`pftrsResponseStatus`
-> PollForTaskResponse

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

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

pftrsTaskObject - The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId , which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus .
pftrsResponseStatus - -- | The response status code.

data PollForTaskResponse Source #

Contains the output of PollForTask.

See: pollForTaskResponse smart constructor.

Instances

Eq PollForTaskResponse Source #
Methods (==) :: PollForTaskResponse -> PollForTaskResponse -> Bool # (/=) :: PollForTaskResponse -> PollForTaskResponse -> Bool #
Data PollForTaskResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PollForTaskResponse -> c PollForTaskResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PollForTaskResponse # toConstr :: PollForTaskResponse -> Constr # dataTypeOf :: PollForTaskResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c PollForTaskResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PollForTaskResponse) # gmapT :: (forall b. Data b => b -> b) -> PollForTaskResponse -> PollForTaskResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PollForTaskResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PollForTaskResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> PollForTaskResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PollForTaskResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PollForTaskResponse -> m PollForTaskResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForTaskResponse -> m PollForTaskResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PollForTaskResponse -> m PollForTaskResponse #
Read PollForTaskResponse Source #
Methods readsPrec :: Int -> ReadS PollForTaskResponse # readList :: ReadS [PollForTaskResponse] # readPrec :: ReadPrec PollForTaskResponse # readListPrec :: ReadPrec [PollForTaskResponse] #
Show PollForTaskResponse Source #
Methods showsPrec :: Int -> PollForTaskResponse -> ShowS # show :: PollForTaskResponse -> String # showList :: [PollForTaskResponse] -> ShowS #
Generic PollForTaskResponse Source #
Associated Types type Rep PollForTaskResponse :: * -> * # Methods from :: PollForTaskResponse -> Rep PollForTaskResponse x # to :: Rep PollForTaskResponse x -> PollForTaskResponse #
NFData PollForTaskResponse Source #
Methods rnf :: PollForTaskResponse -> () #
type Rep PollForTaskResponse Source #
type Rep PollForTaskResponse = D1 * (MetaData "PollForTaskResponse" "Network.AWS.DataPipeline.PollForTask" "amazonka-datapipeline-1.6.0-kGxEPwUUMy5Qs3ShWYQqJ" False) (C1 * (MetaCons "PollForTaskResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_pftrsTaskObject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TaskObject))) (S1 * (MetaSel (Just Symbol "_pftrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

pftrsTaskObject :: Lens' PollForTaskResponse (Maybe TaskObject) Source #

The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId , which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus .

pftrsResponseStatus :: Lens' PollForTaskResponse Int Source #

- | The response status code.