aws-sdk-connect 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 87704f9b200bf06ae7e4f1654b445736a8608aa3
4
- data.tar.gz: 25fe6c2f45f42a480f4af713f10a4114adf62541
3
+ metadata.gz: a561371924faea469830d12463afe7f80ece5ba2
4
+ data.tar.gz: 7f214ef9fbcfb3e9e804baca385cdee091db9763
5
5
  SHA512:
6
- metadata.gz: 644b898448b5c66d3a48a0941058f621b585c073a62ef9a31c66d92df8e42bfcea14993a5e2c22bb5ddbfa8c4fc03c2e2564943f2fdaa9631ab284e29ee295fb
7
- data.tar.gz: c9e9988a7bb11bdb590660fdb8a7ffb1f961aa0beb8510a45075121a0b3c4268a14188ba38f7af0ae66ad07ca4928afbf5d127f476ae614b197091d74d977e01
6
+ metadata.gz: 0aac9fe28b030cb42d5fa2c64252e397ccaa10fed677d2a555fec0f362afce50de98cd5b882d26626f7fa27e237a152db80f77756fadf0b747afac1cfd329961
7
+ data.tar.gz: 6224d33f9118797a3925b1d0f886b40a0f656b732cbd1f0af97f2c6fc5f405e2a8ac05d1f72a62a6e534ce705038dd2fa3c2ef40a997eb964b3c3badc9c47c26
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-connect/customizations'
42
42
  # @service
43
43
  module Aws::Connect
44
44
 
45
- GEM_VERSION = '1.1.0'
45
+ GEM_VERSION = '1.2.0'
46
46
 
47
47
  end
@@ -156,47 +156,562 @@ module Aws::Connect
156
156
 
157
157
  # @!group API Operations
158
158
 
