aws_sdk_wickr/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    ///   - [`network_id(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network from which to list users.</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 for retrieving the next page of results. This is returned from a previous request when there are more results available.</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 users to return in a single page. Valid range is 1-100. Default is 10.</p><br>
10    ///   - [`sort_fields(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::sort_fields) / [`set_sort_fields(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_sort_fields):<br>required: **false**<br><p>The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.</p><br>
11    ///   - [`sort_direction(SortDirection)`](crate::operation::list_users::builders::ListUsersFluentBuilder::sort_direction) / [`set_sort_direction(Option<SortDirection>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_sort_direction):<br>required: **false**<br><p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p><br>
12    ///   - [`first_name(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::first_name) / [`set_first_name(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_first_name):<br>required: **false**<br><p>Filter results to only include users with first names matching this value.</p><br>
13    ///   - [`last_name(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::last_name) / [`set_last_name(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_last_name):<br>required: **false**<br><p>Filter results to only include users with last names matching this value.</p><br>
14    ///   - [`username(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_username):<br>required: **false**<br><p>Filter results to only include users with usernames matching this value.</p><br>
15    ///   - [`status(i32)`](crate::operation::list_users::builders::ListUsersFluentBuilder::status) / [`set_status(Option<i32>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_status):<br>required: **false**<br><p>Filter results to only include users with this status (1 for pending, 2 for active).</p><br>
16    ///   - [`group_id(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_group_id):<br>required: **false**<br><p>Filter results to only include users belonging to this security group.</p><br>
17    /// - On success, responds with [`ListUsersOutput`](crate::operation::list_users::ListUsersOutput) with field(s):
18    ///   - [`next_token(Option<String>)`](crate::operation::list_users::ListUsersOutput::next_token): <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
19    ///   - [`users(Option<Vec::<User>>)`](crate::operation::list_users::ListUsersOutput::users): <p>A list of user objects matching the specified filters and within the current page.</p>
20    /// - On failure, responds with [`SdkError<ListUsersError>`](crate::operation::list_users::ListUsersError)
21    pub fn list_users(&self) -> crate::operation::list_users::builders::ListUsersFluentBuilder {
22        crate::operation::list_users::builders::ListUsersFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_wickr/client/list_users.rs

aws_sdk_wickr/client/
list_users.rs
