amazonka-datapipeline-0.1.2: Amazon Data Pipeline SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat

Contents

Description

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner 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.

http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ReportTaskRunnerHeartbeat.html

Synopsis

Request

Request constructor

Request lenses

rtrhHostname :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) Source

The public DNS name of the calling task runner.

rtrhTaskrunnerId :: Lens' ReportTaskRunnerHeartbeat Text Source

The identifier 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.

rtrhWorkerGroup :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) Source

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

Response

Response constructor

Response lenses

rtrhrTerminate :: Lens' ReportTaskRunnerHeartbeatResponse Bool Source

Indicates whether the calling task runner should terminate. If True, the task runner that called ReportTaskRunnerHeartbeat should terminate.