aws-sdk-connect 1.172.0

AWS SDK for Amazon Connect Service
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_user::_create_user_input::CreateUserInputBuilder;

pub use crate::operation::create_user::_create_user_output::CreateUserOutputBuilder;

impl crate::operation::create_user::builders::CreateUserInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::create_user::CreateUserOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_user::CreateUserError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.create_user();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `CreateUser`.
///
/// <p>Creates a user account for the specified Amazon Connect instance.</p><important>
/// <p>Certain <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html">UserIdentityInfo</a> parameters are required in some situations. For example, <code>Email</code>, <code>FirstName</code> and <code>LastName</code> are required if you are using Amazon Connect or SAML for identity management.</p>
/// </important> <note>
/// <p>Fields in <code>PhoneConfig</code> cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically:</p>
/// <ul>
/// <li>
/// <p><code>PhoneConfig.AutoAccept</code> conflicts with <code>AutoAcceptConfigs</code></p></li>
/// <li>
/// <p><code>PhoneConfig.AfterContactWorkTimeLimit</code> conflicts with <code>AfterContactWorkConfigs</code></p></li>
/// <li>
/// <p><code>PhoneConfig.PhoneType</code> and <code>PhoneConfig.PhoneNumber</code> conflict with <code>PhoneNumberConfigs</code></p></li>
/// <li>
/// <p><code>PhoneConfig.PersistentConnection</code> conflicts with <code>PersistentConnectionConfigs</code></p></li>
/// </ul>
/// <p>We recommend using channel-specific parameters such as <code>AutoAcceptConfigs</code>, <code>AfterContactWorkConfigs</code>, <code>PhoneNumberConfigs</code>, <code>PersistentConnectionConfigs</code>, and <code>VoiceEnhancementConfigs</code> for per-channel configuration.</p>
/// </note>
/// <p>For information about how to create users using the Amazon Connect admin website, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html">Add Users</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateUserFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::create_user::builders::CreateUserInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::create_user::CreateUserOutput,
        crate::operation::create_user::CreateUserError,
    > for CreateUserFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::create_user::CreateUserOutput,
            crate::operation::create_user::CreateUserError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl CreateUserFluentBuilder {
    /// Creates a new `CreateUserFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the CreateUser as a reference.
    pub fn as_input(&self) -> &crate::operation::create_user::builders::CreateUserInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::create_user::CreateUserOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_user::CreateUserError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::create_user::CreateUser::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::create_user::CreateUser::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::create_user::CreateUserOutput,
        crate::operation::create_user::CreateUserError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from \[a-zA-Z0-9_-.\@\]+.</p>
    /// <p>Username can include @ only if used in an email format. For example:</p>
    /// <ul>
    /// <li>
    /// <p>Correct: testuser</p></li>
    /// <li>
    /// <p>Correct: testuser@example.com</p></li>
    /// <li>
    /// <p>Incorrect: testuser@example</p></li>
    /// </ul>
    pub fn username(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.username(input.into());
        self
    }
    /// <p>The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from \[a-zA-Z0-9_-.\@\]+.</p>
    /// <p>Username can include @ only if used in an email format. For example:</p>
    /// <ul>
    /// <li>
    /// <p>Correct: testuser</p></li>
    /// <li>
    /// <p>Correct: testuser@example.com</p></li>
    /// <li>
    /// <p>Incorrect: testuser@example</p></li>
    /// </ul>
    pub fn set_username(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_username(input);
        self
    }
    /// <p>The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from \[a-zA-Z0-9_-.\@\]+.</p>
    /// <p>Username can include @ only if used in an email format. For example:</p>
    /// <ul>
    /// <li>
    /// <p>Correct: testuser</p></li>
    /// <li>
    /// <p>Correct: testuser@example.com</p></li>
    /// <li>
    /// <p>Incorrect: testuser@example</p></li>
    /// </ul>
    pub fn get_username(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_username()
    }
    /// <p>The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.</p>
    pub fn password(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.password(input.into());
        self
    }
    /// <p>The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.</p>
    pub fn set_password(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_password(input);
        self
    }
    /// <p>The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.</p>
    pub fn get_password(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_password()
    }
    /// <p>The information about the identity of the user.</p>
    pub fn identity_info(mut self, input: crate::types::UserIdentityInfo) -> Self {
        self.inner = self.inner.identity_info(input);
        self
    }
    /// <p>The information about the identity of the user.</p>
    pub fn set_identity_info(mut self, input: ::std::option::Option<crate::types::UserIdentityInfo>) -> Self {
        self.inner = self.inner.set_identity_info(input);
        self
    }
    /// <p>The information about the identity of the user.</p>
    pub fn get_identity_info(&self) -> &::std::option::Option<crate::types::UserIdentityInfo> {
        self.inner.get_identity_info()
    }
    /// <p>The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as <code>AutoAcceptConfigs</code>, <code>AfterContactWorkConfigs</code>, <code>PhoneNumberConfigs</code>, <code>PersistentConnectionConfigs</code>, and <code>VoiceEnhancementConfigs</code>.</p>
    pub fn phone_config(mut self, input: crate::types::UserPhoneConfig) -> Self {
        self.inner = self.inner.phone_config(input);
        self
    }
    /// <p>The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as <code>AutoAcceptConfigs</code>, <code>AfterContactWorkConfigs</code>, <code>PhoneNumberConfigs</code>, <code>PersistentConnectionConfigs</code>, and <code>VoiceEnhancementConfigs</code>.</p>
    pub fn set_phone_config(mut self, input: ::std::option::Option<crate::types::UserPhoneConfig>) -> Self {
        self.inner = self.inner.set_phone_config(input);
        self
    }
    /// <p>The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as <code>AutoAcceptConfigs</code>, <code>AfterContactWorkConfigs</code>, <code>PhoneNumberConfigs</code>, <code>PersistentConnectionConfigs</code>, and <code>VoiceEnhancementConfigs</code>.</p>
    pub fn get_phone_config(&self) -> &::std::option::Option<crate::types::UserPhoneConfig> {
        self.inner.get_phone_config()
    }
    /// <p>The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.</p>
    /// <p>This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.</p>
    pub fn directory_user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.directory_user_id(input.into());
        self
    }
    /// <p>The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.</p>
    /// <p>This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.</p>
    pub fn set_directory_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_directory_user_id(input);
        self
    }
    /// <p>The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.</p>
    /// <p>This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.</p>
    pub fn get_directory_user_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_directory_user_id()
    }
    ///
    /// Appends an item to `SecurityProfileIds`.
    ///
    /// To override the contents of this collection use [`set_security_profile_ids`](Self::set_security_profile_ids).
    ///
    /// <p>The identifier of the security profile for the user.</p>
    pub fn security_profile_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.security_profile_ids(input.into());
        self
    }
    /// <p>The identifier of the security profile for the user.</p>
    pub fn set_security_profile_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_security_profile_ids(input);
        self
    }
    /// <p>The identifier of the security profile for the user.</p>
    pub fn get_security_profile_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_security_profile_ids()
    }
    /// <p>The identifier of the routing profile for the user.</p>
    pub fn routing_profile_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.routing_profile_id(input.into());
        self
    }
    /// <p>The identifier of the routing profile for the user.</p>
    pub fn set_routing_profile_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_routing_profile_id(input);
        self
    }
    /// <p>The identifier of the routing profile for the user.</p>
    pub fn get_routing_profile_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_routing_profile_id()
    }
    /// <p>The identifier of the hierarchy group for the user.</p>
    pub fn hierarchy_group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.hierarchy_group_id(input.into());
        self
    }
    /// <p>The identifier of the hierarchy group for the user.</p>
    pub fn set_hierarchy_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_hierarchy_group_id(input);
        self
    }
    /// <p>The identifier of the hierarchy group for the user.</p>
    pub fn get_hierarchy_group_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_hierarchy_group_id()
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.instance_id(input.into());
        self
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_instance_id(input);
        self
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_instance_id()
    }
    ///
    /// Appends an item to `AutoAcceptConfigs`.
    ///
    /// To override the contents of this collection use [`set_auto_accept_configs`](Self::set_auto_accept_configs).
    ///
    /// <p>The list of auto-accept configuration settings for each channel.</p>
    pub fn auto_accept_configs(mut self, input: crate::types::AutoAcceptConfig) -> Self {
        self.inner = self.inner.auto_accept_configs(input);
        self
    }
    /// <p>The list of auto-accept configuration settings for each channel.</p>
    pub fn set_auto_accept_configs(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AutoAcceptConfig>>) -> Self {
        self.inner = self.inner.set_auto_accept_configs(input);
        self
    }
    /// <p>The list of auto-accept configuration settings for each channel.</p>
    pub fn get_auto_accept_configs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AutoAcceptConfig>> {
        self.inner.get_auto_accept_configs()
    }
    ///
    /// Appends an item to `AfterContactWorkConfigs`.
    ///
    /// To override the contents of this collection use [`set_after_contact_work_configs`](Self::set_after_contact_work_configs).
    ///
    /// <p>The list of after contact work (ACW) timeout configuration settings for each channel.</p>
    pub fn after_contact_work_configs(mut self, input: crate::types::AfterContactWorkConfigPerChannel) -> Self {
        self.inner = self.inner.after_contact_work_configs(input);
        self
    }
    /// <p>The list of after contact work (ACW) timeout configuration settings for each channel.</p>
    pub fn set_after_contact_work_configs(
        mut self,
        input: ::std::option::Option<::std::vec::Vec<crate::types::AfterContactWorkConfigPerChannel>>,
    ) -> Self {
        self.inner = self.inner.set_after_contact_work_configs(input);
        self
    }
    /// <p>The list of after contact work (ACW) timeout configuration settings for each channel.</p>
    pub fn get_after_contact_work_configs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AfterContactWorkConfigPerChannel>> {
        self.inner.get_after_contact_work_configs()
    }
    ///
    /// Appends an item to `PhoneNumberConfigs`.
    ///
    /// To override the contents of this collection use [`set_phone_number_configs`](Self::set_phone_number_configs).
    ///
    /// <p>The list of phone number configuration settings for each channel.</p>
    pub fn phone_number_configs(mut self, input: crate::types::PhoneNumberConfig) -> Self {
        self.inner = self.inner.phone_number_configs(input);
        self
    }
    /// <p>The list of phone number configuration settings for each channel.</p>
    pub fn set_phone_number_configs(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::PhoneNumberConfig>>) -> Self {
        self.inner = self.inner.set_phone_number_configs(input);
        self
    }
    /// <p>The list of phone number configuration settings for each channel.</p>
    pub fn get_phone_number_configs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PhoneNumberConfig>> {
        self.inner.get_phone_number_configs()
    }
    ///
    /// Appends an item to `PersistentConnectionConfigs`.
    ///
    /// To override the contents of this collection use [`set_persistent_connection_configs`](Self::set_persistent_connection_configs).
    ///
    /// <p>The list of persistent connection configuration settings for each channel.</p>
    pub fn persistent_connection_configs(mut self, input: crate::types::PersistentConnectionConfig) -> Self {
        self.inner = self.inner.persistent_connection_configs(input);
        self
    }
    /// <p>The list of persistent connection configuration settings for each channel.</p>
    pub fn set_persistent_connection_configs(
        mut self,
        input: ::std::option::Option<::std::vec::Vec<crate::types::PersistentConnectionConfig>>,
    ) -> Self {
        self.inner = self.inner.set_persistent_connection_configs(input);
        self
    }
    /// <p>The list of persistent connection configuration settings for each channel.</p>
    pub fn get_persistent_connection_configs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PersistentConnectionConfig>> {
        self.inner.get_persistent_connection_configs()
    }
    ///
    /// Appends an item to `VoiceEnhancementConfigs`.
    ///
    /// To override the contents of this collection use [`set_voice_enhancement_configs`](Self::set_voice_enhancement_configs).
    ///
    /// <p>The list of voice enhancement configuration settings for each channel.</p>
    pub fn voice_enhancement_configs(mut self, input: crate::types::VoiceEnhancementConfig) -> Self {
        self.inner = self.inner.voice_enhancement_configs(input);
        self
    }
    /// <p>The list of voice enhancement configuration settings for each channel.</p>
    pub fn set_voice_enhancement_configs(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::VoiceEnhancementConfig>>) -> Self {
        self.inner = self.inner.set_voice_enhancement_configs(input);
        self
    }
    /// <p>The list of voice enhancement configuration settings for each channel.</p>
    pub fn get_voice_enhancement_configs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::VoiceEnhancementConfig>> {
        self.inner.get_voice_enhancement_configs()
    }
    ///
    /// Adds a key-value pair to `Tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.tags(k.into(), v.into());
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.inner = self.inner.set_tags(input);
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.inner.get_tags()
    }
}