aws_sdk_identitystore/client/
describe_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 [`DescribeUser`](crate::operation::describe_user::builders::DescribeUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identity_store_id(impl Into<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::identity_store_id) / [`set_identity_store_id(Option<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::set_identity_store_id):<br>required: **true**<br><p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p><br>
7    ///   - [`user_id(impl Into<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::set_user_id):<br>required: **true**<br><p>The identifier for a user in the identity store.</p><br>
8    /// - On success, responds with [`DescribeUserOutput`](crate::operation::describe_user::DescribeUserOutput) with field(s):
9    ///   - [`identity_store_id(String)`](crate::operation::describe_user::DescribeUserOutput::identity_store_id): <p>The globally unique identifier for the identity store.</p>
10    ///   - [`user_id(String)`](crate::operation::describe_user::DescribeUserOutput::user_id): <p>The identifier for a user in the identity store.</p>
11    ///   - [`user_name(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::user_name): <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.</p>
12    ///   - [`external_ids(Option<Vec::<ExternalId>>)`](crate::operation::describe_user::DescribeUserOutput::external_ids): <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>
13    ///   - [`name(Option<Name>)`](crate::operation::describe_user::DescribeUserOutput::name): <p>The name of the user.</p>
14    ///   - [`display_name(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::display_name): <p>The display name of the user.</p>
15    ///   - [`nick_name(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::nick_name): <p>An alternative descriptive name for the user.</p>
16    ///   - [`profile_url(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::profile_url): <p>A URL link for the user's profile.</p>
17    ///   - [`emails(Option<Vec::<Email>>)`](crate::operation::describe_user::DescribeUserOutput::emails): <p>The email address of the user.</p>
18    ///   - [`addresses(Option<Vec::<Address>>)`](crate::operation::describe_user::DescribeUserOutput::addresses): <p>The physical address of the user.</p>
19    ///   - [`phone_numbers(Option<Vec::<PhoneNumber>>)`](crate::operation::describe_user::DescribeUserOutput::phone_numbers): <p>A list of <code>PhoneNumber</code> objects associated with a user.</p>
20    ///   - [`user_type(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::user_type): <p>A string indicating the type of user.</p>
21    ///   - [`title(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::title): <p>A string containing the title of the user.</p>
22    ///   - [`preferred_language(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::preferred_language): <p>The preferred language of the user.</p>
23    ///   - [`locale(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::locale): <p>A string containing the geographical region or location of the user.</p>
24    ///   - [`timezone(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::timezone): <p>The time zone for a user.</p>
25    ///   - [`user_status(Option<UserStatus>)`](crate::operation::describe_user::DescribeUserOutput::user_status): <p>The current status of the user account.</p>
26    ///   - [`photos(Option<Vec::<Photo>>)`](crate::operation::describe_user::DescribeUserOutput::photos): <p>A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.</p>
27    ///   - [`website(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::website): <p>The user's personal website or blog URL. Returns the stored website information for the user.</p>
28    ///   - [`birthdate(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::birthdate): <p>The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.</p>
29    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_user::DescribeUserOutput::created_at): <p>The date and time the user was created.</p>
30    ///   - [`created_by(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::created_by): <p>The identifier of the user or system that created the user.</p>
31    ///   - [`updated_at(Option<DateTime>)`](crate::operation::describe_user::DescribeUserOutput::updated_at): <p>The date and time the user was last updated.</p>
32    ///   - [`updated_by(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::updated_by): <p>The identifier of the user or system that last updated the user.</p>
33    /// - On failure, responds with [`SdkError<DescribeUserError>`](crate::operation::describe_user::DescribeUserError)
34    pub fn describe_user(&self) -> crate::operation::describe_user::builders::DescribeUserFluentBuilder {
35        crate::operation::describe_user::builders::DescribeUserFluentBuilder::new(self.handle.clone())
36    }
37}
aws_sdk_identitystore/client/describe_user.rs

aws_sdk_identitystore/client/
describe_user.rs
