aws-sdk-connect 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,6 +8,773 @@
8
8
  module Aws::Connect
9
9
  module Types
10
10
 
11
+ # @note When making an API call, you may pass CreateUserRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # username: "AgentUsername", # required
16
+ # password: "Password",
17
+ # identity_info: {
18
+ # first_name: "AgentFirstName",
19
+ # last_name: "AgentLastName",
20
+ # email: "Email",
21
+ # },
22
+ # phone_config: { # required
23
+ # phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
24
+ # auto_accept: false,
25
+ # after_contact_work_time_limit: 1,
26
+ # desk_phone_number: "PhoneNumber",
27
+ # },
28
+ # directory_user_id: "DirectoryUserId",
29
+ # security_profile_ids: ["SecurityProfileId"], # required
30
+ # routing_profile_id: "RoutingProfileId", # required
31
+ # hierarchy_group_id: "HierarchyGroupId",
32
+ # instance_id: "InstanceId", # required
33
+ # }
34
+ #
35
+ # @!attribute [rw] username
36
+ # The user name in Amazon Connect for the user to create.
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] password
40
+ # The password for the user account to create. This is required if you
41
+ # are using Amazon Connect for identity management. If you are using
42
+ # SAML for identity management and include this parameter, an
43
+ # `InvalidRequestException` is returned.
44
+ # @return [String]
45
+ #
46
+ # @!attribute [rw] identity_info
47
+ # Information about the user, including email address, first name, and
48
+ # last name.
49
+ # @return [Types::UserIdentityInfo]
50
+ #
51
+ # @!attribute [rw] phone_config
52
+ # Specifies the phone settings for the user, including
53
+ # AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and
54
+ # PhoneType.
55
+ # @return [Types::UserPhoneConfig]
56
+ #
57
+ # @!attribute [rw] directory_user_id
58
+ # The unique identifier for the user account in the directory service
59
+ # directory used for identity management. If Amazon Connect is unable
60
+ # to access the existing directory, you can use the `DirectoryUserId`
61
+ # to authenticate users. If you include the parameter, it is assumed
62
+ # that Amazon Connect cannot access the directory. If the parameter is
63
+ # not included, the UserIdentityInfo is used to authenticate users
64
+ # from your existing directory.
65
+ #
66
+ # This parameter is required if you are using an existing directory
67
+ # for identity management in Amazon Connect when Amazon Connect cannot
68
+ # access your directory to authenticate users. If you are using SAML
69
+ # for identity management and include this parameter, an
70
+ # `InvalidRequestException` is returned.
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] security_profile_ids
74
+ # The unique identifier of the security profile to assign to the user
75
+ # created.
76
+ # @return [Array<String>]
77
+ #
78
+ # @!attribute [rw] routing_profile_id
79
+ # The unique identifier for the routing profile to assign to the user
80
+ # created.
81
+ # @return [String]
82
+ #
83
+ # @!attribute [rw] hierarchy_group_id
84
+ # The unique identifier for the hierarchy group to assign to the user
85
+ # created.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] instance_id
89
+ # The identifier for your Amazon Connect instance. To find the ID of
90
+ # your instance, open the AWS console and select Amazon Connect.
91
+ # Select the alias of the instance in the Instance alias column. The
92
+ # instance ID is displayed in the Overview section of your instance
93
+ # settings. For example, the instance ID is the set of characters at
94
+ # the end of the instance ARN, after instance/, such as
95
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
96
+ # @return [String]
97
+ #
98
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserRequest AWS API Documentation
99
+ #
100
+ class CreateUserRequest < Struct.new(
101
+ :username,
102
+ :password,
103
+ :identity_info,
104
+ :phone_config,
105
+ :directory_user_id,
106
+ :security_profile_ids,
107
+ :routing_profile_id,
108
+ :hierarchy_group_id,
109
+ :instance_id)
110
+ include Aws::Structure
111
+ end
112
+
113
+ # @!attribute [rw] user_id
114
+ # The unique identifier for the user account in Amazon Connect
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] user_arn
118
+ # The Amazon Resource Name (ARN) of the user account created.
119
+ # @return [String]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserResponse AWS API Documentation
122
+ #
123
+ class CreateUserResponse < Struct.new(
124
+ :user_id,
125
+ :user_arn)
126
+ include Aws::Structure
127
+ end
128
+
129
+ # The credentials to use for federation.
130
+ #
131
+ # @!attribute [rw] access_token
132
+ # An access token generated for a federated user to access Amazon
133
+ # Connect
134
+ # @return [String]
135
+ #
136
+ # @!attribute [rw] access_token_expiration
137
+ # A token generated with an expiration time for the session a user is
138
+ # logged in to Amazon Connect
139
+ # @return [Time]
140
+ #
141
+ # @!attribute [rw] refresh_token
142
+ # Renews a token generated for a user to access the Amazon Connect
143
+ # instance.
144
+ # @return [String]
145
+ #
146
+ # @!attribute [rw] refresh_token_expiration
147
+ # Renews the expiration timer for a generated token.
148
+ # @return [Time]
149
+ #
150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Credentials AWS API Documentation
151
+ #
152
+ class Credentials < Struct.new(
153
+ :access_token,
154
+ :access_token_expiration,
155
+ :refresh_token,
156
+ :refresh_token_expiration)
157
+ include Aws::Structure
158
+ end
159
+
160
+ # @note When making an API call, you may pass DeleteUserRequest
161
+ # data as a hash:
162
+ #
163
+ # {
164
+ # instance_id: "InstanceId", # required
165
+ # user_id: "UserId", # required
166
+ # }
167
+ #
168
+ # @!attribute [rw] instance_id
169
+ # The identifier for your Amazon Connect instance. To find the ID of
170
+ # your instance, open the AWS console and select Amazon Connect.
171
+ # Select the alias of the instance in the Instance alias column. The
172
+ # instance ID is displayed in the Overview section of your instance
173
+ # settings. For example, the instance ID is the set of characters at
174
+ # the end of the instance ARN, after instance/, such as
175
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
176
+ # @return [String]
177
+ #
178
+ # @!attribute [rw] user_id
179
+ # The unique identifier of the user to delete.
180
+ # @return [String]
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserRequest AWS API Documentation
183
+ #
184
+ class DeleteUserRequest < Struct.new(
185
+ :instance_id,
186
+ :user_id)
187
+ include Aws::Structure
188
+ end
189
+
190
+ # @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
191
+ # data as a hash:
192
+ #
193
+ # {
194
+ # hierarchy_group_id: "HierarchyGroupId", # required
195
+ # instance_id: "InstanceId", # required
196
+ # }
197
+ #
198
+ # @!attribute [rw] hierarchy_group_id
199
+ # The identifier for the hierarchy group to return.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] instance_id
203
+ # The identifier for your Amazon Connect instance. To find the ID of
204
+ # your instance, open the AWS console and select Amazon Connect.
205
+ # Select the alias of the instance in the Instance alias column. The
206
+ # instance ID is displayed in the Overview section of your instance
207
+ # settings. For example, the instance ID is the set of characters at
208
+ # the end of the instance ARN, after instance/, such as
209
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
210
+ # @return [String]
211
+ #
212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroupRequest AWS API Documentation
213
+ #
214
+ class DescribeUserHierarchyGroupRequest < Struct.new(
215
+ :hierarchy_group_id,
216
+ :instance_id)
217
+ include Aws::Structure
218
+ end
219
+
220
+ # @!attribute [rw] hierarchy_group
221
+ # Returns a `HierarchyGroup` object.
222
+ # @return [Types::HierarchyGroup]
223
+ #
224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroupResponse AWS API Documentation
225
+ #
226
+ class DescribeUserHierarchyGroupResponse < Struct.new(
227
+ :hierarchy_group)
228
+ include Aws::Structure
229
+ end
230
+
231
+ # @note When making an API call, you may pass DescribeUserHierarchyStructureRequest
232
+ # data as a hash:
233
+ #
234
+ # {
235
+ # instance_id: "InstanceId", # required
236
+ # }
237
+ #
238
+ # @!attribute [rw] instance_id
239
+ # The identifier for your Amazon Connect instance. To find the ID of
240
+ # your instance, open the AWS console and select Amazon Connect.
241
+ # Select the alias of the instance in the Instance alias column. The
242
+ # instance ID is displayed in the Overview section of your instance
243
+ # settings. For example, the instance ID is the set of characters at
244
+ # the end of the instance ARN, after instance/, such as
245
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
246
+ # @return [String]
247
+ #
248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructureRequest AWS API Documentation
249
+ #
250
+ class DescribeUserHierarchyStructureRequest < Struct.new(
251
+ :instance_id)
252
+ include Aws::Structure
253
+ end
254
+
255
+ # @!attribute [rw] hierarchy_structure
256
+ # A `HierarchyStructure` object.
257
+ # @return [Types::HierarchyStructure]
258
+ #
259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructureResponse AWS API Documentation
260
+ #
261
+ class DescribeUserHierarchyStructureResponse < Struct.new(
262
+ :hierarchy_structure)
263
+ include Aws::Structure
264
+ end
265
+
266
+ # @note When making an API call, you may pass DescribeUserRequest
267
+ # data as a hash:
268
+ #
269
+ # {
270
+ # user_id: "UserId", # required
271
+ # instance_id: "InstanceId", # required
272
+ # }
273
+ #
274
+ # @!attribute [rw] user_id
275
+ # Unique identifier for the user account to return.
276
+ # @return [String]
277
+ #
278
+ # @!attribute [rw] instance_id
279
+ # The identifier for your Amazon Connect instance. To find the ID of
280
+ # your instance, open the AWS console and select Amazon Connect.
281
+ # Select the alias of the instance in the Instance alias column. The
282
+ # instance ID is displayed in the Overview section of your instance
283
+ # settings. For example, the instance ID is the set of characters at
284
+ # the end of the instance ARN, after instance/, such as
285
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
286
+ # @return [String]
287
+ #
288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserRequest AWS API Documentation
289
+ #
290
+ class DescribeUserRequest < Struct.new(
291
+ :user_id,
292
+ :instance_id)
293
+ include Aws::Structure
294
+ end
295
+
296
+ # @!attribute [rw] user
297
+ # A `User` object that contains information about the user account and
298
+ # configuration settings.
299
+ # @return [Types::User]
300
+ #
301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserResponse AWS API Documentation
302
+ #
303
+ class DescribeUserResponse < Struct.new(
304
+ :user)
305
+ include Aws::Structure
306
+ end
307
+
308
+ # @note When making an API call, you may pass GetFederationTokenRequest
309
+ # data as a hash:
310
+ #
311
+ # {
312
+ # instance_id: "InstanceId", # required
313
+ # }
314
+ #
315
+ # @!attribute [rw] instance_id
316
+ # The identifier for your Amazon Connect instance. To find the ID of
317
+ # your instance, open the AWS console and select Amazon Connect.
318
+ # Select the alias of the instance in the Instance alias column. The
319
+ # instance ID is displayed in the Overview section of your instance
320
+ # settings. For example, the instance ID is the set of characters at
321
+ # the end of the instance ARN, after instance/, such as
322
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
323
+ # @return [String]
324
+ #
325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationTokenRequest AWS API Documentation
326
+ #
327
+ class GetFederationTokenRequest < Struct.new(
328
+ :instance_id)
329
+ include Aws::Structure
330
+ end
331
+
332
+ # @!attribute [rw] credentials
333
+ # The credentials to use for federation.
334
+ # @return [Types::Credentials]
335
+ #
336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationTokenResponse AWS API Documentation
337
+ #
338
+ class GetFederationTokenResponse < Struct.new(
339
+ :credentials)
340
+ include Aws::Structure
341
+ end
342
+
343
+ # A `HierarchyGroup` object that contains information about a hierarchy
344
+ # group in your Amazon Connect instance.
345
+ #
346
+ # @!attribute [rw] id
347
+ # The identifier for the hierarchy group.
348
+ # @return [String]
349
+ #
350
+ # @!attribute [rw] arn
351
+ # The Amazon Resource Name (ARN) for the hierarchy group.
352
+ # @return [String]
353
+ #
354
+ # @!attribute [rw] name
355
+ # The name of the hierarchy group in your instance.
356
+ # @return [String]
357
+ #
358
+ # @!attribute [rw] level_id
359
+ # The identifier for the level in the hierarchy group.
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] hierarchy_path
363
+ # A `HierarchyPath` object that contains information about the levels
364
+ # in the hierarchy group.
365
+ # @return [Types::HierarchyPath]
366
+ #
367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroup AWS API Documentation
368
+ #
369
+ class HierarchyGroup < Struct.new(
370
+ :id,
371
+ :arn,
372
+ :name,
373
+ :level_id,
374
+ :hierarchy_path)
375
+ include Aws::Structure
376
+ end
377
+
378
+ # A `HierarchyGroupSummary` object that contains information about the
379
+ # hierarchy group, including ARN, Id, and Name.
380
+ #
381
+ # @!attribute [rw] id
382
+ # The identifier of the hierarchy group.
383
+ # @return [String]
384
+ #
385
+ # @!attribute [rw] arn
386
+ # The ARN for the hierarchy group.
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] name
390
+ # The name of the hierarchy group.
391
+ # @return [String]
392
+ #
393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroupSummary AWS API Documentation
394
+ #
395
+ class HierarchyGroupSummary < Struct.new(
396
+ :id,
397
+ :arn,
398
+ :name)
399
+ include Aws::Structure
400
+ end
401
+
402
+ # A `HierarchyLevel` object that contains information about the levels
403
+ # in a hierarchy group, including ARN, Id, and Name.
404
+ #
405
+ # @!attribute [rw] id
406
+ # The identifier for the hierarchy group level.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] arn
410
+ # The ARN for the hierarchy group level.
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] name
414
+ # The name of the hierarchy group level.
415
+ # @return [String]
416
+ #
417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyLevel AWS API Documentation
418
+ #
419
+ class HierarchyLevel < Struct.new(
420
+ :id,
421
+ :arn,
422
+ :name)
423
+ include Aws::Structure
424
+ end
425
+
426
+ # A `HierarchyPath` object that contains information about the levels of
427
+ # the hierarchy group.
428
+ #
429
+ # @!attribute [rw] level_one
430
+ # A `HierarchyGroupSummary` object that contains information about the
431
+ # level of the hierarchy group, including ARN, Id, and Name.
432
+ # @return [Types::HierarchyGroupSummary]
433
+ #
434
+ # @!attribute [rw] level_two
435
+ # A `HierarchyGroupSummary` object that contains information about the
436
+ # level of the hierarchy group, including ARN, Id, and Name.
437
+ # @return [Types::HierarchyGroupSummary]
438
+ #
439
+ # @!attribute [rw] level_three
440
+ # A `HierarchyGroupSummary` object that contains information about the
441
+ # level of the hierarchy group, including ARN, Id, and Name.
442
+ # @return [Types::HierarchyGroupSummary]
443
+ #
444
+ # @!attribute [rw] level_four
445
+ # A `HierarchyGroupSummary` object that contains information about the
446
+ # level of the hierarchy group, including ARN, Id, and Name.
447
+ # @return [Types::HierarchyGroupSummary]
448
+ #
449
+ # @!attribute [rw] level_five
450
+ # A `HierarchyGroupSummary` object that contains information about the
451
+ # level of the hierarchy group, including ARN, Id, and Name.
452
+ # @return [Types::HierarchyGroupSummary]
453
+ #
454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyPath AWS API Documentation
455
+ #
456
+ class HierarchyPath < Struct.new(
457
+ :level_one,
458
+ :level_two,
459
+ :level_three,
460
+ :level_four,
461
+ :level_five)
462
+ include Aws::Structure
463
+ end
464
+
465
+ # A `HierarchyStructure` object that contains information about the
466
+ # hierarchy group structure.
467
+ #
468
+ # @!attribute [rw] level_one
469
+ # A `HierarchyLevel` object that contains information about the
470
+ # hierarchy group level.
471
+ # @return [Types::HierarchyLevel]
472
+ #
473
+ # @!attribute [rw] level_two
474
+ # A `HierarchyLevel` object that contains information about the
475
+ # hierarchy group level.
476
+ # @return [Types::HierarchyLevel]
477
+ #
478
+ # @!attribute [rw] level_three
479
+ # A `HierarchyLevel` object that contains information about the
480
+ # hierarchy group level.
481
+ # @return [Types::HierarchyLevel]
482
+ #
483
+ # @!attribute [rw] level_four
484
+ # A `HierarchyLevel` object that contains information about the
485
+ # hierarchy group level.
486
+ # @return [Types::HierarchyLevel]
487
+ #
488
+ # @!attribute [rw] level_five
489
+ # A `HierarchyLevel` object that contains information about the
490
+ # hierarchy group level.
491
+ # @return [Types::HierarchyLevel]
492
+ #
493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyStructure AWS API Documentation
494
+ #
495
+ class HierarchyStructure < Struct.new(
496
+ :level_one,
497
+ :level_two,
498
+ :level_three,
499
+ :level_four,
500
+ :level_five)
501
+ include Aws::Structure
502
+ end
503
+
504
+ # @note When making an API call, you may pass ListRoutingProfilesRequest
505
+ # data as a hash:
506
+ #
507
+ # {
508
+ # instance_id: "InstanceId", # required
509
+ # next_token: "NextToken",
510
+ # max_results: 1,
511
+ # }
512
+ #
513
+ # @!attribute [rw] instance_id
514
+ # The identifier for your Amazon Connect instance. To find the ID of
515
+ # your instance, open the AWS console and select Amazon Connect.
516
+ # Select the alias of the instance in the Instance alias column. The
517
+ # instance ID is displayed in the Overview section of your instance
518
+ # settings. For example, the instance ID is the set of characters at
519
+ # the end of the instance ARN, after instance/, such as
520
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
521
+ # @return [String]
522
+ #
523
+ # @!attribute [rw] next_token
524
+ # The token for the next set of results. Use the value returned in the
525
+ # previous response in the next request to retrieve the next set of
526
+ # results.
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] max_results
530
+ # The maximum number of routing profiles to return in the response.
531
+ # @return [Integer]
532
+ #
533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfilesRequest AWS API Documentation
534
+ #
535
+ class ListRoutingProfilesRequest < Struct.new(
536
+ :instance_id,
537
+ :next_token,
538
+ :max_results)
539
+ include Aws::Structure
540
+ end
541
+
542
+ # @!attribute [rw] routing_profile_summary_list
543
+ # An array of `RoutingProfileSummary` objects that include the ARN,
544
+ # Id, and Name of the routing profile.
545
+ # @return [Array<Types::RoutingProfileSummary>]
546
+ #
547
+ # @!attribute [rw] next_token
548
+ # A string returned in the response. Use the value returned in the
549
+ # response as the value of the NextToken in a subsequent request to
550
+ # retrieve the next set of results.
551
+ # @return [String]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfilesResponse AWS API Documentation
554
+ #
555
+ class ListRoutingProfilesResponse < Struct.new(
556
+ :routing_profile_summary_list,
557
+ :next_token)
558
+ include Aws::Structure
559
+ end
560
+
561
+ # @note When making an API call, you may pass ListSecurityProfilesRequest
562
+ # data as a hash:
563
+ #
564
+ # {
565
+ # instance_id: "InstanceId", # required
566
+ # next_token: "NextToken",
567
+ # max_results: 1,
568
+ # }
569
+ #
570
+ # @!attribute [rw] instance_id
571
+ # The identifier for your Amazon Connect instance. To find the ID of
572
+ # your instance, open the AWS console and select Amazon Connect.
573
+ # Select the alias of the instance in the Instance alias column. The
574
+ # instance ID is displayed in the Overview section of your instance
575
+ # settings. For example, the instance ID is the set of characters at
576
+ # the end of the instance ARN, after instance/, such as
577
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] next_token
581
+ # The token for the next set of results. Use the value returned in the
582
+ # previous response in the next request to retrieve the next set of
583
+ # results.
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] max_results
587
+ # The maximum number of security profiles to return.
588
+ # @return [Integer]
589
+ #
590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilesRequest AWS API Documentation
591
+ #
592
+ class ListSecurityProfilesRequest < Struct.new(
593
+ :instance_id,
594
+ :next_token,
595
+ :max_results)
596
+ include Aws::Structure
597
+ end
598
+
599
+ # @!attribute [rw] security_profile_summary_list
600
+ # An array of `SecurityProfileSummary` objects.
601
+ # @return [Array<Types::SecurityProfileSummary>]
602
+ #
603
+ # @!attribute [rw] next_token
604
+ # A string returned in the response. Use the value returned in the
605
+ # response as the value of the NextToken in a subsequent request to
606
+ # retrieve the next set of results.
607
+ # @return [String]
608
+ #
609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilesResponse AWS API Documentation
610
+ #
611
+ class ListSecurityProfilesResponse < Struct.new(
612
+ :security_profile_summary_list,
613
+ :next_token)
614
+ include Aws::Structure
615
+ end
616
+
617
+ # @note When making an API call, you may pass ListUserHierarchyGroupsRequest
618
+ # data as a hash:
619
+ #
620
+ # {
621
+ # instance_id: "InstanceId", # required
622
+ # next_token: "NextToken",
623
+ # max_results: 1,
624
+ # }
625
+ #
626
+ # @!attribute [rw] instance_id
627
+ # The identifier for your Amazon Connect instance. To find the ID of
628
+ # your instance, open the AWS console and select Amazon Connect.
629
+ # Select the alias of the instance in the Instance alias column. The
630
+ # instance ID is displayed in the Overview section of your instance
631
+ # settings. For example, the instance ID is the set of characters at
632
+ # the end of the instance ARN, after instance/, such as
633
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
634
+ # @return [String]
635
+ #
636
+ # @!attribute [rw] next_token
637
+ # The token for the next set of results. Use the value returned in the
638
+ # previous response in the next request to retrieve the next set of
639
+ # results.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] max_results
643
+ # The maximum number of hierarchy groups to return.
644
+ # @return [Integer]
645
+ #
646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroupsRequest AWS API Documentation
647
+ #
648
+ class ListUserHierarchyGroupsRequest < Struct.new(
649
+ :instance_id,
650
+ :next_token,
651
+ :max_results)
652
+ include Aws::Structure
653
+ end
654
+
655
+ # @!attribute [rw] user_hierarchy_group_summary_list
656
+ # An array of `HierarchyGroupSummary` objects.
657
+ # @return [Array<Types::HierarchyGroupSummary>]
658
+ #
659
+ # @!attribute [rw] next_token
660
+ # A string returned in the response. Use the value returned in the
661
+ # response as the value of the NextToken in a subsequent request to
662
+ # retrieve the next set of results.
663
+ # @return [String]
664
+ #
665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroupsResponse AWS API Documentation
666
+ #
667
+ class ListUserHierarchyGroupsResponse < Struct.new(
668
+ :user_hierarchy_group_summary_list,
669
+ :next_token)
670
+ include Aws::Structure
671
+ end
672
+
673
+ # @note When making an API call, you may pass ListUsersRequest
674
+ # data as a hash:
675
+ #
676
+ # {
677
+ # instance_id: "InstanceId", # required
678
+ # next_token: "NextToken",
679
+ # max_results: 1,
680
+ # }
681
+ #
682
+ # @!attribute [rw] instance_id
683
+ # The identifier for your Amazon Connect instance. To find the ID of
684
+ # your instance, open the AWS console and select Amazon Connect.
685
+ # Select the alias of the instance in the Instance alias column. The
686
+ # instance ID is displayed in the Overview section of your instance
687
+ # settings. For example, the instance ID is the set of characters at
688
+ # the end of the instance ARN, after instance/, such as
689
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
690
+ # @return [String]
691
+ #
692
+ # @!attribute [rw] next_token
693
+ # The token for the next set of results. Use the value returned in the
694
+ # previous response in the next request to retrieve the next set of
695
+ # results.
696
+ # @return [String]
697
+ #
698
+ # @!attribute [rw] max_results
699
+ # The maximum number of results to return in the response.
700
+ # @return [Integer]
701
+ #
702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsersRequest AWS API Documentation
703
+ #
704
+ class ListUsersRequest < Struct.new(
705
+ :instance_id,
706
+ :next_token,
707
+ :max_results)
708
+ include Aws::Structure
709
+ end
710
+
711
+ # @!attribute [rw] user_summary_list
712
+ # An array of `UserSummary` objects that contain information about the
713
+ # users in your instance.
714
+ # @return [Array<Types::UserSummary>]
715
+ #
716
+ # @!attribute [rw] next_token
717
+ # A string returned in the response. Use the value returned in the
718
+ # response as the value of the NextToken in a subsequent request to
719
+ # retrieve the next set of results.
720
+ # @return [String]
721
+ #
722
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsersResponse AWS API Documentation
723
+ #
724
+ class ListUsersResponse < Struct.new(
725
+ :user_summary_list,
726
+ :next_token)
727
+ include Aws::Structure
728
+ end
729
+
730
+ # A `RoutingProfileSummary` object that contains information about a
731
+ # routing profile, including ARN, Id, and Name.
732
+ #
733
+ # @!attribute [rw] id
734
+ # The identifier of the routing profile.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] arn
738
+ # The ARN of the routing profile.
739
+ # @return [String]
740
+ #
741
+ # @!attribute [rw] name
742
+ # The name of the routing profile.
743
+ # @return [String]
744
+ #
745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileSummary AWS API Documentation
746
+ #
747
+ class RoutingProfileSummary < Struct.new(
748
+ :id,
749
+ :arn,
750
+ :name)
751
+ include Aws::Structure
752
+ end
753
+
754
+ # A `SecurityProfileSummary` object that contains information about a
755
+ # security profile, including ARN, Id, Name.
756
+ #
757
+ # @!attribute [rw] id
758
+ # The identifier of the security profile.
759
+ # @return [String]
760
+ #
761
+ # @!attribute [rw] arn
762
+ # The ARN of the security profile.
763
+ # @return [String]
764
+ #
765
+ # @!attribute [rw] name
766
+ # The name of the security profile.
767
+ # @return [String]
768
+ #
769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfileSummary AWS API Documentation
770
+ #
771
+ class SecurityProfileSummary < Struct.new(
772
+ :id,
773
+ :arn,
774
+ :name)
775
+ include Aws::Structure
776
+ end
777
+
11
778
  # @note When making an API call, you may pass StartOutboundVoiceContactRequest
