aws_sdk_quicksight/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    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</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>A pagination token that can be used in a subsequent request.</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 from this request.</p><br>
10    ///   - [`namespace(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_namespace):<br>required: **true**<br><p>The namespace. Currently, you should set this to <code>default</code>.</p><br>
11    /// - On success, responds with [`ListUsersOutput`](crate::operation::list_users::ListUsersOutput) with field(s):
12    ///   - [`user_list(Option<Vec::<User>>)`](crate::operation::list_users::ListUsersOutput::user_list): <p>The list of users.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_users::ListUsersOutput::next_token): <p>A pagination token that can be used in a subsequent request.</p>
14    ///   - [`request_id(Option<String>)`](crate::operation::list_users::ListUsersOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
15    ///   - [`status(i32)`](crate::operation::list_users::ListUsersOutput::status): <p>The HTTP status of the request.</p>
16    /// - On failure, responds with [`SdkError<ListUsersError>`](crate::operation::list_users::ListUsersError)
17    pub fn list_users(&self) -> crate::operation::list_users::builders::ListUsersFluentBuilder {
18        crate::operation::list_users::builders::ListUsersFluentBuilder::new(self.handle.clone())
19    }
20}