aws-sdk-connect 1.30.0 → 1.35.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +3 -2
- data/lib/aws-sdk-connect/client.rb +975 -25
- data/lib/aws-sdk-connect/client_api.rb +517 -0
- data/lib/aws-sdk-connect/errors.rb +58 -0
- data/lib/aws-sdk-connect/types.rb +1371 -88
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5e90171b4284015d7574567e8e1048010ea1890ec83e2217a00add04ba261c97
|
4
|
+
data.tar.gz: 3ed0c6e36355db6bbf4c01f0085922ea0041cf4fa1daeac42f35c5aab27574e9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e900f9de06bd10cce0e68690404751072f7d4082714bf9690466ed1a0d1c6cc4bdc7260af69b9cc2738b78708eaf3f39c73ef2717b899493d0b35b8ae4d59f2c
|
7
|
+
data.tar.gz: bacd11edf9df22d37f6824a91e2d1a8e2c9925aa99cc0f9d663e2ece7ee1b337d7438df4c9f7bd64b8f2eb1c0a478c0c633c2caf5aa591d8f65dc9174e378bcd
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -27,7 +28,7 @@ require_relative 'aws-sdk-connect/customizations'
|
|
27
28
|
# structure.
|
28
29
|
#
|
29
30
|
# connect = Aws::Connect::Client.new
|
30
|
-
# resp = connect.
|
31
|
+
# resp = connect.associate_routing_profile_queues(params)
|
31
32
|
#
|
32
33
|
# See {Client} for more information.
|
33
34
|
#
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-connect/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::Connect
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.35.0'
|
51
52
|
|
52
53
|
end
|
@@ -327,8 +327,193 @@ module Aws::Connect
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# Associates a set of queues with a routing profile.
|
331
|
+
#
|
332
|
+
# @option params [required, String] :instance_id
|
333
|
+
# The identifier of the Amazon Connect instance.
|
334
|
+
#
|
335
|
+
# @option params [required, String] :routing_profile_id
|
336
|
+
# The identifier of the routing profile.
|
337
|
+
#
|
338
|
+
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
339
|
+
# The queues to associate with this routing profile.
|
340
|
+
#
|
341
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
342
|
+
#
|
343
|
+
# @example Request syntax with placeholder values
|
344
|
+
#
|
345
|
+
# resp = client.associate_routing_profile_queues({
|
346
|
+
# instance_id: "InstanceId", # required
|
347
|
+
# routing_profile_id: "RoutingProfileId", # required
|
348
|
+
# queue_configs: [ # required
|
349
|
+
# {
|
350
|
+
# queue_reference: { # required
|
351
|
+
# queue_id: "QueueId", # required
|
352
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
353
|
+
# },
|
354
|
+
# priority: 1, # required
|
355
|
+
# delay: 1, # required
|
356
|
+
# },
|
357
|
+
# ],
|
358
|
+
# })
|
359
|
+
#
|
360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateRoutingProfileQueues AWS API Documentation
|
361
|
+
#
|
362
|
+
# @overload associate_routing_profile_queues(params = {})
|
363
|
+
# @param [Hash] params ({})
|
364
|
+
def associate_routing_profile_queues(params = {}, options = {})
|
365
|
+
req = build_request(:associate_routing_profile_queues, params)
|
366
|
+
req.send_request(options)
|
367
|
+
end
|
368
|
+
|
369
|
+
# Creates a contact flow for the specified Amazon Connect instance.
|
370
|
+
#
|
371
|
+
# You can also create and update contact flows using the [Amazon Connect
|
372
|
+
# Flow language][1].
|
373
|
+
#
|
374
|
+
#
|
375
|
+
#
|
376
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
377
|
+
#
|
378
|
+
# @option params [required, String] :instance_id
|
379
|
+
# The identifier of the Amazon Connect instance.
|
380
|
+
#
|
381
|
+
# @option params [required, String] :name
|
382
|
+
# The name of the contact flow.
|
383
|
+
#
|
384
|
+
# @option params [required, String] :type
|
385
|
+
# The type of the contact flow. For descriptions of the available types,
|
386
|
+
# see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
387
|
+
# Administrator Guide*.
|
388
|
+
#
|
389
|
+
#
|
390
|
+
#
|
391
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
392
|
+
#
|
393
|
+
# @option params [String] :description
|
394
|
+
# The description of the contact flow.
|
395
|
+
#
|
396
|
+
# @option params [required, String] :content
|
397
|
+
# The content of the contact flow.
|
398
|
+
#
|
399
|
+
# @option params [Hash<String,String>] :tags
|
400
|
+
# One or more tags.
|
401
|
+
#
|
402
|
+
# @return [Types::CreateContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
403
|
+
#
|
404
|
+
# * {Types::CreateContactFlowResponse#contact_flow_id #contact_flow_id} => String
|
405
|
+
# * {Types::CreateContactFlowResponse#contact_flow_arn #contact_flow_arn} => String
|
406
|
+
#
|
407
|
+
# @example Request syntax with placeholder values
|
408
|
+
#
|
409
|
+
# resp = client.create_contact_flow({
|
410
|
+
# instance_id: "InstanceId", # required
|
411
|
+
# name: "ContactFlowName", # required
|
412
|
+
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
413
|
+
# description: "ContactFlowDescription",
|
414
|
+
# content: "ContactFlowContent", # required
|
415
|
+
# tags: {
|
416
|
+
# "TagKey" => "TagValue",
|
417
|
+
# },
|
418
|
+
# })
|
419
|
+
#
|
420
|
+
# @example Response structure
|
421
|
+
#
|
422
|
+
# resp.contact_flow_id #=> String
|
423
|
+
# resp.contact_flow_arn #=> String
|
424
|
+
#
|
425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlow AWS API Documentation
|
426
|
+
#
|
427
|
+
# @overload create_contact_flow(params = {})
|
428
|
+
# @param [Hash] params ({})
|
429
|
+
def create_contact_flow(params = {}, options = {})
|
430
|
+
req = build_request(:create_contact_flow, params)
|
431
|
+
req.send_request(options)
|
432
|
+
end
|
433
|
+
|
434
|
+
# Creates a new routing profile.
|
435
|
+
#
|
436
|
+
# @option params [required, String] :instance_id
|
437
|
+
# The identifier of the Amazon Connect instance.
|
438
|
+
#
|
439
|
+
# @option params [required, String] :name
|
440
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
441
|
+
#
|
442
|
+
# @option params [required, String] :description
|
443
|
+
# Description of the routing profile. Must not be more than 250
|
444
|
+
# characters.
|
445
|
+
#
|
446
|
+
# @option params [required, String] :default_outbound_queue_id
|
447
|
+
# The default outbound queue for the routing profile.
|
448
|
+
#
|
449
|
+
# @option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
450
|
+
# The inbound queues associated with the routing profile. If no queue is
|
451
|
+
# added, the agent can only make outbound calls.
|
452
|
+
#
|
453
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
454
|
+
# The channels agents can handle in the Contact Control Panel (CCP) for
|
455
|
+
# this routing profile.
|
456
|
+
#
|
457
|
+
# @option params [Hash<String,String>] :tags
|
458
|
+
# One or more tags.
|
459
|
+
#
|
460
|
+
# @return [Types::CreateRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
461
|
+
#
|
462
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_arn #routing_profile_arn} => String
|
463
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_id #routing_profile_id} => String
|
464
|
+
#
|
465
|
+
# @example Request syntax with placeholder values
|
466
|
+
#
|
467
|
+
# resp = client.create_routing_profile({
|
468
|
+
# instance_id: "InstanceId", # required
|
469
|
+
# name: "RoutingProfileName", # required
|
470
|
+
# description: "RoutingProfileDescription", # required
|
471
|
+
# default_outbound_queue_id: "QueueId", # required
|
472
|
+
# queue_configs: [
|
473
|
+
# {
|
474
|
+
# queue_reference: { # required
|
475
|
+
# queue_id: "QueueId", # required
|
476
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
477
|
+
# },
|
478
|
+
# priority: 1, # required
|
479
|
+
# delay: 1, # required
|
480
|
+
# },
|
481
|
+
# ],
|
482
|
+
# media_concurrencies: [ # required
|
483
|
+
# {
|
484
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
485
|
+
# concurrency: 1, # required
|
486
|
+
# },
|
487
|
+
# ],
|
488
|
+
# tags: {
|
489
|
+
# "TagKey" => "TagValue",
|
490
|
+
# },
|
491
|
+
# })
|
492
|
+
#
|
493
|
+
# @example Response structure
|
494
|
+
#
|
495
|
+
# resp.routing_profile_arn #=> String
|
496
|
+
# resp.routing_profile_id #=> String
|
497
|
+
#
|
498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfile AWS API Documentation
|
499
|
+
#
|
500
|
+
# @overload create_routing_profile(params = {})
|
501
|
+
# @param [Hash] params ({})
|
502
|
+
def create_routing_profile(params = {}, options = {})
|
503
|
+
req = build_request(:create_routing_profile, params)
|
504
|
+
req.send_request(options)
|
505
|
+
end
|
506
|
+
|
330
507
|
# Creates a user account for the specified Amazon Connect instance.
|
331
508
|
#
|
509
|
+
# For information about how to create user accounts using the Amazon
|
510
|
+
# Connect console, see [Add Users][1] in the *Amazon Connect
|
511
|
+
# Administrator Guide*.
|
512
|
+
#
|
513
|
+
#
|
514
|
+
#
|
515
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html
|
516
|
+
#
|
332
517
|
# @option params [required, String] :username
|
333
518
|
# The user name for the account. For instances not using SAML for
|
334
519
|
# identity management, the user name can include up to 20 characters. If
|
@@ -419,8 +604,56 @@ module Aws::Connect
|
|
419
604
|
req.send_request(options)
|
420
605
|
end
|
421
606
|
|
607
|
+
# Creates a new user hierarchy group.
|
608
|
+
#
|
609
|
+
# @option params [required, String] :name
|
610
|
+
# The name of the user hierarchy group. Must not be more than 100
|
611
|
+
# characters.
|
612
|
+
#
|
613
|
+
# @option params [String] :parent_group_id
|
614
|
+
# The identifier for the parent hierarchy group. The user hierarchy is
|
615
|
+
# created at level one if the parent group ID is null.
|
616
|
+
#
|
617
|
+
# @option params [required, String] :instance_id
|
618
|
+
# The identifier of the Amazon Connect instance.
|
619
|
+
#
|
620
|
+
# @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
621
|
+
#
|
622
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_id #hierarchy_group_id} => String
|
623
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_arn #hierarchy_group_arn} => String
|
624
|
+
#
|
625
|
+
# @example Request syntax with placeholder values
|
626
|
+
#
|
627
|
+
# resp = client.create_user_hierarchy_group({
|
628
|
+
# name: "HierarchyGroupName", # required
|
629
|
+
# parent_group_id: "HierarchyGroupId",
|
630
|
+
# instance_id: "InstanceId", # required
|
631
|
+
# })
|
632
|
+
#
|
633
|
+
# @example Response structure
|
634
|
+
#
|
635
|
+
# resp.hierarchy_group_id #=> String
|
636
|
+
# resp.hierarchy_group_arn #=> String
|
637
|
+
#
|
638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroup AWS API Documentation
|
639
|
+
#
|
640
|
+
# @overload create_user_hierarchy_group(params = {})
|
641
|
+
# @param [Hash] params ({})
|
642
|
+
def create_user_hierarchy_group(params = {}, options = {})
|
643
|
+
req = build_request(:create_user_hierarchy_group, params)
|
644
|
+
req.send_request(options)
|
645
|
+
end
|
646
|
+
|
422
647
|
# Deletes a user account from the specified Amazon Connect instance.
|
423
648
|
#
|
649
|
+
# For information about what happens to a user's data when their
|
650
|
+
# account is deleted, see [Delete Users from Your Amazon Connect
|
651
|
+
# Instance][1] in the *Amazon Connect Administrator Guide*.
|
652
|
+
#
|
653
|
+
#
|
654
|
+
#
|
655
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
|
656
|
+
#
|
424
657
|
# @option params [required, String] :instance_id
|
425
658
|
# The identifier of the Amazon Connect instance.
|
426
659
|
#
|
@@ -445,6 +678,121 @@ module Aws::Connect
|
|
445
678
|
req.send_request(options)
|
446
679
|
end
|
447
680
|
|
681
|
+
# Deletes an existing user hierarchy group. It must not be associated
|
682
|
+
# with any agents or have any active child groups.
|
683
|
+
#
|
684
|
+
# @option params [required, String] :hierarchy_group_id
|
685
|
+
# The identifier of the hierarchy group.
|
686
|
+
#
|
687
|
+
# @option params [required, String] :instance_id
|
688
|
+
# The identifier of the Amazon Connect instance.
|
689
|
+
#
|
690
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
691
|
+
#
|
692
|
+
# @example Request syntax with placeholder values
|
693
|
+
#
|
694
|
+
# resp = client.delete_user_hierarchy_group({
|
695
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
696
|
+
# instance_id: "InstanceId", # required
|
697
|
+
# })
|
698
|
+
#
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserHierarchyGroup AWS API Documentation
|
700
|
+
#
|
701
|
+
# @overload delete_user_hierarchy_group(params = {})
|
702
|
+
# @param [Hash] params ({})
|
703
|
+
def delete_user_hierarchy_group(params = {}, options = {})
|
704
|
+
req = build_request(:delete_user_hierarchy_group, params)
|
705
|
+
req.send_request(options)
|
706
|
+
end
|
707
|
+
|
708
|
+
# Describes the specified contact flow.
|
709
|
+
#
|
710
|
+
# You can also create and update contact flows using the [Amazon Connect
|
711
|
+
# Flow language][1].
|
712
|
+
#
|
713
|
+
#
|
714
|
+
#
|
715
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
716
|
+
#
|
717
|
+
# @option params [required, String] :instance_id
|
718
|
+
# The identifier of the Amazon Connect instance.
|
719
|
+
#
|
720
|
+
# @option params [required, String] :contact_flow_id
|
721
|
+
# The identifier of the contact flow.
|
722
|
+
#
|
723
|
+
# @return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
724
|
+
#
|
725
|
+
# * {Types::DescribeContactFlowResponse#contact_flow #contact_flow} => Types::ContactFlow
|
726
|
+
#
|
727
|
+
# @example Request syntax with placeholder values
|
728
|
+
#
|
729
|
+
# resp = client.describe_contact_flow({
|
730
|
+
# instance_id: "InstanceId", # required
|
731
|
+
# contact_flow_id: "ContactFlowId", # required
|
732
|
+
# })
|
733
|
+
#
|
734
|
+
# @example Response structure
|
735
|
+
#
|
736
|
+
# resp.contact_flow.arn #=> String
|
737
|
+
# resp.contact_flow.id #=> String
|
738
|
+
# resp.contact_flow.name #=> String
|
739
|
+
# resp.contact_flow.type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
|
740
|
+
# resp.contact_flow.description #=> String
|
741
|
+
# resp.contact_flow.content #=> String
|
742
|
+
# resp.contact_flow.tags #=> Hash
|
743
|
+
# resp.contact_flow.tags["TagKey"] #=> String
|
744
|
+
#
|
745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlow AWS API Documentation
|
746
|
+
#
|
747
|
+
# @overload describe_contact_flow(params = {})
|
748
|
+
# @param [Hash] params ({})
|
749
|
+
def describe_contact_flow(params = {}, options = {})
|
750
|
+
req = build_request(:describe_contact_flow, params)
|
751
|
+
req.send_request(options)
|
752
|
+
end
|
753
|
+
|
754
|
+
# Describes the specified routing profile.
|
755
|
+
#
|
756
|
+
# @option params [required, String] :instance_id
|
757
|
+
# The identifier of the Amazon Connect instance.
|
758
|
+
#
|
759
|
+
# @option params [required, String] :routing_profile_id
|
760
|
+
# The identifier of the routing profile.
|
761
|
+
#
|
762
|
+
# @return [Types::DescribeRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
763
|
+
#
|
764
|
+
# * {Types::DescribeRoutingProfileResponse#routing_profile #routing_profile} => Types::RoutingProfile
|
765
|
+
#
|
766
|
+
# @example Request syntax with placeholder values
|
767
|
+
#
|
768
|
+
# resp = client.describe_routing_profile({
|
769
|
+
# instance_id: "InstanceId", # required
|
770
|
+
# routing_profile_id: "RoutingProfileId", # required
|
771
|
+
# })
|
772
|
+
#
|
773
|
+
# @example Response structure
|
774
|
+
#
|
775
|
+
# resp.routing_profile.instance_id #=> String
|
776
|
+
# resp.routing_profile.name #=> String
|
777
|
+
# resp.routing_profile.routing_profile_arn #=> String
|
778
|
+
# resp.routing_profile.routing_profile_id #=> String
|
779
|
+
# resp.routing_profile.description #=> String
|
780
|
+
# resp.routing_profile.media_concurrencies #=> Array
|
781
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT"
|
782
|
+
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
783
|
+
# resp.routing_profile.default_outbound_queue_id #=> String
|
784
|
+
# resp.routing_profile.tags #=> Hash
|
785
|
+
# resp.routing_profile.tags["TagKey"] #=> String
|
786
|
+
#
|
787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
|
788
|
+
#
|
789
|
+
# @overload describe_routing_profile(params = {})
|
790
|
+
# @param [Hash] params ({})
|
791
|
+
def describe_routing_profile(params = {}, options = {})
|
792
|
+
req = build_request(:describe_routing_profile, params)
|
793
|
+
req.send_request(options)
|
794
|
+
end
|
795
|
+
|
448
796
|
# Describes the specified user account. You can find the instance ID in
|
449
797
|
# the console (it’s the final part of the ARN). The console does not
|
450
798
|
# display the user IDs. Instead, list the users and note the IDs
|
@@ -589,6 +937,41 @@ module Aws::Connect
|
|
589
937
|
req.send_request(options)
|
590
938
|
end
|
591
939
|
|
940
|
+
# Disassociates a set of queues from a routing profile.
|
941
|
+
#
|
942
|
+
# @option params [required, String] :instance_id
|
943
|
+
# The identifier of the Amazon Connect instance.
|
944
|
+
#
|
945
|
+
# @option params [required, String] :routing_profile_id
|
946
|
+
# The identifier of the routing profile.
|
947
|
+
#
|
948
|
+
# @option params [required, Array<Types::RoutingProfileQueueReference>] :queue_references
|
949
|
+
# The queues to disassociate from this routing profile.
|
950
|
+
#
|
951
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
952
|
+
#
|
953
|
+
# @example Request syntax with placeholder values
|
954
|
+
#
|
955
|
+
# resp = client.disassociate_routing_profile_queues({
|
956
|
+
# instance_id: "InstanceId", # required
|
957
|
+
# routing_profile_id: "RoutingProfileId", # required
|
958
|
+
# queue_references: [ # required
|
959
|
+
# {
|
960
|
+
# queue_id: "QueueId", # required
|
961
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
962
|
+
# },
|
963
|
+
# ],
|
964
|
+
# })
|
965
|
+
#
|
966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueues AWS API Documentation
|
967
|
+
#
|
968
|
+
# @overload disassociate_routing_profile_queues(params = {})
|
969
|
+
# @param [Hash] params ({})
|
970
|
+
def disassociate_routing_profile_queues(params = {}, options = {})
|
971
|
+
req = build_request(:disassociate_routing_profile_queues, params)
|
972
|
+
req.send_request(options)
|
973
|
+
end
|
974
|
+
|
592
975
|
# Retrieves the contact attributes for the specified contact.
|
593
976
|
#
|
594
977
|
# @option params [required, String] :instance_id
|
@@ -625,12 +1008,12 @@ module Aws::Connect
|
|
625
1008
|
# Gets the real-time metric data from the specified Amazon Connect
|
626
1009
|
# instance.
|
627
1010
|
#
|
628
|
-
# For
|
629
|
-
# *Amazon Connect Administrator Guide*.
|
1011
|
+
# For a description of each metric, see [Real-time Metrics
|
1012
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
630
1013
|
#
|
631
1014
|
#
|
632
1015
|
#
|
633
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-
|
1016
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
634
1017
|
#
|
635
1018
|
# @option params [required, String] :instance_id
|
636
1019
|
# The identifier of the Amazon Connect instance.
|
@@ -639,79 +1022,126 @@ module Aws::Connect
|
|
639
1022
|
# The queues, up to 100, or channels, to use to filter the metrics
|
640
1023
|
# returned. Metric data is retrieved only for the resources associated
|
641
1024
|
# with the queues or channels included in the filter. You can include
|
642
|
-
# both queue IDs and queue ARNs in the same request.
|
643
|
-
#
|
1025
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1026
|
+
# `CHAT` channels are supported.
|
644
1027
|
#
|
645
1028
|
# @option params [Array<String>] :groupings
|
646
1029
|
# The grouping applied to the metrics returned. For example, when
|
647
1030
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
648
1031
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
649
|
-
# include a Channels filter.
|
1032
|
+
# include a Channels filter. Both `VOICE` and `CHAT` channels are
|
1033
|
+
# supported.
|
650
1034
|
#
|
651
1035
|
# If no `Grouping` is included in the request, a summary of metrics is
|
652
1036
|
# returned.
|
653
1037
|
#
|
654
1038
|
# @option params [required, Array<Types::CurrentMetric>] :current_metrics
|
655
1039
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
656
|
-
# The following metrics are available. For a description of
|
657
|
-
# see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
1040
|
+
# The following metrics are available. For a description of all the
|
1041
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
658
1042
|
# Administrator Guide*.
|
659
1043
|
#
|
660
1044
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
661
1045
|
#
|
662
1046
|
# : Unit: COUNT
|
663
1047
|
#
|
1048
|
+
# Name in real-time metrics report: [ACW][2]
|
1049
|
+
#
|
664
1050
|
# AGENTS\_AVAILABLE
|
665
1051
|
#
|
666
1052
|
# : Unit: COUNT
|
667
1053
|
#
|
1054
|
+
# Name in real-time metrics report: [Available][3]
|
1055
|
+
#
|
668
1056
|
# AGENTS\_ERROR
|
669
1057
|
#
|
670
1058
|
# : Unit: COUNT
|
671
1059
|
#
|
1060
|
+
# Name in real-time metrics report: [Error][4]
|
1061
|
+
#
|
672
1062
|
# AGENTS\_NON\_PRODUCTIVE
|
673
1063
|
#
|
674
1064
|
# : Unit: COUNT
|
675
1065
|
#
|
1066
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
1067
|
+
#
|
676
1068
|
# AGENTS\_ON\_CALL
|
677
1069
|
#
|
678
1070
|
# : Unit: COUNT
|
679
1071
|
#
|
1072
|
+
# Name in real-time metrics report: [On contact][6]
|
1073
|
+
#
|
680
1074
|
# AGENTS\_ON\_CONTACT
|
681
1075
|
#
|
682
1076
|
# : Unit: COUNT
|
683
1077
|
#
|
1078
|
+
# Name in real-time metrics report: [On contact][6]
|
1079
|
+
#
|
684
1080
|
# AGENTS\_ONLINE
|
685
1081
|
#
|
686
1082
|
# : Unit: COUNT
|
687
1083
|
#
|
1084
|
+
# Name in real-time metrics report: [Online][7]
|
1085
|
+
#
|
688
1086
|
# AGENTS\_STAFFED
|
689
1087
|
#
|
690
1088
|
# : Unit: COUNT
|
691
1089
|
#
|
1090
|
+
# Name in real-time metrics report: [Staffed][8]
|
1091
|
+
#
|
692
1092
|
# CONTACTS\_IN\_QUEUE
|
693
1093
|
#
|
694
1094
|
# : Unit: COUNT
|
695
1095
|
#
|
1096
|
+
# Name in real-time metrics report: [In queue][9]
|
1097
|
+
#
|
696
1098
|
# CONTACTS\_SCHEDULED
|
697
1099
|
#
|
698
1100
|
# : Unit: COUNT
|
699
1101
|
#
|
1102
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1103
|
+
#
|
700
1104
|
# OLDEST\_CONTACT\_AGE
|
701
1105
|
#
|
702
1106
|
# : Unit: SECONDS
|
703
1107
|
#
|
1108
|
+
# When you use groupings, Unit says SECONDS but the Value is returned
|
1109
|
+
# in MILLISECONDS. For example, if you get a response like this:
|
1110
|
+
#
|
1111
|
+
# `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \},
|
1112
|
+
# "Value": 24113.0 `\\}
|
1113
|
+
#
|
1114
|
+
# The actual OLDEST\_CONTACT\_AGE is 24 seconds.
|
1115
|
+
#
|
1116
|
+
# Name in real-time metrics report: [Oldest][11]
|
1117
|
+
#
|
704
1118
|
# SLOTS\_ACTIVE
|
705
1119
|
#
|
706
1120
|
# : Unit: COUNT
|
707
1121
|
#
|
1122
|
+
# Name in real-time metrics report: [Active][12]
|
1123
|
+
#
|
708
1124
|
# SLOTS\_AVAILABLE
|
709
1125
|
#
|
710
1126
|
# : Unit: COUNT
|
711
1127
|
#
|
1128
|
+
# Name in real-time metrics report: [Availability][13]
|
1129
|
+
#
|
712
1130
|
#
|
713
1131
|
#
|
714
1132
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
1133
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
|
1134
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
|
1135
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
|
1136
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
|
1137
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
|
1138
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
|
1139
|
+
# [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
|
1140
|
+
# [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
|
1141
|
+
# [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
|
1142
|
+
# [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
|
1143
|
+
# [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
|
1144
|
+
# [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
|
715
1145
|
#
|
716
1146
|
# @option params [String] :next_token
|
717
1147
|
# The token for the next set of results. Use the value returned in the
|
@@ -808,12 +1238,12 @@ module Aws::Connect
|
|
808
1238
|
# Gets historical metric data from the specified Amazon Connect
|
809
1239
|
# instance.
|
810
1240
|
#
|
811
|
-
# For
|
812
|
-
# *Amazon Connect Administrator Guide*.
|
1241
|
+
# For a description of each historical metric, see [Historical Metrics
|
1242
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
813
1243
|
#
|
814
1244
|
#
|
815
1245
|
#
|
816
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html
|
1246
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
817
1247
|
#
|
818
1248
|
# @option params [required, String] :instance_id
|
819
1249
|
# The identifier of the Amazon Connect instance.
|
@@ -840,8 +1270,8 @@ module Aws::Connect
|
|
840
1270
|
# The queues, up to 100, or channels, to use to filter the metrics
|
841
1271
|
# returned. Metric data is retrieved only for the resources associated
|
842
1272
|
# with the queues or channels included in the filter. You can include
|
843
|
-
# both queue IDs and queue ARNs in the same request.
|
844
|
-
#
|
1273
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1274
|
+
# `CHAT` channels are supported.
|
845
1275
|
#
|
846
1276
|
# @option params [Array<String>] :groupings
|
847
1277
|
# The grouping applied to the metrics returned. For example, when
|
@@ -1086,6 +1516,17 @@ module Aws::Connect
|
|
1086
1516
|
# Provides information about the contact flows for the specified Amazon
|
1087
1517
|
# Connect instance.
|
1088
1518
|
#
|
1519
|
+
# You can also create and update contact flows using the [Amazon Connect
|
1520
|
+
# Flow language][1].
|
1521
|
+
#
|
1522
|
+
# For more information about contact flows, see [Contact Flows][2] in
|
1523
|
+
# the *Amazon Connect Administrator Guide*.
|
1524
|
+
#
|
1525
|
+
#
|
1526
|
+
#
|
1527
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
1528
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
1529
|
+
#
|
1089
1530
|
# @option params [required, String] :instance_id
|
1090
1531
|
# The identifier of the Amazon Connect instance.
|
1091
1532
|
#
|
@@ -1137,6 +1578,13 @@ module Aws::Connect
|
|
1137
1578
|
# Provides information about the hours of operation for the specified
|
1138
1579
|
# Amazon Connect instance.
|
1139
1580
|
#
|
1581
|
+
# For more information about hours of operation, see [Set the Hours of
|
1582
|
+
# Operation for a Queue][1] in the *Amazon Connect Administrator Guide*.
|
1583
|
+
#
|
1584
|
+
#
|
1585
|
+
#
|
1586
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
|
1587
|
+
#
|
1140
1588
|
# @option params [required, String] :instance_id
|
1141
1589
|
# The identifier of the Amazon Connect instance.
|
1142
1590
|
#
|
@@ -1183,6 +1631,14 @@ module Aws::Connect
|
|
1183
1631
|
# Provides information about the phone numbers for the specified Amazon
|
1184
1632
|
# Connect instance.
|
1185
1633
|
#
|
1634
|
+
# For more information about phone numbers, see [Set Up Phone Numbers
|
1635
|
+
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
1636
|
+
# Guide*.
|
1637
|
+
#
|
1638
|
+
#
|
1639
|
+
#
|
1640
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
1641
|
+
#
|
1186
1642
|
# @option params [required, String] :instance_id
|
1187
1643
|
# The identifier of the Amazon Connect instance.
|
1188
1644
|
#
|
@@ -1236,26 +1692,79 @@ module Aws::Connect
|
|
1236
1692
|
req.send_request(options)
|
1237
1693
|
end
|
1238
1694
|
|
1239
|
-
# Provides information about the
|
1240
|
-
# instance.
|
1695
|
+
# Provides information about the prompts for the specified Amazon
|
1696
|
+
# Connect instance.
|
1241
1697
|
#
|
1242
1698
|
# @option params [required, String] :instance_id
|
1243
1699
|
# The identifier of the Amazon Connect instance.
|
1244
1700
|
#
|
1245
|
-
# @option params [Array<String>] :queue_types
|
1246
|
-
# The type of queue.
|
1247
|
-
#
|
1248
1701
|
# @option params [String] :next_token
|
1249
1702
|
# The token for the next set of results. Use the value returned in the
|
1250
1703
|
# previous response in the next request to retrieve the next set of
|
1251
1704
|
# results.
|
1252
1705
|
#
|
1253
1706
|
# @option params [Integer] :max_results
|
1254
|
-
# The
|
1707
|
+
# The maximum number of results to return per page.
|
1255
1708
|
#
|
1256
|
-
# @return [Types::
|
1709
|
+
# @return [Types::ListPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1257
1710
|
#
|
1258
|
-
# * {Types::
|
1711
|
+
# * {Types::ListPromptsResponse#prompt_summary_list #prompt_summary_list} => Array<Types::PromptSummary>
|
1712
|
+
# * {Types::ListPromptsResponse#next_token #next_token} => String
|
1713
|
+
#
|
1714
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1715
|
+
#
|
1716
|
+
# @example Request syntax with placeholder values
|
1717
|
+
#
|
1718
|
+
# resp = client.list_prompts({
|
1719
|
+
# instance_id: "InstanceId", # required
|
1720
|
+
# next_token: "NextToken",
|
1721
|
+
# max_results: 1,
|
1722
|
+
# })
|
1723
|
+
#
|
1724
|
+
# @example Response structure
|
1725
|
+
#
|
1726
|
+
# resp.prompt_summary_list #=> Array
|
1727
|
+
# resp.prompt_summary_list[0].id #=> String
|
1728
|
+
# resp.prompt_summary_list[0].arn #=> String
|
1729
|
+
# resp.prompt_summary_list[0].name #=> String
|
1730
|
+
# resp.next_token #=> String
|
1731
|
+
#
|
1732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPrompts AWS API Documentation
|
1733
|
+
#
|
1734
|
+
# @overload list_prompts(params = {})
|
1735
|
+
# @param [Hash] params ({})
|
1736
|
+
def list_prompts(params = {}, options = {})
|
1737
|
+
req = build_request(:list_prompts, params)
|
1738
|
+
req.send_request(options)
|
1739
|
+
end
|
1740
|
+
|
1741
|
+
# Provides information about the queues for the specified Amazon Connect
|
1742
|
+
# instance.
|
1743
|
+
#
|
1744
|
+
# For more information about queues, see [Queues: Standard and Agent][1]
|
1745
|
+
# in the *Amazon Connect Administrator Guide*.
|
1746
|
+
#
|
1747
|
+
#
|
1748
|
+
#
|
1749
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html
|
1750
|
+
#
|
1751
|
+
# @option params [required, String] :instance_id
|
1752
|
+
# The identifier of the Amazon Connect instance.
|
1753
|
+
#
|
1754
|
+
# @option params [Array<String>] :queue_types
|
1755
|
+
# The type of queue.
|
1756
|
+
#
|
1757
|
+
# @option params [String] :next_token
|
1758
|
+
# The token for the next set of results. Use the value returned in the
|
1759
|
+
# previous response in the next request to retrieve the next set of
|
1760
|
+
# results.
|
1761
|
+
#
|
1762
|
+
# @option params [Integer] :max_results
|
1763
|
+
# The maximimum number of results to return per page.
|
1764
|
+
#
|
1765
|
+
# @return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1766
|
+
#
|
1767
|
+
# * {Types::ListQueuesResponse#queue_summary_list #queue_summary_list} => Array<Types::QueueSummary>
|
1259
1768
|
# * {Types::ListQueuesResponse#next_token #next_token} => String
|
1260
1769
|
#
|
1261
1770
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1287,9 +1796,70 @@ module Aws::Connect
|
|
1287
1796
|
req.send_request(options)
|
1288
1797
|
end
|
1289
1798
|
|
1799
|
+
# List the queues associated with a routing profile.
|
1800
|
+
#
|
1801
|
+
# @option params [required, String] :instance_id
|
1802
|
+
# The identifier of the Amazon Connect instance.
|
1803
|
+
#
|
1804
|
+
# @option params [required, String] :routing_profile_id
|
1805
|
+
# The identifier of the routing profile.
|
1806
|
+
#
|
1807
|
+
# @option params [String] :next_token
|
1808
|
+
# The token for the next set of results. Use the value returned in the
|
1809
|
+
# previous response in the next request to retrieve the next set of
|
1810
|
+
# results.
|
1811
|
+
#
|
1812
|
+
# @option params [Integer] :max_results
|
1813
|
+
# The maximimum number of results to return per page.
|
1814
|
+
#
|
1815
|
+
# @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1816
|
+
#
|
1817
|
+
# * {Types::ListRoutingProfileQueuesResponse#next_token #next_token} => String
|
1818
|
+
# * {Types::ListRoutingProfileQueuesResponse#routing_profile_queue_config_summary_list #routing_profile_queue_config_summary_list} => Array<Types::RoutingProfileQueueConfigSummary>
|
1819
|
+
#
|
1820
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1821
|
+
#
|
1822
|
+
# @example Request syntax with placeholder values
|
1823
|
+
#
|
1824
|
+
# resp = client.list_routing_profile_queues({
|
1825
|
+
# instance_id: "InstanceId", # required
|
1826
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1827
|
+
# next_token: "NextToken",
|
1828
|
+
# max_results: 1,
|
1829
|
+
# })
|
1830
|
+
#
|
1831
|
+
# @example Response structure
|
1832
|
+
#
|
1833
|
+
# resp.next_token #=> String
|
1834
|
+
# resp.routing_profile_queue_config_summary_list #=> Array
|
1835
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_id #=> String
|
1836
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_arn #=> String
|
1837
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
1838
|
+
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
1839
|
+
# resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
|
1840
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT"
|
1841
|
+
#
|
1842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
1843
|
+
#
|
1844
|
+
# @overload list_routing_profile_queues(params = {})
|
1845
|
+
# @param [Hash] params ({})
|
1846
|
+
def list_routing_profile_queues(params = {}, options = {})
|
1847
|
+
req = build_request(:list_routing_profile_queues, params)
|
1848
|
+
req.send_request(options)
|
1849
|
+
end
|
1850
|
+
|
1290
1851
|
# Provides summary information about the routing profiles for the
|
1291
1852
|
# specified Amazon Connect instance.
|
1292
1853
|
#
|
1854
|
+
# For more information about routing profiles, see [Routing Profiles][1]
|
1855
|
+
# and [Create a Routing Profile][2] in the *Amazon Connect Administrator
|
1856
|
+
# Guide*.
|
1857
|
+
#
|
1858
|
+
#
|
1859
|
+
#
|
1860
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html
|
1861
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
|
1862
|
+
#
|
1293
1863
|
# @option params [required, String] :instance_id
|
1294
1864
|
# The identifier of the Amazon Connect instance.
|
1295
1865
|
#
|
@@ -1336,6 +1906,13 @@ module Aws::Connect
|
|
1336
1906
|
# Provides summary information about the security profiles for the
|
1337
1907
|
# specified Amazon Connect instance.
|
1338
1908
|
#
|
1909
|
+
# For more information about security profiles, see [Security
|
1910
|
+
# Profiles][1] in the *Amazon Connect Administrator Guide*.
|
1911
|
+
#
|
1912
|
+
#
|
1913
|
+
#
|
1914
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
|
1915
|
+
#
|
1339
1916
|
# @option params [required, String] :instance_id
|
1340
1917
|
# The identifier of the Amazon Connect instance.
|
1341
1918
|
#
|
@@ -1381,6 +1958,13 @@ module Aws::Connect
|
|
1381
1958
|
|
1382
1959
|
# Lists the tags for the specified resource.
|
1383
1960
|
#
|
1961
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
1962
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
1963
|
+
#
|
1964
|
+
#
|
1965
|
+
#
|
1966
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
1967
|
+
#
|
1384
1968
|
# @option params [required, String] :resource_arn
|
1385
1969
|
# The Amazon Resource Name (ARN) of the resource.
|
1386
1970
|
#
|
@@ -1411,6 +1995,13 @@ module Aws::Connect
|
|
1411
1995
|
# Provides summary information about the hierarchy groups for the
|
1412
1996
|
# specified Amazon Connect instance.
|
1413
1997
|
#
|
1998
|
+
# For more information about agent hierarchies, see [Set Up Agent
|
1999
|
+
# Hierarchies][1] in the *Amazon Connect Administrator Guide*.
|
2000
|
+
#
|
2001
|
+
#
|
2002
|
+
#
|
2003
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
|
2004
|
+
#
|
1414
2005
|
# @option params [required, String] :instance_id
|
1415
2006
|
# The identifier of the Amazon Connect instance.
|
1416
2007
|
#
|
@@ -1545,15 +2136,35 @@ module Aws::Connect
|
|
1545
2136
|
# [CreateParticipantConnection][1] with WEBSOCKET and
|
1546
2137
|
# CONNECTION\_CREDENTIALS.
|
1547
2138
|
#
|
2139
|
+
# A 429 error occurs in two situations:
|
2140
|
+
#
|
2141
|
+
# * API rate limit is exceeded. API TPS throttling returns a
|
2142
|
+
# `TooManyRequests` exception from the API Gateway.
|
2143
|
+
#
|
2144
|
+
# * The [quota for concurrent active chats][2] is exceeded. Active chat
|
2145
|
+
# throttling returns a `LimitExceededException`.
|
2146
|
+
#
|
2147
|
+
# For more information about how chat works, see [Chat][3] in the
|
2148
|
+
# *Amazon Connect Administrator Guide*.
|
2149
|
+
#
|
1548
2150
|
#
|
1549
2151
|
#
|
1550
2152
|
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
2153
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
2154
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html
|
1551
2155
|
#
|
1552
2156
|
# @option params [required, String] :instance_id
|
1553
2157
|
# The identifier of the Amazon Connect instance.
|
1554
2158
|
#
|
1555
2159
|
# @option params [required, String] :contact_flow_id
|
1556
|
-
# The identifier of the contact flow for the chat.
|
2160
|
+
# The identifier of the contact flow for initiating the chat. To see the
|
2161
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2162
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2163
|
+
# contact flow. On the contact flow page, under the name of the contact
|
2164
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
2165
|
+
# is the last part of the ARN, shown here in bold:
|
2166
|
+
#
|
2167
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1557
2168
|
#
|
1558
2169
|
# @option params [Hash<String,String>] :attributes
|
1559
2170
|
# A custom key-value pair using an attribute map. The attributes are
|
@@ -1680,11 +2291,29 @@ module Aws::Connect
|
|
1680
2291
|
# There is a 60 second dialing timeout for this operation. If the call
|
1681
2292
|
# is not connected after 60 seconds, it fails.
|
1682
2293
|
#
|
2294
|
+
# <note markdown="1"> UK numbers with a 447 prefix are not allowed by default. Before you
|
2295
|
+
# can dial these UK mobile numbers, you must submit a service quota
|
2296
|
+
# increase request. For more information, see [Amazon Connect Service
|
2297
|
+
# Quotas][1] in the *Amazon Connect Administrator Guide*.
|
2298
|
+
#
|
2299
|
+
# </note>
|
2300
|
+
#
|
2301
|
+
#
|
2302
|
+
#
|
2303
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
2304
|
+
#
|
1683
2305
|
# @option params [required, String] :destination_phone_number
|
1684
2306
|
# The phone number of the customer, in E.164 format.
|
1685
2307
|
#
|
1686
2308
|
# @option params [required, String] :contact_flow_id
|
1687
|
-
# The identifier of the contact flow for the outbound call.
|
2309
|
+
# The identifier of the contact flow for the outbound call. To see the
|
2310
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2311
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2312
|
+
# contact flow. On the contact flow page, under the name of the contact
|
2313
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
2314
|
+
# is the last part of the ARN, shown here in bold:
|
2315
|
+
#
|
2316
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1688
2317
|
#
|
1689
2318
|
# @option params [required, String] :instance_id
|
1690
2319
|
# The identifier of the Amazon Connect instance.
|
@@ -1855,7 +2484,15 @@ module Aws::Connect
|
|
1855
2484
|
|
1856
2485
|
# Adds the specified tags to the specified resource.
|
1857
2486
|
#
|
1858
|
-
# The supported resource
|
2487
|
+
# The supported resource types are users, routing profiles, and contact
|
2488
|
+
# flows.
|
2489
|
+
#
|
2490
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
2491
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
2492
|
+
#
|
2493
|
+
#
|
2494
|
+
#
|
2495
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
1859
2496
|
#
|
1860
2497
|
# @option params [required, String] :resource_arn
|
1861
2498
|
# The Amazon Resource Name (ARN) of the resource.
|
@@ -1970,6 +2607,233 @@ module Aws::Connect
|
|
1970
2607
|
req.send_request(options)
|
1971
2608
|
end
|
1972
2609
|
|
2610
|
+
# Updates the specified contact flow.
|
2611
|
+
#
|
2612
|
+
# You can also create and update contact flows using the [Amazon Connect
|
2613
|
+
# Flow language][1].
|
2614
|
+
#
|
2615
|
+
#
|
2616
|
+
#
|
2617
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
2618
|
+
#
|
2619
|
+
# @option params [required, String] :instance_id
|
2620
|
+
# The identifier of the Amazon Connect instance.
|
2621
|
+
#
|
2622
|
+
# @option params [required, String] :contact_flow_id
|
2623
|
+
# The identifier of the contact flow.
|
2624
|
+
#
|
2625
|
+
# @option params [required, String] :content
|
2626
|
+
# The JSON string that represents contact flow’s content. For an
|
2627
|
+
# example, see [Example contact flow in Amazon Connect Flow language][1]
|
2628
|
+
# in the *Amazon Connect Administrator Guide*.
|
2629
|
+
#
|
2630
|
+
#
|
2631
|
+
#
|
2632
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
|
2633
|
+
#
|
2634
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2635
|
+
#
|
2636
|
+
# @example Request syntax with placeholder values
|
2637
|
+
#
|
2638
|
+
# resp = client.update_contact_flow_content({
|
2639
|
+
# instance_id: "InstanceId", # required
|
2640
|
+
# contact_flow_id: "ContactFlowId", # required
|
2641
|
+
# content: "ContactFlowContent", # required
|
2642
|
+
# })
|
2643
|
+
#
|
2644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContent AWS API Documentation
|
2645
|
+
#
|
2646
|
+
# @overload update_contact_flow_content(params = {})
|
2647
|
+
# @param [Hash] params ({})
|
2648
|
+
def update_contact_flow_content(params = {}, options = {})
|
2649
|
+
req = build_request(:update_contact_flow_content, params)
|
2650
|
+
req.send_request(options)
|
2651
|
+
end
|
2652
|
+
|
2653
|
+
# The name of the contact flow.
|
2654
|
+
#
|
2655
|
+
# You can also create and update contact flows using the [Amazon Connect
|
2656
|
+
# Flow language][1].
|
2657
|
+
#
|
2658
|
+
#
|
2659
|
+
#
|
2660
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
2661
|
+
#
|
2662
|
+
# @option params [required, String] :instance_id
|
2663
|
+
# The identifier of the Amazon Connect instance.
|
2664
|
+
#
|
2665
|
+
# @option params [required, String] :contact_flow_id
|
2666
|
+
# The identifier of the contact flow.
|
2667
|
+
#
|
2668
|
+
# @option params [String] :name
|
2669
|
+
# The name of the contact flow.
|
2670
|
+
#
|
2671
|
+
# @option params [String] :description
|
2672
|
+
# The description of the contact flow.
|
2673
|
+
#
|
2674
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2675
|
+
#
|
2676
|
+
# @example Request syntax with placeholder values
|
2677
|
+
#
|
2678
|
+
# resp = client.update_contact_flow_name({
|
2679
|
+
# instance_id: "InstanceId", # required
|
2680
|
+
# contact_flow_id: "ContactFlowId", # required
|
2681
|
+
# name: "ContactFlowName",
|
2682
|
+
# description: "ContactFlowDescription",
|
2683
|
+
# })
|
2684
|
+
#
|
2685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowName AWS API Documentation
|
2686
|
+
#
|
2687
|
+
# @overload update_contact_flow_name(params = {})
|
2688
|
+
# @param [Hash] params ({})
|
2689
|
+
def update_contact_flow_name(params = {}, options = {})
|
2690
|
+
req = build_request(:update_contact_flow_name, params)
|
2691
|
+
req.send_request(options)
|
2692
|
+
end
|
2693
|
+
|
2694
|
+
# Updates the channels that agents can handle in the Contact Control
|
2695
|
+
# Panel (CCP) for a routing profile.
|
2696
|
+
#
|
2697
|
+
# @option params [required, String] :instance_id
|
2698
|
+
# The identifier of the Amazon Connect instance.
|
2699
|
+
#
|
2700
|
+
# @option params [required, String] :routing_profile_id
|
2701
|
+
# The identifier of the routing profile.
|
2702
|
+
#
|
2703
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
2704
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
2705
|
+
#
|
2706
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2707
|
+
#
|
2708
|
+
# @example Request syntax with placeholder values
|
2709
|
+
#
|
2710
|
+
# resp = client.update_routing_profile_concurrency({
|
2711
|
+
# instance_id: "InstanceId", # required
|
2712
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2713
|
+
# media_concurrencies: [ # required
|
2714
|
+
# {
|
2715
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2716
|
+
# concurrency: 1, # required
|
2717
|
+
# },
|
2718
|
+
# ],
|
2719
|
+
# })
|
2720
|
+
#
|
2721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrency AWS API Documentation
|
2722
|
+
#
|
2723
|
+
# @overload update_routing_profile_concurrency(params = {})
|
2724
|
+
# @param [Hash] params ({})
|
2725
|
+
def update_routing_profile_concurrency(params = {}, options = {})
|
2726
|
+
req = build_request(:update_routing_profile_concurrency, params)
|
2727
|
+
req.send_request(options)
|
2728
|
+
end
|
2729
|
+
|
2730
|
+
# Updates the default outbound queue of a routing profile.
|
2731
|
+
#
|
2732
|
+
# @option params [required, String] :instance_id
|
2733
|
+
# The identifier of the Amazon Connect instance.
|
2734
|
+
#
|
2735
|
+
# @option params [required, String] :routing_profile_id
|
2736
|
+
# The identifier of the routing profile.
|
2737
|
+
#
|
2738
|
+
# @option params [required, String] :default_outbound_queue_id
|
2739
|
+
# The identifier for the default outbound queue.
|
2740
|
+
#
|
2741
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2742
|
+
#
|
2743
|
+
# @example Request syntax with placeholder values
|
2744
|
+
#
|
2745
|
+
# resp = client.update_routing_profile_default_outbound_queue({
|
2746
|
+
# instance_id: "InstanceId", # required
|
2747
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2748
|
+
# default_outbound_queue_id: "QueueId", # required
|
2749
|
+
# })
|
2750
|
+
#
|
2751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue AWS API Documentation
|
2752
|
+
#
|
2753
|
+
# @overload update_routing_profile_default_outbound_queue(params = {})
|
2754
|
+
# @param [Hash] params ({})
|
2755
|
+
def update_routing_profile_default_outbound_queue(params = {}, options = {})
|
2756
|
+
req = build_request(:update_routing_profile_default_outbound_queue, params)
|
2757
|
+
req.send_request(options)
|
2758
|
+
end
|
2759
|
+
|
2760
|
+
# Updates the name and description of a routing profile. The request
|
2761
|
+
# accepts the following data in JSON format. At least `Name` or
|
2762
|
+
# `Description` must be provided.
|
2763
|
+
#
|
2764
|
+
# @option params [required, String] :instance_id
|
2765
|
+
# The identifier of the Amazon Connect instance.
|
2766
|
+
#
|
2767
|
+
# @option params [required, String] :routing_profile_id
|
2768
|
+
# The identifier of the routing profile.
|
2769
|
+
#
|
2770
|
+
# @option params [String] :name
|
2771
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
2772
|
+
#
|
2773
|
+
# @option params [String] :description
|
2774
|
+
# The description of the routing profile. Must not be more than 250
|
2775
|
+
# characters.
|
2776
|
+
#
|
2777
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2778
|
+
#
|
2779
|
+
# @example Request syntax with placeholder values
|
2780
|
+
#
|
2781
|
+
# resp = client.update_routing_profile_name({
|
2782
|
+
# instance_id: "InstanceId", # required
|
2783
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2784
|
+
# name: "RoutingProfileName",
|
2785
|
+
# description: "RoutingProfileDescription",
|
2786
|
+
# })
|
2787
|
+
#
|
2788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileName AWS API Documentation
|
2789
|
+
#
|
2790
|
+
# @overload update_routing_profile_name(params = {})
|
2791
|
+
# @param [Hash] params ({})
|
2792
|
+
def update_routing_profile_name(params = {}, options = {})
|
2793
|
+
req = build_request(:update_routing_profile_name, params)
|
2794
|
+
req.send_request(options)
|
2795
|
+
end
|
2796
|
+
|
2797
|
+
# Updates the properties associated with a set of queues for a routing
|
2798
|
+
# profile.
|
2799
|
+
#
|
2800
|
+
# @option params [required, String] :instance_id
|
2801
|
+
# The identifier of the Amazon Connect instance.
|
2802
|
+
#
|
2803
|
+
# @option params [required, String] :routing_profile_id
|
2804
|
+
# The identifier of the routing profile.
|
2805
|
+
#
|
2806
|
+
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
2807
|
+
# The queues to be updated for this routing profile.
|
2808
|
+
#
|
2809
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2810
|
+
#
|
2811
|
+
# @example Request syntax with placeholder values
|
2812
|
+
#
|
2813
|
+
# resp = client.update_routing_profile_queues({
|
2814
|
+
# instance_id: "InstanceId", # required
|
2815
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2816
|
+
# queue_configs: [ # required
|
2817
|
+
# {
|
2818
|
+
# queue_reference: { # required
|
2819
|
+
# queue_id: "QueueId", # required
|
2820
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2821
|
+
# },
|
2822
|
+
# priority: 1, # required
|
2823
|
+
# delay: 1, # required
|
2824
|
+
# },
|
2825
|
+
# ],
|
2826
|
+
# })
|
2827
|
+
#
|
2828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueues AWS API Documentation
|
2829
|
+
#
|
2830
|
+
# @overload update_routing_profile_queues(params = {})
|
2831
|
+
# @param [Hash] params ({})
|
2832
|
+
def update_routing_profile_queues(params = {}, options = {})
|
2833
|
+
req = build_request(:update_routing_profile_queues, params)
|
2834
|
+
req.send_request(options)
|
2835
|
+
end
|
2836
|
+
|
1973
2837
|
# Assigns the specified hierarchy group to the specified user.
|
1974
2838
|
#
|
1975
2839
|
# @option params [String] :hierarchy_group_id
|
@@ -2000,8 +2864,94 @@ module Aws::Connect
|
|
2000
2864
|
req.send_request(options)
|
2001
2865
|
end
|
2002
2866
|
|
2867
|
+
# Updates the name of the user hierarchy group.
|
2868
|
+
#
|
2869
|
+
# @option params [required, String] :name
|
2870
|
+
# The name of the hierarchy group. Must not be more than 100 characters.
|
2871
|
+
#
|
2872
|
+
# @option params [required, String] :hierarchy_group_id
|
2873
|
+
# The identifier of the hierarchy group.
|
2874
|
+
#
|
2875
|
+
# @option params [required, String] :instance_id
|
2876
|
+
# The identifier of the Amazon Connect instance.
|
2877
|
+
#
|
2878
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2879
|
+
#
|
2880
|
+
# @example Request syntax with placeholder values
|
2881
|
+
#
|
2882
|
+
# resp = client.update_user_hierarchy_group_name({
|
2883
|
+
# name: "HierarchyGroupName", # required
|
2884
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
2885
|
+
# instance_id: "InstanceId", # required
|
2886
|
+
# })
|
2887
|
+
#
|
2888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyGroupName AWS API Documentation
|
2889
|
+
#
|
2890
|
+
# @overload update_user_hierarchy_group_name(params = {})
|
2891
|
+
# @param [Hash] params ({})
|
2892
|
+
def update_user_hierarchy_group_name(params = {}, options = {})
|
2893
|
+
req = build_request(:update_user_hierarchy_group_name, params)
|
2894
|
+
req.send_request(options)
|
2895
|
+
end
|
2896
|
+
|
2897
|
+
# Updates the user hierarchy structure: add, remove, and rename user
|
2898
|
+
# hierarchy levels.
|
2899
|
+
#
|
2900
|
+
# @option params [required, Types::HierarchyStructureUpdate] :hierarchy_structure
|
2901
|
+
# The hierarchy levels to update.
|
2902
|
+
#
|
2903
|
+
# @option params [required, String] :instance_id
|
2904
|
+
# The identifier of the Amazon Connect instance.
|
2905
|
+
#
|
2906
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2907
|
+
#
|
2908
|
+
# @example Request syntax with placeholder values
|
2909
|
+
#
|
2910
|
+
# resp = client.update_user_hierarchy_structure({
|
2911
|
+
# hierarchy_structure: { # required
|
2912
|
+
# level_one: {
|
2913
|
+
# name: "HierarchyLevelName", # required
|
2914
|
+
# },
|
2915
|
+
# level_two: {
|
2916
|
+
# name: "HierarchyLevelName", # required
|
2917
|
+
# },
|
2918
|
+
# level_three: {
|
2919
|
+
# name: "HierarchyLevelName", # required
|
2920
|
+
# },
|
2921
|
+
# level_four: {
|
2922
|
+
# name: "HierarchyLevelName", # required
|
2923
|
+
# },
|
2924
|
+
# level_five: {
|
2925
|
+
# name: "HierarchyLevelName", # required
|
2926
|
+
# },
|
2927
|
+
# },
|
2928
|
+
# instance_id: "InstanceId", # required
|
2929
|
+
# })
|
2930
|
+
#
|
2931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyStructure AWS API Documentation
|
2932
|
+
#
|
2933
|
+
# @overload update_user_hierarchy_structure(params = {})
|
2934
|
+
# @param [Hash] params ({})
|
2935
|
+
def update_user_hierarchy_structure(params = {}, options = {})
|
2936
|
+
req = build_request(:update_user_hierarchy_structure, params)
|
2937
|
+
req.send_request(options)
|
2938
|
+
end
|
2939
|
+
|
2003
2940
|
# Updates the identity information for the specified user.
|
2004
2941
|
#
|
2942
|
+
# Someone with the ability to invoke `UpdateUserIndentityInfo` can
|
2943
|
+
# change the login credentials of other users by changing their email
|
2944
|
+
# address. This poses a security risk to your organization. They can
|
2945
|
+
# change the email address of a user to the attacker's email address,
|
2946
|
+
# and then reset the password through email. We strongly recommend
|
2947
|
+
# limiting who has the ability to invoke `UpdateUserIndentityInfo`. For
|
2948
|
+
# more information, see [Best Practices for Security Profiles][1] in the
|
2949
|
+
# *Amazon Connect Administrator Guide*.
|
2950
|
+
#
|
2951
|
+
#
|
2952
|
+
#
|
2953
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html
|
2954
|
+
#
|
2005
2955
|
# @option params [required, Types::UserIdentityInfo] :identity_info
|
2006
2956
|
# The identity information for the user.
|
2007
2957
|
#
|
@@ -2142,7 +3092,7 @@ module Aws::Connect
|
|
2142
3092
|
params: params,
|
2143
3093
|
config: config)
|
2144
3094
|
context[:gem_name] = 'aws-sdk-connect'
|
2145
|
-
context[:gem_version] = '1.
|
3095
|
+
context[:gem_version] = '1.35.0'
|
2146
3096
|
Seahorse::Client::Request.new(handlers, context)
|
2147
3097
|
end
|
2148
3098
|
|