aws_sdk_cleanrooms/client/
list_memberships.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 [`ListMemberships`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that's used to fetch the next set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p><br>
9    ///   - [`status(MembershipStatus)`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::status) / [`set_status(Option<MembershipStatus>)`](crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::set_status):<br>required: **false**<br><p>A filter which will return only memberships in the specified status.</p><br>
10    /// - On success, responds with [`ListMembershipsOutput`](crate::operation::list_memberships::ListMembershipsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_memberships::ListMembershipsOutput::next_token): <p>The pagination token that's used to fetch the next set of results.</p>
12    ///   - [`membership_summaries(Vec::<MembershipSummary>)`](crate::operation::list_memberships::ListMembershipsOutput::membership_summaries): <p>The list of memberships returned from the ListMemberships operation.</p>
13    /// - On failure, responds with [`SdkError<ListMembershipsError>`](crate::operation::list_memberships::ListMembershipsError)
14    pub fn list_memberships(&self) -> crate::operation::list_memberships::builders::ListMembershipsFluentBuilder {
15        crate::operation::list_memberships::builders::ListMembershipsFluentBuilder::new(self.handle.clone())
16    }
17}