aws-sdk-connect 1.57.0 → 1.61.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +374 -23
- data/lib/aws-sdk-connect/client_api.rb +239 -0
- data/lib/aws-sdk-connect/errors.rb +32 -0
- data/lib/aws-sdk-connect/types.rb +522 -22
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fae4a2028fbcf29afdeb6838dfaf63f8b417c8aaa352b06b9c3f9d7744321df1
|
4
|
+
data.tar.gz: 28a4b6449e79f29ed85a6b0116d51be6129fcafaaa8d60405a47ef59e8531ac4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e7fbaa8a393d9cc5122a2ecd08453f6f974cab91bbbd4d44844ae0eaf823f971a3a9931c53b2e1b8fd73bec9b01d7a5cc1174f86c59fbf96e877099684358e16
|
7
|
+
data.tar.gz: 536a083620623579c31279b587a29dca939959c77a4b8f3be691bce56f1eb06e57a89c74a4d3d758b964d9177db2f428de2e564b7a50a1d91c66f23997471d5a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.61.0 (2022-01-20)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds tagging support for UserHierarchyGroups resource.
|
8
|
+
|
9
|
+
1.60.0 (2021-12-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.59.0 (2021-11-30)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.58.0 (2021-11-22)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - This release adds support for UpdateContactFlowMetadata, DeleteContactFlow and module APIs. For details, see the Release Notes in the Amazon Connect Administrator Guide.
|
23
|
+
|
4
24
|
1.57.0 (2021-11-12)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.61.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::Connect
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::Connect
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::Connect
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -295,7 +303,7 @@ module Aws::Connect
|
|
295
303
|
# seconds to wait when opening a HTTP session before raising a
|
296
304
|
# `Timeout::Error`.
|
297
305
|
#
|
298
|
-
# @option options [
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
299
307
|
# number of seconds to wait for response data. This value can
|
300
308
|
# safely be set per-request on the session.
|
301
309
|
#
|
@@ -311,6 +319,9 @@ module Aws::Connect
|
|
311
319
|
# disables this behaviour. This value can safely be set per
|
312
320
|
# request on the session.
|
313
321
|
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
314
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
315
326
|
# HTTP debug output will be sent to the `:logger`.
|
316
327
|
#
|
@@ -677,7 +688,7 @@ module Aws::Connect
|
|
677
688
|
# The display order of the status.
|
678
689
|
#
|
679
690
|
# @option params [Hash<String,String>] :tags
|
680
|
-
#
|
691
|
+
# The tags used to organize, track, or control access for this resource.
|
681
692
|
#
|
682
693
|
# @return [Types::CreateAgentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
683
694
|
#
|
@@ -776,6 +787,67 @@ module Aws::Connect
|
|
776
787
|
req.send_request(options)
|
777
788
|
end
|
778
789
|
|
790
|
+
# Creates a contact flow module for the specified Amazon Connect
|
791
|
+
# instance.
|
792
|
+
#
|
793
|
+
# @option params [required, String] :instance_id
|
794
|
+
# The identifier of the Amazon Connect instance. You can find the
|
795
|
+
# instanceId in the ARN of the instance.
|
796
|
+
#
|
797
|
+
# @option params [required, String] :name
|
798
|
+
# The name of the contact flow module.
|
799
|
+
#
|
800
|
+
# @option params [String] :description
|
801
|
+
# The description of the contact flow module.
|
802
|
+
#
|
803
|
+
# @option params [required, String] :content
|
804
|
+
# The content of the contact flow module.
|
805
|
+
#
|
806
|
+
# @option params [Hash<String,String>] :tags
|
807
|
+
# The tags used to organize, track, or control access for this resource.
|
808
|
+
#
|
809
|
+
# @option params [String] :client_token
|
810
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
811
|
+
# idempotency of the request.
|
812
|
+
#
|
813
|
+
# **A suitable default value is auto-generated.** You should normally
|
814
|
+
# not need to pass this option.**
|
815
|
+
#
|
816
|
+
# @return [Types::CreateContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
817
|
+
#
|
818
|
+
# * {Types::CreateContactFlowModuleResponse#id #id} => String
|
819
|
+
# * {Types::CreateContactFlowModuleResponse#arn #arn} => String
|
820
|
+
#
|
821
|
+
# @example Request syntax with placeholder values
|
822
|
+
#
|
823
|
+
# resp = client.create_contact_flow_module({
|
824
|
+
# instance_id: "InstanceId", # required
|
825
|
+
# name: "ContactFlowModuleName", # required
|
826
|
+
# description: "ContactFlowModuleDescription",
|
827
|
+
# content: "ContactFlowModuleContent", # required
|
828
|
+
# tags: {
|
829
|
+
# "TagKey" => "TagValue",
|
830
|
+
# },
|
831
|
+
# client_token: "ClientToken",
|
832
|
+
# })
|
833
|
+
#
|
834
|
+
# @example Response structure
|
835
|
+
#
|
836
|
+
# resp.id #=> String
|
837
|
+
# resp.arn #=> String
|
838
|
+
#
|
839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowModule AWS API Documentation
|
840
|
+
#
|
841
|
+
# @overload create_contact_flow_module(params = {})
|
842
|
+
# @param [Hash] params ({})
|
843
|
+
def create_contact_flow_module(params = {}, options = {})
|
844
|
+
req = build_request(:create_contact_flow_module, params)
|
845
|
+
req.send_request(options)
|
846
|
+
end
|
847
|
+
|
848
|
+
# This API is in preview release for Amazon Connect and is subject to
|
849
|
+
# change.
|
850
|
+
#
|
779
851
|
# Creates hours of operation.
|
780
852
|
#
|
781
853
|
# @option params [required, String] :instance_id
|
@@ -796,7 +868,7 @@ module Aws::Connect
|
|
796
868
|
# and end time.
|
797
869
|
#
|
798
870
|
# @option params [Hash<String,String>] :tags
|
799
|
-
#
|
871
|
+
# The tags used to organize, track, or control access for this resource.
|
800
872
|
#
|
801
873
|
# @return [Types::CreateHoursOfOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
802
874
|
#
|
@@ -905,7 +977,8 @@ module Aws::Connect
|
|
905
977
|
req.send_request(options)
|
906
978
|
end
|
907
979
|
|
908
|
-
# Creates an
|
980
|
+
# Creates an Amazon Web Services resource association with an Amazon
|
981
|
+
# Connect instance.
|
909
982
|
#
|
910
983
|
# @option params [required, String] :instance_id
|
911
984
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -930,7 +1003,7 @@ module Aws::Connect
|
|
930
1003
|
# integration type.
|
931
1004
|
#
|
932
1005
|
# @option params [Hash<String,String>] :tags
|
933
|
-
#
|
1006
|
+
# The tags used to organize, track, or control access for this resource.
|
934
1007
|
#
|
935
1008
|
# @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
1009
|
#
|
@@ -994,7 +1067,7 @@ module Aws::Connect
|
|
994
1067
|
# The quick connects available to agents who are working the queue.
|
995
1068
|
#
|
996
1069
|
# @option params [Hash<String,String>] :tags
|
997
|
-
#
|
1070
|
+
# The tags used to organize, track, or control access for this resource.
|
998
1071
|
#
|
999
1072
|
# @return [Types::CreateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1000
1073
|
#
|
@@ -1050,7 +1123,7 @@ module Aws::Connect
|
|
1050
1123
|
# Configuration settings for the quick connect.
|
1051
1124
|
#
|
1052
1125
|
# @option params [Hash<String,String>] :tags
|
1053
|
-
#
|
1126
|
+
# The tags used to organize, track, or control access for this resource.
|
1054
1127
|
#
|
1055
1128
|
# @return [Types::CreateQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1056
1129
|
#
|
@@ -1189,7 +1262,7 @@ module Aws::Connect
|
|
1189
1262
|
# instanceId in the ARN of the instance.
|
1190
1263
|
#
|
1191
1264
|
# @option params [Hash<String,String>] :tags
|
1192
|
-
#
|
1265
|
+
# The tags used to organize, track, or control access for this resource.
|
1193
1266
|
#
|
1194
1267
|
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1195
1268
|
#
|
@@ -1236,7 +1309,7 @@ module Aws::Connect
|
|
1236
1309
|
# integration association can have only one of each use case type.
|
1237
1310
|
#
|
1238
1311
|
# @option params [Hash<String,String>] :tags
|
1239
|
-
#
|
1312
|
+
# The tags used to organize, track, or control access for this resource.
|
1240
1313
|
#
|
1241
1314
|
# @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1242
1315
|
#
|
@@ -1383,6 +1456,9 @@ module Aws::Connect
|
|
1383
1456
|
# The identifier of the Amazon Connect instance. You can find the
|
1384
1457
|
# instanceId in the ARN of the instance.
|
1385
1458
|
#
|
1459
|
+
# @option params [Hash<String,String>] :tags
|
1460
|
+
# The tags used to organize, track, or control access for this resource.
|
1461
|
+
#
|
1386
1462
|
# @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1387
1463
|
#
|
1388
1464
|
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_id #hierarchy_group_id} => String
|
@@ -1394,6 +1470,9 @@ module Aws::Connect
|
|
1394
1470
|
# name: "HierarchyGroupName", # required
|
1395
1471
|
# parent_group_id: "HierarchyGroupId",
|
1396
1472
|
# instance_id: "InstanceId", # required
|
1473
|
+
# tags: {
|
1474
|
+
# "TagKey" => "TagValue",
|
1475
|
+
# },
|
1397
1476
|
# })
|
1398
1477
|
#
|
1399
1478
|
# @example Response structure
|
@@ -1410,6 +1489,63 @@ module Aws::Connect
|
|
1410
1489
|
req.send_request(options)
|
1411
1490
|
end
|
1412
1491
|
|
1492
|
+
# Deletes a contact flow for the specified Amazon Connect instance.
|
1493
|
+
#
|
1494
|
+
# @option params [required, String] :instance_id
|
1495
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1496
|
+
# instanceId in the ARN of the instance.
|
1497
|
+
#
|
1498
|
+
# @option params [required, String] :contact_flow_id
|
1499
|
+
# The identifier of the contact flow.
|
1500
|
+
#
|
1501
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1502
|
+
#
|
1503
|
+
# @example Request syntax with placeholder values
|
1504
|
+
#
|
1505
|
+
# resp = client.delete_contact_flow({
|
1506
|
+
# instance_id: "InstanceId", # required
|
1507
|
+
# contact_flow_id: "ContactFlowId", # required
|
1508
|
+
# })
|
1509
|
+
#
|
1510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlow AWS API Documentation
|
1511
|
+
#
|
1512
|
+
# @overload delete_contact_flow(params = {})
|
1513
|
+
# @param [Hash] params ({})
|
1514
|
+
def delete_contact_flow(params = {}, options = {})
|
1515
|
+
req = build_request(:delete_contact_flow, params)
|
1516
|
+
req.send_request(options)
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# Deletes the specified contact flow module.
|
1520
|
+
#
|
1521
|
+
# @option params [required, String] :instance_id
|
1522
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1523
|
+
# instanceId in the ARN of the instance.
|
1524
|
+
#
|
1525
|
+
# @option params [required, String] :contact_flow_module_id
|
1526
|
+
# The identifier of the contact flow module.
|
1527
|
+
#
|
1528
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1529
|
+
#
|
1530
|
+
# @example Request syntax with placeholder values
|
1531
|
+
#
|
1532
|
+
# resp = client.delete_contact_flow_module({
|
1533
|
+
# instance_id: "InstanceId", # required
|
1534
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
1535
|
+
# })
|
1536
|
+
#
|
1537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowModule AWS API Documentation
|
1538
|
+
#
|
1539
|
+
# @overload delete_contact_flow_module(params = {})
|
1540
|
+
# @param [Hash] params ({})
|
1541
|
+
def delete_contact_flow_module(params = {}, options = {})
|
1542
|
+
req = build_request(:delete_contact_flow_module, params)
|
1543
|
+
req.send_request(options)
|
1544
|
+
end
|
1545
|
+
|
1546
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1547
|
+
# change.
|
1548
|
+
#
|
1413
1549
|
# Deletes an hours of operation.
|
1414
1550
|
#
|
1415
1551
|
# @option params [required, String] :instance_id
|
@@ -1470,8 +1606,9 @@ module Aws::Connect
|
|
1470
1606
|
req.send_request(options)
|
1471
1607
|
end
|
1472
1608
|
|
1473
|
-
# Deletes an
|
1474
|
-
# The association must not have any use cases
|
1609
|
+
# Deletes an Amazon Web Services resource association from an Amazon
|
1610
|
+
# Connect instance. The association must not have any use cases
|
1611
|
+
# associated with it.
|
1475
1612
|
#
|
1476
1613
|
# @option params [required, String] :instance_id
|
1477
1614
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -1698,15 +1835,15 @@ module Aws::Connect
|
|
1698
1835
|
#
|
1699
1836
|
# Describes the specified contact.
|
1700
1837
|
#
|
1701
|
-
# Contact information
|
1702
|
-
# then it is deleted.
|
1838
|
+
# Contact information remains available in Amazon Connect for 24 months,
|
1839
|
+
# and then it is deleted.
|
1703
1840
|
#
|
1704
1841
|
# @option params [required, String] :instance_id
|
1705
1842
|
# The identifier of the Amazon Connect instance. You can find the
|
1706
1843
|
# instanceId in the ARN of the instance.
|
1707
1844
|
#
|
1708
1845
|
# @option params [required, String] :contact_id
|
1709
|
-
# The identifier of the
|
1846
|
+
# The identifier of the contact.
|
1710
1847
|
#
|
1711
1848
|
# @return [Types::DescribeContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1712
1849
|
#
|
@@ -1779,6 +1916,7 @@ module Aws::Connect
|
|
1779
1916
|
# resp.contact_flow.id #=> String
|
1780
1917
|
# resp.contact_flow.name #=> String
|
1781
1918
|
# resp.contact_flow.type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
|
1919
|
+
# resp.contact_flow.state #=> String, one of "ACTIVE", "ARCHIVED"
|
1782
1920
|
# resp.contact_flow.description #=> String
|
1783
1921
|
# resp.contact_flow.content #=> String
|
1784
1922
|
# resp.contact_flow.tags #=> Hash
|
@@ -1793,6 +1931,50 @@ module Aws::Connect
|
|
1793
1931
|
req.send_request(options)
|
1794
1932
|
end
|
1795
1933
|
|
1934
|
+
# Describes the specified contact flow module.
|
1935
|
+
#
|
1936
|
+
# @option params [required, String] :instance_id
|
1937
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1938
|
+
# instanceId in the ARN of the instance.
|
1939
|
+
#
|
1940
|
+
# @option params [required, String] :contact_flow_module_id
|
1941
|
+
# The identifier of the contact flow module.
|
1942
|
+
#
|
1943
|
+
# @return [Types::DescribeContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1944
|
+
#
|
1945
|
+
# * {Types::DescribeContactFlowModuleResponse#contact_flow_module #contact_flow_module} => Types::ContactFlowModule
|
1946
|
+
#
|
1947
|
+
# @example Request syntax with placeholder values
|
1948
|
+
#
|
1949
|
+
# resp = client.describe_contact_flow_module({
|
1950
|
+
# instance_id: "InstanceId", # required
|
1951
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
1952
|
+
# })
|
1953
|
+
#
|
1954
|
+
# @example Response structure
|
1955
|
+
#
|
1956
|
+
# resp.contact_flow_module.arn #=> String
|
1957
|
+
# resp.contact_flow_module.id #=> String
|
1958
|
+
# resp.contact_flow_module.name #=> String
|
1959
|
+
# resp.contact_flow_module.content #=> String
|
1960
|
+
# resp.contact_flow_module.description #=> String
|
1961
|
+
# resp.contact_flow_module.state #=> String, one of "ACTIVE", "ARCHIVED"
|
1962
|
+
# resp.contact_flow_module.status #=> String, one of "PUBLISHED", "SAVED"
|
1963
|
+
# resp.contact_flow_module.tags #=> Hash
|
1964
|
+
# resp.contact_flow_module.tags["TagKey"] #=> String
|
1965
|
+
#
|
1966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowModule AWS API Documentation
|
1967
|
+
#
|
1968
|
+
# @overload describe_contact_flow_module(params = {})
|
1969
|
+
# @param [Hash] params ({})
|
1970
|
+
def describe_contact_flow_module(params = {}, options = {})
|
1971
|
+
req = build_request(:describe_contact_flow_module, params)
|
1972
|
+
req.send_request(options)
|
1973
|
+
end
|
1974
|
+
|
1975
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1976
|
+
# change.
|
1977
|
+
#
|
1796
1978
|
# Describes the hours of operation.
|
1797
1979
|
#
|
1798
1980
|
# @option params [required, String] :instance_id
|
@@ -2245,6 +2427,8 @@ module Aws::Connect
|
|
2245
2427
|
# resp.hierarchy_group.hierarchy_path.level_five.id #=> String
|
2246
2428
|
# resp.hierarchy_group.hierarchy_path.level_five.arn #=> String
|
2247
2429
|
# resp.hierarchy_group.hierarchy_path.level_five.name #=> String
|
2430
|
+
# resp.hierarchy_group.tags #=> Hash
|
2431
|
+
# resp.hierarchy_group.tags["TagKey"] #=> String
|
2248
2432
|
#
|
2249
2433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup AWS API Documentation
|
2250
2434
|
#
|
@@ -3296,6 +3480,58 @@ module Aws::Connect
|
|
3296
3480
|
req.send_request(options)
|
3297
3481
|
end
|
3298
3482
|
|
3483
|
+
# Provides information about the contact flow modules for the specified
|
3484
|
+
# Amazon Connect instance.
|
3485
|
+
#
|
3486
|
+
# @option params [required, String] :instance_id
|
3487
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3488
|
+
# instanceId in the ARN of the instance.
|
3489
|
+
#
|
3490
|
+
# @option params [String] :next_token
|
3491
|
+
# The token for the next set of results. Use the value returned in the
|
3492
|
+
# previous response in the next request to retrieve the next set of
|
3493
|
+
# results.
|
3494
|
+
#
|
3495
|
+
# @option params [Integer] :max_results
|
3496
|
+
# The maximum number of results to return per page.
|
3497
|
+
#
|
3498
|
+
# @option params [String] :contact_flow_module_state
|
3499
|
+
# The state of the contact flow module.
|
3500
|
+
#
|
3501
|
+
# @return [Types::ListContactFlowModulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3502
|
+
#
|
3503
|
+
# * {Types::ListContactFlowModulesResponse#contact_flow_modules_summary_list #contact_flow_modules_summary_list} => Array<Types::ContactFlowModuleSummary>
|
3504
|
+
# * {Types::ListContactFlowModulesResponse#next_token #next_token} => String
|
3505
|
+
#
|
3506
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3507
|
+
#
|
3508
|
+
# @example Request syntax with placeholder values
|
3509
|
+
#
|
3510
|
+
# resp = client.list_contact_flow_modules({
|
3511
|
+
# instance_id: "InstanceId", # required
|
3512
|
+
# next_token: "NextToken",
|
3513
|
+
# max_results: 1,
|
3514
|
+
# contact_flow_module_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
3515
|
+
# })
|
3516
|
+
#
|
3517
|
+
# @example Response structure
|
3518
|
+
#
|
3519
|
+
# resp.contact_flow_modules_summary_list #=> Array
|
3520
|
+
# resp.contact_flow_modules_summary_list[0].id #=> String
|
3521
|
+
# resp.contact_flow_modules_summary_list[0].arn #=> String
|
3522
|
+
# resp.contact_flow_modules_summary_list[0].name #=> String
|
3523
|
+
# resp.contact_flow_modules_summary_list[0].state #=> String, one of "ACTIVE", "ARCHIVED"
|
3524
|
+
# resp.next_token #=> String
|
3525
|
+
#
|
3526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowModules AWS API Documentation
|
3527
|
+
#
|
3528
|
+
# @overload list_contact_flow_modules(params = {})
|
3529
|
+
# @param [Hash] params ({})
|
3530
|
+
def list_contact_flow_modules(params = {}, options = {})
|
3531
|
+
req = build_request(:list_contact_flow_modules, params)
|
3532
|
+
req.send_request(options)
|
3533
|
+
end
|
3534
|
+
|
3299
3535
|
# Provides information about the contact flows for the specified Amazon
|
3300
3536
|
# Connect instance.
|
3301
3537
|
#
|
@@ -3348,6 +3584,7 @@ module Aws::Connect
|
|
3348
3584
|
# resp.contact_flow_summary_list[0].arn #=> String
|
3349
3585
|
# resp.contact_flow_summary_list[0].name #=> String
|
3350
3586
|
# resp.contact_flow_summary_list[0].contact_flow_type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
|
3587
|
+
# resp.contact_flow_summary_list[0].contact_flow_state #=> String, one of "ACTIVE", "ARCHIVED"
|
3351
3588
|
# resp.next_token #=> String
|
3352
3589
|
#
|
3353
3590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
|
@@ -3380,7 +3617,7 @@ module Aws::Connect
|
|
3380
3617
|
# previous response in the next request to retrieve the next set of
|
3381
3618
|
# results.
|
3382
3619
|
#
|
3383
|
-
# This is not expected to be set
|
3620
|
+
# This is not expected to be set, because the value returned in the
|
3384
3621
|
# previous response is always null.
|
3385
3622
|
#
|
3386
3623
|
# @return [Types::ListContactReferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3637,14 +3874,15 @@ module Aws::Connect
|
|
3637
3874
|
req.send_request(options)
|
3638
3875
|
end
|
3639
3876
|
|
3640
|
-
# Provides summary information about the
|
3641
|
-
# the specified Amazon Connect instance.
|
3877
|
+
# Provides summary information about the Amazon Web Services resource
|
3878
|
+
# associations for the specified Amazon Connect instance.
|
3642
3879
|
#
|
3643
3880
|
# @option params [required, String] :instance_id
|
3644
3881
|
# The identifier of the Amazon Connect instance. You can find the
|
3645
3882
|
# instanceId in the ARN of the instance.
|
3646
3883
|
#
|
3647
3884
|
# @option params [String] :integration_type
|
3885
|
+
# The integration type.
|
3648
3886
|
#
|
3649
3887
|
# @option params [String] :next_token
|
3650
3888
|
# The token for the next set of results. Use the value returned in the
|
@@ -4898,8 +5136,7 @@ module Aws::Connect
|
|
4898
5136
|
req.send_request(options)
|
4899
5137
|
end
|
4900
5138
|
|
4901
|
-
# Initiates a contact flow to start a new task
|
4902
|
-
# future date and time.
|
5139
|
+
# Initiates a contact flow to start a new task.
|
4903
5140
|
#
|
4904
5141
|
# @option params [required, String] :instance_id
|
4905
5142
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -5251,7 +5488,7 @@ module Aws::Connect
|
|
5251
5488
|
# This API is in preview release for Amazon Connect and is subject to
|
5252
5489
|
# change.
|
5253
5490
|
#
|
5254
|
-
# Adds or updates user
|
5491
|
+
# Adds or updates user-defined contact information associated with the
|
5255
5492
|
# specified contact. At least one field to be updated must be present in
|
5256
5493
|
# the request.
|
5257
5494
|
#
|
@@ -5413,6 +5650,116 @@ module Aws::Connect
|
|
5413
5650
|
req.send_request(options)
|
5414
5651
|
end
|
5415
5652
|
|
5653
|
+
# Updates metadata about specified contact flow.
|
5654
|
+
#
|
5655
|
+
# @option params [required, String] :instance_id
|
5656
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5657
|
+
# instanceId in the ARN of the instance.
|
5658
|
+
#
|
5659
|
+
# @option params [required, String] :contact_flow_id
|
5660
|
+
# The identifier of the contact flow.
|
5661
|
+
#
|
5662
|
+
# @option params [String] :name
|
5663
|
+
# TThe name of the contact flow.
|
5664
|
+
#
|
5665
|
+
# @option params [String] :description
|
5666
|
+
# The description of the contact flow.
|
5667
|
+
#
|
5668
|
+
# @option params [String] :contact_flow_state
|
5669
|
+
# The state of contact flow.
|
5670
|
+
#
|
5671
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5672
|
+
#
|
5673
|
+
# @example Request syntax with placeholder values
|
5674
|
+
#
|
5675
|
+
# resp = client.update_contact_flow_metadata({
|
5676
|
+
# instance_id: "InstanceId", # required
|
5677
|
+
# contact_flow_id: "ContactFlowId", # required
|
5678
|
+
# name: "ContactFlowName",
|
5679
|
+
# description: "ContactFlowDescription",
|
5680
|
+
# contact_flow_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
5681
|
+
# })
|
5682
|
+
#
|
5683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowMetadata AWS API Documentation
|
5684
|
+
#
|
5685
|
+
# @overload update_contact_flow_metadata(params = {})
|
5686
|
+
# @param [Hash] params ({})
|
5687
|
+
def update_contact_flow_metadata(params = {}, options = {})
|
5688
|
+
req = build_request(:update_contact_flow_metadata, params)
|
5689
|
+
req.send_request(options)
|
5690
|
+
end
|
5691
|
+
|
5692
|
+
# Updates specified contact flow module for the specified Amazon Connect
|
5693
|
+
# instance.
|
5694
|
+
#
|
5695
|
+
# @option params [required, String] :instance_id
|
5696
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5697
|
+
# instanceId in the ARN of the instance.
|
5698
|
+
#
|
5699
|
+
# @option params [required, String] :contact_flow_module_id
|
5700
|
+
# The identifier of the contact flow module.
|
5701
|
+
#
|
5702
|
+
# @option params [required, String] :content
|
5703
|
+
# The content of the contact flow module.
|
5704
|
+
#
|
5705
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5706
|
+
#
|
5707
|
+
# @example Request syntax with placeholder values
|
5708
|
+
#
|
5709
|
+
# resp = client.update_contact_flow_module_content({
|
5710
|
+
# instance_id: "InstanceId", # required
|
5711
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
5712
|
+
# content: "ContactFlowModuleContent", # required
|
5713
|
+
# })
|
5714
|
+
#
|
5715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContent AWS API Documentation
|
5716
|
+
#
|
5717
|
+
# @overload update_contact_flow_module_content(params = {})
|
5718
|
+
# @param [Hash] params ({})
|
5719
|
+
def update_contact_flow_module_content(params = {}, options = {})
|
5720
|
+
req = build_request(:update_contact_flow_module_content, params)
|
5721
|
+
req.send_request(options)
|
5722
|
+
end
|
5723
|
+
|
5724
|
+
# Updates metadata about specified contact flow module.
|
5725
|
+
#
|
5726
|
+
# @option params [required, String] :instance_id
|
5727
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5728
|
+
# instanceId in the ARN of the instance.
|
5729
|
+
#
|
5730
|
+
# @option params [required, String] :contact_flow_module_id
|
5731
|
+
# The identifier of the contact flow module.
|
5732
|
+
#
|
5733
|
+
# @option params [String] :name
|
5734
|
+
# The name of the contact flow module.
|
5735
|
+
#
|
5736
|
+
# @option params [String] :description
|
5737
|
+
# The description of the contact flow module.
|
5738
|
+
#
|
5739
|
+
# @option params [String] :state
|
5740
|
+
# The state of contact flow module.
|
5741
|
+
#
|
5742
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5743
|
+
#
|
5744
|
+
# @example Request syntax with placeholder values
|
5745
|
+
#
|
5746
|
+
# resp = client.update_contact_flow_module_metadata({
|
5747
|
+
# instance_id: "InstanceId", # required
|
5748
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
5749
|
+
# name: "ContactFlowModuleName",
|
5750
|
+
# description: "ContactFlowModuleDescription",
|
5751
|
+
# state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
5752
|
+
# })
|
5753
|
+
#
|
5754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleMetadata AWS API Documentation
|
5755
|
+
#
|
5756
|
+
# @overload update_contact_flow_module_metadata(params = {})
|
5757
|
+
# @param [Hash] params ({})
|
5758
|
+
def update_contact_flow_module_metadata(params = {}, options = {})
|
5759
|
+
req = build_request(:update_contact_flow_module_metadata, params)
|
5760
|
+
req.send_request(options)
|
5761
|
+
end
|
5762
|
+
|
5416
5763
|
# The name of the contact flow.
|
5417
5764
|
#
|
5418
5765
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -5488,6 +5835,9 @@ module Aws::Connect
|
|
5488
5835
|
req.send_request(options)
|
5489
5836
|
end
|
5490
5837
|
|
5838
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5839
|
+
# change.
|
5840
|
+
#
|
5491
5841
|
# Updates the hours of operation.
|
5492
5842
|
#
|
5493
5843
|
# @option params [required, String] :instance_id
|
@@ -5556,7 +5906,8 @@ module Aws::Connect
|
|
5556
5906
|
# The type of attribute.
|
5557
5907
|
#
|
5558
5908
|
# <note markdown="1"> Only allowlisted customers can consume USE\_CUSTOM\_TTS\_VOICES. To
|
5559
|
-
# access this feature, contact
|
5909
|
+
# access this feature, contact Amazon Web Services Support for
|
5910
|
+
# allowlisting.
|
5560
5911
|
#
|
5561
5912
|
# </note>
|
5562
5913
|
#
|
@@ -6362,7 +6713,7 @@ module Aws::Connect
|
|
6362
6713
|
params: params,
|
6363
6714
|
config: config)
|
6364
6715
|
context[:gem_name] = 'aws-sdk-connect'
|
6365
|
-
context[:gem_version] = '1.
|
6716
|
+
context[:gem_version] = '1.61.0'
|
6366
6717
|
Seahorse::Client::Request.new(handlers, context)
|
6367
6718
|
end
|
6368
6719
|
|