12
779
  # data as a hash:
13
780
  #
@@ -24,40 +791,28 @@ module Aws::Connect
24
791
  # }
25
792
  #
26
793
  # @!attribute [rw] destination_phone_number
27
- # The phone number, in E.164 format, of the customer to call with the
28
- # outbound contact.
794
+ # The phone number of the customer in E.164 format.
29
795
  # @return [String]
30
796
  #
31
797
  # @!attribute [rw] contact_flow_id
32
- # The identifier for the contact flow to execute for the outbound
33
- # call. This is a GUID value only. Amazon Resource Name (ARN) values
34
- # are not supported.
798
+ # The identifier for the contact flow to connect the outbound call to.
35
799
  #
36
- # To find the `ContactFlowId`, open the contact flow to use in the
37
- # Amazon Connect contact flow designer. The ID for the contact flow is
38
- # displayed in the address bar as part of the URL. For example, an
39
- # address displayed when you open a contact flow is similar to the
40
- # following:
41
- # `https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181
42
- # `. At the end of the URL, you see
43
- # `contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181`. The
44
- # `ContactFlowID` for this contact flow is `
45
- # b0b8f2dd-ed1b-4c44-af36-ce189a178181 `. Make sure to include only
46
- # the GUID after the "contact-flow/" in your requests.
800
+ # To find the `ContactFlowId`, open the contact flow you want to use
801
+ # in the Amazon Connect contact flow editor. The ID for the contact
802
+ # flow is displayed in the address bar as part of the URL. For
803
+ # example, the contact flow ID is the set of characters at the end of
804
+ # the URL, after 'contact-flow/' such as
805
+ # `78ea8fd5-2659-4f2b-b528-699760ccfc1b`.
47
806
  # @return [String]
