aws_sdk_wickr/client/
get_users_count.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 [`GetUsersCount`](crate::operation::get_users_count::builders::GetUsersCountFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::get_users_count::builders::GetUsersCountFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::get_users_count::builders::GetUsersCountFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network for which to retrieve user counts.</p><br>
7    /// - On success, responds with [`GetUsersCountOutput`](crate::operation::get_users_count::GetUsersCountOutput) with field(s):
8    ///   - [`pending(i32)`](crate::operation::get_users_count::GetUsersCountOutput::pending): <p>The number of users with pending status (invited but not yet accepted).</p>
9    ///   - [`active(i32)`](crate::operation::get_users_count::GetUsersCountOutput::active): <p>The number of users with active status in the network.</p>
10    ///   - [`rejected(i32)`](crate::operation::get_users_count::GetUsersCountOutput::rejected): <p>The number of users who have rejected network invitations.</p>
11    ///   - [`remaining(i32)`](crate::operation::get_users_count::GetUsersCountOutput::remaining): <p>The number of additional users that can be added to the network while maintaining premium free trial eligibility.</p>
12    ///   - [`total(i32)`](crate::operation::get_users_count::GetUsersCountOutput::total): <p>The total number of users in the network (active and pending combined).</p>
13    /// - On failure, responds with [`SdkError<GetUsersCountError>`](crate::operation::get_users_count::GetUsersCountError)
14    pub fn get_users_count(&self) -> crate::operation::get_users_count::builders::GetUsersCountFluentBuilder {
15        crate::operation::get_users_count::builders::GetUsersCountFluentBuilder::new(self.handle.clone())
16    }
17}