aws-sdk-connect 1.30.0 → 1.35.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +3 -2
- data/lib/aws-sdk-connect/client.rb +975 -25
- data/lib/aws-sdk-connect/client_api.rb +517 -0
- data/lib/aws-sdk-connect/errors.rb +58 -0
- data/lib/aws-sdk-connect/types.rb +1371 -88
- metadata +4 -4
@@ -27,14 +27,17 @@ module Aws::Connect
|
|
27
27
|
# See {Seahorse::Client::RequestContext} for more information.
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
|
+
# * {ContactFlowNotPublishedException}
|
30
31
|
# * {ContactNotFoundException}
|
31
32
|
# * {DestinationNotAllowedException}
|
32
33
|
# * {DuplicateResourceException}
|
33
34
|
# * {InternalServiceException}
|
35
|
+
# * {InvalidContactFlowException}
|
34
36
|
# * {InvalidParameterException}
|
35
37
|
# * {InvalidRequestException}
|
36
38
|
# * {LimitExceededException}
|
37
39
|
# * {OutboundContactNotPermittedException}
|
40
|
+
# * {ResourceInUseException}
|
38
41
|
# * {ResourceNotFoundException}
|
39
42
|
# * {ThrottlingException}
|
40
43
|
# * {UserNotFoundException}
|
@@ -45,6 +48,21 @@ module Aws::Connect
|
|
45
48
|
|
46
49
|
extend Aws::Errors::DynamicErrors
|
47
50
|
|
51
|
+
class ContactFlowNotPublishedException < ServiceError
|
52
|
+
|
53
|
+
# @param [Seahorse::Client::RequestContext] context
|
54
|
+
# @param [String] message
|
55
|
+
# @param [Aws::Connect::Types::ContactFlowNotPublishedException] data
|
56
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
57
|
+
super(context, message, data)
|
58
|
+
end
|
59
|
+
|
60
|
+
# @return [String]
|
61
|
+
def message
|
62
|
+
@message || @data[:message]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
48
66
|
class ContactNotFoundException < ServiceError
|
49
67
|
|
50
68
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -105,6 +123,21 @@ module Aws::Connect
|
|
105
123
|
end
|
106
124
|
end
|
107
125
|
|
126
|
+
class InvalidContactFlowException < ServiceError
|
127
|
+
|
128
|
+
# @param [Seahorse::Client::RequestContext] context
|
129
|
+
# @param [String] message
|
130
|
+
# @param [Aws::Connect::Types::InvalidContactFlowException] data
|
131
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
132
|
+
super(context, message, data)
|
133
|
+
end
|
134
|
+
|
135
|
+
# @return [String]
|
136
|
+
def problems
|
137
|
+
@data[:problems]
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
108
141
|
class InvalidParameterException < ServiceError
|
109
142
|
|
110
143
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -165,6 +198,31 @@ module Aws::Connect
|
|
165
198
|
end
|
166
199
|
end
|
167
200
|
|
201
|
+
class ResourceInUseException < ServiceError
|
202
|
+
|
203
|
+
# @param [Seahorse::Client::RequestContext] context
|
204
|
+
# @param [String] message
|
205
|
+
# @param [Aws::Connect::Types::ResourceInUseException] data
|
206
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
207
|
+
super(context, message, data)
|
208
|
+
end
|
209
|
+
|
210
|
+
# @return [String]
|
211
|
+
def message
|
212
|
+
@message || @data[:message]
|
213
|
+
end
|
214
|
+
|
215
|
+
# @return [String]
|
216
|
+
def resource_type
|
217
|
+
@data[:resource_type]
|
218
|
+
end
|
219
|
+
|
220
|
+
# @return [String]
|
221
|
+
def resource_id
|
222
|
+
@data[:resource_id]
|
223
|
+
end
|
224
|
+
end
|
225
|
+
|
168
226
|
class ResourceNotFoundException < ServiceError
|
169
227
|
|
170
228
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -10,6 +10,46 @@
|
|
10
10
|
module Aws::Connect
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# @note When making an API call, you may pass AssociateRoutingProfileQueuesRequest
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# instance_id: "InstanceId", # required
|
18
|
+
# routing_profile_id: "RoutingProfileId", # required
|
19
|
+
# queue_configs: [ # required
|
20
|
+
# {
|
21
|
+
# queue_reference: { # required
|
22
|
+
# queue_id: "QueueId", # required
|
23
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
24
|
+
# },
|
25
|
+
# priority: 1, # required
|
26
|
+
# delay: 1, # required
|
27
|
+
# },
|
28
|
+
# ],
|
29
|
+
# }
|
30
|
+
#
|
31
|
+
# @!attribute [rw] instance_id
|
32
|
+
# The identifier of the Amazon Connect instance.
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] routing_profile_id
|
36
|
+
# The identifier of the routing profile.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] queue_configs
|
40
|
+
# The queues to associate with this routing profile.
|
41
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
42
|
+
#
|
43
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateRoutingProfileQueuesRequest AWS API Documentation
|
44
|
+
#
|
45
|
+
class AssociateRoutingProfileQueuesRequest < Struct.new(
|
46
|
+
:instance_id,
|
47
|
+
:routing_profile_id,
|
48
|
+
:queue_configs)
|
49
|
+
SENSITIVE = []
|
50
|
+
include Aws::Structure
|
51
|
+
end
|
52
|
+
|
13
53
|
# A chat message.
|
14
54
|
#
|
15
55
|
# @note When making an API call, you may pass ChatMessage
|
@@ -37,8 +77,78 @@ module Aws::Connect
|
|
37
77
|
include Aws::Structure
|
38
78
|
end
|
39
79
|
|
80
|
+
# Contains information about a contact flow.
|
81
|
+
#
|
82
|
+
# @!attribute [rw] arn
|
83
|
+
# The Amazon Resource Name (ARN) of the contact flow.
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] id
|
87
|
+
# The identifier of the contact flow.
|
88
|
+
# @return [String]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] name
|
91
|
+
# The name of the contact flow.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] type
|
95
|
+
# The type of the contact flow. For descriptions of the available
|
96
|
+
# types, see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
97
|
+
# Administrator Guide*.
|
98
|
+
#
|
99
|
+
#
|
100
|
+
#
|
101
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] description
|
105
|
+
# The description of the contact flow.
|
106
|
+
# @return [String]
|
107
|
+
#
|
108
|
+
# @!attribute [rw] content
|
109
|
+
# The content of the contact flow.
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] tags
|
113
|
+
# One or more tags.
|
114
|
+
# @return [Hash<String,String>]
|
115
|
+
#
|
116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlow AWS API Documentation
|
117
|
+
#
|
118
|
+
class ContactFlow < Struct.new(
|
119
|
+
:arn,
|
120
|
+
:id,
|
121
|
+
:name,
|
122
|
+
:type,
|
123
|
+
:description,
|
124
|
+
:content,
|
125
|
+
:tags)
|
126
|
+
SENSITIVE = []
|
127
|
+
include Aws::Structure
|
128
|
+
end
|
129
|
+
|
130
|
+
# The contact flow has not been published.
|
131
|
+
#
|
132
|
+
# @!attribute [rw] message
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowNotPublishedException AWS API Documentation
|
136
|
+
#
|
137
|
+
class ContactFlowNotPublishedException < Struct.new(
|
138
|
+
:message)
|
139
|
+
SENSITIVE = []
|
140
|
+
include Aws::Structure
|
141
|
+
end
|
142
|
+
|
40
143
|
# Contains summary information about a contact flow.
|
41
144
|
#
|
145
|
+
# You can also create and update contact flows using the [Amazon Connect
|
146
|
+
# Flow language][1].
|
147
|
+
#
|
148
|
+
#
|
149
|
+
#
|
150
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
151
|
+
#
|
42
152
|
# @!attribute [rw] id
|
43
153
|
# The identifier of the contact flow.
|
44
154
|
# @return [String]
|
@@ -80,6 +190,222 @@ module Aws::Connect
|
|
80
190
|
include Aws::Structure
|
81
191
|
end
|
82
192
|
|
193
|
+
# @note When making an API call, you may pass CreateContactFlowRequest
|
194
|
+
# data as a hash:
|
195
|
+
#
|
196
|
+
# {
|
197
|
+
# instance_id: "InstanceId", # required
|
198
|
+
# name: "ContactFlowName", # required
|
199
|
+
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
200
|
+
# description: "ContactFlowDescription",
|
201
|
+
# content: "ContactFlowContent", # required
|
202
|
+
# tags: {
|
203
|
+
# "TagKey" => "TagValue",
|
204
|
+
# },
|
205
|
+
# }
|
206
|
+
#
|
207
|
+
# @!attribute [rw] instance_id
|
208
|
+
# The identifier of the Amazon Connect instance.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] name
|
212
|
+
# The name of the contact flow.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @!attribute [rw] type
|
216
|
+
# The type of the contact flow. For descriptions of the available
|
217
|
+
# types, see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
218
|
+
# Administrator Guide*.
|
219
|
+
#
|
220
|
+
#
|
221
|
+
#
|
222
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
223
|
+
# @return [String]
|
224
|
+
#
|
225
|
+
# @!attribute [rw] description
|
226
|
+
# The description of the contact flow.
|
227
|
+
# @return [String]
|
228
|
+
#
|
229
|
+
# @!attribute [rw] content
|
230
|
+
# The content of the contact flow.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @!attribute [rw] tags
|
234
|
+
# One or more tags.
|
235
|
+
# @return [Hash<String,String>]
|
236
|
+
#
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowRequest AWS API Documentation
|
238
|
+
#
|
239
|
+
class CreateContactFlowRequest < Struct.new(
|
240
|
+
:instance_id,
|
241
|
+
:name,
|
242
|
+
:type,
|
243
|
+
:description,
|
244
|
+
:content,
|
245
|
+
:tags)
|
246
|
+
SENSITIVE = []
|
247
|
+
include Aws::Structure
|
248
|
+
end
|
249
|
+
|
250
|
+
# @!attribute [rw] contact_flow_id
|
251
|
+
# The identifier of the contact flow.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] contact_flow_arn
|
255
|
+
# The Amazon Resource Name (ARN) of the contact flow.
|
256
|
+
# @return [String]
|
257
|
+
#
|
258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowResponse AWS API Documentation
|
259
|
+
#
|
260
|
+
class CreateContactFlowResponse < Struct.new(
|
261
|
+
:contact_flow_id,
|
262
|
+
:contact_flow_arn)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# @note When making an API call, you may pass CreateRoutingProfileRequest
|
268
|
+
# data as a hash:
|
269
|
+
#
|
270
|
+
# {
|
271
|
+
# instance_id: "InstanceId", # required
|
272
|
+
# name: "RoutingProfileName", # required
|
273
|
+
# description: "RoutingProfileDescription", # required
|
274
|
+
# default_outbound_queue_id: "QueueId", # required
|
275
|
+
# queue_configs: [
|
276
|
+
# {
|
277
|
+
# queue_reference: { # required
|
278
|
+
# queue_id: "QueueId", # required
|
279
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
280
|
+
# },
|
281
|
+
# priority: 1, # required
|
282
|
+
# delay: 1, # required
|
283
|
+
# },
|
284
|
+
# ],
|
285
|
+
# media_concurrencies: [ # required
|
286
|
+
# {
|
287
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
288
|
+
# concurrency: 1, # required
|
289
|
+
# },
|
290
|
+
# ],
|
291
|
+
# tags: {
|
292
|
+
# "TagKey" => "TagValue",
|
293
|
+
# },
|
294
|
+
# }
|
295
|
+
#
|
296
|
+
# @!attribute [rw] instance_id
|
297
|
+
# The identifier of the Amazon Connect instance.
|
298
|
+
# @return [String]
|
299
|
+
#
|
300
|
+
# @!attribute [rw] name
|
301
|
+
# The name of the routing profile. Must not be more than 127
|
302
|
+
# characters.
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] description
|
306
|
+
# Description of the routing profile. Must not be more than 250
|
307
|
+
# characters.
|
308
|
+
# @return [String]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] default_outbound_queue_id
|
311
|
+
# The default outbound queue for the routing profile.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] queue_configs
|
315
|
+
# The inbound queues associated with the routing profile. If no queue
|
316
|
+
# is added, the agent can only make outbound calls.
|
317
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] media_concurrencies
|
320
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
321
|
+
# for this routing profile.
|
322
|
+
# @return [Array<Types::MediaConcurrency>]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] tags
|
325
|
+
# One or more tags.
|
326
|
+
# @return [Hash<String,String>]
|
327
|
+
#
|
328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfileRequest AWS API Documentation
|
329
|
+
#
|
330
|
+
class CreateRoutingProfileRequest < Struct.new(
|
331
|
+
:instance_id,
|
332
|
+
:name,
|
333
|
+
:description,
|
334
|
+
:default_outbound_queue_id,
|
335
|
+
:queue_configs,
|
336
|
+
:media_concurrencies,
|
337
|
+
:tags)
|
338
|
+
SENSITIVE = []
|
339
|
+
include Aws::Structure
|
340
|
+
end
|
341
|
+
|
342
|
+
# @!attribute [rw] routing_profile_arn
|
343
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] routing_profile_id
|
347
|
+
# The identifier of the routing profile.
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfileResponse AWS API Documentation
|
351
|
+
#
|
352
|
+
class CreateRoutingProfileResponse < Struct.new(
|
353
|
+
:routing_profile_arn,
|
354
|
+
:routing_profile_id)
|
355
|
+
SENSITIVE = []
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
359
|
+
# @note When making an API call, you may pass CreateUserHierarchyGroupRequest
|
360
|
+
# data as a hash:
|
361
|
+
#
|
362
|
+
# {
|
363
|
+
# name: "HierarchyGroupName", # required
|
364
|
+
# parent_group_id: "HierarchyGroupId",
|
365
|
+
# instance_id: "InstanceId", # required
|
366
|
+
# }
|
367
|
+
#
|
368
|
+
# @!attribute [rw] name
|
369
|
+
# The name of the user hierarchy group. Must not be more than 100
|
370
|
+
# characters.
|
371
|
+
# @return [String]
|
372
|
+
#
|
373
|
+
# @!attribute [rw] parent_group_id
|
374
|
+
# The identifier for the parent hierarchy group. The user hierarchy is
|
375
|
+
# created at level one if the parent group ID is null.
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] instance_id
|
379
|
+
# The identifier of the Amazon Connect instance.
|
380
|
+
# @return [String]
|
381
|
+
#
|
382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroupRequest AWS API Documentation
|
383
|
+
#
|
384
|
+
class CreateUserHierarchyGroupRequest < Struct.new(
|
385
|
+
:name,
|
386
|
+
:parent_group_id,
|
387
|
+
:instance_id)
|
388
|
+
SENSITIVE = []
|
389
|
+
include Aws::Structure
|
390
|
+
end
|
391
|
+
|
392
|
+
# @!attribute [rw] hierarchy_group_id
|
393
|
+
# The identifier of the hierarchy group.
|
394
|
+
# @return [String]
|
395
|
+
#
|
396
|
+
# @!attribute [rw] hierarchy_group_arn
|
397
|
+
# The Amazon Resource Name (ARN) of the hierarchy group.
|
398
|
+
# @return [String]
|
399
|
+
#
|
400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroupResponse AWS API Documentation
|
401
|
+
#
|
402
|
+
class CreateUserHierarchyGroupResponse < Struct.new(
|
403
|
+
:hierarchy_group_id,
|
404
|
+
:hierarchy_group_arn)
|
405
|
+
SENSITIVE = []
|
406
|
+
include Aws::Structure
|
407
|
+
end
|
408
|
+
|
83
409
|
# @note When making an API call, you may pass CreateUserRequest
|
84
410
|
# data as a hash:
|
85
411
|
#
|
@@ -300,6 +626,31 @@ module Aws::Connect
|
|
300
626
|
include Aws::Structure
|
301
627
|
end
|
302
628
|
|
629
|
+
# @note When making an API call, you may pass DeleteUserHierarchyGroupRequest
|
630
|
+
# data as a hash:
|
631
|
+
#
|
632
|
+
# {
|
633
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
634
|
+
# instance_id: "InstanceId", # required
|
635
|
+
# }
|
636
|
+
#
|
637
|
+
# @!attribute [rw] hierarchy_group_id
|
638
|
+
# The identifier of the hierarchy group.
|
639
|
+
# @return [String]
|
640
|
+
#
|
641
|
+
# @!attribute [rw] instance_id
|
642
|
+
# The identifier of the Amazon Connect instance.
|
643
|
+
# @return [String]
|
644
|
+
#
|
645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserHierarchyGroupRequest AWS API Documentation
|
646
|
+
#
|
647
|
+
class DeleteUserHierarchyGroupRequest < Struct.new(
|
648
|
+
:hierarchy_group_id,
|
649
|
+
:instance_id)
|
650
|
+
SENSITIVE = []
|
651
|
+
include Aws::Structure
|
652
|
+
end
|
653
|
+
|
303
654
|
# @note When making an API call, you may pass DeleteUserRequest
|
304
655
|
# data as a hash:
|
305
656
|
#
|
@@ -325,6 +676,80 @@ module Aws::Connect
|
|
325
676
|
include Aws::Structure
|
326
677
|
end
|
327
678
|
|
679
|
+
# @note When making an API call, you may pass DescribeContactFlowRequest
|
680
|
+
# data as a hash:
|
681
|
+
#
|
682
|
+
# {
|
683
|
+
# instance_id: "InstanceId", # required
|
684
|
+
# contact_flow_id: "ContactFlowId", # required
|
685
|
+
# }
|
686
|
+
#
|
687
|
+
# @!attribute [rw] instance_id
|
688
|
+
# The identifier of the Amazon Connect instance.
|
689
|
+
# @return [String]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] contact_flow_id
|
692
|
+
# The identifier of the contact flow.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowRequest AWS API Documentation
|
696
|
+
#
|
697
|
+
class DescribeContactFlowRequest < Struct.new(
|
698
|
+
:instance_id,
|
699
|
+
:contact_flow_id)
|
700
|
+
SENSITIVE = []
|
701
|
+
include Aws::Structure
|
702
|
+
end
|
703
|
+
|
704
|
+
# @!attribute [rw] contact_flow
|
705
|
+
# Information about the contact flow.
|
706
|
+
# @return [Types::ContactFlow]
|
707
|
+
#
|
708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowResponse AWS API Documentation
|
709
|
+
#
|
710
|
+
class DescribeContactFlowResponse < Struct.new(
|
711
|
+
:contact_flow)
|
712
|
+
SENSITIVE = []
|
713
|
+
include Aws::Structure
|
714
|
+
end
|
715
|
+
|
716
|
+
# @note When making an API call, you may pass DescribeRoutingProfileRequest
|
717
|
+
# data as a hash:
|
718
|
+
#
|
719
|
+
# {
|
720
|
+
# instance_id: "InstanceId", # required
|
721
|
+
# routing_profile_id: "RoutingProfileId", # required
|
722
|
+
# }
|
723
|
+
#
|
724
|
+
# @!attribute [rw] instance_id
|
725
|
+
# The identifier of the Amazon Connect instance.
|
726
|
+
# @return [String]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] routing_profile_id
|
729
|
+
# The identifier of the routing profile.
|
730
|
+
# @return [String]
|
731
|
+
#
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileRequest AWS API Documentation
|
733
|
+
#
|
734
|
+
class DescribeRoutingProfileRequest < Struct.new(
|
735
|
+
:instance_id,
|
736
|
+
:routing_profile_id)
|
737
|
+
SENSITIVE = []
|
738
|
+
include Aws::Structure
|
739
|
+
end
|
740
|
+
|
741
|
+
# @!attribute [rw] routing_profile
|
742
|
+
# The routing profile.
|
743
|
+
# @return [Types::RoutingProfile]
|
744
|
+
#
|
745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileResponse AWS API Documentation
|
746
|
+
#
|
747
|
+
class DescribeRoutingProfileResponse < Struct.new(
|
748
|
+
:routing_profile)
|
749
|
+
SENSITIVE = []
|
750
|
+
include Aws::Structure
|
751
|
+
end
|
752
|
+
|
328
753
|
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
329
754
|
# data as a hash:
|
330
755
|
#
|
@@ -463,6 +888,42 @@ module Aws::Connect
|
|
463
888
|
include Aws::Structure
|
464
889
|
end
|
465
890
|
|
891
|
+
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
892
|
+
# data as a hash:
|
893
|
+
#
|
894
|
+
# {
|
895
|
+
# instance_id: "InstanceId", # required
|
896
|
+
# routing_profile_id: "RoutingProfileId", # required
|
897
|
+
# queue_references: [ # required
|
898
|
+
# {
|
899
|
+
# queue_id: "QueueId", # required
|
900
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
901
|
+
# },
|
902
|
+
# ],
|
903
|
+
# }
|
904
|
+
#
|
905
|
+
# @!attribute [rw] instance_id
|
906
|
+
# The identifier of the Amazon Connect instance.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] routing_profile_id
|
910
|
+
# The identifier of the routing profile.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] queue_references
|
914
|
+
# The queues to disassociate from this routing profile.
|
915
|
+
# @return [Array<Types::RoutingProfileQueueReference>]
|
916
|
+
#
|
917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueuesRequest AWS API Documentation
|
918
|
+
#
|
919
|
+
class DisassociateRoutingProfileQueuesRequest < Struct.new(
|
920
|
+
:instance_id,
|
921
|
+
:routing_profile_id,
|
922
|
+
:queue_references)
|
923
|
+
SENSITIVE = []
|
924
|
+
include Aws::Structure
|
925
|
+
end
|
926
|
+
|
466
927
|
# A resource with the specified name already exists.
|
467
928
|
#
|
468
929
|
# @!attribute [rw] message
|
@@ -569,16 +1030,16 @@ module Aws::Connect
|
|
569
1030
|
# The queues, up to 100, or channels, to use to filter the metrics
|
570
1031
|
# returned. Metric data is retrieved only for the resources associated
|
571
1032
|
# with the queues or channels included in the filter. You can include
|
572
|
-
# both queue IDs and queue ARNs in the same request.
|
573
|
-
#
|
1033
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1034
|
+
# `CHAT` channels are supported.
|
574
1035
|
# @return [Types::Filters]
|
575
1036
|
#
|
576
1037
|
# @!attribute [rw] groupings
|
577
1038
|
# The grouping applied to the metrics returned. For example, when
|
578
1039
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
579
1040
|
# than aggregated for all queues. If you group by `CHANNEL`, you
|
580
|
-
# should include a Channels filter.
|
581
|
-
#
|
1041
|
+
# should include a Channels filter. Both `VOICE` and `CHAT` channels
|
1042
|
+
# are supported.
|
582
1043
|
#
|
583
1044
|
# If no `Grouping` is included in the request, a summary of metrics is
|
584
1045
|
# returned.
|
@@ -586,65 +1047,112 @@ module Aws::Connect
|
|
586
1047
|
#
|
587
1048
|
# @!attribute [rw] current_metrics
|
588
1049
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
589
|
-
# The following metrics are available. For a description of
|
590
|
-
#
|
1050
|
+
# The following metrics are available. For a description of all the
|
1051
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon
|
591
1052
|
# Connect Administrator Guide*.
|
592
1053
|
#
|
593
1054
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
594
1055
|
#
|
595
1056
|
# : Unit: COUNT
|
596
1057
|
#
|
1058
|
+
# Name in real-time metrics report: [ACW][2]
|
1059
|
+
#
|
597
1060
|
# AGENTS\_AVAILABLE
|
598
1061
|
#
|
599
1062
|
# : Unit: COUNT
|
600
1063
|
#
|
1064
|
+
# Name in real-time metrics report: [Available][3]
|
1065
|
+
#
|
601
1066
|
# AGENTS\_ERROR
|
602
1067
|
#
|
603
1068
|
# : Unit: COUNT
|
604
1069
|
#
|
1070
|
+
# Name in real-time metrics report: [Error][4]
|
1071
|
+
#
|
605
1072
|
# AGENTS\_NON\_PRODUCTIVE
|
606
1073
|
#
|
607
1074
|
# : Unit: COUNT
|
608
1075
|
#
|
1076
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
1077
|
+
#
|
609
1078
|
# AGENTS\_ON\_CALL
|
610
1079
|
#
|
611
1080
|
# : Unit: COUNT
|
612
1081
|
#
|
1082
|
+
# Name in real-time metrics report: [On contact][6]
|
1083
|
+
#
|
613
1084
|
# AGENTS\_ON\_CONTACT
|
614
1085
|
#
|
615
1086
|
# : Unit: COUNT
|
616
1087
|
#
|
1088
|
+
# Name in real-time metrics report: [On contact][6]
|
1089
|
+
#
|
617
1090
|
# AGENTS\_ONLINE
|
618
1091
|
#
|
619
1092
|
# : Unit: COUNT
|
620
1093
|
#
|
1094
|
+
# Name in real-time metrics report: [Online][7]
|
1095
|
+
#
|
621
1096
|
# AGENTS\_STAFFED
|
622
1097
|
#
|
623
1098
|
# : Unit: COUNT
|
624
1099
|
#
|
1100
|
+
# Name in real-time metrics report: [Staffed][8]
|
1101
|
+
#
|
625
1102
|
# CONTACTS\_IN\_QUEUE
|
626
1103
|
#
|
627
1104
|
# : Unit: COUNT
|
628
1105
|
#
|
1106
|
+
# Name in real-time metrics report: [In queue][9]
|
1107
|
+
#
|
629
1108
|
# CONTACTS\_SCHEDULED
|
630
1109
|
#
|
631
1110
|
# : Unit: COUNT
|
632
1111
|
#
|
1112
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1113
|
+
#
|
633
1114
|
# OLDEST\_CONTACT\_AGE
|
634
1115
|
#
|
635
1116
|
# : Unit: SECONDS
|
636
1117
|
#
|
1118
|
+
# When you use groupings, Unit says SECONDS but the Value is
|
1119
|
+
# returned in MILLISECONDS. For example, if you get a response like
|
1120
|
+
# this:
|
1121
|
+
#
|
1122
|
+
# `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS"
|
1123
|
+
# \}, "Value": 24113.0 `\\}
|
1124
|
+
#
|
1125
|
+
# The actual OLDEST\_CONTACT\_AGE is 24 seconds.
|
1126
|
+
#
|
1127
|
+
# Name in real-time metrics report: [Oldest][11]
|
1128
|
+
#
|
637
1129
|
# SLOTS\_ACTIVE
|
638
1130
|
#
|
639
1131
|
# : Unit: COUNT
|
640
1132
|
#
|
1133
|
+
# Name in real-time metrics report: [Active][12]
|
1134
|
+
#
|
641
1135
|
# SLOTS\_AVAILABLE
|
642
1136
|
#
|
643
1137
|
# : Unit: COUNT
|
644
1138
|
#
|
1139
|
+
# Name in real-time metrics report: [Availability][13]
|
1140
|
+
#
|
645
1141
|
#
|
646
1142
|
#
|
647
1143
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
1144
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
|
1145
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
|
1146
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
|
1147
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
|
1148
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
|
1149
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
|
1150
|
+
# [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
|
1151
|
+
# [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
|
1152
|
+
# [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
|
1153
|
+
# [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
|
1154
|
+
# [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
|
1155
|
+
# [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
|
648
1156
|
# @return [Array<Types::CurrentMetric>]
|
649
1157
|
#
|
650
1158
|
# @!attribute [rw] next_token
|
@@ -789,8 +1297,8 @@ module Aws::Connect
|
|
789
1297
|
# The queues, up to 100, or channels, to use to filter the metrics
|
790
1298
|
# returned. Metric data is retrieved only for the resources associated
|
791
1299
|
# with the queues or channels included in the filter. You can include
|
792
|
-
# both queue IDs and queue ARNs in the same request.
|
793
|
-
#
|
1300
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1301
|
+
# `CHAT` channels are supported.
|
794
1302
|
# @return [Types::Filters]
|
795
1303
|
#
|
796
1304
|
# @!attribute [rw] groupings
|
@@ -1101,6 +1609,28 @@ module Aws::Connect
|
|
1101
1609
|
include Aws::Structure
|
1102
1610
|
end
|
1103
1611
|
|
1612
|
+
# Contains information about the hierarchy level to update.
|
1613
|
+
#
|
1614
|
+
# @note When making an API call, you may pass HierarchyLevelUpdate
|
1615
|
+
# data as a hash:
|
1616
|
+
#
|
1617
|
+
# {
|
1618
|
+
# name: "HierarchyLevelName", # required
|
1619
|
+
# }
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] name
|
1622
|
+
# The name of the user hierarchy level. Must not be more than 50
|
1623
|
+
# characters.
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyLevelUpdate AWS API Documentation
|
1627
|
+
#
|
1628
|
+
class HierarchyLevelUpdate < Struct.new(
|
1629
|
+
:name)
|
1630
|
+
SENSITIVE = []
|
1631
|
+
include Aws::Structure
|
1632
|
+
end
|
1633
|
+
|
1104
1634
|
# Contains information about the levels of a hierarchy group.
|
1105
1635
|
#
|
1106
1636
|
# @!attribute [rw] level_one
|
@@ -1169,6 +1699,61 @@ module Aws::Connect
|
|
1169
1699
|
include Aws::Structure
|
1170
1700
|
end
|
1171
1701
|
|
1702
|
+
# Contains information about the level hierarchy to update.
|
1703
|
+
#
|
1704
|
+
# @note When making an API call, you may pass HierarchyStructureUpdate
|
1705
|
+
# data as a hash:
|
1706
|
+
#
|
1707
|
+
# {
|
1708
|
+
# level_one: {
|
1709
|
+
# name: "HierarchyLevelName", # required
|
1710
|
+
# },
|
1711
|
+
# level_two: {
|
1712
|
+
# name: "HierarchyLevelName", # required
|
1713
|
+
# },
|
1714
|
+
# level_three: {
|
1715
|
+
# name: "HierarchyLevelName", # required
|
1716
|
+
# },
|
1717
|
+
# level_four: {
|
1718
|
+
# name: "HierarchyLevelName", # required
|
1719
|
+
# },
|
1720
|
+
# level_five: {
|
1721
|
+
# name: "HierarchyLevelName", # required
|
1722
|
+
# },
|
1723
|
+
# }
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] level_one
|
1726
|
+
# The update for level one.
|
1727
|
+
# @return [Types::HierarchyLevelUpdate]
|
1728
|
+
#
|
1729
|
+
# @!attribute [rw] level_two
|
1730
|
+
# The update for level two.
|
1731
|
+
# @return [Types::HierarchyLevelUpdate]
|
1732
|
+
#
|
1733
|
+
# @!attribute [rw] level_three
|
1734
|
+
# The update for level three.
|
1735
|
+
# @return [Types::HierarchyLevelUpdate]
|
1736
|
+
#
|
1737
|
+
# @!attribute [rw] level_four
|
1738
|
+
# The update for level four.
|
1739
|
+
# @return [Types::HierarchyLevelUpdate]
|
1740
|
+
#
|
1741
|
+
# @!attribute [rw] level_five
|
1742
|
+
# The update for level five.
|
1743
|
+
# @return [Types::HierarchyLevelUpdate]
|
1744
|
+
#
|
1745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyStructureUpdate AWS API Documentation
|
1746
|
+
#
|
1747
|
+
class HierarchyStructureUpdate < Struct.new(
|
1748
|
+
:level_one,
|
1749
|
+
:level_two,
|
1750
|
+
:level_three,
|
1751
|
+
:level_four,
|
1752
|
+
:level_five)
|
1753
|
+
SENSITIVE = []
|
1754
|
+
include Aws::Structure
|
1755
|
+
end
|
1756
|
+
|
1172
1757
|
# Contains information about a historical metric. For a description of
|
1173
1758
|
# each metric, see [Historical Metrics Definitions][1] in the *Amazon
|
1174
1759
|
# Connect Administrator Guide*.
|
@@ -1294,6 +1879,20 @@ module Aws::Connect
|
|
1294
1879
|
include Aws::Structure
|
1295
1880
|
end
|
1296
1881
|
|
1882
|
+
# The contact flow is not valid.
|
1883
|
+
#
|
1884
|
+
# @!attribute [rw] problems
|
1885
|
+
# The problems with the contact flow. Please fix before trying again.
|
1886
|
+
# @return [Array<Types::ProblemDetail>]
|
1887
|
+
#
|
1888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidContactFlowException AWS API Documentation
|
1889
|
+
#
|
1890
|
+
class InvalidContactFlowException < Struct.new(
|
1891
|
+
:problems)
|
1892
|
+
SENSITIVE = []
|
1893
|
+
include Aws::Structure
|
1894
|
+
end
|
1895
|
+
|
1297
1896
|
# One or more of the specified parameters are not valid.
|
1298
1897
|
#
|
1299
1898
|
# @!attribute [rw] message
|
@@ -1375,25 +1974,139 @@ module Aws::Connect
|
|
1375
1974
|
include Aws::Structure
|
1376
1975
|
end
|
1377
1976
|
|
1378
|
-
# @!attribute [rw] contact_flow_summary_list
|
1379
|
-
# Information about the contact flows.
|
1380
|
-
# @return [Array<Types::ContactFlowSummary>]
|
1977
|
+
# @!attribute [rw] contact_flow_summary_list
|
1978
|
+
# Information about the contact flows.
|
1979
|
+
# @return [Array<Types::ContactFlowSummary>]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] next_token
|
1982
|
+
# If there are additional results, this is the token for the next set
|
1983
|
+
# of results.
|
1984
|
+
# @return [String]
|
1985
|
+
#
|
1986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowsResponse AWS API Documentation
|
1987
|
+
#
|
1988
|
+
class ListContactFlowsResponse < Struct.new(
|
1989
|
+
:contact_flow_summary_list,
|
1990
|
+
:next_token)
|
1991
|
+
SENSITIVE = []
|
1992
|
+
include Aws::Structure
|
1993
|
+
end
|
1994
|
+
|
1995
|
+
# @note When making an API call, you may pass ListHoursOfOperationsRequest
|
1996
|
+
# data as a hash:
|
1997
|
+
#
|
1998
|
+
# {
|
1999
|
+
# instance_id: "InstanceId", # required
|
2000
|
+
# next_token: "NextToken",
|
2001
|
+
# max_results: 1,
|
2002
|
+
# }
|
2003
|
+
#
|
2004
|
+
# @!attribute [rw] instance_id
|
2005
|
+
# The identifier of the Amazon Connect instance.
|
2006
|
+
# @return [String]
|
2007
|
+
#
|
2008
|
+
# @!attribute [rw] next_token
|
2009
|
+
# The token for the next set of results. Use the value returned in the
|
2010
|
+
# previous response in the next request to retrieve the next set of
|
2011
|
+
# results.
|
2012
|
+
# @return [String]
|
2013
|
+
#
|
2014
|
+
# @!attribute [rw] max_results
|
2015
|
+
# The maximimum number of results to return per page.
|
2016
|
+
# @return [Integer]
|
2017
|
+
#
|
2018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsRequest AWS API Documentation
|
2019
|
+
#
|
2020
|
+
class ListHoursOfOperationsRequest < Struct.new(
|
2021
|
+
:instance_id,
|
2022
|
+
:next_token,
|
2023
|
+
:max_results)
|
2024
|
+
SENSITIVE = []
|
2025
|
+
include Aws::Structure
|
2026
|
+
end
|
2027
|
+
|
2028
|
+
# @!attribute [rw] hours_of_operation_summary_list
|
2029
|
+
# Information about the hours of operation.
|
2030
|
+
# @return [Array<Types::HoursOfOperationSummary>]
|
2031
|
+
#
|
2032
|
+
# @!attribute [rw] next_token
|
2033
|
+
# If there are additional results, this is the token for the next set
|
2034
|
+
# of results.
|
2035
|
+
# @return [String]
|
2036
|
+
#
|
2037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsResponse AWS API Documentation
|
2038
|
+
#
|
2039
|
+
class ListHoursOfOperationsResponse < Struct.new(
|
2040
|
+
:hours_of_operation_summary_list,
|
2041
|
+
:next_token)
|
2042
|
+
SENSITIVE = []
|
2043
|
+
include Aws::Structure
|
2044
|
+
end
|
2045
|
+
|
2046
|
+
# @note When making an API call, you may pass ListPhoneNumbersRequest
|
2047
|
+
# data as a hash:
|
2048
|
+
#
|
2049
|
+
# {
|
2050
|
+
# instance_id: "InstanceId", # required
|
2051
|
+
# phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID
|
2052
|
+
# phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
|
2053
|
+
# next_token: "NextToken",
|
2054
|
+
# max_results: 1,
|
2055
|
+
# }
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] instance_id
|
2058
|
+
# The identifier of the Amazon Connect instance.
|
2059
|
+
# @return [String]
|
2060
|
+
#
|
2061
|
+
# @!attribute [rw] phone_number_types
|
2062
|
+
# The type of phone number.
|
2063
|
+
# @return [Array<String>]
|
2064
|
+
#
|
2065
|
+
# @!attribute [rw] phone_number_country_codes
|
2066
|
+
# The ISO country code.
|
2067
|
+
# @return [Array<String>]
|
2068
|
+
#
|
2069
|
+
# @!attribute [rw] next_token
|
2070
|
+
# The token for the next set of results. Use the value returned in the
|
2071
|
+
# previous response in the next request to retrieve the next set of
|
2072
|
+
# results.
|
2073
|
+
# @return [String]
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] max_results
|
2076
|
+
# The maximimum number of results to return per page.
|
2077
|
+
# @return [Integer]
|
2078
|
+
#
|
2079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersRequest AWS API Documentation
|
2080
|
+
#
|
2081
|
+
class ListPhoneNumbersRequest < Struct.new(
|
2082
|
+
:instance_id,
|
2083
|
+
:phone_number_types,
|
2084
|
+
:phone_number_country_codes,
|
2085
|
+
:next_token,
|
2086
|
+
:max_results)
|
2087
|
+
SENSITIVE = []
|
2088
|
+
include Aws::Structure
|
2089
|
+
end
|
2090
|
+
|
2091
|
+
# @!attribute [rw] phone_number_summary_list
|
2092
|
+
# Information about the phone numbers.
|
2093
|
+
# @return [Array<Types::PhoneNumberSummary>]
|
1381
2094
|
#
|
1382
2095
|
# @!attribute [rw] next_token
|
1383
2096
|
# If there are additional results, this is the token for the next set
|
1384
2097
|
# of results.
|
1385
2098
|
# @return [String]
|
1386
2099
|
#
|
1387
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersResponse AWS API Documentation
|
1388
2101
|
#
|
1389
|
-
class
|
1390
|
-
:
|
2102
|
+
class ListPhoneNumbersResponse < Struct.new(
|
2103
|
+
:phone_number_summary_list,
|
1391
2104
|
:next_token)
|
1392
2105
|
SENSITIVE = []
|
1393
2106
|
include Aws::Structure
|
1394
2107
|
end
|
1395
2108
|
|
1396
|
-
# @note When making an API call, you may pass
|
2109
|
+
# @note When making an API call, you may pass ListPromptsRequest
|
1397
2110
|
# data as a hash:
|
1398
2111
|
#
|
1399
2112
|
# {
|
@@ -1413,12 +2126,12 @@ module Aws::Connect
|
|
1413
2126
|
# @return [String]
|
1414
2127
|
#
|
1415
2128
|
# @!attribute [rw] max_results
|
1416
|
-
# The
|
2129
|
+
# The maximum number of results to return per page.
|
1417
2130
|
# @return [Integer]
|
1418
2131
|
#
|
1419
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsRequest AWS API Documentation
|
1420
2133
|
#
|
1421
|
-
class
|
2134
|
+
class ListPromptsRequest < Struct.new(
|
1422
2135
|
:instance_id,
|
1423
2136
|
:next_token,
|
1424
2137
|
:max_results)
|
@@ -1426,31 +2139,30 @@ module Aws::Connect
|
|
1426
2139
|
include Aws::Structure
|
1427
2140
|
end
|
1428
2141
|
|
1429
|
-
# @!attribute [rw]
|
1430
|
-
# Information about the
|
1431
|
-
# @return [Array<Types::
|
2142
|
+
# @!attribute [rw] prompt_summary_list
|
2143
|
+
# Information about the prompts.
|
2144
|
+
# @return [Array<Types::PromptSummary>]
|
1432
2145
|
#
|
1433
2146
|
# @!attribute [rw] next_token
|
1434
2147
|
# If there are additional results, this is the token for the next set
|
1435
2148
|
# of results.
|
1436
2149
|
# @return [String]
|
1437
2150
|
#
|
1438
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsResponse AWS API Documentation
|
1439
2152
|
#
|
1440
|
-
class
|
1441
|
-
:
|
2153
|
+
class ListPromptsResponse < Struct.new(
|
2154
|
+
:prompt_summary_list,
|
1442
2155
|
:next_token)
|
1443
2156
|
SENSITIVE = []
|
1444
2157
|
include Aws::Structure
|
1445
2158
|
end
|
1446
2159
|
|
1447
|
-
# @note When making an API call, you may pass
|
2160
|
+
# @note When making an API call, you may pass ListQueuesRequest
|
1448
2161
|
# data as a hash:
|
1449
2162
|
#
|
1450
2163
|
# {
|
1451
2164
|
# instance_id: "InstanceId", # required
|
1452
|
-
#
|
1453
|
-
# phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
|
2165
|
+
# queue_types: ["STANDARD"], # accepts STANDARD, AGENT
|
1454
2166
|
# next_token: "NextToken",
|
1455
2167
|
# max_results: 1,
|
1456
2168
|
# }
|
@@ -1459,12 +2171,8 @@ module Aws::Connect
|
|
1459
2171
|
# The identifier of the Amazon Connect instance.
|
1460
2172
|
# @return [String]
|
1461
2173
|
#
|
1462
|
-
# @!attribute [rw]
|
1463
|
-
# The type of
|
1464
|
-
# @return [Array<String>]
|
1465
|
-
#
|
1466
|
-
# @!attribute [rw] phone_number_country_codes
|
1467
|
-
# The ISO country code.
|
2174
|
+
# @!attribute [rw] queue_types
|
2175
|
+
# The type of queue.
|
1468
2176
|
# @return [Array<String>]
|
1469
2177
|
#
|
1470
2178
|
# @!attribute [rw] next_token
|
@@ -1477,42 +2185,41 @@ module Aws::Connect
|
|
1477
2185
|
# The maximimum number of results to return per page.
|
1478
2186
|
# @return [Integer]
|
1479
2187
|
#
|
1480
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesRequest AWS API Documentation
|
1481
2189
|
#
|
1482
|
-
class
|
2190
|
+
class ListQueuesRequest < Struct.new(
|
1483
2191
|
:instance_id,
|
1484
|
-
:
|
1485
|
-
:phone_number_country_codes,
|
2192
|
+
:queue_types,
|
1486
2193
|
:next_token,
|
1487
2194
|
:max_results)
|
1488
2195
|
SENSITIVE = []
|
1489
2196
|
include Aws::Structure
|
1490
2197
|
end
|
1491
2198
|
|
1492
|
-
# @!attribute [rw]
|
1493
|
-
# Information about the
|
1494
|
-
# @return [Array<Types::
|
2199
|
+
# @!attribute [rw] queue_summary_list
|
2200
|
+
# Information about the queues.
|
2201
|
+
# @return [Array<Types::QueueSummary>]
|
1495
2202
|
#
|
1496
2203
|
# @!attribute [rw] next_token
|
1497
2204
|
# If there are additional results, this is the token for the next set
|
1498
2205
|
# of results.
|
1499
2206
|
# @return [String]
|
1500
2207
|
#
|
1501
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesResponse AWS API Documentation
|
1502
2209
|
#
|
1503
|
-
class
|
1504
|
-
:
|
2210
|
+
class ListQueuesResponse < Struct.new(
|
2211
|
+
:queue_summary_list,
|
1505
2212
|
:next_token)
|
1506
2213
|
SENSITIVE = []
|
1507
2214
|
include Aws::Structure
|
1508
2215
|
end
|
1509
2216
|
|
1510
|
-
# @note When making an API call, you may pass
|
2217
|
+
# @note When making an API call, you may pass ListRoutingProfileQueuesRequest
|
1511
2218
|
# data as a hash:
|
1512
2219
|
#
|
1513
2220
|
# {
|
1514
2221
|
# instance_id: "InstanceId", # required
|
1515
|
-
#
|
2222
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1516
2223
|
# next_token: "NextToken",
|
1517
2224
|
# max_results: 1,
|
1518
2225
|
# }
|
@@ -1521,9 +2228,9 @@ module Aws::Connect
|
|
1521
2228
|
# The identifier of the Amazon Connect instance.
|
1522
2229
|
# @return [String]
|
1523
2230
|
#
|
1524
|
-
# @!attribute [rw]
|
1525
|
-
# The
|
1526
|
-
# @return [
|
2231
|
+
# @!attribute [rw] routing_profile_id
|
2232
|
+
# The identifier of the routing profile.
|
2233
|
+
# @return [String]
|
1527
2234
|
#
|
1528
2235
|
# @!attribute [rw] next_token
|
1529
2236
|
# The token for the next set of results. Use the value returned in the
|
@@ -1535,31 +2242,31 @@ module Aws::Connect
|
|
1535
2242
|
# The maximimum number of results to return per page.
|
1536
2243
|
# @return [Integer]
|
1537
2244
|
#
|
1538
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesRequest AWS API Documentation
|
1539
2246
|
#
|
1540
|
-
class
|
2247
|
+
class ListRoutingProfileQueuesRequest < Struct.new(
|
1541
2248
|
:instance_id,
|
1542
|
-
:
|
2249
|
+
:routing_profile_id,
|
1543
2250
|
:next_token,
|
1544
2251
|
:max_results)
|
1545
2252
|
SENSITIVE = []
|
1546
2253
|
include Aws::Structure
|
1547
2254
|
end
|
1548
2255
|
|
1549
|
-
# @!attribute [rw] queue_summary_list
|
1550
|
-
# Information about the queues.
|
1551
|
-
# @return [Array<Types::QueueSummary>]
|
1552
|
-
#
|
1553
2256
|
# @!attribute [rw] next_token
|
1554
2257
|
# If there are additional results, this is the token for the next set
|
1555
2258
|
# of results.
|
1556
2259
|
# @return [String]
|
1557
2260
|
#
|
1558
|
-
#
|
2261
|
+
# @!attribute [rw] routing_profile_queue_config_summary_list
|
2262
|
+
# Information about the routing profiles.
|
2263
|
+
# @return [Array<Types::RoutingProfileQueueConfigSummary>]
|
1559
2264
|
#
|
1560
|
-
|
1561
|
-
|
1562
|
-
|
2265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesResponse AWS API Documentation
|
2266
|
+
#
|
2267
|
+
class ListRoutingProfileQueuesResponse < Struct.new(
|
2268
|
+
:next_token,
|
2269
|
+
:routing_profile_queue_config_summary_list)
|
1563
2270
|
SENSITIVE = []
|
1564
2271
|
include Aws::Structure
|
1565
2272
|
end
|
@@ -1799,6 +2506,36 @@ module Aws::Connect
|
|
1799
2506
|
include Aws::Structure
|
1800
2507
|
end
|
1801
2508
|
|
2509
|
+
# Contains information about which channels are supported, and how many
|
2510
|
+
# contacts an agent can have on a channel simultaneously.
|
2511
|
+
#
|
2512
|
+
# @note When making an API call, you may pass MediaConcurrency
|
2513
|
+
# data as a hash:
|
2514
|
+
#
|
2515
|
+
# {
|
2516
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2517
|
+
# concurrency: 1, # required
|
2518
|
+
# }
|
2519
|
+
#
|
2520
|
+
# @!attribute [rw] channel
|
2521
|
+
# The channels that agents can handle in the Contact Control Panel
|
2522
|
+
# (CCP).
|
2523
|
+
# @return [String]
|
2524
|
+
#
|
2525
|
+
# @!attribute [rw] concurrency
|
2526
|
+
# The number of contacts an agent can have on a channel
|
2527
|
+
# simultaneously.
|
2528
|
+
# @return [Integer]
|
2529
|
+
#
|
2530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MediaConcurrency AWS API Documentation
|
2531
|
+
#
|
2532
|
+
class MediaConcurrency < Struct.new(
|
2533
|
+
:channel,
|
2534
|
+
:concurrency)
|
2535
|
+
SENSITIVE = []
|
2536
|
+
include Aws::Structure
|
2537
|
+
end
|
2538
|
+
|
1802
2539
|
# The contact is not permitted.
|
1803
2540
|
#
|
1804
2541
|
# @!attribute [rw] message
|
@@ -1869,6 +2606,44 @@ module Aws::Connect
|
|
1869
2606
|
include Aws::Structure
|
1870
2607
|
end
|
1871
2608
|
|
2609
|
+
# Information about a problem detail.
|
2610
|
+
#
|
2611
|
+
# @!attribute [rw] message
|
2612
|
+
# The problem detail's message.
|
2613
|
+
# @return [String]
|
2614
|
+
#
|
2615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ProblemDetail AWS API Documentation
|
2616
|
+
#
|
2617
|
+
class ProblemDetail < Struct.new(
|
2618
|
+
:message)
|
2619
|
+
SENSITIVE = []
|
2620
|
+
include Aws::Structure
|
2621
|
+
end
|
2622
|
+
|
2623
|
+
# Contains information about the prompt.
|
2624
|
+
#
|
2625
|
+
# @!attribute [rw] id
|
2626
|
+
# The identifier of the prompt.
|
2627
|
+
# @return [String]
|
2628
|
+
#
|
2629
|
+
# @!attribute [rw] arn
|
2630
|
+
# The Amazon Resource Name (ARN) of the prompt.
|
2631
|
+
# @return [String]
|
2632
|
+
#
|
2633
|
+
# @!attribute [rw] name
|
2634
|
+
# The name of the prompt.
|
2635
|
+
# @return [String]
|
2636
|
+
#
|
2637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PromptSummary AWS API Documentation
|
2638
|
+
#
|
2639
|
+
class PromptSummary < Struct.new(
|
2640
|
+
:id,
|
2641
|
+
:arn,
|
2642
|
+
:name)
|
2643
|
+
SENSITIVE = []
|
2644
|
+
include Aws::Structure
|
2645
|
+
end
|
2646
|
+
|
1872
2647
|
# Contains information about a queue resource for which metrics are
|
1873
2648
|
# returned.
|
1874
2649
|
#
|
@@ -1918,56 +2693,257 @@ module Aws::Connect
|
|
1918
2693
|
include Aws::Structure
|
1919
2694
|
end
|
1920
2695
|
|
2696
|
+
# That resource is already in use. Please try another.
|
2697
|
+
#
|
2698
|
+
# @!attribute [rw] message
|
2699
|
+
# @return [String]
|
2700
|
+
#
|
2701
|
+
# @!attribute [rw] resource_type
|
2702
|
+
# The type of resource.
|
2703
|
+
# @return [String]
|
2704
|
+
#
|
2705
|
+
# @!attribute [rw] resource_id
|
2706
|
+
# The identifier for the resource.
|
2707
|
+
# @return [String]
|
2708
|
+
#
|
2709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceInUseException AWS API Documentation
|
2710
|
+
#
|
2711
|
+
class ResourceInUseException < Struct.new(
|
2712
|
+
:message,
|
2713
|
+
:resource_type,
|
2714
|
+
:resource_id)
|
2715
|
+
SENSITIVE = []
|
2716
|
+
include Aws::Structure
|
2717
|
+
end
|
2718
|
+
|
1921
2719
|
# The specified resource was not found.
|
1922
2720
|
#
|
1923
|
-
# @!attribute [rw] message
|
1924
|
-
# The message.
|
2721
|
+
# @!attribute [rw] message
|
2722
|
+
# The message.
|
2723
|
+
# @return [String]
|
2724
|
+
#
|
2725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceNotFoundException AWS API Documentation
|
2726
|
+
#
|
2727
|
+
class ResourceNotFoundException < Struct.new(
|
2728
|
+
:message)
|
2729
|
+
SENSITIVE = []
|
2730
|
+
include Aws::Structure
|
2731
|
+
end
|
2732
|
+
|
2733
|
+
# @note When making an API call, you may pass ResumeContactRecordingRequest
|
2734
|
+
# data as a hash:
|
2735
|
+
#
|
2736
|
+
# {
|
2737
|
+
# instance_id: "InstanceId", # required
|
2738
|
+
# contact_id: "ContactId", # required
|
2739
|
+
# initial_contact_id: "ContactId", # required
|
2740
|
+
# }
|
2741
|
+
#
|
2742
|
+
# @!attribute [rw] instance_id
|
2743
|
+
# The identifier of the Amazon Connect instance.
|
2744
|
+
# @return [String]
|
2745
|
+
#
|
2746
|
+
# @!attribute [rw] contact_id
|
2747
|
+
# The identifier of the contact.
|
2748
|
+
# @return [String]
|
2749
|
+
#
|
2750
|
+
# @!attribute [rw] initial_contact_id
|
2751
|
+
# The identifier of the contact. This is the identifier of the contact
|
2752
|
+
# associated with the first interaction with the contact center.
|
2753
|
+
# @return [String]
|
2754
|
+
#
|
2755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingRequest AWS API Documentation
|
2756
|
+
#
|
2757
|
+
class ResumeContactRecordingRequest < Struct.new(
|
2758
|
+
:instance_id,
|
2759
|
+
:contact_id,
|
2760
|
+
:initial_contact_id)
|
2761
|
+
SENSITIVE = []
|
2762
|
+
include Aws::Structure
|
2763
|
+
end
|
2764
|
+
|
2765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingResponse AWS API Documentation
|
2766
|
+
#
|
2767
|
+
class ResumeContactRecordingResponse < Aws::EmptyStructure; end
|
2768
|
+
|
2769
|
+
# Contains information about a routing profile.
|
2770
|
+
#
|
2771
|
+
# @!attribute [rw] instance_id
|
2772
|
+
# The identifier of the Amazon Connect instance.
|
2773
|
+
# @return [String]
|
2774
|
+
#
|
2775
|
+
# @!attribute [rw] name
|
2776
|
+
# The name of the routing profile.
|
2777
|
+
# @return [String]
|
2778
|
+
#
|
2779
|
+
# @!attribute [rw] routing_profile_arn
|
2780
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
2781
|
+
# @return [String]
|
2782
|
+
#
|
2783
|
+
# @!attribute [rw] routing_profile_id
|
2784
|
+
# The identifier of the routing profile.
|
2785
|
+
# @return [String]
|
2786
|
+
#
|
2787
|
+
# @!attribute [rw] description
|
2788
|
+
# The description of the routing profile.
|
2789
|
+
# @return [String]
|
2790
|
+
#
|
2791
|
+
# @!attribute [rw] media_concurrencies
|
2792
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2793
|
+
# for this routing profile.
|
2794
|
+
# @return [Array<Types::MediaConcurrency>]
|
2795
|
+
#
|
2796
|
+
# @!attribute [rw] default_outbound_queue_id
|
2797
|
+
# The identifier of the default outbound queue for this routing
|
2798
|
+
# profile.
|
2799
|
+
# @return [String]
|
2800
|
+
#
|
2801
|
+
# @!attribute [rw] tags
|
2802
|
+
# One or more tags.
|
2803
|
+
# @return [Hash<String,String>]
|
2804
|
+
#
|
2805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfile AWS API Documentation
|
2806
|
+
#
|
2807
|
+
class RoutingProfile < Struct.new(
|
2808
|
+
:instance_id,
|
2809
|
+
:name,
|
2810
|
+
:routing_profile_arn,
|
2811
|
+
:routing_profile_id,
|
2812
|
+
:description,
|
2813
|
+
:media_concurrencies,
|
2814
|
+
:default_outbound_queue_id,
|
2815
|
+
:tags)
|
2816
|
+
SENSITIVE = []
|
2817
|
+
include Aws::Structure
|
2818
|
+
end
|
2819
|
+
|
2820
|
+
# Contains information about the queue and channel for which priority
|
2821
|
+
# and delay can be set.
|
2822
|
+
#
|
2823
|
+
# @note When making an API call, you may pass RoutingProfileQueueConfig
|
2824
|
+
# data as a hash:
|
2825
|
+
#
|
2826
|
+
# {
|
2827
|
+
# queue_reference: { # required
|
2828
|
+
# queue_id: "QueueId", # required
|
2829
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2830
|
+
# },
|
2831
|
+
# priority: 1, # required
|
2832
|
+
# delay: 1, # required
|
2833
|
+
# }
|
2834
|
+
#
|
2835
|
+
# @!attribute [rw] queue_reference
|
2836
|
+
# Contains information about a queue resource.
|
2837
|
+
# @return [Types::RoutingProfileQueueReference]
|
2838
|
+
#
|
2839
|
+
# @!attribute [rw] priority
|
2840
|
+
# The order in which contacts are to be handled for the queue. For
|
2841
|
+
# more information, see [Queues: priority and delay][1].
|
2842
|
+
#
|
2843
|
+
#
|
2844
|
+
#
|
2845
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2846
|
+
# @return [Integer]
|
2847
|
+
#
|
2848
|
+
# @!attribute [rw] delay
|
2849
|
+
# The delay, in seconds, a contact should be in the queue before they
|
2850
|
+
# are routed to an available agent. For more information, see [Queues:
|
2851
|
+
# priority and delay][1] in the *Amazon Connect Administrator Guide*.
|
2852
|
+
#
|
2853
|
+
#
|
2854
|
+
#
|
2855
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2856
|
+
# @return [Integer]
|
2857
|
+
#
|
2858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfig AWS API Documentation
|
2859
|
+
#
|
2860
|
+
class RoutingProfileQueueConfig < Struct.new(
|
2861
|
+
:queue_reference,
|
2862
|
+
:priority,
|
2863
|
+
:delay)
|
2864
|
+
SENSITIVE = []
|
2865
|
+
include Aws::Structure
|
2866
|
+
end
|
2867
|
+
|
2868
|
+
# Contains summary information about a routing profile queue.
|
2869
|
+
#
|
2870
|
+
# @!attribute [rw] queue_id
|
2871
|
+
# The identifier of the queue.
|
2872
|
+
# @return [String]
|
2873
|
+
#
|
2874
|
+
# @!attribute [rw] queue_arn
|
2875
|
+
# The Amazon Resource Name (ARN) of the queue.
|
2876
|
+
# @return [String]
|
2877
|
+
#
|
2878
|
+
# @!attribute [rw] queue_name
|
2879
|
+
# The name of the queue.
|
2880
|
+
# @return [String]
|
2881
|
+
#
|
2882
|
+
# @!attribute [rw] priority
|
2883
|
+
# The order in which contacts are to be handled for the queue. For
|
2884
|
+
# more information, see [Queues: priority and delay][1].
|
2885
|
+
#
|
2886
|
+
#
|
2887
|
+
#
|
2888
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2889
|
+
# @return [Integer]
|
2890
|
+
#
|
2891
|
+
# @!attribute [rw] delay
|
2892
|
+
# The delay, in seconds, that a contact should be in the queue before
|
2893
|
+
# they are routed to an available agent. For more information, see
|
2894
|
+
# [Queues: priority and delay][1] in the *Amazon Connect Administrator
|
2895
|
+
# Guide*.
|
2896
|
+
#
|
2897
|
+
#
|
2898
|
+
#
|
2899
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2900
|
+
# @return [Integer]
|
2901
|
+
#
|
2902
|
+
# @!attribute [rw] channel
|
2903
|
+
# The channels this queue supports.
|
1925
2904
|
# @return [String]
|
1926
2905
|
#
|
1927
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfigSummary AWS API Documentation
|
1928
2907
|
#
|
1929
|
-
class
|
1930
|
-
:
|
2908
|
+
class RoutingProfileQueueConfigSummary < Struct.new(
|
2909
|
+
:queue_id,
|
2910
|
+
:queue_arn,
|
2911
|
+
:queue_name,
|
2912
|
+
:priority,
|
2913
|
+
:delay,
|
2914
|
+
:channel)
|
1931
2915
|
SENSITIVE = []
|
1932
2916
|
include Aws::Structure
|
1933
2917
|
end
|
1934
2918
|
|
1935
|
-
#
|
2919
|
+
# Contains the channel and queue identifier for a routing profile.
|
2920
|
+
#
|
2921
|
+
# @note When making an API call, you may pass RoutingProfileQueueReference
|
1936
2922
|
# data as a hash:
|
1937
2923
|
#
|
1938
2924
|
# {
|
1939
|
-
#
|
1940
|
-
#
|
1941
|
-
# initial_contact_id: "ContactId", # required
|
2925
|
+
# queue_id: "QueueId", # required
|
2926
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
1942
2927
|
# }
|
1943
2928
|
#
|
1944
|
-
# @!attribute [rw]
|
1945
|
-
# The identifier of the
|
1946
|
-
# @return [String]
|
1947
|
-
#
|
1948
|
-
# @!attribute [rw] contact_id
|
1949
|
-
# The identifier of the contact.
|
2929
|
+
# @!attribute [rw] queue_id
|
2930
|
+
# The identifier of the queue.
|
1950
2931
|
# @return [String]
|
1951
2932
|
#
|
1952
|
-
# @!attribute [rw]
|
1953
|
-
# The
|
1954
|
-
#
|
2933
|
+
# @!attribute [rw] channel
|
2934
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2935
|
+
# for this routing profile.
|
1955
2936
|
# @return [String]
|
1956
2937
|
#
|
1957
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueReference AWS API Documentation
|
1958
2939
|
#
|
1959
|
-
class
|
1960
|
-
:
|
1961
|
-
:
|
1962
|
-
:initial_contact_id)
|
2940
|
+
class RoutingProfileQueueReference < Struct.new(
|
2941
|
+
:queue_id,
|
2942
|
+
:channel)
|
1963
2943
|
SENSITIVE = []
|
1964
2944
|
include Aws::Structure
|
1965
2945
|
end
|
1966
2946
|
|
1967
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingResponse AWS API Documentation
|
1968
|
-
#
|
1969
|
-
class ResumeContactRecordingResponse < Aws::EmptyStructure; end
|
1970
|
-
|
1971
2947
|
# Contains summary information about a routing profile.
|
1972
2948
|
#
|
1973
2949
|
# @!attribute [rw] id
|
@@ -2040,7 +3016,14 @@ module Aws::Connect
|
|
2040
3016
|
# @return [String]
|
2041
3017
|
#
|
2042
3018
|
# @!attribute [rw] contact_flow_id
|
2043
|
-
# The identifier of the contact flow for the chat.
|
3019
|
+
# The identifier of the contact flow for initiating the chat. To see
|
3020
|
+
# the ContactFlowId in the Amazon Connect console user interface, on
|
3021
|
+
# the navigation menu go to **Routing**, **Contact Flows**. Choose the
|
3022
|
+
# contact flow. On the contact flow page, under the name of the
|
3023
|
+
# contact flow, choose **Show additional flow information**. The
|
3024
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
3025
|
+
#
|
3026
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
2044
3027
|
# @return [String]
|
2045
3028
|
#
|
2046
3029
|
# @!attribute [rw] attributes
|
@@ -2175,7 +3158,14 @@ module Aws::Connect
|
|
2175
3158
|
# @return [String]
|
2176
3159
|
#
|
2177
3160
|
# @!attribute [rw] contact_flow_id
|
2178
|
-
# The identifier of the contact flow for the outbound call.
|
3161
|
+
# The identifier of the contact flow for the outbound call. To see the
|
3162
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
3163
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
3164
|
+
# contact flow. On the contact flow page, under the name of the
|
3165
|
+
# contact flow, choose **Show additional flow information**. The
|
3166
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
3167
|
+
#
|
3168
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
2179
3169
|
# @return [String]
|
2180
3170
|
#
|
2181
3171
|
# @!attribute [rw] instance_id
|
@@ -2480,6 +3470,258 @@ module Aws::Connect
|
|
2480
3470
|
#
|
2481
3471
|
class UpdateContactAttributesResponse < Aws::EmptyStructure; end
|
2482
3472
|
|
3473
|
+
# @note When making an API call, you may pass UpdateContactFlowContentRequest
|
3474
|
+
# data as a hash:
|
3475
|
+
#
|
3476
|
+
# {
|
3477
|
+
# instance_id: "InstanceId", # required
|
3478
|
+
# contact_flow_id: "ContactFlowId", # required
|
3479
|
+
# content: "ContactFlowContent", # required
|
3480
|
+
# }
|
3481
|
+
#
|
3482
|
+
# @!attribute [rw] instance_id
|
3483
|
+
# The identifier of the Amazon Connect instance.
|
3484
|
+
# @return [String]
|
3485
|
+
#
|
3486
|
+
# @!attribute [rw] contact_flow_id
|
3487
|
+
# The identifier of the contact flow.
|
3488
|
+
# @return [String]
|
3489
|
+
#
|
3490
|
+
# @!attribute [rw] content
|
3491
|
+
# The JSON string that represents contact flow’s content. For an
|
3492
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
3493
|
+
# language][1] in the *Amazon Connect Administrator Guide*.
|
3494
|
+
#
|
3495
|
+
#
|
3496
|
+
#
|
3497
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
|
3498
|
+
# @return [String]
|
3499
|
+
#
|
3500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContentRequest AWS API Documentation
|
3501
|
+
#
|
3502
|
+
class UpdateContactFlowContentRequest < Struct.new(
|
3503
|
+
:instance_id,
|
3504
|
+
:contact_flow_id,
|
3505
|
+
:content)
|
3506
|
+
SENSITIVE = []
|
3507
|
+
include Aws::Structure
|
3508
|
+
end
|
3509
|
+
|
3510
|
+
# @note When making an API call, you may pass UpdateContactFlowNameRequest
|
3511
|
+
# data as a hash:
|
3512
|
+
#
|
3513
|
+
# {
|
3514
|
+
# instance_id: "InstanceId", # required
|
3515
|
+
# contact_flow_id: "ContactFlowId", # required
|
3516
|
+
# name: "ContactFlowName",
|
3517
|
+
# description: "ContactFlowDescription",
|
3518
|
+
# }
|
3519
|
+
#
|
3520
|
+
# @!attribute [rw] instance_id
|
3521
|
+
# The identifier of the Amazon Connect instance.
|
3522
|
+
# @return [String]
|
3523
|
+
#
|
3524
|
+
# @!attribute [rw] contact_flow_id
|
3525
|
+
# The identifier of the contact flow.
|
3526
|
+
# @return [String]
|
3527
|
+
#
|
3528
|
+
# @!attribute [rw] name
|
3529
|
+
# The name of the contact flow.
|
3530
|
+
# @return [String]
|
3531
|
+
#
|
3532
|
+
# @!attribute [rw] description
|
3533
|
+
# The description of the contact flow.
|
3534
|
+
# @return [String]
|
3535
|
+
#
|
3536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowNameRequest AWS API Documentation
|
3537
|
+
#
|
3538
|
+
class UpdateContactFlowNameRequest < Struct.new(
|
3539
|
+
:instance_id,
|
3540
|
+
:contact_flow_id,
|
3541
|
+
:name,
|
3542
|
+
:description)
|
3543
|
+
SENSITIVE = []
|
3544
|
+
include Aws::Structure
|
3545
|
+
end
|
3546
|
+
|
3547
|
+
# @note When making an API call, you may pass UpdateRoutingProfileConcurrencyRequest
|
3548
|
+
# data as a hash:
|
3549
|
+
#
|
3550
|
+
# {
|
3551
|
+
# instance_id: "InstanceId", # required
|
3552
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3553
|
+
# media_concurrencies: [ # required
|
3554
|
+
# {
|
3555
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3556
|
+
# concurrency: 1, # required
|
3557
|
+
# },
|
3558
|
+
# ],
|
3559
|
+
# }
|
3560
|
+
#
|
3561
|
+
# @!attribute [rw] instance_id
|
3562
|
+
# The identifier of the Amazon Connect instance.
|
3563
|
+
# @return [String]
|
3564
|
+
#
|
3565
|
+
# @!attribute [rw] routing_profile_id
|
3566
|
+
# The identifier of the routing profile.
|
3567
|
+
# @return [String]
|
3568
|
+
#
|
3569
|
+
# @!attribute [rw] media_concurrencies
|
3570
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
3571
|
+
# @return [Array<Types::MediaConcurrency>]
|
3572
|
+
#
|
3573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrencyRequest AWS API Documentation
|
3574
|
+
#
|
3575
|
+
class UpdateRoutingProfileConcurrencyRequest < Struct.new(
|
3576
|
+
:instance_id,
|
3577
|
+
:routing_profile_id,
|
3578
|
+
:media_concurrencies)
|
3579
|
+
SENSITIVE = []
|
3580
|
+
include Aws::Structure
|
3581
|
+
end
|
3582
|
+
|
3583
|
+
# @note When making an API call, you may pass UpdateRoutingProfileDefaultOutboundQueueRequest
|
3584
|
+
# data as a hash:
|
3585
|
+
#
|
3586
|
+
# {
|
3587
|
+
# instance_id: "InstanceId", # required
|
3588
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3589
|
+
# default_outbound_queue_id: "QueueId", # required
|
3590
|
+
# }
|
3591
|
+
#
|
3592
|
+
# @!attribute [rw] instance_id
|
3593
|
+
# The identifier of the Amazon Connect instance.
|
3594
|
+
# @return [String]
|
3595
|
+
#
|
3596
|
+
# @!attribute [rw] routing_profile_id
|
3597
|
+
# The identifier of the routing profile.
|
3598
|
+
# @return [String]
|
3599
|
+
#
|
3600
|
+
# @!attribute [rw] default_outbound_queue_id
|
3601
|
+
# The identifier for the default outbound queue.
|
3602
|
+
# @return [String]
|
3603
|
+
#
|
3604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueueRequest AWS API Documentation
|
3605
|
+
#
|
3606
|
+
class UpdateRoutingProfileDefaultOutboundQueueRequest < Struct.new(
|
3607
|
+
:instance_id,
|
3608
|
+
:routing_profile_id,
|
3609
|
+
:default_outbound_queue_id)
|
3610
|
+
SENSITIVE = []
|
3611
|
+
include Aws::Structure
|
3612
|
+
end
|
3613
|
+
|
3614
|
+
# @note When making an API call, you may pass UpdateRoutingProfileNameRequest
|
3615
|
+
# data as a hash:
|
3616
|
+
#
|
3617
|
+
# {
|
3618
|
+
# instance_id: "InstanceId", # required
|
3619
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3620
|
+
# name: "RoutingProfileName",
|
3621
|
+
# description: "RoutingProfileDescription",
|
3622
|
+
# }
|
3623
|
+
#
|
3624
|
+
# @!attribute [rw] instance_id
|
3625
|
+
# The identifier of the Amazon Connect instance.
|
3626
|
+
# @return [String]
|
3627
|
+
#
|
3628
|
+
# @!attribute [rw] routing_profile_id
|
3629
|
+
# The identifier of the routing profile.
|
3630
|
+
# @return [String]
|
3631
|
+
#
|
3632
|
+
# @!attribute [rw] name
|
3633
|
+
# The name of the routing profile. Must not be more than 127
|
3634
|
+
# characters.
|
3635
|
+
# @return [String]
|
3636
|
+
#
|
3637
|
+
# @!attribute [rw] description
|
3638
|
+
# The description of the routing profile. Must not be more than 250
|
3639
|
+
# characters.
|
3640
|
+
# @return [String]
|
3641
|
+
#
|
3642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileNameRequest AWS API Documentation
|
3643
|
+
#
|
3644
|
+
class UpdateRoutingProfileNameRequest < Struct.new(
|
3645
|
+
:instance_id,
|
3646
|
+
:routing_profile_id,
|
3647
|
+
:name,
|
3648
|
+
:description)
|
3649
|
+
SENSITIVE = []
|
3650
|
+
include Aws::Structure
|
3651
|
+
end
|
3652
|
+
|
3653
|
+
# @note When making an API call, you may pass UpdateRoutingProfileQueuesRequest
|
3654
|
+
# data as a hash:
|
3655
|
+
#
|
3656
|
+
# {
|
3657
|
+
# instance_id: "InstanceId", # required
|
3658
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3659
|
+
# queue_configs: [ # required
|
3660
|
+
# {
|
3661
|
+
# queue_reference: { # required
|
3662
|
+
# queue_id: "QueueId", # required
|
3663
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3664
|
+
# },
|
3665
|
+
# priority: 1, # required
|
3666
|
+
# delay: 1, # required
|
3667
|
+
# },
|
3668
|
+
# ],
|
3669
|
+
# }
|
3670
|
+
#
|
3671
|
+
# @!attribute [rw] instance_id
|
3672
|
+
# The identifier of the Amazon Connect instance.
|
3673
|
+
# @return [String]
|
3674
|
+
#
|
3675
|
+
# @!attribute [rw] routing_profile_id
|
3676
|
+
# The identifier of the routing profile.
|
3677
|
+
# @return [String]
|
3678
|
+
#
|
3679
|
+
# @!attribute [rw] queue_configs
|
3680
|
+
# The queues to be updated for this routing profile.
|
3681
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
3682
|
+
#
|
3683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueuesRequest AWS API Documentation
|
3684
|
+
#
|
3685
|
+
class UpdateRoutingProfileQueuesRequest < Struct.new(
|
3686
|
+
:instance_id,
|
3687
|
+
:routing_profile_id,
|
3688
|
+
:queue_configs)
|
3689
|
+
SENSITIVE = []
|
3690
|
+
include Aws::Structure
|
3691
|
+
end
|
3692
|
+
|
3693
|
+
# @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
|
3694
|
+
# data as a hash:
|
3695
|
+
#
|
3696
|
+
# {
|
3697
|
+
# name: "HierarchyGroupName", # required
|
3698
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
3699
|
+
# instance_id: "InstanceId", # required
|
3700
|
+
# }
|
3701
|
+
#
|
3702
|
+
# @!attribute [rw] name
|
3703
|
+
# The name of the hierarchy group. Must not be more than 100
|
3704
|
+
# characters.
|
3705
|
+
# @return [String]
|
3706
|
+
#
|
3707
|
+
# @!attribute [rw] hierarchy_group_id
|
3708
|
+
# The identifier of the hierarchy group.
|
3709
|
+
# @return [String]
|
3710
|
+
#
|
3711
|
+
# @!attribute [rw] instance_id
|
3712
|
+
# The identifier of the Amazon Connect instance.
|
3713
|
+
# @return [String]
|
3714
|
+
#
|
3715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyGroupNameRequest AWS API Documentation
|
3716
|
+
#
|
3717
|
+
class UpdateUserHierarchyGroupNameRequest < Struct.new(
|
3718
|
+
:name,
|
3719
|
+
:hierarchy_group_id,
|
3720
|
+
:instance_id)
|
3721
|
+
SENSITIVE = []
|
3722
|
+
include Aws::Structure
|
3723
|
+
end
|
3724
|
+
|
2483
3725
|
# @note When making an API call, you may pass UpdateUserHierarchyRequest
|
2484
3726
|
# data as a hash:
|
2485
3727
|
#
|
@@ -2511,6 +3753,47 @@ module Aws::Connect
|
|
2511
3753
|
include Aws::Structure
|
2512
3754
|
end
|
2513
3755
|
|
3756
|
+
# @note When making an API call, you may pass UpdateUserHierarchyStructureRequest
|
3757
|
+
# data as a hash:
|
3758
|
+
#
|
3759
|
+
# {
|
3760
|
+
# hierarchy_structure: { # required
|
3761
|
+
# level_one: {
|
3762
|
+
# name: "HierarchyLevelName", # required
|
3763
|
+
# },
|
3764
|
+
# level_two: {
|
3765
|
+
# name: "HierarchyLevelName", # required
|
3766
|
+
# },
|
3767
|
+
# level_three: {
|
3768
|
+
# name: "HierarchyLevelName", # required
|
3769
|
+
# },
|
3770
|
+
# level_four: {
|
3771
|
+
# name: "HierarchyLevelName", # required
|
3772
|
+
# },
|
3773
|
+
# level_five: {
|
3774
|
+
# name: "HierarchyLevelName", # required
|
3775
|
+
# },
|
3776
|
+
# },
|
3777
|
+
# instance_id: "InstanceId", # required
|
3778
|
+
# }
|
3779
|
+
#
|
3780
|
+
# @!attribute [rw] hierarchy_structure
|
3781
|
+
# The hierarchy levels to update.
|
3782
|
+
# @return [Types::HierarchyStructureUpdate]
|
3783
|
+
#
|
3784
|
+
# @!attribute [rw] instance_id
|
3785
|
+
# The identifier of the Amazon Connect instance.
|
3786
|
+
# @return [String]
|
3787
|
+
#
|
3788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyStructureRequest AWS API Documentation
|
3789
|
+
#
|
3790
|
+
class UpdateUserHierarchyStructureRequest < Struct.new(
|
3791
|
+
:hierarchy_structure,
|
3792
|
+
:instance_id)
|
3793
|
+
SENSITIVE = []
|
3794
|
+
include Aws::Structure
|
3795
|
+
end
|
3796
|
+
|
2514
3797
|
# @note When making an API call, you may pass UpdateUserIdentityInfoRequest
|
2515
3798
|
# data as a hash:
|
2516
3799
|
#
|