aws_sdk_location/client/
get_device_position.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 [`GetDevicePosition`](crate::operation::get_device_position::builders::GetDevicePositionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`tracker_name(impl Into<String>)`](crate::operation::get_device_position::builders::GetDevicePositionFluentBuilder::tracker_name) / [`set_tracker_name(Option<String>)`](crate::operation::get_device_position::builders::GetDevicePositionFluentBuilder::set_tracker_name):<br>required: **true**<br><p>The tracker resource receiving the position update.</p><br>
7    ///   - [`device_id(impl Into<String>)`](crate::operation::get_device_position::builders::GetDevicePositionFluentBuilder::device_id) / [`set_device_id(Option<String>)`](crate::operation::get_device_position::builders::GetDevicePositionFluentBuilder::set_device_id):<br>required: **true**<br><p>The device whose position you want to retrieve.</p><br>
8    /// - On success, responds with [`GetDevicePositionOutput`](crate::operation::get_device_position::GetDevicePositionOutput) with field(s):
9    ///   - [`device_id(Option<String>)`](crate::operation::get_device_position::GetDevicePositionOutput::device_id): <p>The device whose position you retrieved.</p>
10    ///   - [`sample_time(DateTime)`](crate::operation::get_device_position::GetDevicePositionOutput::sample_time): <p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601 </a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
11    ///   - [`received_time(DateTime)`](crate::operation::get_device_position::GetDevicePositionOutput::received_time): <p>The timestamp for when the tracker resource received the device position. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601 </a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
12    ///   - [`position(Vec::<f64>)`](crate::operation::get_device_position::GetDevicePositionOutput::position): <p>The last known device position.</p>
13    ///   - [`accuracy(Option<PositionalAccuracy>)`](crate::operation::get_device_position::GetDevicePositionOutput::accuracy): <p>The accuracy of the device position.</p>
14    ///   - [`position_properties(Option<HashMap::<String, String>>)`](crate::operation::get_device_position::GetDevicePositionOutput::position_properties): <p>The properties associated with the position.</p>
15    /// - On failure, responds with [`SdkError<GetDevicePositionError>`](crate::operation::get_device_position::GetDevicePositionError)
16    pub fn get_device_position(&self) -> crate::operation::get_device_position::builders::GetDevicePositionFluentBuilder {
17        crate::operation::get_device_position::builders::GetDevicePositionFluentBuilder::new(self.handle.clone())
18    }
19}