aws-sdk-connect 1.54.0 → 1.58.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/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +777 -30
- data/lib/aws-sdk-connect/client_api.rb +534 -19
- data/lib/aws-sdk-connect/errors.rb +48 -0
- data/lib/aws-sdk-connect/types.rb +1210 -108
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +4 -4
@@ -275,6 +275,15 @@ module Aws::Connect
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -668,7 +677,7 @@ module Aws::Connect
|
|
668
677
|
# The display order of the status.
|
669
678
|
#
|
670
679
|
# @option params [Hash<String,String>] :tags
|
671
|
-
#
|
680
|
+
# The tags used to organize, track, or control access for this resource.
|
672
681
|
#
|
673
682
|
# @return [Types::CreateAgentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
674
683
|
#
|
@@ -767,6 +776,67 @@ module Aws::Connect
|
|
767
776
|
req.send_request(options)
|
768
777
|
end
|
769
778
|
|
779
|
+
# Creates a contact flow module for the specified Amazon Connect
|
780
|
+
# instance.
|
781
|
+
#
|
782
|
+
# @option params [required, String] :instance_id
|
783
|
+
# The identifier of the Amazon Connect instance. You can find the
|
784
|
+
# instanceId in the ARN of the instance.
|
785
|
+
#
|
786
|
+
# @option params [required, String] :name
|
787
|
+
# The name of the contact flow module.
|
788
|
+
#
|
789
|
+
# @option params [String] :description
|
790
|
+
# The description of the contact flow module.
|
791
|
+
#
|
792
|
+
# @option params [required, String] :content
|
793
|
+
# The content of the contact flow module.
|
794
|
+
#
|
795
|
+
# @option params [Hash<String,String>] :tags
|
796
|
+
# The tags used to organize, track, or control access for this resource.
|
797
|
+
#
|
798
|
+
# @option params [String] :client_token
|
799
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
800
|
+
# idempotency of the request.
|
801
|
+
#
|
802
|
+
# **A suitable default value is auto-generated.** You should normally
|
803
|
+
# not need to pass this option.**
|
804
|
+
#
|
805
|
+
# @return [Types::CreateContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
806
|
+
#
|
807
|
+
# * {Types::CreateContactFlowModuleResponse#id #id} => String
|
808
|
+
# * {Types::CreateContactFlowModuleResponse#arn #arn} => String
|
809
|
+
#
|
810
|
+
# @example Request syntax with placeholder values
|
811
|
+
#
|
812
|
+
# resp = client.create_contact_flow_module({
|
813
|
+
# instance_id: "InstanceId", # required
|
814
|
+
# name: "ContactFlowModuleName", # required
|
815
|
+
# description: "ContactFlowModuleDescription",
|
816
|
+
# content: "ContactFlowModuleContent", # required
|
817
|
+
# tags: {
|
818
|
+
# "TagKey" => "TagValue",
|
819
|
+
# },
|
820
|
+
# client_token: "ClientToken",
|
821
|
+
# })
|
822
|
+
#
|
823
|
+
# @example Response structure
|
824
|
+
#
|
825
|
+
# resp.id #=> String
|
826
|
+
# resp.arn #=> String
|
827
|
+
#
|
828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowModule AWS API Documentation
|
829
|
+
#
|
830
|
+
# @overload create_contact_flow_module(params = {})
|
831
|
+
# @param [Hash] params ({})
|
832
|
+
def create_contact_flow_module(params = {}, options = {})
|
833
|
+
req = build_request(:create_contact_flow_module, params)
|
834
|
+
req.send_request(options)
|
835
|
+
end
|
836
|
+
|
837
|
+
# This API is in preview release for Amazon Connect and is subject to
|
838
|
+
# change.
|
839
|
+
#
|
770
840
|
# Creates hours of operation.
|
771
841
|
#
|
772
842
|
# @option params [required, String] :instance_id
|
@@ -787,7 +857,7 @@ module Aws::Connect
|
|
787
857
|
# and end time.
|
788
858
|
#
|
789
859
|
# @option params [Hash<String,String>] :tags
|
790
|
-
#
|
860
|
+
# The tags used to organize, track, or control access for this resource.
|
791
861
|
#
|
792
862
|
# @return [Types::CreateHoursOfOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
793
863
|
#
|
@@ -921,7 +991,7 @@ module Aws::Connect
|
|
921
991
|
# integration type.
|
922
992
|
#
|
923
993
|
# @option params [Hash<String,String>] :tags
|
924
|
-
#
|
994
|
+
# The tags used to organize, track, or control access for this resource.
|
925
995
|
#
|
926
996
|
# @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
927
997
|
#
|
@@ -985,7 +1055,7 @@ module Aws::Connect
|
|
985
1055
|
# The quick connects available to agents who are working the queue.
|
986
1056
|
#
|
987
1057
|
# @option params [Hash<String,String>] :tags
|
988
|
-
#
|
1058
|
+
# The tags used to organize, track, or control access for this resource.
|
989
1059
|
#
|
990
1060
|
# @return [Types::CreateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
991
1061
|
#
|
@@ -1041,7 +1111,7 @@ module Aws::Connect
|
|
1041
1111
|
# Configuration settings for the quick connect.
|
1042
1112
|
#
|
1043
1113
|
# @option params [Hash<String,String>] :tags
|
1044
|
-
#
|
1114
|
+
# The tags used to organize, track, or control access for this resource.
|
1045
1115
|
#
|
1046
1116
|
# @return [Types::CreateQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1047
1117
|
#
|
@@ -1161,6 +1231,58 @@ module Aws::Connect
|
|
1161
1231
|
req.send_request(options)
|
1162
1232
|
end
|
1163
1233
|
|
1234
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1235
|
+
# change.
|
1236
|
+
#
|
1237
|
+
# Creates a security profile.
|
1238
|
+
#
|
1239
|
+
# @option params [required, String] :security_profile_name
|
1240
|
+
# The name of the security profile.
|
1241
|
+
#
|
1242
|
+
# @option params [String] :description
|
1243
|
+
# The description of the security profile.
|
1244
|
+
#
|
1245
|
+
# @option params [Array<String>] :permissions
|
1246
|
+
# Permissions assigned to the security profile.
|
1247
|
+
#
|
1248
|
+
# @option params [required, String] :instance_id
|
1249
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1250
|
+
# instanceId in the ARN of the instance.
|
1251
|
+
#
|
1252
|
+
# @option params [Hash<String,String>] :tags
|
1253
|
+
# The tags used to organize, track, or control access for this resource.
|
1254
|
+
#
|
1255
|
+
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1256
|
+
#
|
1257
|
+
# * {Types::CreateSecurityProfileResponse#security_profile_id #security_profile_id} => String
|
1258
|
+
# * {Types::CreateSecurityProfileResponse#security_profile_arn #security_profile_arn} => String
|
1259
|
+
#
|
1260
|
+
# @example Request syntax with placeholder values
|
1261
|
+
#
|
1262
|
+
# resp = client.create_security_profile({
|
1263
|
+
# security_profile_name: "SecurityProfileName", # required
|
1264
|
+
# description: "SecurityProfileDescription",
|
1265
|
+
# permissions: ["SecurityProfilePermission"],
|
1266
|
+
# instance_id: "InstanceId", # required
|
1267
|
+
# tags: {
|
1268
|
+
# "TagKey" => "TagValue",
|
1269
|
+
# },
|
1270
|
+
# })
|
1271
|
+
#
|
1272
|
+
# @example Response structure
|
1273
|
+
#
|
1274
|
+
# resp.security_profile_id #=> String
|
1275
|
+
# resp.security_profile_arn #=> String
|
1276
|
+
#
|
1277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateSecurityProfile AWS API Documentation
|
1278
|
+
#
|
1279
|
+
# @overload create_security_profile(params = {})
|
1280
|
+
# @param [Hash] params ({})
|
1281
|
+
def create_security_profile(params = {}, options = {})
|
1282
|
+
req = build_request(:create_security_profile, params)
|
1283
|
+
req.send_request(options)
|
1284
|
+
end
|
1285
|
+
|
1164
1286
|
# Creates a use case for an integration association.
|
1165
1287
|
#
|
1166
1288
|
# @option params [required, String] :instance_id
|
@@ -1175,7 +1297,7 @@ module Aws::Connect
|
|
1175
1297
|
# integration association can have only one of each use case type.
|
1176
1298
|
#
|
1177
1299
|
# @option params [Hash<String,String>] :tags
|
1178
|
-
#
|
1300
|
+
# The tags used to organize, track, or control access for this resource.
|
1179
1301
|
#
|
1180
1302
|
# @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1181
1303
|
#
|
@@ -1349,6 +1471,63 @@ module Aws::Connect
|
|
1349
1471
|
req.send_request(options)
|
1350
1472
|
end
|
1351
1473
|
|
1474
|
+
# Deletes a contact flow for the specified Amazon Connect instance.
|
1475
|
+
#
|
1476
|
+
# @option params [required, String] :instance_id
|
1477
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1478
|
+
# instanceId in the ARN of the instance.
|
1479
|
+
#
|
1480
|
+
# @option params [required, String] :contact_flow_id
|
1481
|
+
# The identifier of the contact flow.
|
1482
|
+
#
|
1483
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1484
|
+
#
|
1485
|
+
# @example Request syntax with placeholder values
|
1486
|
+
#
|
1487
|
+
# resp = client.delete_contact_flow({
|
1488
|
+
# instance_id: "InstanceId", # required
|
1489
|
+
# contact_flow_id: "ContactFlowId", # required
|
1490
|
+
# })
|
1491
|
+
#
|
1492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlow AWS API Documentation
|
1493
|
+
#
|
1494
|
+
# @overload delete_contact_flow(params = {})
|
1495
|
+
# @param [Hash] params ({})
|
1496
|
+
def delete_contact_flow(params = {}, options = {})
|
1497
|
+
req = build_request(:delete_contact_flow, params)
|
1498
|
+
req.send_request(options)
|
1499
|
+
end
|
1500
|
+
|
1501
|
+
# Deletes the specified contact flow module.
|
1502
|
+
#
|
1503
|
+
# @option params [required, String] :instance_id
|
1504
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1505
|
+
# instanceId in the ARN of the instance.
|
1506
|
+
#
|
1507
|
+
# @option params [required, String] :contact_flow_module_id
|
1508
|
+
# The identifier of the contact flow module.
|
1509
|
+
#
|
1510
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1511
|
+
#
|
1512
|
+
# @example Request syntax with placeholder values
|
1513
|
+
#
|
1514
|
+
# resp = client.delete_contact_flow_module({
|
1515
|
+
# instance_id: "InstanceId", # required
|
1516
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
1517
|
+
# })
|
1518
|
+
#
|
1519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowModule AWS API Documentation
|
1520
|
+
#
|
1521
|
+
# @overload delete_contact_flow_module(params = {})
|
1522
|
+
# @param [Hash] params ({})
|
1523
|
+
def delete_contact_flow_module(params = {}, options = {})
|
1524
|
+
req = build_request(:delete_contact_flow_module, params)
|
1525
|
+
req.send_request(options)
|
1526
|
+
end
|
1527
|
+
|
1528
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1529
|
+
# change.
|
1530
|
+
#
|
1352
1531
|
# Deletes an hours of operation.
|
1353
1532
|
#
|
1354
1533
|
# @option params [required, String] :instance_id
|
@@ -1464,6 +1643,36 @@ module Aws::Connect
|
|
1464
1643
|
req.send_request(options)
|
1465
1644
|
end
|
1466
1645
|
|
1646
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1647
|
+
# change.
|
1648
|
+
#
|
1649
|
+
# Deletes a security profile.
|
1650
|
+
#
|
1651
|
+
# @option params [required, String] :instance_id
|
1652
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1653
|
+
# instanceId in the ARN of the instance.
|
1654
|
+
#
|
1655
|
+
# @option params [required, String] :security_profile_id
|
1656
|
+
# The identifier for the security profle.
|
1657
|
+
#
|
1658
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1659
|
+
#
|
1660
|
+
# @example Request syntax with placeholder values
|
1661
|
+
#
|
1662
|
+
# resp = client.delete_security_profile({
|
1663
|
+
# instance_id: "InstanceId", # required
|
1664
|
+
# security_profile_id: "SecurityProfileId", # required
|
1665
|
+
# })
|
1666
|
+
#
|
1667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteSecurityProfile AWS API Documentation
|
1668
|
+
#
|
1669
|
+
# @overload delete_security_profile(params = {})
|
1670
|
+
# @param [Hash] params ({})
|
1671
|
+
def delete_security_profile(params = {}, options = {})
|
1672
|
+
req = build_request(:delete_security_profile, params)
|
1673
|
+
req.send_request(options)
|
1674
|
+
end
|
1675
|
+
|
1467
1676
|
# Deletes a use case from an integration association.
|
1468
1677
|
#
|
1469
1678
|
# @option params [required, String] :instance_id
|
@@ -1602,6 +1811,60 @@ module Aws::Connect
|
|
1602
1811
|
req.send_request(options)
|
1603
1812
|
end
|
1604
1813
|
|
1814
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1815
|
+
# change.
|
1816
|
+
#
|
1817
|
+
# Describes the specified contact.
|
1818
|
+
#
|
1819
|
+
# Contact information remains available in Amazon Connect for 24 months,
|
1820
|
+
# and then it is deleted.
|
1821
|
+
#
|
1822
|
+
# @option params [required, String] :instance_id
|
1823
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1824
|
+
# instanceId in the ARN of the instance.
|
1825
|
+
#
|
1826
|
+
# @option params [required, String] :contact_id
|
1827
|
+
# The identifier of the contact.
|
1828
|
+
#
|
1829
|
+
# @return [Types::DescribeContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1830
|
+
#
|
1831
|
+
# * {Types::DescribeContactResponse#contact #contact} => Types::Contact
|
1832
|
+
#
|
1833
|
+
# @example Request syntax with placeholder values
|
1834
|
+
#
|
1835
|
+
# resp = client.describe_contact({
|
1836
|
+
# instance_id: "InstanceId", # required
|
1837
|
+
# contact_id: "ContactId", # required
|
1838
|
+
# })
|
1839
|
+
#
|
1840
|
+
# @example Response structure
|
1841
|
+
#
|
1842
|
+
# resp.contact.arn #=> String
|
1843
|
+
# resp.contact.id #=> String
|
1844
|
+
# resp.contact.initial_contact_id #=> String
|
1845
|
+
# resp.contact.previous_contact_id #=> String
|
1846
|
+
# resp.contact.initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API"
|
1847
|
+
# resp.contact.name #=> String
|
1848
|
+
# resp.contact.description #=> String
|
1849
|
+
# resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1850
|
+
# resp.contact.queue_info.id #=> String
|
1851
|
+
# resp.contact.queue_info.enqueue_timestamp #=> Time
|
1852
|
+
# resp.contact.agent_info.id #=> String
|
1853
|
+
# resp.contact.agent_info.connected_to_agent_timestamp #=> Time
|
1854
|
+
# resp.contact.initiation_timestamp #=> Time
|
1855
|
+
# resp.contact.disconnect_timestamp #=> Time
|
1856
|
+
# resp.contact.last_update_timestamp #=> Time
|
1857
|
+
# resp.contact.scheduled_timestamp #=> Time
|
1858
|
+
#
|
1859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContact AWS API Documentation
|
1860
|
+
#
|
1861
|
+
# @overload describe_contact(params = {})
|
1862
|
+
# @param [Hash] params ({})
|
1863
|
+
def describe_contact(params = {}, options = {})
|
1864
|
+
req = build_request(:describe_contact, params)
|
1865
|
+
req.send_request(options)
|
1866
|
+
end
|
1867
|
+
|
1605
1868
|
# Describes the specified contact flow.
|
1606
1869
|
#
|
1607
1870
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -1634,6 +1897,7 @@ module Aws::Connect
|
|
1634
1897
|
# resp.contact_flow.id #=> String
|
1635
1898
|
# resp.contact_flow.name #=> String
|
1636
1899
|
# 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"
|
1900
|
+
# resp.contact_flow.state #=> String, one of "ACTIVE", "ARCHIVED"
|
1637
1901
|
# resp.contact_flow.description #=> String
|
1638
1902
|
# resp.contact_flow.content #=> String
|
1639
1903
|
# resp.contact_flow.tags #=> Hash
|
@@ -1648,6 +1912,50 @@ module Aws::Connect
|
|
1648
1912
|
req.send_request(options)
|
1649
1913
|
end
|
1650
1914
|
|
1915
|
+
# Describes the specified contact flow module.
|
1916
|
+
#
|
1917
|
+
# @option params [required, String] :instance_id
|
1918
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1919
|
+
# instanceId in the ARN of the instance.
|
1920
|
+
#
|
1921
|
+
# @option params [required, String] :contact_flow_module_id
|
1922
|
+
# The identifier of the contact flow module.
|
1923
|
+
#
|
1924
|
+
# @return [Types::DescribeContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1925
|
+
#
|
1926
|
+
# * {Types::DescribeContactFlowModuleResponse#contact_flow_module #contact_flow_module} => Types::ContactFlowModule
|
1927
|
+
#
|
1928
|
+
# @example Request syntax with placeholder values
|
1929
|
+
#
|
1930
|
+
# resp = client.describe_contact_flow_module({
|
1931
|
+
# instance_id: "InstanceId", # required
|
1932
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
1933
|
+
# })
|
1934
|
+
#
|
1935
|
+
# @example Response structure
|
1936
|
+
#
|
1937
|
+
# resp.contact_flow_module.arn #=> String
|
1938
|
+
# resp.contact_flow_module.id #=> String
|
1939
|
+
# resp.contact_flow_module.name #=> String
|
1940
|
+
# resp.contact_flow_module.content #=> String
|
1941
|
+
# resp.contact_flow_module.description #=> String
|
1942
|
+
# resp.contact_flow_module.state #=> String, one of "ACTIVE", "ARCHIVED"
|
1943
|
+
# resp.contact_flow_module.status #=> String, one of "PUBLISHED", "SAVED"
|
1944
|
+
# resp.contact_flow_module.tags #=> Hash
|
1945
|
+
# resp.contact_flow_module.tags["TagKey"] #=> String
|
1946
|
+
#
|
1947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowModule AWS API Documentation
|
1948
|
+
#
|
1949
|
+
# @overload describe_contact_flow_module(params = {})
|
1950
|
+
# @param [Hash] params ({})
|
1951
|
+
def describe_contact_flow_module(params = {}, options = {})
|
1952
|
+
req = build_request(:describe_contact_flow_module, params)
|
1953
|
+
req.send_request(options)
|
1954
|
+
end
|
1955
|
+
|
1956
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1957
|
+
# change.
|
1958
|
+
#
|
1651
1959
|
# Describes the hours of operation.
|
1652
1960
|
#
|
1653
1961
|
# @option params [required, String] :instance_id
|
@@ -1965,6 +2273,48 @@ module Aws::Connect
|
|
1965
2273
|
req.send_request(options)
|
1966
2274
|
end
|
1967
2275
|
|
2276
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2277
|
+
# change.
|
2278
|
+
#
|
2279
|
+
# Gets basic information about the security profle.
|
2280
|
+
#
|
2281
|
+
# @option params [required, String] :security_profile_id
|
2282
|
+
# The identifier for the security profle.
|
2283
|
+
#
|
2284
|
+
# @option params [required, String] :instance_id
|
2285
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2286
|
+
# instanceId in the ARN of the instance.
|
2287
|
+
#
|
2288
|
+
# @return [Types::DescribeSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2289
|
+
#
|
2290
|
+
# * {Types::DescribeSecurityProfileResponse#security_profile #security_profile} => Types::SecurityProfile
|
2291
|
+
#
|
2292
|
+
# @example Request syntax with placeholder values
|
2293
|
+
#
|
2294
|
+
# resp = client.describe_security_profile({
|
2295
|
+
# security_profile_id: "SecurityProfileId", # required
|
2296
|
+
# instance_id: "InstanceId", # required
|
2297
|
+
# })
|
2298
|
+
#
|
2299
|
+
# @example Response structure
|
2300
|
+
#
|
2301
|
+
# resp.security_profile.id #=> String
|
2302
|
+
# resp.security_profile.organization_resource_id #=> String
|
2303
|
+
# resp.security_profile.arn #=> String
|
2304
|
+
# resp.security_profile.security_profile_name #=> String
|
2305
|
+
# resp.security_profile.description #=> String
|
2306
|
+
# resp.security_profile.tags #=> Hash
|
2307
|
+
# resp.security_profile.tags["TagKey"] #=> String
|
2308
|
+
#
|
2309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfile AWS API Documentation
|
2310
|
+
#
|
2311
|
+
# @overload describe_security_profile(params = {})
|
2312
|
+
# @param [Hash] params ({})
|
2313
|
+
def describe_security_profile(params = {}, options = {})
|
2314
|
+
req = build_request(:describe_security_profile, params)
|
2315
|
+
req.send_request(options)
|
2316
|
+
end
|
2317
|
+
|
1968
2318
|
# Describes the specified user account. You can find the instance ID in
|
1969
2319
|
# the console (it’s the final part of the ARN). The console does not
|
1970
2320
|
# display the user IDs. Instead, list the users and note the IDs
|
@@ -2588,14 +2938,13 @@ module Aws::Connect
|
|
2588
2938
|
# instance_id: "InstanceId", # required
|
2589
2939
|
# filters: { # required
|
2590
2940
|
# queues: ["QueueId"],
|
2591
|
-
# routing_profiles: ["RoutingProfileId"],
|
2592
2941
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2593
2942
|
# },
|
2594
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2943
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2595
2944
|
# current_metrics: [ # required
|
2596
2945
|
# {
|
2597
2946
|
# name: "AGENTS_ONLINE", # accepts 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
|
2598
|
-
# unit: "SECONDS", # accepts SECONDS,
|
2947
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2599
2948
|
# },
|
2600
2949
|
# ],
|
2601
2950
|
# next_token: "NextToken",
|
@@ -2608,15 +2957,10 @@ module Aws::Connect
|
|
2608
2957
|
# resp.metric_results #=> Array
|
2609
2958
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
2610
2959
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
2611
|
-
# resp.metric_results[0].dimensions.queue.queue_type #=> String, one of "STANDARD", "AGENT"
|
2612
2960
|
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2613
|
-
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
2614
|
-
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
2615
|
-
# resp.metric_results[0].dimensions.instance_reference.id #=> String
|
2616
|
-
# resp.metric_results[0].dimensions.instance_reference.arn #=> String
|
2617
2961
|
# resp.metric_results[0].collections #=> Array
|
2618
2962
|
# 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"
|
2619
|
-
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "
|
2963
|
+
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
2620
2964
|
# resp.metric_results[0].collections[0].value #=> Float
|
2621
2965
|
# resp.data_snapshot_time #=> Time
|
2622
2966
|
#
|
@@ -2917,19 +3261,18 @@ module Aws::Connect
|
|
2917
3261
|
# end_time: Time.now, # required
|
2918
3262
|
# filters: { # required
|
2919
3263
|
# queues: ["QueueId"],
|
2920
|
-
# routing_profiles: ["RoutingProfileId"],
|
2921
3264
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2922
3265
|
# },
|
2923
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
3266
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2924
3267
|
# historical_metrics: [ # required
|
2925
3268
|
# {
|
2926
|
-
# name: "CONTACTS_QUEUED", # accepts 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,
|
3269
|
+
# name: "CONTACTS_QUEUED", # accepts 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
|
2927
3270
|
# threshold: {
|
2928
3271
|
# comparison: "LT", # accepts LT
|
2929
3272
|
# threshold_value: 1.0,
|
2930
3273
|
# },
|
2931
3274
|
# statistic: "SUM", # accepts SUM, MAX, AVG
|
2932
|
-
# unit: "SECONDS", # accepts SECONDS,
|
3275
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2933
3276
|
# },
|
2934
3277
|
# ],
|
2935
3278
|
# next_token: "NextToken",
|
@@ -2942,18 +3285,13 @@ module Aws::Connect
|
|
2942
3285
|
# resp.metric_results #=> Array
|
2943
3286
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
2944
3287
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
2945
|
-
# resp.metric_results[0].dimensions.queue.queue_type #=> String, one of "STANDARD", "AGENT"
|
2946
3288
|
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2947
|
-
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
2948
|
-
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
2949
|
-
# resp.metric_results[0].dimensions.instance_reference.id #=> String
|
2950
|
-
# resp.metric_results[0].dimensions.instance_reference.arn #=> String
|
2951
3289
|
# resp.metric_results[0].collections #=> Array
|
2952
|
-
# 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", "
|
3290
|
+
# 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"
|
2953
3291
|
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
2954
3292
|
# resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
|
2955
3293
|
# resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
|
2956
|
-
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "
|
3294
|
+
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
2957
3295
|
# resp.metric_results[0].collections[0].value #=> Float
|
2958
3296
|
#
|
2959
3297
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData AWS API Documentation
|
@@ -3121,6 +3459,58 @@ module Aws::Connect
|
|
3121
3459
|
req.send_request(options)
|
3122
3460
|
end
|
3123
3461
|
|
3462
|
+
# Provides information about the contact flow modules for the specified
|
3463
|
+
# Amazon Connect instance.
|
3464
|
+
#
|
3465
|
+
# @option params [required, String] :instance_id
|
3466
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3467
|
+
# instanceId in the ARN of the instance.
|
3468
|
+
#
|
3469
|
+
# @option params [String] :next_token
|
3470
|
+
# The token for the next set of results. Use the value returned in the
|
3471
|
+
# previous response in the next request to retrieve the next set of
|
3472
|
+
# results.
|
3473
|
+
#
|
3474
|
+
# @option params [Integer] :max_results
|
3475
|
+
# The maximum number of results to return per page.
|
3476
|
+
#
|
3477
|
+
# @option params [String] :contact_flow_module_state
|
3478
|
+
# The state of the contact flow module.
|
3479
|
+
#
|
3480
|
+
# @return [Types::ListContactFlowModulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3481
|
+
#
|
3482
|
+
# * {Types::ListContactFlowModulesResponse#contact_flow_modules_summary_list #contact_flow_modules_summary_list} => Array<Types::ContactFlowModuleSummary>
|
3483
|
+
# * {Types::ListContactFlowModulesResponse#next_token #next_token} => String
|
3484
|
+
#
|
3485
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3486
|
+
#
|
3487
|
+
# @example Request syntax with placeholder values
|
3488
|
+
#
|
3489
|
+
# resp = client.list_contact_flow_modules({
|
3490
|
+
# instance_id: "InstanceId", # required
|
3491
|
+
# next_token: "NextToken",
|
3492
|
+
# max_results: 1,
|
3493
|
+
# contact_flow_module_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
3494
|
+
# })
|
3495
|
+
#
|
3496
|
+
# @example Response structure
|
3497
|
+
#
|
3498
|
+
# resp.contact_flow_modules_summary_list #=> Array
|
3499
|
+
# resp.contact_flow_modules_summary_list[0].id #=> String
|
3500
|
+
# resp.contact_flow_modules_summary_list[0].arn #=> String
|
3501
|
+
# resp.contact_flow_modules_summary_list[0].name #=> String
|
3502
|
+
# resp.contact_flow_modules_summary_list[0].state #=> String, one of "ACTIVE", "ARCHIVED"
|
3503
|
+
# resp.next_token #=> String
|
3504
|
+
#
|
3505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowModules AWS API Documentation
|
3506
|
+
#
|
3507
|
+
# @overload list_contact_flow_modules(params = {})
|
3508
|
+
# @param [Hash] params ({})
|
3509
|
+
def list_contact_flow_modules(params = {}, options = {})
|
3510
|
+
req = build_request(:list_contact_flow_modules, params)
|
3511
|
+
req.send_request(options)
|
3512
|
+
end
|
3513
|
+
|
3124
3514
|
# Provides information about the contact flows for the specified Amazon
|
3125
3515
|
# Connect instance.
|
3126
3516
|
#
|
@@ -3173,6 +3563,7 @@ module Aws::Connect
|
|
3173
3563
|
# resp.contact_flow_summary_list[0].arn #=> String
|
3174
3564
|
# resp.contact_flow_summary_list[0].name #=> String
|
3175
3565
|
# 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"
|
3566
|
+
# resp.contact_flow_summary_list[0].contact_flow_state #=> String, one of "ACTIVE", "ARCHIVED"
|
3176
3567
|
# resp.next_token #=> String
|
3177
3568
|
#
|
3178
3569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
|
@@ -3184,6 +3575,65 @@ module Aws::Connect
|
|
3184
3575
|
req.send_request(options)
|
3185
3576
|
end
|
3186
3577
|
|
3578
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3579
|
+
# change.
|
3580
|
+
#
|
3581
|
+
# For the specified `referenceTypes`, returns a list of references
|
3582
|
+
# associated with the contact.
|
3583
|
+
#
|
3584
|
+
# @option params [required, String] :instance_id
|
3585
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3586
|
+
# instanceId in the ARN of the instance.
|
3587
|
+
#
|
3588
|
+
# @option params [required, String] :contact_id
|
3589
|
+
# The identifier of the initial contact.
|
3590
|
+
#
|
3591
|
+
# @option params [required, Array<String>] :reference_types
|
3592
|
+
# The type of reference.
|
3593
|
+
#
|
3594
|
+
# @option params [String] :next_token
|
3595
|
+
# The token for the next set of results. Use the value returned in the
|
3596
|
+
# previous response in the next request to retrieve the next set of
|
3597
|
+
# results.
|
3598
|
+
#
|
3599
|
+
# This is not expected to be set, because the value returned in the
|
3600
|
+
# previous response is always null.
|
3601
|
+
#
|
3602
|
+
# @return [Types::ListContactReferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3603
|
+
#
|
3604
|
+
# * {Types::ListContactReferencesResponse#reference_summary_list #reference_summary_list} => Array<Types::ReferenceSummary>
|
3605
|
+
# * {Types::ListContactReferencesResponse#next_token #next_token} => String
|
3606
|
+
#
|
3607
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3608
|
+
#
|
3609
|
+
# @example Request syntax with placeholder values
|
3610
|
+
#
|
3611
|
+
# resp = client.list_contact_references({
|
3612
|
+
# instance_id: "InstanceId", # required
|
3613
|
+
# contact_id: "ContactId", # required
|
3614
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT
|
3615
|
+
# next_token: "NextToken",
|
3616
|
+
# })
|
3617
|
+
#
|
3618
|
+
# @example Response structure
|
3619
|
+
#
|
3620
|
+
# resp.reference_summary_list #=> Array
|
3621
|
+
# resp.reference_summary_list[0].url.name #=> String
|
3622
|
+
# resp.reference_summary_list[0].url.value #=> String
|
3623
|
+
# resp.reference_summary_list[0].attachment.name #=> String
|
3624
|
+
# resp.reference_summary_list[0].attachment.value #=> String
|
3625
|
+
# resp.reference_summary_list[0].attachment.status #=> String, one of "APPROVED", "REJECTED"
|
3626
|
+
# resp.next_token #=> String
|
3627
|
+
#
|
3628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferences AWS API Documentation
|
3629
|
+
#
|
3630
|
+
# @overload list_contact_references(params = {})
|
3631
|
+
# @param [Hash] params ({})
|
3632
|
+
def list_contact_references(params = {}, options = {})
|
3633
|
+
req = build_request(:list_contact_references, params)
|
3634
|
+
req.send_request(options)
|
3635
|
+
end
|
3636
|
+
|
3187
3637
|
# Provides information about the hours of operation for the specified
|
3188
3638
|
# Amazon Connect instance.
|
3189
3639
|
#
|
@@ -3411,6 +3861,7 @@ module Aws::Connect
|
|
3411
3861
|
# instanceId in the ARN of the instance.
|
3412
3862
|
#
|
3413
3863
|
# @option params [String] :integration_type
|
3864
|
+
# The integration type.
|
3414
3865
|
#
|
3415
3866
|
# @option params [String] :next_token
|
3416
3867
|
# The token for the next set of results. Use the value returned in the
|
@@ -3999,6 +4450,57 @@ module Aws::Connect
|
|
3999
4450
|
req.send_request(options)
|
4000
4451
|
end
|
4001
4452
|
|
4453
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4454
|
+
# change.
|
4455
|
+
#
|
4456
|
+
# Lists the permissions granted to a security profile.
|
4457
|
+
#
|
4458
|
+
# @option params [required, String] :security_profile_id
|
4459
|
+
# The identifier for the security profle.
|
4460
|
+
#
|
4461
|
+
# @option params [required, String] :instance_id
|
4462
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4463
|
+
# instanceId in the ARN of the instance.
|
4464
|
+
#
|
4465
|
+
# @option params [String] :next_token
|
4466
|
+
# The token for the next set of results. Use the value returned in the
|
4467
|
+
# previous response in the next request to retrieve the next set of
|
4468
|
+
# results.
|
4469
|
+
#
|
4470
|
+
# @option params [Integer] :max_results
|
4471
|
+
# The maximum number of results to return per page.
|
4472
|
+
#
|
4473
|
+
# @return [Types::ListSecurityProfilePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4474
|
+
#
|
4475
|
+
# * {Types::ListSecurityProfilePermissionsResponse#permissions #permissions} => Array<String>
|
4476
|
+
# * {Types::ListSecurityProfilePermissionsResponse#next_token #next_token} => String
|
4477
|
+
#
|
4478
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4479
|
+
#
|
4480
|
+
# @example Request syntax with placeholder values
|
4481
|
+
#
|
4482
|
+
# resp = client.list_security_profile_permissions({
|
4483
|
+
# security_profile_id: "SecurityProfileId", # required
|
4484
|
+
# instance_id: "InstanceId", # required
|
4485
|
+
# next_token: "NextToken",
|
4486
|
+
# max_results: 1,
|
4487
|
+
# })
|
4488
|
+
#
|
4489
|
+
# @example Response structure
|
4490
|
+
#
|
4491
|
+
# resp.permissions #=> Array
|
4492
|
+
# resp.permissions[0] #=> String
|
4493
|
+
# resp.next_token #=> String
|
4494
|
+
#
|
4495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilePermissions AWS API Documentation
|
4496
|
+
#
|
4497
|
+
# @overload list_security_profile_permissions(params = {})
|
4498
|
+
# @param [Hash] params ({})
|
4499
|
+
def list_security_profile_permissions(params = {}, options = {})
|
4500
|
+
req = build_request(:list_security_profile_permissions, params)
|
4501
|
+
req.send_request(options)
|
4502
|
+
end
|
4503
|
+
|
4002
4504
|
# Provides summary information about the security profiles for the
|
4003
4505
|
# specified Amazon Connect instance.
|
4004
4506
|
#
|
@@ -4357,8 +4859,8 @@ module Aws::Connect
|
|
4357
4859
|
# display_name: "DisplayName", # required
|
4358
4860
|
# },
|
4359
4861
|
# initial_message: {
|
4360
|
-
# content_type: "ChatContentType",
|
4361
|
-
# content: "ChatContent",
|
4862
|
+
# content_type: "ChatContentType", # required
|
4863
|
+
# content: "ChatContent", # required
|
4362
4864
|
# },
|
4363
4865
|
# client_token: "ClientToken",
|
4364
4866
|
# })
|
@@ -4660,6 +5162,11 @@ module Aws::Connect
|
|
4660
5162
|
# **A suitable default value is auto-generated.** You should normally
|
4661
5163
|
# not need to pass this option.**
|
4662
5164
|
#
|
5165
|
+
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
5166
|
+
# The timestamp, in Unix Epoch seconds format, at which to start running
|
5167
|
+
# the inbound contact flow. The scheduled time cannot be in the past. It
|
5168
|
+
# must be within up to 6 days in future.
|
5169
|
+
#
|
4663
5170
|
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4664
5171
|
#
|
4665
5172
|
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
@@ -4677,11 +5184,12 @@ module Aws::Connect
|
|
4677
5184
|
# references: {
|
4678
5185
|
# "ReferenceKey" => {
|
4679
5186
|
# value: "ReferenceValue", # required
|
4680
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
5187
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
4681
5188
|
# },
|
4682
5189
|
# },
|
4683
5190
|
# description: "Description",
|
4684
5191
|
# client_token: "ClientToken",
|
5192
|
+
# scheduled_time: Time.now,
|
4685
5193
|
# })
|
4686
5194
|
#
|
4687
5195
|
# @example Response structure
|
@@ -4956,6 +5464,60 @@ module Aws::Connect
|
|
4956
5464
|
req.send_request(options)
|
4957
5465
|
end
|
4958
5466
|
|
5467
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5468
|
+
# change.
|
5469
|
+
#
|
5470
|
+
# Adds or updates user-defined contact information associated with the
|
5471
|
+
# specified contact. At least one field to be updated must be present in
|
5472
|
+
# the request.
|
5473
|
+
#
|
5474
|
+
# You can add or update user-defined contact information for both
|
5475
|
+
# ongoing and completed contacts.
|
5476
|
+
#
|
5477
|
+
# @option params [required, String] :instance_id
|
5478
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5479
|
+
# instanceId in the ARN of the instance.
|
5480
|
+
#
|
5481
|
+
# @option params [required, String] :contact_id
|
5482
|
+
# The identifier of the contact. This is the identifier of the contact
|
5483
|
+
# associated with the first interaction with your contact center.
|
5484
|
+
#
|
5485
|
+
# @option params [String] :name
|
5486
|
+
# The name of the contact.
|
5487
|
+
#
|
5488
|
+
# @option params [String] :description
|
5489
|
+
# The description of the contact.
|
5490
|
+
#
|
5491
|
+
# @option params [Hash<String,Types::Reference>] :references
|
5492
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
5493
|
+
# (CCP).
|
5494
|
+
#
|
5495
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5496
|
+
#
|
5497
|
+
# @example Request syntax with placeholder values
|
5498
|
+
#
|
5499
|
+
# resp = client.update_contact({
|
5500
|
+
# instance_id: "InstanceId", # required
|
5501
|
+
# contact_id: "ContactId", # required
|
5502
|
+
# name: "Name",
|
5503
|
+
# description: "Description",
|
5504
|
+
# references: {
|
5505
|
+
# "ReferenceKey" => {
|
5506
|
+
# value: "ReferenceValue", # required
|
5507
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
5508
|
+
# },
|
5509
|
+
# },
|
5510
|
+
# })
|
5511
|
+
#
|
5512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContact AWS API Documentation
|
5513
|
+
#
|
5514
|
+
# @overload update_contact(params = {})
|
5515
|
+
# @param [Hash] params ({})
|
5516
|
+
def update_contact(params = {}, options = {})
|
5517
|
+
req = build_request(:update_contact, params)
|
5518
|
+
req.send_request(options)
|
5519
|
+
end
|
5520
|
+
|
4959
5521
|
# Creates or updates user-defined contact attributes associated with the
|
4960
5522
|
# specified contact.
|
4961
5523
|
#
|
@@ -5067,6 +5629,116 @@ module Aws::Connect
|
|
5067
5629
|
req.send_request(options)
|
5068
5630
|
end
|
5069
5631
|
|
5632
|
+
# Updates metadata about specified contact flow.
|
5633
|
+
#
|
5634
|
+
# @option params [required, String] :instance_id
|
5635
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5636
|
+
# instanceId in the ARN of the instance.
|
5637
|
+
#
|
5638
|
+
# @option params [required, String] :contact_flow_id
|
5639
|
+
# The identifier of the contact flow.
|
5640
|
+
#
|
5641
|
+
# @option params [String] :name
|
5642
|
+
# TThe name of the contact flow.
|
5643
|
+
#
|
5644
|
+
# @option params [String] :description
|
5645
|
+
# The description of the contact flow.
|
5646
|
+
#
|
5647
|
+
# @option params [String] :contact_flow_state
|
5648
|
+
# The state of contact flow.
|
5649
|
+
#
|
5650
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5651
|
+
#
|
5652
|
+
# @example Request syntax with placeholder values
|
5653
|
+
#
|
5654
|
+
# resp = client.update_contact_flow_metadata({
|
5655
|
+
# instance_id: "InstanceId", # required
|
5656
|
+
# contact_flow_id: "ContactFlowId", # required
|
5657
|
+
# name: "ContactFlowName",
|
5658
|
+
# description: "ContactFlowDescription",
|
5659
|
+
# contact_flow_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
5660
|
+
# })
|
5661
|
+
#
|
5662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowMetadata AWS API Documentation
|
5663
|
+
#
|
5664
|
+
# @overload update_contact_flow_metadata(params = {})
|
5665
|
+
# @param [Hash] params ({})
|
5666
|
+
def update_contact_flow_metadata(params = {}, options = {})
|
5667
|
+
req = build_request(:update_contact_flow_metadata, params)
|
5668
|
+
req.send_request(options)
|
5669
|
+
end
|
5670
|
+
|
5671
|
+
# Updates specified contact flow module for the specified Amazon Connect
|
5672
|
+
# instance.
|
5673
|
+
#
|
5674
|
+
# @option params [required, String] :instance_id
|
5675
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5676
|
+
# instanceId in the ARN of the instance.
|
5677
|
+
#
|
5678
|
+
# @option params [required, String] :contact_flow_module_id
|
5679
|
+
# The identifier of the contact flow module.
|
5680
|
+
#
|
5681
|
+
# @option params [required, String] :content
|
5682
|
+
# The content of the contact flow module.
|
5683
|
+
#
|
5684
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5685
|
+
#
|
5686
|
+
# @example Request syntax with placeholder values
|
5687
|
+
#
|
5688
|
+
# resp = client.update_contact_flow_module_content({
|
5689
|
+
# instance_id: "InstanceId", # required
|
5690
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
5691
|
+
# content: "ContactFlowModuleContent", # required
|
5692
|
+
# })
|
5693
|
+
#
|
5694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContent AWS API Documentation
|
5695
|
+
#
|
5696
|
+
# @overload update_contact_flow_module_content(params = {})
|
5697
|
+
# @param [Hash] params ({})
|
5698
|
+
def update_contact_flow_module_content(params = {}, options = {})
|
5699
|
+
req = build_request(:update_contact_flow_module_content, params)
|
5700
|
+
req.send_request(options)
|
5701
|
+
end
|
5702
|
+
|
5703
|
+
# Updates metadata about specified contact flow module.
|
5704
|
+
#
|
5705
|
+
# @option params [required, String] :instance_id
|
5706
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5707
|
+
# instanceId in the ARN of the instance.
|
5708
|
+
#
|
5709
|
+
# @option params [required, String] :contact_flow_module_id
|
5710
|
+
# The identifier of the contact flow module.
|
5711
|
+
#
|
5712
|
+
# @option params [String] :name
|
5713
|
+
# The name of the contact flow module.
|
5714
|
+
#
|
5715
|
+
# @option params [String] :description
|
5716
|
+
# The description of the contact flow module.
|
5717
|
+
#
|
5718
|
+
# @option params [String] :state
|
5719
|
+
# The state of contact flow module.
|
5720
|
+
#
|
5721
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5722
|
+
#
|
5723
|
+
# @example Request syntax with placeholder values
|
5724
|
+
#
|
5725
|
+
# resp = client.update_contact_flow_module_metadata({
|
5726
|
+
# instance_id: "InstanceId", # required
|
5727
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
5728
|
+
# name: "ContactFlowModuleName",
|
5729
|
+
# description: "ContactFlowModuleDescription",
|
5730
|
+
# state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
5731
|
+
# })
|
5732
|
+
#
|
5733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleMetadata AWS API Documentation
|
5734
|
+
#
|
5735
|
+
# @overload update_contact_flow_module_metadata(params = {})
|
5736
|
+
# @param [Hash] params ({})
|
5737
|
+
def update_contact_flow_module_metadata(params = {}, options = {})
|
5738
|
+
req = build_request(:update_contact_flow_module_metadata, params)
|
5739
|
+
req.send_request(options)
|
5740
|
+
end
|
5741
|
+
|
5070
5742
|
# The name of the contact flow.
|
5071
5743
|
#
|
5072
5744
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -5108,6 +5780,43 @@ module Aws::Connect
|
|
5108
5780
|
req.send_request(options)
|
5109
5781
|
end
|
5110
5782
|
|
5783
|
+
# Updates the scheduled time of a task contact that is already
|
5784
|
+
# scheduled.
|
5785
|
+
#
|
5786
|
+
# @option params [required, String] :instance_id
|
5787
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5788
|
+
# instanceId in the ARN of the instance.
|
5789
|
+
#
|
5790
|
+
# @option params [required, String] :contact_id
|
5791
|
+
# The identifier of the contact.
|
5792
|
+
#
|
5793
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :scheduled_time
|
5794
|
+
# The timestamp, in Unix Epoch seconds format, at which to start running
|
5795
|
+
# the inbound contact flow. The scheduled time cannot be in the past. It
|
5796
|
+
# must be within up to 6 days in future.
|
5797
|
+
#
|
5798
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5799
|
+
#
|
5800
|
+
# @example Request syntax with placeholder values
|
5801
|
+
#
|
5802
|
+
# resp = client.update_contact_schedule({
|
5803
|
+
# instance_id: "InstanceId", # required
|
5804
|
+
# contact_id: "ContactId", # required
|
5805
|
+
# scheduled_time: Time.now, # required
|
5806
|
+
# })
|
5807
|
+
#
|
5808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactSchedule AWS API Documentation
|
5809
|
+
#
|
5810
|
+
# @overload update_contact_schedule(params = {})
|
5811
|
+
# @param [Hash] params ({})
|
5812
|
+
def update_contact_schedule(params = {}, options = {})
|
5813
|
+
req = build_request(:update_contact_schedule, params)
|
5814
|
+
req.send_request(options)
|
5815
|
+
end
|
5816
|
+
|
5817
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5818
|
+
# change.
|
5819
|
+
#
|
5111
5820
|
# Updates the hours of operation.
|
5112
5821
|
#
|
5113
5822
|
# @option params [required, String] :instance_id
|
@@ -5680,6 +6389,44 @@ module Aws::Connect
|
|
5680
6389
|
req.send_request(options)
|
5681
6390
|
end
|
5682
6391
|
|
6392
|
+
# This API is in preview release for Amazon Connect and is subject to
|
6393
|
+
# change.
|
6394
|
+
#
|
6395
|
+
# Updates a security profile.
|
6396
|
+
#
|
6397
|
+
# @option params [String] :description
|
6398
|
+
# The description of the security profile.
|
6399
|
+
#
|
6400
|
+
# @option params [Array<String>] :permissions
|
6401
|
+
# The permissions granted to a security profile.
|
6402
|
+
#
|
6403
|
+
# @option params [required, String] :security_profile_id
|
6404
|
+
# The identifier for the security profle.
|
6405
|
+
#
|
6406
|
+
# @option params [required, String] :instance_id
|
6407
|
+
# The identifier of the Amazon Connect instance. You can find the
|
6408
|
+
# instanceId in the ARN of the instance.
|
6409
|
+
#
|
6410
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6411
|
+
#
|
6412
|
+
# @example Request syntax with placeholder values
|
6413
|
+
#
|
6414
|
+
# resp = client.update_security_profile({
|
6415
|
+
# description: "SecurityProfileDescription",
|
6416
|
+
# permissions: ["SecurityProfilePermission"],
|
6417
|
+
# security_profile_id: "SecurityProfileId", # required
|
6418
|
+
# instance_id: "InstanceId", # required
|
6419
|
+
# })
|
6420
|
+
#
|
6421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateSecurityProfile AWS API Documentation
|
6422
|
+
#
|
6423
|
+
# @overload update_security_profile(params = {})
|
6424
|
+
# @param [Hash] params ({})
|
6425
|
+
def update_security_profile(params = {}, options = {})
|
6426
|
+
req = build_request(:update_security_profile, params)
|
6427
|
+
req.send_request(options)
|
6428
|
+
end
|
6429
|
+
|
5683
6430
|
# Assigns the specified hierarchy group to the specified user.
|
5684
6431
|
#
|
5685
6432
|
# @option params [String] :hierarchy_group_id
|
@@ -5944,7 +6691,7 @@ module Aws::Connect
|
|
5944
6691
|
params: params,
|
5945
6692
|
config: config)
|
5946
6693
|
context[:gem_name] = 'aws-sdk-connect'
|
5947
|
-
context[:gem_version] = '1.
|
6694
|
+
context[:gem_version] = '1.58.0'
|
5948
6695
|
Seahorse::Client::Request.new(handlers, context)
|
5949
6696
|
end
|
5950
6697
|
|