aws_sdk_datapipeline/client/

report_task_runner_heartbeat.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ReportTaskRunnerHeartbeat`](crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`taskrunner_id(impl Into<String>)`](crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder::taskrunner_id) / [`set_taskrunner_id(Option<String>)`](crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder::set_taskrunner_id):<br>required: **true**<br><p>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.</p><br>
    ///   - [`worker_group(impl Into<String>)`](crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder::worker_group) / [`set_worker_group(Option<String>)`](crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder::set_worker_group):<br>required: **false**<br><p>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.</p><br>
    ///   - [`hostname(impl Into<String>)`](crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder::hostname) / [`set_hostname(Option<String>)`](crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder::set_hostname):<br>required: **false**<br><p>The public DNS name of the task runner.</p><br>
    /// - On success, responds with [`ReportTaskRunnerHeartbeatOutput`](crate::operation::report_task_runner_heartbeat::ReportTaskRunnerHeartbeatOutput) with field(s):
    ///   - [`terminate(bool)`](crate::operation::report_task_runner_heartbeat::ReportTaskRunnerHeartbeatOutput::terminate): <p>Indicates whether the calling task runner should terminate.</p>
    /// - On failure, responds with [`SdkError<ReportTaskRunnerHeartbeatError>`](crate::operation::report_task_runner_heartbeat::ReportTaskRunnerHeartbeatError)
    pub fn report_task_runner_heartbeat(&self) -> crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder {
        crate::operation::report_task_runner_heartbeat::builders::ReportTaskRunnerHeartbeatFluentBuilder::new(self.handle.clone())
    }
}