aws_sdk_networkmanager/client/get_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 [`GetDevices`](crate::operation::get_devices::builders::GetDevicesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`global_network_id(impl Into<String>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::global_network_id) / [`set_global_network_id(Option<String>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::set_global_network_id):<br>required: **true**<br><p>The ID of the global network.</p><br>
8 /// - [`device_ids(impl Into<String>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::device_ids) / [`set_device_ids(Option<Vec::<String>>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::set_device_ids):<br>required: **false**<br><p>One or more device IDs. The maximum is 10.</p><br>
9 /// - [`site_id(impl Into<String>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::site_id) / [`set_site_id(Option<String>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::set_site_id):<br>required: **false**<br><p>The ID of the site.</p><br>
10 /// - [`max_results(i32)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
11 /// - [`next_token(impl Into<String>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_devices::builders::GetDevicesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
12 /// - On success, responds with [`GetDevicesOutput`](crate::operation::get_devices::GetDevicesOutput) with field(s):
13 /// - [`devices(Option<Vec::<Device>>)`](crate::operation::get_devices::GetDevicesOutput::devices): <p>The devices.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::get_devices::GetDevicesOutput::next_token): <p>The token for the next page of results.</p>
15 /// - On failure, responds with [`SdkError<GetDevicesError>`](crate::operation::get_devices::GetDevicesError)
16 pub fn get_devices(&self) -> crate::operation::get_devices::builders::GetDevicesFluentBuilder {
17 crate::operation::get_devices::builders::GetDevicesFluentBuilder::new(self.handle.clone())
18 }
19}