aws_sdk_sagemaker/operation/create_user_profile/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_user_profile::_create_user_profile_output::CreateUserProfileOutputBuilder;
3
4pub use crate::operation::create_user_profile::_create_user_profile_input::CreateUserProfileInputBuilder;
5
6impl crate::operation::create_user_profile::builders::CreateUserProfileInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_user_profile::CreateUserProfileOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_user_profile::CreateUserProfileError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_user_profile();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateUserProfile`.
24///
25/// <p>Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateUserProfileFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_user_profile::builders::CreateUserProfileInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_user_profile::CreateUserProfileOutput,
35        crate::operation::create_user_profile::CreateUserProfileError,
36    > for CreateUserProfileFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_user_profile::CreateUserProfileOutput,
44            crate::operation::create_user_profile::CreateUserProfileError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateUserProfileFluentBuilder {
51    /// Creates a new `CreateUserProfileFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateUserProfile as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_user_profile::builders::CreateUserProfileInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_user_profile::CreateUserProfileOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_user_profile::CreateUserProfileError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_user_profile::CreateUserProfile::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_user_profile::CreateUserProfile::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_user_profile::CreateUserProfileOutput,
97        crate::operation::create_user_profile::CreateUserProfileError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The ID of the associated Domain.</p>
112    pub fn domain_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.domain_id(input.into());
114        self
115    }
116    /// <p>The ID of the associated Domain.</p>
117    pub fn set_domain_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_domain_id(input);
119        self
120    }
121    /// <p>The ID of the associated Domain.</p>
122    pub fn get_domain_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_domain_id()
124    }
125    /// <p>A name for the UserProfile. This value is not case sensitive.</p>
126    pub fn user_profile_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.user_profile_name(input.into());
128        self
129    }
130    /// <p>A name for the UserProfile. This value is not case sensitive.</p>
131    pub fn set_user_profile_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_user_profile_name(input);
133        self
134    }
135    /// <p>A name for the UserProfile. This value is not case sensitive.</p>
136    pub fn get_user_profile_name(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_user_profile_name()
138    }
139    /// <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>
140    pub fn single_sign_on_user_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.single_sign_on_user_identifier(input.into());
142        self
143    }
144    /// <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>
145    pub fn set_single_sign_on_user_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_single_sign_on_user_identifier(input);
147        self
148    }
149    /// <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>
150    pub fn get_single_sign_on_user_identifier(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_single_sign_on_user_identifier()
152    }
153    /// <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>
154    pub fn single_sign_on_user_value(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.single_sign_on_user_value(input.into());
156        self
157    }
158    /// <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>
159    pub fn set_single_sign_on_user_value(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_single_sign_on_user_value(input);
161        self
162    }
163    /// <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>
164    pub fn get_single_sign_on_user_value(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_single_sign_on_user_value()
166    }
167    ///
168    /// Appends an item to `Tags`.
169    ///
170    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
171    ///
172    /// <p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p>
173    /// <p>Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.</p>
174    pub fn tags(mut self, input: crate::types::Tag) -> Self {
175        self.inner = self.inner.tags(input);
176        self
177    }
178    /// <p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p>
179    /// <p>Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.</p>
180    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
181        self.inner = self.inner.set_tags(input);
182        self
183    }
184    /// <p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p>
185    /// <p>Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.</p>
186    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
187        self.inner.get_tags()
188    }
189    /// <p>A collection of settings.</p>
190    pub fn user_settings(mut self, input: crate::types::UserSettings) -> Self {
191        self.inner = self.inner.user_settings(input);
192        self
193    }
194    /// <p>A collection of settings.</p>
195    pub fn set_user_settings(mut self, input: ::std::option::Option<crate::types::UserSettings>) -> Self {
196        self.inner = self.inner.set_user_settings(input);
197        self
198    }
199    /// <p>A collection of settings.</p>
200    pub fn get_user_settings(&self) -> &::std::option::Option<crate::types::UserSettings> {
201        self.inner.get_user_settings()
202    }
203}