159
+ # Creates a new user account in your Amazon Connect instance.
160
+ #
161
+ # @option params [required, String] :username
162
+ # The user name in Amazon Connect for the user to create.
163
+ #
164
+ # @option params [String] :password
165
+ # The password for the user account to create. This is required if you
166
+ # are using Amazon Connect for identity management. If you are using
167
+ # SAML for identity management and include this parameter, an
168
+ # `InvalidRequestException` is returned.
169
+ #
170
+ # @option params [Types::UserIdentityInfo] :identity_info
171
+ # Information about the user, including email address, first name, and
172
+ # last name.
173
+ #
174
+ # @option params [required, Types::UserPhoneConfig] :phone_config
175
+ # Specifies the phone settings for the user, including
176
+ # AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
177
+ #
178
+ # @option params [String] :directory_user_id
179
+ # The unique identifier for the user account in the directory service
180
+ # directory used for identity management. If Amazon Connect is unable to
181
+ # access the existing directory, you can use the `DirectoryUserId` to
182
+ # authenticate users. If you include the parameter, it is assumed that
183
+ # Amazon Connect cannot access the directory. If the parameter is not
184
+ # included, the UserIdentityInfo is used to authenticate users from your
185
+ # existing directory.
186
+ #
187
+ # This parameter is required if you are using an existing directory for
188
+ # identity management in Amazon Connect when Amazon Connect cannot
189
+ # access your directory to authenticate users. If you are using SAML for
190
+ # identity management and include this parameter, an
191
+ # `InvalidRequestException` is returned.
192
+ #
193
+ # @option params [required, Array<String>] :security_profile_ids
194
+ # The unique identifier of the security profile to assign to the user
195
+ # created.
196
+ #
197
+ # @option params [required, String] :routing_profile_id
198
+ # The unique identifier for the routing profile to assign to the user
199
+ # created.
200
+ #
201
+ # @option params [String] :hierarchy_group_id
202
+ # The unique identifier for the hierarchy group to assign to the user
203
+ # created.
204
+ #
205
+ # @option params [required, String] :instance_id
206
+ # The identifier for your Amazon Connect instance. To find the ID of
207
+ # your instance, open the AWS console and select Amazon Connect. Select
208
+ # the alias of the instance in the Instance alias column. The instance
209
+ # ID is displayed in the Overview section of your instance settings. For
210
+ # example, the instance ID is the set of characters at the end of the
211
+ # instance ARN, after instance/, such as
212
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
213
+ #
214
+ # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
215
+ #
216
+ # * {Types::CreateUserResponse#user_id #user_id} => String
217
+ # * {Types::CreateUserResponse#user_arn #user_arn} => String
218
+ #
219
+ # @example Request syntax with placeholder values
220
+ #
221
+ # resp = client.create_user({
222
+ # username: "AgentUsername", # required
223
+ # password: "Password",
224
+ # identity_info: {
225
+ # first_name: "AgentFirstName",
226
+ # last_name: "AgentLastName",
227
+ # email: "Email",
228
+ # },
229
+ # phone_config: { # required
230
+ # phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
231
+ # auto_accept: false,
232
+ # after_contact_work_time_limit: 1,
233
+ # desk_phone_number: "PhoneNumber",
234
+ # },
235
+ # directory_user_id: "DirectoryUserId",
236
+ # security_profile_ids: ["SecurityProfileId"], # required
237
+ # routing_profile_id: "RoutingProfileId", # required
238
+ # hierarchy_group_id: "HierarchyGroupId",
239
+ # instance_id: "InstanceId", # required
240
+ # })
241
+ #
242
+ # @example Response structure
243
+ #
244
+ # resp.user_id #=> String
245
+ # resp.user_arn #=> String
246
+ #
247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser AWS API Documentation
248
+ #
249
+ # @overload create_user(params = {})
250
+ # @param [Hash] params ({})
251
+ def create_user(params = {}, options = {})
252
+ req = build_request(:create_user, params)
253
+ req.send_request(options)
254
+ end
255
+
256
+ # Deletes a user account from Amazon Connect.
257
+ #
258
+ # @option params [required, String] :instance_id
259
+ # The identifier for your Amazon Connect instance. To find the ID of
260
+ # your instance, open the AWS console and select Amazon Connect. Select
261
+ # the alias of the instance in the Instance alias column. The instance
262
+ # ID is displayed in the Overview section of your instance settings. For
263
+ # example, the instance ID is the set of characters at the end of the
264
+ # instance ARN, after instance/, such as
265
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
266
+ #
267
+ # @option params [required, String] :user_id
268
+ # The unique identifier of the user to delete.
269
+ #
270
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
271
+ #
272
+ # @example Request syntax with placeholder values
273
+ #
274
+ # resp = client.delete_user({
275
+ # instance_id: "InstanceId", # required
276
+ # user_id: "UserId", # required
277
+ # })
278
+ #
279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser AWS API Documentation
280
+ #
281
+ # @overload delete_user(params = {})
282
+ # @param [Hash] params ({})
283
+ def delete_user(params = {}, options = {})
284
+ req = build_request(:delete_user, params)
285
+ req.send_request(options)
286
+ end
287
+
288
+ # Returns a `User` object that contains information about the user
289
+ # account specified by the `UserId`.
290
+ #
291
+ # @option params [required, String] :user_id
292
+ # Unique identifier for the user account to return.
293
+ #
294
+ # @option params [required, String] :instance_id
295
+ # The identifier for your Amazon Connect instance. To find the ID of
296
+ # your instance, open the AWS console and select Amazon Connect. Select
297
+ # the alias of the instance in the Instance alias column. The instance
298
+ # ID is displayed in the Overview section of your instance settings. For
299
+ # example, the instance ID is the set of characters at the end of the
300
+ # instance ARN, after instance/, such as
301
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
302
+ #
303
+ # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
304
+ #
305
+ # * {Types::DescribeUserResponse#user #user} => Types::User
306
+ #
307
+ # @example Request syntax with placeholder values
308
+ #
309
+ # resp = client.describe_user({
310
+ # user_id: "UserId", # required
311
+ # instance_id: "InstanceId", # required
312
+ # })
313
+ #
314
+ # @example Response structure
315
+ #
316
+ # resp.user.id #=> String
317
+ # resp.user.arn #=> String
318
+ # resp.user.username #=> String
319
+ # resp.user.identity_info.first_name #=> String
320
+ # resp.user.identity_info.last_name #=> String
321
+ # resp.user.identity_info.email #=> String
322
+ # resp.user.phone_config.phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
323
+ # resp.user.phone_config.auto_accept #=> Boolean
324
+ # resp.user.phone_config.after_contact_work_time_limit #=> Integer
325
+ # resp.user.phone_config.desk_phone_number #=> String
326
+ # resp.user.directory_user_id #=> String
327
+ # resp.user.security_profile_ids #=> Array
328
+ # resp.user.security_profile_ids[0] #=> String
329
+ # resp.user.routing_profile_id #=> String
330
+ # resp.user.hierarchy_group_id #=> String
331
+ #
332
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser AWS API Documentation
333
+ #
334
+ # @overload describe_user(params = {})
335
+ # @param [Hash] params ({})
336
+ def describe_user(params = {}, options = {})
337
+ req = build_request(:describe_user, params)
338
+ req.send_request(options)
339
+ end
340
+
341
+ # Returns a `HierarchyGroup` object that includes information about a
342
+ # hierarchy group in your instance.
343
+ #
344
+ # @option params [required, String] :hierarchy_group_id
345
+ # The identifier for the hierarchy group to return.
346
+ #
347
+ # @option params [required, String] :instance_id
348
+ # The identifier for your Amazon Connect instance. To find the ID of
349
+ # your instance, open the AWS console and select Amazon Connect. Select
350
+ # the alias of the instance in the Instance alias column. The instance
351
+ # ID is displayed in the Overview section of your instance settings. For
352
+ # example, the instance ID is the set of characters at the end of the
353
+ # instance ARN, after instance/, such as
354
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
355
+ #
356
+ # @return [Types::DescribeUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
357
+ #
358
+ # * {Types::DescribeUserHierarchyGroupResponse#hierarchy_group #hierarchy_group} => Types::HierarchyGroup
359
+ #
360
+ # @example Request syntax with placeholder values
361
+ #
362
+ # resp = client.describe_user_hierarchy_group({
363
+ # hierarchy_group_id: "HierarchyGroupId", # required
364
+ # instance_id: "InstanceId", # required
365
+ # })
366
+ #
367
+ # @example Response structure
368
+ #
369
+ # resp.hierarchy_group.id #=> String
370
+ # resp.hierarchy_group.arn #=> String
371
+ # resp.hierarchy_group.name #=> String
372
+ # resp.hierarchy_group.level_id #=> String
373
+ # resp.hierarchy_group.hierarchy_path.level_one.id #=> String
374
+ # resp.hierarchy_group.hierarchy_path.level_one.arn #=> String
375
+ # resp.hierarchy_group.hierarchy_path.level_one.name #=> String
376
+ # resp.hierarchy_group.hierarchy_path.level_two.id #=> String
377
+ # resp.hierarchy_group.hierarchy_path.level_two.arn #=> String
378
+ # resp.hierarchy_group.hierarchy_path.level_two.name #=> String
379
+ # resp.hierarchy_group.hierarchy_path.level_three.id #=> String
380
+ # resp.hierarchy_group.hierarchy_path.level_three.arn #=> String
381
+ # resp.hierarchy_group.hierarchy_path.level_three.name #=> String
382
+ # resp.hierarchy_group.hierarchy_path.level_four.id #=> String
383
+ # resp.hierarchy_group.hierarchy_path.level_four.arn #=> String
384
+ # resp.hierarchy_group.hierarchy_path.level_four.name #=> String
385
+ # resp.hierarchy_group.hierarchy_path.level_five.id #=> String
386
+ # resp.hierarchy_group.hierarchy_path.level_five.arn #=> String
387
+ # resp.hierarchy_group.hierarchy_path.level_five.name #=> String
388
+ #
389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup AWS API Documentation
390
+ #
391
+ # @overload describe_user_hierarchy_group(params = {})
392
+ # @param [Hash] params ({})
393
+ def describe_user_hierarchy_group(params = {}, options = {})
394
+ req = build_request(:describe_user_hierarchy_group, params)
395
+ req.send_request(options)
396
+ end
397
+
398
+ # Returns a `HiearchyGroupStructure` object, which contains data about
399
+ # the levels in the agent hierarchy.
400
+ #
401
+ # @option params [required, String] :instance_id
402
+ # The identifier for your Amazon Connect instance. To find the ID of
403
+ # your instance, open the AWS console and select Amazon Connect. Select
404
+ # the alias of the instance in the Instance alias column. The instance
405
+ # ID is displayed in the Overview section of your instance settings. For
406
+ # example, the instance ID is the set of characters at the end of the
407
+ # instance ARN, after instance/, such as
408
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
409
+ #
410
+ # @return [Types::DescribeUserHierarchyStructureResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
411
+ #
412
+ # * {Types::DescribeUserHierarchyStructureResponse#hierarchy_structure #hierarchy_structure} => Types::HierarchyStructure
413
+ #
414
+ # @example Request syntax with placeholder values
415
+ #
416
+ # resp = client.describe_user_hierarchy_structure({
417
+ # instance_id: "InstanceId", # required
418
+ # })
419
+ #
420
+ # @example Response structure
421
+ #
422
+ # resp.hierarchy_structure.level_one.id #=> String
423
+ # resp.hierarchy_structure.level_one.arn #=> String
424
+ # resp.hierarchy_structure.level_one.name #=> String
425
+ # resp.hierarchy_structure.level_two.id #=> String
426
+ # resp.hierarchy_structure.level_two.arn #=> String
427
+ # resp.hierarchy_structure.level_two.name #=> String
428
+ # resp.hierarchy_structure.level_three.id #=> String
429
+ # resp.hierarchy_structure.level_three.arn #=> String
430
+ # resp.hierarchy_structure.level_three.name #=> String
431
+ # resp.hierarchy_structure.level_four.id #=> String
432
+ # resp.hierarchy_structure.level_four.arn #=> String
433
+ # resp.hierarchy_structure.level_four.name #=> String
434
+ # resp.hierarchy_structure.level_five.id #=> String
435
+ # resp.hierarchy_structure.level_five.arn #=> String
436
+ # resp.hierarchy_structure.level_five.name #=> String
437
+ #
438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure AWS API Documentation
439
+ #
440
+ # @overload describe_user_hierarchy_structure(params = {})
441
+ # @param [Hash] params ({})
442
+ def describe_user_hierarchy_structure(params = {}, options = {})
443
+ req = build_request(:describe_user_hierarchy_structure, params)
444
+ req.send_request(options)
445
+ end
446
+
447
+ # Retrieves a token for federation.
448
+ #
449
+ # @option params [required, String] :instance_id
450
+ # The identifier for your Amazon Connect instance. To find the ID of
451
+ # your instance, open the AWS console and select Amazon Connect. Select
452
+ # the alias of the instance in the Instance alias column. The instance
453
+ # ID is displayed in the Overview section of your instance settings. For
454
+ # example, the instance ID is the set of characters at the end of the
455
+ # instance ARN, after instance/, such as
456
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
457
+ #
458
+ # @return [Types::GetFederationTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
459
+ #
460
+ # * {Types::GetFederationTokenResponse#credentials #credentials} => Types::Credentials
461
+ #
462
+ # @example Request syntax with placeholder values
463
+ #
464
+ # resp = client.get_federation_token({
465
+ # instance_id: "InstanceId", # required
466
+ # })
467
+ #
468
+ # @example Response structure
469
+ #
470
+ # resp.credentials.access_token #=> String
471
+ # resp.credentials.access_token_expiration #=> Time
472
+ # resp.credentials.refresh_token #=> String
473
+ # resp.credentials.refresh_token_expiration #=> Time
474
+ #
475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFederationToken AWS API Documentation
476
+ #
477
+ # @overload get_federation_token(params = {})
478
+ # @param [Hash] params ({})
479
+ def get_federation_token(params = {}, options = {})
480
+ req = build_request(:get_federation_token, params)
481
+ req.send_request(options)
482
+ end
483
+
484
+ # Returns an array of `RoutingProfileSummary` objects that includes
485
+ # information about the routing profiles in your instance.
486
+ #
487
+ # @option params [required, String] :instance_id
488
+ # The identifier for your Amazon Connect instance. To find the ID of
489
+ # your instance, open the AWS console and select Amazon Connect. Select
490
+ # the alias of the instance in the Instance alias column. The instance
491
+ # ID is displayed in the Overview section of your instance settings. For
492
+ # example, the instance ID is the set of characters at the end of the
493
+ # instance ARN, after instance/, such as
494
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
495
+ #
496
+ # @option params [String] :next_token
497
+ # The token for the next set of results. Use the value returned in the
498
+ # previous response in the next request to retrieve the next set of
499
+ # results.
500
+ #
501
+ # @option params [Integer] :max_results
502
+ # The maximum number of routing profiles to return in the response.
503
+ #
504
+ # @return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
505
+ #
506
+ # * {Types::ListRoutingProfilesResponse#routing_profile_summary_list #routing_profile_summary_list} => Array&lt;Types::RoutingProfileSummary&gt;
507
+ # * {Types::ListRoutingProfilesResponse#next_token #next_token} => String
508
+ #
509
+ # @example Request syntax with placeholder values
510
+ #
511
+ # resp = client.list_routing_profiles({
512
+ # instance_id: "InstanceId", # required
513
+ # next_token: "NextToken",
514
+ # max_results: 1,
515
+ # })
516
+ #
517
+ # @example Response structure
518
+ #
519
+ # resp.routing_profile_summary_list #=> Array
520
+ # resp.routing_profile_summary_list[0].id #=> String
521
+ # resp.routing_profile_summary_list[0].arn #=> String
522
+ # resp.routing_profile_summary_list[0].name #=> String
523
+ # resp.next_token #=> String
524
+ #
525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles AWS API Documentation
526
+ #
527
+ # @overload list_routing_profiles(params = {})
528
+ # @param [Hash] params ({})
529
+ def list_routing_profiles(params = {}, options = {})
530
+ req = build_request(:list_routing_profiles, params)
531
+ req.send_request(options)
532
+ end
533
+
534
+ # Returns an array of SecurityProfileSummary objects that contain
535
+ # information about the security profiles in your instance, including
536
+ # the ARN, Id, and Name of the security profile.
537
+ #
538
+ # @option params [required, String] :instance_id
539
+ # The identifier for your Amazon Connect instance. To find the ID of
540
+ # your instance, open the AWS console and select Amazon Connect. Select
541
+ # the alias of the instance in the Instance alias column. The instance
542
+ # ID is displayed in the Overview section of your instance settings. For
543
+ # example, the instance ID is the set of characters at the end of the
544
+ # instance ARN, after instance/, such as
545
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
546
+ #
547
+ # @option params [String] :next_token
548
+ # The token for the next set of results. Use the value returned in the
549
+ # previous response in the next request to retrieve the next set of
550
+ # results.
551
+ #
552
+ # @option params [Integer] :max_results
553
+ # The maximum number of security profiles to return.
554
+ #
555
+ # @return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
556
+ #
557
+ # * {Types::ListSecurityProfilesResponse#security_profile_summary_list #security_profile_summary_list} => Array&lt;Types::SecurityProfileSummary&gt;
558
+ # * {Types::ListSecurityProfilesResponse#next_token #next_token} => String
559
+ #
560
+ # @example Request syntax with placeholder values
561
+ #
562
+ # resp = client.list_security_profiles({
563
+ # instance_id: "InstanceId", # required
564
+ # next_token: "NextToken",
565
+ # max_results: 1,
566
+ # })
567
+ #
568
+ # @example Response structure
569
+ #
570
+ # resp.security_profile_summary_list #=> Array
571
+ # resp.security_profile_summary_list[0].id #=> String
572
+ # resp.security_profile_summary_list[0].arn #=> String
573
+ # resp.security_profile_summary_list[0].name #=> String
574
+ # resp.next_token #=> String
575
+ #
576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfiles AWS API Documentation
577
+ #
578
+ # @overload list_security_profiles(params = {})
579
+ # @param [Hash] params ({})
580
+ def list_security_profiles(params = {}, options = {})
581
+ req = build_request(:list_security_profiles, params)
582
+ req.send_request(options)
583
+ end
584
+
585
+ # Returns a `UserHierarchyGroupSummaryList`, which is an array of
586
+ # `HierarchyGroupSummary` objects that contain information about the
587
+ # hierarchy groups in your instance.
588
+ #
589
+ # @option params [required, String] :instance_id
590
+ # The identifier for your Amazon Connect instance. To find the ID of
591
+ # your instance, open the AWS console and select Amazon Connect. Select
592
+ # the alias of the instance in the Instance alias column. The instance
593
+ # ID is displayed in the Overview section of your instance settings. For
594
+ # example, the instance ID is the set of characters at the end of the
595
+ # instance ARN, after instance/, such as
596
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
597
+ #
598
+ # @option params [String] :next_token
599
+ # The token for the next set of results. Use the value returned in the
600
+ # previous response in the next request to retrieve the next set of
601
+ # results.
602
+ #
603
+ # @option params [Integer] :max_results
604
+ # The maximum number of hierarchy groups to return.
605
+ #
606
+ # @return [Types::ListUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
607
+ #
608
+ # * {Types::ListUserHierarchyGroupsResponse#user_hierarchy_group_summary_list #user_hierarchy_group_summary_list} => Array&lt;Types::HierarchyGroupSummary&gt;
609
+ # * {Types::ListUserHierarchyGroupsResponse#next_token #next_token} => String
610
+ #
611
+ # @example Request syntax with placeholder values
612
+ #
613
+ # resp = client.list_user_hierarchy_groups({
614
+ # instance_id: "InstanceId", # required
615
+ # next_token: "NextToken",
616
+ # max_results: 1,
617
+ # })
618
+ #
619
+ # @example Response structure
620
+ #
621
+ # resp.user_hierarchy_group_summary_list #=> Array
622
+ # resp.user_hierarchy_group_summary_list[0].id #=> String
623
+ # resp.user_hierarchy_group_summary_list[0].arn #=> String
624
+ # resp.user_hierarchy_group_summary_list[0].name #=> String
625
+ # resp.next_token #=> String
626
+ #
627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroups AWS API Documentation
628
+ #
629
+ # @overload list_user_hierarchy_groups(params = {})
630
+ # @param [Hash] params ({})
631
+ def list_user_hierarchy_groups(params = {}, options = {})
632
+ req = build_request(:list_user_hierarchy_groups, params)
633
+ req.send_request(options)
634
+ end
635
+
636
+ # Returns a `UserSummaryList`, which is an array of `UserSummary`
637
+ # objects.
638
+ #
639
+ # @option params [required, String] :instance_id
640
+ # The identifier for your Amazon Connect instance. To find the ID of
641
+ # your instance, open the AWS console and select Amazon Connect. Select
642
+ # the alias of the instance in the Instance alias column. The instance
643
+ # ID is displayed in the Overview section of your instance settings. For
644
+ # example, the instance ID is the set of characters at the end of the
645
+ # instance ARN, after instance/, such as
646
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
647
+ #
648
+ # @option params [String] :next_token
649
+ # The token for the next set of results. Use the value returned in the
650
+ # previous response in the next request to retrieve the next set of
651
+ # results.
652
+ #
653
+ # @option params [Integer] :max_results
654
+ # The maximum number of results to return in the response.
655
+ #
656
+ # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
657
+ #
658
+ # * {Types::ListUsersResponse#user_summary_list #user_summary_list} => Array&lt;Types::UserSummary&gt;
659
+ # * {Types::ListUsersResponse#next_token #next_token} => String
660
+ #
661
+ # @example Request syntax with placeholder values
662
+ #
663
+ # resp = client.list_users({
664
+ # instance_id: "InstanceId", # required
665
+ # next_token: "NextToken",
666
+ # max_results: 1,
667
+ # })
668
+ #
669
+ # @example Response structure
670
+ #
671
+ # resp.user_summary_list #=> Array
672
+ # resp.user_summary_list[0].id #=> String
673
+ # resp.user_summary_list[0].arn #=> String
674
+ # resp.user_summary_list[0].username #=> String
675
+ # resp.next_token #=> String
676
+ #
677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsers AWS API Documentation
678
+ #
679
+ # @overload list_users(params = {})
680
+ # @param [Hash] params ({})
681
+ def list_users(params = {}, options = {})
682
+ req = build_request(:list_users, params)
683
+ req.send_request(options)
684
+ end
685
+
159
686
  # The `StartOutboundVoiceContact` operation initiates a contact flow to
