aws_sdk_wickr/client/
list_guest_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 [`ListGuestUsers`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`network_id(impl Into<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network from which to list guest users.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.</p><br>
9    ///   - [`sort_direction(SortDirection)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::sort_direction) / [`set_sort_direction(Option<SortDirection>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::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>
10    ///   - [`sort_fields(impl Into<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::sort_fields) / [`set_sort_fields(Option<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::set_sort_fields):<br>required: **false**<br><p>The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.</p><br>
11    ///   - [`username(impl Into<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::set_username):<br>required: **false**<br><p>Filter results to only include guest users with usernames matching this value.</p><br>
12    ///   - [`billing_period(impl Into<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::billing_period) / [`set_billing_period(Option<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::set_billing_period):<br>required: **false**<br><p>Filter results to only include guest users from this billing period (e.g., '2024-01').</p><br>
13    ///   - [`next_token(impl Into<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::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>
14    /// - On success, responds with [`ListGuestUsersOutput`](crate::operation::list_guest_users::ListGuestUsersOutput) with field(s):
15    ///   - [`next_token(Option<String>)`](crate::operation::list_guest_users::ListGuestUsersOutput::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>
16    ///   - [`guestlist(Vec::<GuestUser>)`](crate::operation::list_guest_users::ListGuestUsersOutput::guestlist): <p>A list of guest user objects within the current page.</p>
17    /// - On failure, responds with [`SdkError<ListGuestUsersError>`](crate::operation::list_guest_users::ListGuestUsersError)
18    pub fn list_guest_users(&self) -> crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder {
19        crate::operation::list_guest_users::builders::ListGuestUsersFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_wickr/client/list_guest_users.rs

aws_sdk_wickr/client/
list_guest_users.rs
