Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198974.1 KB

Task runners call <code>ReportTaskRunnerHeartbeat</code> 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.

post/#X-Amz-Target=DataPipeline.ReportTaskRunnerHeartbeat

Headers

X-Amz-Target'DataPipeline.ReportTaskRunnerHeartbeat' required

Request body

taskrunnerIdstring required

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.

workerGroupstring

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

hostnamestring

The public DNS name of the task runner.

Response

Success

terminateboolean required

Indicates whether the calling task runner should terminate.