160
687
  # place an outbound call to a customer.
161
688
  #
162
689
  # There is a throttling limit placed on usage of the API that includes a
163
- # `RateLimit` of 2 per second, and a `BurstLimit` of 5 per second.
690
+ # RateLimit of 2 per second, and a BurstLimit of 5 per second.
164
691
  #
165
- # If you are using an IAM account, it must have permissions to the
692
+ # If you are using an IAM account, it must have permission to the
166
693
  # `connect:StartOutboundVoiceContact` action.
167
694
  #
168
695
  # @option params [required, String] :destination_phone_number
169
- # The phone number, in E.164 format, of the customer to call with the
170
- # outbound contact.
696
+ # The phone number of the customer in E.164 format.
171
697
  #
172
698
  # @option params [required, String] :contact_flow_id
173
- # The identifier for the contact flow to execute for the outbound call.
174
- # This is a GUID value only. Amazon Resource Name (ARN) values are not
175
- # supported.
176
- #
177
- # To find the `ContactFlowId`, open the contact flow to use in the
178
- # Amazon Connect contact flow designer. The ID for the contact flow is
179
- # displayed in the address bar as part of the URL. For example, an
180
- # address displayed when you open a contact flow is similar to the
181
- # following:
182
- # `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
183
- # `. At the end of the URL, you see
184
- # `contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181`. The
185
- # `ContactFlowID` for this contact flow is `
186
- # b0b8f2dd-ed1b-4c44-af36-ce189a178181 `. Make sure to include only the
187
- # GUID after the "contact-flow/" in your requests.
188
- #
189
- # @option params [required, String] :instance_id
190
- # The identifier for your Amazon Connect instance. To find the
191
- # `InstanceId` value for your Amazon Connect instance, open the [Amazon
192
- # Connect console][1]. Select the instance alias of the instance and
193
- # view the instance ID in the **Overview** section. For example, the
194
- # instance ID is the set of characters at the end of the instance ARN,
195
- # after "instance/", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
196
- #
699
+ # The identifier for the contact flow to connect the outbound call to.
197
700
  #
