aws_sdk_managedblockchain/client/list_members.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 [`ListMembers`](crate::operation::list_members::builders::ListMembersFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_members::builders::ListMembersFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`network_id(impl Into<String>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::set_network_id):<br>required: **true**<br><p>The unique identifier of the network for which to list members.</p><br>
8 /// - [`name(impl Into<String>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::set_name):<br>required: **false**<br><p>The optional name of the member to list.</p><br>
9 /// - [`status(MemberStatus)`](crate::operation::list_members::builders::ListMembersFluentBuilder::status) / [`set_status(Option<MemberStatus>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::set_status):<br>required: **false**<br><p>An optional status specifier. If provided, only members currently in this status are listed.</p><br>
10 /// - [`is_owned(bool)`](crate::operation::list_members::builders::ListMembersFluentBuilder::is_owned) / [`set_is_owned(Option<bool>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::set_is_owned):<br>required: **false**<br><p>An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns (<code>true</code>) or that other Amazon Web Services accountsn own (<code>false</code>). If omitted, all members are listed.</p><br>
11 /// - [`max_results(i32)`](crate::operation::list_members::builders::ListMembersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of members to return in the request.</p><br>
12 /// - [`next_token(impl Into<String>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_members::builders::ListMembersFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that indicates the next set of results to retrieve.</p><br>
13 /// - On success, responds with [`ListMembersOutput`](crate::operation::list_members::ListMembersOutput) with field(s):
14 /// - [`members(Option<Vec::<MemberSummary>>)`](crate::operation::list_members::ListMembersOutput::members): <p>An array of <code>MemberSummary</code> objects. Each object contains details about a network member.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::list_members::ListMembersOutput::next_token): <p>The pagination token that indicates the next set of results to retrieve.</p>
16 /// - On failure, responds with [`SdkError<ListMembersError>`](crate::operation::list_members::ListMembersError)
17 pub fn list_members(&self) -> crate::operation::list_members::builders::ListMembersFluentBuilder {
18 crate::operation::list_members::builders::ListMembersFluentBuilder::new(self.handle.clone())
19 }
20}