
report-task-runner-heartbeat
****************************


DESCRIPTION
===========

Task runners call report-task-runner-heartbeat 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.


SYNOPSIS
========

   aws datapipeline report-task-runner-heartbeat
     --taskrunner-id <value>
     [--worker-group <value>]
     [--hostname <value>]


REQUIRED PARAMETERS
===================

"--taskrunner-id"  (string)
   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.


OPTIONAL PARAMETERS
===================

"--worker-group"  (string)
   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 --worker-group in the call to ReportTaskRunnerHeartbeat. There
   are no wildcard values permitted in workerGroup, the string must be
   an exact, case-sensitive, match.

"--hostname"  (string)
   The public DNS name of the calling task runner.
