aws_sdk_managedblockchain/client/
list_nodes.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 [`ListNodes`](crate::operation::list_nodes::builders::ListNodesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`network_id(impl Into<String>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::set_network_id):<br>required: **true**<br><p>The unique identifier of the network for which to list nodes.</p><br>
8    ///   - [`member_id(impl Into<String>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::member_id) / [`set_member_id(Option<String>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::set_member_id):<br>required: **false**<br><p>The unique identifier of the member who owns the nodes to list.</p> <p>Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.</p><br>
9    ///   - [`status(NodeStatus)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::status) / [`set_status(Option<NodeStatus>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::set_status):<br>required: **false**<br><p>An optional status specifier. If provided, only nodes currently in this status are listed.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of nodes to list.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_nodes::builders::ListNodesFluentBuilder::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 [`ListNodesOutput`](crate::operation::list_nodes::ListNodesOutput) with field(s):
13    ///   - [`nodes(Option<Vec::<NodeSummary>>)`](crate::operation::list_nodes::ListNodesOutput::nodes): <p>An array of <code>NodeSummary</code> objects that contain configuration properties for each node.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_nodes::ListNodesOutput::next_token): <p>The pagination token that indicates the next set of results to retrieve.</p>
15    /// - On failure, responds with [`SdkError<ListNodesError>`](crate::operation::list_nodes::ListNodesError)
16    pub fn list_nodes(&self) -> crate::operation::list_nodes::builders::ListNodesFluentBuilder {
17        crate::operation::list_nodes::builders::ListNodesFluentBuilder::new(self.handle.clone())
18    }
19}