48
807
  #
49
808
  # @!attribute [rw] instance_id
50
- # The identifier for your Amazon Connect instance. To find the
51
- # `InstanceId` value for your Amazon Connect instance, open the
52
- # [Amazon Connect console][1]. Select the instance alias of the
53
- # instance and view the instance ID in the **Overview** section. For
54
- # example, the instance ID is the set of characters at the end of the
55
- # instance ARN, after "instance/", such as
809
+ # The identifier for your Amazon Connect instance. To find the ID of
810
+ # your instance, open the AWS console and select Amazon Connect.
811
+ # Select the alias of the instance in the Instance alias column. The
812
+ # instance ID is displayed in the Overview section of your instance
813
+ # settings. For example, the instance ID is the set of characters at
814
+ # the end of the instance ARN, after instance/, such as
56
815
  # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
57
- #
58
- #
59
- #
60
- # [1]: https://console.aws.amazon.com/connect/
61
816
  # @return [String]
62
817
  #
63
818
  # @!attribute [rw] client_token
@@ -72,20 +827,20 @@ module Aws::Connect
72
827
  #
73
828
  # @!attribute [rw] source_phone_number
74
829
  # The phone number, in E.164 format, associated with your Amazon
75
- # Connect instance to use to place the outbound call.
830
+ # Connect instance to use for the outbound call.
76
831
  # @return [String]
