aws_sdk_snowdevicemanagement/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 /// - [`managed_device_id(impl Into<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::managed_device_id) / [`set_managed_device_id(Option<String>)`](crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::set_managed_device_id):<br>required: **true**<br><p>The ID of the device that you are checking the information of.</p><br>
7 /// - On success, responds with [`DescribeDeviceOutput`](crate::operation::describe_device::DescribeDeviceOutput) with field(s):
8 /// - [`last_reached_out_at(Option<DateTime>)`](crate::operation::describe_device::DescribeDeviceOutput::last_reached_out_at): <p>When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.</p>
9 /// - [`last_updated_at(Option<DateTime>)`](crate::operation::describe_device::DescribeDeviceOutput::last_updated_at): <p>When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.</p>
10 /// - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_device::DescribeDeviceOutput::tags): <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.</p>
11 /// - [`managed_device_id(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::managed_device_id): <p>The ID of the device that you checked the information for.</p>
12 /// - [`managed_device_arn(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::managed_device_arn): <p>The Amazon Resource Name (ARN) of the device.</p>
13 /// - [`device_type(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::device_type): <p>The type of Amazon Web Services Snow Family device.</p>
14 /// - [`associated_with_job(Option<String>)`](crate::operation::describe_device::DescribeDeviceOutput::associated_with_job): <p>The ID of the job used when ordering the device.</p>
15 /// - [`device_state(Option<UnlockState>)`](crate::operation::describe_device::DescribeDeviceOutput::device_state): <p>The current state of the device.</p>
16 /// - [`physical_network_interfaces(Option<Vec::<PhysicalNetworkInterface>>)`](crate::operation::describe_device::DescribeDeviceOutput::physical_network_interfaces): <p>The network interfaces available on the device.</p>
17 /// - [`device_capacities(Option<Vec::<Capacity>>)`](crate::operation::describe_device::DescribeDeviceOutput::device_capacities): <p>The hardware specifications of the device.</p>
18 /// - [`software(Option<SoftwareInformation>)`](crate::operation::describe_device::DescribeDeviceOutput::software): <p>The software installed on the device.</p>
19 /// - On failure, responds with [`SdkError<DescribeDeviceError>`](crate::operation::describe_device::DescribeDeviceError)
20 pub fn describe_device(&self) -> crate::operation::describe_device::builders::DescribeDeviceFluentBuilder {
21 crate::operation::describe_device::builders::DescribeDeviceFluentBuilder::new(self.handle.clone())
22 }
23}