aws_sdk_identitystore/client/

create_user.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateUser`](crate::operation::create_user::builders::CreateUserFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`identity_store_id(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::identity_store_id) / [`set_identity_store_id(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_identity_store_id):<br>required: **true**<br><p>The globally unique identifier for the identity store.</p><br>
    ///   - [`user_name(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::user_name) / [`set_user_name(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_user_name):<br>required: **false**<br><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. <code>Administrator</code> and <code>AWSAdministrators</code> are reserved names and can't be used for users or groups.</p><br>
    ///   - [`name(Name)`](crate::operation::create_user::builders::CreateUserFluentBuilder::name) / [`set_name(Option<Name>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_name):<br>required: **false**<br><p>An object containing the name of the user. When used in IAM Identity Center, this parameter is required.</p><br>
    ///   - [`display_name(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_display_name):<br>required: **false**<br><p>A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe." When used in IAM Identity Center, this parameter is required.</p><br>
    ///   - [`nick_name(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::nick_name) / [`set_nick_name(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_nick_name):<br>required: **false**<br><p>A string containing an alternate name for the user.</p><br>
    ///   - [`profile_url(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::profile_url) / [`set_profile_url(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_profile_url):<br>required: **false**<br><p>A string containing a URL that might be associated with the user.</p><br>
    ///   - [`emails(Email)`](crate::operation::create_user::builders::CreateUserFluentBuilder::emails) / [`set_emails(Option<Vec::<Email>>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_emails):<br>required: **false**<br><p>A list of <code>Email</code> objects containing email addresses associated with the user.</p><br>
    ///   - [`addresses(Address)`](crate::operation::create_user::builders::CreateUserFluentBuilder::addresses) / [`set_addresses(Option<Vec::<Address>>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_addresses):<br>required: **false**<br><p>A list of <code>Address</code> objects containing addresses associated with the user.</p><br>
    ///   - [`phone_numbers(PhoneNumber)`](crate::operation::create_user::builders::CreateUserFluentBuilder::phone_numbers) / [`set_phone_numbers(Option<Vec::<PhoneNumber>>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_phone_numbers):<br>required: **false**<br><p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p><br>
    ///   - [`user_type(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::user_type) / [`set_user_type(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_user_type):<br>required: **false**<br><p>A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.</p><br>
    ///   - [`title(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_title):<br>required: **false**<br><p>A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.</p><br>
    ///   - [`preferred_language(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::preferred_language) / [`set_preferred_language(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_preferred_language):<br>required: **false**<br><p>A string containing the preferred language of the user. For example, "American English" or "en-us."</p><br>
    ///   - [`locale(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::locale) / [`set_locale(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_locale):<br>required: **false**<br><p>A string containing the geographical region or location of the user.</p><br>
    ///   - [`timezone(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::timezone) / [`set_timezone(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_timezone):<br>required: **false**<br><p>A string containing the time zone of the user.</p><br>
    ///   - [`photos(Photo)`](crate::operation::create_user::builders::CreateUserFluentBuilder::photos) / [`set_photos(Option<Vec::<Photo>>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_photos):<br>required: **false**<br><p>A list of photos associated with the user. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.</p><br>
    ///   - [`website(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::website) / [`set_website(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_website):<br>required: **false**<br><p>The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.</p><br>
    ///   - [`birthdate(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::birthdate) / [`set_birthdate(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_birthdate):<br>required: **false**<br><p>The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.</p><br>
    ///   - [`extensions(impl Into<String>, Document)`](crate::operation::create_user::builders::CreateUserFluentBuilder::extensions) / [`set_extensions(Option<HashMap::<String, Document>>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_extensions):<br>required: **false**<br><p>A map with additional attribute extensions for the user. Each map key corresponds to an extension name, while map values represent extension data in <code>Document</code> type (not supported by Java V1, Go V1 and older versions of the CLI). <code>aws:identitystore:enterprise</code> is the only supported extension name.</p><br>
    /// - On success, responds with [`CreateUserOutput`](crate::operation::create_user::CreateUserOutput) with field(s):
    ///   - [`identity_store_id(String)`](crate::operation::create_user::CreateUserOutput::identity_store_id): <p>The globally unique identifier for the identity store.</p>
    ///   - [`user_id(String)`](crate::operation::create_user::CreateUserOutput::user_id): <p>The identifier of the newly created user in the identity store.</p>
    /// - On failure, responds with [`SdkError<CreateUserError>`](crate::operation::create_user::CreateUserError)
    pub fn create_user(&self) -> crate::operation::create_user::builders::CreateUserFluentBuilder {
        crate::operation::create_user::builders::CreateUserFluentBuilder::new(self.handle.clone())
    }
}