aws_sdk_wickr/client/
update_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 [`UpdateUser`](crate::operation::update_user::builders::UpdateUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network containing the user to update.</p><br>
7    ///   - [`user_id(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_user_id):<br>required: **true**<br><p>The unique identifier of the user to update.</p><br>
8    ///   - [`user_details(UpdateUserDetails)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::user_details) / [`set_user_details(Option<UpdateUserDetails>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_user_details):<br>required: **false**<br><p>An object containing the user details to be updated, such as name, password, security groups, and invite code settings.</p><br>
9    /// - On success, responds with [`UpdateUserOutput`](crate::operation::update_user::UpdateUserOutput) with field(s):
10    ///   - [`user_id(String)`](crate::operation::update_user::UpdateUserOutput::user_id): <p>The unique identifier of the updated user.</p>
11    ///   - [`network_id(String)`](crate::operation::update_user::UpdateUserOutput::network_id): <p>The ID of the network where the user was updated.</p>
12    ///   - [`security_group_ids(Option<Vec::<String>>)`](crate::operation::update_user::UpdateUserOutput::security_group_ids): <p>The list of security group IDs to which the user now belongs after the update.</p>
13    ///   - [`first_name(Option<String>)`](crate::operation::update_user::UpdateUserOutput::first_name): <p>The updated first name of the user.</p>
14    ///   - [`last_name(Option<String>)`](crate::operation::update_user::UpdateUserOutput::last_name): <p>The updated last name of the user.</p>
15    ///   - [`middle_name(Option<String>)`](crate::operation::update_user::UpdateUserOutput::middle_name): <p>The middle name of the user (currently not used).</p>
16    ///   - [`suspended(bool)`](crate::operation::update_user::UpdateUserOutput::suspended): <p>Indicates whether the user is suspended after the update.</p>
17    ///   - [`modified(Option<i32>)`](crate::operation::update_user::UpdateUserOutput::modified): <p>The timestamp when the user was last modified, specified in epoch seconds.</p>
18    ///   - [`status(Option<i32>)`](crate::operation::update_user::UpdateUserOutput::status): <p>The user's status after the update.</p>
19    ///   - [`invite_code(Option<String>)`](crate::operation::update_user::UpdateUserOutput::invite_code): <p>The updated invite code for the user, if applicable.</p>
20    ///   - [`invite_expiration(Option<i32>)`](crate::operation::update_user::UpdateUserOutput::invite_expiration): <p>The expiration time of the user's invite code, specified in epoch seconds.</p>
21    ///   - [`code_validation(Option<bool>)`](crate::operation::update_user::UpdateUserOutput::code_validation): <p>Indicates whether the user can be verified through a custom invite code.</p>
22    /// - On failure, responds with [`SdkError<UpdateUserError>`](crate::operation::update_user::UpdateUserError)
23    pub fn update_user(&self) -> crate::operation::update_user::builders::UpdateUserFluentBuilder {
24        crate::operation::update_user::builders::UpdateUserFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_wickr/client/update_user.rs

aws_sdk_wickr/client/
update_user.rs
