aws_sdk_cleanrooms/client/
list_collaborations.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 [`ListCollaborations`](crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder::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_collaborations::builders::ListCollaborationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder::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    ///   - [`member_status(FilterableMemberStatus)`](crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder::member_status) / [`set_member_status(Option<FilterableMemberStatus>)`](crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder::set_member_status):<br>required: **false**<br><p>The caller's status in a collaboration.</p><br>
10    /// - On success, responds with [`ListCollaborationsOutput`](crate::operation::list_collaborations::ListCollaborationsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_collaborations::ListCollaborationsOutput::next_token): <p>The pagination token that's used to fetch the next set of results.</p>
12    ///   - [`collaboration_list(Vec::<CollaborationSummary>)`](crate::operation::list_collaborations::ListCollaborationsOutput::collaboration_list): <p>The list of collaborations.</p>
13    /// - On failure, responds with [`SdkError<ListCollaborationsError>`](crate::operation::list_collaborations::ListCollaborationsError)
14    pub fn list_collaborations(&self) -> crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder {
15        crate::operation::list_collaborations::builders::ListCollaborationsFluentBuilder::new(self.handle.clone())
16    }
17}