701
+ # To find the `ContactFlowId`, open the contact flow you want to use in
702
+ # the Amazon Connect contact flow editor. The ID for the contact flow is
703
+ # displayed in the address bar as part of the URL. For example, the
704
+ # contact flow ID is the set of characters at the end of the URL, after
705
+ # 'contact-flow/' such as `78ea8fd5-2659-4f2b-b528-699760ccfc1b`.
198
706
  #
199
- # [1]: https://console.aws.amazon.com/connect/
707
+ # @option params [required, String] :instance_id
708
+ # The identifier for your Amazon Connect instance. To find the ID of
709
+ # your instance, open the AWS console and select Amazon Connect. Select
710
+ # the alias of the instance in the Instance alias column. The instance
711
+ # ID is displayed in the Overview section of your instance settings. For
712
+ # example, the instance ID is the set of characters at the end of the
713
+ # instance ARN, after instance/, such as
714
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
200
715
  #
201
716
  # @option params [String] :client_token
202
717
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -209,19 +724,19 @@ module Aws::Connect
209
724
  #
210
725
  # @option params [String] :source_phone_number
211
726
  # The phone number, in E.164 format, associated with your Amazon Connect
212
- # instance to use to place the outbound call.
727
+ # instance to use for the outbound call.
213
728
  #
