aws_sdk_networkmanager/client/
get_links.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 [`GetLinks`](crate::operation::get_links::builders::GetLinksFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_links::builders::GetLinksFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`global_network_id(impl Into<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::global_network_id) / [`set_global_network_id(Option<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::set_global_network_id):<br>required: **true**<br><p>The ID of the global network.</p><br>
8    ///   - [`link_ids(impl Into<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::link_ids) / [`set_link_ids(Option<Vec::<String>>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::set_link_ids):<br>required: **false**<br><p>One or more link IDs. The maximum is 10.</p><br>
9    ///   - [`site_id(impl Into<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::site_id) / [`set_site_id(Option<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::set_site_id):<br>required: **false**<br><p>The ID of the site.</p><br>
10    ///   - [`r#type(impl Into<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::type) / [`set_type(Option<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::set_type):<br>required: **false**<br><p>The link type.</p><br>
11    ///   - [`provider(impl Into<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::provider) / [`set_provider(Option<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::set_provider):<br>required: **false**<br><p>The link provider.</p><br>
12    ///   - [`max_results(i32)`](crate::operation::get_links::builders::GetLinksFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
13    ///   - [`next_token(impl Into<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_links::builders::GetLinksFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
14    /// - On success, responds with [`GetLinksOutput`](crate::operation::get_links::GetLinksOutput) with field(s):
15    ///   - [`links(Option<Vec::<Link>>)`](crate::operation::get_links::GetLinksOutput::links): <p>The links.</p>
16    ///   - [`next_token(Option<String>)`](crate::operation::get_links::GetLinksOutput::next_token): <p>The token for the next page of results.</p>
17    /// - On failure, responds with [`SdkError<GetLinksError>`](crate::operation::get_links::GetLinksError)
18    pub fn get_links(&self) -> crate::operation::get_links::builders::GetLinksFluentBuilder {
19        crate::operation::get_links::builders::GetLinksFluentBuilder::new(self.handle.clone())
20    }
21}