aws_sdk_workmail/client/
list_users.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 [`ListUsers`](crate::operation::list_users::builders::ListUsersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_users::builders::ListUsersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`organization_id(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier for the organization under which the users exist.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::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>
9    ///   - [`max_results(i32)`](crate::operation::list_users::builders::ListUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
10    ///   - [`filters(ListUsersFilters)`](crate::operation::list_users::builders::ListUsersFluentBuilder::filters) / [`set_filters(Option<ListUsersFilters>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_filters):<br>required: **false**<br><p>Limit the user search results based on the filter criteria. You can only use one filter per request.</p><br>
11    /// - On success, responds with [`ListUsersOutput`](crate::operation::list_users::ListUsersOutput) with field(s):
12    ///   - [`users(Option<Vec::<User>>)`](crate::operation::list_users::ListUsersOutput::users): <p>The overview of users for an organization.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_users::ListUsersOutput::next_token): <p>The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.</p>
14    /// - On failure, responds with [`SdkError<ListUsersError>`](crate::operation::list_users::ListUsersError)
15    pub fn list_users(&self) -> crate::operation::list_users::builders::ListUsersFluentBuilder {
16        crate::operation::list_users::builders::ListUsersFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_workmail/client/list_users.rs

aws_sdk_workmail/client/
list_users.rs
