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