aws-sdk-connect 1.29.0 → 1.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +4 -3
- data/lib/aws-sdk-connect/client.rb +849 -24
- data/lib/aws-sdk-connect/client_api.rb +414 -0
- data/lib/aws-sdk-connect/errors.rb +32 -0
- data/lib/aws-sdk-connect/types.rb +1108 -73
- metadata +4 -4
@@ -27,10 +27,12 @@ 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}
|
@@ -45,6 +47,21 @@ module Aws::Connect
|
|
45
47
|
|
46
48
|
extend Aws::Errors::DynamicErrors
|
47
49
|
|
50
|
+
class ContactFlowNotPublishedException < ServiceError
|
51
|
+
|
52
|
+
# @param [Seahorse::Client::RequestContext] context
|
53
|
+
# @param [String] message
|
54
|
+
# @param [Aws::Connect::Types::ContactFlowNotPublishedException] data
|
55
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
56
|
+
super(context, message, data)
|
57
|
+
end
|
58
|
+
|
59
|
+
# @return [String]
|
60
|
+
def message
|
61
|
+
@message || @data[:message]
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
48
65
|
class ContactNotFoundException < ServiceError
|
49
66
|
|
50
67
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -105,6 +122,21 @@ module Aws::Connect
|
|
105
122
|
end
|
106
123
|
end
|
107
124
|
|
125
|
+
class InvalidContactFlowException < ServiceError
|
126
|
+
|
127
|
+
# @param [Seahorse::Client::RequestContext] context
|
128
|
+
# @param [String] message
|
129
|
+
# @param [Aws::Connect::Types::InvalidContactFlowException] data
|
130
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
131
|
+
super(context, message, data)
|
132
|
+
end
|
133
|
+
|
134
|
+
# @return [String]
|
135
|
+
def problems
|
136
|
+
@data[:problems]
|
137
|
+
end
|
138
|
+
end
|
139
|
+
|
108
140
|
class InvalidParameterException < ServiceError
|
109
141
|
|
110
142
|
# @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,172 @@ 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
|
+
|
83
359
|
# @note When making an API call, you may pass CreateUserRequest
|
84
360
|
# data as a hash:
|
85
361
|
#
|
@@ -325,6 +601,80 @@ module Aws::Connect
|
|
325
601
|
include Aws::Structure
|
326
602
|
end
|
327
603
|
|
604
|
+
# @note When making an API call, you may pass DescribeContactFlowRequest
|
605
|
+
# data as a hash:
|
606
|
+
#
|
607
|
+
# {
|
608
|
+
# instance_id: "InstanceId", # required
|
609
|
+
# contact_flow_id: "ContactFlowId", # required
|
610
|
+
# }
|
611
|
+
#
|
612
|
+
# @!attribute [rw] instance_id
|
613
|
+
# The identifier of the Amazon Connect instance.
|
614
|
+
# @return [String]
|
615
|
+
#
|
616
|
+
# @!attribute [rw] contact_flow_id
|
617
|
+
# The identifier of the contact flow.
|
618
|
+
# @return [String]
|
619
|
+
#
|
620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowRequest AWS API Documentation
|
621
|
+
#
|
622
|
+
class DescribeContactFlowRequest < Struct.new(
|
623
|
+
:instance_id,
|
624
|
+
:contact_flow_id)
|
625
|
+
SENSITIVE = []
|
626
|
+
include Aws::Structure
|
627
|
+
end
|
628
|
+
|
629
|
+
# @!attribute [rw] contact_flow
|
630
|
+
# Information about the contact flow.
|
631
|
+
# @return [Types::ContactFlow]
|
632
|
+
#
|
633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowResponse AWS API Documentation
|
634
|
+
#
|
635
|
+
class DescribeContactFlowResponse < Struct.new(
|
636
|
+
:contact_flow)
|
637
|
+
SENSITIVE = []
|
638
|
+
include Aws::Structure
|
639
|
+
end
|
640
|
+
|
641
|
+
# @note When making an API call, you may pass DescribeRoutingProfileRequest
|
642
|
+
# data as a hash:
|
643
|
+
#
|
644
|
+
# {
|
645
|
+
# instance_id: "InstanceId", # required
|
646
|
+
# routing_profile_id: "RoutingProfileId", # required
|
647
|
+
# }
|
648
|
+
#
|
649
|
+
# @!attribute [rw] instance_id
|
650
|
+
# The identifier of the Amazon Connect instance.
|
651
|
+
# @return [String]
|
652
|
+
#
|
653
|
+
# @!attribute [rw] routing_profile_id
|
654
|
+
# The identifier of the routing profile.
|
655
|
+
# @return [String]
|
656
|
+
#
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileRequest AWS API Documentation
|
658
|
+
#
|
659
|
+
class DescribeRoutingProfileRequest < Struct.new(
|
660
|
+
:instance_id,
|
661
|
+
:routing_profile_id)
|
662
|
+
SENSITIVE = []
|
663
|
+
include Aws::Structure
|
664
|
+
end
|
665
|
+
|
666
|
+
# @!attribute [rw] routing_profile
|
667
|
+
# The routing profile.
|
668
|
+
# @return [Types::RoutingProfile]
|
669
|
+
#
|
670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileResponse AWS API Documentation
|
671
|
+
#
|
672
|
+
class DescribeRoutingProfileResponse < Struct.new(
|
673
|
+
:routing_profile)
|
674
|
+
SENSITIVE = []
|
675
|
+
include Aws::Structure
|
676
|
+
end
|
677
|
+
|
328
678
|
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
329
679
|
# data as a hash:
|
330
680
|
#
|
@@ -463,16 +813,52 @@ module Aws::Connect
|
|
463
813
|
include Aws::Structure
|
464
814
|
end
|
465
815
|
|
466
|
-
#
|
816
|
+
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
817
|
+
# data as a hash:
|
467
818
|
#
|
468
|
-
#
|
819
|
+
# {
|
820
|
+
# instance_id: "InstanceId", # required
|
821
|
+
# routing_profile_id: "RoutingProfileId", # required
|
822
|
+
# queue_references: [ # required
|
823
|
+
# {
|
824
|
+
# queue_id: "QueueId", # required
|
825
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
826
|
+
# },
|
827
|
+
# ],
|
828
|
+
# }
|
829
|
+
#
|
830
|
+
# @!attribute [rw] instance_id
|
831
|
+
# The identifier of the Amazon Connect instance.
|
469
832
|
# @return [String]
|
470
833
|
#
|
471
|
-
#
|
834
|
+
# @!attribute [rw] routing_profile_id
|
835
|
+
# The identifier of the routing profile.
|
836
|
+
# @return [String]
|
472
837
|
#
|
473
|
-
|
474
|
-
|
475
|
-
|
838
|
+
# @!attribute [rw] queue_references
|
839
|
+
# The queues to disassociate from this routing profile.
|
840
|
+
# @return [Array<Types::RoutingProfileQueueReference>]
|
841
|
+
#
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueuesRequest AWS API Documentation
|
843
|
+
#
|
844
|
+
class DisassociateRoutingProfileQueuesRequest < Struct.new(
|
845
|
+
:instance_id,
|
846
|
+
:routing_profile_id,
|
847
|
+
:queue_references)
|
848
|
+
SENSITIVE = []
|
849
|
+
include Aws::Structure
|
850
|
+
end
|
851
|
+
|
852
|
+
# A resource with the specified name already exists.
|
853
|
+
#
|
854
|
+
# @!attribute [rw] message
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DuplicateResourceException AWS API Documentation
|
858
|
+
#
|
859
|
+
class DuplicateResourceException < Struct.new(
|
860
|
+
:message)
|
861
|
+
SENSITIVE = []
|
476
862
|
include Aws::Structure
|
477
863
|
end
|
478
864
|
|
@@ -569,16 +955,16 @@ module Aws::Connect
|
|
569
955
|
# The queues, up to 100, or channels, to use to filter the metrics
|
570
956
|
# returned. Metric data is retrieved only for the resources associated
|
571
957
|
# with the queues or channels included in the filter. You can include
|
572
|
-
# both queue IDs and queue ARNs in the same request.
|
573
|
-
#
|
958
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
959
|
+
# `CHAT` channels are supported.
|
574
960
|
# @return [Types::Filters]
|
575
961
|
#
|
576
962
|
# @!attribute [rw] groupings
|
577
963
|
# The grouping applied to the metrics returned. For example, when
|
578
964
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
579
965
|
# than aggregated for all queues. If you group by `CHANNEL`, you
|
580
|
-
# should include a Channels filter.
|
581
|
-
#
|
966
|
+
# should include a Channels filter. Both `VOICE` and `CHAT` channels
|
967
|
+
# are supported.
|
582
968
|
#
|
583
969
|
# If no `Grouping` is included in the request, a summary of metrics is
|
584
970
|
# returned.
|
@@ -586,65 +972,112 @@ module Aws::Connect
|
|
586
972
|
#
|
587
973
|
# @!attribute [rw] current_metrics
|
588
974
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
589
|
-
# The following metrics are available. For a description of
|
590
|
-
#
|
975
|
+
# The following metrics are available. For a description of all the
|
976
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon
|
591
977
|
# Connect Administrator Guide*.
|
592
978
|
#
|
593
979
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
594
980
|
#
|
595
981
|
# : Unit: COUNT
|
596
982
|
#
|
983
|
+
# Name in real-time metrics report: [ACW][2]
|
984
|
+
#
|
597
985
|
# AGENTS\_AVAILABLE
|
598
986
|
#
|
599
987
|
# : Unit: COUNT
|
600
988
|
#
|
989
|
+
# Name in real-time metrics report: [Available][3]
|
990
|
+
#
|
601
991
|
# AGENTS\_ERROR
|
602
992
|
#
|
603
993
|
# : Unit: COUNT
|
604
994
|
#
|
995
|
+
# Name in real-time metrics report: [Error][4]
|
996
|
+
#
|
605
997
|
# AGENTS\_NON\_PRODUCTIVE
|
606
998
|
#
|
607
999
|
# : Unit: COUNT
|
608
1000
|
#
|
1001
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
1002
|
+
#
|
609
1003
|
# AGENTS\_ON\_CALL
|
610
1004
|
#
|
611
1005
|
# : Unit: COUNT
|
612
1006
|
#
|
1007
|
+
# Name in real-time metrics report: [On contact][6]
|
1008
|
+
#
|
613
1009
|
# AGENTS\_ON\_CONTACT
|
614
1010
|
#
|
615
1011
|
# : Unit: COUNT
|
616
1012
|
#
|
1013
|
+
# Name in real-time metrics report: [On contact][6]
|
1014
|
+
#
|
617
1015
|
# AGENTS\_ONLINE
|
618
1016
|
#
|
619
1017
|
# : Unit: COUNT
|
620
1018
|
#
|
1019
|
+
# Name in real-time metrics report: [Online][7]
|
1020
|
+
#
|
621
1021
|
# AGENTS\_STAFFED
|
622
1022
|
#
|
623
1023
|
# : Unit: COUNT
|
624
1024
|
#
|
1025
|
+
# Name in real-time metrics report: [Staffed][8]
|
1026
|
+
#
|
625
1027
|
# CONTACTS\_IN\_QUEUE
|
626
1028
|
#
|
627
1029
|
# : Unit: COUNT
|
628
1030
|
#
|
1031
|
+
# Name in real-time metrics report: [In queue][9]
|
1032
|
+
#
|
629
1033
|
# CONTACTS\_SCHEDULED
|
630
1034
|
#
|
631
1035
|
# : Unit: COUNT
|
632
1036
|
#
|
1037
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1038
|
+
#
|
633
1039
|
# OLDEST\_CONTACT\_AGE
|
634
1040
|
#
|
635
1041
|
# : Unit: SECONDS
|
636
1042
|
#
|
1043
|
+
# When you use groupings, Unit says SECONDS but the Value is
|
1044
|
+
# returned in MILLISECONDS. For example, if you get a response like
|
1045
|
+
# this:
|
1046
|
+
#
|
1047
|
+
# `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS"
|
1048
|
+
# \}, "Value": 24113.0 `\\}
|
1049
|
+
#
|
1050
|
+
# The actual OLDEST\_CONTACT\_AGE is 24 seconds.
|
1051
|
+
#
|
1052
|
+
# Name in real-time metrics report: [Oldest][11]
|
1053
|
+
#
|
637
1054
|
# SLOTS\_ACTIVE
|
638
1055
|
#
|
639
1056
|
# : Unit: COUNT
|
640
1057
|
#
|
1058
|
+
# Name in real-time metrics report: [Active][12]
|
1059
|
+
#
|
641
1060
|
# SLOTS\_AVAILABLE
|
642
1061
|
#
|
643
1062
|
# : Unit: COUNT
|
644
1063
|
#
|
1064
|
+
# Name in real-time metrics report: [Availability][13]
|
1065
|
+
#
|
645
1066
|
#
|
646
1067
|
#
|
647
1068
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
1069
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
|
1070
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
|
1071
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
|
1072
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
|
1073
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
|
1074
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
|
1075
|
+
# [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
|
1076
|
+
# [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
|
1077
|
+
# [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
|
1078
|
+
# [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
|
1079
|
+
# [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
|
1080
|
+
# [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
|
648
1081
|
# @return [Array<Types::CurrentMetric>]
|
649
1082
|
#
|
650
1083
|
# @!attribute [rw] next_token
|
@@ -789,8 +1222,8 @@ module Aws::Connect
|
|
789
1222
|
# The queues, up to 100, or channels, to use to filter the metrics
|
790
1223
|
# returned. Metric data is retrieved only for the resources associated
|
791
1224
|
# with the queues or channels included in the filter. You can include
|
792
|
-
# both queue IDs and queue ARNs in the same request.
|
793
|
-
#
|
1225
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1226
|
+
# `CHAT` channels are supported.
|
794
1227
|
# @return [Types::Filters]
|
795
1228
|
#
|
796
1229
|
# @!attribute [rw] groupings
|
@@ -1294,6 +1727,20 @@ module Aws::Connect
|
|
1294
1727
|
include Aws::Structure
|
1295
1728
|
end
|
1296
1729
|
|
1730
|
+
# The contact flow is not valid.
|
1731
|
+
#
|
1732
|
+
# @!attribute [rw] problems
|
1733
|
+
# The problems with the contact flow. Please fix before trying again.
|
1734
|
+
# @return [Array<Types::ProblemDetail>]
|
1735
|
+
#
|
1736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidContactFlowException AWS API Documentation
|
1737
|
+
#
|
1738
|
+
class InvalidContactFlowException < Struct.new(
|
1739
|
+
:problems)
|
1740
|
+
SENSITIVE = []
|
1741
|
+
include Aws::Structure
|
1742
|
+
end
|
1743
|
+
|
1297
1744
|
# One or more of the specified parameters are not valid.
|
1298
1745
|
#
|
1299
1746
|
# @!attribute [rw] message
|
@@ -1507,6 +1954,57 @@ module Aws::Connect
|
|
1507
1954
|
include Aws::Structure
|
1508
1955
|
end
|
1509
1956
|
|
1957
|
+
# @note When making an API call, you may pass ListPromptsRequest
|
1958
|
+
# data as a hash:
|
1959
|
+
#
|
1960
|
+
# {
|
1961
|
+
# instance_id: "InstanceId", # required
|
1962
|
+
# next_token: "NextToken",
|
1963
|
+
# max_results: 1,
|
1964
|
+
# }
|
1965
|
+
#
|
1966
|
+
# @!attribute [rw] instance_id
|
1967
|
+
# The identifier of the Amazon Connect instance.
|
1968
|
+
# @return [String]
|
1969
|
+
#
|
1970
|
+
# @!attribute [rw] next_token
|
1971
|
+
# The token for the next set of results. Use the value returned in the
|
1972
|
+
# previous response in the next request to retrieve the next set of
|
1973
|
+
# results.
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @!attribute [rw] max_results
|
1977
|
+
# The maximum number of results to return per page.
|
1978
|
+
# @return [Integer]
|
1979
|
+
#
|
1980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsRequest AWS API Documentation
|
1981
|
+
#
|
1982
|
+
class ListPromptsRequest < Struct.new(
|
1983
|
+
:instance_id,
|
1984
|
+
:next_token,
|
1985
|
+
:max_results)
|
1986
|
+
SENSITIVE = []
|
1987
|
+
include Aws::Structure
|
1988
|
+
end
|
1989
|
+
|
1990
|
+
# @!attribute [rw] prompt_summary_list
|
1991
|
+
# Information about the prompts.
|
1992
|
+
# @return [Array<Types::PromptSummary>]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] next_token
|
1995
|
+
# If there are additional results, this is the token for the next set
|
1996
|
+
# of results.
|
1997
|
+
# @return [String]
|
1998
|
+
#
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsResponse AWS API Documentation
|
2000
|
+
#
|
2001
|
+
class ListPromptsResponse < Struct.new(
|
2002
|
+
:prompt_summary_list,
|
2003
|
+
:next_token)
|
2004
|
+
SENSITIVE = []
|
2005
|
+
include Aws::Structure
|
2006
|
+
end
|
2007
|
+
|
1510
2008
|
# @note When making an API call, you may pass ListQueuesRequest
|
1511
2009
|
# data as a hash:
|
1512
2010
|
#
|
@@ -1564,6 +2062,63 @@ module Aws::Connect
|
|
1564
2062
|
include Aws::Structure
|
1565
2063
|
end
|
1566
2064
|
|
2065
|
+
# @note When making an API call, you may pass ListRoutingProfileQueuesRequest
|
2066
|
+
# data as a hash:
|
2067
|
+
#
|
2068
|
+
# {
|
2069
|
+
# instance_id: "InstanceId", # required
|
2070
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2071
|
+
# next_token: "NextToken",
|
2072
|
+
# max_results: 1,
|
2073
|
+
# }
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] instance_id
|
2076
|
+
# The identifier of the Amazon Connect instance.
|
2077
|
+
# @return [String]
|
2078
|
+
#
|
2079
|
+
# @!attribute [rw] routing_profile_id
|
2080
|
+
# The identifier of the routing profile.
|
2081
|
+
# @return [String]
|
2082
|
+
#
|
2083
|
+
# @!attribute [rw] next_token
|
2084
|
+
# The token for the next set of results. Use the value returned in the
|
2085
|
+
# previous response in the next request to retrieve the next set of
|
2086
|
+
# results.
|
2087
|
+
# @return [String]
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] max_results
|
2090
|
+
# The maximimum number of results to return per page.
|
2091
|
+
# @return [Integer]
|
2092
|
+
#
|
2093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesRequest AWS API Documentation
|
2094
|
+
#
|
2095
|
+
class ListRoutingProfileQueuesRequest < Struct.new(
|
2096
|
+
:instance_id,
|
2097
|
+
:routing_profile_id,
|
2098
|
+
:next_token,
|
2099
|
+
:max_results)
|
2100
|
+
SENSITIVE = []
|
2101
|
+
include Aws::Structure
|
2102
|
+
end
|
2103
|
+
|
2104
|
+
# @!attribute [rw] next_token
|
2105
|
+
# If there are additional results, this is the token for the next set
|
2106
|
+
# of results.
|
2107
|
+
# @return [String]
|
2108
|
+
#
|
2109
|
+
# @!attribute [rw] routing_profile_queue_config_summary_list
|
2110
|
+
# Information about the routing profiles.
|
2111
|
+
# @return [Array<Types::RoutingProfileQueueConfigSummary>]
|
2112
|
+
#
|
2113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesResponse AWS API Documentation
|
2114
|
+
#
|
2115
|
+
class ListRoutingProfileQueuesResponse < Struct.new(
|
2116
|
+
:next_token,
|
2117
|
+
:routing_profile_queue_config_summary_list)
|
2118
|
+
SENSITIVE = []
|
2119
|
+
include Aws::Structure
|
2120
|
+
end
|
2121
|
+
|
1567
2122
|
# @note When making an API call, you may pass ListRoutingProfilesRequest
|
1568
2123
|
# data as a hash:
|
1569
2124
|
#
|
@@ -1799,6 +2354,36 @@ module Aws::Connect
|
|
1799
2354
|
include Aws::Structure
|
1800
2355
|
end
|
1801
2356
|
|
2357
|
+
# Contains information about which channels are supported, and how many
|
2358
|
+
# contacts an agent can have on a channel simultaneously.
|
2359
|
+
#
|
2360
|
+
# @note When making an API call, you may pass MediaConcurrency
|
2361
|
+
# data as a hash:
|
2362
|
+
#
|
2363
|
+
# {
|
2364
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2365
|
+
# concurrency: 1, # required
|
2366
|
+
# }
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] channel
|
2369
|
+
# The channels that agents can handle in the Contact Control Panel
|
2370
|
+
# (CCP).
|
2371
|
+
# @return [String]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] concurrency
|
2374
|
+
# The number of contacts an agent can have on a channel
|
2375
|
+
# simultaneously.
|
2376
|
+
# @return [Integer]
|
2377
|
+
#
|
2378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MediaConcurrency AWS API Documentation
|
2379
|
+
#
|
2380
|
+
class MediaConcurrency < Struct.new(
|
2381
|
+
:channel,
|
2382
|
+
:concurrency)
|
2383
|
+
SENSITIVE = []
|
2384
|
+
include Aws::Structure
|
2385
|
+
end
|
2386
|
+
|
1802
2387
|
# The contact is not permitted.
|
1803
2388
|
#
|
1804
2389
|
# @!attribute [rw] message
|
@@ -1869,105 +2454,321 @@ module Aws::Connect
|
|
1869
2454
|
include Aws::Structure
|
1870
2455
|
end
|
1871
2456
|
|
1872
|
-
#
|
1873
|
-
#
|
2457
|
+
# Information about a problem detail.
|
2458
|
+
#
|
2459
|
+
# @!attribute [rw] message
|
2460
|
+
# The problem detail's message.
|
2461
|
+
# @return [String]
|
2462
|
+
#
|
2463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ProblemDetail AWS API Documentation
|
2464
|
+
#
|
2465
|
+
class ProblemDetail < Struct.new(
|
2466
|
+
:message)
|
2467
|
+
SENSITIVE = []
|
2468
|
+
include Aws::Structure
|
2469
|
+
end
|
2470
|
+
|
2471
|
+
# Contains information about the prompt.
|
2472
|
+
#
|
2473
|
+
# @!attribute [rw] id
|
2474
|
+
# The identifier of the prompt.
|
2475
|
+
# @return [String]
|
2476
|
+
#
|
2477
|
+
# @!attribute [rw] arn
|
2478
|
+
# The Amazon Resource Name (ARN) of the prompt.
|
2479
|
+
# @return [String]
|
2480
|
+
#
|
2481
|
+
# @!attribute [rw] name
|
2482
|
+
# The name of the prompt.
|
2483
|
+
# @return [String]
|
2484
|
+
#
|
2485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PromptSummary AWS API Documentation
|
2486
|
+
#
|
2487
|
+
class PromptSummary < Struct.new(
|
2488
|
+
:id,
|
2489
|
+
:arn,
|
2490
|
+
:name)
|
2491
|
+
SENSITIVE = []
|
2492
|
+
include Aws::Structure
|
2493
|
+
end
|
2494
|
+
|
2495
|
+
# Contains information about a queue resource for which metrics are
|
2496
|
+
# returned.
|
2497
|
+
#
|
2498
|
+
# @!attribute [rw] id
|
2499
|
+
# The identifier of the queue.
|
2500
|
+
# @return [String]
|
2501
|
+
#
|
2502
|
+
# @!attribute [rw] arn
|
2503
|
+
# The Amazon Resource Name (ARN) of the queue.
|
2504
|
+
# @return [String]
|
2505
|
+
#
|
2506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueReference AWS API Documentation
|
2507
|
+
#
|
2508
|
+
class QueueReference < Struct.new(
|
2509
|
+
:id,
|
2510
|
+
:arn)
|
2511
|
+
SENSITIVE = []
|
2512
|
+
include Aws::Structure
|
2513
|
+
end
|
2514
|
+
|
2515
|
+
# Contains summary information about a queue.
|
2516
|
+
#
|
2517
|
+
# @!attribute [rw] id
|
2518
|
+
# The identifier of the queue.
|
2519
|
+
# @return [String]
|
2520
|
+
#
|
2521
|
+
# @!attribute [rw] arn
|
2522
|
+
# The Amazon Resource Name (ARN) of the queue.
|
2523
|
+
# @return [String]
|
2524
|
+
#
|
2525
|
+
# @!attribute [rw] name
|
2526
|
+
# The name of the queue.
|
2527
|
+
# @return [String]
|
2528
|
+
#
|
2529
|
+
# @!attribute [rw] queue_type
|
2530
|
+
# The type of queue.
|
2531
|
+
# @return [String]
|
2532
|
+
#
|
2533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueSummary AWS API Documentation
|
2534
|
+
#
|
2535
|
+
class QueueSummary < Struct.new(
|
2536
|
+
:id,
|
2537
|
+
:arn,
|
2538
|
+
:name,
|
2539
|
+
:queue_type)
|
2540
|
+
SENSITIVE = []
|
2541
|
+
include Aws::Structure
|
2542
|
+
end
|
2543
|
+
|
2544
|
+
# The specified resource was not found.
|
2545
|
+
#
|
2546
|
+
# @!attribute [rw] message
|
2547
|
+
# The message.
|
2548
|
+
# @return [String]
|
2549
|
+
#
|
2550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceNotFoundException AWS API Documentation
|
2551
|
+
#
|
2552
|
+
class ResourceNotFoundException < Struct.new(
|
2553
|
+
:message)
|
2554
|
+
SENSITIVE = []
|
2555
|
+
include Aws::Structure
|
2556
|
+
end
|
2557
|
+
|
2558
|
+
# @note When making an API call, you may pass ResumeContactRecordingRequest
|
2559
|
+
# data as a hash:
|
2560
|
+
#
|
2561
|
+
# {
|
2562
|
+
# instance_id: "InstanceId", # required
|
2563
|
+
# contact_id: "ContactId", # required
|
2564
|
+
# initial_contact_id: "ContactId", # required
|
2565
|
+
# }
|
2566
|
+
#
|
2567
|
+
# @!attribute [rw] instance_id
|
2568
|
+
# The identifier of the Amazon Connect instance.
|
2569
|
+
# @return [String]
|
2570
|
+
#
|
2571
|
+
# @!attribute [rw] contact_id
|
2572
|
+
# The identifier of the contact.
|
2573
|
+
# @return [String]
|
2574
|
+
#
|
2575
|
+
# @!attribute [rw] initial_contact_id
|
2576
|
+
# The identifier of the contact. This is the identifier of the contact
|
2577
|
+
# associated with the first interaction with the contact center.
|
2578
|
+
# @return [String]
|
2579
|
+
#
|
2580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingRequest AWS API Documentation
|
2581
|
+
#
|
2582
|
+
class ResumeContactRecordingRequest < Struct.new(
|
2583
|
+
:instance_id,
|
2584
|
+
:contact_id,
|
2585
|
+
:initial_contact_id)
|
2586
|
+
SENSITIVE = []
|
2587
|
+
include Aws::Structure
|
2588
|
+
end
|
2589
|
+
|
2590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingResponse AWS API Documentation
|
2591
|
+
#
|
2592
|
+
class ResumeContactRecordingResponse < Aws::EmptyStructure; end
|
2593
|
+
|
2594
|
+
# Contains information about a routing profile.
|
2595
|
+
#
|
2596
|
+
# @!attribute [rw] instance_id
|
2597
|
+
# The identifier of the Amazon Connect instance.
|
2598
|
+
# @return [String]
|
2599
|
+
#
|
2600
|
+
# @!attribute [rw] name
|
2601
|
+
# The name of the routing profile.
|
2602
|
+
# @return [String]
|
2603
|
+
#
|
2604
|
+
# @!attribute [rw] routing_profile_arn
|
2605
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
2606
|
+
# @return [String]
|
2607
|
+
#
|
2608
|
+
# @!attribute [rw] routing_profile_id
|
2609
|
+
# The identifier of the routing profile.
|
2610
|
+
# @return [String]
|
2611
|
+
#
|
2612
|
+
# @!attribute [rw] description
|
2613
|
+
# The description of the routing profile.
|
2614
|
+
# @return [String]
|
2615
|
+
#
|
2616
|
+
# @!attribute [rw] media_concurrencies
|
2617
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2618
|
+
# for this routing profile.
|
2619
|
+
# @return [Array<Types::MediaConcurrency>]
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] default_outbound_queue_id
|
2622
|
+
# The identifier of the default outbound queue for this routing
|
2623
|
+
# profile.
|
2624
|
+
# @return [String]
|
2625
|
+
#
|
2626
|
+
# @!attribute [rw] tags
|
2627
|
+
# One or more tags.
|
2628
|
+
# @return [Hash<String,String>]
|
2629
|
+
#
|
2630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfile AWS API Documentation
|
2631
|
+
#
|
2632
|
+
class RoutingProfile < Struct.new(
|
2633
|
+
:instance_id,
|
2634
|
+
:name,
|
2635
|
+
:routing_profile_arn,
|
2636
|
+
:routing_profile_id,
|
2637
|
+
:description,
|
2638
|
+
:media_concurrencies,
|
2639
|
+
:default_outbound_queue_id,
|
2640
|
+
:tags)
|
2641
|
+
SENSITIVE = []
|
2642
|
+
include Aws::Structure
|
2643
|
+
end
|
2644
|
+
|
2645
|
+
# Contains information about the queue and channel for which priority
|
2646
|
+
# and delay can be set.
|
1874
2647
|
#
|
1875
|
-
#
|
1876
|
-
#
|
1877
|
-
# @return [String]
|
2648
|
+
# @note When making an API call, you may pass RoutingProfileQueueConfig
|
2649
|
+
# data as a hash:
|
1878
2650
|
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
2651
|
+
# {
|
2652
|
+
# queue_reference: { # required
|
2653
|
+
# queue_id: "QueueId", # required
|
2654
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2655
|
+
# },
|
2656
|
+
# priority: 1, # required
|
2657
|
+
# delay: 1, # required
|
2658
|
+
# }
|
1882
2659
|
#
|
1883
|
-
#
|
2660
|
+
# @!attribute [rw] queue_reference
|
2661
|
+
# Contains information about a queue resource.
|
2662
|
+
# @return [Types::RoutingProfileQueueReference]
|
1884
2663
|
#
|
1885
|
-
|
1886
|
-
|
1887
|
-
|
2664
|
+
# @!attribute [rw] priority
|
2665
|
+
# The order in which contacts are to be handled for the queue. For
|
2666
|
+
# more information, see [Queues: priority and delay][1].
|
2667
|
+
#
|
2668
|
+
#
|
2669
|
+
#
|
2670
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2671
|
+
# @return [Integer]
|
2672
|
+
#
|
2673
|
+
# @!attribute [rw] delay
|
2674
|
+
# The delay, in seconds, a contact should be in the queue before they
|
2675
|
+
# are routed to an available agent. For more information, see [Queues:
|
2676
|
+
# priority and delay][1] in the *Amazon Connect Administrator Guide*.
|
2677
|
+
#
|
2678
|
+
#
|
2679
|
+
#
|
2680
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2681
|
+
# @return [Integer]
|
2682
|
+
#
|
2683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfig AWS API Documentation
|
2684
|
+
#
|
2685
|
+
class RoutingProfileQueueConfig < Struct.new(
|
2686
|
+
:queue_reference,
|
2687
|
+
:priority,
|
2688
|
+
:delay)
|
1888
2689
|
SENSITIVE = []
|
1889
2690
|
include Aws::Structure
|
1890
2691
|
end
|
1891
2692
|
|
1892
|
-
# Contains summary information about a queue.
|
2693
|
+
# Contains summary information about a routing profile queue.
|
1893
2694
|
#
|
1894
|
-
# @!attribute [rw]
|
2695
|
+
# @!attribute [rw] queue_id
|
1895
2696
|
# The identifier of the queue.
|
1896
2697
|
# @return [String]
|
1897
2698
|
#
|
1898
|
-
# @!attribute [rw]
|
2699
|
+
# @!attribute [rw] queue_arn
|
1899
2700
|
# The Amazon Resource Name (ARN) of the queue.
|
1900
2701
|
# @return [String]
|
1901
2702
|
#
|
1902
|
-
# @!attribute [rw]
|
2703
|
+
# @!attribute [rw] queue_name
|
1903
2704
|
# The name of the queue.
|
1904
2705
|
# @return [String]
|
1905
2706
|
#
|
1906
|
-
# @!attribute [rw]
|
1907
|
-
# The
|
1908
|
-
#
|
2707
|
+
# @!attribute [rw] priority
|
2708
|
+
# The order in which contacts are to be handled for the queue. For
|
2709
|
+
# more information, see [Queues: priority and delay][1].
|
1909
2710
|
#
|
1910
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueSummary AWS API Documentation
|
1911
2711
|
#
|
1912
|
-
class QueueSummary < Struct.new(
|
1913
|
-
:id,
|
1914
|
-
:arn,
|
1915
|
-
:name,
|
1916
|
-
:queue_type)
|
1917
|
-
SENSITIVE = []
|
1918
|
-
include Aws::Structure
|
1919
|
-
end
|
1920
|
-
|
1921
|
-
# The specified resource was not found.
|
1922
2712
|
#
|
1923
|
-
#
|
1924
|
-
#
|
2713
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2714
|
+
# @return [Integer]
|
2715
|
+
#
|
2716
|
+
# @!attribute [rw] delay
|
2717
|
+
# The delay, in seconds, that a contact should be in the queue before
|
2718
|
+
# they are routed to an available agent. For more information, see
|
2719
|
+
# [Queues: priority and delay][1] in the *Amazon Connect Administrator
|
2720
|
+
# Guide*.
|
2721
|
+
#
|
2722
|
+
#
|
2723
|
+
#
|
2724
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2725
|
+
# @return [Integer]
|
2726
|
+
#
|
2727
|
+
# @!attribute [rw] channel
|
2728
|
+
# The channels this queue supports.
|
1925
2729
|
# @return [String]
|
1926
2730
|
#
|
1927
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfigSummary AWS API Documentation
|
1928
2732
|
#
|
1929
|
-
class
|
1930
|
-
:
|
2733
|
+
class RoutingProfileQueueConfigSummary < Struct.new(
|
2734
|
+
:queue_id,
|
2735
|
+
:queue_arn,
|
2736
|
+
:queue_name,
|
2737
|
+
:priority,
|
2738
|
+
:delay,
|
2739
|
+
:channel)
|
1931
2740
|
SENSITIVE = []
|
1932
2741
|
include Aws::Structure
|
1933
2742
|
end
|
1934
2743
|
|
1935
|
-
#
|
2744
|
+
# Contains the channel and queue identifier for a routing profile.
|
2745
|
+
#
|
2746
|
+
# @note When making an API call, you may pass RoutingProfileQueueReference
|
1936
2747
|
# data as a hash:
|
1937
2748
|
#
|
1938
2749
|
# {
|
1939
|
-
#
|
1940
|
-
#
|
1941
|
-
# initial_contact_id: "ContactId", # required
|
2750
|
+
# queue_id: "QueueId", # required
|
2751
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
1942
2752
|
# }
|
1943
2753
|
#
|
1944
|
-
# @!attribute [rw]
|
1945
|
-
# The identifier of the
|
1946
|
-
# @return [String]
|
1947
|
-
#
|
1948
|
-
# @!attribute [rw] contact_id
|
1949
|
-
# The identifier of the contact.
|
2754
|
+
# @!attribute [rw] queue_id
|
2755
|
+
# The identifier of the queue.
|
1950
2756
|
# @return [String]
|
1951
2757
|
#
|
1952
|
-
# @!attribute [rw]
|
1953
|
-
# The
|
1954
|
-
#
|
2758
|
+
# @!attribute [rw] channel
|
2759
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2760
|
+
# for this routing profile.
|
1955
2761
|
# @return [String]
|
1956
2762
|
#
|
1957
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueReference AWS API Documentation
|
1958
2764
|
#
|
1959
|
-
class
|
1960
|
-
:
|
1961
|
-
:
|
1962
|
-
:initial_contact_id)
|
2765
|
+
class RoutingProfileQueueReference < Struct.new(
|
2766
|
+
:queue_id,
|
2767
|
+
:channel)
|
1963
2768
|
SENSITIVE = []
|
1964
2769
|
include Aws::Structure
|
1965
2770
|
end
|
1966
2771
|
|
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
2772
|
# Contains summary information about a routing profile.
|
1972
2773
|
#
|
1973
2774
|
# @!attribute [rw] id
|
@@ -2040,7 +2841,14 @@ module Aws::Connect
|
|
2040
2841
|
# @return [String]
|
2041
2842
|
#
|
2042
2843
|
# @!attribute [rw] contact_flow_id
|
2043
|
-
# The identifier of the contact flow for the chat.
|
2844
|
+
# The identifier of the contact flow for initiating the chat. To see
|
2845
|
+
# the ContactFlowId in the Amazon Connect console user interface, on
|
2846
|
+
# the navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2847
|
+
# contact flow. On the contact flow page, under the name of the
|
2848
|
+
# contact flow, choose **Show additional flow information**. The
|
2849
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
2850
|
+
#
|
2851
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
2044
2852
|
# @return [String]
|
2045
2853
|
#
|
2046
2854
|
# @!attribute [rw] attributes
|
@@ -2175,7 +2983,14 @@ module Aws::Connect
|
|
2175
2983
|
# @return [String]
|
2176
2984
|
#
|
2177
2985
|
# @!attribute [rw] contact_flow_id
|
2178
|
-
# The identifier of the contact flow for the outbound call.
|
2986
|
+
# The identifier of the contact flow for the outbound call. To see the
|
2987
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2988
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2989
|
+
# contact flow. On the contact flow page, under the name of the
|
2990
|
+
# contact flow, choose **Show additional flow information**. The
|
2991
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
2992
|
+
#
|
2993
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
2179
2994
|
# @return [String]
|
2180
2995
|
#
|
2181
2996
|
# @!attribute [rw] instance_id
|
@@ -2480,6 +3295,226 @@ module Aws::Connect
|
|
2480
3295
|
#
|
2481
3296
|
class UpdateContactAttributesResponse < Aws::EmptyStructure; end
|
2482
3297
|
|
3298
|
+
# @note When making an API call, you may pass UpdateContactFlowContentRequest
|
3299
|
+
# data as a hash:
|
3300
|
+
#
|
3301
|
+
# {
|
3302
|
+
# instance_id: "InstanceId", # required
|
3303
|
+
# contact_flow_id: "ContactFlowId", # required
|
3304
|
+
# content: "ContactFlowContent", # required
|
3305
|
+
# }
|
3306
|
+
#
|
3307
|
+
# @!attribute [rw] instance_id
|
3308
|
+
# The identifier of the Amazon Connect instance.
|
3309
|
+
# @return [String]
|
3310
|
+
#
|
3311
|
+
# @!attribute [rw] contact_flow_id
|
3312
|
+
# The identifier of the contact flow.
|
3313
|
+
# @return [String]
|
3314
|
+
#
|
3315
|
+
# @!attribute [rw] content
|
3316
|
+
# The JSON string that represents contact flow’s content. For an
|
3317
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
3318
|
+
# language][1] in the *Amazon Connect Administrator Guide*.
|
3319
|
+
#
|
3320
|
+
#
|
3321
|
+
#
|
3322
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
|
3323
|
+
# @return [String]
|
3324
|
+
#
|
3325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContentRequest AWS API Documentation
|
3326
|
+
#
|
3327
|
+
class UpdateContactFlowContentRequest < Struct.new(
|
3328
|
+
:instance_id,
|
3329
|
+
:contact_flow_id,
|
3330
|
+
:content)
|
3331
|
+
SENSITIVE = []
|
3332
|
+
include Aws::Structure
|
3333
|
+
end
|
3334
|
+
|
3335
|
+
# @note When making an API call, you may pass UpdateContactFlowNameRequest
|
3336
|
+
# data as a hash:
|
3337
|
+
#
|
3338
|
+
# {
|
3339
|
+
# instance_id: "InstanceId", # required
|
3340
|
+
# contact_flow_id: "ContactFlowId", # required
|
3341
|
+
# name: "ContactFlowName",
|
3342
|
+
# description: "ContactFlowDescription",
|
3343
|
+
# }
|
3344
|
+
#
|
3345
|
+
# @!attribute [rw] instance_id
|
3346
|
+
# The identifier of the Amazon Connect instance.
|
3347
|
+
# @return [String]
|
3348
|
+
#
|
3349
|
+
# @!attribute [rw] contact_flow_id
|
3350
|
+
# The identifier of the contact flow.
|
3351
|
+
# @return [String]
|
3352
|
+
#
|
3353
|
+
# @!attribute [rw] name
|
3354
|
+
# The name of the contact flow.
|
3355
|
+
# @return [String]
|
3356
|
+
#
|
3357
|
+
# @!attribute [rw] description
|
3358
|
+
# The description of the contact flow.
|
3359
|
+
# @return [String]
|
3360
|
+
#
|
3361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowNameRequest AWS API Documentation
|
3362
|
+
#
|
3363
|
+
class UpdateContactFlowNameRequest < Struct.new(
|
3364
|
+
:instance_id,
|
3365
|
+
:contact_flow_id,
|
3366
|
+
:name,
|
3367
|
+
:description)
|
3368
|
+
SENSITIVE = []
|
3369
|
+
include Aws::Structure
|
3370
|
+
end
|
3371
|
+
|
3372
|
+
# @note When making an API call, you may pass UpdateRoutingProfileConcurrencyRequest
|
3373
|
+
# data as a hash:
|
3374
|
+
#
|
3375
|
+
# {
|
3376
|
+
# instance_id: "InstanceId", # required
|
3377
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3378
|
+
# media_concurrencies: [ # required
|
3379
|
+
# {
|
3380
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3381
|
+
# concurrency: 1, # required
|
3382
|
+
# },
|
3383
|
+
# ],
|
3384
|
+
# }
|
3385
|
+
#
|
3386
|
+
# @!attribute [rw] instance_id
|
3387
|
+
# The identifier of the Amazon Connect instance.
|
3388
|
+
# @return [String]
|
3389
|
+
#
|
3390
|
+
# @!attribute [rw] routing_profile_id
|
3391
|
+
# The identifier of the routing profile.
|
3392
|
+
# @return [String]
|
3393
|
+
#
|
3394
|
+
# @!attribute [rw] media_concurrencies
|
3395
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
3396
|
+
# @return [Array<Types::MediaConcurrency>]
|
3397
|
+
#
|
3398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrencyRequest AWS API Documentation
|
3399
|
+
#
|
3400
|
+
class UpdateRoutingProfileConcurrencyRequest < Struct.new(
|
3401
|
+
:instance_id,
|
3402
|
+
:routing_profile_id,
|
3403
|
+
:media_concurrencies)
|
3404
|
+
SENSITIVE = []
|
3405
|
+
include Aws::Structure
|
3406
|
+
end
|
3407
|
+
|
3408
|
+
# @note When making an API call, you may pass UpdateRoutingProfileDefaultOutboundQueueRequest
|
3409
|
+
# data as a hash:
|
3410
|
+
#
|
3411
|
+
# {
|
3412
|
+
# instance_id: "InstanceId", # required
|
3413
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3414
|
+
# default_outbound_queue_id: "QueueId", # required
|
3415
|
+
# }
|
3416
|
+
#
|
3417
|
+
# @!attribute [rw] instance_id
|
3418
|
+
# The identifier of the Amazon Connect instance.
|
3419
|
+
# @return [String]
|
3420
|
+
#
|
3421
|
+
# @!attribute [rw] routing_profile_id
|
3422
|
+
# The identifier of the routing profile.
|
3423
|
+
# @return [String]
|
3424
|
+
#
|
3425
|
+
# @!attribute [rw] default_outbound_queue_id
|
3426
|
+
# The identifier for the default outbound queue.
|
3427
|
+
# @return [String]
|
3428
|
+
#
|
3429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueueRequest AWS API Documentation
|
3430
|
+
#
|
3431
|
+
class UpdateRoutingProfileDefaultOutboundQueueRequest < Struct.new(
|
3432
|
+
:instance_id,
|
3433
|
+
:routing_profile_id,
|
3434
|
+
:default_outbound_queue_id)
|
3435
|
+
SENSITIVE = []
|
3436
|
+
include Aws::Structure
|
3437
|
+
end
|
3438
|
+
|
3439
|
+
# @note When making an API call, you may pass UpdateRoutingProfileNameRequest
|
3440
|
+
# data as a hash:
|
3441
|
+
#
|
3442
|
+
# {
|
3443
|
+
# instance_id: "InstanceId", # required
|
3444
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3445
|
+
# name: "RoutingProfileName",
|
3446
|
+
# description: "RoutingProfileDescription",
|
3447
|
+
# }
|
3448
|
+
#
|
3449
|
+
# @!attribute [rw] instance_id
|
3450
|
+
# The identifier of the Amazon Connect instance.
|
3451
|
+
# @return [String]
|
3452
|
+
#
|
3453
|
+
# @!attribute [rw] routing_profile_id
|
3454
|
+
# The identifier of the routing profile.
|
3455
|
+
# @return [String]
|
3456
|
+
#
|
3457
|
+
# @!attribute [rw] name
|
3458
|
+
# The name of the routing profile. Must not be more than 127
|
3459
|
+
# characters.
|
3460
|
+
# @return [String]
|
3461
|
+
#
|
3462
|
+
# @!attribute [rw] description
|
3463
|
+
# The description of the routing profile. Must not be more than 250
|
3464
|
+
# characters.
|
3465
|
+
# @return [String]
|
3466
|
+
#
|
3467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileNameRequest AWS API Documentation
|
3468
|
+
#
|
3469
|
+
class UpdateRoutingProfileNameRequest < Struct.new(
|
3470
|
+
:instance_id,
|
3471
|
+
:routing_profile_id,
|
3472
|
+
:name,
|
3473
|
+
:description)
|
3474
|
+
SENSITIVE = []
|
3475
|
+
include Aws::Structure
|
3476
|
+
end
|
3477
|
+
|
3478
|
+
# @note When making an API call, you may pass UpdateRoutingProfileQueuesRequest
|
3479
|
+
# data as a hash:
|
3480
|
+
#
|
3481
|
+
# {
|
3482
|
+
# instance_id: "InstanceId", # required
|
3483
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3484
|
+
# queue_configs: [ # required
|
3485
|
+
# {
|
3486
|
+
# queue_reference: { # required
|
3487
|
+
# queue_id: "QueueId", # required
|
3488
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3489
|
+
# },
|
3490
|
+
# priority: 1, # required
|
3491
|
+
# delay: 1, # required
|
3492
|
+
# },
|
3493
|
+
# ],
|
3494
|
+
# }
|
3495
|
+
#
|
3496
|
+
# @!attribute [rw] instance_id
|
3497
|
+
# The identifier of the Amazon Connect instance.
|
3498
|
+
# @return [String]
|
3499
|
+
#
|
3500
|
+
# @!attribute [rw] routing_profile_id
|
3501
|
+
# The identifier of the routing profile.
|
3502
|
+
# @return [String]
|
3503
|
+
#
|
3504
|
+
# @!attribute [rw] queue_configs
|
3505
|
+
# The queues to be updated for this routing profile.
|
3506
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
3507
|
+
#
|
3508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueuesRequest AWS API Documentation
|
3509
|
+
#
|
3510
|
+
class UpdateRoutingProfileQueuesRequest < Struct.new(
|
3511
|
+
:instance_id,
|
3512
|
+
:routing_profile_id,
|
3513
|
+
:queue_configs)
|
3514
|
+
SENSITIVE = []
|
3515
|
+
include Aws::Structure
|
3516
|
+
end
|
3517
|
+
|
2483
3518
|
# @note When making an API call, you may pass UpdateUserHierarchyRequest
|
2484
3519
|
# data as a hash:
|
2485
3520
|
#
|