aws_sdk_sagemakeredge/client/
send_heartbeat.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`SendHeartbeat`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`agent_metrics(EdgeMetric)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::agent_metrics) / [`set_agent_metrics(Option<Vec::<EdgeMetric>>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::set_agent_metrics):<br>required: **false**<br><p>For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.</p><br>
7    ///   - [`models(Model)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::models) / [`set_models(Option<Vec::<Model>>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::set_models):<br>required: **false**<br><p>Returns a list of models deployed on the the device.</p><br>
8    ///   - [`agent_version(impl Into<String>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::agent_version) / [`set_agent_version(Option<String>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::set_agent_version):<br>required: **true**<br><p>Returns the version of the agent.</p><br>
9    ///   - [`device_name(impl Into<String>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::device_name) / [`set_device_name(Option<String>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::set_device_name):<br>required: **true**<br><p>The unique name of the device.</p><br>
10    ///   - [`device_fleet_name(impl Into<String>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::device_fleet_name) / [`set_device_fleet_name(Option<String>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::set_device_fleet_name):<br>required: **true**<br><p>The name of the fleet that the device belongs to.</p><br>
11    ///   - [`deployment_result(DeploymentResult)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::deployment_result) / [`set_deployment_result(Option<DeploymentResult>)`](crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::set_deployment_result):<br>required: **false**<br><p>Returns the result of a deployment on the device.</p><br>
12    /// - On success, responds with [`SendHeartbeatOutput`](crate::operation::send_heartbeat::SendHeartbeatOutput)
13    /// - On failure, responds with [`SdkError<SendHeartbeatError>`](crate::operation::send_heartbeat::SendHeartbeatError)
14    pub fn send_heartbeat(&self) -> crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder {
15        crate::operation::send_heartbeat::builders::SendHeartbeatFluentBuilder::new(self.handle.clone())
16    }
17}