1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AdminGetUser`](crate::operation::admin_get_user::builders::AdminGetUserFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_get_user::builders::AdminGetUserFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_get_user::builders::AdminGetUserFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The user pool ID for the user pool where you want to get information about the user.</p><br>
    ///   - [`username(impl Into<String>)`](crate::operation::admin_get_user::builders::AdminGetUserFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_get_user::builders::AdminGetUserFluentBuilder::set_username):<br>required: **true**<br><p>The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, you can also use their <code>sub</code> in this request.</p><br>
    /// - On success, responds with [`AdminGetUserOutput`](crate::operation::admin_get_user::AdminGetUserOutput) with field(s):
    ///   - [`username(String)`](crate::operation::admin_get_user::AdminGetUserOutput::username): <p>The username of the user that you requested.</p>
    ///   - [`user_attributes(Option<Vec::<AttributeType>>)`](crate::operation::admin_get_user::AdminGetUserOutput::user_attributes): <p>An array of name-value pairs representing user attributes.</p>
    ///   - [`user_create_date(Option<DateTime>)`](crate::operation::admin_get_user::AdminGetUserOutput::user_create_date): <p>The date the user was created.</p>
    ///   - [`user_last_modified_date(Option<DateTime>)`](crate::operation::admin_get_user::AdminGetUserOutput::user_last_modified_date): <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
    ///   - [`enabled(bool)`](crate::operation::admin_get_user::AdminGetUserOutput::enabled): <p>Indicates that the status is <code>enabled</code>.</p>
    ///   - [`user_status(Option<UserStatusType>)`](crate::operation::admin_get_user::AdminGetUserOutput::user_status): <p>The user status. Can be one of the following:</p> <ul>  <li>   <p>UNCONFIRMED - User has been created but not confirmed.</p></li>  <li>   <p>CONFIRMED - User has been confirmed.</p></li>  <li>   <p>UNKNOWN - User status isn't known.</p></li>  <li>   <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p></li>  <li>   <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.</p></li> </ul>
    ///   - [`mfa_options(Option<Vec::<MfaOptionType>>)`](crate::operation::admin_get_user::AdminGetUserOutput::mfa_options): <p><i>This response parameter is no longer supported.</i> It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.</p>
    ///   - [`preferred_mfa_setting(Option<String>)`](crate::operation::admin_get_user::AdminGetUserOutput::preferred_mfa_setting): <p>The user's preferred MFA setting.</p>
    ///   - [`user_mfa_setting_list(Option<Vec::<String>>)`](crate::operation::admin_get_user::AdminGetUserOutput::user_mfa_setting_list): <p>The MFA options that are activated for the user. The possible values in this list are <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.</p>
    /// - On failure, responds with [`SdkError<AdminGetUserError>`](crate::operation::admin_get_user::AdminGetUserError)
    pub fn admin_get_user(&self) -> crate::operation::admin_get_user::builders::AdminGetUserFluentBuilder {
        crate::operation::admin_get_user::builders::AdminGetUserFluentBuilder::new(self.handle.clone())
    }
}