amazonka-datapipeline-1.4.5: Amazon Data Pipeline 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.DataPipeline.ReportTaskRunnerHeartbeat

Contents

Description

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

Synopsis

Creating a Request

reportTaskRunnerHeartbeat #

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

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

  • rtrhHostname - The public DNS name of the task runner.
  • rtrhWorkerGroup - 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 . There are no wildcard values permitted in workerGroup ; the string must be an exact, case-sensitive, match.
  • rtrhTaskrunnerId - The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

data ReportTaskRunnerHeartbeat #

Contains the parameters for ReportTaskRunnerHeartbeat.

See: reportTaskRunnerHeartbeat smart constructor.

Instances

Eq ReportTaskRunnerHeartbeat # 
Data ReportTaskRunnerHeartbeat # 

Methods

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

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

toConstr :: ReportTaskRunnerHeartbeat -> Constr #

dataTypeOf :: ReportTaskRunnerHeartbeat -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ReportTaskRunnerHeartbeat # 
Show ReportTaskRunnerHeartbeat # 
Generic ReportTaskRunnerHeartbeat # 
Hashable ReportTaskRunnerHeartbeat # 
ToJSON ReportTaskRunnerHeartbeat # 
NFData ReportTaskRunnerHeartbeat # 
AWSRequest ReportTaskRunnerHeartbeat # 
ToQuery ReportTaskRunnerHeartbeat # 
ToPath ReportTaskRunnerHeartbeat # 
ToHeaders ReportTaskRunnerHeartbeat # 
type Rep ReportTaskRunnerHeartbeat # 
type Rep ReportTaskRunnerHeartbeat = D1 (MetaData "ReportTaskRunnerHeartbeat" "Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat" "amazonka-datapipeline-1.4.5-BJaoECYz4XDHL06I8wcb9o" False) (C1 (MetaCons "ReportTaskRunnerHeartbeat'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtrhHostname") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rtrhWorkerGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rtrhTaskrunnerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ReportTaskRunnerHeartbeat # 

Request Lenses

rtrhHostname :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) #

The public DNS name of the task runner.

rtrhWorkerGroup :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) #

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 . There are no wildcard values permitted in workerGroup ; the string must be an exact, case-sensitive, match.

rtrhTaskrunnerId :: Lens' ReportTaskRunnerHeartbeat Text #

The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

Destructuring the Response

reportTaskRunnerHeartbeatResponse #

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

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

data ReportTaskRunnerHeartbeatResponse #

Contains the output of ReportTaskRunnerHeartbeat.

See: reportTaskRunnerHeartbeatResponse smart constructor.

Instances

Eq ReportTaskRunnerHeartbeatResponse # 
Data ReportTaskRunnerHeartbeatResponse # 

Methods

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

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

toConstr :: ReportTaskRunnerHeartbeatResponse -> Constr #

dataTypeOf :: ReportTaskRunnerHeartbeatResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ReportTaskRunnerHeartbeatResponse # 
Show ReportTaskRunnerHeartbeatResponse # 
Generic ReportTaskRunnerHeartbeatResponse # 
NFData ReportTaskRunnerHeartbeatResponse # 
type Rep ReportTaskRunnerHeartbeatResponse # 
type Rep ReportTaskRunnerHeartbeatResponse = D1 (MetaData "ReportTaskRunnerHeartbeatResponse" "Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat" "amazonka-datapipeline-1.4.5-BJaoECYz4XDHL06I8wcb9o" False) (C1 (MetaCons "ReportTaskRunnerHeartbeatResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtrhrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_rtrhrsTerminate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))

Response Lenses

rtrhrsTerminate :: Lens' ReportTaskRunnerHeartbeatResponse Bool #

Indicates whether the calling task runner should terminate.