aws_sdk_location/client/
list_device_positions.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 [`ListDevicePositions`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`tracker_name(impl Into<String>)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::tracker_name) / [`set_tracker_name(Option<String>)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::set_tracker_name):<br>required: **true**<br><p>The tracker resource containing the requested devices.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional limit for the number of entries returned in a single call.</p> <p>Default value: <code>100</code></p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::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>
10    ///   - [`filter_geometry(TrackingFilterGeometry)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::filter_geometry) / [`set_filter_geometry(Option<TrackingFilterGeometry>)`](crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::set_filter_geometry):<br>required: **false**<br><p>The geometry used to filter device positions.</p><br>
11    /// - On success, responds with [`ListDevicePositionsOutput`](crate::operation::list_device_positions::ListDevicePositionsOutput) with field(s):
12    ///   - [`entries(Vec::<ListDevicePositionsResponseEntry>)`](crate::operation::list_device_positions::ListDevicePositionsOutput::entries): <p>Contains details about each device's last known position.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_device_positions::ListDevicePositionsOutput::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>
14    /// - On failure, responds with [`SdkError<ListDevicePositionsError>`](crate::operation::list_device_positions::ListDevicePositionsError)
15    pub fn list_device_positions(&self) -> crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder {
16        crate::operation::list_device_positions::builders::ListDevicePositionsFluentBuilder::new(self.handle.clone())
17    }
18}