aws-sdk-connect 1.20.0 → 1.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-connect.rb +7 -4
- data/lib/aws-sdk-connect/client.rb +286 -21
- data/lib/aws-sdk-connect/client_api.rb +110 -0
- data/lib/aws-sdk-connect/errors.rb +33 -11
- data/lib/aws-sdk-connect/resource.rb +1 -0
- data/lib/aws-sdk-connect/types.rb +251 -7
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 02f1a66f20d6d0ab95c1cc72d58799b300091ef0cb8d630d6ff681fcf151eb94
|
4
|
+
data.tar.gz: c023e6a2706d5fa7b3e242b556c0be10505583a0bf192b52c14c48a285f71c7b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 838afd12d3686b6a2c92bade218448a2f71522e32ae60475d3f5468f156e5a4f50c3e54c2de05382d486006deef4bd733e3373b8f706d74a785bfc8ea675d393
|
7
|
+
data.tar.gz: e91a3fcc975bb15dc0bdf78a5c56f0fc919525d12950c0626126e4aa5cba5c43ccec203808cc08baedd8248c03d9cb6ac009efeb8cd7cfffd351b0a6ba4d4424
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-connect/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# connect = Aws::Connect::Client.new
|
28
|
+
# resp = connect.create_user(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon Connect Service
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon Connect Service are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Connect::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon Connect Service API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-connect/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Connect
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.25.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:connect)
|
31
31
|
|
32
32
|
module Aws::Connect
|
33
|
+
# An API client for Connect. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Connect::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Connect
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Connect
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Connect
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Connect
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Connect
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Connect
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Connect
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::Connect
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::Connect
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -298,6 +352,9 @@ module Aws::Connect
|
|
298
352
|
# @option params [required, String] :instance_id
|
299
353
|
# The identifier of the Amazon Connect instance.
|
300
354
|
#
|
355
|
+
# @option params [Hash<String,String>] :tags
|
356
|
+
# One or more tags.
|
357
|
+
#
|
301
358
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
302
359
|
#
|
303
360
|
# * {Types::CreateUserResponse#user_id #user_id} => String
|
@@ -324,6 +381,9 @@ module Aws::Connect
|
|
324
381
|
# routing_profile_id: "RoutingProfileId", # required
|
325
382
|
# hierarchy_group_id: "HierarchyGroupId",
|
326
383
|
# instance_id: "InstanceId", # required
|
384
|
+
# tags: {
|
385
|
+
# "TagKey" => "TagValue",
|
386
|
+
# },
|
327
387
|
# })
|
328
388
|
#
|
329
389
|
# @example Response structure
|
@@ -366,7 +426,10 @@ module Aws::Connect
|
|
366
426
|
req.send_request(options)
|
367
427
|
end
|
368
428
|
|
369
|
-
# Describes the specified user account.
|
429
|
+
# Describes the specified user account. You can find the instance ID in
|
430
|
+
# the console (it’s the final part of the ARN). The console does not
|
431
|
+
# display the user IDs. Instead, list the users and note the IDs
|
432
|
+
# provided in the output.
|
370
433
|
#
|
371
434
|
# @option params [required, String] :user_id
|
372
435
|
# The identifier of the user account.
|
@@ -402,6 +465,8 @@ module Aws::Connect
|
|
402
465
|
# resp.user.security_profile_ids[0] #=> String
|
403
466
|
# resp.user.routing_profile_id #=> String
|
404
467
|
# resp.user.hierarchy_group_id #=> String
|
468
|
+
# resp.user.tags #=> Hash
|
469
|
+
# resp.user.tags["TagKey"] #=> String
|
405
470
|
#
|
406
471
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser AWS API Documentation
|
407
472
|
#
|
@@ -591,6 +656,10 @@ module Aws::Connect
|
|
591
656
|
#
|
592
657
|
# : Unit: COUNT
|
593
658
|
#
|
659
|
+
# AGENTS\_ON\_CONTACT
|
660
|
+
#
|
661
|
+
# : Unit: COUNT
|
662
|
+
#
|
594
663
|
# AGENTS\_ONLINE
|
595
664
|
#
|
596
665
|
# : Unit: COUNT
|
@@ -611,6 +680,14 @@ module Aws::Connect
|
|
611
680
|
#
|
612
681
|
# : Unit: SECONDS
|
613
682
|
#
|
683
|
+
# SLOTS\_ACTIVE
|
684
|
+
#
|
685
|
+
# : Unit: COUNT
|
686
|
+
#
|
687
|
+
# SLOTS\_AVAILABLE
|
688
|
+
#
|
689
|
+
# : Unit: COUNT
|
690
|
+
#
|
614
691
|
# @option params [String] :next_token
|
615
692
|
# The token for the next set of results. Use the value returned in the
|
616
693
|
# previous response in the next request to retrieve the next set of
|
@@ -629,18 +706,20 @@ module Aws::Connect
|
|
629
706
|
# * {Types::GetCurrentMetricDataResponse#metric_results #metric_results} => Array<Types::CurrentMetricResult>
|
630
707
|
# * {Types::GetCurrentMetricDataResponse#data_snapshot_time #data_snapshot_time} => Time
|
631
708
|
#
|
709
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
710
|
+
#
|
632
711
|
# @example Request syntax with placeholder values
|
633
712
|
#
|
634
713
|
# resp = client.get_current_metric_data({
|
635
714
|
# instance_id: "InstanceId", # required
|
636
715
|
# filters: { # required
|
637
716
|
# queues: ["QueueId"],
|
638
|
-
# channels: ["VOICE"], # accepts VOICE
|
717
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
639
718
|
# },
|
640
719
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
641
720
|
# current_metrics: [ # required
|
642
721
|
# {
|
643
|
-
# 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
|
722
|
+
# 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
|
644
723
|
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
645
724
|
# },
|
646
725
|
# ],
|
@@ -654,9 +733,9 @@ module Aws::Connect
|
|
654
733
|
# resp.metric_results #=> Array
|
655
734
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
656
735
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
657
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
|
736
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
658
737
|
# resp.metric_results[0].collections #=> Array
|
659
|
-
# 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"
|
738
|
+
# 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"
|
660
739
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
661
740
|
# resp.metric_results[0].collections[0].value #=> Float
|
662
741
|
# resp.data_snapshot_time #=> Time
|
@@ -921,6 +1000,8 @@ module Aws::Connect
|
|
921
1000
|
# * {Types::GetMetricDataResponse#next_token #next_token} => String
|
922
1001
|
# * {Types::GetMetricDataResponse#metric_results #metric_results} => Array<Types::HistoricalMetricResult>
|
923
1002
|
#
|
1003
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1004
|
+
#
|
924
1005
|
# @example Request syntax with placeholder values
|
925
1006
|
#
|
926
1007
|
# resp = client.get_metric_data({
|
@@ -929,7 +1010,7 @@ module Aws::Connect
|
|
929
1010
|
# end_time: Time.now, # required
|
930
1011
|
# filters: { # required
|
931
1012
|
# queues: ["QueueId"],
|
932
|
-
# channels: ["VOICE"], # accepts VOICE
|
1013
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
933
1014
|
# },
|
934
1015
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
935
1016
|
# historical_metrics: [ # required
|
@@ -953,7 +1034,7 @@ module Aws::Connect
|
|
953
1034
|
# resp.metric_results #=> Array
|
954
1035
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
955
1036
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
956
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
|
1037
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
957
1038
|
# resp.metric_results[0].collections #=> Array
|
958
1039
|
# 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"
|
959
1040
|
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
@@ -993,6 +1074,8 @@ module Aws::Connect
|
|
993
1074
|
# * {Types::ListContactFlowsResponse#contact_flow_summary_list #contact_flow_summary_list} => Array<Types::ContactFlowSummary>
|
994
1075
|
# * {Types::ListContactFlowsResponse#next_token #next_token} => String
|
995
1076
|
#
|
1077
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1078
|
+
#
|
996
1079
|
# @example Request syntax with placeholder values
|
997
1080
|
#
|
998
1081
|
# resp = client.list_contact_flows({
|
@@ -1039,6 +1122,8 @@ module Aws::Connect
|
|
1039
1122
|
# * {Types::ListHoursOfOperationsResponse#hours_of_operation_summary_list #hours_of_operation_summary_list} => Array<Types::HoursOfOperationSummary>
|
1040
1123
|
# * {Types::ListHoursOfOperationsResponse#next_token #next_token} => String
|
1041
1124
|
#
|
1125
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1126
|
+
#
|
1042
1127
|
# @example Request syntax with placeholder values
|
1043
1128
|
#
|
1044
1129
|
# resp = client.list_hours_of_operations({
|
@@ -1089,6 +1174,8 @@ module Aws::Connect
|
|
1089
1174
|
# * {Types::ListPhoneNumbersResponse#phone_number_summary_list #phone_number_summary_list} => Array<Types::PhoneNumberSummary>
|
1090
1175
|
# * {Types::ListPhoneNumbersResponse#next_token #next_token} => String
|
1091
1176
|
#
|
1177
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1178
|
+
#
|
1092
1179
|
# @example Request syntax with placeholder values
|
1093
1180
|
#
|
1094
1181
|
# resp = client.list_phone_numbers({
|
@@ -1140,6 +1227,8 @@ module Aws::Connect
|
|
1140
1227
|
# * {Types::ListQueuesResponse#queue_summary_list #queue_summary_list} => Array<Types::QueueSummary>
|
1141
1228
|
# * {Types::ListQueuesResponse#next_token #next_token} => String
|
1142
1229
|
#
|
1230
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1231
|
+
#
|
1143
1232
|
# @example Request syntax with placeholder values
|
1144
1233
|
#
|
1145
1234
|
# resp = client.list_queues({
|
@@ -1186,6 +1275,8 @@ module Aws::Connect
|
|
1186
1275
|
# * {Types::ListRoutingProfilesResponse#routing_profile_summary_list #routing_profile_summary_list} => Array<Types::RoutingProfileSummary>
|
1187
1276
|
# * {Types::ListRoutingProfilesResponse#next_token #next_token} => String
|
1188
1277
|
#
|
1278
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1279
|
+
#
|
1189
1280
|
# @example Request syntax with placeholder values
|
1190
1281
|
#
|
1191
1282
|
# resp = client.list_routing_profiles({
|
@@ -1230,6 +1321,8 @@ module Aws::Connect
|
|
1230
1321
|
# * {Types::ListSecurityProfilesResponse#security_profile_summary_list #security_profile_summary_list} => Array<Types::SecurityProfileSummary>
|
1231
1322
|
# * {Types::ListSecurityProfilesResponse#next_token #next_token} => String
|
1232
1323
|
#
|
1324
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1325
|
+
#
|
1233
1326
|
# @example Request syntax with placeholder values
|
1234
1327
|
#
|
1235
1328
|
# resp = client.list_security_profiles({
|
@@ -1255,6 +1348,35 @@ module Aws::Connect
|
|
1255
1348
|
req.send_request(options)
|
1256
1349
|
end
|
1257
1350
|
|
1351
|
+
# Lists the tags for the specified resource.
|
1352
|
+
#
|
1353
|
+
# @option params [required, String] :resource_arn
|
1354
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1355
|
+
#
|
1356
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1357
|
+
#
|
1358
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1359
|
+
#
|
1360
|
+
# @example Request syntax with placeholder values
|
1361
|
+
#
|
1362
|
+
# resp = client.list_tags_for_resource({
|
1363
|
+
# resource_arn: "ARN", # required
|
1364
|
+
# })
|
1365
|
+
#
|
1366
|
+
# @example Response structure
|
1367
|
+
#
|
1368
|
+
# resp.tags #=> Hash
|
1369
|
+
# resp.tags["TagKey"] #=> String
|
1370
|
+
#
|
1371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTagsForResource AWS API Documentation
|
1372
|
+
#
|
1373
|
+
# @overload list_tags_for_resource(params = {})
|
1374
|
+
# @param [Hash] params ({})
|
1375
|
+
def list_tags_for_resource(params = {}, options = {})
|
1376
|
+
req = build_request(:list_tags_for_resource, params)
|
1377
|
+
req.send_request(options)
|
1378
|
+
end
|
1379
|
+
|
1258
1380
|
# Provides summary information about the hierarchy groups for the
|
1259
1381
|
# specified Amazon Connect instance.
|
1260
1382
|
#
|
@@ -1274,6 +1396,8 @@ module Aws::Connect
|
|
1274
1396
|
# * {Types::ListUserHierarchyGroupsResponse#user_hierarchy_group_summary_list #user_hierarchy_group_summary_list} => Array<Types::HierarchyGroupSummary>
|
1275
1397
|
# * {Types::ListUserHierarchyGroupsResponse#next_token #next_token} => String
|
1276
1398
|
#
|
1399
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1400
|
+
#
|
1277
1401
|
# @example Request syntax with placeholder values
|
1278
1402
|
#
|
1279
1403
|
# resp = client.list_user_hierarchy_groups({
|
@@ -1318,6 +1442,8 @@ module Aws::Connect
|
|
1318
1442
|
# * {Types::ListUsersResponse#user_summary_list #user_summary_list} => Array<Types::UserSummary>
|
1319
1443
|
# * {Types::ListUsersResponse#next_token #next_token} => String
|
1320
1444
|
#
|
1445
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1446
|
+
#
|
1321
1447
|
# @example Request syntax with placeholder values
|
1322
1448
|
#
|
1323
1449
|
# resp = client.list_users({
|
@@ -1343,6 +1469,88 @@ module Aws::Connect
|
|
1343
1469
|
req.send_request(options)
|
1344
1470
|
end
|
1345
1471
|
|
1472
|
+
# Initiates a contact flow to start a new chat for the customer.
|
1473
|
+
# Response of this API provides a token required to obtain credentials
|
1474
|
+
# from the [CreateParticipantConnection][1] API in the Amazon Connect
|
1475
|
+
# Participant Service.
|
1476
|
+
#
|
1477
|
+
# When a new chat contact is successfully created, clients need to
|
1478
|
+
# subscribe to the participant’s connection for the created chat within
|
1479
|
+
# 5 minutes. This is achieved by invoking
|
1480
|
+
# [CreateParticipantConnection][1] with WEBSOCKET and
|
1481
|
+
# CONNECTION\_CREDENTIALS.
|
1482
|
+
#
|
1483
|
+
#
|
1484
|
+
#
|
1485
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
1486
|
+
#
|
1487
|
+
# @option params [required, String] :instance_id
|
1488
|
+
# The identifier of the Amazon Connect instance.
|
1489
|
+
#
|
1490
|
+
# @option params [required, String] :contact_flow_id
|
1491
|
+
# The identifier of the contact flow for the chat.
|
1492
|
+
#
|
1493
|
+
# @option params [Hash<String,String>] :attributes
|
1494
|
+
# A custom key-value pair using an attribute map. The attributes are
|
1495
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
1496
|
+
# flows just like any other contact attributes.
|
1497
|
+
#
|
1498
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
1499
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
1500
|
+
# underscore characters.
|
1501
|
+
#
|
1502
|
+
# @option params [required, Types::ParticipantDetails] :participant_details
|
1503
|
+
# Information identifying the participant.
|
1504
|
+
#
|
1505
|
+
# @option params [Types::ChatMessage] :initial_message
|
1506
|
+
# The initial message to be sent to the newly created chat.
|
1507
|
+
#
|
1508
|
+
# @option params [String] :client_token
|
1509
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1510
|
+
# idempotency of the request.
|
1511
|
+
#
|
1512
|
+
# **A suitable default value is auto-generated.** You should normally
|
1513
|
+
# not need to pass this option.**
|
1514
|
+
#
|
1515
|
+
# @return [Types::StartChatContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1516
|
+
#
|
1517
|
+
# * {Types::StartChatContactResponse#contact_id #contact_id} => String
|
1518
|
+
# * {Types::StartChatContactResponse#participant_id #participant_id} => String
|
1519
|
+
# * {Types::StartChatContactResponse#participant_token #participant_token} => String
|
1520
|
+
#
|
1521
|
+
# @example Request syntax with placeholder values
|
1522
|
+
#
|
1523
|
+
# resp = client.start_chat_contact({
|
1524
|
+
# instance_id: "InstanceId", # required
|
1525
|
+
# contact_flow_id: "ContactFlowId", # required
|
1526
|
+
# attributes: {
|
1527
|
+
# "AttributeName" => "AttributeValue",
|
1528
|
+
# },
|
1529
|
+
# participant_details: { # required
|
1530
|
+
# display_name: "DisplayName", # required
|
1531
|
+
# },
|
1532
|
+
# initial_message: {
|
1533
|
+
# content_type: "ChatContentType", # required
|
1534
|
+
# content: "ChatContent", # required
|
1535
|
+
# },
|
1536
|
+
# client_token: "ClientToken",
|
1537
|
+
# })
|
1538
|
+
#
|
1539
|
+
# @example Response structure
|
1540
|
+
#
|
1541
|
+
# resp.contact_id #=> String
|
1542
|
+
# resp.participant_id #=> String
|
1543
|
+
# resp.participant_token #=> String
|
1544
|
+
#
|
1545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContact AWS API Documentation
|
1546
|
+
#
|
1547
|
+
# @overload start_chat_contact(params = {})
|
1548
|
+
# @param [Hash] params ({})
|
1549
|
+
def start_chat_contact(params = {}, options = {})
|
1550
|
+
req = build_request(:start_chat_contact, params)
|
1551
|
+
req.send_request(options)
|
1552
|
+
end
|
1553
|
+
|
1346
1554
|
# Initiates a contact flow to place an outbound call to a customer.
|
1347
1555
|
#
|
1348
1556
|
# There is a 60 second dialing timeout for this operation. If the call
|
@@ -1443,6 +1651,63 @@ module Aws::Connect
|
|
1443
1651
|
req.send_request(options)
|
1444
1652
|
end
|
1445
1653
|
|
1654
|
+
# Adds the specified tags to the specified resource.
|
1655
|
+
#
|
1656
|
+
# The supported resource type is users.
|
1657
|
+
#
|
1658
|
+
# @option params [required, String] :resource_arn
|
1659
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1660
|
+
#
|
1661
|
+
# @option params [required, Hash<String,String>] :tags
|
1662
|
+
# One or more tags. For example, \\\{ "tags": \\\{"key1":"value1",
|
1663
|
+
# "key2":"value2"\\} \\}.
|
1664
|
+
#
|
1665
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1666
|
+
#
|
1667
|
+
# @example Request syntax with placeholder values
|
1668
|
+
#
|
1669
|
+
# resp = client.tag_resource({
|
1670
|
+
# resource_arn: "ARN", # required
|
1671
|
+
# tags: { # required
|
1672
|
+
# "TagKey" => "TagValue",
|
1673
|
+
# },
|
1674
|
+
# })
|
1675
|
+
#
|
1676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TagResource AWS API Documentation
|
1677
|
+
#
|
1678
|
+
# @overload tag_resource(params = {})
|
1679
|
+
# @param [Hash] params ({})
|
1680
|
+
def tag_resource(params = {}, options = {})
|
1681
|
+
req = build_request(:tag_resource, params)
|
1682
|
+
req.send_request(options)
|
1683
|
+
end
|
1684
|
+
|
1685
|
+
# Removes the specified tags from the specified resource.
|
1686
|
+
#
|
1687
|
+
# @option params [required, String] :resource_arn
|
1688
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1689
|
+
#
|
1690
|
+
# @option params [required, Array<String>] :tag_keys
|
1691
|
+
# The tag keys.
|
1692
|
+
#
|
1693
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1694
|
+
#
|
1695
|
+
# @example Request syntax with placeholder values
|
1696
|
+
#
|
1697
|
+
# resp = client.untag_resource({
|
1698
|
+
# resource_arn: "ARN", # required
|
1699
|
+
# tag_keys: ["TagKey"], # required
|
1700
|
+
# })
|
1701
|
+
#
|
1702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UntagResource AWS API Documentation
|
1703
|
+
#
|
1704
|
+
# @overload untag_resource(params = {})
|
1705
|
+
# @param [Hash] params ({})
|
1706
|
+
def untag_resource(params = {}, options = {})
|
1707
|
+
req = build_request(:untag_resource, params)
|
1708
|
+
req.send_request(options)
|
1709
|
+
end
|
1710
|
+
|
1446
1711
|
# Creates or updates the contact attributes associated with the
|
1447
1712
|
# specified contact.
|
1448
1713
|
#
|
@@ -1675,7 +1940,7 @@ module Aws::Connect
|
|
1675
1940
|
params: params,
|
1676
1941
|
config: config)
|
1677
1942
|
context[:gem_name] = 'aws-sdk-connect'
|
1678
|
-
context[:gem_version] = '1.
|
1943
|
+
context[:gem_version] = '1.25.0'
|
1679
1944
|
Seahorse::Client::Request.new(handlers, context)
|
1680
1945
|
end
|
1681
1946
|
|