214
729
  # @option params [String] :queue_id
215
- # The queue to which to add the call. If you specify a queue, the phone
216
- # displayed for caller ID is the phone number defined for the queue. If
217
- # you do not specify a queue, the queue used is the queue defined in the
218
- # contact flow specified by `ContactFlowId`.
730
+ # The queue to add the call to. If you specify a queue, the phone
731
+ # displayed for caller ID is the phone number specified in the queue. If
732
+ # you do not specify a queue, the queue used will be the queue defined
733
+ # in the contact flow.
219
734
  #
220
- # To find the `QueueId`, open the queue to use in the Amazon Connect
221
- # queue editor. The ID for the queue is displayed in the address bar as
222
- # part of the URL. For example, the `QueueId` value is the set of
223
- # characters at the end of the URL, after "queue/", such as
224
- # `aeg40574-2d01-51c3-73d6-bf8624d2168c`.
735
+ # To find the `QueueId`, open the queue you want to use in the Amazon
736
+ # Connect Queue editor. The ID for the queue is displayed in the address
737
+ # bar as part of the URL. For example, the queue ID is the set of
738
+ # characters at the end of the URL, after 'queue/' such as
739
+ # `queue/aeg40574-2d01-51c3-73d6-bf8624d2168c`.
225
740
  #
