aws_sdk_sagemaker/client/create_user_profile.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 [`CreateUserProfile`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain_id(impl Into<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::set_domain_id):<br>required: **true**<br><p>The ID of the associated Domain.</p><br>
7 /// - [`user_profile_name(impl Into<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::user_profile_name) / [`set_user_profile_name(Option<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::set_user_profile_name):<br>required: **true**<br><p>A name for the UserProfile. This value is not case sensitive.</p><br>
8 /// - [`single_sign_on_user_identifier(impl Into<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::single_sign_on_user_identifier) / [`set_single_sign_on_user_identifier(Option<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::set_single_sign_on_user_identifier):<br>required: **false**<br><p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.</p><br>
9 /// - [`single_sign_on_user_value(impl Into<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::single_sign_on_user_value) / [`set_single_sign_on_user_value(Option<String>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::set_single_sign_on_user_value):<br>required: **false**<br><p>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.</p><br>
10 /// - [`tags(Tag)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::set_tags):<br>required: **false**<br><p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p> <p>Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.</p><br>
11 /// - [`user_settings(UserSettings)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::user_settings) / [`set_user_settings(Option<UserSettings>)`](crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::set_user_settings):<br>required: **false**<br><p>A collection of settings.</p><br>
12 /// - On success, responds with [`CreateUserProfileOutput`](crate::operation::create_user_profile::CreateUserProfileOutput) with field(s):
13 /// - [`user_profile_arn(Option<String>)`](crate::operation::create_user_profile::CreateUserProfileOutput::user_profile_arn): <p>The user profile Amazon Resource Name (ARN).</p>
14 /// - On failure, responds with [`SdkError<CreateUserProfileError>`](crate::operation::create_user_profile::CreateUserProfileError)
15 pub fn create_user_profile(&self) -> crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder {
16 crate::operation::create_user_profile::builders::CreateUserProfileFluentBuilder::new(self.handle.clone())
17 }
18}