aws_sdk_workmail/client/
update_user.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateUser`](crate::operation::update_user::builders::UpdateUserFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier for the organization under which the user exists.</p><br>
    ///   - [`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 identifier for the user to be updated.</p> <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p> <ul>  <li>   <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p></li>  <li>   <p>Email address: user@domain.tld</p></li>  <li>   <p>User name: user</p></li> </ul><br>
    ///   - [`role(UserRole)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::role) / [`set_role(Option<UserRole>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_role):<br>required: **false**<br><p>Updates the user role.</p> <p>You cannot pass <i>SYSTEM_USER</i> or <i>RESOURCE</i>.</p><br>
    ///   - [`display_name(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_display_name):<br>required: **false**<br><p>Updates the display name of the user.</p><br>
    ///   - [`first_name(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::first_name) / [`set_first_name(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_first_name):<br>required: **false**<br><p>Updates the user's first name.</p><br>
    ///   - [`last_name(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::last_name) / [`set_last_name(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_last_name):<br>required: **false**<br><p>Updates the user's last name.</p><br>
    ///   - [`hidden_from_global_address_list(bool)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::hidden_from_global_address_list) / [`set_hidden_from_global_address_list(Option<bool>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_hidden_from_global_address_list):<br>required: **false**<br><p>If enabled, the user is hidden from the global address list.</p><br>
    ///   - [`initials(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::initials) / [`set_initials(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_initials):<br>required: **false**<br><p>Updates the user's initials.</p><br>
    ///   - [`telephone(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::telephone) / [`set_telephone(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_telephone):<br>required: **false**<br><p>Updates the user's contact details.</p><br>
    ///   - [`street(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::street) / [`set_street(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_street):<br>required: **false**<br><p>Updates the user's street address.</p><br>
    ///   - [`job_title(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::job_title) / [`set_job_title(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_job_title):<br>required: **false**<br><p>Updates the user's job title.</p><br>
    ///   - [`city(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::city) / [`set_city(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_city):<br>required: **false**<br><p>Updates the user's city.</p><br>
    ///   - [`company(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::company) / [`set_company(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_company):<br>required: **false**<br><p>Updates the user's company.</p><br>
    ///   - [`zip_code(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::zip_code) / [`set_zip_code(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_zip_code):<br>required: **false**<br><p>Updates the user's zip code.</p><br>
    ///   - [`department(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::department) / [`set_department(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_department):<br>required: **false**<br><p>Updates the user's department.</p><br>
    ///   - [`country(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::country) / [`set_country(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_country):<br>required: **false**<br><p>Updates the user's country.</p><br>
    ///   - [`office(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::office) / [`set_office(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_office):<br>required: **false**<br><p>Updates the user's office.</p><br>
    ///   - [`identity_provider_user_id(impl Into<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::identity_provider_user_id) / [`set_identity_provider_user_id(Option<String>)`](crate::operation::update_user::builders::UpdateUserFluentBuilder::set_identity_provider_user_id):<br>required: **false**<br><p>User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.</p><br>
    /// - On success, responds with [`UpdateUserOutput`](crate::operation::update_user::UpdateUserOutput)
    /// - On failure, responds with [`SdkError<UpdateUserError>`](crate::operation::update_user::UpdateUserError)
    pub fn update_user(&self) -> crate::operation::update_user::builders::UpdateUserFluentBuilder {
        crate::operation::update_user::builders::UpdateUserFluentBuilder::new(self.handle.clone())
    }
}