aws_sdk_location/client/
batch_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 [`BatchGetDevicePosition`](crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`tracker_name(impl Into<String>)`](crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder::tracker_name) / [`set_tracker_name(Option<String>)`](crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder::set_tracker_name):<br>required: **true**<br><p>The tracker resource retrieving the device position.</p><br>
7    ///   - [`device_ids(impl Into<String>)`](crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder::device_ids) / [`set_device_ids(Option<Vec::<String>>)`](crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder::set_device_ids):<br>required: **true**<br><p>Devices whose position you want to retrieve.</p> <ul>  <li>   <p>For example, for two devices: <code>device-ids=DeviceId1&amp;device-ids=DeviceId2</code></p></li> </ul><br>
8    /// - On success, responds with [`BatchGetDevicePositionOutput`](crate::operation::batch_get_device_position::BatchGetDevicePositionOutput) with field(s):
9    ///   - [`errors(Vec::<BatchGetDevicePositionError>)`](crate::operation::batch_get_device_position::BatchGetDevicePositionOutput::errors): <p>Contains error details for each device that failed to send its position to the tracker resource.</p>
10    ///   - [`device_positions(Vec::<DevicePosition>)`](crate::operation::batch_get_device_position::BatchGetDevicePositionOutput::device_positions): <p>Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.</p>
11    /// - On failure, responds with [`SdkError<BatchGetDevicePositionError>`](crate::operation::batch_get_device_position::BatchGetDevicePositionError)
12    pub fn batch_get_device_position(&self) -> crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder {
13        crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder::new(self.handle.clone())
14    }
15}