aws-sdk-connect 1.36.0 → 1.37.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +1 -1
- data/lib/aws-sdk-connect/client.rb +390 -19
- data/lib/aws-sdk-connect/client_api.rb +218 -0
- data/lib/aws-sdk-connect/types.rb +508 -19
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e525b991cc49a110a852fa962640a4894b0cebb0cb9fc8304a5ea21804ad4871
|
4
|
+
data.tar.gz: 01fd4e0da53367ec97384dea727856457eaffed23eced0fa364a00ad42830c18
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 294c20183a8ef8b9ac32d5faf461e7ed5f6396e0a112ab64ff00f4b7d70d2af7b45d3e99e2c0e8ed3f34858aa21f77b33a39571cfc12e773bf99491ca99bb623
|
7
|
+
data.tar.gz: 163f4a3936d0ba613eabc81a2c028649b04b18c6522e5d07fb6cb8479b40d44e6f5e372510a6d689a78bb2b9567579337074796238ca171285945764b68fda63
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -502,7 +502,7 @@ module Aws::Connect
|
|
502
502
|
# {
|
503
503
|
# queue_reference: { # required
|
504
504
|
# queue_id: "QueueId", # required
|
505
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
505
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
506
506
|
# },
|
507
507
|
# priority: 1, # required
|
508
508
|
# delay: 1, # required
|
@@ -616,6 +616,9 @@ module Aws::Connect
|
|
616
616
|
req.send_request(options)
|
617
617
|
end
|
618
618
|
|
619
|
+
# This API is in preview release for Amazon Connect and is subject to
|
620
|
+
# change.
|
621
|
+
#
|
619
622
|
# Initiates an Amazon Connect instance with all the supported channels
|
620
623
|
# enabled. It does not attach any storage (such as Amazon S3, or
|
621
624
|
# Kinesis) or allow for any configurations on features such as Contact
|
@@ -669,6 +672,59 @@ module Aws::Connect
|
|
669
672
|
req.send_request(options)
|
670
673
|
end
|
671
674
|
|
675
|
+
# This API is in preview release for Amazon Connect and is subject to
|
676
|
+
# change.
|
677
|
+
#
|
678
|
+
# Create an AppIntegration association with anAmazon Connect instance.
|
679
|
+
#
|
680
|
+
# @option params [required, String] :instance_id
|
681
|
+
# The identifier of the Amazon Connect instance.
|
682
|
+
#
|
683
|
+
# @option params [required, String] :integration_type
|
684
|
+
# The type of information to be ingested.
|
685
|
+
#
|
686
|
+
# @option params [required, String] :integration_arn
|
687
|
+
# The Amazon Resource Name (ARN) of the integration.
|
688
|
+
#
|
689
|
+
# @option params [required, String] :source_application_url
|
690
|
+
# The URL for the external application.
|
691
|
+
#
|
692
|
+
# @option params [required, String] :source_application_name
|
693
|
+
# The name of the external application.
|
694
|
+
#
|
695
|
+
# @option params [required, String] :source_type
|
696
|
+
# The type of the data source.
|
697
|
+
#
|
698
|
+
# @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
699
|
+
#
|
700
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_id #integration_association_id} => String
|
701
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_arn #integration_association_arn} => String
|
702
|
+
#
|
703
|
+
# @example Request syntax with placeholder values
|
704
|
+
#
|
705
|
+
# resp = client.create_integration_association({
|
706
|
+
# instance_id: "InstanceId", # required
|
707
|
+
# integration_type: "EVENT", # required, accepts EVENT
|
708
|
+
# integration_arn: "ARN", # required
|
709
|
+
# source_application_url: "URI", # required
|
710
|
+
# source_application_name: "SourceApplicationName", # required
|
711
|
+
# source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK
|
712
|
+
# })
|
713
|
+
#
|
714
|
+
# @example Response structure
|
715
|
+
#
|
716
|
+
# resp.integration_association_id #=> String
|
717
|
+
# resp.integration_association_arn #=> String
|
718
|
+
#
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociation AWS API Documentation
|
720
|
+
#
|
721
|
+
# @overload create_integration_association(params = {})
|
722
|
+
# @param [Hash] params ({})
|
723
|
+
def create_integration_association(params = {}, options = {})
|
724
|
+
req = build_request(:create_integration_association, params)
|
725
|
+
req.send_request(options)
|
726
|
+
end
|
727
|
+
|
672
728
|
# Creates a new routing profile.
|
673
729
|
#
|
674
730
|
# @option params [required, String] :instance_id
|
@@ -711,7 +767,7 @@ module Aws::Connect
|
|
711
767
|
# {
|
712
768
|
# queue_reference: { # required
|
713
769
|
# queue_id: "QueueId", # required
|
714
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
770
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
715
771
|
# },
|
716
772
|
# priority: 1, # required
|
717
773
|
# delay: 1, # required
|
@@ -719,7 +775,7 @@ module Aws::Connect
|
|
719
775
|
# ],
|
720
776
|
# media_concurrencies: [ # required
|
721
777
|
# {
|
722
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
778
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
723
779
|
# concurrency: 1, # required
|
724
780
|
# },
|
725
781
|
# ],
|
@@ -742,6 +798,49 @@ module Aws::Connect
|
|
742
798
|
req.send_request(options)
|
743
799
|
end
|
744
800
|
|
801
|
+
# This API is in preview release for Amazon Connect and is subject to
|
802
|
+
# change.
|
803
|
+
#
|
804
|
+
# Creates a use case for an AppIntegration association.
|
805
|
+
#
|
806
|
+
# @option params [required, String] :instance_id
|
807
|
+
# The identifier of the Amazon Connect instance.
|
808
|
+
#
|
809
|
+
# @option params [required, String] :integration_association_id
|
810
|
+
# The identifier for the AppIntegration association.
|
811
|
+
#
|
812
|
+
# @option params [required, String] :use_case_type
|
813
|
+
# The type of use case to associate to the AppIntegration association.
|
814
|
+
# Each AppIntegration association can have only one of each use case
|
815
|
+
# type.
|
816
|
+
#
|
817
|
+
# @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
818
|
+
#
|
819
|
+
# * {Types::CreateUseCaseResponse#use_case_id #use_case_id} => String
|
820
|
+
# * {Types::CreateUseCaseResponse#use_case_arn #use_case_arn} => String
|
821
|
+
#
|
822
|
+
# @example Request syntax with placeholder values
|
823
|
+
#
|
824
|
+
# resp = client.create_use_case({
|
825
|
+
# instance_id: "InstanceId", # required
|
826
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
827
|
+
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
|
828
|
+
# })
|
829
|
+
#
|
830
|
+
# @example Response structure
|
831
|
+
#
|
832
|
+
# resp.use_case_id #=> String
|
833
|
+
# resp.use_case_arn #=> String
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCase AWS API Documentation
|
836
|
+
#
|
837
|
+
# @overload create_use_case(params = {})
|
838
|
+
# @param [Hash] params ({})
|
839
|
+
def create_use_case(params = {}, options = {})
|
840
|
+
req = build_request(:create_use_case, params)
|
841
|
+
req.send_request(options)
|
842
|
+
end
|
843
|
+
|
745
844
|
# Creates a user account for the specified Amazon Connect instance.
|
746
845
|
#
|
747
846
|
# For information about how to create user accounts using the Amazon
|
@@ -882,6 +981,9 @@ module Aws::Connect
|
|
882
981
|
req.send_request(options)
|
883
982
|
end
|
884
983
|
|
984
|
+
# This API is in preview release for Amazon Connect and is subject to
|
985
|
+
# change.
|
986
|
+
#
|
885
987
|
# Deletes the Amazon Connect instance.
|
886
988
|
#
|
887
989
|
# @option params [required, String] :instance_id
|
@@ -904,6 +1006,69 @@ module Aws::Connect
|
|
904
1006
|
req.send_request(options)
|
905
1007
|
end
|
906
1008
|
|
1009
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1010
|
+
# change.
|
1011
|
+
#
|
1012
|
+
# Deletes an AppIntegration association from an Amazon Connect instance.
|
1013
|
+
# The association must not have any use cases associated with it.
|
1014
|
+
#
|
1015
|
+
# @option params [required, String] :instance_id
|
1016
|
+
# The identifier of the Amazon Connect instance.
|
1017
|
+
#
|
1018
|
+
# @option params [required, String] :integration_association_id
|
1019
|
+
# The identifier for the AppIntegration association.
|
1020
|
+
#
|
1021
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1022
|
+
#
|
1023
|
+
# @example Request syntax with placeholder values
|
1024
|
+
#
|
1025
|
+
# resp = client.delete_integration_association({
|
1026
|
+
# instance_id: "InstanceId", # required
|
1027
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1028
|
+
# })
|
1029
|
+
#
|
1030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociation AWS API Documentation
|
1031
|
+
#
|
1032
|
+
# @overload delete_integration_association(params = {})
|
1033
|
+
# @param [Hash] params ({})
|
1034
|
+
def delete_integration_association(params = {}, options = {})
|
1035
|
+
req = build_request(:delete_integration_association, params)
|
1036
|
+
req.send_request(options)
|
1037
|
+
end
|
1038
|
+
|
1039
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1040
|
+
# change.
|
1041
|
+
#
|
1042
|
+
# Deletes a use case from an AppIntegration association.
|
1043
|
+
#
|
1044
|
+
# @option params [required, String] :instance_id
|
1045
|
+
# The identifier of the Amazon Connect instance.
|
1046
|
+
#
|
1047
|
+
# @option params [required, String] :integration_association_id
|
1048
|
+
# The identifier for the AppIntegration association.
|
1049
|
+
#
|
1050
|
+
# @option params [required, String] :use_case_id
|
1051
|
+
# The identifier for the use case.
|
1052
|
+
#
|
1053
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1054
|
+
#
|
1055
|
+
# @example Request syntax with placeholder values
|
1056
|
+
#
|
1057
|
+
# resp = client.delete_use_case({
|
1058
|
+
# instance_id: "InstanceId", # required
|
1059
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1060
|
+
# use_case_id: "UseCaseId", # required
|
1061
|
+
# })
|
1062
|
+
#
|
1063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUseCase AWS API Documentation
|
1064
|
+
#
|
1065
|
+
# @overload delete_use_case(params = {})
|
1066
|
+
# @param [Hash] params ({})
|
1067
|
+
def delete_use_case(params = {}, options = {})
|
1068
|
+
req = build_request(:delete_use_case, params)
|
1069
|
+
req.send_request(options)
|
1070
|
+
end
|
1071
|
+
|
907
1072
|
# Deletes a user account from the specified Amazon Connect instance.
|
908
1073
|
#
|
909
1074
|
# For information about what happens to a user's data when their
|
@@ -1164,7 +1329,7 @@ module Aws::Connect
|
|
1164
1329
|
# resp.routing_profile.routing_profile_id #=> String
|
1165
1330
|
# resp.routing_profile.description #=> String
|
1166
1331
|
# resp.routing_profile.media_concurrencies #=> Array
|
1167
|
-
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT"
|
1332
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1168
1333
|
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
1169
1334
|
# resp.routing_profile.default_outbound_queue_id #=> String
|
1170
1335
|
# resp.routing_profile.tags #=> Hash
|
@@ -1461,7 +1626,7 @@ module Aws::Connect
|
|
1461
1626
|
# queue_references: [ # required
|
1462
1627
|
# {
|
1463
1628
|
# queue_id: "QueueId", # required
|
1464
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
1629
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
1465
1630
|
# },
|
1466
1631
|
# ],
|
1467
1632
|
# })
|
@@ -1552,14 +1717,14 @@ module Aws::Connect
|
|
1552
1717
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1553
1718
|
# returned. Metric data is retrieved only for the resources associated
|
1554
1719
|
# with the queues or channels included in the filter. You can include
|
1555
|
-
# both queue IDs and queue ARNs in the same request.
|
1556
|
-
#
|
1720
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
1721
|
+
# TASK channels are supported.
|
1557
1722
|
#
|
1558
1723
|
# @option params [Array<String>] :groupings
|
1559
1724
|
# The grouping applied to the metrics returned. For example, when
|
1560
1725
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
1561
1726
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
1562
|
-
# include a Channels filter.
|
1727
|
+
# include a Channels filter. VOICE, CHAT, and TASK channels are
|
1563
1728
|
# supported.
|
1564
1729
|
#
|
1565
1730
|
# If no `Grouping` is included in the request, a summary of metrics is
|
@@ -1699,7 +1864,7 @@ module Aws::Connect
|
|
1699
1864
|
# instance_id: "InstanceId", # required
|
1700
1865
|
# filters: { # required
|
1701
1866
|
# queues: ["QueueId"],
|
1702
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
1867
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1703
1868
|
# },
|
1704
1869
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1705
1870
|
# current_metrics: [ # required
|
@@ -1718,7 +1883,7 @@ module Aws::Connect
|
|
1718
1883
|
# resp.metric_results #=> Array
|
1719
1884
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
1720
1885
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
1721
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
1886
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1722
1887
|
# resp.metric_results[0].collections #=> Array
|
1723
1888
|
# 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
1889
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
@@ -1800,8 +1965,8 @@ module Aws::Connect
|
|
1800
1965
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1801
1966
|
# returned. Metric data is retrieved only for the resources associated
|
1802
1967
|
# with the queues or channels included in the filter. You can include
|
1803
|
-
# both queue IDs and queue ARNs in the same request.
|
1804
|
-
#
|
1968
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
1969
|
+
# TASK channels are supported.
|
1805
1970
|
#
|
1806
1971
|
# @option params [Array<String>] :groupings
|
1807
1972
|
# The grouping applied to the metrics returned. For example, when
|
@@ -2001,7 +2166,7 @@ module Aws::Connect
|
|
2001
2166
|
# end_time: Time.now, # required
|
2002
2167
|
# filters: { # required
|
2003
2168
|
# queues: ["QueueId"],
|
2004
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2169
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2005
2170
|
# },
|
2006
2171
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2007
2172
|
# historical_metrics: [ # required
|
@@ -2025,7 +2190,7 @@ module Aws::Connect
|
|
2025
2190
|
# resp.metric_results #=> Array
|
2026
2191
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
2027
2192
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
2028
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
2193
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2029
2194
|
# resp.metric_results[0].collections #=> Array
|
2030
2195
|
# 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
2196
|
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
@@ -2202,6 +2367,9 @@ module Aws::Connect
|
|
2202
2367
|
req.send_request(options)
|
2203
2368
|
end
|
2204
2369
|
|
2370
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2371
|
+
# change.
|
2372
|
+
#
|
2205
2373
|
# Returns a paginated list of all attribute types for the given
|
2206
2374
|
# instance.
|
2207
2375
|
#
|
@@ -2247,6 +2415,9 @@ module Aws::Connect
|
|
2247
2415
|
req.send_request(options)
|
2248
2416
|
end
|
2249
2417
|
|
2418
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2419
|
+
# change.
|
2420
|
+
#
|
2250
2421
|
# Returns a paginated list of storage configs for the identified
|
2251
2422
|
# instance and resource type.
|
2252
2423
|
#
|
@@ -2306,6 +2477,9 @@ module Aws::Connect
|
|
2306
2477
|
req.send_request(options)
|
2307
2478
|
end
|
2308
2479
|
|
2480
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2481
|
+
# change.
|
2482
|
+
#
|
2309
2483
|
# Return a list of instances which are in active state,
|
2310
2484
|
# creation-in-progress state, and failed state. Instances that aren't
|
2311
2485
|
# successfully created (they are in a failed state) are returned only
|
@@ -2356,6 +2530,60 @@ module Aws::Connect
|
|
2356
2530
|
req.send_request(options)
|
2357
2531
|
end
|
2358
2532
|
|
2533
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2534
|
+
# change.
|
2535
|
+
#
|
2536
|
+
# Provides summary information about the AppIntegration associations for
|
2537
|
+
# the specified Amazon Connect instance.
|
2538
|
+
#
|
2539
|
+
# @option params [required, String] :instance_id
|
2540
|
+
# The identifier of the Amazon Connect instance.
|
2541
|
+
#
|
2542
|
+
# @option params [String] :next_token
|
2543
|
+
# The token for the next set of results. Use the value returned in the
|
2544
|
+
# previous response in the next request to retrieve the next set of
|
2545
|
+
# results.
|
2546
|
+
#
|
2547
|
+
# @option params [Integer] :max_results
|
2548
|
+
# The maximimum number of results to return per page.
|
2549
|
+
#
|
2550
|
+
# @return [Types::ListIntegrationAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2551
|
+
#
|
2552
|
+
# * {Types::ListIntegrationAssociationsResponse#integration_association_summary_list #integration_association_summary_list} => Array<Types::IntegrationAssociationSummary>
|
2553
|
+
# * {Types::ListIntegrationAssociationsResponse#next_token #next_token} => String
|
2554
|
+
#
|
2555
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2556
|
+
#
|
2557
|
+
# @example Request syntax with placeholder values
|
2558
|
+
#
|
2559
|
+
# resp = client.list_integration_associations({
|
2560
|
+
# instance_id: "InstanceId", # required
|
2561
|
+
# next_token: "NextToken",
|
2562
|
+
# max_results: 1,
|
2563
|
+
# })
|
2564
|
+
#
|
2565
|
+
# @example Response structure
|
2566
|
+
#
|
2567
|
+
# resp.integration_association_summary_list #=> Array
|
2568
|
+
# resp.integration_association_summary_list[0].integration_association_id #=> String
|
2569
|
+
# resp.integration_association_summary_list[0].integration_association_arn #=> String
|
2570
|
+
# resp.integration_association_summary_list[0].instance_id #=> String
|
2571
|
+
# resp.integration_association_summary_list[0].integration_type #=> String, one of "EVENT"
|
2572
|
+
# resp.integration_association_summary_list[0].integration_arn #=> String
|
2573
|
+
# resp.integration_association_summary_list[0].source_application_url #=> String
|
2574
|
+
# resp.integration_association_summary_list[0].source_application_name #=> String
|
2575
|
+
# resp.integration_association_summary_list[0].source_type #=> String, one of "SALESFORCE", "ZENDESK"
|
2576
|
+
# resp.next_token #=> String
|
2577
|
+
#
|
2578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociations AWS API Documentation
|
2579
|
+
#
|
2580
|
+
# @overload list_integration_associations(params = {})
|
2581
|
+
# @param [Hash] params ({})
|
2582
|
+
def list_integration_associations(params = {}, options = {})
|
2583
|
+
req = build_request(:list_integration_associations, params)
|
2584
|
+
req.send_request(options)
|
2585
|
+
end
|
2586
|
+
|
2359
2587
|
# Returns a paginated list of all the Lambda functions that show up in
|
2360
2588
|
# the drop-down options in the relevant contact flow blocks.
|
2361
2589
|
#
|
@@ -2654,7 +2882,7 @@ module Aws::Connect
|
|
2654
2882
|
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
2655
2883
|
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
2656
2884
|
# 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"
|
2885
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2658
2886
|
#
|
2659
2887
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
2660
2888
|
#
|
@@ -2855,6 +3083,58 @@ module Aws::Connect
|
|
2855
3083
|
req.send_request(options)
|
2856
3084
|
end
|
2857
3085
|
|
3086
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3087
|
+
# change.
|
3088
|
+
#
|
3089
|
+
# List the use cases.
|
3090
|
+
#
|
3091
|
+
# @option params [required, String] :instance_id
|
3092
|
+
# The identifier of the Amazon Connect instance.
|
3093
|
+
#
|
3094
|
+
# @option params [required, String] :integration_association_id
|
3095
|
+
# The identifier for the integration association.
|
3096
|
+
#
|
3097
|
+
# @option params [String] :next_token
|
3098
|
+
# The token for the next set of results. Use the value returned in the
|
3099
|
+
# previous response in the next request to retrieve the next set of
|
3100
|
+
# results.
|
3101
|
+
#
|
3102
|
+
# @option params [Integer] :max_results
|
3103
|
+
# The maximimum number of results to return per page.
|
3104
|
+
#
|
3105
|
+
# @return [Types::ListUseCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3106
|
+
#
|
3107
|
+
# * {Types::ListUseCasesResponse#use_case_summary_list #use_case_summary_list} => Array<Types::UseCase>
|
3108
|
+
# * {Types::ListUseCasesResponse#next_token #next_token} => String
|
3109
|
+
#
|
3110
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3111
|
+
#
|
3112
|
+
# @example Request syntax with placeholder values
|
3113
|
+
#
|
3114
|
+
# resp = client.list_use_cases({
|
3115
|
+
# instance_id: "InstanceId", # required
|
3116
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
3117
|
+
# next_token: "NextToken",
|
3118
|
+
# max_results: 1,
|
3119
|
+
# })
|
3120
|
+
#
|
3121
|
+
# @example Response structure
|
3122
|
+
#
|
3123
|
+
# resp.use_case_summary_list #=> Array
|
3124
|
+
# resp.use_case_summary_list[0].use_case_id #=> String
|
3125
|
+
# resp.use_case_summary_list[0].use_case_arn #=> String
|
3126
|
+
# resp.use_case_summary_list[0].use_case_type #=> String, one of "RULES_EVALUATION"
|
3127
|
+
# resp.next_token #=> String
|
3128
|
+
#
|
3129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCases AWS API Documentation
|
3130
|
+
#
|
3131
|
+
# @overload list_use_cases(params = {})
|
3132
|
+
# @param [Hash] params ({})
|
3133
|
+
def list_use_cases(params = {}, options = {})
|
3134
|
+
req = build_request(:list_use_cases, params)
|
3135
|
+
req.send_request(options)
|
3136
|
+
end
|
3137
|
+
|
2858
3138
|
# Provides summary information about the hierarchy groups for the
|
2859
3139
|
# specified Amazon Connect instance.
|
2860
3140
|
#
|
@@ -3241,6 +3521,89 @@ module Aws::Connect
|
|
3241
3521
|
req.send_request(options)
|
3242
3522
|
end
|
3243
3523
|
|
3524
|
+
# Initiates a contact flow to start a new task.
|
3525
|
+
#
|
3526
|
+
# @option params [required, String] :instance_id
|
3527
|
+
# The identifier of the Amazon Connect instance.
|
3528
|
+
#
|
3529
|
+
# @option params [String] :previous_contact_id
|
3530
|
+
# The identifier of the previous chat, voice, or task contact.
|
3531
|
+
#
|
3532
|
+
# @option params [required, String] :contact_flow_id
|
3533
|
+
# The identifier of the contact flow for initiating the tasks. To see
|
3534
|
+
# the ContactFlowId in the Amazon Connect console user interface, on the
|
3535
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
3536
|
+
# contact flow. On the contact flow page, under the name of the contact
|
3537
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
3538
|
+
# is the last part of the ARN, shown here in bold:
|
3539
|
+
#
|
3540
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
3541
|
+
#
|
3542
|
+
# @option params [Hash<String,String>] :attributes
|
3543
|
+
# A custom key-value pair using an attribute map. The attributes are
|
3544
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
3545
|
+
# flows just like any other contact attributes.
|
3546
|
+
#
|
3547
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
3548
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
3549
|
+
# underscore characters.
|
3550
|
+
#
|
3551
|
+
# @option params [required, String] :name
|
3552
|
+
# The name of a task that is shown to an agent in the Contact Control
|
3553
|
+
# Panel (CCP).
|
3554
|
+
#
|
3555
|
+
# @option params [Hash<String,Types::Reference>] :references
|
3556
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
3557
|
+
# (CCP).
|
3558
|
+
#
|
3559
|
+
# @option params [String] :description
|
3560
|
+
# A description of the task that is shown to an agent in the Contact
|
3561
|
+
# Control Panel (CCP).
|
3562
|
+
#
|
3563
|
+
# @option params [String] :client_token
|
3564
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
3565
|
+
# idempotency of the request.
|
3566
|
+
#
|
3567
|
+
# **A suitable default value is auto-generated.** You should normally
|
3568
|
+
# not need to pass this option.**
|
3569
|
+
#
|
3570
|
+
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3571
|
+
#
|
3572
|
+
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
3573
|
+
#
|
3574
|
+
# @example Request syntax with placeholder values
|
3575
|
+
#
|
3576
|
+
# resp = client.start_task_contact({
|
3577
|
+
# instance_id: "InstanceId", # required
|
3578
|
+
# previous_contact_id: "ContactId",
|
3579
|
+
# contact_flow_id: "ContactFlowId", # required
|
3580
|
+
# attributes: {
|
3581
|
+
# "AttributeName" => "AttributeValue",
|
3582
|
+
# },
|
3583
|
+
# name: "Name", # required
|
3584
|
+
# references: {
|
3585
|
+
# "ReferenceKey" => {
|
3586
|
+
# value: "ReferenceValue", # required
|
3587
|
+
# type: "URL", # required, accepts URL
|
3588
|
+
# },
|
3589
|
+
# },
|
3590
|
+
# description: "Description",
|
3591
|
+
# client_token: "ClientToken",
|
3592
|
+
# })
|
3593
|
+
#
|
3594
|
+
# @example Response structure
|
3595
|
+
#
|
3596
|
+
# resp.contact_id #=> String
|
3597
|
+
#
|
3598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContact AWS API Documentation
|
3599
|
+
#
|
3600
|
+
# @overload start_task_contact(params = {})
|
3601
|
+
# @param [Hash] params ({})
|
3602
|
+
def start_task_contact(params = {}, options = {})
|
3603
|
+
req = build_request(:start_task_contact, params)
|
3604
|
+
req.send_request(options)
|
3605
|
+
end
|
3606
|
+
|
3244
3607
|
# Ends the specified contact.
|
3245
3608
|
#
|
3246
3609
|
# @option params [required, String] :contact_id
|
@@ -3554,6 +3917,9 @@ module Aws::Connect
|
|
3554
3917
|
req.send_request(options)
|
3555
3918
|
end
|
3556
3919
|
|
3920
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3921
|
+
# change.
|
3922
|
+
#
|
3557
3923
|
# Updates the value for the specified attribute type.
|
3558
3924
|
#
|
3559
3925
|
# @option params [required, String] :instance_id
|
@@ -3584,6 +3950,9 @@ module Aws::Connect
|
|
3584
3950
|
req.send_request(options)
|
3585
3951
|
end
|
3586
3952
|
|
3953
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3954
|
+
# change.
|
3955
|
+
#
|
3587
3956
|
# Updates an existing configuration for a resource type. This API is
|
3588
3957
|
# idempotent.
|
3589
3958
|
#
|
@@ -3666,7 +4035,7 @@ module Aws::Connect
|
|
3666
4035
|
# routing_profile_id: "RoutingProfileId", # required
|
3667
4036
|
# media_concurrencies: [ # required
|
3668
4037
|
# {
|
3669
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4038
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
3670
4039
|
# concurrency: 1, # required
|
3671
4040
|
# },
|
3672
4041
|
# ],
|
@@ -3758,7 +4127,9 @@ module Aws::Connect
|
|
3758
4127
|
# The identifier of the routing profile.
|
3759
4128
|
#
|
3760
4129
|
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
3761
|
-
# The queues to be updated for this routing profile.
|
4130
|
+
# The queues to be updated for this routing profile. Queues must first
|
4131
|
+
# be associated to the routing profile. You can do this using
|
4132
|
+
# AssociateRoutingProfileQueues.
|
3762
4133
|
#
|
3763
4134
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3764
4135
|
#
|
@@ -3771,7 +4142,7 @@ module Aws::Connect
|
|
3771
4142
|
# {
|
3772
4143
|
# queue_reference: { # required
|
3773
4144
|
# queue_id: "QueueId", # required
|
3774
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4145
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
3775
4146
|
# },
|
3776
4147
|
# priority: 1, # required
|
3777
4148
|
# delay: 1, # required
|
@@ -4046,7 +4417,7 @@ module Aws::Connect
|
|
4046
4417
|
params: params,
|
4047
4418
|
config: config)
|
4048
4419
|
context[:gem_name] = 'aws-sdk-connect'
|
4049
|
-
context[:gem_version] = '1.
|
4420
|
+
context[:gem_version] = '1.37.0'
|
4050
4421
|
Seahorse::Client::Request.new(handlers, context)
|
4051
4422
|
end
|
4052
4423
|
|