aws_sdk_managedblockchain/client/list_proposals.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 [`ListProposals`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`network_id(impl Into<String>)`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder::set_network_id):<br>required: **true**<br><p>The unique identifier of the network.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of proposals to return.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_proposals::builders::ListProposalsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that indicates the next set of results to retrieve.</p><br>
10 /// - On success, responds with [`ListProposalsOutput`](crate::operation::list_proposals::ListProposalsOutput) with field(s):
11 /// - [`proposals(Option<Vec::<ProposalSummary>>)`](crate::operation::list_proposals::ListProposalsOutput::proposals): <p>The summary of each proposal made on the network.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_proposals::ListProposalsOutput::next_token): <p>The pagination token that indicates the next set of results to retrieve.</p>
13 /// - On failure, responds with [`SdkError<ListProposalsError>`](crate::operation::list_proposals::ListProposalsError)
14 pub fn list_proposals(&self) -> crate::operation::list_proposals::builders::ListProposalsFluentBuilder {
15 crate::operation::list_proposals::builders::ListProposalsFluentBuilder::new(self.handle.clone())
16 }
17}