226
741
  # @option params [Hash<String,String>] :attributes
227
742
  # Specify a custom key-value pair using an attribute map. The attributes
@@ -232,8 +747,9 @@ module Aws::Connect
232
747
  # Attribute keys can include only alphanumeric, dash, and underscore
233
748
  # characters.
234
749
  #
235
- # For example, to play a greeting when the customer answers the call,
236
- # you can pass the customer name in attributes similar to the following:
750
+ # For example, if you want play a greeting when the customer answers the
751
+ # call, you can pass the customer name in attributes similar to the
752
+ # following:
237
753
  #
238
754
  # @return [Types::StartOutboundVoiceContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
239
755
  #
@@ -269,16 +785,20 @@ module Aws::Connect
269
785
  # Ends the contact initiated by the `StartOutboundVoiceContact`
270
786
  # operation.
271
787
  #
272
- # If you are using an IAM account, it must have permissions to the
273
- # `connect:StopContact` operation.
788
+ # If you are using an IAM account, it must have permission to the
789
+ # `connect:StopContact` action.
274
790
  #
275
791
  # @option params [required, String] :contact_id
276
- # The unique identifier of the contact to end. This is the `ContactId`
277
- # value returned from the `StartOutboundVoiceContact` operation.
792
+ # The unique identifier of the contact to end.
278
793
  #
