aws-sdk-connect 1.36.0 → 1.41.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 +1 -1
- data/lib/aws-sdk-connect/client.rb +1255 -94
- data/lib/aws-sdk-connect/client_api.rb +700 -0
- data/lib/aws-sdk-connect/types.rb +1691 -101
- 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: d38717c90f6e12b2a2c9102bdbf884ca8524ef5675ab2cd684a837f357c3fcb2
|
4
|
+
data.tar.gz: a53651b51f3e7ec0a875404a92ee3f3b68e9c56647ba60c26f930beaa7072b52
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5362637dbeb4dd5a3f6415d861da0ede678a83711b1cee42839562d2c76c63c1270847e6a2d5ff063027a5400fbcf1d401c6f995333f9c939d26a9446b08b189
|
7
|
+
data.tar.gz: 8080098ba4e3cca30214684178e2b04b797779984937efdda81957b7d8457287f38b6094f58401dafd87f2bc3efc549ae75096b2a25649e0b3990c3e9b0b55f6
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -327,6 +327,9 @@ module Aws::Connect
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# This API is in preview release for Amazon Connect and is subject to
|
331
|
+
# change.
|
332
|
+
#
|
330
333
|
# Associates an approved origin to an Amazon Connect instance.
|
331
334
|
#
|
332
335
|
# @option params [required, String] :instance_id
|
@@ -353,6 +356,9 @@ module Aws::Connect
|
|
353
356
|
req.send_request(options)
|
354
357
|
end
|
355
358
|
|
359
|
+
# This API is in preview release for Amazon Connect and is subject to
|
360
|
+
# change.
|
361
|
+
#
|
356
362
|
# Associates a storage resource type for the first time. You can only
|
357
363
|
# associate one type of storage configuration in a single call. This
|
358
364
|
# means, for example, that you can't define an instance with multiple
|
@@ -360,8 +366,8 @@ module Aws::Connect
|
|
360
366
|
#
|
361
367
|
# This API does not create a resource that doesn't exist. It only
|
362
368
|
# associates it to the instance. Ensure that the resource being
|
363
|
-
# specified in the storage configuration, like an
|
364
|
-
#
|
369
|
+
# specified in the storage configuration, like an S3 bucket, exists when
|
370
|
+
# being used for association.
|
365
371
|
#
|
366
372
|
# @option params [required, String] :instance_id
|
367
373
|
# The identifier of the Amazon Connect instance.
|
@@ -422,6 +428,9 @@ module Aws::Connect
|
|
422
428
|
req.send_request(options)
|
423
429
|
end
|
424
430
|
|
431
|
+
# This API is in preview release for Amazon Connect and is subject to
|
432
|
+
# change.
|
433
|
+
#
|
425
434
|
# Allows the specified Amazon Connect instance to access the specified
|
426
435
|
# Lambda function.
|
427
436
|
#
|
@@ -450,6 +459,9 @@ module Aws::Connect
|
|
450
459
|
req.send_request(options)
|
451
460
|
end
|
452
461
|
|
462
|
+
# This API is in preview release for Amazon Connect and is subject to
|
463
|
+
# change.
|
464
|
+
#
|
453
465
|
# Allows the specified Amazon Connect instance to access the specified
|
454
466
|
# Amazon Lex bot.
|
455
467
|
#
|
@@ -480,6 +492,39 @@ module Aws::Connect
|
|
480
492
|
req.send_request(options)
|
481
493
|
end
|
482
494
|
|
495
|
+
# This API is in preview release for Amazon Connect and is subject to
|
496
|
+
# change.
|
497
|
+
#
|
498
|
+
# Associates a set of quick connects with a queue.
|
499
|
+
#
|
500
|
+
# @option params [required, String] :instance_id
|
501
|
+
# The identifier of the Amazon Connect instance.
|
502
|
+
#
|
503
|
+
# @option params [required, String] :queue_id
|
504
|
+
# The identifier for the queue.
|
505
|
+
#
|
506
|
+
# @option params [required, Array<String>] :quick_connect_ids
|
507
|
+
# The quick connects to associate with this queue.
|
508
|
+
#
|
509
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
510
|
+
#
|
511
|
+
# @example Request syntax with placeholder values
|
512
|
+
#
|
513
|
+
# resp = client.associate_queue_quick_connects({
|
514
|
+
# instance_id: "InstanceId", # required
|
515
|
+
# queue_id: "QueueId", # required
|
516
|
+
# quick_connect_ids: ["QuickConnectId"], # required
|
517
|
+
# })
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateQueueQuickConnects AWS API Documentation
|
520
|
+
#
|
521
|
+
# @overload associate_queue_quick_connects(params = {})
|
522
|
+
# @param [Hash] params ({})
|
523
|
+
def associate_queue_quick_connects(params = {}, options = {})
|
524
|
+
req = build_request(:associate_queue_quick_connects, params)
|
525
|
+
req.send_request(options)
|
526
|
+
end
|
527
|
+
|
483
528
|
# Associates a set of queues with a routing profile.
|
484
529
|
#
|
485
530
|
# @option params [required, String] :instance_id
|
@@ -502,7 +547,7 @@ module Aws::Connect
|
|
502
547
|
# {
|
503
548
|
# queue_reference: { # required
|
504
549
|
# queue_id: "QueueId", # required
|
505
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
550
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
506
551
|
# },
|
507
552
|
# priority: 1, # required
|
508
553
|
# delay: 1, # required
|
@@ -519,6 +564,9 @@ module Aws::Connect
|
|
519
564
|
req.send_request(options)
|
520
565
|
end
|
521
566
|
|
567
|
+
# This API is in preview release for Amazon Connect and is subject to
|
568
|
+
# change.
|
569
|
+
#
|
522
570
|
# Associates a security key to the instance.
|
523
571
|
#
|
524
572
|
# @option params [required, String] :instance_id
|
@@ -616,10 +664,13 @@ module Aws::Connect
|
|
616
664
|
req.send_request(options)
|
617
665
|
end
|
618
666
|
|
667
|
+
# This API is in preview release for Amazon Connect and is subject to
|
668
|
+
# change.
|
669
|
+
#
|
619
670
|
# Initiates an Amazon Connect instance with all the supported channels
|
620
|
-
# enabled. It does not attach any storage
|
621
|
-
#
|
622
|
-
# Lens for Amazon Connect.
|
671
|
+
# enabled. It does not attach any storage, such as Amazon Simple Storage
|
672
|
+
# Service (Amazon S3) or Amazon Kinesis. It also does not allow for any
|
673
|
+
# configurations on features, such as Contact Lens for Amazon Connect.
|
623
674
|
#
|
624
675
|
# @option params [String] :client_token
|
625
676
|
# The idempotency token.
|
@@ -634,10 +685,10 @@ module Aws::Connect
|
|
634
685
|
# The identifier for the directory.
|
635
686
|
#
|
636
687
|
# @option params [required, Boolean] :inbound_calls_enabled
|
637
|
-
#
|
688
|
+
# Your contact center handles incoming contacts.
|
638
689
|
#
|
639
690
|
# @option params [required, Boolean] :outbound_calls_enabled
|
640
|
-
#
|
691
|
+
# Your contact center allows outbound calls.
|
641
692
|
#
|
642
693
|
# @return [Types::CreateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
643
694
|
#
|
@@ -669,6 +720,191 @@ module Aws::Connect
|
|
669
720
|
req.send_request(options)
|
670
721
|
end
|
671
722
|
|
723
|
+
# This API is in preview release for Amazon Connect and is subject to
|
724
|
+
# change.
|
725
|
+
#
|
726
|
+
# Create an AppIntegration association with an Amazon Connect instance.
|
727
|
+
#
|
728
|
+
# @option params [required, String] :instance_id
|
729
|
+
# The identifier of the Amazon Connect instance.
|
730
|
+
#
|
731
|
+
# @option params [required, String] :integration_type
|
732
|
+
# The type of information to be ingested.
|
733
|
+
#
|
734
|
+
# @option params [required, String] :integration_arn
|
735
|
+
# The Amazon Resource Name (ARN) of the integration.
|
736
|
+
#
|
737
|
+
# @option params [required, String] :source_application_url
|
738
|
+
# The URL for the external application.
|
739
|
+
#
|
740
|
+
# @option params [required, String] :source_application_name
|
741
|
+
# The name of the external application.
|
742
|
+
#
|
743
|
+
# @option params [required, String] :source_type
|
744
|
+
# The type of the data source.
|
745
|
+
#
|
746
|
+
# @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
747
|
+
#
|
748
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_id #integration_association_id} => String
|
749
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_arn #integration_association_arn} => String
|
750
|
+
#
|
751
|
+
# @example Request syntax with placeholder values
|
752
|
+
#
|
753
|
+
# resp = client.create_integration_association({
|
754
|
+
# instance_id: "InstanceId", # required
|
755
|
+
# integration_type: "EVENT", # required, accepts EVENT
|
756
|
+
# integration_arn: "ARN", # required
|
757
|
+
# source_application_url: "URI", # required
|
758
|
+
# source_application_name: "SourceApplicationName", # required
|
759
|
+
# source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK
|
760
|
+
# })
|
761
|
+
#
|
762
|
+
# @example Response structure
|
763
|
+
#
|
764
|
+
# resp.integration_association_id #=> String
|
765
|
+
# resp.integration_association_arn #=> String
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociation AWS API Documentation
|
768
|
+
#
|
769
|
+
# @overload create_integration_association(params = {})
|
770
|
+
# @param [Hash] params ({})
|
771
|
+
def create_integration_association(params = {}, options = {})
|
772
|
+
req = build_request(:create_integration_association, params)
|
773
|
+
req.send_request(options)
|
774
|
+
end
|
775
|
+
|
776
|
+
# This API is in preview release for Amazon Connect and is subject to
|
777
|
+
# change.
|
778
|
+
#
|
779
|
+
# Creates a new queue for the specified Amazon Connect instance.
|
780
|
+
#
|
781
|
+
# @option params [required, String] :instance_id
|
782
|
+
# The identifier of the Amazon Connect instance.
|
783
|
+
#
|
784
|
+
# @option params [required, String] :name
|
785
|
+
# The name of the queue.
|
786
|
+
#
|
787
|
+
# @option params [String] :description
|
788
|
+
# The description of the queue.
|
789
|
+
#
|
790
|
+
# @option params [Types::OutboundCallerConfig] :outbound_caller_config
|
791
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
792
|
+
#
|
793
|
+
# @option params [required, String] :hours_of_operation_id
|
794
|
+
# The identifier for the hours of operation.
|
795
|
+
#
|
796
|
+
# @option params [Integer] :max_contacts
|
797
|
+
# The maximum number of contacts that can be in the queue before it is
|
798
|
+
# considered full.
|
799
|
+
#
|
800
|
+
# @option params [Array<String>] :quick_connect_ids
|
801
|
+
# The quick connects available to agents who are working the queue.
|
802
|
+
#
|
803
|
+
# @option params [Hash<String,String>] :tags
|
804
|
+
# One or more tags.
|
805
|
+
#
|
806
|
+
# @return [Types::CreateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
807
|
+
#
|
808
|
+
# * {Types::CreateQueueResponse#queue_arn #queue_arn} => String
|
809
|
+
# * {Types::CreateQueueResponse#queue_id #queue_id} => String
|
810
|
+
#
|
811
|
+
# @example Request syntax with placeholder values
|
812
|
+
#
|
813
|
+
# resp = client.create_queue({
|
814
|
+
# instance_id: "InstanceId", # required
|
815
|
+
# name: "CommonNameLength127", # required
|
816
|
+
# description: "QueueDescription",
|
817
|
+
# outbound_caller_config: {
|
818
|
+
# outbound_caller_id_name: "OutboundCallerIdName",
|
819
|
+
# outbound_caller_id_number_id: "PhoneNumberId",
|
820
|
+
# outbound_flow_id: "ContactFlowId",
|
821
|
+
# },
|
822
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
823
|
+
# max_contacts: 1,
|
824
|
+
# quick_connect_ids: ["QuickConnectId"],
|
825
|
+
# tags: {
|
826
|
+
# "TagKey" => "TagValue",
|
827
|
+
# },
|
828
|
+
# })
|
829
|
+
#
|
830
|
+
# @example Response structure
|
831
|
+
#
|
832
|
+
# resp.queue_arn #=> String
|
833
|
+
# resp.queue_id #=> String
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQueue AWS API Documentation
|
836
|
+
#
|
837
|
+
# @overload create_queue(params = {})
|
838
|
+
# @param [Hash] params ({})
|
839
|
+
def create_queue(params = {}, options = {})
|
840
|
+
req = build_request(:create_queue, params)
|
841
|
+
req.send_request(options)
|
842
|
+
end
|
843
|
+
|
844
|
+
# This API is in preview release for Amazon Connect and is subject to
|
845
|
+
# change.
|
846
|
+
#
|
847
|
+
# Creates a quick connect for the specified Amazon Connect instance.
|
848
|
+
#
|
849
|
+
# @option params [required, String] :instance_id
|
850
|
+
# The identifier of the Amazon Connect instance.
|
851
|
+
#
|
852
|
+
# @option params [required, String] :name
|
853
|
+
# The name of the quick connect.
|
854
|
+
#
|
855
|
+
# @option params [String] :description
|
856
|
+
# The description of the quick connect.
|
857
|
+
#
|
858
|
+
# @option params [required, Types::QuickConnectConfig] :quick_connect_config
|
859
|
+
# Configuration settings for the quick connect.
|
860
|
+
#
|
861
|
+
# @option params [Hash<String,String>] :tags
|
862
|
+
# One or more tags.
|
863
|
+
#
|
864
|
+
# @return [Types::CreateQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
865
|
+
#
|
866
|
+
# * {Types::CreateQuickConnectResponse#quick_connect_arn #quick_connect_arn} => String
|
867
|
+
# * {Types::CreateQuickConnectResponse#quick_connect_id #quick_connect_id} => String
|
868
|
+
#
|
869
|
+
# @example Request syntax with placeholder values
|
870
|
+
#
|
871
|
+
# resp = client.create_quick_connect({
|
872
|
+
# instance_id: "InstanceId", # required
|
873
|
+
# name: "QuickConnectName", # required
|
874
|
+
# description: "QuickConnectDescription",
|
875
|
+
# quick_connect_config: { # required
|
876
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
877
|
+
# user_config: {
|
878
|
+
# user_id: "UserId", # required
|
879
|
+
# contact_flow_id: "ContactFlowId", # required
|
880
|
+
# },
|
881
|
+
# queue_config: {
|
882
|
+
# queue_id: "QueueId", # required
|
883
|
+
# contact_flow_id: "ContactFlowId", # required
|
884
|
+
# },
|
885
|
+
# phone_config: {
|
886
|
+
# phone_number: "PhoneNumber", # required
|
887
|
+
# },
|
888
|
+
# },
|
889
|
+
# tags: {
|
890
|
+
# "TagKey" => "TagValue",
|
891
|
+
# },
|
892
|
+
# })
|
893
|
+
#
|
894
|
+
# @example Response structure
|
895
|
+
#
|
896
|
+
# resp.quick_connect_arn #=> String
|
897
|
+
# resp.quick_connect_id #=> String
|
898
|
+
#
|
899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnect AWS API Documentation
|
900
|
+
#
|
901
|
+
# @overload create_quick_connect(params = {})
|
902
|
+
# @param [Hash] params ({})
|
903
|
+
def create_quick_connect(params = {}, options = {})
|
904
|
+
req = build_request(:create_quick_connect, params)
|
905
|
+
req.send_request(options)
|
906
|
+
end
|
907
|
+
|
672
908
|
# Creates a new routing profile.
|
673
909
|
#
|
674
910
|
# @option params [required, String] :instance_id
|
@@ -686,11 +922,11 @@ module Aws::Connect
|
|
686
922
|
#
|
687
923
|
# @option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
688
924
|
# The inbound queues associated with the routing profile. If no queue is
|
689
|
-
# added, the agent can only
|
925
|
+
# added, the agent can make only outbound calls.
|
690
926
|
#
|
691
927
|
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
692
|
-
# The channels agents can handle in the Contact Control Panel (CCP)
|
693
|
-
# this routing profile.
|
928
|
+
# The channels that agents can handle in the Contact Control Panel (CCP)
|
929
|
+
# for this routing profile.
|
694
930
|
#
|
695
931
|
# @option params [Hash<String,String>] :tags
|
696
932
|
# One or more tags.
|
@@ -711,7 +947,7 @@ module Aws::Connect
|
|
711
947
|
# {
|
712
948
|
# queue_reference: { # required
|
713
949
|
# queue_id: "QueueId", # required
|
714
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
950
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
715
951
|
# },
|
716
952
|
# priority: 1, # required
|
717
953
|
# delay: 1, # required
|
@@ -719,7 +955,7 @@ module Aws::Connect
|
|
719
955
|
# ],
|
720
956
|
# media_concurrencies: [ # required
|
721
957
|
# {
|
722
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
958
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
723
959
|
# concurrency: 1, # required
|
724
960
|
# },
|
725
961
|
# ],
|
@@ -742,6 +978,49 @@ module Aws::Connect
|
|
742
978
|
req.send_request(options)
|
743
979
|
end
|
744
980
|
|
981
|
+
# This API is in preview release for Amazon Connect and is subject to
|
982
|
+
# change.
|
983
|
+
#
|
984
|
+
# Creates a use case for an AppIntegration association.
|
985
|
+
#
|
986
|
+
# @option params [required, String] :instance_id
|
987
|
+
# The identifier of the Amazon Connect instance.
|
988
|
+
#
|
989
|
+
# @option params [required, String] :integration_association_id
|
990
|
+
# The identifier for the AppIntegration association.
|
991
|
+
#
|
992
|
+
# @option params [required, String] :use_case_type
|
993
|
+
# The type of use case to associate to the AppIntegration association.
|
994
|
+
# Each AppIntegration association can have only one of each use case
|
995
|
+
# type.
|
996
|
+
#
|
997
|
+
# @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
998
|
+
#
|
999
|
+
# * {Types::CreateUseCaseResponse#use_case_id #use_case_id} => String
|
1000
|
+
# * {Types::CreateUseCaseResponse#use_case_arn #use_case_arn} => String
|
1001
|
+
#
|
1002
|
+
# @example Request syntax with placeholder values
|
1003
|
+
#
|
1004
|
+
# resp = client.create_use_case({
|
1005
|
+
# instance_id: "InstanceId", # required
|
1006
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1007
|
+
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
|
1008
|
+
# })
|
1009
|
+
#
|
1010
|
+
# @example Response structure
|
1011
|
+
#
|
1012
|
+
# resp.use_case_id #=> String
|
1013
|
+
# resp.use_case_arn #=> String
|
1014
|
+
#
|
1015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCase AWS API Documentation
|
1016
|
+
#
|
1017
|
+
# @overload create_use_case(params = {})
|
1018
|
+
# @param [Hash] params ({})
|
1019
|
+
def create_use_case(params = {}, options = {})
|
1020
|
+
req = build_request(:create_use_case, params)
|
1021
|
+
req.send_request(options)
|
1022
|
+
end
|
1023
|
+
|
745
1024
|
# Creates a user account for the specified Amazon Connect instance.
|
746
1025
|
#
|
747
1026
|
# For information about how to create user accounts using the Amazon
|
@@ -882,6 +1161,9 @@ module Aws::Connect
|
|
882
1161
|
req.send_request(options)
|
883
1162
|
end
|
884
1163
|
|
1164
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1165
|
+
# change.
|
1166
|
+
#
|
885
1167
|
# Deletes the Amazon Connect instance.
|
886
1168
|
#
|
887
1169
|
# @option params [required, String] :instance_id
|
@@ -904,6 +1186,98 @@ module Aws::Connect
|
|
904
1186
|
req.send_request(options)
|
905
1187
|
end
|
906
1188
|
|
1189
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1190
|
+
# change.
|
1191
|
+
#
|
1192
|
+
# Deletes an AppIntegration association from an Amazon Connect instance.
|
1193
|
+
# The association must not have any use cases associated with it.
|
1194
|
+
#
|
1195
|
+
# @option params [required, String] :instance_id
|
1196
|
+
# The identifier of the Amazon Connect instance.
|
1197
|
+
#
|
1198
|
+
# @option params [required, String] :integration_association_id
|
1199
|
+
# The identifier for the AppIntegration association.
|
1200
|
+
#
|
1201
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1202
|
+
#
|
1203
|
+
# @example Request syntax with placeholder values
|
1204
|
+
#
|
1205
|
+
# resp = client.delete_integration_association({
|
1206
|
+
# instance_id: "InstanceId", # required
|
1207
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1208
|
+
# })
|
1209
|
+
#
|
1210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociation AWS API Documentation
|
1211
|
+
#
|
1212
|
+
# @overload delete_integration_association(params = {})
|
1213
|
+
# @param [Hash] params ({})
|
1214
|
+
def delete_integration_association(params = {}, options = {})
|
1215
|
+
req = build_request(:delete_integration_association, params)
|
1216
|
+
req.send_request(options)
|
1217
|
+
end
|
1218
|
+
|
1219
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1220
|
+
# change.
|
1221
|
+
#
|
1222
|
+
# Deletes a quick connect.
|
1223
|
+
#
|
1224
|
+
# @option params [required, String] :instance_id
|
1225
|
+
# The identifier of the Amazon Connect instance.
|
1226
|
+
#
|
1227
|
+
# @option params [required, String] :quick_connect_id
|
1228
|
+
# The identifier for the quick connect.
|
1229
|
+
#
|
1230
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1231
|
+
#
|
1232
|
+
# @example Request syntax with placeholder values
|
1233
|
+
#
|
1234
|
+
# resp = client.delete_quick_connect({
|
1235
|
+
# instance_id: "InstanceId", # required
|
1236
|
+
# quick_connect_id: "QuickConnectId", # required
|
1237
|
+
# })
|
1238
|
+
#
|
1239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteQuickConnect AWS API Documentation
|
1240
|
+
#
|
1241
|
+
# @overload delete_quick_connect(params = {})
|
1242
|
+
# @param [Hash] params ({})
|
1243
|
+
def delete_quick_connect(params = {}, options = {})
|
1244
|
+
req = build_request(:delete_quick_connect, params)
|
1245
|
+
req.send_request(options)
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1249
|
+
# change.
|
1250
|
+
#
|
1251
|
+
# Deletes a use case from an AppIntegration association.
|
1252
|
+
#
|
1253
|
+
# @option params [required, String] :instance_id
|
1254
|
+
# The identifier of the Amazon Connect instance.
|
1255
|
+
#
|
1256
|
+
# @option params [required, String] :integration_association_id
|
1257
|
+
# The identifier for the AppIntegration association.
|
1258
|
+
#
|
1259
|
+
# @option params [required, String] :use_case_id
|
1260
|
+
# The identifier for the use case.
|
1261
|
+
#
|
1262
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1263
|
+
#
|
1264
|
+
# @example Request syntax with placeholder values
|
1265
|
+
#
|
1266
|
+
# resp = client.delete_use_case({
|
1267
|
+
# instance_id: "InstanceId", # required
|
1268
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1269
|
+
# use_case_id: "UseCaseId", # required
|
1270
|
+
# })
|
1271
|
+
#
|
1272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUseCase AWS API Documentation
|
1273
|
+
#
|
1274
|
+
# @overload delete_use_case(params = {})
|
1275
|
+
# @param [Hash] params ({})
|
1276
|
+
def delete_use_case(params = {}, options = {})
|
1277
|
+
req = build_request(:delete_use_case, params)
|
1278
|
+
req.send_request(options)
|
1279
|
+
end
|
1280
|
+
|
907
1281
|
# Deletes a user account from the specified Amazon Connect instance.
|
908
1282
|
#
|
909
1283
|
# For information about what happens to a user's data when their
|
@@ -1011,9 +1385,59 @@ module Aws::Connect
|
|
1011
1385
|
req.send_request(options)
|
1012
1386
|
end
|
1013
1387
|
|
1388
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1389
|
+
# change.
|
1390
|
+
#
|
1391
|
+
# Describes the hours of operation.
|
1392
|
+
#
|
1393
|
+
# @option params [required, String] :instance_id
|
1394
|
+
# The identifier of the Amazon Connect instance.
|
1395
|
+
#
|
1396
|
+
# @option params [required, String] :hours_of_operation_id
|
1397
|
+
# The identifier for the hours of operation.
|
1398
|
+
#
|
1399
|
+
# @return [Types::DescribeHoursOfOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1400
|
+
#
|
1401
|
+
# * {Types::DescribeHoursOfOperationResponse#hours_of_operation #hours_of_operation} => Types::HoursOfOperation
|
1402
|
+
#
|
1403
|
+
# @example Request syntax with placeholder values
|
1404
|
+
#
|
1405
|
+
# resp = client.describe_hours_of_operation({
|
1406
|
+
# instance_id: "InstanceId", # required
|
1407
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
1408
|
+
# })
|
1409
|
+
#
|
1410
|
+
# @example Response structure
|
1411
|
+
#
|
1412
|
+
# resp.hours_of_operation.hours_of_operation_id #=> String
|
1413
|
+
# resp.hours_of_operation.hours_of_operation_arn #=> String
|
1414
|
+
# resp.hours_of_operation.name #=> String
|
1415
|
+
# resp.hours_of_operation.description #=> String
|
1416
|
+
# resp.hours_of_operation.time_zone #=> String
|
1417
|
+
# resp.hours_of_operation.config #=> Array
|
1418
|
+
# resp.hours_of_operation.config[0].day #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
1419
|
+
# resp.hours_of_operation.config[0].start_time.hours #=> Integer
|
1420
|
+
# resp.hours_of_operation.config[0].start_time.minutes #=> Integer
|
1421
|
+
# resp.hours_of_operation.config[0].end_time.hours #=> Integer
|
1422
|
+
# resp.hours_of_operation.config[0].end_time.minutes #=> Integer
|
1423
|
+
# resp.hours_of_operation.tags #=> Hash
|
1424
|
+
# resp.hours_of_operation.tags["TagKey"] #=> String
|
1425
|
+
#
|
1426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeHoursOfOperation AWS API Documentation
|
1427
|
+
#
|
1428
|
+
# @overload describe_hours_of_operation(params = {})
|
1429
|
+
# @param [Hash] params ({})
|
1430
|
+
def describe_hours_of_operation(params = {}, options = {})
|
1431
|
+
req = build_request(:describe_hours_of_operation, params)
|
1432
|
+
req.send_request(options)
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1436
|
+
# change.
|
1437
|
+
#
|
1014
1438
|
# Returns the current state of the specified instance identifier. It
|
1015
1439
|
# tracks the instance while it is being created and returns an error
|
1016
|
-
# status if applicable.
|
1440
|
+
# status, if applicable.
|
1017
1441
|
#
|
1018
1442
|
# If an instance is not created successfully, the instance status reason
|
1019
1443
|
# field returns details relevant to the reason. The instance in a failed
|
@@ -1055,6 +1479,9 @@ module Aws::Connect
|
|
1055
1479
|
req.send_request(options)
|
1056
1480
|
end
|
1057
1481
|
|
1482
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1483
|
+
# change.
|
1484
|
+
#
|
1058
1485
|
# Describes the specified instance attribute.
|
1059
1486
|
#
|
1060
1487
|
# @option params [required, String] :instance_id
|
@@ -1088,6 +1515,9 @@ module Aws::Connect
|
|
1088
1515
|
req.send_request(options)
|
1089
1516
|
end
|
1090
1517
|
|
1518
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1519
|
+
# change.
|
1520
|
+
#
|
1091
1521
|
# Retrieves the current storage configurations for the specified
|
1092
1522
|
# resource type, association ID, and instance ID.
|
1093
1523
|
#
|
@@ -1137,6 +1567,98 @@ module Aws::Connect
|
|
1137
1567
|
req.send_request(options)
|
1138
1568
|
end
|
1139
1569
|
|
1570
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1571
|
+
# change.
|
1572
|
+
#
|
1573
|
+
# Describes the specified queue.
|
1574
|
+
#
|
1575
|
+
# @option params [required, String] :instance_id
|
1576
|
+
# The identifier of the Amazon Connect instance.
|
1577
|
+
#
|
1578
|
+
# @option params [required, String] :queue_id
|
1579
|
+
# The identifier for the queue.
|
1580
|
+
#
|
1581
|
+
# @return [Types::DescribeQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1582
|
+
#
|
1583
|
+
# * {Types::DescribeQueueResponse#queue #queue} => Types::Queue
|
1584
|
+
#
|
1585
|
+
# @example Request syntax with placeholder values
|
1586
|
+
#
|
1587
|
+
# resp = client.describe_queue({
|
1588
|
+
# instance_id: "InstanceId", # required
|
1589
|
+
# queue_id: "QueueId", # required
|
1590
|
+
# })
|
1591
|
+
#
|
1592
|
+
# @example Response structure
|
1593
|
+
#
|
1594
|
+
# resp.queue.name #=> String
|
1595
|
+
# resp.queue.queue_arn #=> String
|
1596
|
+
# resp.queue.queue_id #=> String
|
1597
|
+
# resp.queue.description #=> String
|
1598
|
+
# resp.queue.outbound_caller_config.outbound_caller_id_name #=> String
|
1599
|
+
# resp.queue.outbound_caller_config.outbound_caller_id_number_id #=> String
|
1600
|
+
# resp.queue.outbound_caller_config.outbound_flow_id #=> String
|
1601
|
+
# resp.queue.hours_of_operation_id #=> String
|
1602
|
+
# resp.queue.max_contacts #=> Integer
|
1603
|
+
# resp.queue.status #=> String, one of "ENABLED", "DISABLED"
|
1604
|
+
# resp.queue.tags #=> Hash
|
1605
|
+
# resp.queue.tags["TagKey"] #=> String
|
1606
|
+
#
|
1607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQueue AWS API Documentation
|
1608
|
+
#
|
1609
|
+
# @overload describe_queue(params = {})
|
1610
|
+
# @param [Hash] params ({})
|
1611
|
+
def describe_queue(params = {}, options = {})
|
1612
|
+
req = build_request(:describe_queue, params)
|
1613
|
+
req.send_request(options)
|
1614
|
+
end
|
1615
|
+
|
1616
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1617
|
+
# change.
|
1618
|
+
#
|
1619
|
+
# Describes the quick connect.
|
1620
|
+
#
|
1621
|
+
# @option params [required, String] :instance_id
|
1622
|
+
# The identifier of the Amazon Connect instance.
|
1623
|
+
#
|
1624
|
+
# @option params [required, String] :quick_connect_id
|
1625
|
+
# The identifier for the quick connect.
|
1626
|
+
#
|
1627
|
+
# @return [Types::DescribeQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1628
|
+
#
|
1629
|
+
# * {Types::DescribeQuickConnectResponse#quick_connect #quick_connect} => Types::QuickConnect
|
1630
|
+
#
|
1631
|
+
# @example Request syntax with placeholder values
|
1632
|
+
#
|
1633
|
+
# resp = client.describe_quick_connect({
|
1634
|
+
# instance_id: "InstanceId", # required
|
1635
|
+
# quick_connect_id: "QuickConnectId", # required
|
1636
|
+
# })
|
1637
|
+
#
|
1638
|
+
# @example Response structure
|
1639
|
+
#
|
1640
|
+
# resp.quick_connect.quick_connect_arn #=> String
|
1641
|
+
# resp.quick_connect.quick_connect_id #=> String
|
1642
|
+
# resp.quick_connect.name #=> String
|
1643
|
+
# resp.quick_connect.description #=> String
|
1644
|
+
# resp.quick_connect.quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
1645
|
+
# resp.quick_connect.quick_connect_config.user_config.user_id #=> String
|
1646
|
+
# resp.quick_connect.quick_connect_config.user_config.contact_flow_id #=> String
|
1647
|
+
# resp.quick_connect.quick_connect_config.queue_config.queue_id #=> String
|
1648
|
+
# resp.quick_connect.quick_connect_config.queue_config.contact_flow_id #=> String
|
1649
|
+
# resp.quick_connect.quick_connect_config.phone_config.phone_number #=> String
|
1650
|
+
# resp.quick_connect.tags #=> Hash
|
1651
|
+
# resp.quick_connect.tags["TagKey"] #=> String
|
1652
|
+
#
|
1653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQuickConnect AWS API Documentation
|
1654
|
+
#
|
1655
|
+
# @overload describe_quick_connect(params = {})
|
1656
|
+
# @param [Hash] params ({})
|
1657
|
+
def describe_quick_connect(params = {}, options = {})
|
1658
|
+
req = build_request(:describe_quick_connect, params)
|
1659
|
+
req.send_request(options)
|
1660
|
+
end
|
1661
|
+
|
1140
1662
|
# Describes the specified routing profile.
|
1141
1663
|
#
|
1142
1664
|
# @option params [required, String] :instance_id
|
@@ -1164,7 +1686,7 @@ module Aws::Connect
|
|
1164
1686
|
# resp.routing_profile.routing_profile_id #=> String
|
1165
1687
|
# resp.routing_profile.description #=> String
|
1166
1688
|
# resp.routing_profile.media_concurrencies #=> Array
|
1167
|
-
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT"
|
1689
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1168
1690
|
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
1169
1691
|
# resp.routing_profile.default_outbound_queue_id #=> String
|
1170
1692
|
# resp.routing_profile.tags #=> Hash
|
@@ -1323,6 +1845,9 @@ module Aws::Connect
|
|
1323
1845
|
req.send_request(options)
|
1324
1846
|
end
|
1325
1847
|
|
1848
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1849
|
+
# change.
|
1850
|
+
#
|
1326
1851
|
# Revokes access to integrated applications from Amazon Connect.
|
1327
1852
|
#
|
1328
1853
|
# @option params [required, String] :instance_id
|
@@ -1349,6 +1874,9 @@ module Aws::Connect
|
|
1349
1874
|
req.send_request(options)
|
1350
1875
|
end
|
1351
1876
|
|
1877
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1878
|
+
# change.
|
1879
|
+
#
|
1352
1880
|
# Removes the storage type configurations for the specified resource
|
1353
1881
|
# type and association ID.
|
1354
1882
|
#
|
@@ -1381,7 +1909,10 @@ module Aws::Connect
|
|
1381
1909
|
req.send_request(options)
|
1382
1910
|
end
|
1383
1911
|
|
1384
|
-
#
|
1912
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1913
|
+
# change.
|
1914
|
+
#
|
1915
|
+
# Remove the Lambda function from the dropdown options available in the
|
1385
1916
|
# relevant contact flow blocks.
|
1386
1917
|
#
|
1387
1918
|
# @option params [required, String] :instance_id
|
@@ -1409,6 +1940,9 @@ module Aws::Connect
|
|
1409
1940
|
req.send_request(options)
|
1410
1941
|
end
|
1411
1942
|
|
1943
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1944
|
+
# change.
|
1945
|
+
#
|
1412
1946
|
# Revokes authorization from the specified instance to access the
|
1413
1947
|
# specified Amazon Lex bot.
|
1414
1948
|
#
|
@@ -1440,6 +1974,39 @@ module Aws::Connect
|
|
1440
1974
|
req.send_request(options)
|
1441
1975
|
end
|
1442
1976
|
|
1977
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1978
|
+
# change.
|
1979
|
+
#
|
1980
|
+
# Disassociates a set of quick connects from a queue.
|
1981
|
+
#
|
1982
|
+
# @option params [required, String] :instance_id
|
1983
|
+
# The identifier of the Amazon Connect instance.
|
1984
|
+
#
|
1985
|
+
# @option params [required, String] :queue_id
|
1986
|
+
# The identifier for the queue.
|
1987
|
+
#
|
1988
|
+
# @option params [required, Array<String>] :quick_connect_ids
|
1989
|
+
# The quick connects to disassociate from the queue.
|
1990
|
+
#
|
1991
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1992
|
+
#
|
1993
|
+
# @example Request syntax with placeholder values
|
1994
|
+
#
|
1995
|
+
# resp = client.disassociate_queue_quick_connects({
|
1996
|
+
# instance_id: "InstanceId", # required
|
1997
|
+
# queue_id: "QueueId", # required
|
1998
|
+
# quick_connect_ids: ["QuickConnectId"], # required
|
1999
|
+
# })
|
2000
|
+
#
|
2001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateQueueQuickConnects AWS API Documentation
|
2002
|
+
#
|
2003
|
+
# @overload disassociate_queue_quick_connects(params = {})
|
2004
|
+
# @param [Hash] params ({})
|
2005
|
+
def disassociate_queue_quick_connects(params = {}, options = {})
|
2006
|
+
req = build_request(:disassociate_queue_quick_connects, params)
|
2007
|
+
req.send_request(options)
|
2008
|
+
end
|
2009
|
+
|
1443
2010
|
# Disassociates a set of queues from a routing profile.
|
1444
2011
|
#
|
1445
2012
|
# @option params [required, String] :instance_id
|
@@ -1461,7 +2028,7 @@ module Aws::Connect
|
|
1461
2028
|
# queue_references: [ # required
|
1462
2029
|
# {
|
1463
2030
|
# queue_id: "QueueId", # required
|
1464
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2031
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
1465
2032
|
# },
|
1466
2033
|
# ],
|
1467
2034
|
# })
|
@@ -1475,6 +2042,9 @@ module Aws::Connect
|
|
1475
2042
|
req.send_request(options)
|
1476
2043
|
end
|
1477
2044
|
|
2045
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2046
|
+
# change.
|
2047
|
+
#
|
1478
2048
|
# Deletes the specified security key.
|
1479
2049
|
#
|
1480
2050
|
# @option params [required, String] :instance_id
|
@@ -1552,14 +2122,14 @@ module Aws::Connect
|
|
1552
2122
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1553
2123
|
# returned. Metric data is retrieved only for the resources associated
|
1554
2124
|
# with the queues or channels included in the filter. You can include
|
1555
|
-
# both queue IDs and queue ARNs in the same request.
|
1556
|
-
#
|
2125
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2126
|
+
# TASK channels are supported.
|
1557
2127
|
#
|
1558
2128
|
# @option params [Array<String>] :groupings
|
1559
2129
|
# The grouping applied to the metrics returned. For example, when
|
1560
2130
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
1561
2131
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
1562
|
-
# include a Channels filter.
|
2132
|
+
# include a Channels filter. VOICE, CHAT, and TASK channels are
|
1563
2133
|
# supported.
|
1564
2134
|
#
|
1565
2135
|
# If no `Grouping` is included in the request, a summary of metrics is
|
@@ -1683,7 +2253,7 @@ module Aws::Connect
|
|
1683
2253
|
# parameters as the request that generated the token.
|
1684
2254
|
#
|
1685
2255
|
# @option params [Integer] :max_results
|
1686
|
-
# The
|
2256
|
+
# The maximum number of results to return per page.
|
1687
2257
|
#
|
1688
2258
|
# @return [Types::GetCurrentMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1689
2259
|
#
|
@@ -1699,7 +2269,7 @@ module Aws::Connect
|
|
1699
2269
|
# instance_id: "InstanceId", # required
|
1700
2270
|
# filters: { # required
|
1701
2271
|
# queues: ["QueueId"],
|
1702
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2272
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1703
2273
|
# },
|
1704
2274
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1705
2275
|
# current_metrics: [ # required
|
@@ -1718,7 +2288,7 @@ module Aws::Connect
|
|
1718
2288
|
# resp.metric_results #=> Array
|
1719
2289
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
1720
2290
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
1721
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
2291
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1722
2292
|
# resp.metric_results[0].collections #=> Array
|
1723
2293
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE"
|
1724
2294
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
@@ -1800,8 +2370,8 @@ module Aws::Connect
|
|
1800
2370
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1801
2371
|
# returned. Metric data is retrieved only for the resources associated
|
1802
2372
|
# with the queues or channels included in the filter. You can include
|
1803
|
-
# both queue IDs and queue ARNs in the same request.
|
1804
|
-
#
|
2373
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2374
|
+
# TASK channels are supported.
|
1805
2375
|
#
|
1806
2376
|
# @option params [Array<String>] :groupings
|
1807
2377
|
# The grouping applied to the metrics returned. For example, when
|
@@ -1984,7 +2554,7 @@ module Aws::Connect
|
|
1984
2554
|
# results.
|
1985
2555
|
#
|
1986
2556
|
# @option params [Integer] :max_results
|
1987
|
-
# The
|
2557
|
+
# The maximum number of results to return per page.
|
1988
2558
|
#
|
1989
2559
|
# @return [Types::GetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1990
2560
|
#
|
@@ -2001,7 +2571,7 @@ module Aws::Connect
|
|
2001
2571
|
# end_time: Time.now, # required
|
2002
2572
|
# filters: { # required
|
2003
2573
|
# queues: ["QueueId"],
|
2004
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2574
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2005
2575
|
# },
|
2006
2576
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2007
2577
|
# historical_metrics: [ # required
|
@@ -2025,7 +2595,7 @@ module Aws::Connect
|
|
2025
2595
|
# resp.metric_results #=> Array
|
2026
2596
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
2027
2597
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
2028
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
2598
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2029
2599
|
# resp.metric_results[0].collections #=> Array
|
2030
2600
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
|
2031
2601
|
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
@@ -2043,6 +2613,9 @@ module Aws::Connect
|
|
2043
2613
|
req.send_request(options)
|
2044
2614
|
end
|
2045
2615
|
|
2616
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2617
|
+
# change.
|
2618
|
+
#
|
2046
2619
|
# Returns a paginated list of all approved origins associated with the
|
2047
2620
|
# instance.
|
2048
2621
|
#
|
@@ -2055,7 +2628,7 @@ module Aws::Connect
|
|
2055
2628
|
# results.
|
2056
2629
|
#
|
2057
2630
|
# @option params [Integer] :max_results
|
2058
|
-
# The
|
2631
|
+
# The maximum number of results to return per page.
|
2059
2632
|
#
|
2060
2633
|
# @return [Types::ListApprovedOriginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2061
2634
|
#
|
@@ -2113,7 +2686,7 @@ module Aws::Connect
|
|
2113
2686
|
# results.
|
2114
2687
|
#
|
2115
2688
|
# @option params [Integer] :max_results
|
2116
|
-
# The
|
2689
|
+
# The maximum number of results to return per page.
|
2117
2690
|
#
|
2118
2691
|
# @return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2119
2692
|
#
|
@@ -2168,7 +2741,7 @@ module Aws::Connect
|
|
2168
2741
|
# results.
|
2169
2742
|
#
|
2170
2743
|
# @option params [Integer] :max_results
|
2171
|
-
# The
|
2744
|
+
# The maximum number of results to return per page.
|
2172
2745
|
#
|
2173
2746
|
# @return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2174
2747
|
#
|
@@ -2202,6 +2775,9 @@ module Aws::Connect
|
|
2202
2775
|
req.send_request(options)
|
2203
2776
|
end
|
2204
2777
|
|
2778
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2779
|
+
# change.
|
2780
|
+
#
|
2205
2781
|
# Returns a paginated list of all attribute types for the given
|
2206
2782
|
# instance.
|
2207
2783
|
#
|
@@ -2214,7 +2790,7 @@ module Aws::Connect
|
|
2214
2790
|
# results.
|
2215
2791
|
#
|
2216
2792
|
# @option params [Integer] :max_results
|
2217
|
-
# The
|
2793
|
+
# The maximum number of results to return per page.
|
2218
2794
|
#
|
2219
2795
|
# @return [Types::ListInstanceAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2220
2796
|
#
|
@@ -2247,6 +2823,9 @@ module Aws::Connect
|
|
2247
2823
|
req.send_request(options)
|
2248
2824
|
end
|
2249
2825
|
|
2826
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2827
|
+
# change.
|
2828
|
+
#
|
2250
2829
|
# Returns a paginated list of storage configs for the identified
|
2251
2830
|
# instance and resource type.
|
2252
2831
|
#
|
@@ -2262,7 +2841,7 @@ module Aws::Connect
|
|
2262
2841
|
# results.
|
2263
2842
|
#
|
2264
2843
|
# @option params [Integer] :max_results
|
2265
|
-
# The
|
2844
|
+
# The maximum number of results to return per page.
|
2266
2845
|
#
|
2267
2846
|
# @return [Types::ListInstanceStorageConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2268
2847
|
#
|
@@ -2306,6 +2885,9 @@ module Aws::Connect
|
|
2306
2885
|
req.send_request(options)
|
2307
2886
|
end
|
2308
2887
|
|
2888
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2889
|
+
# change.
|
2890
|
+
#
|
2309
2891
|
# Return a list of instances which are in active state,
|
2310
2892
|
# creation-in-progress state, and failed state. Instances that aren't
|
2311
2893
|
# successfully created (they are in a failed state) are returned only
|
@@ -2317,7 +2899,7 @@ module Aws::Connect
|
|
2317
2899
|
# results.
|
2318
2900
|
#
|
2319
2901
|
# @option params [Integer] :max_results
|
2320
|
-
# The
|
2902
|
+
# The maximum number of results to return per page.
|
2321
2903
|
#
|
2322
2904
|
# @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2323
2905
|
#
|
@@ -2356,8 +2938,65 @@ module Aws::Connect
|
|
2356
2938
|
req.send_request(options)
|
2357
2939
|
end
|
2358
2940
|
|
2359
|
-
#
|
2360
|
-
#
|
2941
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2942
|
+
# change.
|
2943
|
+
#
|
2944
|
+
# Provides summary information about the AppIntegration associations for
|
2945
|
+
# the specified Amazon Connect instance.
|
2946
|
+
#
|
2947
|
+
# @option params [required, String] :instance_id
|
2948
|
+
# The identifier of the Amazon Connect instance.
|
2949
|
+
#
|
2950
|
+
# @option params [String] :next_token
|
2951
|
+
# The token for the next set of results. Use the value returned in the
|
2952
|
+
# previous response in the next request to retrieve the next set of
|
2953
|
+
# results.
|
2954
|
+
#
|
2955
|
+
# @option params [Integer] :max_results
|
2956
|
+
# The maximum number of results to return per page.
|
2957
|
+
#
|
2958
|
+
# @return [Types::ListIntegrationAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2959
|
+
#
|
2960
|
+
# * {Types::ListIntegrationAssociationsResponse#integration_association_summary_list #integration_association_summary_list} => Array<Types::IntegrationAssociationSummary>
|
2961
|
+
# * {Types::ListIntegrationAssociationsResponse#next_token #next_token} => String
|
2962
|
+
#
|
2963
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2964
|
+
#
|
2965
|
+
# @example Request syntax with placeholder values
|
2966
|
+
#
|
2967
|
+
# resp = client.list_integration_associations({
|
2968
|
+
# instance_id: "InstanceId", # required
|
2969
|
+
# next_token: "NextToken",
|
2970
|
+
# max_results: 1,
|
2971
|
+
# })
|
2972
|
+
#
|
2973
|
+
# @example Response structure
|
2974
|
+
#
|
2975
|
+
# resp.integration_association_summary_list #=> Array
|
2976
|
+
# resp.integration_association_summary_list[0].integration_association_id #=> String
|
2977
|
+
# resp.integration_association_summary_list[0].integration_association_arn #=> String
|
2978
|
+
# resp.integration_association_summary_list[0].instance_id #=> String
|
2979
|
+
# resp.integration_association_summary_list[0].integration_type #=> String, one of "EVENT"
|
2980
|
+
# resp.integration_association_summary_list[0].integration_arn #=> String
|
2981
|
+
# resp.integration_association_summary_list[0].source_application_url #=> String
|
2982
|
+
# resp.integration_association_summary_list[0].source_application_name #=> String
|
2983
|
+
# resp.integration_association_summary_list[0].source_type #=> String, one of "SALESFORCE", "ZENDESK"
|
2984
|
+
# resp.next_token #=> String
|
2985
|
+
#
|
2986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociations AWS API Documentation
|
2987
|
+
#
|
2988
|
+
# @overload list_integration_associations(params = {})
|
2989
|
+
# @param [Hash] params ({})
|
2990
|
+
def list_integration_associations(params = {}, options = {})
|
2991
|
+
req = build_request(:list_integration_associations, params)
|
2992
|
+
req.send_request(options)
|
2993
|
+
end
|
2994
|
+
|
2995
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2996
|
+
# change.
|
2997
|
+
#
|
2998
|
+
# Returns a paginated list of all Lambda functions that display in the
|
2999
|
+
# dropdown options in the relevant contact flow blocks.
|
2361
3000
|
#
|
2362
3001
|
# @option params [required, String] :instance_id
|
2363
3002
|
# The identifier of the Amazon Connect instance.
|
@@ -2368,7 +3007,7 @@ module Aws::Connect
|
|
2368
3007
|
# results.
|
2369
3008
|
#
|
2370
3009
|
# @option params [Integer] :max_results
|
2371
|
-
# The
|
3010
|
+
# The maximum number of results to return per page.
|
2372
3011
|
#
|
2373
3012
|
# @return [Types::ListLambdaFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2374
3013
|
#
|
@@ -2400,6 +3039,9 @@ module Aws::Connect
|
|
2400
3039
|
req.send_request(options)
|
2401
3040
|
end
|
2402
3041
|
|
3042
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3043
|
+
# change.
|
3044
|
+
#
|
2403
3045
|
# Returns a paginated list of all the Amazon Lex bots currently
|
2404
3046
|
# associated with the instance.
|
2405
3047
|
#
|
@@ -2412,7 +3054,7 @@ module Aws::Connect
|
|
2412
3054
|
# results.
|
2413
3055
|
#
|
2414
3056
|
# @option params [Integer] :max_results
|
2415
|
-
# The
|
3057
|
+
# The maximum number of results to return per page.
|
2416
3058
|
#
|
2417
3059
|
# @return [Types::ListLexBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2418
3060
|
#
|
@@ -2471,7 +3113,7 @@ module Aws::Connect
|
|
2471
3113
|
# results.
|
2472
3114
|
#
|
2473
3115
|
# @option params [Integer] :max_results
|
2474
|
-
# The
|
3116
|
+
# The maximum number of results to return per page.
|
2475
3117
|
#
|
2476
3118
|
# @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2477
3119
|
#
|
@@ -2555,6 +3197,59 @@ module Aws::Connect
|
|
2555
3197
|
req.send_request(options)
|
2556
3198
|
end
|
2557
3199
|
|
3200
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3201
|
+
# change.
|
3202
|
+
#
|
3203
|
+
# Lists the quick connects associated with a queue.
|
3204
|
+
#
|
3205
|
+
# @option params [required, String] :instance_id
|
3206
|
+
# The identifier of the Amazon Connect instance.
|
3207
|
+
#
|
3208
|
+
# @option params [required, String] :queue_id
|
3209
|
+
# The identifier for the queue.
|
3210
|
+
#
|
3211
|
+
# @option params [String] :next_token
|
3212
|
+
# The token for the next set of results. Use the value returned in the
|
3213
|
+
# previous response in the next request to retrieve the next set of
|
3214
|
+
# results.
|
3215
|
+
#
|
3216
|
+
# @option params [Integer] :max_results
|
3217
|
+
# The maximum number of results to return per page.
|
3218
|
+
#
|
3219
|
+
# @return [Types::ListQueueQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3220
|
+
#
|
3221
|
+
# * {Types::ListQueueQuickConnectsResponse#next_token #next_token} => String
|
3222
|
+
# * {Types::ListQueueQuickConnectsResponse#quick_connect_summary_list #quick_connect_summary_list} => Array<Types::QuickConnectSummary>
|
3223
|
+
#
|
3224
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3225
|
+
#
|
3226
|
+
# @example Request syntax with placeholder values
|
3227
|
+
#
|
3228
|
+
# resp = client.list_queue_quick_connects({
|
3229
|
+
# instance_id: "InstanceId", # required
|
3230
|
+
# queue_id: "QueueId", # required
|
3231
|
+
# next_token: "NextToken",
|
3232
|
+
# max_results: 1,
|
3233
|
+
# })
|
3234
|
+
#
|
3235
|
+
# @example Response structure
|
3236
|
+
#
|
3237
|
+
# resp.next_token #=> String
|
3238
|
+
# resp.quick_connect_summary_list #=> Array
|
3239
|
+
# resp.quick_connect_summary_list[0].id #=> String
|
3240
|
+
# resp.quick_connect_summary_list[0].arn #=> String
|
3241
|
+
# resp.quick_connect_summary_list[0].name #=> String
|
3242
|
+
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
3243
|
+
#
|
3244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueueQuickConnects AWS API Documentation
|
3245
|
+
#
|
3246
|
+
# @overload list_queue_quick_connects(params = {})
|
3247
|
+
# @param [Hash] params ({})
|
3248
|
+
def list_queue_quick_connects(params = {}, options = {})
|
3249
|
+
req = build_request(:list_queue_quick_connects, params)
|
3250
|
+
req.send_request(options)
|
3251
|
+
end
|
3252
|
+
|
2558
3253
|
# Provides information about the queues for the specified Amazon Connect
|
2559
3254
|
# instance.
|
2560
3255
|
#
|
@@ -2577,7 +3272,7 @@ module Aws::Connect
|
|
2577
3272
|
# results.
|
2578
3273
|
#
|
2579
3274
|
# @option params [Integer] :max_results
|
2580
|
-
# The
|
3275
|
+
# The maximum number of results to return per page.
|
2581
3276
|
#
|
2582
3277
|
# @return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2583
3278
|
#
|
@@ -2604,16 +3299,73 @@ module Aws::Connect
|
|
2604
3299
|
# resp.queue_summary_list[0].queue_type #=> String, one of "STANDARD", "AGENT"
|
2605
3300
|
# resp.next_token #=> String
|
2606
3301
|
#
|
2607
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueues AWS API Documentation
|
3302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueues AWS API Documentation
|
3303
|
+
#
|
3304
|
+
# @overload list_queues(params = {})
|
3305
|
+
# @param [Hash] params ({})
|
3306
|
+
def list_queues(params = {}, options = {})
|
3307
|
+
req = build_request(:list_queues, params)
|
3308
|
+
req.send_request(options)
|
3309
|
+
end
|
3310
|
+
|
3311
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3312
|
+
# change.
|
3313
|
+
#
|
3314
|
+
# Provides information about the quick connects for the specified Amazon
|
3315
|
+
# Connect instance.
|
3316
|
+
#
|
3317
|
+
# @option params [required, String] :instance_id
|
3318
|
+
# The identifier of the Amazon Connect instance.
|
3319
|
+
#
|
3320
|
+
# @option params [String] :next_token
|
3321
|
+
# The token for the next set of results. Use the value returned in the
|
3322
|
+
# previous response in the next request to retrieve the next set of
|
3323
|
+
# results.
|
3324
|
+
#
|
3325
|
+
# @option params [Integer] :max_results
|
3326
|
+
# The maximum number of results to return per page.
|
3327
|
+
#
|
3328
|
+
# @option params [Array<String>] :quick_connect_types
|
3329
|
+
# The type of quick connect. In the Amazon Connect console, when you
|
3330
|
+
# create a quick connect, you are prompted to assign one of the
|
3331
|
+
# following types: Agent (USER), External (PHONE\_NUMBER), or Queue
|
3332
|
+
# (QUEUE).
|
3333
|
+
#
|
3334
|
+
# @return [Types::ListQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3335
|
+
#
|
3336
|
+
# * {Types::ListQuickConnectsResponse#quick_connect_summary_list #quick_connect_summary_list} => Array<Types::QuickConnectSummary>
|
3337
|
+
# * {Types::ListQuickConnectsResponse#next_token #next_token} => String
|
3338
|
+
#
|
3339
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3340
|
+
#
|
3341
|
+
# @example Request syntax with placeholder values
|
3342
|
+
#
|
3343
|
+
# resp = client.list_quick_connects({
|
3344
|
+
# instance_id: "InstanceId", # required
|
3345
|
+
# next_token: "NextToken",
|
3346
|
+
# max_results: 1,
|
3347
|
+
# quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
|
3348
|
+
# })
|
3349
|
+
#
|
3350
|
+
# @example Response structure
|
3351
|
+
#
|
3352
|
+
# resp.quick_connect_summary_list #=> Array
|
3353
|
+
# resp.quick_connect_summary_list[0].id #=> String
|
3354
|
+
# resp.quick_connect_summary_list[0].arn #=> String
|
3355
|
+
# resp.quick_connect_summary_list[0].name #=> String
|
3356
|
+
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
3357
|
+
# resp.next_token #=> String
|
3358
|
+
#
|
3359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQuickConnects AWS API Documentation
|
2608
3360
|
#
|
2609
|
-
# @overload
|
3361
|
+
# @overload list_quick_connects(params = {})
|
2610
3362
|
# @param [Hash] params ({})
|
2611
|
-
def
|
2612
|
-
req = build_request(:
|
3363
|
+
def list_quick_connects(params = {}, options = {})
|
3364
|
+
req = build_request(:list_quick_connects, params)
|
2613
3365
|
req.send_request(options)
|
2614
3366
|
end
|
2615
3367
|
|
2616
|
-
#
|
3368
|
+
# Lists the queues associated with a routing profile.
|
2617
3369
|
#
|
2618
3370
|
# @option params [required, String] :instance_id
|
2619
3371
|
# The identifier of the Amazon Connect instance.
|
@@ -2627,7 +3379,7 @@ module Aws::Connect
|
|
2627
3379
|
# results.
|
2628
3380
|
#
|
2629
3381
|
# @option params [Integer] :max_results
|
2630
|
-
# The
|
3382
|
+
# The maximum number of results to return per page.
|
2631
3383
|
#
|
2632
3384
|
# @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2633
3385
|
#
|
@@ -2654,7 +3406,7 @@ module Aws::Connect
|
|
2654
3406
|
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
2655
3407
|
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
2656
3408
|
# resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
|
2657
|
-
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT"
|
3409
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2658
3410
|
#
|
2659
3411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
2660
3412
|
#
|
@@ -2686,7 +3438,7 @@ module Aws::Connect
|
|
2686
3438
|
# results.
|
2687
3439
|
#
|
2688
3440
|
# @option params [Integer] :max_results
|
2689
|
-
# The
|
3441
|
+
# The maximum number of results to return per page.
|
2690
3442
|
#
|
2691
3443
|
# @return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2692
3444
|
#
|
@@ -2720,6 +3472,9 @@ module Aws::Connect
|
|
2720
3472
|
req.send_request(options)
|
2721
3473
|
end
|
2722
3474
|
|
3475
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3476
|
+
# change.
|
3477
|
+
#
|
2723
3478
|
# Returns a paginated list of all security keys associated with the
|
2724
3479
|
# instance.
|
2725
3480
|
#
|
@@ -2732,7 +3487,7 @@ module Aws::Connect
|
|
2732
3487
|
# results.
|
2733
3488
|
#
|
2734
3489
|
# @option params [Integer] :max_results
|
2735
|
-
# The
|
3490
|
+
# The maximum number of results to return per page.
|
2736
3491
|
#
|
2737
3492
|
# @return [Types::ListSecurityKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2738
3493
|
#
|
@@ -2785,7 +3540,7 @@ module Aws::Connect
|
|
2785
3540
|
# results.
|
2786
3541
|
#
|
2787
3542
|
# @option params [Integer] :max_results
|
2788
|
-
# The
|
3543
|
+
# The maximum number of results to return per page.
|
2789
3544
|
#
|
2790
3545
|
# @return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2791
3546
|
#
|
@@ -2855,6 +3610,58 @@ module Aws::Connect
|
|
2855
3610
|
req.send_request(options)
|
2856
3611
|
end
|
2857
3612
|
|
3613
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3614
|
+
# change.
|
3615
|
+
#
|
3616
|
+
# Lists the use cases.
|
3617
|
+
#
|
3618
|
+
# @option params [required, String] :instance_id
|
3619
|
+
# The identifier of the Amazon Connect instance.
|
3620
|
+
#
|
3621
|
+
# @option params [required, String] :integration_association_id
|
3622
|
+
# The identifier for the integration association.
|
3623
|
+
#
|
3624
|
+
# @option params [String] :next_token
|
3625
|
+
# The token for the next set of results. Use the value returned in the
|
3626
|
+
# previous response in the next request to retrieve the next set of
|
3627
|
+
# results.
|
3628
|
+
#
|
3629
|
+
# @option params [Integer] :max_results
|
3630
|
+
# The maximum number of results to return per page.
|
3631
|
+
#
|
3632
|
+
# @return [Types::ListUseCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3633
|
+
#
|
3634
|
+
# * {Types::ListUseCasesResponse#use_case_summary_list #use_case_summary_list} => Array<Types::UseCase>
|
3635
|
+
# * {Types::ListUseCasesResponse#next_token #next_token} => String
|
3636
|
+
#
|
3637
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3638
|
+
#
|
3639
|
+
# @example Request syntax with placeholder values
|
3640
|
+
#
|
3641
|
+
# resp = client.list_use_cases({
|
3642
|
+
# instance_id: "InstanceId", # required
|
3643
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
3644
|
+
# next_token: "NextToken",
|
3645
|
+
# max_results: 1,
|
3646
|
+
# })
|
3647
|
+
#
|
3648
|
+
# @example Response structure
|
3649
|
+
#
|
3650
|
+
# resp.use_case_summary_list #=> Array
|
3651
|
+
# resp.use_case_summary_list[0].use_case_id #=> String
|
3652
|
+
# resp.use_case_summary_list[0].use_case_arn #=> String
|
3653
|
+
# resp.use_case_summary_list[0].use_case_type #=> String, one of "RULES_EVALUATION"
|
3654
|
+
# resp.next_token #=> String
|
3655
|
+
#
|
3656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCases AWS API Documentation
|
3657
|
+
#
|
3658
|
+
# @overload list_use_cases(params = {})
|
3659
|
+
# @param [Hash] params ({})
|
3660
|
+
def list_use_cases(params = {}, options = {})
|
3661
|
+
req = build_request(:list_use_cases, params)
|
3662
|
+
req.send_request(options)
|
3663
|
+
end
|
3664
|
+
|
2858
3665
|
# Provides summary information about the hierarchy groups for the
|
2859
3666
|
# specified Amazon Connect instance.
|
2860
3667
|
#
|
@@ -2874,7 +3681,7 @@ module Aws::Connect
|
|
2874
3681
|
# results.
|
2875
3682
|
#
|
2876
3683
|
# @option params [Integer] :max_results
|
2877
|
-
# The
|
3684
|
+
# The maximum number of results to return per page.
|
2878
3685
|
#
|
2879
3686
|
# @return [Types::ListUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2880
3687
|
#
|
@@ -2920,7 +3727,7 @@ module Aws::Connect
|
|
2920
3727
|
# results.
|
2921
3728
|
#
|
2922
3729
|
# @option params [Integer] :max_results
|
2923
|
-
# The
|
3730
|
+
# The maximum number of results to return per page.
|
2924
3731
|
#
|
2925
3732
|
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2926
3733
|
#
|
@@ -2993,7 +3800,7 @@ module Aws::Connect
|
|
2993
3800
|
# from the [CreateParticipantConnection][1] API in the Amazon Connect
|
2994
3801
|
# Participant Service.
|
2995
3802
|
#
|
2996
|
-
# When a new chat contact is successfully created, clients
|
3803
|
+
# When a new chat contact is successfully created, clients must
|
2997
3804
|
# subscribe to the participant’s connection for the created chat within
|
2998
3805
|
# 5 minutes. This is achieved by invoking
|
2999
3806
|
# [CreateParticipantConnection][1] with WEBSOCKET and
|
@@ -3007,8 +3814,8 @@ module Aws::Connect
|
|
3007
3814
|
# * The [quota for concurrent active chats][2] is exceeded. Active chat
|
3008
3815
|
# throttling returns a `LimitExceededException`.
|
3009
3816
|
#
|
3010
|
-
# For more information about
|
3011
|
-
#
|
3817
|
+
# For more information about chat, see [Chat][3] in the *Amazon Connect
|
3818
|
+
# Administrator Guide*.
|
3012
3819
|
#
|
3013
3820
|
#
|
3014
3821
|
#
|
@@ -3031,7 +3838,7 @@ module Aws::Connect
|
|
3031
3838
|
#
|
3032
3839
|
# @option params [Hash<String,String>] :attributes
|
3033
3840
|
# A custom key-value pair using an attribute map. The attributes are
|
3034
|
-
# standard Amazon Connect attributes
|
3841
|
+
# standard Amazon Connect attributes. They can be accessed in contact
|
3035
3842
|
# flows just like any other contact attributes.
|
3036
3843
|
#
|
3037
3844
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
@@ -3090,7 +3897,7 @@ module Aws::Connect
|
|
3090
3897
|
req.send_request(options)
|
3091
3898
|
end
|
3092
3899
|
|
3093
|
-
#
|
3900
|
+
# Starts recording the contact when the agent joins the call.
|
3094
3901
|
# StartContactRecording is a one-time action. For example, if you use
|
3095
3902
|
# StopContactRecording to stop recording an ongoing call, you can't use
|
3096
3903
|
# StartContactRecording to restart it. For scenarios where the recording
|
@@ -3118,7 +3925,7 @@ module Aws::Connect
|
|
3118
3925
|
# associated with the first interaction with the contact center.
|
3119
3926
|
#
|
3120
3927
|
# @option params [required, Types::VoiceRecordingConfiguration] :voice_recording_configuration
|
3121
|
-
#
|
3928
|
+
# The person being recorded.
|
3122
3929
|
#
|
3123
3930
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3124
3931
|
#
|
@@ -3142,16 +3949,16 @@ module Aws::Connect
|
|
3142
3949
|
req.send_request(options)
|
3143
3950
|
end
|
3144
3951
|
|
3145
|
-
#
|
3146
|
-
#
|
3147
|
-
#
|
3952
|
+
# Places an outbound call to a contact, and then initiates the contact
|
3953
|
+
# flow. It performs the actions in the contact flow that's specified
|
3954
|
+
# (in `ContactFlowId`).
|
3148
3955
|
#
|
3149
|
-
# Agents
|
3150
|
-
#
|
3151
|
-
# contact, and then puts the contact in queue,
|
3152
|
-
#
|
3956
|
+
# Agents do not initiate the outbound API, which means that they do not
|
3957
|
+
# dial the contact. If the contact flow places an outbound call to a
|
3958
|
+
# contact, and then puts the contact in queue, the call is then routed
|
3959
|
+
# to the agent, like any other inbound case.
|
3153
3960
|
#
|
3154
|
-
# There is a 60
|
3961
|
+
# There is a 60-second dialing timeout for this operation. If the call
|
3155
3962
|
# is not connected after 60 seconds, it fails.
|
3156
3963
|
#
|
3157
3964
|
# <note markdown="1"> UK numbers with a 447 prefix are not allowed by default. Before you
|
@@ -3241,6 +4048,89 @@ module Aws::Connect
|
|
3241
4048
|
req.send_request(options)
|
3242
4049
|
end
|
3243
4050
|
|
4051
|
+
# Initiates a contact flow to start a new task.
|
4052
|
+
#
|
4053
|
+
# @option params [required, String] :instance_id
|
4054
|
+
# The identifier of the Amazon Connect instance.
|
4055
|
+
#
|
4056
|
+
# @option params [String] :previous_contact_id
|
4057
|
+
# The identifier of the previous chat, voice, or task contact.
|
4058
|
+
#
|
4059
|
+
# @option params [required, String] :contact_flow_id
|
4060
|
+
# The identifier of the contact flow for initiating the tasks. To see
|
4061
|
+
# the ContactFlowId in the Amazon Connect console user interface, on the
|
4062
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
4063
|
+
# contact flow. On the contact flow page, under the name of the contact
|
4064
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
4065
|
+
# is the last part of the ARN, shown here in bold:
|
4066
|
+
#
|
4067
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
4068
|
+
#
|
4069
|
+
# @option params [Hash<String,String>] :attributes
|
4070
|
+
# A custom key-value pair using an attribute map. The attributes are
|
4071
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
4072
|
+
# flows just like any other contact attributes.
|
4073
|
+
#
|
4074
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
4075
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
4076
|
+
# underscore characters.
|
4077
|
+
#
|
4078
|
+
# @option params [required, String] :name
|
4079
|
+
# The name of a task that is shown to an agent in the Contact Control
|
4080
|
+
# Panel (CCP).
|
4081
|
+
#
|
4082
|
+
# @option params [Hash<String,Types::Reference>] :references
|
4083
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
4084
|
+
# (CCP).
|
4085
|
+
#
|
4086
|
+
# @option params [String] :description
|
4087
|
+
# A description of the task that is shown to an agent in the Contact
|
4088
|
+
# Control Panel (CCP).
|
4089
|
+
#
|
4090
|
+
# @option params [String] :client_token
|
4091
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
4092
|
+
# idempotency of the request.
|
4093
|
+
#
|
4094
|
+
# **A suitable default value is auto-generated.** You should normally
|
4095
|
+
# not need to pass this option.**
|
4096
|
+
#
|
4097
|
+
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4098
|
+
#
|
4099
|
+
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
4100
|
+
#
|
4101
|
+
# @example Request syntax with placeholder values
|
4102
|
+
#
|
4103
|
+
# resp = client.start_task_contact({
|
4104
|
+
# instance_id: "InstanceId", # required
|
4105
|
+
# previous_contact_id: "ContactId",
|
4106
|
+
# contact_flow_id: "ContactFlowId", # required
|
4107
|
+
# attributes: {
|
4108
|
+
# "AttributeName" => "AttributeValue",
|
4109
|
+
# },
|
4110
|
+
# name: "Name", # required
|
4111
|
+
# references: {
|
4112
|
+
# "ReferenceKey" => {
|
4113
|
+
# value: "ReferenceValue", # required
|
4114
|
+
# type: "URL", # required, accepts URL
|
4115
|
+
# },
|
4116
|
+
# },
|
4117
|
+
# description: "Description",
|
4118
|
+
# client_token: "ClientToken",
|
4119
|
+
# })
|
4120
|
+
#
|
4121
|
+
# @example Response structure
|
4122
|
+
#
|
4123
|
+
# resp.contact_id #=> String
|
4124
|
+
#
|
4125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContact AWS API Documentation
|
4126
|
+
#
|
4127
|
+
# @overload start_task_contact(params = {})
|
4128
|
+
# @param [Hash] params ({})
|
4129
|
+
def start_task_contact(params = {}, options = {})
|
4130
|
+
req = build_request(:start_task_contact, params)
|
4131
|
+
req.send_request(options)
|
4132
|
+
end
|
4133
|
+
|
3244
4134
|
# Ends the specified contact.
|
3245
4135
|
#
|
3246
4136
|
# @option params [required, String] :contact_id
|
@@ -3267,7 +4157,7 @@ module Aws::Connect
|
|
3267
4157
|
req.send_request(options)
|
3268
4158
|
end
|
3269
4159
|
|
3270
|
-
#
|
4160
|
+
# Stops recording a call when a contact is being recorded.
|
3271
4161
|
# StopContactRecording is a one-time action. If you use
|
3272
4162
|
# StopContactRecording to stop recording an ongoing call, you can't use
|
3273
4163
|
# StartContactRecording to restart it. For scenarios where the recording
|
@@ -3347,8 +4237,8 @@ module Aws::Connect
|
|
3347
4237
|
|
3348
4238
|
# Adds the specified tags to the specified resource.
|
3349
4239
|
#
|
3350
|
-
# The supported resource types are users, routing profiles,
|
3351
|
-
# flows.
|
4240
|
+
# The supported resource types are users, routing profiles, queues,
|
4241
|
+
# quick connects, and contact flows.
|
3352
4242
|
#
|
3353
4243
|
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
3354
4244
|
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
@@ -3414,25 +4304,26 @@ module Aws::Connect
|
|
3414
4304
|
# specified contact.
|
3415
4305
|
#
|
3416
4306
|
# You can add or update attributes for both ongoing and completed
|
3417
|
-
# contacts. For example,
|
3418
|
-
#
|
3419
|
-
# about steps that the agent took during the call that
|
3420
|
-
#
|
3421
|
-
#
|
4307
|
+
# contacts. For example, while the call is active, you can update the
|
4308
|
+
# customer's name or the reason the customer called. You can add notes
|
4309
|
+
# about steps that the agent took during the call that display to the
|
4310
|
+
# next agent that takes the call. You can also update attributes for a
|
4311
|
+
# contact using data from your CRM application and save the data with
|
3422
4312
|
# the contact in Amazon Connect. You could also flag calls for
|
3423
|
-
# additional analysis, such as legal review or
|
4313
|
+
# additional analysis, such as legal review or to identify abusive
|
3424
4314
|
# callers.
|
3425
4315
|
#
|
3426
4316
|
# Contact attributes are available in Amazon Connect for 24 months, and
|
3427
4317
|
# are then deleted.
|
3428
4318
|
#
|
3429
4319
|
# **Important:** You cannot use the operation to update attributes for
|
3430
|
-
# contacts that occurred prior to the release of the API,
|
3431
|
-
# 2018. You can update attributes only for contacts that
|
3432
|
-
# the release of the API. If you attempt to update
|
3433
|
-
# contact that occurred prior to the release of the
|
3434
|
-
# returned. This applies also to queued callbacks
|
3435
|
-
# prior to the release of the API but are still
|
4320
|
+
# contacts that occurred prior to the release of the API, which was
|
4321
|
+
# September 12, 2018. You can update attributes only for contacts that
|
4322
|
+
# started after the release of the API. If you attempt to update
|
4323
|
+
# attributes for a contact that occurred prior to the release of the
|
4324
|
+
# API, a 400 error is returned. This applies also to queued callbacks
|
4325
|
+
# that were initiated prior to the release of the API but are still
|
4326
|
+
# active in your instance.
|
3436
4327
|
#
|
3437
4328
|
# @option params [required, String] :initial_contact_id
|
3438
4329
|
# The identifier of the contact. This is the identifier of the contact
|
@@ -3554,6 +4445,9 @@ module Aws::Connect
|
|
3554
4445
|
req.send_request(options)
|
3555
4446
|
end
|
3556
4447
|
|
4448
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4449
|
+
# change.
|
4450
|
+
#
|
3557
4451
|
# Updates the value for the specified attribute type.
|
3558
4452
|
#
|
3559
4453
|
# @option params [required, String] :instance_id
|
@@ -3584,6 +4478,9 @@ module Aws::Connect
|
|
3584
4478
|
req.send_request(options)
|
3585
4479
|
end
|
3586
4480
|
|
4481
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4482
|
+
# change.
|
4483
|
+
#
|
3587
4484
|
# Updates an existing configuration for a resource type. This API is
|
3588
4485
|
# idempotent.
|
3589
4486
|
#
|
@@ -3645,6 +4542,268 @@ module Aws::Connect
|
|
3645
4542
|
req.send_request(options)
|
3646
4543
|
end
|
3647
4544
|
|
4545
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4546
|
+
# change.
|
4547
|
+
#
|
4548
|
+
# Updates the hours of operation for the specified queue.
|
4549
|
+
#
|
4550
|
+
# @option params [required, String] :instance_id
|
4551
|
+
# The identifier of the Amazon Connect instance.
|
4552
|
+
#
|
4553
|
+
# @option params [required, String] :queue_id
|
4554
|
+
# The identifier for the queue.
|
4555
|
+
#
|
4556
|
+
# @option params [required, String] :hours_of_operation_id
|
4557
|
+
# The identifier for the hours of operation.
|
4558
|
+
#
|
4559
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4560
|
+
#
|
4561
|
+
# @example Request syntax with placeholder values
|
4562
|
+
#
|
4563
|
+
# resp = client.update_queue_hours_of_operation({
|
4564
|
+
# instance_id: "InstanceId", # required
|
4565
|
+
# queue_id: "QueueId", # required
|
4566
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
4567
|
+
# })
|
4568
|
+
#
|
4569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueHoursOfOperation AWS API Documentation
|
4570
|
+
#
|
4571
|
+
# @overload update_queue_hours_of_operation(params = {})
|
4572
|
+
# @param [Hash] params ({})
|
4573
|
+
def update_queue_hours_of_operation(params = {}, options = {})
|
4574
|
+
req = build_request(:update_queue_hours_of_operation, params)
|
4575
|
+
req.send_request(options)
|
4576
|
+
end
|
4577
|
+
|
4578
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4579
|
+
# change.
|
4580
|
+
#
|
4581
|
+
# Updates the maximum number of contacts allowed in a queue before it is
|
4582
|
+
# considered full.
|
4583
|
+
#
|
4584
|
+
# @option params [required, String] :instance_id
|
4585
|
+
# The identifier of the Amazon Connect instance.
|
4586
|
+
#
|
4587
|
+
# @option params [required, String] :queue_id
|
4588
|
+
# The identifier for the queue.
|
4589
|
+
#
|
4590
|
+
# @option params [required, Integer] :max_contacts
|
4591
|
+
# The maximum number of contacts that can be in the queue before it is
|
4592
|
+
# considered full.
|
4593
|
+
#
|
4594
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4595
|
+
#
|
4596
|
+
# @example Request syntax with placeholder values
|
4597
|
+
#
|
4598
|
+
# resp = client.update_queue_max_contacts({
|
4599
|
+
# instance_id: "InstanceId", # required
|
4600
|
+
# queue_id: "QueueId", # required
|
4601
|
+
# max_contacts: 1, # required
|
4602
|
+
# })
|
4603
|
+
#
|
4604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueMaxContacts AWS API Documentation
|
4605
|
+
#
|
4606
|
+
# @overload update_queue_max_contacts(params = {})
|
4607
|
+
# @param [Hash] params ({})
|
4608
|
+
def update_queue_max_contacts(params = {}, options = {})
|
4609
|
+
req = build_request(:update_queue_max_contacts, params)
|
4610
|
+
req.send_request(options)
|
4611
|
+
end
|
4612
|
+
|
4613
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4614
|
+
# change.
|
4615
|
+
#
|
4616
|
+
# Updates the name and description of a queue. At least `Name` or
|
4617
|
+
# `Description` must be provided.
|
4618
|
+
#
|
4619
|
+
# @option params [required, String] :instance_id
|
4620
|
+
# The identifier of the Amazon Connect instance.
|
4621
|
+
#
|
4622
|
+
# @option params [required, String] :queue_id
|
4623
|
+
# The identifier for the queue.
|
4624
|
+
#
|
4625
|
+
# @option params [String] :name
|
4626
|
+
# The name of the queue.
|
4627
|
+
#
|
4628
|
+
# @option params [String] :description
|
4629
|
+
# The description of the queue.
|
4630
|
+
#
|
4631
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4632
|
+
#
|
4633
|
+
# @example Request syntax with placeholder values
|
4634
|
+
#
|
4635
|
+
# resp = client.update_queue_name({
|
4636
|
+
# instance_id: "InstanceId", # required
|
4637
|
+
# queue_id: "QueueId", # required
|
4638
|
+
# name: "CommonNameLength127",
|
4639
|
+
# description: "QueueDescription",
|
4640
|
+
# })
|
4641
|
+
#
|
4642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueName AWS API Documentation
|
4643
|
+
#
|
4644
|
+
# @overload update_queue_name(params = {})
|
4645
|
+
# @param [Hash] params ({})
|
4646
|
+
def update_queue_name(params = {}, options = {})
|
4647
|
+
req = build_request(:update_queue_name, params)
|
4648
|
+
req.send_request(options)
|
4649
|
+
end
|
4650
|
+
|
4651
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4652
|
+
# change.
|
4653
|
+
#
|
4654
|
+
# Updates the outbound caller ID name, number, and outbound whisper flow
|
4655
|
+
# for a specified queue.
|
4656
|
+
#
|
4657
|
+
# @option params [required, String] :instance_id
|
4658
|
+
# The identifier of the Amazon Connect instance.
|
4659
|
+
#
|
4660
|
+
# @option params [required, String] :queue_id
|
4661
|
+
# The identifier for the queue.
|
4662
|
+
#
|
4663
|
+
# @option params [required, Types::OutboundCallerConfig] :outbound_caller_config
|
4664
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
4665
|
+
#
|
4666
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4667
|
+
#
|
4668
|
+
# @example Request syntax with placeholder values
|
4669
|
+
#
|
4670
|
+
# resp = client.update_queue_outbound_caller_config({
|
4671
|
+
# instance_id: "InstanceId", # required
|
4672
|
+
# queue_id: "QueueId", # required
|
4673
|
+
# outbound_caller_config: { # required
|
4674
|
+
# outbound_caller_id_name: "OutboundCallerIdName",
|
4675
|
+
# outbound_caller_id_number_id: "PhoneNumberId",
|
4676
|
+
# outbound_flow_id: "ContactFlowId",
|
4677
|
+
# },
|
4678
|
+
# })
|
4679
|
+
#
|
4680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundCallerConfig AWS API Documentation
|
4681
|
+
#
|
4682
|
+
# @overload update_queue_outbound_caller_config(params = {})
|
4683
|
+
# @param [Hash] params ({})
|
4684
|
+
def update_queue_outbound_caller_config(params = {}, options = {})
|
4685
|
+
req = build_request(:update_queue_outbound_caller_config, params)
|
4686
|
+
req.send_request(options)
|
4687
|
+
end
|
4688
|
+
|
4689
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4690
|
+
# change.
|
4691
|
+
#
|
4692
|
+
# Updates the status of the queue.
|
4693
|
+
#
|
4694
|
+
# @option params [required, String] :instance_id
|
4695
|
+
# The identifier of the Amazon Connect instance.
|
4696
|
+
#
|
4697
|
+
# @option params [required, String] :queue_id
|
4698
|
+
# The identifier for the queue.
|
4699
|
+
#
|
4700
|
+
# @option params [required, String] :status
|
4701
|
+
# The status of the queue.
|
4702
|
+
#
|
4703
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4704
|
+
#
|
4705
|
+
# @example Request syntax with placeholder values
|
4706
|
+
#
|
4707
|
+
# resp = client.update_queue_status({
|
4708
|
+
# instance_id: "InstanceId", # required
|
4709
|
+
# queue_id: "QueueId", # required
|
4710
|
+
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
4711
|
+
# })
|
4712
|
+
#
|
4713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueStatus AWS API Documentation
|
4714
|
+
#
|
4715
|
+
# @overload update_queue_status(params = {})
|
4716
|
+
# @param [Hash] params ({})
|
4717
|
+
def update_queue_status(params = {}, options = {})
|
4718
|
+
req = build_request(:update_queue_status, params)
|
4719
|
+
req.send_request(options)
|
4720
|
+
end
|
4721
|
+
|
4722
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4723
|
+
# change.
|
4724
|
+
#
|
4725
|
+
# Updates the configuration settings for the specified quick connect.
|
4726
|
+
#
|
4727
|
+
# @option params [required, String] :instance_id
|
4728
|
+
# The identifier of the Amazon Connect instance.
|
4729
|
+
#
|
4730
|
+
# @option params [required, String] :quick_connect_id
|
4731
|
+
# The identifier for the quick connect.
|
4732
|
+
#
|
4733
|
+
# @option params [required, Types::QuickConnectConfig] :quick_connect_config
|
4734
|
+
# Information about the configuration settings for the quick connect.
|
4735
|
+
#
|
4736
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4737
|
+
#
|
4738
|
+
# @example Request syntax with placeholder values
|
4739
|
+
#
|
4740
|
+
# resp = client.update_quick_connect_config({
|
4741
|
+
# instance_id: "InstanceId", # required
|
4742
|
+
# quick_connect_id: "QuickConnectId", # required
|
4743
|
+
# quick_connect_config: { # required
|
4744
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
4745
|
+
# user_config: {
|
4746
|
+
# user_id: "UserId", # required
|
4747
|
+
# contact_flow_id: "ContactFlowId", # required
|
4748
|
+
# },
|
4749
|
+
# queue_config: {
|
4750
|
+
# queue_id: "QueueId", # required
|
4751
|
+
# contact_flow_id: "ContactFlowId", # required
|
4752
|
+
# },
|
4753
|
+
# phone_config: {
|
4754
|
+
# phone_number: "PhoneNumber", # required
|
4755
|
+
# },
|
4756
|
+
# },
|
4757
|
+
# })
|
4758
|
+
#
|
4759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectConfig AWS API Documentation
|
4760
|
+
#
|
4761
|
+
# @overload update_quick_connect_config(params = {})
|
4762
|
+
# @param [Hash] params ({})
|
4763
|
+
def update_quick_connect_config(params = {}, options = {})
|
4764
|
+
req = build_request(:update_quick_connect_config, params)
|
4765
|
+
req.send_request(options)
|
4766
|
+
end
|
4767
|
+
|
4768
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4769
|
+
# change.
|
4770
|
+
#
|
4771
|
+
# Updates the name and description of a quick connect. The request
|
4772
|
+
# accepts the following data in JSON format. At least `Name` or
|
4773
|
+
# `Description` must be provided.
|
4774
|
+
#
|
4775
|
+
# @option params [required, String] :instance_id
|
4776
|
+
# The identifier of the Amazon Connect instance.
|
4777
|
+
#
|
4778
|
+
# @option params [required, String] :quick_connect_id
|
4779
|
+
# The identifier for the quick connect.
|
4780
|
+
#
|
4781
|
+
# @option params [String] :name
|
4782
|
+
# The name of the quick connect.
|
4783
|
+
#
|
4784
|
+
# @option params [String] :description
|
4785
|
+
# The description of the quick connect.
|
4786
|
+
#
|
4787
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4788
|
+
#
|
4789
|
+
# @example Request syntax with placeholder values
|
4790
|
+
#
|
4791
|
+
# resp = client.update_quick_connect_name({
|
4792
|
+
# instance_id: "InstanceId", # required
|
4793
|
+
# quick_connect_id: "QuickConnectId", # required
|
4794
|
+
# name: "QuickConnectName",
|
4795
|
+
# description: "QuickConnectDescription",
|
4796
|
+
# })
|
4797
|
+
#
|
4798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectName AWS API Documentation
|
4799
|
+
#
|
4800
|
+
# @overload update_quick_connect_name(params = {})
|
4801
|
+
# @param [Hash] params ({})
|
4802
|
+
def update_quick_connect_name(params = {}, options = {})
|
4803
|
+
req = build_request(:update_quick_connect_name, params)
|
4804
|
+
req.send_request(options)
|
4805
|
+
end
|
4806
|
+
|
3648
4807
|
# Updates the channels that agents can handle in the Contact Control
|
3649
4808
|
# Panel (CCP) for a routing profile.
|
3650
4809
|
#
|
@@ -3655,7 +4814,8 @@ module Aws::Connect
|
|
3655
4814
|
# The identifier of the routing profile.
|
3656
4815
|
#
|
3657
4816
|
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
3658
|
-
# The channels agents can handle in the Contact Control Panel
|
4817
|
+
# The channels that agents can handle in the Contact Control Panel
|
4818
|
+
# (CCP).
|
3659
4819
|
#
|
3660
4820
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3661
4821
|
#
|
@@ -3666,7 +4826,7 @@ module Aws::Connect
|
|
3666
4826
|
# routing_profile_id: "RoutingProfileId", # required
|
3667
4827
|
# media_concurrencies: [ # required
|
3668
4828
|
# {
|
3669
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4829
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
3670
4830
|
# concurrency: 1, # required
|
3671
4831
|
# },
|
3672
4832
|
# ],
|
@@ -3758,7 +4918,9 @@ module Aws::Connect
|
|
3758
4918
|
# The identifier of the routing profile.
|
3759
4919
|
#
|
3760
4920
|
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
3761
|
-
# The queues to be updated for this routing profile.
|
4921
|
+
# The queues to be updated for this routing profile. Queues must first
|
4922
|
+
# be associated to the routing profile. You can do this using
|
4923
|
+
# AssociateRoutingProfileQueues.
|
3762
4924
|
#
|
3763
4925
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3764
4926
|
#
|
@@ -3771,7 +4933,7 @@ module Aws::Connect
|
|
3771
4933
|
# {
|
3772
4934
|
# queue_reference: { # required
|
3773
4935
|
# queue_id: "QueueId", # required
|
3774
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4936
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
3775
4937
|
# },
|
3776
4938
|
# priority: 1, # required
|
3777
4939
|
# delay: 1, # required
|
@@ -3893,14 +5055,13 @@ module Aws::Connect
|
|
3893
5055
|
|
3894
5056
|
# Updates the identity information for the specified user.
|
3895
5057
|
#
|
3896
|
-
#
|
3897
|
-
#
|
3898
|
-
#
|
3899
|
-
#
|
3900
|
-
#
|
3901
|
-
#
|
3902
|
-
#
|
3903
|
-
# *Amazon Connect Administrator Guide*.
|
5058
|
+
# We strongly recommend limiting who has the ability to invoke
|
5059
|
+
# `UpdateUserIdentityInfo`. Someone with that ability can change the
|
5060
|
+
# login credentials of other users by changing their email address. This
|
5061
|
+
# poses a security risk to your organization. They can change the email
|
5062
|
+
# address of a user to the attacker's email address, and then reset the
|
5063
|
+
# password through email. For more information, see [Best Practices for
|
5064
|
+
# Security Profiles][1] in the *Amazon Connect Administrator Guide*.
|
3904
5065
|
#
|
3905
5066
|
#
|
3906
5067
|
#
|
@@ -4046,7 +5207,7 @@ module Aws::Connect
|
|
4046
5207
|
params: params,
|
4047
5208
|
config: config)
|
4048
5209
|
context[:gem_name] = 'aws-sdk-connect'
|
4049
|
-
context[:gem_version] = '1.
|
5210
|
+
context[:gem_version] = '1.41.0'
|
4050
5211
|
Seahorse::Client::Request.new(handlers, context)
|
4051
5212
|
end
|
4052
5213
|
|