aws_sdk_managedblockchain/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    ///   - [`name(impl Into<String>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::set_name):<br>required: **false**<br><p>The name of the network.</p><br>
8    ///   - [`framework(Framework)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::framework) / [`set_framework(Option<Framework>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::set_framework):<br>required: **false**<br><p>An optional framework specifier. If provided, only networks of this framework type are listed.</p><br>
9    ///   - [`status(NetworkStatus)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::status) / [`set_status(Option<NetworkStatus>)`](crate::operation::list_networks::builders::ListNetworksFluentBuilder::set_status):<br>required: **false**<br><p>An optional status specifier. If provided, only networks currently in this status are listed.</p> <p>Applies only to Hyperledger Fabric.</p><br>
10    ///   - [`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 list.</p><br>
11    ///   - [`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 pagination token that indicates the next set of results to retrieve.</p><br>
12    /// - On success, responds with [`ListNetworksOutput`](crate::operation::list_networks::ListNetworksOutput) with field(s):
13    ///   - [`networks(Option<Vec::<NetworkSummary>>)`](crate::operation::list_networks::ListNetworksOutput::networks): <p>An array of <code>NetworkSummary</code> objects that contain configuration properties for each network.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_networks::ListNetworksOutput::next_token): <p>The pagination token that indicates the next set of results to retrieve.</p>
15    /// - On failure, responds with [`SdkError<ListNetworksError>`](crate::operation::list_networks::ListNetworksError)
16    pub fn list_networks(&self) -> crate::operation::list_networks::builders::ListNetworksFluentBuilder {
17        crate::operation::list_networks::builders::ListNetworksFluentBuilder::new(self.handle.clone())
18    }
19}