279
794
  # @option params [required, String] :instance_id
280
- # The identifier of the Amazon Connect instance in which the contact is
281
- # active.
795
+ # The identifier for your Amazon Connect instance. To find the ID of
796
+ # your instance, open the AWS console and select Amazon Connect. Select
797
+ # the alias of the instance in the Instance alias column. The instance
798
+ # ID is displayed in the Overview section of your instance settings. For
799
+ # example, the instance ID is the set of characters at the end of the
800
+ # instance ARN, after instance/, such as
801
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
282
802
  #
283
803
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
284
804
  #
@@ -298,6 +818,200 @@ module Aws::Connect
298
818
  req.send_request(options)
299
819
  end
300
820
 
821
+ # Assigns the specified hierarchy group to the user.
822
+ #
823
+ # @option params [String] :hierarchy_group_id
824
+ # The identifier for the hierarchy group to assign to the user.
825
+ #
826
+ # @option params [required, String] :user_id
827
+ # The identifier of the user account to assign the hierarchy group to.
828
+ #
829
+ # @option params [required, String] :instance_id
830
+ # The identifier for your Amazon Connect instance. To find the ID of
831
+ # your instance, open the AWS console and select Amazon Connect. Select
832
+ # the alias of the instance in the Instance alias column. The instance
833
+ # ID is displayed in the Overview section of your instance settings. For
834
+ # example, the instance ID is the set of characters at the end of the
835
+ # instance ARN, after instance/, such as
836
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
837
+ #
838
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
839
+ #
840
+ # @example Request syntax with placeholder values
841
+ #
842
+ # resp = client.update_user_hierarchy({
843
+ # hierarchy_group_id: "HierarchyGroupId",
844
+ # user_id: "UserId", # required
845
+ # instance_id: "InstanceId", # required
846
+ # })
847
+ #
848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchy AWS API Documentation
849
+ #
850
+ # @overload update_user_hierarchy(params = {})
851
+ # @param [Hash] params ({})
852
+ def update_user_hierarchy(params = {}, options = {})
853
+ req = build_request(:update_user_hierarchy, params)
854
+ req.send_request(options)
855
+ end
856
+
857
+ # Updates the identity information for the specified user in a
858
+ # `UserIdentityInfo` object, including email, first name, and last name.
859
+ #
860
+ # @option params [required, Types::UserIdentityInfo] :identity_info
861
+ # A `UserIdentityInfo` object.
862
+ #
863
+ # @option params [required, String] :user_id
864
+ # The identifier for the user account to update identity information
865
+ # for.
866
+ #
867
+ # @option params [required, String] :instance_id
868
+ # The identifier for your Amazon Connect instance. To find the ID of
869
+ # your instance, open the AWS console and select Amazon Connect. Select
870
+ # the alias of the instance in the Instance alias column. The instance
871
+ # ID is displayed in the Overview section of your instance settings. For
872
+ # example, the instance ID is the set of characters at the end of the
873
+ # instance ARN, after instance/, such as
874
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
875
+ #
876
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
877
+ #
878
+ # @example Request syntax with placeholder values
879
+ #
880
+ # resp = client.update_user_identity_info({
881
+ # identity_info: { # required
882
+ # first_name: "AgentFirstName",
883
+ # last_name: "AgentLastName",
884
+ # email: "Email",
885
+ # },
886
+ # user_id: "UserId", # required
887
+ # instance_id: "InstanceId", # required
888
+ # })
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserIdentityInfo AWS API Documentation
891
+ #
892
+ # @overload update_user_identity_info(params = {})
893
+ # @param [Hash] params ({})
894
+ def update_user_identity_info(params = {}, options = {})
895
+ req = build_request(:update_user_identity_info, params)
896
+ req.send_request(options)
897
+ end
898
+
899
+ # Updates the phone configuration settings in the `UserPhoneConfig`
900
+ # object for the specified user.
901
+ #
902
+ # @option params [required, Types::UserPhoneConfig] :phone_config
903
+ # A `UserPhoneConfig` object that contains settings for
904
+ # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
905
+ # `PhoneType` to assign to the user.
906
+ #
907
+ # @option params [required, String] :user_id
908
+ # The identifier for the user account to change phone settings for.
909
+ #
910
+ # @option params [required, String] :instance_id
911
+ # The identifier for your Amazon Connect instance. To find the ID of
912
+ # your instance, open the AWS console and select Amazon Connect. Select
913
+ # the alias of the instance in the Instance alias column. The instance
914
+ # ID is displayed in the Overview section of your instance settings. For
915
+ # example, the instance ID is the set of characters at the end of the
916
+ # instance ARN, after instance/, such as
917
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
918
+ #
919
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
920
+ #
921
+ # @example Request syntax with placeholder values
922
+ #
923
+ # resp = client.update_user_phone_config({
924
+ # phone_config: { # required
925
+ # phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
926
+ # auto_accept: false,
927
+ # after_contact_work_time_limit: 1,
928
+ # desk_phone_number: "PhoneNumber",
929
+ # },
930
+ # user_id: "UserId", # required
931
+ # instance_id: "InstanceId", # required
932
+ # })
933
+ #
934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserPhoneConfig AWS API Documentation
935
+ #
936
+ # @overload update_user_phone_config(params = {})
937
+ # @param [Hash] params ({})
938
+ def update_user_phone_config(params = {}, options = {})
939
+ req = build_request(:update_user_phone_config, params)
940
+ req.send_request(options)
941
+ end
942
+
943
+ # Assigns the specified routing profile to a user.
944
+ #
945
+ # @option params [required, String] :routing_profile_id
946
+ # The identifier of the routing profile to assign to the user.
947
+ #
948
+ # @option params [required, String] :user_id
949
+ # The identifier for the user account to assign the routing profile to.
950
+ #
951
+ # @option params [required, String] :instance_id
952
+ # The identifier for your Amazon Connect instance. To find the ID of
953
+ # your instance, open the AWS console and select Amazon Connect. Select
954
+ # the alias of the instance in the Instance alias column. The instance
955
+ # ID is displayed in the Overview section of your instance settings. For
956
+ # example, the instance ID is the set of characters at the end of the
957
+ # instance ARN, after instance/, such as
958
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
959
+ #
960
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
961
+ #
962
+ # @example Request syntax with placeholder values
963
+ #
964
+ # resp = client.update_user_routing_profile({
965
+ # routing_profile_id: "RoutingProfileId", # required
966
+ # user_id: "UserId", # required
967
+ # instance_id: "InstanceId", # required
968
+ # })
969
+ #
970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserRoutingProfile AWS API Documentation
971
+ #
972
+ # @overload update_user_routing_profile(params = {})
973
+ # @param [Hash] params ({})
974
+ def update_user_routing_profile(params = {}, options = {})
975
+ req = build_request(:update_user_routing_profile, params)
976
+ req.send_request(options)
977
+ end
978
+
979
+ # Update the security profiles assigned to the user.
980
+ #
981
+ # @option params [required, Array<String>] :security_profile_ids
982
+ # The identifiers for the security profiles to assign to the user.
983
+ #
984
+ # @option params [required, String] :user_id
985
+ # The identifier of the user account to assign the security profiles.
986
+ #
987
+ # @option params [required, String] :instance_id
988
+ # The identifier for your Amazon Connect instance. To find the ID of
989
+ # your instance, open the AWS console and select Amazon Connect. Select
990
+ # the alias of the instance in the Instance alias column. The instance
991
+ # ID is displayed in the Overview section of your instance settings. For
992
+ # example, the instance ID is the set of characters at the end of the
993
+ # instance ARN, after instance/, such as
994
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
995
+ #
996
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
997
+ #
998
+ # @example Request syntax with placeholder values
999
+ #
1000
+ # resp = client.update_user_security_profiles({
1001
+ # security_profile_ids: ["SecurityProfileId"], # required
1002
+ # user_id: "UserId", # required
1003
+ # instance_id: "InstanceId", # required
1004
+ # })
1005
+ #
1006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserSecurityProfiles AWS API Documentation
1007
+ #
1008
+ # @overload update_user_security_profiles(params = {})
1009
+ # @param [Hash] params ({})
1010
+ def update_user_security_profiles(params = {}, options = {})
1011
+ req = build_request(:update_user_security_profiles, params)
1012
+ req.send_request(options)
1013
+ end
1014
+
301
1015
  # @!endgroup
302
1016
 
303
1017
  # @param params ({})
@@ -311,7 +1025,7 @@ module Aws::Connect
311
1025
  params: params,
312
1026
  config: config)
313
1027
  context[:gem_name] = 'aws-sdk-connect'
314
- context[:gem_version] = '1.1.0'
1028
+ context[:gem_version] = '1.2.0'
315
1029
  Seahorse::Client::Request.new(handlers, context)
316
1030
  end
317
1031