aws_sdk_snowdevicemanagement/client/list_devices.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 [`ListDevices`](crate::operation::list_devices::builders::ListDevicesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`job_id(impl Into<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::set_job_id):<br>required: **false**<br><p>The ID of the job used to order the device.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of devices to list per page.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::set_next_token):<br>required: **false**<br><p>A pagination token to continue to the next page of results.</p><br>
10 /// - On success, responds with [`ListDevicesOutput`](crate::operation::list_devices::ListDevicesOutput) with field(s):
11 /// - [`devices(Option<Vec::<DeviceSummary>>)`](crate::operation::list_devices::ListDevicesOutput::devices): <p>A list of device structures that contain information about the device.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_devices::ListDevicesOutput::next_token): <p>A pagination token to continue to the next page of devices.</p>
13 /// - On failure, responds with [`SdkError<ListDevicesError>`](crate::operation::list_devices::ListDevicesError)
14 pub fn list_devices(&self) -> crate::operation::list_devices::builders::ListDevicesFluentBuilder {
15 crate::operation::list_devices::builders::ListDevicesFluentBuilder::new(self.handle.clone())
16 }
17}