aws_sdk_wickr/client/
list_networks.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 [`ListNetworks`](crate::operation::list_networks::builders::ListNetworksFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of networks to return in a single page. Valid range is 1-100. Default is 10.</p><br>
8    ///   - [`sort_fields(impl Into<String>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::sort_fields) / [`set_sort_fields(Option<String>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::set_sort_fields):<br>required: **false**<br><p>The field to sort networks by. Accepted values are 'networkId' and 'networkName'. Default is 'networkId'.</p><br>
9    ///   - [`sort_direction(SortDirection)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::sort_direction) / [`set_sort_direction(Option<SortDirection>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::set_sort_direction):<br>required: **false**<br><p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p><br>
11    /// - On success, responds with [`ListNetworksOutput`](crate::operation::list_networks::ListNetworksOutput) with field(s):
12    ///   - [`networks(Vec::<Network>)`](crate::operation::list_networks::ListNetworksOutput::networks): <p>A list of network objects for the Amazon Web Services account.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_networks::ListNetworksOutput::next_token): <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
14    /// - On failure, responds with [`SdkError<ListNetworksError>`](crate::operation::list_networks::ListNetworksError)
15    pub fn list_networks(&self) -> crate::operation::list_networks::builders::ListNetworksFluentBuilder {
16        crate::operation::list_networks::builders::ListNetworksFluentBuilder::new(self.handle.clone())
17    }
18}