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
@@ -158,6 +158,37 @@ module Aws::Connect
|
|
158
158
|
include Aws::Structure
|
159
159
|
end
|
160
160
|
|
161
|
+
# @note When making an API call, you may pass AssociateQueueQuickConnectsRequest
|
162
|
+
# data as a hash:
|
163
|
+
#
|
164
|
+
# {
|
165
|
+
# instance_id: "InstanceId", # required
|
166
|
+
# queue_id: "QueueId", # required
|
167
|
+
# quick_connect_ids: ["QuickConnectId"], # required
|
168
|
+
# }
|
169
|
+
#
|
170
|
+
# @!attribute [rw] instance_id
|
171
|
+
# The identifier of the Amazon Connect instance.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] queue_id
|
175
|
+
# The identifier for the queue.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] quick_connect_ids
|
179
|
+
# The quick connects to associate with this queue.
|
180
|
+
# @return [Array<String>]
|
181
|
+
#
|
182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateQueueQuickConnectsRequest AWS API Documentation
|
183
|
+
#
|
184
|
+
class AssociateQueueQuickConnectsRequest < Struct.new(
|
185
|
+
:instance_id,
|
186
|
+
:queue_id,
|
187
|
+
:quick_connect_ids)
|
188
|
+
SENSITIVE = []
|
189
|
+
include Aws::Structure
|
190
|
+
end
|
191
|
+
|
161
192
|
# @note When making an API call, you may pass AssociateRoutingProfileQueuesRequest
|
162
193
|
# data as a hash:
|
163
194
|
#
|
@@ -168,7 +199,7 @@ module Aws::Connect
|
|
168
199
|
# {
|
169
200
|
# queue_reference: { # required
|
170
201
|
# queue_id: "QueueId", # required
|
171
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
202
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
172
203
|
# },
|
173
204
|
# priority: 1, # required
|
174
205
|
# delay: 1, # required
|
@@ -266,7 +297,7 @@ module Aws::Connect
|
|
266
297
|
# }
|
267
298
|
#
|
268
299
|
# @!attribute [rw] content_type
|
269
|
-
# The type of the content. Supported types are text
|
300
|
+
# The type of the content. Supported types are text and plain.
|
270
301
|
# @return [String]
|
271
302
|
#
|
272
303
|
# @!attribute [rw] content
|
@@ -498,11 +529,11 @@ module Aws::Connect
|
|
498
529
|
# @return [String]
|
499
530
|
#
|
500
531
|
# @!attribute [rw] inbound_calls_enabled
|
501
|
-
#
|
532
|
+
# Your contact center handles incoming contacts.
|
502
533
|
# @return [Boolean]
|
503
534
|
#
|
504
535
|
# @!attribute [rw] outbound_calls_enabled
|
505
|
-
#
|
536
|
+
# Your contact center allows outbound calls.
|
506
537
|
# @return [Boolean]
|
507
538
|
#
|
508
539
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstanceRequest AWS API Documentation
|
@@ -535,6 +566,232 @@ module Aws::Connect
|
|
535
566
|
include Aws::Structure
|
536
567
|
end
|
537
568
|
|
569
|
+
# @note When making an API call, you may pass CreateIntegrationAssociationRequest
|
570
|
+
# data as a hash:
|
571
|
+
#
|
572
|
+
# {
|
573
|
+
# instance_id: "InstanceId", # required
|
574
|
+
# integration_type: "EVENT", # required, accepts EVENT
|
575
|
+
# integration_arn: "ARN", # required
|
576
|
+
# source_application_url: "URI", # required
|
577
|
+
# source_application_name: "SourceApplicationName", # required
|
578
|
+
# source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK
|
579
|
+
# }
|
580
|
+
#
|
581
|
+
# @!attribute [rw] instance_id
|
582
|
+
# The identifier of the Amazon Connect instance.
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] integration_type
|
586
|
+
# The type of information to be ingested.
|
587
|
+
# @return [String]
|
588
|
+
#
|
589
|
+
# @!attribute [rw] integration_arn
|
590
|
+
# The Amazon Resource Name (ARN) of the integration.
|
591
|
+
# @return [String]
|
592
|
+
#
|
593
|
+
# @!attribute [rw] source_application_url
|
594
|
+
# The URL for the external application.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @!attribute [rw] source_application_name
|
598
|
+
# The name of the external application.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] source_type
|
602
|
+
# The type of the data source.
|
603
|
+
# @return [String]
|
604
|
+
#
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociationRequest AWS API Documentation
|
606
|
+
#
|
607
|
+
class CreateIntegrationAssociationRequest < Struct.new(
|
608
|
+
:instance_id,
|
609
|
+
:integration_type,
|
610
|
+
:integration_arn,
|
611
|
+
:source_application_url,
|
612
|
+
:source_application_name,
|
613
|
+
:source_type)
|
614
|
+
SENSITIVE = []
|
615
|
+
include Aws::Structure
|
616
|
+
end
|
617
|
+
|
618
|
+
# @!attribute [rw] integration_association_id
|
619
|
+
# The identifier for the association.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] integration_association_arn
|
623
|
+
# The Amazon Resource Name (ARN) for the association.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociationResponse AWS API Documentation
|
627
|
+
#
|
628
|
+
class CreateIntegrationAssociationResponse < Struct.new(
|
629
|
+
:integration_association_id,
|
630
|
+
:integration_association_arn)
|
631
|
+
SENSITIVE = []
|
632
|
+
include Aws::Structure
|
633
|
+
end
|
634
|
+
|
635
|
+
# @note When making an API call, you may pass CreateQueueRequest
|
636
|
+
# data as a hash:
|
637
|
+
#
|
638
|
+
# {
|
639
|
+
# instance_id: "InstanceId", # required
|
640
|
+
# name: "CommonNameLength127", # required
|
641
|
+
# description: "QueueDescription",
|
642
|
+
# outbound_caller_config: {
|
643
|
+
# outbound_caller_id_name: "OutboundCallerIdName",
|
644
|
+
# outbound_caller_id_number_id: "PhoneNumberId",
|
645
|
+
# outbound_flow_id: "ContactFlowId",
|
646
|
+
# },
|
647
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
648
|
+
# max_contacts: 1,
|
649
|
+
# quick_connect_ids: ["QuickConnectId"],
|
650
|
+
# tags: {
|
651
|
+
# "TagKey" => "TagValue",
|
652
|
+
# },
|
653
|
+
# }
|
654
|
+
#
|
655
|
+
# @!attribute [rw] instance_id
|
656
|
+
# The identifier of the Amazon Connect instance.
|
657
|
+
# @return [String]
|
658
|
+
#
|
659
|
+
# @!attribute [rw] name
|
660
|
+
# The name of the queue.
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @!attribute [rw] description
|
664
|
+
# The description of the queue.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @!attribute [rw] outbound_caller_config
|
668
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
669
|
+
# @return [Types::OutboundCallerConfig]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] hours_of_operation_id
|
672
|
+
# The identifier for the hours of operation.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] max_contacts
|
676
|
+
# The maximum number of contacts that can be in the queue before it is
|
677
|
+
# considered full.
|
678
|
+
# @return [Integer]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] quick_connect_ids
|
681
|
+
# The quick connects available to agents who are working the queue.
|
682
|
+
# @return [Array<String>]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] tags
|
685
|
+
# One or more tags.
|
686
|
+
# @return [Hash<String,String>]
|
687
|
+
#
|
688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQueueRequest AWS API Documentation
|
689
|
+
#
|
690
|
+
class CreateQueueRequest < Struct.new(
|
691
|
+
:instance_id,
|
692
|
+
:name,
|
693
|
+
:description,
|
694
|
+
:outbound_caller_config,
|
695
|
+
:hours_of_operation_id,
|
696
|
+
:max_contacts,
|
697
|
+
:quick_connect_ids,
|
698
|
+
:tags)
|
699
|
+
SENSITIVE = []
|
700
|
+
include Aws::Structure
|
701
|
+
end
|
702
|
+
|
703
|
+
# @!attribute [rw] queue_arn
|
704
|
+
# The Amazon Resource Name (ARN) of the queue.
|
705
|
+
# @return [String]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] queue_id
|
708
|
+
# The identifier for the queue.
|
709
|
+
# @return [String]
|
710
|
+
#
|
711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQueueResponse AWS API Documentation
|
712
|
+
#
|
713
|
+
class CreateQueueResponse < Struct.new(
|
714
|
+
:queue_arn,
|
715
|
+
:queue_id)
|
716
|
+
SENSITIVE = []
|
717
|
+
include Aws::Structure
|
718
|
+
end
|
719
|
+
|
720
|
+
# @note When making an API call, you may pass CreateQuickConnectRequest
|
721
|
+
# data as a hash:
|
722
|
+
#
|
723
|
+
# {
|
724
|
+
# instance_id: "InstanceId", # required
|
725
|
+
# name: "QuickConnectName", # required
|
726
|
+
# description: "QuickConnectDescription",
|
727
|
+
# quick_connect_config: { # required
|
728
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
729
|
+
# user_config: {
|
730
|
+
# user_id: "UserId", # required
|
731
|
+
# contact_flow_id: "ContactFlowId", # required
|
732
|
+
# },
|
733
|
+
# queue_config: {
|
734
|
+
# queue_id: "QueueId", # required
|
735
|
+
# contact_flow_id: "ContactFlowId", # required
|
736
|
+
# },
|
737
|
+
# phone_config: {
|
738
|
+
# phone_number: "PhoneNumber", # required
|
739
|
+
# },
|
740
|
+
# },
|
741
|
+
# tags: {
|
742
|
+
# "TagKey" => "TagValue",
|
743
|
+
# },
|
744
|
+
# }
|
745
|
+
#
|
746
|
+
# @!attribute [rw] instance_id
|
747
|
+
# The identifier of the Amazon Connect instance.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] name
|
751
|
+
# The name of the quick connect.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] description
|
755
|
+
# The description of the quick connect.
|
756
|
+
# @return [String]
|
757
|
+
#
|
758
|
+
# @!attribute [rw] quick_connect_config
|
759
|
+
# Configuration settings for the quick connect.
|
760
|
+
# @return [Types::QuickConnectConfig]
|
761
|
+
#
|
762
|
+
# @!attribute [rw] tags
|
763
|
+
# One or more tags.
|
764
|
+
# @return [Hash<String,String>]
|
765
|
+
#
|
766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnectRequest AWS API Documentation
|
767
|
+
#
|
768
|
+
class CreateQuickConnectRequest < Struct.new(
|
769
|
+
:instance_id,
|
770
|
+
:name,
|
771
|
+
:description,
|
772
|
+
:quick_connect_config,
|
773
|
+
:tags)
|
774
|
+
SENSITIVE = []
|
775
|
+
include Aws::Structure
|
776
|
+
end
|
777
|
+
|
778
|
+
# @!attribute [rw] quick_connect_arn
|
779
|
+
# The Amazon Resource Name (ARN) for the quick connect.
|
780
|
+
# @return [String]
|
781
|
+
#
|
782
|
+
# @!attribute [rw] quick_connect_id
|
783
|
+
# The identifier for the quick connect.
|
784
|
+
# @return [String]
|
785
|
+
#
|
786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnectResponse AWS API Documentation
|
787
|
+
#
|
788
|
+
class CreateQuickConnectResponse < Struct.new(
|
789
|
+
:quick_connect_arn,
|
790
|
+
:quick_connect_id)
|
791
|
+
SENSITIVE = []
|
792
|
+
include Aws::Structure
|
793
|
+
end
|
794
|
+
|
538
795
|
# @note When making an API call, you may pass CreateRoutingProfileRequest
|
539
796
|
# data as a hash:
|
540
797
|
#
|
@@ -547,7 +804,7 @@ module Aws::Connect
|
|
547
804
|
# {
|
548
805
|
# queue_reference: { # required
|
549
806
|
# queue_id: "QueueId", # required
|
550
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
807
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
551
808
|
# },
|
552
809
|
# priority: 1, # required
|
553
810
|
# delay: 1, # required
|
@@ -555,7 +812,7 @@ module Aws::Connect
|
|
555
812
|
# ],
|
556
813
|
# media_concurrencies: [ # required
|
557
814
|
# {
|
558
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
815
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
559
816
|
# concurrency: 1, # required
|
560
817
|
# },
|
561
818
|
# ],
|
@@ -584,12 +841,12 @@ module Aws::Connect
|
|
584
841
|
#
|
585
842
|
# @!attribute [rw] queue_configs
|
586
843
|
# The inbound queues associated with the routing profile. If no queue
|
587
|
-
# is added, the agent can only
|
844
|
+
# is added, the agent can make only outbound calls.
|
588
845
|
# @return [Array<Types::RoutingProfileQueueConfig>]
|
589
846
|
#
|
590
847
|
# @!attribute [rw] media_concurrencies
|
591
|
-
# The channels agents can handle in the Contact Control Panel
|
592
|
-
# for this routing profile.
|
848
|
+
# The channels that agents can handle in the Contact Control Panel
|
849
|
+
# (CCP) for this routing profile.
|
593
850
|
# @return [Array<Types::MediaConcurrency>]
|
594
851
|
#
|
595
852
|
# @!attribute [rw] tags
|
@@ -627,6 +884,56 @@ module Aws::Connect
|
|
627
884
|
include Aws::Structure
|
628
885
|
end
|
629
886
|
|
887
|
+
# @note When making an API call, you may pass CreateUseCaseRequest
|
888
|
+
# data as a hash:
|
889
|
+
#
|
890
|
+
# {
|
891
|
+
# instance_id: "InstanceId", # required
|
892
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
893
|
+
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
|
894
|
+
# }
|
895
|
+
#
|
896
|
+
# @!attribute [rw] instance_id
|
897
|
+
# The identifier of the Amazon Connect instance.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] integration_association_id
|
901
|
+
# The identifier for the AppIntegration association.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @!attribute [rw] use_case_type
|
905
|
+
# The type of use case to associate to the AppIntegration association.
|
906
|
+
# Each AppIntegration association can have only one of each use case
|
907
|
+
# type.
|
908
|
+
# @return [String]
|
909
|
+
#
|
910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCaseRequest AWS API Documentation
|
911
|
+
#
|
912
|
+
class CreateUseCaseRequest < Struct.new(
|
913
|
+
:instance_id,
|
914
|
+
:integration_association_id,
|
915
|
+
:use_case_type)
|
916
|
+
SENSITIVE = []
|
917
|
+
include Aws::Structure
|
918
|
+
end
|
919
|
+
|
920
|
+
# @!attribute [rw] use_case_id
|
921
|
+
# The identifier of the use case.
|
922
|
+
# @return [String]
|
923
|
+
#
|
924
|
+
# @!attribute [rw] use_case_arn
|
925
|
+
# The Amazon Resource Name (ARN) for the use case.
|
926
|
+
# @return [String]
|
927
|
+
#
|
928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCaseResponse AWS API Documentation
|
929
|
+
#
|
930
|
+
class CreateUseCaseResponse < Struct.new(
|
931
|
+
:use_case_id,
|
932
|
+
:use_case_arn)
|
933
|
+
SENSITIVE = []
|
934
|
+
include Aws::Structure
|
935
|
+
end
|
936
|
+
|
630
937
|
# @note When making an API call, you may pass CreateUserHierarchyGroupRequest
|
631
938
|
# data as a hash:
|
632
939
|
#
|
@@ -916,6 +1223,87 @@ module Aws::Connect
|
|
916
1223
|
include Aws::Structure
|
917
1224
|
end
|
918
1225
|
|
1226
|
+
# @note When making an API call, you may pass DeleteIntegrationAssociationRequest
|
1227
|
+
# data as a hash:
|
1228
|
+
#
|
1229
|
+
# {
|
1230
|
+
# instance_id: "InstanceId", # required
|
1231
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1232
|
+
# }
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] instance_id
|
1235
|
+
# The identifier of the Amazon Connect instance.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] integration_association_id
|
1239
|
+
# The identifier for the AppIntegration association.
|
1240
|
+
# @return [String]
|
1241
|
+
#
|
1242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociationRequest AWS API Documentation
|
1243
|
+
#
|
1244
|
+
class DeleteIntegrationAssociationRequest < Struct.new(
|
1245
|
+
:instance_id,
|
1246
|
+
:integration_association_id)
|
1247
|
+
SENSITIVE = []
|
1248
|
+
include Aws::Structure
|
1249
|
+
end
|
1250
|
+
|
1251
|
+
# @note When making an API call, you may pass DeleteQuickConnectRequest
|
1252
|
+
# data as a hash:
|
1253
|
+
#
|
1254
|
+
# {
|
1255
|
+
# instance_id: "InstanceId", # required
|
1256
|
+
# quick_connect_id: "QuickConnectId", # required
|
1257
|
+
# }
|
1258
|
+
#
|
1259
|
+
# @!attribute [rw] instance_id
|
1260
|
+
# The identifier of the Amazon Connect instance.
|
1261
|
+
# @return [String]
|
1262
|
+
#
|
1263
|
+
# @!attribute [rw] quick_connect_id
|
1264
|
+
# The identifier for the quick connect.
|
1265
|
+
# @return [String]
|
1266
|
+
#
|
1267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteQuickConnectRequest AWS API Documentation
|
1268
|
+
#
|
1269
|
+
class DeleteQuickConnectRequest < Struct.new(
|
1270
|
+
:instance_id,
|
1271
|
+
:quick_connect_id)
|
1272
|
+
SENSITIVE = []
|
1273
|
+
include Aws::Structure
|
1274
|
+
end
|
1275
|
+
|
1276
|
+
# @note When making an API call, you may pass DeleteUseCaseRequest
|
1277
|
+
# data as a hash:
|
1278
|
+
#
|
1279
|
+
# {
|
1280
|
+
# instance_id: "InstanceId", # required
|
1281
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1282
|
+
# use_case_id: "UseCaseId", # required
|
1283
|
+
# }
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] instance_id
|
1286
|
+
# The identifier of the Amazon Connect instance.
|
1287
|
+
# @return [String]
|
1288
|
+
#
|
1289
|
+
# @!attribute [rw] integration_association_id
|
1290
|
+
# The identifier for the AppIntegration association.
|
1291
|
+
# @return [String]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] use_case_id
|
1294
|
+
# The identifier for the use case.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUseCaseRequest AWS API Documentation
|
1298
|
+
#
|
1299
|
+
class DeleteUseCaseRequest < Struct.new(
|
1300
|
+
:instance_id,
|
1301
|
+
:integration_association_id,
|
1302
|
+
:use_case_id)
|
1303
|
+
SENSITIVE = []
|
1304
|
+
include Aws::Structure
|
1305
|
+
end
|
1306
|
+
|
919
1307
|
# @note When making an API call, you may pass DeleteUserHierarchyGroupRequest
|
920
1308
|
# data as a hash:
|
921
1309
|
#
|
@@ -1003,6 +1391,43 @@ module Aws::Connect
|
|
1003
1391
|
include Aws::Structure
|
1004
1392
|
end
|
1005
1393
|
|
1394
|
+
# @note When making an API call, you may pass DescribeHoursOfOperationRequest
|
1395
|
+
# data as a hash:
|
1396
|
+
#
|
1397
|
+
# {
|
1398
|
+
# instance_id: "InstanceId", # required
|
1399
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
1400
|
+
# }
|
1401
|
+
#
|
1402
|
+
# @!attribute [rw] instance_id
|
1403
|
+
# The identifier of the Amazon Connect instance.
|
1404
|
+
# @return [String]
|
1405
|
+
#
|
1406
|
+
# @!attribute [rw] hours_of_operation_id
|
1407
|
+
# The identifier for the hours of operation.
|
1408
|
+
# @return [String]
|
1409
|
+
#
|
1410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeHoursOfOperationRequest AWS API Documentation
|
1411
|
+
#
|
1412
|
+
class DescribeHoursOfOperationRequest < Struct.new(
|
1413
|
+
:instance_id,
|
1414
|
+
:hours_of_operation_id)
|
1415
|
+
SENSITIVE = []
|
1416
|
+
include Aws::Structure
|
1417
|
+
end
|
1418
|
+
|
1419
|
+
# @!attribute [rw] hours_of_operation
|
1420
|
+
# The hours of operation.
|
1421
|
+
# @return [Types::HoursOfOperation]
|
1422
|
+
#
|
1423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeHoursOfOperationResponse AWS API Documentation
|
1424
|
+
#
|
1425
|
+
class DescribeHoursOfOperationResponse < Struct.new(
|
1426
|
+
:hours_of_operation)
|
1427
|
+
SENSITIVE = []
|
1428
|
+
include Aws::Structure
|
1429
|
+
end
|
1430
|
+
|
1006
1431
|
# @note When making an API call, you may pass DescribeInstanceAttributeRequest
|
1007
1432
|
# data as a hash:
|
1008
1433
|
#
|
@@ -1115,6 +1540,80 @@ module Aws::Connect
|
|
1115
1540
|
include Aws::Structure
|
1116
1541
|
end
|
1117
1542
|
|
1543
|
+
# @note When making an API call, you may pass DescribeQueueRequest
|
1544
|
+
# data as a hash:
|
1545
|
+
#
|
1546
|
+
# {
|
1547
|
+
# instance_id: "InstanceId", # required
|
1548
|
+
# queue_id: "QueueId", # required
|
1549
|
+
# }
|
1550
|
+
#
|
1551
|
+
# @!attribute [rw] instance_id
|
1552
|
+
# The identifier of the Amazon Connect instance.
|
1553
|
+
# @return [String]
|
1554
|
+
#
|
1555
|
+
# @!attribute [rw] queue_id
|
1556
|
+
# The identifier for the queue.
|
1557
|
+
# @return [String]
|
1558
|
+
#
|
1559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQueueRequest AWS API Documentation
|
1560
|
+
#
|
1561
|
+
class DescribeQueueRequest < Struct.new(
|
1562
|
+
:instance_id,
|
1563
|
+
:queue_id)
|
1564
|
+
SENSITIVE = []
|
1565
|
+
include Aws::Structure
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
# @!attribute [rw] queue
|
1569
|
+
# The name of the queue.
|
1570
|
+
# @return [Types::Queue]
|
1571
|
+
#
|
1572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQueueResponse AWS API Documentation
|
1573
|
+
#
|
1574
|
+
class DescribeQueueResponse < Struct.new(
|
1575
|
+
:queue)
|
1576
|
+
SENSITIVE = []
|
1577
|
+
include Aws::Structure
|
1578
|
+
end
|
1579
|
+
|
1580
|
+
# @note When making an API call, you may pass DescribeQuickConnectRequest
|
1581
|
+
# data as a hash:
|
1582
|
+
#
|
1583
|
+
# {
|
1584
|
+
# instance_id: "InstanceId", # required
|
1585
|
+
# quick_connect_id: "QuickConnectId", # required
|
1586
|
+
# }
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] instance_id
|
1589
|
+
# The identifier of the Amazon Connect instance.
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] quick_connect_id
|
1593
|
+
# The identifier for the quick connect.
|
1594
|
+
# @return [String]
|
1595
|
+
#
|
1596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQuickConnectRequest AWS API Documentation
|
1597
|
+
#
|
1598
|
+
class DescribeQuickConnectRequest < Struct.new(
|
1599
|
+
:instance_id,
|
1600
|
+
:quick_connect_id)
|
1601
|
+
SENSITIVE = []
|
1602
|
+
include Aws::Structure
|
1603
|
+
end
|
1604
|
+
|
1605
|
+
# @!attribute [rw] quick_connect
|
1606
|
+
# Information about the quick connect.
|
1607
|
+
# @return [Types::QuickConnect]
|
1608
|
+
#
|
1609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQuickConnectResponse AWS API Documentation
|
1610
|
+
#
|
1611
|
+
class DescribeQuickConnectResponse < Struct.new(
|
1612
|
+
:quick_connect)
|
1613
|
+
SENSITIVE = []
|
1614
|
+
include Aws::Structure
|
1615
|
+
end
|
1616
|
+
|
1118
1617
|
# @note When making an API call, you may pass DescribeRoutingProfileRequest
|
1119
1618
|
# data as a hash:
|
1120
1619
|
#
|
@@ -1260,7 +1759,7 @@ module Aws::Connect
|
|
1260
1759
|
# Outbound calls to the destination number are not allowed.
|
1261
1760
|
#
|
1262
1761
|
# @!attribute [rw] message
|
1263
|
-
# The message.
|
1762
|
+
# The message about the outbound calls.
|
1264
1763
|
# @return [String]
|
1265
1764
|
#
|
1266
1765
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DestinationNotAllowedException AWS API Documentation
|
@@ -1404,6 +1903,37 @@ module Aws::Connect
|
|
1404
1903
|
include Aws::Structure
|
1405
1904
|
end
|
1406
1905
|
|
1906
|
+
# @note When making an API call, you may pass DisassociateQueueQuickConnectsRequest
|
1907
|
+
# data as a hash:
|
1908
|
+
#
|
1909
|
+
# {
|
1910
|
+
# instance_id: "InstanceId", # required
|
1911
|
+
# queue_id: "QueueId", # required
|
1912
|
+
# quick_connect_ids: ["QuickConnectId"], # required
|
1913
|
+
# }
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] instance_id
|
1916
|
+
# The identifier of the Amazon Connect instance.
|
1917
|
+
# @return [String]
|
1918
|
+
#
|
1919
|
+
# @!attribute [rw] queue_id
|
1920
|
+
# The identifier for the queue.
|
1921
|
+
# @return [String]
|
1922
|
+
#
|
1923
|
+
# @!attribute [rw] quick_connect_ids
|
1924
|
+
# The quick connects to disassociate from the queue.
|
1925
|
+
# @return [Array<String>]
|
1926
|
+
#
|
1927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateQueueQuickConnectsRequest AWS API Documentation
|
1928
|
+
#
|
1929
|
+
class DisassociateQueueQuickConnectsRequest < Struct.new(
|
1930
|
+
:instance_id,
|
1931
|
+
:queue_id,
|
1932
|
+
:quick_connect_ids)
|
1933
|
+
SENSITIVE = []
|
1934
|
+
include Aws::Structure
|
1935
|
+
end
|
1936
|
+
|
1407
1937
|
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
1408
1938
|
# data as a hash:
|
1409
1939
|
#
|
@@ -1413,7 +1943,7 @@ module Aws::Connect
|
|
1413
1943
|
# queue_references: [ # required
|
1414
1944
|
# {
|
1415
1945
|
# queue_id: "QueueId", # required
|
1416
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
1946
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
1417
1947
|
# },
|
1418
1948
|
# ],
|
1419
1949
|
# }
|
@@ -1513,7 +2043,7 @@ module Aws::Connect
|
|
1513
2043
|
#
|
1514
2044
|
# {
|
1515
2045
|
# queues: ["QueueId"],
|
1516
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2046
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1517
2047
|
# }
|
1518
2048
|
#
|
1519
2049
|
# @!attribute [rw] queues
|
@@ -1578,7 +2108,7 @@ module Aws::Connect
|
|
1578
2108
|
# instance_id: "InstanceId", # required
|
1579
2109
|
# filters: { # required
|
1580
2110
|
# queues: ["QueueId"],
|
1581
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2111
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1582
2112
|
# },
|
1583
2113
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1584
2114
|
# current_metrics: [ # required
|
@@ -1599,16 +2129,16 @@ module Aws::Connect
|
|
1599
2129
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1600
2130
|
# returned. Metric data is retrieved only for the resources associated
|
1601
2131
|
# with the queues or channels included in the filter. You can include
|
1602
|
-
# both queue IDs and queue ARNs in the same request.
|
1603
|
-
#
|
2132
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2133
|
+
# TASK channels are supported.
|
1604
2134
|
# @return [Types::Filters]
|
1605
2135
|
#
|
1606
2136
|
# @!attribute [rw] groupings
|
1607
2137
|
# The grouping applied to the metrics returned. For example, when
|
1608
2138
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
1609
2139
|
# than aggregated for all queues. If you group by `CHANNEL`, you
|
1610
|
-
# should include a Channels filter.
|
1611
|
-
#
|
2140
|
+
# should include a Channels filter. VOICE, CHAT, and TASK channels are
|
2141
|
+
# supported.
|
1612
2142
|
#
|
1613
2143
|
# If no `Grouping` is included in the request, a summary of metrics is
|
1614
2144
|
# returned.
|
@@ -1735,7 +2265,7 @@ module Aws::Connect
|
|
1735
2265
|
# @return [String]
|
1736
2266
|
#
|
1737
2267
|
# @!attribute [rw] max_results
|
1738
|
-
# The
|
2268
|
+
# The maximum number of results to return per page.
|
1739
2269
|
# @return [Integer]
|
1740
2270
|
#
|
1741
2271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataRequest AWS API Documentation
|
@@ -1819,7 +2349,7 @@ module Aws::Connect
|
|
1819
2349
|
# end_time: Time.now, # required
|
1820
2350
|
# filters: { # required
|
1821
2351
|
# queues: ["QueueId"],
|
1822
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2352
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1823
2353
|
# },
|
1824
2354
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1825
2355
|
# historical_metrics: [ # required
|
@@ -1866,8 +2396,8 @@ module Aws::Connect
|
|
1866
2396
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1867
2397
|
# returned. Metric data is retrieved only for the resources associated
|
1868
2398
|
# with the queues or channels included in the filter. You can include
|
1869
|
-
# both queue IDs and queue ARNs in the same request.
|
1870
|
-
#
|
2399
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2400
|
+
# TASK channels are supported.
|
1871
2401
|
# @return [Types::Filters]
|
1872
2402
|
#
|
1873
2403
|
# @!attribute [rw] groupings
|
@@ -2054,7 +2584,7 @@ module Aws::Connect
|
|
2054
2584
|
# @return [String]
|
2055
2585
|
#
|
2056
2586
|
# @!attribute [rw] max_results
|
2057
|
-
# The
|
2587
|
+
# The maximum number of results to return per page.
|
2058
2588
|
# @return [Integer]
|
2059
2589
|
#
|
2060
2590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataRequest AWS API Documentation
|
@@ -2381,30 +2911,98 @@ module Aws::Connect
|
|
2381
2911
|
# The value of the metric.
|
2382
2912
|
# @return [Float]
|
2383
2913
|
#
|
2384
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetricData AWS API Documentation
|
2914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetricData AWS API Documentation
|
2915
|
+
#
|
2916
|
+
class HistoricalMetricData < Struct.new(
|
2917
|
+
:metric,
|
2918
|
+
:value)
|
2919
|
+
SENSITIVE = []
|
2920
|
+
include Aws::Structure
|
2921
|
+
end
|
2922
|
+
|
2923
|
+
# Contains information about the historical metrics retrieved.
|
2924
|
+
#
|
2925
|
+
# @!attribute [rw] dimensions
|
2926
|
+
# The dimension for the metrics.
|
2927
|
+
# @return [Types::Dimensions]
|
2928
|
+
#
|
2929
|
+
# @!attribute [rw] collections
|
2930
|
+
# The set of metrics.
|
2931
|
+
# @return [Array<Types::HistoricalMetricData>]
|
2932
|
+
#
|
2933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetricResult AWS API Documentation
|
2934
|
+
#
|
2935
|
+
class HistoricalMetricResult < Struct.new(
|
2936
|
+
:dimensions,
|
2937
|
+
:collections)
|
2938
|
+
SENSITIVE = []
|
2939
|
+
include Aws::Structure
|
2940
|
+
end
|
2941
|
+
|
2942
|
+
# Information about of the hours of operation.
|
2943
|
+
#
|
2944
|
+
# @!attribute [rw] hours_of_operation_id
|
2945
|
+
# The identifier for the hours of operation.
|
2946
|
+
# @return [String]
|
2947
|
+
#
|
2948
|
+
# @!attribute [rw] hours_of_operation_arn
|
2949
|
+
# The Amazon Resource Name (ARN) for the hours of operation.
|
2950
|
+
# @return [String]
|
2951
|
+
#
|
2952
|
+
# @!attribute [rw] name
|
2953
|
+
# The name for the hours of operation.
|
2954
|
+
# @return [String]
|
2955
|
+
#
|
2956
|
+
# @!attribute [rw] description
|
2957
|
+
# The description for the hours of operation.
|
2958
|
+
# @return [String]
|
2959
|
+
#
|
2960
|
+
# @!attribute [rw] time_zone
|
2961
|
+
# The time zone for the hours of operation.
|
2962
|
+
# @return [String]
|
2963
|
+
#
|
2964
|
+
# @!attribute [rw] config
|
2965
|
+
# Configuration information for the hours of operation.
|
2966
|
+
# @return [Array<Types::HoursOfOperationConfig>]
|
2385
2967
|
#
|
2386
|
-
|
2387
|
-
|
2388
|
-
|
2968
|
+
# @!attribute [rw] tags
|
2969
|
+
# One or more tags.
|
2970
|
+
# @return [Hash<String,String>]
|
2971
|
+
#
|
2972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HoursOfOperation AWS API Documentation
|
2973
|
+
#
|
2974
|
+
class HoursOfOperation < Struct.new(
|
2975
|
+
:hours_of_operation_id,
|
2976
|
+
:hours_of_operation_arn,
|
2977
|
+
:name,
|
2978
|
+
:description,
|
2979
|
+
:time_zone,
|
2980
|
+
:config,
|
2981
|
+
:tags)
|
2389
2982
|
SENSITIVE = []
|
2390
2983
|
include Aws::Structure
|
2391
2984
|
end
|
2392
2985
|
|
2393
|
-
# Contains information about the
|
2986
|
+
# Contains information about the hours of operation.
|
2394
2987
|
#
|
2395
|
-
# @!attribute [rw]
|
2396
|
-
# The
|
2397
|
-
# @return [
|
2988
|
+
# @!attribute [rw] day
|
2989
|
+
# The day that the hours of operation applies to.
|
2990
|
+
# @return [String]
|
2398
2991
|
#
|
2399
|
-
# @!attribute [rw]
|
2400
|
-
# The
|
2401
|
-
# @return [
|
2992
|
+
# @!attribute [rw] start_time
|
2993
|
+
# The start time that your contact center is open.
|
2994
|
+
# @return [Types::HoursOfOperationTimeSlice]
|
2402
2995
|
#
|
2403
|
-
#
|
2996
|
+
# @!attribute [rw] end_time
|
2997
|
+
# The end time that your contact center is closes.
|
2998
|
+
# @return [Types::HoursOfOperationTimeSlice]
|
2404
2999
|
#
|
2405
|
-
|
2406
|
-
|
2407
|
-
|
3000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HoursOfOperationConfig AWS API Documentation
|
3001
|
+
#
|
3002
|
+
class HoursOfOperationConfig < Struct.new(
|
3003
|
+
:day,
|
3004
|
+
:start_time,
|
3005
|
+
:end_time)
|
2408
3006
|
SENSITIVE = []
|
2409
3007
|
include Aws::Structure
|
2410
3008
|
end
|
@@ -2434,6 +3032,25 @@ module Aws::Connect
|
|
2434
3032
|
include Aws::Structure
|
2435
3033
|
end
|
2436
3034
|
|
3035
|
+
# The start time or end time for an hours of operation.
|
3036
|
+
#
|
3037
|
+
# @!attribute [rw] hours
|
3038
|
+
# The hours.
|
3039
|
+
# @return [Integer]
|
3040
|
+
#
|
3041
|
+
# @!attribute [rw] minutes
|
3042
|
+
# The minutes.
|
3043
|
+
# @return [Integer]
|
3044
|
+
#
|
3045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HoursOfOperationTimeSlice AWS API Documentation
|
3046
|
+
#
|
3047
|
+
class HoursOfOperationTimeSlice < Struct.new(
|
3048
|
+
:hours,
|
3049
|
+
:minutes)
|
3050
|
+
SENSITIVE = []
|
3051
|
+
include Aws::Structure
|
3052
|
+
end
|
3053
|
+
|
2437
3054
|
# The Amazon Connect instance.
|
2438
3055
|
#
|
2439
3056
|
# @!attribute [rw] id
|
@@ -2549,7 +3166,7 @@ module Aws::Connect
|
|
2549
3166
|
# @return [String]
|
2550
3167
|
#
|
2551
3168
|
# @!attribute [rw] s3_config
|
2552
|
-
# The S3 configuration.
|
3169
|
+
# The S3 bucket configuration.
|
2553
3170
|
# @return [Types::S3Config]
|
2554
3171
|
#
|
2555
3172
|
# @!attribute [rw] kinesis_video_stream_config
|
@@ -2631,7 +3248,57 @@ module Aws::Connect
|
|
2631
3248
|
include Aws::Structure
|
2632
3249
|
end
|
2633
3250
|
|
2634
|
-
#
|
3251
|
+
# Contains summary information about the associated AppIntegrations.
|
3252
|
+
#
|
3253
|
+
# @!attribute [rw] integration_association_id
|
3254
|
+
# The identifier for the AppIntegration association.
|
3255
|
+
# @return [String]
|
3256
|
+
#
|
3257
|
+
# @!attribute [rw] integration_association_arn
|
3258
|
+
# The Amazon Resource Name (ARN) for the AppIntegration association.
|
3259
|
+
# @return [String]
|
3260
|
+
#
|
3261
|
+
# @!attribute [rw] instance_id
|
3262
|
+
# The identifier of the Amazon Connect instance.
|
3263
|
+
# @return [String]
|
3264
|
+
#
|
3265
|
+
# @!attribute [rw] integration_type
|
3266
|
+
# The integration type.
|
3267
|
+
# @return [String]
|
3268
|
+
#
|
3269
|
+
# @!attribute [rw] integration_arn
|
3270
|
+
# The Amazon Resource Name (ARN) for the AppIntegration.
|
3271
|
+
# @return [String]
|
3272
|
+
#
|
3273
|
+
# @!attribute [rw] source_application_url
|
3274
|
+
# The URL for the external application.
|
3275
|
+
# @return [String]
|
3276
|
+
#
|
3277
|
+
# @!attribute [rw] source_application_name
|
3278
|
+
# The user-provided, friendly name for the external application.
|
3279
|
+
# @return [String]
|
3280
|
+
#
|
3281
|
+
# @!attribute [rw] source_type
|
3282
|
+
# The name of the source.
|
3283
|
+
# @return [String]
|
3284
|
+
#
|
3285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/IntegrationAssociationSummary AWS API Documentation
|
3286
|
+
#
|
3287
|
+
class IntegrationAssociationSummary < Struct.new(
|
3288
|
+
:integration_association_id,
|
3289
|
+
:integration_association_arn,
|
3290
|
+
:instance_id,
|
3291
|
+
:integration_type,
|
3292
|
+
:integration_arn,
|
3293
|
+
:source_application_url,
|
3294
|
+
:source_application_name,
|
3295
|
+
:source_type)
|
3296
|
+
SENSITIVE = []
|
3297
|
+
include Aws::Structure
|
3298
|
+
end
|
3299
|
+
|
3300
|
+
# Request processing failed because of an error or failure with the
|
3301
|
+
# service.
|
2635
3302
|
#
|
2636
3303
|
# @!attribute [rw] message
|
2637
3304
|
# The message.
|
@@ -2662,7 +3329,7 @@ module Aws::Connect
|
|
2662
3329
|
# One or more of the specified parameters are not valid.
|
2663
3330
|
#
|
2664
3331
|
# @!attribute [rw] message
|
2665
|
-
# The message.
|
3332
|
+
# The message about the parameters.
|
2666
3333
|
# @return [String]
|
2667
3334
|
#
|
2668
3335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidParameterException AWS API Documentation
|
@@ -2676,7 +3343,7 @@ module Aws::Connect
|
|
2676
3343
|
# The request is not valid.
|
2677
3344
|
#
|
2678
3345
|
# @!attribute [rw] message
|
2679
|
-
# The message.
|
3346
|
+
# The message about the request.
|
2680
3347
|
# @return [String]
|
2681
3348
|
#
|
2682
3349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidRequestException AWS API Documentation
|
@@ -2687,7 +3354,7 @@ module Aws::Connect
|
|
2687
3354
|
include Aws::Structure
|
2688
3355
|
end
|
2689
3356
|
|
2690
|
-
# Configuration information of a Kinesis Firehose delivery stream.
|
3357
|
+
# Configuration information of a Kinesis Data Firehose delivery stream.
|
2691
3358
|
#
|
2692
3359
|
# @note When making an API call, you may pass KinesisFirehoseConfig
|
2693
3360
|
# data as a hash:
|
@@ -2785,7 +3452,7 @@ module Aws::Connect
|
|
2785
3452
|
# @return [String]
|
2786
3453
|
#
|
2787
3454
|
# @!attribute [rw] lex_region
|
2788
|
-
# The Region the Amazon Lex bot was created in.
|
3455
|
+
# The Region that the Amazon Lex bot was created in.
|
2789
3456
|
# @return [String]
|
2790
3457
|
#
|
2791
3458
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/LexBot AWS API Documentation
|
@@ -2800,7 +3467,7 @@ module Aws::Connect
|
|
2800
3467
|
# The allowed limit for the resource has been exceeded.
|
2801
3468
|
#
|
2802
3469
|
# @!attribute [rw] message
|
2803
|
-
# The message.
|
3470
|
+
# The message about the limit.
|
2804
3471
|
# @return [String]
|
2805
3472
|
#
|
2806
3473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/LimitExceededException AWS API Documentation
|
@@ -2831,7 +3498,7 @@ module Aws::Connect
|
|
2831
3498
|
# @return [String]
|
2832
3499
|
#
|
2833
3500
|
# @!attribute [rw] max_results
|
2834
|
-
# The
|
3501
|
+
# The maximum number of results to return per page.
|
2835
3502
|
# @return [Integer]
|
2836
3503
|
#
|
2837
3504
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListApprovedOriginsRequest AWS API Documentation
|
@@ -2887,7 +3554,7 @@ module Aws::Connect
|
|
2887
3554
|
# @return [String]
|
2888
3555
|
#
|
2889
3556
|
# @!attribute [rw] max_results
|
2890
|
-
# The
|
3557
|
+
# The maximum number of results to return per page.
|
2891
3558
|
# @return [Integer]
|
2892
3559
|
#
|
2893
3560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowsRequest AWS API Documentation
|
@@ -2939,7 +3606,7 @@ module Aws::Connect
|
|
2939
3606
|
# @return [String]
|
2940
3607
|
#
|
2941
3608
|
# @!attribute [rw] max_results
|
2942
|
-
# The
|
3609
|
+
# The maximum number of results to return per page.
|
2943
3610
|
# @return [Integer]
|
2944
3611
|
#
|
2945
3612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsRequest AWS API Documentation
|
@@ -2990,7 +3657,7 @@ module Aws::Connect
|
|
2990
3657
|
# @return [String]
|
2991
3658
|
#
|
2992
3659
|
# @!attribute [rw] max_results
|
2993
|
-
# The
|
3660
|
+
# The maximum number of results to return per page.
|
2994
3661
|
# @return [Integer]
|
2995
3662
|
#
|
2996
3663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributesRequest AWS API Documentation
|
@@ -3046,7 +3713,7 @@ module Aws::Connect
|
|
3046
3713
|
# @return [String]
|
3047
3714
|
#
|
3048
3715
|
# @!attribute [rw] max_results
|
3049
|
-
# The
|
3716
|
+
# The maximum number of results to return per page.
|
3050
3717
|
# @return [Integer]
|
3051
3718
|
#
|
3052
3719
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceStorageConfigsRequest AWS API Documentation
|
@@ -3093,7 +3760,7 @@ module Aws::Connect
|
|
3093
3760
|
# @return [String]
|
3094
3761
|
#
|
3095
3762
|
# @!attribute [rw] max_results
|
3096
|
-
# The
|
3763
|
+
# The maximum number of results to return per page.
|
3097
3764
|
# @return [Integer]
|
3098
3765
|
#
|
3099
3766
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstancesRequest AWS API Documentation
|
@@ -3123,6 +3790,57 @@ module Aws::Connect
|
|
3123
3790
|
include Aws::Structure
|
3124
3791
|
end
|
3125
3792
|
|
3793
|
+
# @note When making an API call, you may pass ListIntegrationAssociationsRequest
|
3794
|
+
# data as a hash:
|
3795
|
+
#
|
3796
|
+
# {
|
3797
|
+
# instance_id: "InstanceId", # required
|
3798
|
+
# next_token: "NextToken",
|
3799
|
+
# max_results: 1,
|
3800
|
+
# }
|
3801
|
+
#
|
3802
|
+
# @!attribute [rw] instance_id
|
3803
|
+
# The identifier of the Amazon Connect instance.
|
3804
|
+
# @return [String]
|
3805
|
+
#
|
3806
|
+
# @!attribute [rw] next_token
|
3807
|
+
# The token for the next set of results. Use the value returned in the
|
3808
|
+
# previous response in the next request to retrieve the next set of
|
3809
|
+
# results.
|
3810
|
+
# @return [String]
|
3811
|
+
#
|
3812
|
+
# @!attribute [rw] max_results
|
3813
|
+
# The maximum number of results to return per page.
|
3814
|
+
# @return [Integer]
|
3815
|
+
#
|
3816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociationsRequest AWS API Documentation
|
3817
|
+
#
|
3818
|
+
class ListIntegrationAssociationsRequest < Struct.new(
|
3819
|
+
:instance_id,
|
3820
|
+
:next_token,
|
3821
|
+
:max_results)
|
3822
|
+
SENSITIVE = []
|
3823
|
+
include Aws::Structure
|
3824
|
+
end
|
3825
|
+
|
3826
|
+
# @!attribute [rw] integration_association_summary_list
|
3827
|
+
# The AppIntegration associations.
|
3828
|
+
# @return [Array<Types::IntegrationAssociationSummary>]
|
3829
|
+
#
|
3830
|
+
# @!attribute [rw] next_token
|
3831
|
+
# If there are additional results, this is the token for the next set
|
3832
|
+
# of results.
|
3833
|
+
# @return [String]
|
3834
|
+
#
|
3835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociationsResponse AWS API Documentation
|
3836
|
+
#
|
3837
|
+
class ListIntegrationAssociationsResponse < Struct.new(
|
3838
|
+
:integration_association_summary_list,
|
3839
|
+
:next_token)
|
3840
|
+
SENSITIVE = []
|
3841
|
+
include Aws::Structure
|
3842
|
+
end
|
3843
|
+
|
3126
3844
|
# @note When making an API call, you may pass ListLambdaFunctionsRequest
|
3127
3845
|
# data as a hash:
|
3128
3846
|
#
|
@@ -3143,7 +3861,7 @@ module Aws::Connect
|
|
3143
3861
|
# @return [String]
|
3144
3862
|
#
|
3145
3863
|
# @!attribute [rw] max_results
|
3146
|
-
# The
|
3864
|
+
# The maximum number of results to return per page.
|
3147
3865
|
# @return [Integer]
|
3148
3866
|
#
|
3149
3867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLambdaFunctionsRequest AWS API Documentation
|
@@ -3194,7 +3912,7 @@ module Aws::Connect
|
|
3194
3912
|
# @return [String]
|
3195
3913
|
#
|
3196
3914
|
# @!attribute [rw] max_results
|
3197
|
-
# The
|
3915
|
+
# The maximum number of results to return per page.
|
3198
3916
|
# @return [Integer]
|
3199
3917
|
#
|
3200
3918
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLexBotsRequest AWS API Documentation
|
@@ -3208,7 +3926,7 @@ module Aws::Connect
|
|
3208
3926
|
end
|
3209
3927
|
|
3210
3928
|
# @!attribute [rw] lex_bots
|
3211
|
-
# The
|
3929
|
+
# The names and Regions of the Amazon Lex bots associated with the
|
3212
3930
|
# specified instance.
|
3213
3931
|
# @return [Array<Types::LexBot>]
|
3214
3932
|
#
|
@@ -3256,7 +3974,7 @@ module Aws::Connect
|
|
3256
3974
|
# @return [String]
|
3257
3975
|
#
|
3258
3976
|
# @!attribute [rw] max_results
|
3259
|
-
# The
|
3977
|
+
# The maximum number of results to return per page.
|
3260
3978
|
# @return [Integer]
|
3261
3979
|
#
|
3262
3980
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersRequest AWS API Documentation
|
@@ -3340,6 +4058,63 @@ module Aws::Connect
|
|
3340
4058
|
include Aws::Structure
|
3341
4059
|
end
|
3342
4060
|
|
4061
|
+
# @note When making an API call, you may pass ListQueueQuickConnectsRequest
|
4062
|
+
# data as a hash:
|
4063
|
+
#
|
4064
|
+
# {
|
4065
|
+
# instance_id: "InstanceId", # required
|
4066
|
+
# queue_id: "QueueId", # required
|
4067
|
+
# next_token: "NextToken",
|
4068
|
+
# max_results: 1,
|
4069
|
+
# }
|
4070
|
+
#
|
4071
|
+
# @!attribute [rw] instance_id
|
4072
|
+
# The identifier of the Amazon Connect instance.
|
4073
|
+
# @return [String]
|
4074
|
+
#
|
4075
|
+
# @!attribute [rw] queue_id
|
4076
|
+
# The identifier for the queue.
|
4077
|
+
# @return [String]
|
4078
|
+
#
|
4079
|
+
# @!attribute [rw] next_token
|
4080
|
+
# The token for the next set of results. Use the value returned in the
|
4081
|
+
# previous response in the next request to retrieve the next set of
|
4082
|
+
# results.
|
4083
|
+
# @return [String]
|
4084
|
+
#
|
4085
|
+
# @!attribute [rw] max_results
|
4086
|
+
# The maximum number of results to return per page.
|
4087
|
+
# @return [Integer]
|
4088
|
+
#
|
4089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueueQuickConnectsRequest AWS API Documentation
|
4090
|
+
#
|
4091
|
+
class ListQueueQuickConnectsRequest < Struct.new(
|
4092
|
+
:instance_id,
|
4093
|
+
:queue_id,
|
4094
|
+
:next_token,
|
4095
|
+
:max_results)
|
4096
|
+
SENSITIVE = []
|
4097
|
+
include Aws::Structure
|
4098
|
+
end
|
4099
|
+
|
4100
|
+
# @!attribute [rw] next_token
|
4101
|
+
# If there are additional results, this is the token for the next set
|
4102
|
+
# of results.
|
4103
|
+
# @return [String]
|
4104
|
+
#
|
4105
|
+
# @!attribute [rw] quick_connect_summary_list
|
4106
|
+
# Information about the quick connects.
|
4107
|
+
# @return [Array<Types::QuickConnectSummary>]
|
4108
|
+
#
|
4109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueueQuickConnectsResponse AWS API Documentation
|
4110
|
+
#
|
4111
|
+
class ListQueueQuickConnectsResponse < Struct.new(
|
4112
|
+
:next_token,
|
4113
|
+
:quick_connect_summary_list)
|
4114
|
+
SENSITIVE = []
|
4115
|
+
include Aws::Structure
|
4116
|
+
end
|
4117
|
+
|
3343
4118
|
# @note When making an API call, you may pass ListQueuesRequest
|
3344
4119
|
# data as a hash:
|
3345
4120
|
#
|
@@ -3365,7 +4140,7 @@ module Aws::Connect
|
|
3365
4140
|
# @return [String]
|
3366
4141
|
#
|
3367
4142
|
# @!attribute [rw] max_results
|
3368
|
-
# The
|
4143
|
+
# The maximum number of results to return per page.
|
3369
4144
|
# @return [Integer]
|
3370
4145
|
#
|
3371
4146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesRequest AWS API Documentation
|
@@ -3397,6 +4172,66 @@ module Aws::Connect
|
|
3397
4172
|
include Aws::Structure
|
3398
4173
|
end
|
3399
4174
|
|
4175
|
+
# @note When making an API call, you may pass ListQuickConnectsRequest
|
4176
|
+
# data as a hash:
|
4177
|
+
#
|
4178
|
+
# {
|
4179
|
+
# instance_id: "InstanceId", # required
|
4180
|
+
# next_token: "NextToken",
|
4181
|
+
# max_results: 1,
|
4182
|
+
# quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
|
4183
|
+
# }
|
4184
|
+
#
|
4185
|
+
# @!attribute [rw] instance_id
|
4186
|
+
# The identifier of the Amazon Connect instance.
|
4187
|
+
# @return [String]
|
4188
|
+
#
|
4189
|
+
# @!attribute [rw] next_token
|
4190
|
+
# The token for the next set of results. Use the value returned in the
|
4191
|
+
# previous response in the next request to retrieve the next set of
|
4192
|
+
# results.
|
4193
|
+
# @return [String]
|
4194
|
+
#
|
4195
|
+
# @!attribute [rw] max_results
|
4196
|
+
# The maximum number of results to return per page.
|
4197
|
+
# @return [Integer]
|
4198
|
+
#
|
4199
|
+
# @!attribute [rw] quick_connect_types
|
4200
|
+
# The type of quick connect. In the Amazon Connect console, when you
|
4201
|
+
# create a quick connect, you are prompted to assign one of the
|
4202
|
+
# following types: Agent (USER), External (PHONE\_NUMBER), or Queue
|
4203
|
+
# (QUEUE).
|
4204
|
+
# @return [Array<String>]
|
4205
|
+
#
|
4206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQuickConnectsRequest AWS API Documentation
|
4207
|
+
#
|
4208
|
+
class ListQuickConnectsRequest < Struct.new(
|
4209
|
+
:instance_id,
|
4210
|
+
:next_token,
|
4211
|
+
:max_results,
|
4212
|
+
:quick_connect_types)
|
4213
|
+
SENSITIVE = []
|
4214
|
+
include Aws::Structure
|
4215
|
+
end
|
4216
|
+
|
4217
|
+
# @!attribute [rw] quick_connect_summary_list
|
4218
|
+
# Information about the quick connects.
|
4219
|
+
# @return [Array<Types::QuickConnectSummary>]
|
4220
|
+
#
|
4221
|
+
# @!attribute [rw] next_token
|
4222
|
+
# If there are additional results, this is the token for the next set
|
4223
|
+
# of results.
|
4224
|
+
# @return [String]
|
4225
|
+
#
|
4226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQuickConnectsResponse AWS API Documentation
|
4227
|
+
#
|
4228
|
+
class ListQuickConnectsResponse < Struct.new(
|
4229
|
+
:quick_connect_summary_list,
|
4230
|
+
:next_token)
|
4231
|
+
SENSITIVE = []
|
4232
|
+
include Aws::Structure
|
4233
|
+
end
|
4234
|
+
|
3400
4235
|
# @note When making an API call, you may pass ListRoutingProfileQueuesRequest
|
3401
4236
|
# data as a hash:
|
3402
4237
|
#
|
@@ -3422,7 +4257,7 @@ module Aws::Connect
|
|
3422
4257
|
# @return [String]
|
3423
4258
|
#
|
3424
4259
|
# @!attribute [rw] max_results
|
3425
|
-
# The
|
4260
|
+
# The maximum number of results to return per page.
|
3426
4261
|
# @return [Integer]
|
3427
4262
|
#
|
3428
4263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesRequest AWS API Documentation
|
@@ -3474,7 +4309,7 @@ module Aws::Connect
|
|
3474
4309
|
# @return [String]
|
3475
4310
|
#
|
3476
4311
|
# @!attribute [rw] max_results
|
3477
|
-
# The
|
4312
|
+
# The maximum number of results to return per page.
|
3478
4313
|
# @return [Integer]
|
3479
4314
|
#
|
3480
4315
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfilesRequest AWS API Documentation
|
@@ -3525,7 +4360,7 @@ module Aws::Connect
|
|
3525
4360
|
# @return [String]
|
3526
4361
|
#
|
3527
4362
|
# @!attribute [rw] max_results
|
3528
|
-
# The
|
4363
|
+
# The maximum number of results to return per page.
|
3529
4364
|
# @return [Integer]
|
3530
4365
|
#
|
3531
4366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityKeysRequest AWS API Documentation
|
@@ -3576,7 +4411,7 @@ module Aws::Connect
|
|
3576
4411
|
# @return [String]
|
3577
4412
|
#
|
3578
4413
|
# @!attribute [rw] max_results
|
3579
|
-
# The
|
4414
|
+
# The maximum number of results to return per page.
|
3580
4415
|
# @return [Integer]
|
3581
4416
|
#
|
3582
4417
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilesRequest AWS API Documentation
|
@@ -3618,22 +4453,82 @@ module Aws::Connect
|
|
3618
4453
|
# The Amazon Resource Name (ARN) of the resource.
|
3619
4454
|
# @return [String]
|
3620
4455
|
#
|
3621
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTagsForResourceRequest AWS API Documentation
|
4456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTagsForResourceRequest AWS API Documentation
|
4457
|
+
#
|
4458
|
+
class ListTagsForResourceRequest < Struct.new(
|
4459
|
+
:resource_arn)
|
4460
|
+
SENSITIVE = []
|
4461
|
+
include Aws::Structure
|
4462
|
+
end
|
4463
|
+
|
4464
|
+
# @!attribute [rw] tags
|
4465
|
+
# Information about the tags.
|
4466
|
+
# @return [Hash<String,String>]
|
4467
|
+
#
|
4468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTagsForResourceResponse AWS API Documentation
|
4469
|
+
#
|
4470
|
+
class ListTagsForResourceResponse < Struct.new(
|
4471
|
+
:tags)
|
4472
|
+
SENSITIVE = []
|
4473
|
+
include Aws::Structure
|
4474
|
+
end
|
4475
|
+
|
4476
|
+
# Provides summary information about the use cases for the specified
|
4477
|
+
# Amazon Connect AppIntegration association.
|
4478
|
+
#
|
4479
|
+
# @note When making an API call, you may pass ListUseCasesRequest
|
4480
|
+
# data as a hash:
|
4481
|
+
#
|
4482
|
+
# {
|
4483
|
+
# instance_id: "InstanceId", # required
|
4484
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
4485
|
+
# next_token: "NextToken",
|
4486
|
+
# max_results: 1,
|
4487
|
+
# }
|
4488
|
+
#
|
4489
|
+
# @!attribute [rw] instance_id
|
4490
|
+
# The identifier of the Amazon Connect instance.
|
4491
|
+
# @return [String]
|
4492
|
+
#
|
4493
|
+
# @!attribute [rw] integration_association_id
|
4494
|
+
# The identifier for the integration association.
|
4495
|
+
# @return [String]
|
4496
|
+
#
|
4497
|
+
# @!attribute [rw] next_token
|
4498
|
+
# The token for the next set of results. Use the value returned in the
|
4499
|
+
# previous response in the next request to retrieve the next set of
|
4500
|
+
# results.
|
4501
|
+
# @return [String]
|
4502
|
+
#
|
4503
|
+
# @!attribute [rw] max_results
|
4504
|
+
# The maximum number of results to return per page.
|
4505
|
+
# @return [Integer]
|
4506
|
+
#
|
4507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesRequest AWS API Documentation
|
3622
4508
|
#
|
3623
|
-
class
|
3624
|
-
:
|
4509
|
+
class ListUseCasesRequest < Struct.new(
|
4510
|
+
:instance_id,
|
4511
|
+
:integration_association_id,
|
4512
|
+
:next_token,
|
4513
|
+
:max_results)
|
3625
4514
|
SENSITIVE = []
|
3626
4515
|
include Aws::Structure
|
3627
4516
|
end
|
3628
4517
|
|
3629
|
-
# @!attribute [rw]
|
3630
|
-
#
|
3631
|
-
# @return [
|
4518
|
+
# @!attribute [rw] use_case_summary_list
|
4519
|
+
# The use cases.
|
4520
|
+
# @return [Array<Types::UseCase>]
|
3632
4521
|
#
|
3633
|
-
#
|
4522
|
+
# @!attribute [rw] next_token
|
4523
|
+
# If there are additional results, this is the token for the next set
|
4524
|
+
# of results.
|
4525
|
+
# @return [String]
|
3634
4526
|
#
|
3635
|
-
|
3636
|
-
|
4527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesResponse AWS API Documentation
|
4528
|
+
#
|
4529
|
+
class ListUseCasesResponse < Struct.new(
|
4530
|
+
:use_case_summary_list,
|
4531
|
+
:next_token)
|
3637
4532
|
SENSITIVE = []
|
3638
4533
|
include Aws::Structure
|
3639
4534
|
end
|
@@ -3658,7 +4553,7 @@ module Aws::Connect
|
|
3658
4553
|
# @return [String]
|
3659
4554
|
#
|
3660
4555
|
# @!attribute [rw] max_results
|
3661
|
-
# The
|
4556
|
+
# The maximum number of results to return per page.
|
3662
4557
|
# @return [Integer]
|
3663
4558
|
#
|
3664
4559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroupsRequest AWS API Documentation
|
@@ -3709,7 +4604,7 @@ module Aws::Connect
|
|
3709
4604
|
# @return [String]
|
3710
4605
|
#
|
3711
4606
|
# @!attribute [rw] max_results
|
3712
|
-
# The
|
4607
|
+
# The maximum number of results to return per page.
|
3713
4608
|
# @return [Integer]
|
3714
4609
|
#
|
3715
4610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsersRequest AWS API Documentation
|
@@ -3747,7 +4642,7 @@ module Aws::Connect
|
|
3747
4642
|
# data as a hash:
|
3748
4643
|
#
|
3749
4644
|
# {
|
3750
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4645
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
3751
4646
|
# concurrency: 1, # required
|
3752
4647
|
# }
|
3753
4648
|
#
|
@@ -3770,10 +4665,43 @@ module Aws::Connect
|
|
3770
4665
|
include Aws::Structure
|
3771
4666
|
end
|
3772
4667
|
|
4668
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
4669
|
+
#
|
4670
|
+
# @note When making an API call, you may pass OutboundCallerConfig
|
4671
|
+
# data as a hash:
|
4672
|
+
#
|
4673
|
+
# {
|
4674
|
+
# outbound_caller_id_name: "OutboundCallerIdName",
|
4675
|
+
# outbound_caller_id_number_id: "PhoneNumberId",
|
4676
|
+
# outbound_flow_id: "ContactFlowId",
|
4677
|
+
# }
|
4678
|
+
#
|
4679
|
+
# @!attribute [rw] outbound_caller_id_name
|
4680
|
+
# The caller ID name.
|
4681
|
+
# @return [String]
|
4682
|
+
#
|
4683
|
+
# @!attribute [rw] outbound_caller_id_number_id
|
4684
|
+
# The caller ID number.
|
4685
|
+
# @return [String]
|
4686
|
+
#
|
4687
|
+
# @!attribute [rw] outbound_flow_id
|
4688
|
+
# The outbound whisper flow to be used during an outbound call.
|
4689
|
+
# @return [String]
|
4690
|
+
#
|
4691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundCallerConfig AWS API Documentation
|
4692
|
+
#
|
4693
|
+
class OutboundCallerConfig < Struct.new(
|
4694
|
+
:outbound_caller_id_name,
|
4695
|
+
:outbound_caller_id_number_id,
|
4696
|
+
:outbound_flow_id)
|
4697
|
+
SENSITIVE = []
|
4698
|
+
include Aws::Structure
|
4699
|
+
end
|
4700
|
+
|
3773
4701
|
# The contact is not permitted.
|
3774
4702
|
#
|
3775
4703
|
# @!attribute [rw] message
|
3776
|
-
# The message.
|
4704
|
+
# The message about the contact.
|
3777
4705
|
# @return [String]
|
3778
4706
|
#
|
3779
4707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundContactNotPermittedException AWS API Documentation
|
@@ -3805,6 +4733,27 @@ module Aws::Connect
|
|
3805
4733
|
include Aws::Structure
|
3806
4734
|
end
|
3807
4735
|
|
4736
|
+
# Contains information about a phone number for a quick connect.
|
4737
|
+
#
|
4738
|
+
# @note When making an API call, you may pass PhoneNumberQuickConnectConfig
|
4739
|
+
# data as a hash:
|
4740
|
+
#
|
4741
|
+
# {
|
4742
|
+
# phone_number: "PhoneNumber", # required
|
4743
|
+
# }
|
4744
|
+
#
|
4745
|
+
# @!attribute [rw] phone_number
|
4746
|
+
# The phone number in E.164 format.
|
4747
|
+
# @return [String]
|
4748
|
+
#
|
4749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PhoneNumberQuickConnectConfig AWS API Documentation
|
4750
|
+
#
|
4751
|
+
class PhoneNumberQuickConnectConfig < Struct.new(
|
4752
|
+
:phone_number)
|
4753
|
+
SENSITIVE = []
|
4754
|
+
include Aws::Structure
|
4755
|
+
end
|
4756
|
+
|
3808
4757
|
# Contains summary information about a phone number for a contact
|
3809
4758
|
# center.
|
3810
4759
|
#
|
@@ -3878,6 +4827,89 @@ module Aws::Connect
|
|
3878
4827
|
include Aws::Structure
|
3879
4828
|
end
|
3880
4829
|
|
4830
|
+
# Contains information about a queue.
|
4831
|
+
#
|
4832
|
+
# @!attribute [rw] name
|
4833
|
+
# The name of the queue.
|
4834
|
+
# @return [String]
|
4835
|
+
#
|
4836
|
+
# @!attribute [rw] queue_arn
|
4837
|
+
# The Amazon Resource Name (ARN) for the queue.
|
4838
|
+
# @return [String]
|
4839
|
+
#
|
4840
|
+
# @!attribute [rw] queue_id
|
4841
|
+
# The identifier for the queue.
|
4842
|
+
# @return [String]
|
4843
|
+
#
|
4844
|
+
# @!attribute [rw] description
|
4845
|
+
# The description of the queue.
|
4846
|
+
# @return [String]
|
4847
|
+
#
|
4848
|
+
# @!attribute [rw] outbound_caller_config
|
4849
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
4850
|
+
# @return [Types::OutboundCallerConfig]
|
4851
|
+
#
|
4852
|
+
# @!attribute [rw] hours_of_operation_id
|
4853
|
+
# The identifier for the hours of operation.
|
4854
|
+
# @return [String]
|
4855
|
+
#
|
4856
|
+
# @!attribute [rw] max_contacts
|
4857
|
+
# The maximum number of contacts that can be in the queue before it is
|
4858
|
+
# considered full.
|
4859
|
+
# @return [Integer]
|
4860
|
+
#
|
4861
|
+
# @!attribute [rw] status
|
4862
|
+
# The status of the queue.
|
4863
|
+
# @return [String]
|
4864
|
+
#
|
4865
|
+
# @!attribute [rw] tags
|
4866
|
+
# One or more tags.
|
4867
|
+
# @return [Hash<String,String>]
|
4868
|
+
#
|
4869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Queue AWS API Documentation
|
4870
|
+
#
|
4871
|
+
class Queue < Struct.new(
|
4872
|
+
:name,
|
4873
|
+
:queue_arn,
|
4874
|
+
:queue_id,
|
4875
|
+
:description,
|
4876
|
+
:outbound_caller_config,
|
4877
|
+
:hours_of_operation_id,
|
4878
|
+
:max_contacts,
|
4879
|
+
:status,
|
4880
|
+
:tags)
|
4881
|
+
SENSITIVE = []
|
4882
|
+
include Aws::Structure
|
4883
|
+
end
|
4884
|
+
|
4885
|
+
# Contains information about a queue for a quick connect. The contact
|
4886
|
+
# flow must be of type Transfer to Queue.
|
4887
|
+
#
|
4888
|
+
# @note When making an API call, you may pass QueueQuickConnectConfig
|
4889
|
+
# data as a hash:
|
4890
|
+
#
|
4891
|
+
# {
|
4892
|
+
# queue_id: "QueueId", # required
|
4893
|
+
# contact_flow_id: "ContactFlowId", # required
|
4894
|
+
# }
|
4895
|
+
#
|
4896
|
+
# @!attribute [rw] queue_id
|
4897
|
+
# The identifier for the queue.
|
4898
|
+
# @return [String]
|
4899
|
+
#
|
4900
|
+
# @!attribute [rw] contact_flow_id
|
4901
|
+
# The identifier of the contact flow.
|
4902
|
+
# @return [String]
|
4903
|
+
#
|
4904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueQuickConnectConfig AWS API Documentation
|
4905
|
+
#
|
4906
|
+
class QueueQuickConnectConfig < Struct.new(
|
4907
|
+
:queue_id,
|
4908
|
+
:contact_flow_id)
|
4909
|
+
SENSITIVE = []
|
4910
|
+
include Aws::Structure
|
4911
|
+
end
|
4912
|
+
|
3881
4913
|
# Contains information about a queue resource for which metrics are
|
3882
4914
|
# returned.
|
3883
4915
|
#
|
@@ -3927,6 +4959,159 @@ module Aws::Connect
|
|
3927
4959
|
include Aws::Structure
|
3928
4960
|
end
|
3929
4961
|
|
4962
|
+
# Contains information about a quick connect.
|
4963
|
+
#
|
4964
|
+
# @!attribute [rw] quick_connect_arn
|
4965
|
+
# The Amazon Resource Name (ARN) of the quick connect.
|
4966
|
+
# @return [String]
|
4967
|
+
#
|
4968
|
+
# @!attribute [rw] quick_connect_id
|
4969
|
+
# The identifier for the quick connect.
|
4970
|
+
# @return [String]
|
4971
|
+
#
|
4972
|
+
# @!attribute [rw] name
|
4973
|
+
# The name of the quick connect.
|
4974
|
+
# @return [String]
|
4975
|
+
#
|
4976
|
+
# @!attribute [rw] description
|
4977
|
+
# The description.
|
4978
|
+
# @return [String]
|
4979
|
+
#
|
4980
|
+
# @!attribute [rw] quick_connect_config
|
4981
|
+
# Contains information about the quick connect.
|
4982
|
+
# @return [Types::QuickConnectConfig]
|
4983
|
+
#
|
4984
|
+
# @!attribute [rw] tags
|
4985
|
+
# One or more tags.
|
4986
|
+
# @return [Hash<String,String>]
|
4987
|
+
#
|
4988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QuickConnect AWS API Documentation
|
4989
|
+
#
|
4990
|
+
class QuickConnect < Struct.new(
|
4991
|
+
:quick_connect_arn,
|
4992
|
+
:quick_connect_id,
|
4993
|
+
:name,
|
4994
|
+
:description,
|
4995
|
+
:quick_connect_config,
|
4996
|
+
:tags)
|
4997
|
+
SENSITIVE = []
|
4998
|
+
include Aws::Structure
|
4999
|
+
end
|
5000
|
+
|
5001
|
+
# Contains configuration settings for a quick connect.
|
5002
|
+
#
|
5003
|
+
# @note When making an API call, you may pass QuickConnectConfig
|
5004
|
+
# data as a hash:
|
5005
|
+
#
|
5006
|
+
# {
|
5007
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
5008
|
+
# user_config: {
|
5009
|
+
# user_id: "UserId", # required
|
5010
|
+
# contact_flow_id: "ContactFlowId", # required
|
5011
|
+
# },
|
5012
|
+
# queue_config: {
|
5013
|
+
# queue_id: "QueueId", # required
|
5014
|
+
# contact_flow_id: "ContactFlowId", # required
|
5015
|
+
# },
|
5016
|
+
# phone_config: {
|
5017
|
+
# phone_number: "PhoneNumber", # required
|
5018
|
+
# },
|
5019
|
+
# }
|
5020
|
+
#
|
5021
|
+
# @!attribute [rw] quick_connect_type
|
5022
|
+
# The type of quick connect. In the Amazon Connect console, when you
|
5023
|
+
# create a quick connect, you are prompted to assign one of the
|
5024
|
+
# following types: Agent (USER), External (PHONE\_NUMBER), or Queue
|
5025
|
+
# (QUEUE).
|
5026
|
+
# @return [String]
|
5027
|
+
#
|
5028
|
+
# @!attribute [rw] user_config
|
5029
|
+
# The user configuration. This is required only if QuickConnectType is
|
5030
|
+
# USER.
|
5031
|
+
# @return [Types::UserQuickConnectConfig]
|
5032
|
+
#
|
5033
|
+
# @!attribute [rw] queue_config
|
5034
|
+
# The queue configuration. This is required only if QuickConnectType
|
5035
|
+
# is QUEUE.
|
5036
|
+
# @return [Types::QueueQuickConnectConfig]
|
5037
|
+
#
|
5038
|
+
# @!attribute [rw] phone_config
|
5039
|
+
# The phone configuration. This is required only if QuickConnectType
|
5040
|
+
# is PHONE\_NUMBER.
|
5041
|
+
# @return [Types::PhoneNumberQuickConnectConfig]
|
5042
|
+
#
|
5043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QuickConnectConfig AWS API Documentation
|
5044
|
+
#
|
5045
|
+
class QuickConnectConfig < Struct.new(
|
5046
|
+
:quick_connect_type,
|
5047
|
+
:user_config,
|
5048
|
+
:queue_config,
|
5049
|
+
:phone_config)
|
5050
|
+
SENSITIVE = []
|
5051
|
+
include Aws::Structure
|
5052
|
+
end
|
5053
|
+
|
5054
|
+
# Contains summary information about a quick connect.
|
5055
|
+
#
|
5056
|
+
# @!attribute [rw] id
|
5057
|
+
# The identifier for the quick connect.
|
5058
|
+
# @return [String]
|
5059
|
+
#
|
5060
|
+
# @!attribute [rw] arn
|
5061
|
+
# The Amazon Resource Name (ARN) of the quick connect.
|
5062
|
+
# @return [String]
|
5063
|
+
#
|
5064
|
+
# @!attribute [rw] name
|
5065
|
+
# The name of the quick connect.
|
5066
|
+
# @return [String]
|
5067
|
+
#
|
5068
|
+
# @!attribute [rw] quick_connect_type
|
5069
|
+
# The type of quick connect. In the Amazon Connect console, when you
|
5070
|
+
# create a quick connect, you are prompted to assign one of the
|
5071
|
+
# following types: Agent (USER), External (PHONE\_NUMBER), or Queue
|
5072
|
+
# (QUEUE).
|
5073
|
+
# @return [String]
|
5074
|
+
#
|
5075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QuickConnectSummary AWS API Documentation
|
5076
|
+
#
|
5077
|
+
class QuickConnectSummary < Struct.new(
|
5078
|
+
:id,
|
5079
|
+
:arn,
|
5080
|
+
:name,
|
5081
|
+
:quick_connect_type)
|
5082
|
+
SENSITIVE = []
|
5083
|
+
include Aws::Structure
|
5084
|
+
end
|
5085
|
+
|
5086
|
+
# A link that an agent selects to complete a given task. You can have up
|
5087
|
+
# to 4,096 UTF-8 bytes across all references for a contact.
|
5088
|
+
#
|
5089
|
+
# @note When making an API call, you may pass Reference
|
5090
|
+
# data as a hash:
|
5091
|
+
#
|
5092
|
+
# {
|
5093
|
+
# value: "ReferenceValue", # required
|
5094
|
+
# type: "URL", # required, accepts URL
|
5095
|
+
# }
|
5096
|
+
#
|
5097
|
+
# @!attribute [rw] value
|
5098
|
+
# A formatted URL that displays to an agent in the Contact Control
|
5099
|
+
# Panel (CCP)
|
5100
|
+
# @return [String]
|
5101
|
+
#
|
5102
|
+
# @!attribute [rw] type
|
5103
|
+
# A valid URL.
|
5104
|
+
# @return [String]
|
5105
|
+
#
|
5106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
5107
|
+
#
|
5108
|
+
class Reference < Struct.new(
|
5109
|
+
:value,
|
5110
|
+
:type)
|
5111
|
+
SENSITIVE = []
|
5112
|
+
include Aws::Structure
|
5113
|
+
end
|
5114
|
+
|
3930
5115
|
# A resource already has that name.
|
3931
5116
|
#
|
3932
5117
|
# @!attribute [rw] message
|
@@ -3966,7 +5151,7 @@ module Aws::Connect
|
|
3966
5151
|
# The specified resource was not found.
|
3967
5152
|
#
|
3968
5153
|
# @!attribute [rw] message
|
3969
|
-
# The message.
|
5154
|
+
# The message about the resource.
|
3970
5155
|
# @return [String]
|
3971
5156
|
#
|
3972
5157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceNotFoundException AWS API Documentation
|
@@ -4073,7 +5258,7 @@ module Aws::Connect
|
|
4073
5258
|
# {
|
4074
5259
|
# queue_reference: { # required
|
4075
5260
|
# queue_id: "QueueId", # required
|
4076
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
5261
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
4077
5262
|
# },
|
4078
5263
|
# priority: 1, # required
|
4079
5264
|
# delay: 1, # required
|
@@ -4115,7 +5300,7 @@ module Aws::Connect
|
|
4115
5300
|
# Contains summary information about a routing profile queue.
|
4116
5301
|
#
|
4117
5302
|
# @!attribute [rw] queue_id
|
4118
|
-
# The identifier
|
5303
|
+
# The identifier for the queue.
|
4119
5304
|
# @return [String]
|
4120
5305
|
#
|
4121
5306
|
# @!attribute [rw] queue_arn
|
@@ -4170,11 +5355,11 @@ module Aws::Connect
|
|
4170
5355
|
#
|
4171
5356
|
# {
|
4172
5357
|
# queue_id: "QueueId", # required
|
4173
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
5358
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
4174
5359
|
# }
|
4175
5360
|
#
|
4176
5361
|
# @!attribute [rw] queue_id
|
4177
|
-
# The identifier
|
5362
|
+
# The identifier for the queue.
|
4178
5363
|
# @return [String]
|
4179
5364
|
#
|
4180
5365
|
# @!attribute [rw] channel
|
@@ -4215,7 +5400,8 @@ module Aws::Connect
|
|
4215
5400
|
include Aws::Structure
|
4216
5401
|
end
|
4217
5402
|
|
4218
|
-
# Information about the
|
5403
|
+
# Information about the Amazon Simple Storage Service (Amazon S3)
|
5404
|
+
# storage type.
|
4219
5405
|
#
|
4220
5406
|
# @note When making an API call, you may pass S3Config
|
4221
5407
|
# data as a hash:
|
@@ -4238,7 +5424,7 @@ module Aws::Connect
|
|
4238
5424
|
# @return [String]
|
4239
5425
|
#
|
4240
5426
|
# @!attribute [rw] encryption_config
|
4241
|
-
# The S3 encryption configuration.
|
5427
|
+
# The Amazon S3 encryption configuration.
|
4242
5428
|
# @return [Types::EncryptionConfig]
|
4243
5429
|
#
|
4244
5430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/S3Config AWS API Documentation
|
@@ -4349,7 +5535,7 @@ module Aws::Connect
|
|
4349
5535
|
#
|
4350
5536
|
# @!attribute [rw] attributes
|
4351
5537
|
# A custom key-value pair using an attribute map. The attributes are
|
4352
|
-
# standard Amazon Connect attributes
|
5538
|
+
# standard Amazon Connect attributes. They can be accessed in contact
|
4353
5539
|
# flows just like any other contact attributes.
|
4354
5540
|
#
|
4355
5541
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
@@ -4441,7 +5627,7 @@ module Aws::Connect
|
|
4441
5627
|
# @return [String]
|
4442
5628
|
#
|
4443
5629
|
# @!attribute [rw] voice_recording_configuration
|
4444
|
-
#
|
5630
|
+
# The person being recorded.
|
4445
5631
|
# @return [Types::VoiceRecordingConfiguration]
|
4446
5632
|
#
|
4447
5633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingRequest AWS API Documentation
|
@@ -4509,12 +5695,88 @@ module Aws::Connect
|
|
4509
5695
|
# specify a queue.
|
4510
5696
|
# @return [String]
|
4511
5697
|
#
|
4512
|
-
# @!attribute [rw] queue_id
|
4513
|
-
# The queue for the call. If you specify a queue, the phone displayed
|
4514
|
-
# for caller ID is the phone number specified in the queue. If you do
|
4515
|
-
# not specify a queue, the queue defined in the contact flow is used.
|
4516
|
-
# If you do not specify a queue, you must specify a source phone
|
4517
|
-
# number.
|
5698
|
+
# @!attribute [rw] queue_id
|
5699
|
+
# The queue for the call. If you specify a queue, the phone displayed
|
5700
|
+
# for caller ID is the phone number specified in the queue. If you do
|
5701
|
+
# not specify a queue, the queue defined in the contact flow is used.
|
5702
|
+
# If you do not specify a queue, you must specify a source phone
|
5703
|
+
# number.
|
5704
|
+
# @return [String]
|
5705
|
+
#
|
5706
|
+
# @!attribute [rw] attributes
|
5707
|
+
# A custom key-value pair using an attribute map. The attributes are
|
5708
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
5709
|
+
# flows just like any other contact attributes.
|
5710
|
+
#
|
5711
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
5712
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
5713
|
+
# underscore characters.
|
5714
|
+
# @return [Hash<String,String>]
|
5715
|
+
#
|
5716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactRequest AWS API Documentation
|
5717
|
+
#
|
5718
|
+
class StartOutboundVoiceContactRequest < Struct.new(
|
5719
|
+
:destination_phone_number,
|
5720
|
+
:contact_flow_id,
|
5721
|
+
:instance_id,
|
5722
|
+
:client_token,
|
5723
|
+
:source_phone_number,
|
5724
|
+
:queue_id,
|
5725
|
+
:attributes)
|
5726
|
+
SENSITIVE = []
|
5727
|
+
include Aws::Structure
|
5728
|
+
end
|
5729
|
+
|
5730
|
+
# @!attribute [rw] contact_id
|
5731
|
+
# The identifier of this contact within the Amazon Connect instance.
|
5732
|
+
# @return [String]
|
5733
|
+
#
|
5734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactResponse AWS API Documentation
|
5735
|
+
#
|
5736
|
+
class StartOutboundVoiceContactResponse < Struct.new(
|
5737
|
+
:contact_id)
|
5738
|
+
SENSITIVE = []
|
5739
|
+
include Aws::Structure
|
5740
|
+
end
|
5741
|
+
|
5742
|
+
# @note When making an API call, you may pass StartTaskContactRequest
|
5743
|
+
# data as a hash:
|
5744
|
+
#
|
5745
|
+
# {
|
5746
|
+
# instance_id: "InstanceId", # required
|
5747
|
+
# previous_contact_id: "ContactId",
|
5748
|
+
# contact_flow_id: "ContactFlowId", # required
|
5749
|
+
# attributes: {
|
5750
|
+
# "AttributeName" => "AttributeValue",
|
5751
|
+
# },
|
5752
|
+
# name: "Name", # required
|
5753
|
+
# references: {
|
5754
|
+
# "ReferenceKey" => {
|
5755
|
+
# value: "ReferenceValue", # required
|
5756
|
+
# type: "URL", # required, accepts URL
|
5757
|
+
# },
|
5758
|
+
# },
|
5759
|
+
# description: "Description",
|
5760
|
+
# client_token: "ClientToken",
|
5761
|
+
# }
|
5762
|
+
#
|
5763
|
+
# @!attribute [rw] instance_id
|
5764
|
+
# The identifier of the Amazon Connect instance.
|
5765
|
+
# @return [String]
|
5766
|
+
#
|
5767
|
+
# @!attribute [rw] previous_contact_id
|
5768
|
+
# The identifier of the previous chat, voice, or task contact.
|
5769
|
+
# @return [String]
|
5770
|
+
#
|
5771
|
+
# @!attribute [rw] contact_flow_id
|
5772
|
+
# The identifier of the contact flow for initiating the tasks. To see
|
5773
|
+
# the ContactFlowId in the Amazon Connect console user interface, on
|
5774
|
+
# the navigation menu go to **Routing**, **Contact Flows**. Choose the
|
5775
|
+
# contact flow. On the contact flow page, under the name of the
|
5776
|
+
# contact flow, choose **Show additional flow information**. The
|
5777
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
5778
|
+
#
|
5779
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
4518
5780
|
# @return [String]
|
4519
5781
|
#
|
4520
5782
|
# @!attribute [rw] attributes
|
@@ -4527,16 +5789,40 @@ module Aws::Connect
|
|
4527
5789
|
# underscore characters.
|
4528
5790
|
# @return [Hash<String,String>]
|
4529
5791
|
#
|
4530
|
-
#
|
5792
|
+
# @!attribute [rw] name
|
5793
|
+
# The name of a task that is shown to an agent in the Contact Control
|
5794
|
+
# Panel (CCP).
|
5795
|
+
# @return [String]
|
4531
5796
|
#
|
4532
|
-
|
4533
|
-
|
4534
|
-
|
5797
|
+
# @!attribute [rw] references
|
5798
|
+
# A formatted URL that is shown to an agent in the Contact Control
|
5799
|
+
# Panel (CCP).
|
5800
|
+
# @return [Hash<String,Types::Reference>]
|
5801
|
+
#
|
5802
|
+
# @!attribute [rw] description
|
5803
|
+
# A description of the task that is shown to an agent in the Contact
|
5804
|
+
# Control Panel (CCP).
|
5805
|
+
# @return [String]
|
5806
|
+
#
|
5807
|
+
# @!attribute [rw] client_token
|
5808
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
5809
|
+
# idempotency of the request.
|
5810
|
+
#
|
5811
|
+
# **A suitable default value is auto-generated.** You should normally
|
5812
|
+
# not need to pass this option.
|
5813
|
+
# @return [String]
|
5814
|
+
#
|
5815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
|
5816
|
+
#
|
5817
|
+
class StartTaskContactRequest < Struct.new(
|
4535
5818
|
:instance_id,
|
4536
|
-
:
|
4537
|
-
:
|
4538
|
-
:
|
4539
|
-
:
|
5819
|
+
:previous_contact_id,
|
5820
|
+
:contact_flow_id,
|
5821
|
+
:attributes,
|
5822
|
+
:name,
|
5823
|
+
:references,
|
5824
|
+
:description,
|
5825
|
+
:client_token)
|
4540
5826
|
SENSITIVE = []
|
4541
5827
|
include Aws::Structure
|
4542
5828
|
end
|
@@ -4545,9 +5831,9 @@ module Aws::Connect
|
|
4545
5831
|
# The identifier of this contact within the Amazon Connect instance.
|
4546
5832
|
# @return [String]
|
4547
5833
|
#
|
4548
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
5834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactResponse AWS API Documentation
|
4549
5835
|
#
|
4550
|
-
class
|
5836
|
+
class StartTaskContactResponse < Struct.new(
|
4551
5837
|
:contact_id)
|
4552
5838
|
SENSITIVE = []
|
4553
5839
|
include Aws::Structure
|
@@ -4959,6 +6245,253 @@ module Aws::Connect
|
|
4959
6245
|
include Aws::Structure
|
4960
6246
|
end
|
4961
6247
|
|
6248
|
+
# @note When making an API call, you may pass UpdateQueueHoursOfOperationRequest
|
6249
|
+
# data as a hash:
|
6250
|
+
#
|
6251
|
+
# {
|
6252
|
+
# instance_id: "InstanceId", # required
|
6253
|
+
# queue_id: "QueueId", # required
|
6254
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
6255
|
+
# }
|
6256
|
+
#
|
6257
|
+
# @!attribute [rw] instance_id
|
6258
|
+
# The identifier of the Amazon Connect instance.
|
6259
|
+
# @return [String]
|
6260
|
+
#
|
6261
|
+
# @!attribute [rw] queue_id
|
6262
|
+
# The identifier for the queue.
|
6263
|
+
# @return [String]
|
6264
|
+
#
|
6265
|
+
# @!attribute [rw] hours_of_operation_id
|
6266
|
+
# The identifier for the hours of operation.
|
6267
|
+
# @return [String]
|
6268
|
+
#
|
6269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueHoursOfOperationRequest AWS API Documentation
|
6270
|
+
#
|
6271
|
+
class UpdateQueueHoursOfOperationRequest < Struct.new(
|
6272
|
+
:instance_id,
|
6273
|
+
:queue_id,
|
6274
|
+
:hours_of_operation_id)
|
6275
|
+
SENSITIVE = []
|
6276
|
+
include Aws::Structure
|
6277
|
+
end
|
6278
|
+
|
6279
|
+
# @note When making an API call, you may pass UpdateQueueMaxContactsRequest
|
6280
|
+
# data as a hash:
|
6281
|
+
#
|
6282
|
+
# {
|
6283
|
+
# instance_id: "InstanceId", # required
|
6284
|
+
# queue_id: "QueueId", # required
|
6285
|
+
# max_contacts: 1, # required
|
6286
|
+
# }
|
6287
|
+
#
|
6288
|
+
# @!attribute [rw] instance_id
|
6289
|
+
# The identifier of the Amazon Connect instance.
|
6290
|
+
# @return [String]
|
6291
|
+
#
|
6292
|
+
# @!attribute [rw] queue_id
|
6293
|
+
# The identifier for the queue.
|
6294
|
+
# @return [String]
|
6295
|
+
#
|
6296
|
+
# @!attribute [rw] max_contacts
|
6297
|
+
# The maximum number of contacts that can be in the queue before it is
|
6298
|
+
# considered full.
|
6299
|
+
# @return [Integer]
|
6300
|
+
#
|
6301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueMaxContactsRequest AWS API Documentation
|
6302
|
+
#
|
6303
|
+
class UpdateQueueMaxContactsRequest < Struct.new(
|
6304
|
+
:instance_id,
|
6305
|
+
:queue_id,
|
6306
|
+
:max_contacts)
|
6307
|
+
SENSITIVE = []
|
6308
|
+
include Aws::Structure
|
6309
|
+
end
|
6310
|
+
|
6311
|
+
# @note When making an API call, you may pass UpdateQueueNameRequest
|
6312
|
+
# data as a hash:
|
6313
|
+
#
|
6314
|
+
# {
|
6315
|
+
# instance_id: "InstanceId", # required
|
6316
|
+
# queue_id: "QueueId", # required
|
6317
|
+
# name: "CommonNameLength127",
|
6318
|
+
# description: "QueueDescription",
|
6319
|
+
# }
|
6320
|
+
#
|
6321
|
+
# @!attribute [rw] instance_id
|
6322
|
+
# The identifier of the Amazon Connect instance.
|
6323
|
+
# @return [String]
|
6324
|
+
#
|
6325
|
+
# @!attribute [rw] queue_id
|
6326
|
+
# The identifier for the queue.
|
6327
|
+
# @return [String]
|
6328
|
+
#
|
6329
|
+
# @!attribute [rw] name
|
6330
|
+
# The name of the queue.
|
6331
|
+
# @return [String]
|
6332
|
+
#
|
6333
|
+
# @!attribute [rw] description
|
6334
|
+
# The description of the queue.
|
6335
|
+
# @return [String]
|
6336
|
+
#
|
6337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueNameRequest AWS API Documentation
|
6338
|
+
#
|
6339
|
+
class UpdateQueueNameRequest < Struct.new(
|
6340
|
+
:instance_id,
|
6341
|
+
:queue_id,
|
6342
|
+
:name,
|
6343
|
+
:description)
|
6344
|
+
SENSITIVE = []
|
6345
|
+
include Aws::Structure
|
6346
|
+
end
|
6347
|
+
|
6348
|
+
# @note When making an API call, you may pass UpdateQueueOutboundCallerConfigRequest
|
6349
|
+
# data as a hash:
|
6350
|
+
#
|
6351
|
+
# {
|
6352
|
+
# instance_id: "InstanceId", # required
|
6353
|
+
# queue_id: "QueueId", # required
|
6354
|
+
# outbound_caller_config: { # required
|
6355
|
+
# outbound_caller_id_name: "OutboundCallerIdName",
|
6356
|
+
# outbound_caller_id_number_id: "PhoneNumberId",
|
6357
|
+
# outbound_flow_id: "ContactFlowId",
|
6358
|
+
# },
|
6359
|
+
# }
|
6360
|
+
#
|
6361
|
+
# @!attribute [rw] instance_id
|
6362
|
+
# The identifier of the Amazon Connect instance.
|
6363
|
+
# @return [String]
|
6364
|
+
#
|
6365
|
+
# @!attribute [rw] queue_id
|
6366
|
+
# The identifier for the queue.
|
6367
|
+
# @return [String]
|
6368
|
+
#
|
6369
|
+
# @!attribute [rw] outbound_caller_config
|
6370
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
6371
|
+
# @return [Types::OutboundCallerConfig]
|
6372
|
+
#
|
6373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundCallerConfigRequest AWS API Documentation
|
6374
|
+
#
|
6375
|
+
class UpdateQueueOutboundCallerConfigRequest < Struct.new(
|
6376
|
+
:instance_id,
|
6377
|
+
:queue_id,
|
6378
|
+
:outbound_caller_config)
|
6379
|
+
SENSITIVE = []
|
6380
|
+
include Aws::Structure
|
6381
|
+
end
|
6382
|
+
|
6383
|
+
# @note When making an API call, you may pass UpdateQueueStatusRequest
|
6384
|
+
# data as a hash:
|
6385
|
+
#
|
6386
|
+
# {
|
6387
|
+
# instance_id: "InstanceId", # required
|
6388
|
+
# queue_id: "QueueId", # required
|
6389
|
+
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
6390
|
+
# }
|
6391
|
+
#
|
6392
|
+
# @!attribute [rw] instance_id
|
6393
|
+
# The identifier of the Amazon Connect instance.
|
6394
|
+
# @return [String]
|
6395
|
+
#
|
6396
|
+
# @!attribute [rw] queue_id
|
6397
|
+
# The identifier for the queue.
|
6398
|
+
# @return [String]
|
6399
|
+
#
|
6400
|
+
# @!attribute [rw] status
|
6401
|
+
# The status of the queue.
|
6402
|
+
# @return [String]
|
6403
|
+
#
|
6404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueStatusRequest AWS API Documentation
|
6405
|
+
#
|
6406
|
+
class UpdateQueueStatusRequest < Struct.new(
|
6407
|
+
:instance_id,
|
6408
|
+
:queue_id,
|
6409
|
+
:status)
|
6410
|
+
SENSITIVE = []
|
6411
|
+
include Aws::Structure
|
6412
|
+
end
|
6413
|
+
|
6414
|
+
# @note When making an API call, you may pass UpdateQuickConnectConfigRequest
|
6415
|
+
# data as a hash:
|
6416
|
+
#
|
6417
|
+
# {
|
6418
|
+
# instance_id: "InstanceId", # required
|
6419
|
+
# quick_connect_id: "QuickConnectId", # required
|
6420
|
+
# quick_connect_config: { # required
|
6421
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
6422
|
+
# user_config: {
|
6423
|
+
# user_id: "UserId", # required
|
6424
|
+
# contact_flow_id: "ContactFlowId", # required
|
6425
|
+
# },
|
6426
|
+
# queue_config: {
|
6427
|
+
# queue_id: "QueueId", # required
|
6428
|
+
# contact_flow_id: "ContactFlowId", # required
|
6429
|
+
# },
|
6430
|
+
# phone_config: {
|
6431
|
+
# phone_number: "PhoneNumber", # required
|
6432
|
+
# },
|
6433
|
+
# },
|
6434
|
+
# }
|
6435
|
+
#
|
6436
|
+
# @!attribute [rw] instance_id
|
6437
|
+
# The identifier of the Amazon Connect instance.
|
6438
|
+
# @return [String]
|
6439
|
+
#
|
6440
|
+
# @!attribute [rw] quick_connect_id
|
6441
|
+
# The identifier for the quick connect.
|
6442
|
+
# @return [String]
|
6443
|
+
#
|
6444
|
+
# @!attribute [rw] quick_connect_config
|
6445
|
+
# Information about the configuration settings for the quick connect.
|
6446
|
+
# @return [Types::QuickConnectConfig]
|
6447
|
+
#
|
6448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectConfigRequest AWS API Documentation
|
6449
|
+
#
|
6450
|
+
class UpdateQuickConnectConfigRequest < Struct.new(
|
6451
|
+
:instance_id,
|
6452
|
+
:quick_connect_id,
|
6453
|
+
:quick_connect_config)
|
6454
|
+
SENSITIVE = []
|
6455
|
+
include Aws::Structure
|
6456
|
+
end
|
6457
|
+
|
6458
|
+
# @note When making an API call, you may pass UpdateQuickConnectNameRequest
|
6459
|
+
# data as a hash:
|
6460
|
+
#
|
6461
|
+
# {
|
6462
|
+
# instance_id: "InstanceId", # required
|
6463
|
+
# quick_connect_id: "QuickConnectId", # required
|
6464
|
+
# name: "QuickConnectName",
|
6465
|
+
# description: "QuickConnectDescription",
|
6466
|
+
# }
|
6467
|
+
#
|
6468
|
+
# @!attribute [rw] instance_id
|
6469
|
+
# The identifier of the Amazon Connect instance.
|
6470
|
+
# @return [String]
|
6471
|
+
#
|
6472
|
+
# @!attribute [rw] quick_connect_id
|
6473
|
+
# The identifier for the quick connect.
|
6474
|
+
# @return [String]
|
6475
|
+
#
|
6476
|
+
# @!attribute [rw] name
|
6477
|
+
# The name of the quick connect.
|
6478
|
+
# @return [String]
|
6479
|
+
#
|
6480
|
+
# @!attribute [rw] description
|
6481
|
+
# The description of the quick connect.
|
6482
|
+
# @return [String]
|
6483
|
+
#
|
6484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectNameRequest AWS API Documentation
|
6485
|
+
#
|
6486
|
+
class UpdateQuickConnectNameRequest < Struct.new(
|
6487
|
+
:instance_id,
|
6488
|
+
:quick_connect_id,
|
6489
|
+
:name,
|
6490
|
+
:description)
|
6491
|
+
SENSITIVE = []
|
6492
|
+
include Aws::Structure
|
6493
|
+
end
|
6494
|
+
|
4962
6495
|
# @note When making an API call, you may pass UpdateRoutingProfileConcurrencyRequest
|
4963
6496
|
# data as a hash:
|
4964
6497
|
#
|
@@ -4967,7 +6500,7 @@ module Aws::Connect
|
|
4967
6500
|
# routing_profile_id: "RoutingProfileId", # required
|
4968
6501
|
# media_concurrencies: [ # required
|
4969
6502
|
# {
|
4970
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
6503
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
4971
6504
|
# concurrency: 1, # required
|
4972
6505
|
# },
|
4973
6506
|
# ],
|
@@ -4982,7 +6515,8 @@ module Aws::Connect
|
|
4982
6515
|
# @return [String]
|
4983
6516
|
#
|
4984
6517
|
# @!attribute [rw] media_concurrencies
|
4985
|
-
# The channels agents can handle in the Contact Control Panel
|
6518
|
+
# The channels that agents can handle in the Contact Control Panel
|
6519
|
+
# (CCP).
|
4986
6520
|
# @return [Array<Types::MediaConcurrency>]
|
4987
6521
|
#
|
4988
6522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrencyRequest AWS API Documentation
|
@@ -5075,7 +6609,7 @@ module Aws::Connect
|
|
5075
6609
|
# {
|
5076
6610
|
# queue_reference: { # required
|
5077
6611
|
# queue_id: "QueueId", # required
|
5078
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
6612
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
5079
6613
|
# },
|
5080
6614
|
# priority: 1, # required
|
5081
6615
|
# delay: 1, # required
|
@@ -5092,7 +6626,9 @@ module Aws::Connect
|
|
5092
6626
|
# @return [String]
|
5093
6627
|
#
|
5094
6628
|
# @!attribute [rw] queue_configs
|
5095
|
-
# The queues to be updated for this routing profile.
|
6629
|
+
# The queues to be updated for this routing profile. Queues must first
|
6630
|
+
# be associated to the routing profile. You can do this using
|
6631
|
+
# AssociateRoutingProfileQueues.
|
5096
6632
|
# @return [Array<Types::RoutingProfileQueueConfig>]
|
5097
6633
|
#
|
5098
6634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueuesRequest AWS API Documentation
|
@@ -5342,6 +6878,32 @@ module Aws::Connect
|
|
5342
6878
|
include Aws::Structure
|
5343
6879
|
end
|
5344
6880
|
|
6881
|
+
# Contains the use case.
|
6882
|
+
#
|
6883
|
+
# @!attribute [rw] use_case_id
|
6884
|
+
# The identifier for the use case.
|
6885
|
+
# @return [String]
|
6886
|
+
#
|
6887
|
+
# @!attribute [rw] use_case_arn
|
6888
|
+
# The Amazon Resource Name (ARN) for the use case.
|
6889
|
+
# @return [String]
|
6890
|
+
#
|
6891
|
+
# @!attribute [rw] use_case_type
|
6892
|
+
# The type of use case to associate to the AppIntegration association.
|
6893
|
+
# Each AppIntegration association can have only one of each use case
|
6894
|
+
# type.
|
6895
|
+
# @return [String]
|
6896
|
+
#
|
6897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UseCase AWS API Documentation
|
6898
|
+
#
|
6899
|
+
class UseCase < Struct.new(
|
6900
|
+
:use_case_id,
|
6901
|
+
:use_case_arn,
|
6902
|
+
:use_case_type)
|
6903
|
+
SENSITIVE = []
|
6904
|
+
include Aws::Structure
|
6905
|
+
end
|
6906
|
+
|
5345
6907
|
# Contains information about a user account for a Amazon Connect
|
5346
6908
|
# instance.
|
5347
6909
|
#
|
@@ -5493,6 +7055,34 @@ module Aws::Connect
|
|
5493
7055
|
include Aws::Structure
|
5494
7056
|
end
|
5495
7057
|
|
7058
|
+
# Contains information about the quick connect configuration settings
|
7059
|
+
# for a user. The contact flow must be of type Transfer to Agent.
|
7060
|
+
#
|
7061
|
+
# @note When making an API call, you may pass UserQuickConnectConfig
|
7062
|
+
# data as a hash:
|
7063
|
+
#
|
7064
|
+
# {
|
7065
|
+
# user_id: "UserId", # required
|
7066
|
+
# contact_flow_id: "ContactFlowId", # required
|
7067
|
+
# }
|
7068
|
+
#
|
7069
|
+
# @!attribute [rw] user_id
|
7070
|
+
# The identifier of the user.
|
7071
|
+
# @return [String]
|
7072
|
+
#
|
7073
|
+
# @!attribute [rw] contact_flow_id
|
7074
|
+
# The identifier of the contact flow.
|
7075
|
+
# @return [String]
|
7076
|
+
#
|
7077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserQuickConnectConfig AWS API Documentation
|
7078
|
+
#
|
7079
|
+
class UserQuickConnectConfig < Struct.new(
|
7080
|
+
:user_id,
|
7081
|
+
:contact_flow_id)
|
7082
|
+
SENSITIVE = []
|
7083
|
+
include Aws::Structure
|
7084
|
+
end
|
7085
|
+
|
5496
7086
|
# Contains summary information about a user.
|
5497
7087
|
#
|
5498
7088
|
# @!attribute [rw] id
|