77
832
  #
78
833
  # @!attribute [rw] queue_id
79
- # The queue to which to add the call. If you specify a queue, the
80
- # phone displayed for caller ID is the phone number defined for the
81
- # queue. If you do not specify a queue, the queue used is the queue
82
- # defined in the contact flow specified by `ContactFlowId`.
834
+ # The queue to add the call to. If you specify a queue, the phone
835
+ # displayed for caller ID is the phone number specified in the queue.
836
+ # If you do not specify a queue, the queue used will be the queue
837
+ # defined in the contact flow.
83
838
  #
84
- # To find the `QueueId`, open the queue to use in the Amazon Connect
85
- # queue editor. The ID for the queue is displayed in the address bar
86
- # as part of the URL. For example, the `QueueId` value is the set of
87
- # characters at the end of the URL, after "queue/", such as
88
- # `aeg40574-2d01-51c3-73d6-bf8624d2168c`.
839
+ # To find the `QueueId`, open the queue you want to use in the Amazon
840
+ # Connect Queue editor. The ID for the queue is displayed in the
841
+ # address bar as part of the URL. For example, the queue ID is the set
842
+ # of characters at the end of the URL, after 'queue/' such as
843
+ # `queue/aeg40574-2d01-51c3-73d6-bf8624d2168c`.
89
844
  # @return [String]
