aws_sdk_wickr/client/
get_user.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 [`GetUser`](crate::operation::get_user::builders::GetUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::get_user::builders::GetUserFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::get_user::builders::GetUserFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network containing the user.</p><br>
7    ///   - [`user_id(impl Into<String>)`](crate::operation::get_user::builders::GetUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::get_user::builders::GetUserFluentBuilder::set_user_id):<br>required: **true**<br><p>The unique identifier of the user to retrieve.</p><br>
8    ///   - [`start_time(DateTime)`](crate::operation::get_user::builders::GetUserFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::get_user::builders::GetUserFluentBuilder::set_start_time):<br>required: **false**<br><p>The start time for filtering the user's last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.</p><br>
9    ///   - [`end_time(DateTime)`](crate::operation::get_user::builders::GetUserFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::get_user::builders::GetUserFluentBuilder::set_end_time):<br>required: **false**<br><p>The end time for filtering the user's last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.</p><br>
10    /// - On success, responds with [`GetUserOutput`](crate::operation::get_user::GetUserOutput) with field(s):
11    ///   - [`user_id(String)`](crate::operation::get_user::GetUserOutput::user_id): <p>The unique identifier of the user.</p>
12    ///   - [`first_name(Option<String>)`](crate::operation::get_user::GetUserOutput::first_name): <p>The first name of the user.</p>
13    ///   - [`last_name(Option<String>)`](crate::operation::get_user::GetUserOutput::last_name): <p>The last name of the user.</p>
14    ///   - [`username(Option<String>)`](crate::operation::get_user::GetUserOutput::username): <p>The email address or username of the user.</p>
15    ///   - [`is_admin(Option<bool>)`](crate::operation::get_user::GetUserOutput::is_admin): <p>Indicates whether the user has administrator privileges in the network.</p>
16    ///   - [`suspended(Option<bool>)`](crate::operation::get_user::GetUserOutput::suspended): <p>Indicates whether the user is currently suspended.</p>
17    ///   - [`status(Option<i32>)`](crate::operation::get_user::GetUserOutput::status): <p>The current status of the user (1 for pending, 2 for active).</p>
18    ///   - [`last_activity(Option<i32>)`](crate::operation::get_user::GetUserOutput::last_activity): <p>The timestamp of the user's last activity in the network, specified in epoch seconds.</p>
19    ///   - [`last_login(Option<i32>)`](crate::operation::get_user::GetUserOutput::last_login): <p>The timestamp of the user's last login to the network, specified in epoch seconds.</p>
20    ///   - [`security_group_ids(Option<Vec::<String>>)`](crate::operation::get_user::GetUserOutput::security_group_ids): <p>A list of security group IDs to which the user belongs.</p>
21    /// - On failure, responds with [`SdkError<GetUserError>`](crate::operation::get_user::GetUserError)
22    pub fn get_user(&self) -> crate::operation::get_user::builders::GetUserFluentBuilder {
23        crate::operation::get_user::builders::GetUserFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_wickr/client/get_user.rs

aws_sdk_wickr/client/
get_user.rs
