aws_sdk_chime/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    ///   - [`account_id(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Chime account ID.</p><br>
8    ///   - [`user_email(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::user_email) / [`set_user_email(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_user_email):<br>required: **false**<br><p>Optional. The user email address used to filter results. Maximum 1.</p><br>
9    ///   - [`user_type(UserType)`](crate::operation::list_users::builders::ListUsersFluentBuilder::user_type) / [`set_user_type(Option<UserType>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_user_type):<br>required: **false**<br><p>The user type.</p><br>
10    ///   - [`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. Defaults to 100.</p><br>
11    ///   - [`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.</p><br>
12    /// - On success, responds with [`ListUsersOutput`](crate::operation::list_users::ListUsersOutput) with field(s):
13    ///   - [`users(Option<Vec::<User>>)`](crate::operation::list_users::ListUsersOutput::users): <p>List of users and user details.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_users::ListUsersOutput::next_token): <p>The token to use to retrieve the next page of results.</p>
15    /// - On failure, responds with [`SdkError<ListUsersError>`](crate::operation::list_users::ListUsersError)
16    pub fn list_users(&self) -> crate::operation::list_users::builders::ListUsersFluentBuilder {
17        crate::operation::list_users::builders::ListUsersFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_chime/client/list_users.rs

aws_sdk_chime/client/
list_users.rs
