aws_sdk_sagemaker/client/
describe_device.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 [`DescribeDevice`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::set_next_token):<br>required: **false**<br><p>Next token of device description.</p><br>
7    ///   - [`device_name(impl Into<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::device_name) / [`set_device_name(Option<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::set_device_name):<br>required: **true**<br><p>The unique ID of the device.</p><br>
8    ///   - [`device_fleet_name(impl Into<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::device_fleet_name) / [`set_device_fleet_name(Option<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::set_device_fleet_name):<br>required: **true**<br><p>The name of the fleet the devices belong to.</p><br>
9    /// - On success, responds with [`DescribeDeviceOutput`](crate::operation::describe_device::DescribeDeviceOutput) with field(s):
10    ///   - [`device_arn(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::device_arn): <p>The Amazon Resource Name (ARN) of the device.</p>
11    ///   - [`device_name(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::device_name): <p>The unique identifier of the device.</p>
12    ///   - [`description(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::description): <p>A description of the device.</p>
13    ///   - [`device_fleet_name(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::device_fleet_name): <p>The name of the fleet the device belongs to.</p>
14    ///   - [`iot_thing_name(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::iot_thing_name): <p>The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.</p>
15    ///   - [`registration_time(Option<DateTime>)`](crate::operation::describe_device::DescribeDeviceOutput::registration_time): <p>The timestamp of the last registration or de-reregistration.</p>
16    ///   - [`latest_heartbeat(Option<DateTime>)`](crate::operation::describe_device::DescribeDeviceOutput::latest_heartbeat): <p>The last heartbeat received from the device.</p>
17    ///   - [`models(Option<Vec::<EdgeModel>>)`](crate::operation::describe_device::DescribeDeviceOutput::models): <p>Models on the device.</p>
18    ///   - [`max_models(Option<i32>)`](crate::operation::describe_device::DescribeDeviceOutput::max_models): <p>The maximum number of models.</p>
19    ///   - [`next_token(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::next_token): <p>The response from the last list when returning a list large enough to need tokening.</p>
20    ///   - [`agent_version(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::agent_version): <p>Edge Manager agent version.</p>
21    /// - On failure, responds with [`SdkError<DescribeDeviceError>`](crate::operation::describe_device::DescribeDeviceError)
22    pub fn describe_device(&self) -> crate::operation::describe_device::builders::DescribeDeviceFluentBuilder {
23        crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::new(self.handle.clone())
24    }
25}