aws_sdk_networkmanager/client/
get_connections.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 [`GetConnections`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`global_network_id(impl Into<String>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::global_network_id) / [`set_global_network_id(Option<String>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::set_global_network_id):<br>required: **true**<br><p>The ID of the global network.</p><br>
8    ///   - [`connection_ids(impl Into<String>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::connection_ids) / [`set_connection_ids(Option<Vec::<String>>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::set_connection_ids):<br>required: **false**<br><p>One or more connection IDs.</p><br>
9    ///   - [`device_id(impl Into<String>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::device_id) / [`set_device_id(Option<String>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::set_device_id):<br>required: **false**<br><p>The ID of the device.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::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_connections::builders::GetConnectionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_connections::builders::GetConnectionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
12    /// - On success, responds with [`GetConnectionsOutput`](crate::operation::get_connections::GetConnectionsOutput) with field(s):
13    ///   - [`connections(Option<Vec::<Connection>>)`](crate::operation::get_connections::GetConnectionsOutput::connections): <p>Information about the connections.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::get_connections::GetConnectionsOutput::next_token): <p>The token to use for the next page of results.</p>
15    /// - On failure, responds with [`SdkError<GetConnectionsError>`](crate::operation::get_connections::GetConnectionsError)
16    pub fn get_connections(&self) -> crate::operation::get_connections::builders::GetConnectionsFluentBuilder {
17        crate::operation::get_connections::builders::GetConnectionsFluentBuilder::new(self.handle.clone())
18    }
19}