aws_sdk_finspace/client/list_kx_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 [`ListKxUsers`](crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`environment_id(impl Into<String>)`](crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment.</p><br>
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates where a results page should begin.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in this request.</p><br>
9 /// - On success, responds with [`ListKxUsersOutput`](crate::operation::list_kx_users::ListKxUsersOutput) with field(s):
10 /// - [`users(Option<Vec::<KxUser>>)`](crate::operation::list_kx_users::ListKxUsersOutput::users): <p>A list of users in a kdb environment.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::list_kx_users::ListKxUsersOutput::next_token): <p>A token that indicates where a results page should begin.</p>
12 /// - On failure, responds with [`SdkError<ListKxUsersError>`](crate::operation::list_kx_users::ListKxUsersError)
13 pub fn list_kx_users(&self) -> crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder {
14 crate::operation::list_kx_users::builders::ListKxUsersFluentBuilder::new(self.handle.clone())
15 }
16}