aws-sdk-connect 1.27.0 → 1.32.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 +4 -3
- data/lib/aws-sdk-connect/client.rb +999 -30
- data/lib/aws-sdk-connect/client_api.rb +501 -0
- data/lib/aws-sdk-connect/errors.rb +32 -0
- data/lib/aws-sdk-connect/types.rb +1268 -49
- metadata +2 -2
@@ -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,6 +77,69 @@ 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
|
#
|
42
145
|
# @!attribute [rw] id
|
@@ -80,6 +183,172 @@ module Aws::Connect
|
|
80
183
|
include Aws::Structure
|
81
184
|
end
|
82
185
|
|
186
|
+
# @note When making an API call, you may pass CreateContactFlowRequest
|
187
|
+
# data as a hash:
|
188
|
+
#
|
189
|
+
# {
|
190
|
+
# instance_id: "InstanceId", # required
|
191
|
+
# name: "ContactFlowName", # required
|
192
|
+
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
193
|
+
# description: "ContactFlowDescription",
|
194
|
+
# content: "ContactFlowContent", # required
|
195
|
+
# tags: {
|
196
|
+
# "TagKey" => "TagValue",
|
197
|
+
# },
|
198
|
+
# }
|
199
|
+
#
|
200
|
+
# @!attribute [rw] instance_id
|
201
|
+
# The identifier of the Amazon Connect instance.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] name
|
205
|
+
# The name of the contact flow.
|
206
|
+
# @return [String]
|
207
|
+
#
|
208
|
+
# @!attribute [rw] type
|
209
|
+
# The type of the contact flow. For descriptions of the available
|
210
|
+
# types, see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
211
|
+
# Administrator Guide*.
|
212
|
+
#
|
213
|
+
#
|
214
|
+
#
|
215
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
216
|
+
# @return [String]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] description
|
219
|
+
# The description of the contact flow.
|
220
|
+
# @return [String]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] content
|
223
|
+
# The content of the contact flow.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] tags
|
227
|
+
# One or more tags.
|
228
|
+
# @return [Hash<String,String>]
|
229
|
+
#
|
230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowRequest AWS API Documentation
|
231
|
+
#
|
232
|
+
class CreateContactFlowRequest < Struct.new(
|
233
|
+
:instance_id,
|
234
|
+
:name,
|
235
|
+
:type,
|
236
|
+
:description,
|
237
|
+
:content,
|
238
|
+
:tags)
|
239
|
+
SENSITIVE = []
|
240
|
+
include Aws::Structure
|
241
|
+
end
|
242
|
+
|
243
|
+
# @!attribute [rw] contact_flow_id
|
244
|
+
# The identifier of the contact flow.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @!attribute [rw] contact_flow_arn
|
248
|
+
# The Amazon Resource Name (ARN) of the contact flow.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowResponse AWS API Documentation
|
252
|
+
#
|
253
|
+
class CreateContactFlowResponse < Struct.new(
|
254
|
+
:contact_flow_id,
|
255
|
+
:contact_flow_arn)
|
256
|
+
SENSITIVE = []
|
257
|
+
include Aws::Structure
|
258
|
+
end
|
259
|
+
|
260
|
+
# @note When making an API call, you may pass CreateRoutingProfileRequest
|
261
|
+
# data as a hash:
|
262
|
+
#
|
263
|
+
# {
|
264
|
+
# instance_id: "InstanceId", # required
|
265
|
+
# name: "RoutingProfileName", # required
|
266
|
+
# description: "RoutingProfileDescription", # required
|
267
|
+
# default_outbound_queue_id: "QueueId", # required
|
268
|
+
# queue_configs: [
|
269
|
+
# {
|
270
|
+
# queue_reference: { # required
|
271
|
+
# queue_id: "QueueId", # required
|
272
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
273
|
+
# },
|
274
|
+
# priority: 1, # required
|
275
|
+
# delay: 1, # required
|
276
|
+
# },
|
277
|
+
# ],
|
278
|
+
# media_concurrencies: [ # required
|
279
|
+
# {
|
280
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
281
|
+
# concurrency: 1, # required
|
282
|
+
# },
|
283
|
+
# ],
|
284
|
+
# tags: {
|
285
|
+
# "TagKey" => "TagValue",
|
286
|
+
# },
|
287
|
+
# }
|
288
|
+
#
|
289
|
+
# @!attribute [rw] instance_id
|
290
|
+
# The identifier of the Amazon Connect instance.
|
291
|
+
# @return [String]
|
292
|
+
#
|
293
|
+
# @!attribute [rw] name
|
294
|
+
# The name of the routing profile. Must not be more than 127
|
295
|
+
# characters.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @!attribute [rw] description
|
299
|
+
# Description of the routing profile. Must not be more than 250
|
300
|
+
# characters.
|
301
|
+
# @return [String]
|
302
|
+
#
|
303
|
+
# @!attribute [rw] default_outbound_queue_id
|
304
|
+
# The default outbound queue for the routing profile.
|
305
|
+
# @return [String]
|
306
|
+
#
|
307
|
+
# @!attribute [rw] queue_configs
|
308
|
+
# The inbound queues associated with the routing profile. If no queue
|
309
|
+
# is added, the agent can only make outbound calls.
|
310
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] media_concurrencies
|
313
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
314
|
+
# for this routing profile.
|
315
|
+
# @return [Array<Types::MediaConcurrency>]
|
316
|
+
#
|
317
|
+
# @!attribute [rw] tags
|
318
|
+
# One or more tags.
|
319
|
+
# @return [Hash<String,String>]
|
320
|
+
#
|
321
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfileRequest AWS API Documentation
|
322
|
+
#
|
323
|
+
class CreateRoutingProfileRequest < Struct.new(
|
324
|
+
:instance_id,
|
325
|
+
:name,
|
326
|
+
:description,
|
327
|
+
:default_outbound_queue_id,
|
328
|
+
:queue_configs,
|
329
|
+
:media_concurrencies,
|
330
|
+
:tags)
|
331
|
+
SENSITIVE = []
|
332
|
+
include Aws::Structure
|
333
|
+
end
|
334
|
+
|
335
|
+
# @!attribute [rw] routing_profile_arn
|
336
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] routing_profile_id
|
340
|
+
# The identifier of the routing profile.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfileResponse AWS API Documentation
|
344
|
+
#
|
345
|
+
class CreateRoutingProfileResponse < Struct.new(
|
346
|
+
:routing_profile_arn,
|
347
|
+
:routing_profile_id)
|
348
|
+
SENSITIVE = []
|
349
|
+
include Aws::Structure
|
350
|
+
end
|
351
|
+
|
83
352
|
# @note When making an API call, you may pass CreateUserRequest
|
84
353
|
# data as a hash:
|
85
354
|
#
|
@@ -229,7 +498,13 @@ module Aws::Connect
|
|
229
498
|
include Aws::Structure
|
230
499
|
end
|
231
500
|
|
232
|
-
# Contains information about a real-time metric.
|
501
|
+
# Contains information about a real-time metric. For a description of
|
502
|
+
# each metric, see [Real-time Metrics Definitions][1] in the *Amazon
|
503
|
+
# Connect Administrator Guide*.
|
504
|
+
#
|
505
|
+
#
|
506
|
+
#
|
507
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
233
508
|
#
|
234
509
|
# @note When making an API call, you may pass CurrentMetric
|
235
510
|
# data as a hash:
|
@@ -319,6 +594,80 @@ module Aws::Connect
|
|
319
594
|
include Aws::Structure
|
320
595
|
end
|
321
596
|
|
597
|
+
# @note When making an API call, you may pass DescribeContactFlowRequest
|
598
|
+
# data as a hash:
|
599
|
+
#
|
600
|
+
# {
|
601
|
+
# instance_id: "InstanceId", # required
|
602
|
+
# contact_flow_id: "ContactFlowId", # required
|
603
|
+
# }
|
604
|
+
#
|
605
|
+
# @!attribute [rw] instance_id
|
606
|
+
# The identifier of the Amazon Connect instance.
|
607
|
+
# @return [String]
|
608
|
+
#
|
609
|
+
# @!attribute [rw] contact_flow_id
|
610
|
+
# The identifier of the contact flow.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowRequest AWS API Documentation
|
614
|
+
#
|
615
|
+
class DescribeContactFlowRequest < Struct.new(
|
616
|
+
:instance_id,
|
617
|
+
:contact_flow_id)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
622
|
+
# @!attribute [rw] contact_flow
|
623
|
+
# Information about the contact flow.
|
624
|
+
# @return [Types::ContactFlow]
|
625
|
+
#
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowResponse AWS API Documentation
|
627
|
+
#
|
628
|
+
class DescribeContactFlowResponse < Struct.new(
|
629
|
+
:contact_flow)
|
630
|
+
SENSITIVE = []
|
631
|
+
include Aws::Structure
|
632
|
+
end
|
633
|
+
|
634
|
+
# @note When making an API call, you may pass DescribeRoutingProfileRequest
|
635
|
+
# data as a hash:
|
636
|
+
#
|
637
|
+
# {
|
638
|
+
# instance_id: "InstanceId", # required
|
639
|
+
# routing_profile_id: "RoutingProfileId", # required
|
640
|
+
# }
|
641
|
+
#
|
642
|
+
# @!attribute [rw] instance_id
|
643
|
+
# The identifier of the Amazon Connect instance.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @!attribute [rw] routing_profile_id
|
647
|
+
# The identifier of the routing profile.
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileRequest AWS API Documentation
|
651
|
+
#
|
652
|
+
class DescribeRoutingProfileRequest < Struct.new(
|
653
|
+
:instance_id,
|
654
|
+
:routing_profile_id)
|
655
|
+
SENSITIVE = []
|
656
|
+
include Aws::Structure
|
657
|
+
end
|
658
|
+
|
659
|
+
# @!attribute [rw] routing_profile
|
660
|
+
# The routing profile.
|
661
|
+
# @return [Types::RoutingProfile]
|
662
|
+
#
|
663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileResponse AWS API Documentation
|
664
|
+
#
|
665
|
+
class DescribeRoutingProfileResponse < Struct.new(
|
666
|
+
:routing_profile)
|
667
|
+
SENSITIVE = []
|
668
|
+
include Aws::Structure
|
669
|
+
end
|
670
|
+
|
322
671
|
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
323
672
|
# data as a hash:
|
324
673
|
#
|
@@ -457,6 +806,42 @@ module Aws::Connect
|
|
457
806
|
include Aws::Structure
|
458
807
|
end
|
459
808
|
|
809
|
+
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
810
|
+
# data as a hash:
|
811
|
+
#
|
812
|
+
# {
|
813
|
+
# instance_id: "InstanceId", # required
|
814
|
+
# routing_profile_id: "RoutingProfileId", # required
|
815
|
+
# queue_references: [ # required
|
816
|
+
# {
|
817
|
+
# queue_id: "QueueId", # required
|
818
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
819
|
+
# },
|
820
|
+
# ],
|
821
|
+
# }
|
822
|
+
#
|
823
|
+
# @!attribute [rw] instance_id
|
824
|
+
# The identifier of the Amazon Connect instance.
|
825
|
+
# @return [String]
|
826
|
+
#
|
827
|
+
# @!attribute [rw] routing_profile_id
|
828
|
+
# The identifier of the routing profile.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] queue_references
|
832
|
+
# The queues to disassociate from this routing profile.
|
833
|
+
# @return [Array<Types::RoutingProfileQueueReference>]
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueuesRequest AWS API Documentation
|
836
|
+
#
|
837
|
+
class DisassociateRoutingProfileQueuesRequest < Struct.new(
|
838
|
+
:instance_id,
|
839
|
+
:routing_profile_id,
|
840
|
+
:queue_references)
|
841
|
+
SENSITIVE = []
|
842
|
+
include Aws::Structure
|
843
|
+
end
|
844
|
+
|
460
845
|
# A resource with the specified name already exists.
|
461
846
|
#
|
462
847
|
# @!attribute [rw] message
|
@@ -563,16 +948,16 @@ module Aws::Connect
|
|
563
948
|
# The queues, up to 100, or channels, to use to filter the metrics
|
564
949
|
# returned. Metric data is retrieved only for the resources associated
|
565
950
|
# with the queues or channels included in the filter. You can include
|
566
|
-
# both queue IDs and queue ARNs in the same request.
|
567
|
-
#
|
951
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
952
|
+
# `CHAT` channels are supported.
|
568
953
|
# @return [Types::Filters]
|
569
954
|
#
|
570
955
|
# @!attribute [rw] groupings
|
571
956
|
# The grouping applied to the metrics returned. For example, when
|
572
957
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
573
958
|
# than aggregated for all queues. If you group by `CHANNEL`, you
|
574
|
-
# should include a Channels filter.
|
575
|
-
#
|
959
|
+
# should include a Channels filter. Both `VOICE` and `CHAT` channels
|
960
|
+
# are supported.
|
576
961
|
#
|
577
962
|
# If no `Grouping` is included in the request, a summary of metrics is
|
578
963
|
# returned.
|
@@ -580,59 +965,112 @@ module Aws::Connect
|
|
580
965
|
#
|
581
966
|
# @!attribute [rw] current_metrics
|
582
967
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
583
|
-
# The following metrics are available
|
968
|
+
# The following metrics are available. For a description of all the
|
969
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon
|
970
|
+
# Connect Administrator Guide*.
|
584
971
|
#
|
585
972
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
586
973
|
#
|
587
974
|
# : Unit: COUNT
|
588
975
|
#
|
976
|
+
# Name in real-time metrics report: [ACW][2]
|
977
|
+
#
|
589
978
|
# AGENTS\_AVAILABLE
|
590
979
|
#
|
591
980
|
# : Unit: COUNT
|
592
981
|
#
|
982
|
+
# Name in real-time metrics report: [Available][3]
|
983
|
+
#
|
593
984
|
# AGENTS\_ERROR
|
594
985
|
#
|
595
986
|
# : Unit: COUNT
|
596
987
|
#
|
988
|
+
# Name in real-time metrics report: [Error][4]
|
989
|
+
#
|
597
990
|
# AGENTS\_NON\_PRODUCTIVE
|
598
991
|
#
|
599
992
|
# : Unit: COUNT
|
600
993
|
#
|
994
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
995
|
+
#
|
601
996
|
# AGENTS\_ON\_CALL
|
602
997
|
#
|
603
998
|
# : Unit: COUNT
|
604
999
|
#
|
1000
|
+
# Name in real-time metrics report: [On contact][6]
|
1001
|
+
#
|
605
1002
|
# AGENTS\_ON\_CONTACT
|
606
1003
|
#
|
607
1004
|
# : Unit: COUNT
|
608
1005
|
#
|
1006
|
+
# Name in real-time metrics report: [On contact][6]
|
1007
|
+
#
|
609
1008
|
# AGENTS\_ONLINE
|
610
1009
|
#
|
611
1010
|
# : Unit: COUNT
|
612
1011
|
#
|
1012
|
+
# Name in real-time metrics report: [Online][7]
|
1013
|
+
#
|
613
1014
|
# AGENTS\_STAFFED
|
614
1015
|
#
|
615
1016
|
# : Unit: COUNT
|
616
1017
|
#
|
1018
|
+
# Name in real-time metrics report: [Staffed][8]
|
1019
|
+
#
|
617
1020
|
# CONTACTS\_IN\_QUEUE
|
618
1021
|
#
|
619
1022
|
# : Unit: COUNT
|
620
1023
|
#
|
1024
|
+
# Name in real-time metrics report: [In queue][9]
|
1025
|
+
#
|
621
1026
|
# CONTACTS\_SCHEDULED
|
622
1027
|
#
|
623
1028
|
# : Unit: COUNT
|
624
1029
|
#
|
1030
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1031
|
+
#
|
625
1032
|
# OLDEST\_CONTACT\_AGE
|
626
1033
|
#
|
627
1034
|
# : Unit: SECONDS
|
628
1035
|
#
|
1036
|
+
# When you use groupings, Unit says SECONDS but the Value is
|
1037
|
+
# returned in MILLISECONDS. For example, if you get a response like
|
1038
|
+
# this:
|
1039
|
+
#
|
1040
|
+
# `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS"
|
1041
|
+
# \}, "Value": 24113.0 `\\}
|
1042
|
+
#
|
1043
|
+
# The actual OLDEST\_CONTACT\_AGE is 24 seconds.
|
1044
|
+
#
|
1045
|
+
# Name in real-time metrics report: [Oldest][11]
|
1046
|
+
#
|
629
1047
|
# SLOTS\_ACTIVE
|
630
1048
|
#
|
631
1049
|
# : Unit: COUNT
|
632
1050
|
#
|
1051
|
+
# Name in real-time metrics report: [Active][12]
|
1052
|
+
#
|
633
1053
|
# SLOTS\_AVAILABLE
|
634
1054
|
#
|
635
1055
|
# : Unit: COUNT
|
1056
|
+
#
|
1057
|
+
# Name in real-time metrics report: [Availability][13]
|
1058
|
+
#
|
1059
|
+
#
|
1060
|
+
#
|
1061
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
1062
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
|
1063
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
|
1064
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
|
1065
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
|
1066
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
|
1067
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
|
1068
|
+
# [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
|
1069
|
+
# [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
|
1070
|
+
# [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
|
1071
|
+
# [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
|
1072
|
+
# [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
|
1073
|
+
# [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
|
636
1074
|
# @return [Array<Types::CurrentMetric>]
|
637
1075
|
#
|
638
1076
|
# @!attribute [rw] next_token
|
@@ -777,8 +1215,8 @@ module Aws::Connect
|
|
777
1215
|
# The queues, up to 100, or channels, to use to filter the metrics
|
778
1216
|
# returned. Metric data is retrieved only for the resources associated
|
779
1217
|
# with the queues or channels included in the filter. You can include
|
780
|
-
# both queue IDs and queue ARNs in the same request.
|
781
|
-
#
|
1218
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1219
|
+
# `CHAT` channels are supported.
|
782
1220
|
# @return [Types::Filters]
|
783
1221
|
#
|
784
1222
|
# @!attribute [rw] groupings
|
@@ -795,7 +1233,9 @@ module Aws::Connect
|
|
795
1233
|
#
|
796
1234
|
# @!attribute [rw] historical_metrics
|
797
1235
|
# The metrics to retrieve. Specify the name, unit, and statistic for
|
798
|
-
# each metric. The following historical metrics are available
|
1236
|
+
# each metric. The following historical metrics are available. For a
|
1237
|
+
# description of each metric, see [Historical Metrics Definitions][1]
|
1238
|
+
# in the *Amazon Connect Administrator Guide*.
|
799
1239
|
#
|
800
1240
|
# ABANDON\_TIME
|
801
1241
|
#
|
@@ -950,6 +1390,10 @@ module Aws::Connect
|
|
950
1390
|
# Threshold: Only "Less than" comparisons are supported, with the
|
951
1391
|
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90,
|
952
1392
|
# 120, 180, 240, 300, 600
|
1393
|
+
#
|
1394
|
+
#
|
1395
|
+
#
|
1396
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
953
1397
|
# @return [Array<Types::HistoricalMetric>]
|
954
1398
|
#
|
955
1399
|
# @!attribute [rw] next_token
|
@@ -1151,7 +1595,13 @@ module Aws::Connect
|
|
1151
1595
|
include Aws::Structure
|
1152
1596
|
end
|
1153
1597
|
|
1154
|
-
# Contains information about a historical metric.
|
1598
|
+
# Contains information about a historical metric. For a description of
|
1599
|
+
# each metric, see [Historical Metrics Definitions][1] in the *Amazon
|
1600
|
+
# Connect Administrator Guide*.
|
1601
|
+
#
|
1602
|
+
#
|
1603
|
+
#
|
1604
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
1155
1605
|
#
|
1156
1606
|
# @note When making an API call, you may pass HistoricalMetric
|
1157
1607
|
# data as a hash:
|
@@ -1270,6 +1720,20 @@ module Aws::Connect
|
|
1270
1720
|
include Aws::Structure
|
1271
1721
|
end
|
1272
1722
|
|
1723
|
+
# The contact flow is not valid.
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] problems
|
1726
|
+
# The problems with the contact flow. Please fix before trying again.
|
1727
|
+
# @return [Array<Types::ProblemDetail>]
|
1728
|
+
#
|
1729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidContactFlowException AWS API Documentation
|
1730
|
+
#
|
1731
|
+
class InvalidContactFlowException < Struct.new(
|
1732
|
+
:problems)
|
1733
|
+
SENSITIVE = []
|
1734
|
+
include Aws::Structure
|
1735
|
+
end
|
1736
|
+
|
1273
1737
|
# One or more of the specified parameters are not valid.
|
1274
1738
|
#
|
1275
1739
|
# @!attribute [rw] message
|
@@ -1435,12 +1899,121 @@ module Aws::Connect
|
|
1435
1899
|
# The identifier of the Amazon Connect instance.
|
1436
1900
|
# @return [String]
|
1437
1901
|
#
|
1438
|
-
# @!attribute [rw] phone_number_types
|
1439
|
-
# The type of phone number.
|
1440
|
-
# @return [Array<String>]
|
1441
|
-
#
|
1442
|
-
# @!attribute [rw] phone_number_country_codes
|
1443
|
-
# The ISO country code.
|
1902
|
+
# @!attribute [rw] phone_number_types
|
1903
|
+
# The type of phone number.
|
1904
|
+
# @return [Array<String>]
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] phone_number_country_codes
|
1907
|
+
# The ISO country code.
|
1908
|
+
# @return [Array<String>]
|
1909
|
+
#
|
1910
|
+
# @!attribute [rw] next_token
|
1911
|
+
# The token for the next set of results. Use the value returned in the
|
1912
|
+
# previous response in the next request to retrieve the next set of
|
1913
|
+
# results.
|
1914
|
+
# @return [String]
|
1915
|
+
#
|
1916
|
+
# @!attribute [rw] max_results
|
1917
|
+
# The maximimum number of results to return per page.
|
1918
|
+
# @return [Integer]
|
1919
|
+
#
|
1920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersRequest AWS API Documentation
|
1921
|
+
#
|
1922
|
+
class ListPhoneNumbersRequest < Struct.new(
|
1923
|
+
:instance_id,
|
1924
|
+
:phone_number_types,
|
1925
|
+
:phone_number_country_codes,
|
1926
|
+
:next_token,
|
1927
|
+
:max_results)
|
1928
|
+
SENSITIVE = []
|
1929
|
+
include Aws::Structure
|
1930
|
+
end
|
1931
|
+
|
1932
|
+
# @!attribute [rw] phone_number_summary_list
|
1933
|
+
# Information about the phone numbers.
|
1934
|
+
# @return [Array<Types::PhoneNumberSummary>]
|
1935
|
+
#
|
1936
|
+
# @!attribute [rw] next_token
|
1937
|
+
# If there are additional results, this is the token for the next set
|
1938
|
+
# of results.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersResponse AWS API Documentation
|
1942
|
+
#
|
1943
|
+
class ListPhoneNumbersResponse < Struct.new(
|
1944
|
+
:phone_number_summary_list,
|
1945
|
+
:next_token)
|
1946
|
+
SENSITIVE = []
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# @note When making an API call, you may pass ListPromptsRequest
|
1951
|
+
# data as a hash:
|
1952
|
+
#
|
1953
|
+
# {
|
1954
|
+
# instance_id: "InstanceId", # required
|
1955
|
+
# next_token: "NextToken",
|
1956
|
+
# max_results: 1,
|
1957
|
+
# }
|
1958
|
+
#
|
1959
|
+
# @!attribute [rw] instance_id
|
1960
|
+
# The identifier of the Amazon Connect instance.
|
1961
|
+
# @return [String]
|
1962
|
+
#
|
1963
|
+
# @!attribute [rw] next_token
|
1964
|
+
# The token for the next set of results. Use the value returned in the
|
1965
|
+
# previous response in the next request to retrieve the next set of
|
1966
|
+
# results.
|
1967
|
+
# @return [String]
|
1968
|
+
#
|
1969
|
+
# @!attribute [rw] max_results
|
1970
|
+
# The maximum number of results to return per page.
|
1971
|
+
# @return [Integer]
|
1972
|
+
#
|
1973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsRequest AWS API Documentation
|
1974
|
+
#
|
1975
|
+
class ListPromptsRequest < Struct.new(
|
1976
|
+
:instance_id,
|
1977
|
+
:next_token,
|
1978
|
+
:max_results)
|
1979
|
+
SENSITIVE = []
|
1980
|
+
include Aws::Structure
|
1981
|
+
end
|
1982
|
+
|
1983
|
+
# @!attribute [rw] prompt_summary_list
|
1984
|
+
# Information about the prompts.
|
1985
|
+
# @return [Array<Types::PromptSummary>]
|
1986
|
+
#
|
1987
|
+
# @!attribute [rw] next_token
|
1988
|
+
# If there are additional results, this is the token for the next set
|
1989
|
+
# of results.
|
1990
|
+
# @return [String]
|
1991
|
+
#
|
1992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsResponse AWS API Documentation
|
1993
|
+
#
|
1994
|
+
class ListPromptsResponse < Struct.new(
|
1995
|
+
:prompt_summary_list,
|
1996
|
+
:next_token)
|
1997
|
+
SENSITIVE = []
|
1998
|
+
include Aws::Structure
|
1999
|
+
end
|
2000
|
+
|
2001
|
+
# @note When making an API call, you may pass ListQueuesRequest
|
2002
|
+
# data as a hash:
|
2003
|
+
#
|
2004
|
+
# {
|
2005
|
+
# instance_id: "InstanceId", # required
|
2006
|
+
# queue_types: ["STANDARD"], # accepts STANDARD, AGENT
|
2007
|
+
# next_token: "NextToken",
|
2008
|
+
# max_results: 1,
|
2009
|
+
# }
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] instance_id
|
2012
|
+
# The identifier of the Amazon Connect instance.
|
2013
|
+
# @return [String]
|
2014
|
+
#
|
2015
|
+
# @!attribute [rw] queue_types
|
2016
|
+
# The type of queue.
|
1444
2017
|
# @return [Array<String>]
|
1445
2018
|
#
|
1446
2019
|
# @!attribute [rw] next_token
|
@@ -1453,42 +2026,41 @@ module Aws::Connect
|
|
1453
2026
|
# The maximimum number of results to return per page.
|
1454
2027
|
# @return [Integer]
|
1455
2028
|
#
|
1456
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesRequest AWS API Documentation
|
1457
2030
|
#
|
1458
|
-
class
|
2031
|
+
class ListQueuesRequest < Struct.new(
|
1459
2032
|
:instance_id,
|
1460
|
-
:
|
1461
|
-
:phone_number_country_codes,
|
2033
|
+
:queue_types,
|
1462
2034
|
:next_token,
|
1463
2035
|
:max_results)
|
1464
2036
|
SENSITIVE = []
|
1465
2037
|
include Aws::Structure
|
1466
2038
|
end
|
1467
2039
|
|
1468
|
-
# @!attribute [rw]
|
1469
|
-
# Information about the
|
1470
|
-
# @return [Array<Types::
|
2040
|
+
# @!attribute [rw] queue_summary_list
|
2041
|
+
# Information about the queues.
|
2042
|
+
# @return [Array<Types::QueueSummary>]
|
1471
2043
|
#
|
1472
2044
|
# @!attribute [rw] next_token
|
1473
2045
|
# If there are additional results, this is the token for the next set
|
1474
2046
|
# of results.
|
1475
2047
|
# @return [String]
|
1476
2048
|
#
|
1477
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesResponse AWS API Documentation
|
1478
2050
|
#
|
1479
|
-
class
|
1480
|
-
:
|
2051
|
+
class ListQueuesResponse < Struct.new(
|
2052
|
+
:queue_summary_list,
|
1481
2053
|
:next_token)
|
1482
2054
|
SENSITIVE = []
|
1483
2055
|
include Aws::Structure
|
1484
2056
|
end
|
1485
2057
|
|
1486
|
-
# @note When making an API call, you may pass
|
2058
|
+
# @note When making an API call, you may pass ListRoutingProfileQueuesRequest
|
1487
2059
|
# data as a hash:
|
1488
2060
|
#
|
1489
2061
|
# {
|
1490
2062
|
# instance_id: "InstanceId", # required
|
1491
|
-
#
|
2063
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1492
2064
|
# next_token: "NextToken",
|
1493
2065
|
# max_results: 1,
|
1494
2066
|
# }
|
@@ -1497,9 +2069,9 @@ module Aws::Connect
|
|
1497
2069
|
# The identifier of the Amazon Connect instance.
|
1498
2070
|
# @return [String]
|
1499
2071
|
#
|
1500
|
-
# @!attribute [rw]
|
1501
|
-
# The
|
1502
|
-
# @return [
|
2072
|
+
# @!attribute [rw] routing_profile_id
|
2073
|
+
# The identifier of the routing profile.
|
2074
|
+
# @return [String]
|
1503
2075
|
#
|
1504
2076
|
# @!attribute [rw] next_token
|
1505
2077
|
# The token for the next set of results. Use the value returned in the
|
@@ -1511,31 +2083,31 @@ module Aws::Connect
|
|
1511
2083
|
# The maximimum number of results to return per page.
|
1512
2084
|
# @return [Integer]
|
1513
2085
|
#
|
1514
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesRequest AWS API Documentation
|
1515
2087
|
#
|
1516
|
-
class
|
2088
|
+
class ListRoutingProfileQueuesRequest < Struct.new(
|
1517
2089
|
:instance_id,
|
1518
|
-
:
|
2090
|
+
:routing_profile_id,
|
1519
2091
|
:next_token,
|
1520
2092
|
:max_results)
|
1521
2093
|
SENSITIVE = []
|
1522
2094
|
include Aws::Structure
|
1523
2095
|
end
|
1524
2096
|
|
1525
|
-
# @!attribute [rw] queue_summary_list
|
1526
|
-
# Information about the queues.
|
1527
|
-
# @return [Array<Types::QueueSummary>]
|
1528
|
-
#
|
1529
2097
|
# @!attribute [rw] next_token
|
1530
2098
|
# If there are additional results, this is the token for the next set
|
1531
2099
|
# of results.
|
1532
2100
|
# @return [String]
|
1533
2101
|
#
|
1534
|
-
#
|
2102
|
+
# @!attribute [rw] routing_profile_queue_config_summary_list
|
2103
|
+
# Information about the routing profiles.
|
2104
|
+
# @return [Array<Types::RoutingProfileQueueConfigSummary>]
|
1535
2105
|
#
|
1536
|
-
|
1537
|
-
|
1538
|
-
|
2106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesResponse AWS API Documentation
|
2107
|
+
#
|
2108
|
+
class ListRoutingProfileQueuesResponse < Struct.new(
|
2109
|
+
:next_token,
|
2110
|
+
:routing_profile_queue_config_summary_list)
|
1539
2111
|
SENSITIVE = []
|
1540
2112
|
include Aws::Structure
|
1541
2113
|
end
|
@@ -1775,6 +2347,36 @@ module Aws::Connect
|
|
1775
2347
|
include Aws::Structure
|
1776
2348
|
end
|
1777
2349
|
|
2350
|
+
# Contains information about which channels are supported, and how many
|
2351
|
+
# contacts an agent can have on a channel simultaneously.
|
2352
|
+
#
|
2353
|
+
# @note When making an API call, you may pass MediaConcurrency
|
2354
|
+
# data as a hash:
|
2355
|
+
#
|
2356
|
+
# {
|
2357
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2358
|
+
# concurrency: 1, # required
|
2359
|
+
# }
|
2360
|
+
#
|
2361
|
+
# @!attribute [rw] channel
|
2362
|
+
# The channels that agents can handle in the Contact Control Panel
|
2363
|
+
# (CCP).
|
2364
|
+
# @return [String]
|
2365
|
+
#
|
2366
|
+
# @!attribute [rw] concurrency
|
2367
|
+
# The number of contacts an agent can have on a channel
|
2368
|
+
# simultaneously.
|
2369
|
+
# @return [Integer]
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MediaConcurrency AWS API Documentation
|
2372
|
+
#
|
2373
|
+
class MediaConcurrency < Struct.new(
|
2374
|
+
:channel,
|
2375
|
+
:concurrency)
|
2376
|
+
SENSITIVE = []
|
2377
|
+
include Aws::Structure
|
2378
|
+
end
|
2379
|
+
|
1778
2380
|
# The contact is not permitted.
|
1779
2381
|
#
|
1780
2382
|
# @!attribute [rw] message
|
@@ -1845,6 +2447,44 @@ module Aws::Connect
|
|
1845
2447
|
include Aws::Structure
|
1846
2448
|
end
|
1847
2449
|
|
2450
|
+
# Information about a problem detail.
|
2451
|
+
#
|
2452
|
+
# @!attribute [rw] message
|
2453
|
+
# The problem detail's message.
|
2454
|
+
# @return [String]
|
2455
|
+
#
|
2456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ProblemDetail AWS API Documentation
|
2457
|
+
#
|
2458
|
+
class ProblemDetail < Struct.new(
|
2459
|
+
:message)
|
2460
|
+
SENSITIVE = []
|
2461
|
+
include Aws::Structure
|
2462
|
+
end
|
2463
|
+
|
2464
|
+
# Contains information about the prompt.
|
2465
|
+
#
|
2466
|
+
# @!attribute [rw] id
|
2467
|
+
# The identifier of the prompt.
|
2468
|
+
# @return [String]
|
2469
|
+
#
|
2470
|
+
# @!attribute [rw] arn
|
2471
|
+
# The Amazon Resource Name (ARN) of the prompt.
|
2472
|
+
# @return [String]
|
2473
|
+
#
|
2474
|
+
# @!attribute [rw] name
|
2475
|
+
# The name of the prompt.
|
2476
|
+
# @return [String]
|
2477
|
+
#
|
2478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PromptSummary AWS API Documentation
|
2479
|
+
#
|
2480
|
+
class PromptSummary < Struct.new(
|
2481
|
+
:id,
|
2482
|
+
:arn,
|
2483
|
+
:name)
|
2484
|
+
SENSITIVE = []
|
2485
|
+
include Aws::Structure
|
2486
|
+
end
|
2487
|
+
|
1848
2488
|
# Contains information about a queue resource for which metrics are
|
1849
2489
|
# returned.
|
1850
2490
|
#
|
@@ -1908,6 +2548,220 @@ module Aws::Connect
|
|
1908
2548
|
include Aws::Structure
|
1909
2549
|
end
|
1910
2550
|
|
2551
|
+
# @note When making an API call, you may pass ResumeContactRecordingRequest
|
2552
|
+
# data as a hash:
|
2553
|
+
#
|
2554
|
+
# {
|
2555
|
+
# instance_id: "InstanceId", # required
|
2556
|
+
# contact_id: "ContactId", # required
|
2557
|
+
# initial_contact_id: "ContactId", # required
|
2558
|
+
# }
|
2559
|
+
#
|
2560
|
+
# @!attribute [rw] instance_id
|
2561
|
+
# The identifier of the Amazon Connect instance.
|
2562
|
+
# @return [String]
|
2563
|
+
#
|
2564
|
+
# @!attribute [rw] contact_id
|
2565
|
+
# The identifier of the contact.
|
2566
|
+
# @return [String]
|
2567
|
+
#
|
2568
|
+
# @!attribute [rw] initial_contact_id
|
2569
|
+
# The identifier of the contact. This is the identifier of the contact
|
2570
|
+
# associated with the first interaction with the contact center.
|
2571
|
+
# @return [String]
|
2572
|
+
#
|
2573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingRequest AWS API Documentation
|
2574
|
+
#
|
2575
|
+
class ResumeContactRecordingRequest < Struct.new(
|
2576
|
+
:instance_id,
|
2577
|
+
:contact_id,
|
2578
|
+
:initial_contact_id)
|
2579
|
+
SENSITIVE = []
|
2580
|
+
include Aws::Structure
|
2581
|
+
end
|
2582
|
+
|
2583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingResponse AWS API Documentation
|
2584
|
+
#
|
2585
|
+
class ResumeContactRecordingResponse < Aws::EmptyStructure; end
|
2586
|
+
|
2587
|
+
# Contains information about a routing profile.
|
2588
|
+
#
|
2589
|
+
# @!attribute [rw] instance_id
|
2590
|
+
# The identifier of the Amazon Connect instance.
|
2591
|
+
# @return [String]
|
2592
|
+
#
|
2593
|
+
# @!attribute [rw] name
|
2594
|
+
# The name of the routing profile.
|
2595
|
+
# @return [String]
|
2596
|
+
#
|
2597
|
+
# @!attribute [rw] routing_profile_arn
|
2598
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
2599
|
+
# @return [String]
|
2600
|
+
#
|
2601
|
+
# @!attribute [rw] routing_profile_id
|
2602
|
+
# The identifier of the routing profile.
|
2603
|
+
# @return [String]
|
2604
|
+
#
|
2605
|
+
# @!attribute [rw] description
|
2606
|
+
# The description of the routing profile.
|
2607
|
+
# @return [String]
|
2608
|
+
#
|
2609
|
+
# @!attribute [rw] media_concurrencies
|
2610
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2611
|
+
# for this routing profile.
|
2612
|
+
# @return [Array<Types::MediaConcurrency>]
|
2613
|
+
#
|
2614
|
+
# @!attribute [rw] default_outbound_queue_id
|
2615
|
+
# The identifier of the default outbound queue for this routing
|
2616
|
+
# profile.
|
2617
|
+
# @return [String]
|
2618
|
+
#
|
2619
|
+
# @!attribute [rw] tags
|
2620
|
+
# One or more tags.
|
2621
|
+
# @return [Hash<String,String>]
|
2622
|
+
#
|
2623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfile AWS API Documentation
|
2624
|
+
#
|
2625
|
+
class RoutingProfile < Struct.new(
|
2626
|
+
:instance_id,
|
2627
|
+
:name,
|
2628
|
+
:routing_profile_arn,
|
2629
|
+
:routing_profile_id,
|
2630
|
+
:description,
|
2631
|
+
:media_concurrencies,
|
2632
|
+
:default_outbound_queue_id,
|
2633
|
+
:tags)
|
2634
|
+
SENSITIVE = []
|
2635
|
+
include Aws::Structure
|
2636
|
+
end
|
2637
|
+
|
2638
|
+
# Contains information about the queue and channel for which priority
|
2639
|
+
# and delay can be set.
|
2640
|
+
#
|
2641
|
+
# @note When making an API call, you may pass RoutingProfileQueueConfig
|
2642
|
+
# data as a hash:
|
2643
|
+
#
|
2644
|
+
# {
|
2645
|
+
# queue_reference: { # required
|
2646
|
+
# queue_id: "QueueId", # required
|
2647
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2648
|
+
# },
|
2649
|
+
# priority: 1, # required
|
2650
|
+
# delay: 1, # required
|
2651
|
+
# }
|
2652
|
+
#
|
2653
|
+
# @!attribute [rw] queue_reference
|
2654
|
+
# Contains information about a queue resource.
|
2655
|
+
# @return [Types::RoutingProfileQueueReference]
|
2656
|
+
#
|
2657
|
+
# @!attribute [rw] priority
|
2658
|
+
# The order in which contacts are to be handled for the queue. For
|
2659
|
+
# more information, see [Queues: priority and delay][1].
|
2660
|
+
#
|
2661
|
+
#
|
2662
|
+
#
|
2663
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2664
|
+
# @return [Integer]
|
2665
|
+
#
|
2666
|
+
# @!attribute [rw] delay
|
2667
|
+
# The delay, in seconds, a contact should be in the queue before they
|
2668
|
+
# are routed to an available agent. For more information, see [Queues:
|
2669
|
+
# priority and delay][1] in the *Amazon Connect Administrator Guide*.
|
2670
|
+
#
|
2671
|
+
#
|
2672
|
+
#
|
2673
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2674
|
+
# @return [Integer]
|
2675
|
+
#
|
2676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfig AWS API Documentation
|
2677
|
+
#
|
2678
|
+
class RoutingProfileQueueConfig < Struct.new(
|
2679
|
+
:queue_reference,
|
2680
|
+
:priority,
|
2681
|
+
:delay)
|
2682
|
+
SENSITIVE = []
|
2683
|
+
include Aws::Structure
|
2684
|
+
end
|
2685
|
+
|
2686
|
+
# Contains summary information about a routing profile queue.
|
2687
|
+
#
|
2688
|
+
# @!attribute [rw] queue_id
|
2689
|
+
# The identifier of the queue.
|
2690
|
+
# @return [String]
|
2691
|
+
#
|
2692
|
+
# @!attribute [rw] queue_arn
|
2693
|
+
# The Amazon Resource Name (ARN) of the queue.
|
2694
|
+
# @return [String]
|
2695
|
+
#
|
2696
|
+
# @!attribute [rw] queue_name
|
2697
|
+
# The name of the queue.
|
2698
|
+
# @return [String]
|
2699
|
+
#
|
2700
|
+
# @!attribute [rw] priority
|
2701
|
+
# The order in which contacts are to be handled for the queue. For
|
2702
|
+
# more information, see [Queues: priority and delay][1].
|
2703
|
+
#
|
2704
|
+
#
|
2705
|
+
#
|
2706
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2707
|
+
# @return [Integer]
|
2708
|
+
#
|
2709
|
+
# @!attribute [rw] delay
|
2710
|
+
# The delay, in seconds, that a contact should be in the queue before
|
2711
|
+
# they are routed to an available agent. For more information, see
|
2712
|
+
# [Queues: priority and delay][1] in the *Amazon Connect Administrator
|
2713
|
+
# Guide*.
|
2714
|
+
#
|
2715
|
+
#
|
2716
|
+
#
|
2717
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2718
|
+
# @return [Integer]
|
2719
|
+
#
|
2720
|
+
# @!attribute [rw] channel
|
2721
|
+
# The channels this queue supports.
|
2722
|
+
# @return [String]
|
2723
|
+
#
|
2724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfigSummary AWS API Documentation
|
2725
|
+
#
|
2726
|
+
class RoutingProfileQueueConfigSummary < Struct.new(
|
2727
|
+
:queue_id,
|
2728
|
+
:queue_arn,
|
2729
|
+
:queue_name,
|
2730
|
+
:priority,
|
2731
|
+
:delay,
|
2732
|
+
:channel)
|
2733
|
+
SENSITIVE = []
|
2734
|
+
include Aws::Structure
|
2735
|
+
end
|
2736
|
+
|
2737
|
+
# Contains the channel and queue identifier for a routing profile.
|
2738
|
+
#
|
2739
|
+
# @note When making an API call, you may pass RoutingProfileQueueReference
|
2740
|
+
# data as a hash:
|
2741
|
+
#
|
2742
|
+
# {
|
2743
|
+
# queue_id: "QueueId", # required
|
2744
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2745
|
+
# }
|
2746
|
+
#
|
2747
|
+
# @!attribute [rw] queue_id
|
2748
|
+
# The identifier of the queue.
|
2749
|
+
# @return [String]
|
2750
|
+
#
|
2751
|
+
# @!attribute [rw] channel
|
2752
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2753
|
+
# for this routing profile.
|
2754
|
+
# @return [String]
|
2755
|
+
#
|
2756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueReference AWS API Documentation
|
2757
|
+
#
|
2758
|
+
class RoutingProfileQueueReference < Struct.new(
|
2759
|
+
:queue_id,
|
2760
|
+
:channel)
|
2761
|
+
SENSITIVE = []
|
2762
|
+
include Aws::Structure
|
2763
|
+
end
|
2764
|
+
|
1911
2765
|
# Contains summary information about a routing profile.
|
1912
2766
|
#
|
1913
2767
|
# @!attribute [rw] id
|
@@ -1980,7 +2834,14 @@ module Aws::Connect
|
|
1980
2834
|
# @return [String]
|
1981
2835
|
#
|
1982
2836
|
# @!attribute [rw] contact_flow_id
|
1983
|
-
# The identifier of the contact flow for the chat.
|
2837
|
+
# The identifier of the contact flow for initiating the chat. To see
|
2838
|
+
# the ContactFlowId in the Amazon Connect console user interface, on
|
2839
|
+
# the navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2840
|
+
# contact flow. On the contact flow page, under the name of the
|
2841
|
+
# contact flow, choose **Show additional flow information**. The
|
2842
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
2843
|
+
#
|
2844
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1984
2845
|
# @return [String]
|
1985
2846
|
#
|
1986
2847
|
# @!attribute [rw] attributes
|
@@ -2038,19 +2899,63 @@ module Aws::Connect
|
|
2038
2899
|
#
|
2039
2900
|
#
|
2040
2901
|
#
|
2041
|
-
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
2902
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
2903
|
+
# @return [String]
|
2904
|
+
#
|
2905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactResponse AWS API Documentation
|
2906
|
+
#
|
2907
|
+
class StartChatContactResponse < Struct.new(
|
2908
|
+
:contact_id,
|
2909
|
+
:participant_id,
|
2910
|
+
:participant_token)
|
2911
|
+
SENSITIVE = []
|
2912
|
+
include Aws::Structure
|
2913
|
+
end
|
2914
|
+
|
2915
|
+
# @note When making an API call, you may pass StartContactRecordingRequest
|
2916
|
+
# data as a hash:
|
2917
|
+
#
|
2918
|
+
# {
|
2919
|
+
# instance_id: "InstanceId", # required
|
2920
|
+
# contact_id: "ContactId", # required
|
2921
|
+
# initial_contact_id: "ContactId", # required
|
2922
|
+
# voice_recording_configuration: { # required
|
2923
|
+
# voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
|
2924
|
+
# },
|
2925
|
+
# }
|
2926
|
+
#
|
2927
|
+
# @!attribute [rw] instance_id
|
2928
|
+
# The identifier of the Amazon Connect instance.
|
2929
|
+
# @return [String]
|
2930
|
+
#
|
2931
|
+
# @!attribute [rw] contact_id
|
2932
|
+
# The identifier of the contact.
|
2933
|
+
# @return [String]
|
2934
|
+
#
|
2935
|
+
# @!attribute [rw] initial_contact_id
|
2936
|
+
# The identifier of the contact. This is the identifier of the contact
|
2937
|
+
# associated with the first interaction with the contact center.
|
2042
2938
|
# @return [String]
|
2043
2939
|
#
|
2044
|
-
#
|
2940
|
+
# @!attribute [rw] voice_recording_configuration
|
2941
|
+
# Who is being recorded.
|
2942
|
+
# @return [Types::VoiceRecordingConfiguration]
|
2045
2943
|
#
|
2046
|
-
|
2944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingRequest AWS API Documentation
|
2945
|
+
#
|
2946
|
+
class StartContactRecordingRequest < Struct.new(
|
2947
|
+
:instance_id,
|
2047
2948
|
:contact_id,
|
2048
|
-
:
|
2049
|
-
:
|
2949
|
+
:initial_contact_id,
|
2950
|
+
:voice_recording_configuration)
|
2050
2951
|
SENSITIVE = []
|
2051
2952
|
include Aws::Structure
|
2052
2953
|
end
|
2053
2954
|
|
2955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingResponse AWS API Documentation
|
2956
|
+
#
|
2957
|
+
class StartContactRecordingResponse < Aws::EmptyStructure; end
|
2958
|
+
|
2054
2959
|
# @note When making an API call, you may pass StartOutboundVoiceContactRequest
|
2055
2960
|
# data as a hash:
|
2056
2961
|
#
|
@@ -2071,7 +2976,14 @@ module Aws::Connect
|
|
2071
2976
|
# @return [String]
|
2072
2977
|
#
|
2073
2978
|
# @!attribute [rw] contact_flow_id
|
2074
|
-
# The identifier of the contact flow for the outbound call.
|
2979
|
+
# The identifier of the contact flow for the outbound call. To see the
|
2980
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2981
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2982
|
+
# contact flow. On the contact flow page, under the name of the
|
2983
|
+
# contact flow, choose **Show additional flow information**. The
|
2984
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
2985
|
+
#
|
2986
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
2075
2987
|
# @return [String]
|
2076
2988
|
#
|
2077
2989
|
# @!attribute [rw] instance_id
|
@@ -2138,6 +3050,42 @@ module Aws::Connect
|
|
2138
3050
|
include Aws::Structure
|
2139
3051
|
end
|
2140
3052
|
|
3053
|
+
# @note When making an API call, you may pass StopContactRecordingRequest
|
3054
|
+
# data as a hash:
|
3055
|
+
#
|
3056
|
+
# {
|
3057
|
+
# instance_id: "InstanceId", # required
|
3058
|
+
# contact_id: "ContactId", # required
|
3059
|
+
# initial_contact_id: "ContactId", # required
|
3060
|
+
# }
|
3061
|
+
#
|
3062
|
+
# @!attribute [rw] instance_id
|
3063
|
+
# The identifier of the Amazon Connect instance.
|
3064
|
+
# @return [String]
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] contact_id
|
3067
|
+
# The identifier of the contact.
|
3068
|
+
# @return [String]
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] initial_contact_id
|
3071
|
+
# The identifier of the contact. This is the identifier of the contact
|
3072
|
+
# associated with the first interaction with the contact center.
|
3073
|
+
# @return [String]
|
3074
|
+
#
|
3075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecordingRequest AWS API Documentation
|
3076
|
+
#
|
3077
|
+
class StopContactRecordingRequest < Struct.new(
|
3078
|
+
:instance_id,
|
3079
|
+
:contact_id,
|
3080
|
+
:initial_contact_id)
|
3081
|
+
SENSITIVE = []
|
3082
|
+
include Aws::Structure
|
3083
|
+
end
|
3084
|
+
|
3085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecordingResponse AWS API Documentation
|
3086
|
+
#
|
3087
|
+
class StopContactRecordingResponse < Aws::EmptyStructure; end
|
3088
|
+
|
2141
3089
|
# @note When making an API call, you may pass StopContactRequest
|
2142
3090
|
# data as a hash:
|
2143
3091
|
#
|
@@ -2167,6 +3115,42 @@ module Aws::Connect
|
|
2167
3115
|
#
|
2168
3116
|
class StopContactResponse < Aws::EmptyStructure; end
|
2169
3117
|
|
3118
|
+
# @note When making an API call, you may pass SuspendContactRecordingRequest
|
3119
|
+
# data as a hash:
|
3120
|
+
#
|
3121
|
+
# {
|
3122
|
+
# instance_id: "InstanceId", # required
|
3123
|
+
# contact_id: "ContactId", # required
|
3124
|
+
# initial_contact_id: "ContactId", # required
|
3125
|
+
# }
|
3126
|
+
#
|
3127
|
+
# @!attribute [rw] instance_id
|
3128
|
+
# The identifier of the Amazon Connect instance.
|
3129
|
+
# @return [String]
|
3130
|
+
#
|
3131
|
+
# @!attribute [rw] contact_id
|
3132
|
+
# The identifier of the contact.
|
3133
|
+
# @return [String]
|
3134
|
+
#
|
3135
|
+
# @!attribute [rw] initial_contact_id
|
3136
|
+
# The identifier of the contact. This is the identifier of the contact
|
3137
|
+
# associated with the first interaction with the contact center.
|
3138
|
+
# @return [String]
|
3139
|
+
#
|
3140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingRequest AWS API Documentation
|
3141
|
+
#
|
3142
|
+
class SuspendContactRecordingRequest < Struct.new(
|
3143
|
+
:instance_id,
|
3144
|
+
:contact_id,
|
3145
|
+
:initial_contact_id)
|
3146
|
+
SENSITIVE = []
|
3147
|
+
include Aws::Structure
|
3148
|
+
end
|
3149
|
+
|
3150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingResponse AWS API Documentation
|
3151
|
+
#
|
3152
|
+
class SuspendContactRecordingResponse < Aws::EmptyStructure; end
|
3153
|
+
|
2170
3154
|
# @note When making an API call, you may pass TagResourceRequest
|
2171
3155
|
# data as a hash:
|
2172
3156
|
#
|
@@ -2304,6 +3288,220 @@ module Aws::Connect
|
|
2304
3288
|
#
|
2305
3289
|
class UpdateContactAttributesResponse < Aws::EmptyStructure; end
|
2306
3290
|
|
3291
|
+
# @note When making an API call, you may pass UpdateContactFlowContentRequest
|
3292
|
+
# data as a hash:
|
3293
|
+
#
|
3294
|
+
# {
|
3295
|
+
# instance_id: "InstanceId", # required
|
3296
|
+
# contact_flow_id: "ContactFlowId", # required
|
3297
|
+
# content: "ContactFlowContent", # required
|
3298
|
+
# }
|
3299
|
+
#
|
3300
|
+
# @!attribute [rw] instance_id
|
3301
|
+
# The identifier of the Amazon Connect instance.
|
3302
|
+
# @return [String]
|
3303
|
+
#
|
3304
|
+
# @!attribute [rw] contact_flow_id
|
3305
|
+
# The identifier of the contact flow.
|
3306
|
+
# @return [String]
|
3307
|
+
#
|
3308
|
+
# @!attribute [rw] content
|
3309
|
+
# The content of the contact flow.
|
3310
|
+
# @return [String]
|
3311
|
+
#
|
3312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContentRequest AWS API Documentation
|
3313
|
+
#
|
3314
|
+
class UpdateContactFlowContentRequest < Struct.new(
|
3315
|
+
:instance_id,
|
3316
|
+
:contact_flow_id,
|
3317
|
+
:content)
|
3318
|
+
SENSITIVE = []
|
3319
|
+
include Aws::Structure
|
3320
|
+
end
|
3321
|
+
|
3322
|
+
# @note When making an API call, you may pass UpdateContactFlowNameRequest
|
3323
|
+
# data as a hash:
|
3324
|
+
#
|
3325
|
+
# {
|
3326
|
+
# instance_id: "InstanceId", # required
|
3327
|
+
# contact_flow_id: "ContactFlowId", # required
|
3328
|
+
# name: "ContactFlowName",
|
3329
|
+
# description: "ContactFlowDescription",
|
3330
|
+
# }
|
3331
|
+
#
|
3332
|
+
# @!attribute [rw] instance_id
|
3333
|
+
# The identifier of the Amazon Connect instance.
|
3334
|
+
# @return [String]
|
3335
|
+
#
|
3336
|
+
# @!attribute [rw] contact_flow_id
|
3337
|
+
# The identifier of the contact flow.
|
3338
|
+
# @return [String]
|
3339
|
+
#
|
3340
|
+
# @!attribute [rw] name
|
3341
|
+
# The name of the contact flow.
|
3342
|
+
# @return [String]
|
3343
|
+
#
|
3344
|
+
# @!attribute [rw] description
|
3345
|
+
# The description of the contact flow.
|
3346
|
+
# @return [String]
|
3347
|
+
#
|
3348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowNameRequest AWS API Documentation
|
3349
|
+
#
|
3350
|
+
class UpdateContactFlowNameRequest < Struct.new(
|
3351
|
+
:instance_id,
|
3352
|
+
:contact_flow_id,
|
3353
|
+
:name,
|
3354
|
+
:description)
|
3355
|
+
SENSITIVE = []
|
3356
|
+
include Aws::Structure
|
3357
|
+
end
|
3358
|
+
|
3359
|
+
# @note When making an API call, you may pass UpdateRoutingProfileConcurrencyRequest
|
3360
|
+
# data as a hash:
|
3361
|
+
#
|
3362
|
+
# {
|
3363
|
+
# instance_id: "InstanceId", # required
|
3364
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3365
|
+
# media_concurrencies: [ # required
|
3366
|
+
# {
|
3367
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3368
|
+
# concurrency: 1, # required
|
3369
|
+
# },
|
3370
|
+
# ],
|
3371
|
+
# }
|
3372
|
+
#
|
3373
|
+
# @!attribute [rw] instance_id
|
3374
|
+
# The identifier of the Amazon Connect instance.
|
3375
|
+
# @return [String]
|
3376
|
+
#
|
3377
|
+
# @!attribute [rw] routing_profile_id
|
3378
|
+
# The identifier of the routing profile.
|
3379
|
+
# @return [String]
|
3380
|
+
#
|
3381
|
+
# @!attribute [rw] media_concurrencies
|
3382
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
3383
|
+
# @return [Array<Types::MediaConcurrency>]
|
3384
|
+
#
|
3385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrencyRequest AWS API Documentation
|
3386
|
+
#
|
3387
|
+
class UpdateRoutingProfileConcurrencyRequest < Struct.new(
|
3388
|
+
:instance_id,
|
3389
|
+
:routing_profile_id,
|
3390
|
+
:media_concurrencies)
|
3391
|
+
SENSITIVE = []
|
3392
|
+
include Aws::Structure
|
3393
|
+
end
|
3394
|
+
|
3395
|
+
# @note When making an API call, you may pass UpdateRoutingProfileDefaultOutboundQueueRequest
|
3396
|
+
# data as a hash:
|
3397
|
+
#
|
3398
|
+
# {
|
3399
|
+
# instance_id: "InstanceId", # required
|
3400
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3401
|
+
# default_outbound_queue_id: "QueueId", # required
|
3402
|
+
# }
|
3403
|
+
#
|
3404
|
+
# @!attribute [rw] instance_id
|
3405
|
+
# The identifier of the Amazon Connect instance.
|
3406
|
+
# @return [String]
|
3407
|
+
#
|
3408
|
+
# @!attribute [rw] routing_profile_id
|
3409
|
+
# The identifier of the routing profile.
|
3410
|
+
# @return [String]
|
3411
|
+
#
|
3412
|
+
# @!attribute [rw] default_outbound_queue_id
|
3413
|
+
# The identifier for the default outbound queue.
|
3414
|
+
# @return [String]
|
3415
|
+
#
|
3416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueueRequest AWS API Documentation
|
3417
|
+
#
|
3418
|
+
class UpdateRoutingProfileDefaultOutboundQueueRequest < Struct.new(
|
3419
|
+
:instance_id,
|
3420
|
+
:routing_profile_id,
|
3421
|
+
:default_outbound_queue_id)
|
3422
|
+
SENSITIVE = []
|
3423
|
+
include Aws::Structure
|
3424
|
+
end
|
3425
|
+
|
3426
|
+
# @note When making an API call, you may pass UpdateRoutingProfileNameRequest
|
3427
|
+
# data as a hash:
|
3428
|
+
#
|
3429
|
+
# {
|
3430
|
+
# instance_id: "InstanceId", # required
|
3431
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3432
|
+
# name: "RoutingProfileName",
|
3433
|
+
# description: "RoutingProfileDescription",
|
3434
|
+
# }
|
3435
|
+
#
|
3436
|
+
# @!attribute [rw] instance_id
|
3437
|
+
# The identifier of the Amazon Connect instance.
|
3438
|
+
# @return [String]
|
3439
|
+
#
|
3440
|
+
# @!attribute [rw] routing_profile_id
|
3441
|
+
# The identifier of the routing profile.
|
3442
|
+
# @return [String]
|
3443
|
+
#
|
3444
|
+
# @!attribute [rw] name
|
3445
|
+
# The name of the routing profile. Must not be more than 127
|
3446
|
+
# characters.
|
3447
|
+
# @return [String]
|
3448
|
+
#
|
3449
|
+
# @!attribute [rw] description
|
3450
|
+
# The description of the routing profile. Must not be more than 250
|
3451
|
+
# characters.
|
3452
|
+
# @return [String]
|
3453
|
+
#
|
3454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileNameRequest AWS API Documentation
|
3455
|
+
#
|
3456
|
+
class UpdateRoutingProfileNameRequest < Struct.new(
|
3457
|
+
:instance_id,
|
3458
|
+
:routing_profile_id,
|
3459
|
+
:name,
|
3460
|
+
:description)
|
3461
|
+
SENSITIVE = []
|
3462
|
+
include Aws::Structure
|
3463
|
+
end
|
3464
|
+
|
3465
|
+
# @note When making an API call, you may pass UpdateRoutingProfileQueuesRequest
|
3466
|
+
# data as a hash:
|
3467
|
+
#
|
3468
|
+
# {
|
3469
|
+
# instance_id: "InstanceId", # required
|
3470
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3471
|
+
# queue_configs: [ # required
|
3472
|
+
# {
|
3473
|
+
# queue_reference: { # required
|
3474
|
+
# queue_id: "QueueId", # required
|
3475
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3476
|
+
# },
|
3477
|
+
# priority: 1, # required
|
3478
|
+
# delay: 1, # required
|
3479
|
+
# },
|
3480
|
+
# ],
|
3481
|
+
# }
|
3482
|
+
#
|
3483
|
+
# @!attribute [rw] instance_id
|
3484
|
+
# The identifier of the Amazon Connect instance.
|
3485
|
+
# @return [String]
|
3486
|
+
#
|
3487
|
+
# @!attribute [rw] routing_profile_id
|
3488
|
+
# The identifier of the routing profile.
|
3489
|
+
# @return [String]
|
3490
|
+
#
|
3491
|
+
# @!attribute [rw] queue_configs
|
3492
|
+
# The queues to be updated for this routing profile.
|
3493
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
3494
|
+
#
|
3495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueuesRequest AWS API Documentation
|
3496
|
+
#
|
3497
|
+
class UpdateRoutingProfileQueuesRequest < Struct.new(
|
3498
|
+
:instance_id,
|
3499
|
+
:routing_profile_id,
|
3500
|
+
:queue_configs)
|
3501
|
+
SENSITIVE = []
|
3502
|
+
include Aws::Structure
|
3503
|
+
end
|
3504
|
+
|
2307
3505
|
# @note When making an API call, you may pass UpdateUserHierarchyRequest
|
2308
3506
|
# data as a hash:
|
2309
3507
|
#
|
@@ -2643,5 +3841,26 @@ module Aws::Connect
|
|
2643
3841
|
include Aws::Structure
|
2644
3842
|
end
|
2645
3843
|
|
3844
|
+
# Contains information about the recording configuration settings.
|
3845
|
+
#
|
3846
|
+
# @note When making an API call, you may pass VoiceRecordingConfiguration
|
3847
|
+
# data as a hash:
|
3848
|
+
#
|
3849
|
+
# {
|
3850
|
+
# voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
|
3851
|
+
# }
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] voice_recording_track
|
3854
|
+
# Identifies which track is being recorded.
|
3855
|
+
# @return [String]
|
3856
|
+
#
|
3857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/VoiceRecordingConfiguration AWS API Documentation
|
3858
|
+
#
|
3859
|
+
class VoiceRecordingConfiguration < Struct.new(
|
3860
|
+
:voice_recording_track)
|
3861
|
+
SENSITIVE = []
|
3862
|
+
include Aws::Structure
|
3863
|
+
end
|
3864
|
+
|
2646
3865
|
end
|
2647
3866
|
end
|