aws_sdk_appstream/client/
describe_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 [`DescribeUsers`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`authentication_type(AuthenticationType)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::authentication_type) / [`set_authentication_type(Option<AuthenticationType>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_authentication_type):<br>required: **true**<br><p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p><br>
7    ///   - [`max_results(i32)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum size of each page of results.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p><br>
9    /// - On success, responds with [`DescribeUsersOutput`](crate::operation::describe_users::DescribeUsersOutput) with field(s):
10    ///   - [`users(Option<Vec::<User>>)`](crate::operation::describe_users::DescribeUsersOutput::users): <p>Information about users in the user pool.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::describe_users::DescribeUsersOutput::next_token): <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
12    /// - On failure, responds with [`SdkError<DescribeUsersError>`](crate::operation::describe_users::DescribeUsersError)
13    pub fn describe_users(&self) -> crate::operation::describe_users::builders::DescribeUsersFluentBuilder {
14        crate::operation::describe_users::builders::DescribeUsersFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_appstream/client/describe_users.rs

aws_sdk_appstream/client/
describe_users.rs
