aws_sdk_location/client/

get_device_position_history.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetDevicePositionHistory`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`tracker_name(impl Into<String>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::tracker_name) / [`set_tracker_name(Option<String>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::set_tracker_name):<br>required: **true**<br><p>The tracker resource receiving the request for the device position history.</p><br>
    ///   - [`device_id(impl Into<String>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::device_id) / [`set_device_id(Option<String>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::set_device_id):<br>required: **true**<br><p>The device whose position history you want to retrieve.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p> <p>Default value: <code>null</code></p><br>
    ///   - [`start_time_inclusive(DateTime)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::start_time_inclusive) / [`set_start_time_inclusive(Option<DateTime>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::set_start_time_inclusive):<br>required: **false**<br><p>Specify the start time for the position history in <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>. By default, the value will be 24 hours prior to the time that the request is made.</p> <p>Requirement:</p> <ul>  <li>   <p>The time specified for <code>StartTimeInclusive</code> must be before <code>EndTimeExclusive</code>.</p></li> </ul><br>
    ///   - [`end_time_exclusive(DateTime)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::end_time_exclusive) / [`set_end_time_exclusive(Option<DateTime>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::set_end_time_exclusive):<br>required: **false**<br><p>Specify the end time for the position history in <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>. By default, the value will be the time that the request is made.</p> <p>Requirement:</p> <ul>  <li>   <p>The time specified for <code>EndTimeExclusive</code> must be after the time for <code>StartTimeInclusive</code>.</p></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional limit for the number of device positions returned in a single call.</p> <p>Default value: <code>100</code></p><br>
    /// - On success, responds with [`GetDevicePositionHistoryOutput`](crate::operation::get_device_position_history::GetDevicePositionHistoryOutput) with field(s):
    ///   - [`device_positions(Vec::<DevicePosition>)`](crate::operation::get_device_position_history::GetDevicePositionHistoryOutput::device_positions): <p>Contains the position history details for the requested device.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_device_position_history::GetDevicePositionHistoryOutput::next_token): <p>A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.</p>
    /// - On failure, responds with [`SdkError<GetDevicePositionHistoryError>`](crate::operation::get_device_position_history::GetDevicePositionHistoryError)
    pub fn get_device_position_history(&self) -> crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder {
        crate::operation::get_device_position_history::builders::GetDevicePositionHistoryFluentBuilder::new(self.handle.clone())
    }
}