90
845
  #
91
846
  # @!attribute [rw] attributes
@@ -97,9 +852,9 @@ module Aws::Connect
97
852
  # Attribute keys can include only alphanumeric, dash, and underscore
98
853
  # characters.
99
854
  #
100
- # For example, to play a greeting when the customer answers the call,
101
- # you can pass the customer name in attributes similar to the
102
- # following:
855
+ # For example, if you want play a greeting when the customer answers
856
+ # the call, you can pass the customer name in attributes similar to
857
+ # the following:
103
858
  # @return [Hash<String,String>]
104
859
  #
105
860
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactRequest AWS API Documentation
@@ -136,13 +891,17 @@ module Aws::Connect
136
891
  # }
137
892
  #
138
893
  # @!attribute [rw] contact_id
139
- # The unique identifier of the contact to end. This is the `ContactId`
140
- # value returned from the `StartOutboundVoiceContact` operation.
894
+ # The unique identifier of the contact to end.
141
895
  # @return [String]
142
896
  #
143
897
  # @!attribute [rw] instance_id
144
- # The identifier of the Amazon Connect instance in which the contact
145
- # is active.
898
+ # The identifier for your Amazon Connect instance. To find the ID of
899
+ # your instance, open the AWS console and select Amazon Connect.
900
+ # Select the alias of the instance in the Instance alias column. The
901
+ # instance ID is displayed in the Overview section of your instance
902
+ # settings. For example, the instance ID is the set of characters at
903
+ # the end of the instance ARN, after instance/, such as
904
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
146
905
  # @return [String]
