aws_sdk_workmail/client/
list_organizations.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 [`ListOrganizations`](crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
9    /// - On success, responds with [`ListOrganizationsOutput`](crate::operation::list_organizations::ListOrganizationsOutput) with field(s):
10    ///   - [`organization_summaries(Option<Vec::<OrganizationSummary>>)`](crate::operation::list_organizations::ListOrganizationsOutput::organization_summaries): <p>The overview of owned organizations presented as a list of organization summaries.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_organizations::ListOrganizationsOutput::next_token): <p>The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.</p>
12    /// - On failure, responds with [`SdkError<ListOrganizationsError>`](crate::operation::list_organizations::ListOrganizationsError)
13    pub fn list_organizations(&self) -> crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder {
14        crate::operation::list_organizations::builders::ListOrganizationsFluentBuilder::new(self.handle.clone())
15    }
16}