aws-sdk-connect 1.56.0 → 1.60.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 +558 -17
- data/lib/aws-sdk-connect/client_api.rb +393 -0
- data/lib/aws-sdk-connect/errors.rb +32 -0
- data/lib/aws-sdk-connect/types.rb +886 -12
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +4 -4
@@ -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
|
#
|
@@ -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
|
@@ -905,8 +977,7 @@ module Aws::Connect
|
|
905
977
|
req.send_request(options)
|
906
978
|
end
|
907
979
|
|
908
|
-
# Creates an
|
909
|
-
# Connect instance.
|
980
|
+
# Creates an AWS resource association with an Amazon Connect instance.
|
910
981
|
#
|
911
982
|
# @option params [required, String] :instance_id
|
912
983
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -1411,6 +1482,63 @@ module Aws::Connect
|
|
1411
1482
|
req.send_request(options)
|
1412
1483
|
end
|
1413
1484
|
|
1485
|
+
# Deletes a contact flow for the specified Amazon Connect instance.
|
1486
|
+
#
|
1487
|
+
# @option params [required, String] :instance_id
|
1488
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1489
|
+
# instanceId in the ARN of the instance.
|
1490
|
+
#
|
1491
|
+
# @option params [required, String] :contact_flow_id
|
1492
|
+
# The identifier of the contact flow.
|
1493
|
+
#
|
1494
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1495
|
+
#
|
1496
|
+
# @example Request syntax with placeholder values
|
1497
|
+
#
|
1498
|
+
# resp = client.delete_contact_flow({
|
1499
|
+
# instance_id: "InstanceId", # required
|
1500
|
+
# contact_flow_id: "ContactFlowId", # required
|
1501
|
+
# })
|
1502
|
+
#
|
1503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlow AWS API Documentation
|
1504
|
+
#
|
1505
|
+
# @overload delete_contact_flow(params = {})
|
1506
|
+
# @param [Hash] params ({})
|
1507
|
+
def delete_contact_flow(params = {}, options = {})
|
1508
|
+
req = build_request(:delete_contact_flow, params)
|
1509
|
+
req.send_request(options)
|
1510
|
+
end
|
1511
|
+
|
1512
|
+
# Deletes the specified contact flow module.
|
1513
|
+
#
|
1514
|
+
# @option params [required, String] :instance_id
|
1515
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1516
|
+
# instanceId in the ARN of the instance.
|
1517
|
+
#
|
1518
|
+
# @option params [required, String] :contact_flow_module_id
|
1519
|
+
# The identifier of the contact flow module.
|
1520
|
+
#
|
1521
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1522
|
+
#
|
1523
|
+
# @example Request syntax with placeholder values
|
1524
|
+
#
|
1525
|
+
# resp = client.delete_contact_flow_module({
|
1526
|
+
# instance_id: "InstanceId", # required
|
1527
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
1528
|
+
# })
|
1529
|
+
#
|
1530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowModule AWS API Documentation
|
1531
|
+
#
|
1532
|
+
# @overload delete_contact_flow_module(params = {})
|
1533
|
+
# @param [Hash] params ({})
|
1534
|
+
def delete_contact_flow_module(params = {}, options = {})
|
1535
|
+
req = build_request(:delete_contact_flow_module, params)
|
1536
|
+
req.send_request(options)
|
1537
|
+
end
|
1538
|
+
|
1539
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1540
|
+
# change.
|
1541
|
+
#
|
1414
1542
|
# Deletes an hours of operation.
|
1415
1543
|
#
|
1416
1544
|
# @option params [required, String] :instance_id
|
@@ -1471,9 +1599,8 @@ module Aws::Connect
|
|
1471
1599
|
req.send_request(options)
|
1472
1600
|
end
|
1473
1601
|
|
1474
|
-
# Deletes an
|
1475
|
-
#
|
1476
|
-
# associated with it.
|
1602
|
+
# Deletes an AWS resource association from an Amazon Connect instance.
|
1603
|
+
# The association must not have any use cases associated with it.
|
1477
1604
|
#
|
1478
1605
|
# @option params [required, String] :instance_id
|
1479
1606
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -1695,6 +1822,60 @@ module Aws::Connect
|
|
1695
1822
|
req.send_request(options)
|
1696
1823
|
end
|
1697
1824
|
|
1825
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1826
|
+
# change.
|
1827
|
+
#
|
1828
|
+
# Describes the specified contact.
|
1829
|
+
#
|
1830
|
+
# Contact information remains available in Amazon Connect for 24 months,
|
1831
|
+
# and then it is deleted.
|
1832
|
+
#
|
1833
|
+
# @option params [required, String] :instance_id
|
1834
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1835
|
+
# instanceId in the ARN of the instance.
|
1836
|
+
#
|
1837
|
+
# @option params [required, String] :contact_id
|
1838
|
+
# The identifier of the contact.
|
1839
|
+
#
|
1840
|
+
# @return [Types::DescribeContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1841
|
+
#
|
1842
|
+
# * {Types::DescribeContactResponse#contact #contact} => Types::Contact
|
1843
|
+
#
|
1844
|
+
# @example Request syntax with placeholder values
|
1845
|
+
#
|
1846
|
+
# resp = client.describe_contact({
|
1847
|
+
# instance_id: "InstanceId", # required
|
1848
|
+
# contact_id: "ContactId", # required
|
1849
|
+
# })
|
1850
|
+
#
|
1851
|
+
# @example Response structure
|
1852
|
+
#
|
1853
|
+
# resp.contact.arn #=> String
|
1854
|
+
# resp.contact.id #=> String
|
1855
|
+
# resp.contact.initial_contact_id #=> String
|
1856
|
+
# resp.contact.previous_contact_id #=> String
|
1857
|
+
# resp.contact.initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API"
|
1858
|
+
# resp.contact.name #=> String
|
1859
|
+
# resp.contact.description #=> String
|
1860
|
+
# resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1861
|
+
# resp.contact.queue_info.id #=> String
|
1862
|
+
# resp.contact.queue_info.enqueue_timestamp #=> Time
|
1863
|
+
# resp.contact.agent_info.id #=> String
|
1864
|
+
# resp.contact.agent_info.connected_to_agent_timestamp #=> Time
|
1865
|
+
# resp.contact.initiation_timestamp #=> Time
|
1866
|
+
# resp.contact.disconnect_timestamp #=> Time
|
1867
|
+
# resp.contact.last_update_timestamp #=> Time
|
1868
|
+
# resp.contact.scheduled_timestamp #=> Time
|
1869
|
+
#
|
1870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContact AWS API Documentation
|
1871
|
+
#
|
1872
|
+
# @overload describe_contact(params = {})
|
1873
|
+
# @param [Hash] params ({})
|
1874
|
+
def describe_contact(params = {}, options = {})
|
1875
|
+
req = build_request(:describe_contact, params)
|
1876
|
+
req.send_request(options)
|
1877
|
+
end
|
1878
|
+
|
1698
1879
|
# Describes the specified contact flow.
|
1699
1880
|
#
|
1700
1881
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -1727,6 +1908,7 @@ module Aws::Connect
|
|
1727
1908
|
# resp.contact_flow.id #=> String
|
1728
1909
|
# resp.contact_flow.name #=> String
|
1729
1910
|
# 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"
|
1911
|
+
# resp.contact_flow.state #=> String, one of "ACTIVE", "ARCHIVED"
|
1730
1912
|
# resp.contact_flow.description #=> String
|
1731
1913
|
# resp.contact_flow.content #=> String
|
1732
1914
|
# resp.contact_flow.tags #=> Hash
|
@@ -1741,6 +1923,50 @@ module Aws::Connect
|
|
1741
1923
|
req.send_request(options)
|
1742
1924
|
end
|
1743
1925
|
|
1926
|
+
# Describes the specified contact flow module.
|
1927
|
+
#
|
1928
|
+
# @option params [required, String] :instance_id
|
1929
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1930
|
+
# instanceId in the ARN of the instance.
|
1931
|
+
#
|
1932
|
+
# @option params [required, String] :contact_flow_module_id
|
1933
|
+
# The identifier of the contact flow module.
|
1934
|
+
#
|
1935
|
+
# @return [Types::DescribeContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1936
|
+
#
|
1937
|
+
# * {Types::DescribeContactFlowModuleResponse#contact_flow_module #contact_flow_module} => Types::ContactFlowModule
|
1938
|
+
#
|
1939
|
+
# @example Request syntax with placeholder values
|
1940
|
+
#
|
1941
|
+
# resp = client.describe_contact_flow_module({
|
1942
|
+
# instance_id: "InstanceId", # required
|
1943
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
1944
|
+
# })
|
1945
|
+
#
|
1946
|
+
# @example Response structure
|
1947
|
+
#
|
1948
|
+
# resp.contact_flow_module.arn #=> String
|
1949
|
+
# resp.contact_flow_module.id #=> String
|
1950
|
+
# resp.contact_flow_module.name #=> String
|
1951
|
+
# resp.contact_flow_module.content #=> String
|
1952
|
+
# resp.contact_flow_module.description #=> String
|
1953
|
+
# resp.contact_flow_module.state #=> String, one of "ACTIVE", "ARCHIVED"
|
1954
|
+
# resp.contact_flow_module.status #=> String, one of "PUBLISHED", "SAVED"
|
1955
|
+
# resp.contact_flow_module.tags #=> Hash
|
1956
|
+
# resp.contact_flow_module.tags["TagKey"] #=> String
|
1957
|
+
#
|
1958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowModule AWS API Documentation
|
1959
|
+
#
|
1960
|
+
# @overload describe_contact_flow_module(params = {})
|
1961
|
+
# @param [Hash] params ({})
|
1962
|
+
def describe_contact_flow_module(params = {}, options = {})
|
1963
|
+
req = build_request(:describe_contact_flow_module, params)
|
1964
|
+
req.send_request(options)
|
1965
|
+
end
|
1966
|
+
|
1967
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1968
|
+
# change.
|
1969
|
+
#
|
1744
1970
|
# Describes the hours of operation.
|
1745
1971
|
#
|
1746
1972
|
# @option params [required, String] :instance_id
|
@@ -3244,6 +3470,58 @@ module Aws::Connect
|
|
3244
3470
|
req.send_request(options)
|
3245
3471
|
end
|
3246
3472
|
|
3473
|
+
# Provides information about the contact flow modules for the specified
|
3474
|
+
# Amazon Connect instance.
|
3475
|
+
#
|
3476
|
+
# @option params [required, String] :instance_id
|
3477
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3478
|
+
# instanceId in the ARN of the instance.
|
3479
|
+
#
|
3480
|
+
# @option params [String] :next_token
|
3481
|
+
# The token for the next set of results. Use the value returned in the
|
3482
|
+
# previous response in the next request to retrieve the next set of
|
3483
|
+
# results.
|
3484
|
+
#
|
3485
|
+
# @option params [Integer] :max_results
|
3486
|
+
# The maximum number of results to return per page.
|
3487
|
+
#
|
3488
|
+
# @option params [String] :contact_flow_module_state
|
3489
|
+
# The state of the contact flow module.
|
3490
|
+
#
|
3491
|
+
# @return [Types::ListContactFlowModulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3492
|
+
#
|
3493
|
+
# * {Types::ListContactFlowModulesResponse#contact_flow_modules_summary_list #contact_flow_modules_summary_list} => Array<Types::ContactFlowModuleSummary>
|
3494
|
+
# * {Types::ListContactFlowModulesResponse#next_token #next_token} => String
|
3495
|
+
#
|
3496
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3497
|
+
#
|
3498
|
+
# @example Request syntax with placeholder values
|
3499
|
+
#
|
3500
|
+
# resp = client.list_contact_flow_modules({
|
3501
|
+
# instance_id: "InstanceId", # required
|
3502
|
+
# next_token: "NextToken",
|
3503
|
+
# max_results: 1,
|
3504
|
+
# contact_flow_module_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
3505
|
+
# })
|
3506
|
+
#
|
3507
|
+
# @example Response structure
|
3508
|
+
#
|
3509
|
+
# resp.contact_flow_modules_summary_list #=> Array
|
3510
|
+
# resp.contact_flow_modules_summary_list[0].id #=> String
|
3511
|
+
# resp.contact_flow_modules_summary_list[0].arn #=> String
|
3512
|
+
# resp.contact_flow_modules_summary_list[0].name #=> String
|
3513
|
+
# resp.contact_flow_modules_summary_list[0].state #=> String, one of "ACTIVE", "ARCHIVED"
|
3514
|
+
# resp.next_token #=> String
|
3515
|
+
#
|
3516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowModules AWS API Documentation
|
3517
|
+
#
|
3518
|
+
# @overload list_contact_flow_modules(params = {})
|
3519
|
+
# @param [Hash] params ({})
|
3520
|
+
def list_contact_flow_modules(params = {}, options = {})
|
3521
|
+
req = build_request(:list_contact_flow_modules, params)
|
3522
|
+
req.send_request(options)
|
3523
|
+
end
|
3524
|
+
|
3247
3525
|
# Provides information about the contact flows for the specified Amazon
|
3248
3526
|
# Connect instance.
|
3249
3527
|
#
|
@@ -3296,6 +3574,7 @@ module Aws::Connect
|
|
3296
3574
|
# resp.contact_flow_summary_list[0].arn #=> String
|
3297
3575
|
# resp.contact_flow_summary_list[0].name #=> String
|
3298
3576
|
# 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"
|
3577
|
+
# resp.contact_flow_summary_list[0].contact_flow_state #=> String, one of "ACTIVE", "ARCHIVED"
|
3299
3578
|
# resp.next_token #=> String
|
3300
3579
|
#
|
3301
3580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
|
@@ -3307,6 +3586,65 @@ module Aws::Connect
|
|
3307
3586
|
req.send_request(options)
|
3308
3587
|
end
|
3309
3588
|
|
3589
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3590
|
+
# change.
|
3591
|
+
#
|
3592
|
+
# For the specified `referenceTypes`, returns a list of references
|
3593
|
+
# associated with the contact.
|
3594
|
+
#
|
3595
|
+
# @option params [required, String] :instance_id
|
3596
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3597
|
+
# instanceId in the ARN of the instance.
|
3598
|
+
#
|
3599
|
+
# @option params [required, String] :contact_id
|
3600
|
+
# The identifier of the initial contact.
|
3601
|
+
#
|
3602
|
+
# @option params [required, Array<String>] :reference_types
|
3603
|
+
# The type of reference.
|
3604
|
+
#
|
3605
|
+
# @option params [String] :next_token
|
3606
|
+
# The token for the next set of results. Use the value returned in the
|
3607
|
+
# previous response in the next request to retrieve the next set of
|
3608
|
+
# results.
|
3609
|
+
#
|
3610
|
+
# This is not expected to be set, because the value returned in the
|
3611
|
+
# previous response is always null.
|
3612
|
+
#
|
3613
|
+
# @return [Types::ListContactReferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3614
|
+
#
|
3615
|
+
# * {Types::ListContactReferencesResponse#reference_summary_list #reference_summary_list} => Array<Types::ReferenceSummary>
|
3616
|
+
# * {Types::ListContactReferencesResponse#next_token #next_token} => String
|
3617
|
+
#
|
3618
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3619
|
+
#
|
3620
|
+
# @example Request syntax with placeholder values
|
3621
|
+
#
|
3622
|
+
# resp = client.list_contact_references({
|
3623
|
+
# instance_id: "InstanceId", # required
|
3624
|
+
# contact_id: "ContactId", # required
|
3625
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT
|
3626
|
+
# next_token: "NextToken",
|
3627
|
+
# })
|
3628
|
+
#
|
3629
|
+
# @example Response structure
|
3630
|
+
#
|
3631
|
+
# resp.reference_summary_list #=> Array
|
3632
|
+
# resp.reference_summary_list[0].url.name #=> String
|
3633
|
+
# resp.reference_summary_list[0].url.value #=> String
|
3634
|
+
# resp.reference_summary_list[0].attachment.name #=> String
|
3635
|
+
# resp.reference_summary_list[0].attachment.value #=> String
|
3636
|
+
# resp.reference_summary_list[0].attachment.status #=> String, one of "APPROVED", "REJECTED"
|
3637
|
+
# resp.next_token #=> String
|
3638
|
+
#
|
3639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferences AWS API Documentation
|
3640
|
+
#
|
3641
|
+
# @overload list_contact_references(params = {})
|
3642
|
+
# @param [Hash] params ({})
|
3643
|
+
def list_contact_references(params = {}, options = {})
|
3644
|
+
req = build_request(:list_contact_references, params)
|
3645
|
+
req.send_request(options)
|
3646
|
+
end
|
3647
|
+
|
3310
3648
|
# Provides information about the hours of operation for the specified
|
3311
3649
|
# Amazon Connect instance.
|
3312
3650
|
#
|
@@ -3526,15 +3864,15 @@ module Aws::Connect
|
|
3526
3864
|
req.send_request(options)
|
3527
3865
|
end
|
3528
3866
|
|
3529
|
-
# Provides summary information about the
|
3530
|
-
#
|
3867
|
+
# Provides summary information about the AWS resource associations for
|
3868
|
+
# the specified Amazon Connect instance.
|
3531
3869
|
#
|
3532
3870
|
# @option params [required, String] :instance_id
|
3533
3871
|
# The identifier of the Amazon Connect instance. You can find the
|
3534
3872
|
# instanceId in the ARN of the instance.
|
3535
3873
|
#
|
3536
3874
|
# @option params [String] :integration_type
|
3537
|
-
# The type
|
3875
|
+
# The integration type.
|
3538
3876
|
#
|
3539
3877
|
# @option params [String] :next_token
|
3540
3878
|
# The token for the next set of results. Use the value returned in the
|
@@ -4174,9 +4512,6 @@ module Aws::Connect
|
|
4174
4512
|
req.send_request(options)
|
4175
4513
|
end
|
4176
4514
|
|
4177
|
-
# This API is in preview release for Amazon Connect and is subject to
|
4178
|
-
# change.
|
4179
|
-
#
|
4180
4515
|
# Provides summary information about the security profiles for the
|
4181
4516
|
# specified Amazon Connect instance.
|
4182
4517
|
#
|
@@ -4838,6 +5173,11 @@ module Aws::Connect
|
|
4838
5173
|
# **A suitable default value is auto-generated.** You should normally
|
4839
5174
|
# not need to pass this option.**
|
4840
5175
|
#
|
5176
|
+
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
5177
|
+
# The timestamp, in Unix Epoch seconds format, at which to start running
|
5178
|
+
# the inbound contact flow. The scheduled time cannot be in the past. It
|
5179
|
+
# must be within up to 6 days in future.
|
5180
|
+
#
|
4841
5181
|
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4842
5182
|
#
|
4843
5183
|
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
@@ -4855,11 +5195,12 @@ module Aws::Connect
|
|
4855
5195
|
# references: {
|
4856
5196
|
# "ReferenceKey" => {
|
4857
5197
|
# value: "ReferenceValue", # required
|
4858
|
-
# type: "URL", # required, accepts URL
|
5198
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
4859
5199
|
# },
|
4860
5200
|
# },
|
4861
5201
|
# description: "Description",
|
4862
5202
|
# client_token: "ClientToken",
|
5203
|
+
# scheduled_time: Time.now,
|
4863
5204
|
# })
|
4864
5205
|
#
|
4865
5206
|
# @example Response structure
|
@@ -5134,6 +5475,60 @@ module Aws::Connect
|
|
5134
5475
|
req.send_request(options)
|
5135
5476
|
end
|
5136
5477
|
|
5478
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5479
|
+
# change.
|
5480
|
+
#
|
5481
|
+
# Adds or updates user-defined contact information associated with the
|
5482
|
+
# specified contact. At least one field to be updated must be present in
|
5483
|
+
# the request.
|
5484
|
+
#
|
5485
|
+
# You can add or update user-defined contact information for both
|
5486
|
+
# ongoing and completed contacts.
|
5487
|
+
#
|
5488
|
+
# @option params [required, String] :instance_id
|
5489
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5490
|
+
# instanceId in the ARN of the instance.
|
5491
|
+
#
|
5492
|
+
# @option params [required, String] :contact_id
|
5493
|
+
# The identifier of the contact. This is the identifier of the contact
|
5494
|
+
# associated with the first interaction with your contact center.
|
5495
|
+
#
|
5496
|
+
# @option params [String] :name
|
5497
|
+
# The name of the contact.
|
5498
|
+
#
|
5499
|
+
# @option params [String] :description
|
5500
|
+
# The description of the contact.
|
5501
|
+
#
|
5502
|
+
# @option params [Hash<String,Types::Reference>] :references
|
5503
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
5504
|
+
# (CCP).
|
5505
|
+
#
|
5506
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5507
|
+
#
|
5508
|
+
# @example Request syntax with placeholder values
|
5509
|
+
#
|
5510
|
+
# resp = client.update_contact({
|
5511
|
+
# instance_id: "InstanceId", # required
|
5512
|
+
# contact_id: "ContactId", # required
|
5513
|
+
# name: "Name",
|
5514
|
+
# description: "Description",
|
5515
|
+
# references: {
|
5516
|
+
# "ReferenceKey" => {
|
5517
|
+
# value: "ReferenceValue", # required
|
5518
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
5519
|
+
# },
|
5520
|
+
# },
|
5521
|
+
# })
|
5522
|
+
#
|
5523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContact AWS API Documentation
|
5524
|
+
#
|
5525
|
+
# @overload update_contact(params = {})
|
5526
|
+
# @param [Hash] params ({})
|
5527
|
+
def update_contact(params = {}, options = {})
|
5528
|
+
req = build_request(:update_contact, params)
|
5529
|
+
req.send_request(options)
|
5530
|
+
end
|
5531
|
+
|
5137
5532
|
# Creates or updates user-defined contact attributes associated with the
|
5138
5533
|
# specified contact.
|
5139
5534
|
#
|
@@ -5245,6 +5640,116 @@ module Aws::Connect
|
|
5245
5640
|
req.send_request(options)
|
5246
5641
|
end
|
5247
5642
|
|
5643
|
+
# Updates metadata about specified contact flow.
|
5644
|
+
#
|
5645
|
+
# @option params [required, String] :instance_id
|
5646
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5647
|
+
# instanceId in the ARN of the instance.
|
5648
|
+
#
|
5649
|
+
# @option params [required, String] :contact_flow_id
|
5650
|
+
# The identifier of the contact flow.
|
5651
|
+
#
|
5652
|
+
# @option params [String] :name
|
5653
|
+
# TThe name of the contact flow.
|
5654
|
+
#
|
5655
|
+
# @option params [String] :description
|
5656
|
+
# The description of the contact flow.
|
5657
|
+
#
|
5658
|
+
# @option params [String] :contact_flow_state
|
5659
|
+
# The state of contact flow.
|
5660
|
+
#
|
5661
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5662
|
+
#
|
5663
|
+
# @example Request syntax with placeholder values
|
5664
|
+
#
|
5665
|
+
# resp = client.update_contact_flow_metadata({
|
5666
|
+
# instance_id: "InstanceId", # required
|
5667
|
+
# contact_flow_id: "ContactFlowId", # required
|
5668
|
+
# name: "ContactFlowName",
|
5669
|
+
# description: "ContactFlowDescription",
|
5670
|
+
# contact_flow_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
5671
|
+
# })
|
5672
|
+
#
|
5673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowMetadata AWS API Documentation
|
5674
|
+
#
|
5675
|
+
# @overload update_contact_flow_metadata(params = {})
|
5676
|
+
# @param [Hash] params ({})
|
5677
|
+
def update_contact_flow_metadata(params = {}, options = {})
|
5678
|
+
req = build_request(:update_contact_flow_metadata, params)
|
5679
|
+
req.send_request(options)
|
5680
|
+
end
|
5681
|
+
|
5682
|
+
# Updates specified contact flow module for the specified Amazon Connect
|
5683
|
+
# instance.
|
5684
|
+
#
|
5685
|
+
# @option params [required, String] :instance_id
|
5686
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5687
|
+
# instanceId in the ARN of the instance.
|
5688
|
+
#
|
5689
|
+
# @option params [required, String] :contact_flow_module_id
|
5690
|
+
# The identifier of the contact flow module.
|
5691
|
+
#
|
5692
|
+
# @option params [required, String] :content
|
5693
|
+
# The content of the contact flow module.
|
5694
|
+
#
|
5695
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5696
|
+
#
|
5697
|
+
# @example Request syntax with placeholder values
|
5698
|
+
#
|
5699
|
+
# resp = client.update_contact_flow_module_content({
|
5700
|
+
# instance_id: "InstanceId", # required
|
5701
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
5702
|
+
# content: "ContactFlowModuleContent", # required
|
5703
|
+
# })
|
5704
|
+
#
|
5705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContent AWS API Documentation
|
5706
|
+
#
|
5707
|
+
# @overload update_contact_flow_module_content(params = {})
|
5708
|
+
# @param [Hash] params ({})
|
5709
|
+
def update_contact_flow_module_content(params = {}, options = {})
|
5710
|
+
req = build_request(:update_contact_flow_module_content, params)
|
5711
|
+
req.send_request(options)
|
5712
|
+
end
|
5713
|
+
|
5714
|
+
# Updates metadata about specified contact flow module.
|
5715
|
+
#
|
5716
|
+
# @option params [required, String] :instance_id
|
5717
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5718
|
+
# instanceId in the ARN of the instance.
|
5719
|
+
#
|
5720
|
+
# @option params [required, String] :contact_flow_module_id
|
5721
|
+
# The identifier of the contact flow module.
|
5722
|
+
#
|
5723
|
+
# @option params [String] :name
|
5724
|
+
# The name of the contact flow module.
|
5725
|
+
#
|
5726
|
+
# @option params [String] :description
|
5727
|
+
# The description of the contact flow module.
|
5728
|
+
#
|
5729
|
+
# @option params [String] :state
|
5730
|
+
# The state of contact flow module.
|
5731
|
+
#
|
5732
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5733
|
+
#
|
5734
|
+
# @example Request syntax with placeholder values
|
5735
|
+
#
|
5736
|
+
# resp = client.update_contact_flow_module_metadata({
|
5737
|
+
# instance_id: "InstanceId", # required
|
5738
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
5739
|
+
# name: "ContactFlowModuleName",
|
5740
|
+
# description: "ContactFlowModuleDescription",
|
5741
|
+
# state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
5742
|
+
# })
|
5743
|
+
#
|
5744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleMetadata AWS API Documentation
|
5745
|
+
#
|
5746
|
+
# @overload update_contact_flow_module_metadata(params = {})
|
5747
|
+
# @param [Hash] params ({})
|
5748
|
+
def update_contact_flow_module_metadata(params = {}, options = {})
|
5749
|
+
req = build_request(:update_contact_flow_module_metadata, params)
|
5750
|
+
req.send_request(options)
|
5751
|
+
end
|
5752
|
+
|
5248
5753
|
# The name of the contact flow.
|
5249
5754
|
#
|
5250
5755
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -5286,6 +5791,43 @@ module Aws::Connect
|
|
5286
5791
|
req.send_request(options)
|
5287
5792
|
end
|
5288
5793
|
|
5794
|
+
# Updates the scheduled time of a task contact that is already
|
5795
|
+
# scheduled.
|
5796
|
+
#
|
5797
|
+
# @option params [required, String] :instance_id
|
5798
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5799
|
+
# instanceId in the ARN of the instance.
|
5800
|
+
#
|
5801
|
+
# @option params [required, String] :contact_id
|
5802
|
+
# The identifier of the contact.
|
5803
|
+
#
|
5804
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :scheduled_time
|
5805
|
+
# The timestamp, in Unix Epoch seconds format, at which to start running
|
5806
|
+
# the inbound contact flow. The scheduled time cannot be in the past. It
|
5807
|
+
# must be within up to 6 days in future.
|
5808
|
+
#
|
5809
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5810
|
+
#
|
5811
|
+
# @example Request syntax with placeholder values
|
5812
|
+
#
|
5813
|
+
# resp = client.update_contact_schedule({
|
5814
|
+
# instance_id: "InstanceId", # required
|
5815
|
+
# contact_id: "ContactId", # required
|
5816
|
+
# scheduled_time: Time.now, # required
|
5817
|
+
# })
|
5818
|
+
#
|
5819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactSchedule AWS API Documentation
|
5820
|
+
#
|
5821
|
+
# @overload update_contact_schedule(params = {})
|
5822
|
+
# @param [Hash] params ({})
|
5823
|
+
def update_contact_schedule(params = {}, options = {})
|
5824
|
+
req = build_request(:update_contact_schedule, params)
|
5825
|
+
req.send_request(options)
|
5826
|
+
end
|
5827
|
+
|
5828
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5829
|
+
# change.
|
5830
|
+
#
|
5289
5831
|
# Updates the hours of operation.
|
5290
5832
|
#
|
5291
5833
|
# @option params [required, String] :instance_id
|
@@ -5354,8 +5896,7 @@ module Aws::Connect
|
|
5354
5896
|
# The type of attribute.
|
5355
5897
|
#
|
5356
5898
|
# <note markdown="1"> Only allowlisted customers can consume USE\_CUSTOM\_TTS\_VOICES. To
|
5357
|
-
# access this feature, contact
|
5358
|
-
# allowlisting.
|
5899
|
+
# access this feature, contact AWS Support for allowlisting.
|
5359
5900
|
#
|
5360
5901
|
# </note>
|
5361
5902
|
#
|
@@ -6161,7 +6702,7 @@ module Aws::Connect
|
|
6161
6702
|
params: params,
|
6162
6703
|
config: config)
|
6163
6704
|
context[:gem_name] = 'aws-sdk-connect'
|
6164
|
-
context[:gem_version] = '1.
|
6705
|
+
context[:gem_version] = '1.60.0'
|
6165
6706
|
Seahorse::Client::Request.new(handlers, context)
|
6166
6707
|
end
|
6167
6708
|
|