aws-sdk-location 0.31.0

AWS SDK for Amazon Location Service
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchGetDevicePosition`](crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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): <p>The tracker resource retrieving the device position.</p>
    ///   - [`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): <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>
    /// - On success, responds with [`BatchGetDevicePositionOutput`](crate::operation::batch_get_device_position::BatchGetDevicePositionOutput) with field(s):
    ///   - [`errors(Option<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>
    ///   - [`device_positions(Option<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>
    /// - On failure, responds with [`SdkError<BatchGetDevicePositionError>`](crate::operation::batch_get_device_position::BatchGetDevicePositionError)
    pub fn batch_get_device_position(&self) -> crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder {
        crate::operation::batch_get_device_position::builders::BatchGetDevicePositionFluentBuilder::new(self.handle.clone())
    }
}