147
906
  #
148
907
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRequest AWS API Documentation
@@ -157,5 +916,354 @@ module Aws::Connect
157
916
  #
158
917
  class StopContactResponse < Aws::EmptyStructure; end
159
918
 
919
+ # @note When making an API call, you may pass UpdateUserHierarchyRequest
920
+ # data as a hash:
921
+ #
922
+ # {
923
+ # hierarchy_group_id: "HierarchyGroupId",
924
+ # user_id: "UserId", # required
925
+ # instance_id: "InstanceId", # required
926
+ # }
927
+ #
928
+ # @!attribute [rw] hierarchy_group_id
929
+ # The identifier for the hierarchy group to assign to the user.
930
+ # @return [String]
931
+ #
932
+ # @!attribute [rw] user_id
933
+ # The identifier of the user account to assign the hierarchy group to.
934
+ # @return [String]
935
+ #
936
+ # @!attribute [rw] instance_id
937
+ # The identifier for your Amazon Connect instance. To find the ID of
938
+ # your instance, open the AWS console and select Amazon Connect.
939
+ # Select the alias of the instance in the Instance alias column. The
940
+ # instance ID is displayed in the Overview section of your instance
941
+ # settings. For example, the instance ID is the set of characters at
942
+ # the end of the instance ARN, after instance/, such as
943
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
944
+ # @return [String]
945
+ #
946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyRequest AWS API Documentation
947
+ #
948
+ class UpdateUserHierarchyRequest < Struct.new(
949
+ :hierarchy_group_id,
950
+ :user_id,
951
+ :instance_id)
952
+ include Aws::Structure
953
+ end
954
+
955
+ # @note When making an API call, you may pass UpdateUserIdentityInfoRequest
956
+ # data as a hash:
957
+ #
958
+ # {
959
+ # identity_info: { # required
960
+ # first_name: "AgentFirstName",
961
+ # last_name: "AgentLastName",
962
+ # email: "Email",
963
+ # },
964
+ # user_id: "UserId", # required
965
+ # instance_id: "InstanceId", # required
966
+ # }
967
+ #
968
+ # @!attribute [rw] identity_info
969
+ # A `UserIdentityInfo` object.
970
+ # @return [Types::UserIdentityInfo]
971
+ #
972
+ # @!attribute [rw] user_id
973
+ # The identifier for the user account to update identity information
974
+ # for.
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] instance_id
978
+ # The identifier for your Amazon Connect instance. To find the ID of
979
+ # your instance, open the AWS console and select Amazon Connect.
980
+ # Select the alias of the instance in the Instance alias column. The
981
+ # instance ID is displayed in the Overview section of your instance
982
+ # settings. For example, the instance ID is the set of characters at
983
+ # the end of the instance ARN, after instance/, such as
984
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
985
+ # @return [String]
986
+ #
987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfoRequest AWS API Documentation
988
+ #
989
+ class UpdateUserIdentityInfoRequest < Struct.new(
990
+ :identity_info,
991
+ :user_id,
992
+ :instance_id)
993
+ include Aws::Structure
994
+ end
995
+
996
+ # @note When making an API call, you may pass UpdateUserPhoneConfigRequest
997
+ # data as a hash:
998
+ #
999
+ # {
1000
+ # phone_config: { # required
1001
+ # phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
1002
+ # auto_accept: false,
1003
+ # after_contact_work_time_limit: 1,
1004
+ # desk_phone_number: "PhoneNumber",
1005
+ # },
1006
+ # user_id: "UserId", # required
1007
+ # instance_id: "InstanceId", # required
1008
+ # }
1009
+ #
1010
+ # @!attribute [rw] phone_config
1011
+ # A `UserPhoneConfig` object that contains settings for
1012
+ # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
1013
+ # `PhoneType` to assign to the user.
1014
+ # @return [Types::UserPhoneConfig]
1015
+ #
1016
+ # @!attribute [rw] user_id
1017
+ # The identifier for the user account to change phone settings for.
1018
+ # @return [String]
1019
+ #
1020
+ # @!attribute [rw] instance_id
1021
+ # The identifier for your Amazon Connect instance. To find the ID of
1022
+ # your instance, open the AWS console and select Amazon Connect.
1023
+ # Select the alias of the instance in the Instance alias column. The
1024
+ # instance ID is displayed in the Overview section of your instance
1025
+ # settings. For example, the instance ID is the set of characters at
1026
+ # the end of the instance ARN, after instance/, such as
1027
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1028
+ # @return [String]
1029
+ #
1030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfigRequest AWS API Documentation
1031
+ #
1032
+ class UpdateUserPhoneConfigRequest < Struct.new(
1033
+ :phone_config,
1034
+ :user_id,
1035
+ :instance_id)
1036
+ include Aws::Structure
1037
+ end
1038
+
1039
+ # @note When making an API call, you may pass UpdateUserRoutingProfileRequest
1040
+ # data as a hash:
1041
+ #
1042
+ # {
1043
+ # routing_profile_id: "RoutingProfileId", # required
1044
+ # user_id: "UserId", # required
1045
+ # instance_id: "InstanceId", # required
1046
+ # }
1047
+ #
1048
+ # @!attribute [rw] routing_profile_id
1049
+ # The identifier of the routing profile to assign to the user.
1050
+ # @return [String]
1051
+ #
1052
+ # @!attribute [rw] user_id
1053
+ # The identifier for the user account to assign the routing profile
1054
+ # to.
1055
+ # @return [String]
1056
+ #
1057
+ # @!attribute [rw] instance_id
1058
+ # The identifier for your Amazon Connect instance. To find the ID of
1059
+ # your instance, open the AWS console and select Amazon Connect.
1060
+ # Select the alias of the instance in the Instance alias column. The
1061
+ # instance ID is displayed in the Overview section of your instance
1062
+ # settings. For example, the instance ID is the set of characters at
1063
+ # the end of the instance ARN, after instance/, such as
1064
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1065
+ # @return [String]
1066
+ #
1067
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfileRequest AWS API Documentation
1068
+ #
1069
+ class UpdateUserRoutingProfileRequest < Struct.new(
1070
+ :routing_profile_id,
1071
+ :user_id,
1072
+ :instance_id)
1073
+ include Aws::Structure
1074
+ end
1075
+
1076
+ # @note When making an API call, you may pass UpdateUserSecurityProfilesRequest
1077
+ # data as a hash:
1078
+ #
1079
+ # {
1080
+ # security_profile_ids: ["SecurityProfileId"], # required
1081
+ # user_id: "UserId", # required
1082
+ # instance_id: "InstanceId", # required
1083
+ # }
1084
+ #
1085
+ # @!attribute [rw] security_profile_ids
1086
+ # The identifiers for the security profiles to assign to the user.
1087
+ # @return [Array<String>]
1088
+ #
1089
+ # @!attribute [rw] user_id
1090
+ # The identifier of the user account to assign the security profiles.
1091
+ # @return [String]
1092
+ #
1093
+ # @!attribute [rw] instance_id
1094
+ # The identifier for your Amazon Connect instance. To find the ID of
1095
+ # your instance, open the AWS console and select Amazon Connect.
1096
+ # Select the alias of the instance in the Instance alias column. The
1097
+ # instance ID is displayed in the Overview section of your instance
1098
+ # settings. For example, the instance ID is the set of characters at
1099
+ # the end of the instance ARN, after instance/, such as
1100
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1101
+ # @return [String]
1102
+ #
1103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfilesRequest AWS API Documentation
1104
+ #
1105
+ class UpdateUserSecurityProfilesRequest < Struct.new(
1106
+ :security_profile_ids,
1107
+ :user_id,
1108
+ :instance_id)
1109
+ include Aws::Structure
1110
+ end
1111
+
1112
+ # A `User` object that contains information about a user account in your
1113
+ # Amazon Connect instance, including configuration settings.
1114
+ #
1115
+ # @!attribute [rw] id
1116
+ # The identifier of the user account.
1117
+ # @return [String]
1118
+ #
1119
+ # @!attribute [rw] arn
1120
+ # The ARN of the user account.
1121
+ # @return [String]
1122
+ #
1123
+ # @!attribute [rw] username
1124
+ # The user name assigned to the user account.
1125
+ # @return [String]
1126
+ #
1127
+ # @!attribute [rw] identity_info
1128
+ # A `UserIdentityInfo` object.
1129
+ # @return [Types::UserIdentityInfo]
1130
+ #
1131
+ # @!attribute [rw] phone_config
1132
+ # A `UserPhoneConfig` object.
1133
+ # @return [Types::UserPhoneConfig]
1134
+ #
1135
+ # @!attribute [rw] directory_user_id
1136
+ # The directory Id for the user account in the existing directory used
1137
+ # for identity management.
1138
+ # @return [String]
1139
+ #
1140
+ # @!attribute [rw] security_profile_ids
1141
+ # The identifier(s) for the security profile assigned to the user.
1142
+ # @return [Array<String>]
1143
+ #
1144
+ # @!attribute [rw] routing_profile_id
1145
+ # The identifier of the routing profile assigned to the user.
1146
+ # @return [String]
1147
+ #
1148
+ # @!attribute [rw] hierarchy_group_id
1149
+ # The identifier for the hierarchy group assigned to the user.
1150
+ # @return [String]
1151
+ #
1152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/User AWS API Documentation
1153
+ #
1154
+ class User < Struct.new(
1155
+ :id,
1156
+ :arn,
1157
+ :username,
1158
+ :identity_info,
1159
+ :phone_config,
1160
+ :directory_user_id,
1161
+ :security_profile_ids,
1162
+ :routing_profile_id,
1163
+ :hierarchy_group_id)
1164
+ include Aws::Structure
1165
+ end
1166
+
1167
+ # A `UserIdentityInfo` object that contains information about the
1168
+ # user's identity, including email address, first name, and last name.
1169
+ #
1170
+ # @note When making an API call, you may pass UserIdentityInfo
1171
+ # data as a hash:
1172
+ #
1173
+ # {
1174
+ # first_name: "AgentFirstName",
1175
+ # last_name: "AgentLastName",
1176
+ # email: "Email",
1177
+ # }
1178
+ #
1179
+ # @!attribute [rw] first_name
1180
+ # The first name used in the user account. This is required if you are
1181
+ # using Amazon Connect or SAML for identity management.
1182
+ # @return [String]
1183
+ #
1184
+ # @!attribute [rw] last_name
1185
+ # The last name used in the user account. This is required if you are
1186
+ # using Amazon Connect or SAML for identity management.
1187
+ # @return [String]
1188
+ #
1189
+ # @!attribute [rw] email
1190
+ # The email address added to the user account. If you are using SAML
1191
+ # for identity management and include this parameter, an
1192
+ # `InvalidRequestException` is returned.
1193
+ # @return [String]
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserIdentityInfo AWS API Documentation
1196
+ #
1197
+ class UserIdentityInfo < Struct.new(
1198
+ :first_name,
1199
+ :last_name,
1200
+ :email)
1201
+ include Aws::Structure
1202
+ end
1203
+
1204
+ # A `UserPhoneConfig` object that contains information about the user
1205
+ # phone configuration settings.
1206
+ #
1207
+ # @note When making an API call, you may pass UserPhoneConfig
1208
+ # data as a hash:
1209
+ #
1210
+ # {
1211
+ # phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
1212
+ # auto_accept: false,
1213
+ # after_contact_work_time_limit: 1,
1214
+ # desk_phone_number: "PhoneNumber",
1215
+ # }
1216
+ #
1217
+ # @!attribute [rw] phone_type
1218
+ # The phone type selected for the user, either Soft phone or Desk
1219
+ # phone.
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] auto_accept
1223
+ # The Auto accept setting for the user, Yes or No.
1224
+ # @return [Boolean]
1225
+ #
1226
+ # @!attribute [rw] after_contact_work_time_limit
1227
+ # The After Call Work (ACW) timeout setting, in seconds, for the user.
1228
+ # @return [Integer]
1229
+ #
1230
+ # @!attribute [rw] desk_phone_number
1231
+ # The phone number for the user's desk phone.
1232
+ # @return [String]
1233
+ #
1234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserPhoneConfig AWS API Documentation
1235
+ #
1236
+ class UserPhoneConfig < Struct.new(
1237
+ :phone_type,
1238
+ :auto_accept,
1239
+ :after_contact_work_time_limit,
1240
+ :desk_phone_number)
1241
+ include Aws::Structure
1242
+ end
1243
+
1244
+ # A `UserSummary` object that contains Information about a user,
1245
+ # including ARN, Id, and user name.
1246
+ #
1247
+ # @!attribute [rw] id
1248
+ # The identifier for the user account.
1249
+ # @return [String]
1250
+ #
1251
+ # @!attribute [rw] arn
1252
+ # The ARN for the user account.
1253
+ # @return [String]
1254
+ #
1255
+ # @!attribute [rw] username
1256
+ # The Amazon Connect user name for the user account.
1257
+ # @return [String]
1258
+ #
1259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSummary AWS API Documentation
1260
+ #
1261
+ class UserSummary < Struct.new(
1262
+ :id,
1263
+ :arn,
1264
+ :username)
1265
+ include Aws::Structure
1266
+ end
1267
+
160
1268
  end
161
1269
  end