aws-sdk-connect 1.31.0 → 1.32.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 +2 -2
- data/lib/aws-sdk-connect/client.rb +787 -16
- 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 +1095 -73
- 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
|
#
|
@@ -325,6 +594,80 @@ module Aws::Connect
|
|
325
594
|
include Aws::Structure
|
326
595
|
end
|
327
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
|
+
|
328
671
|
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
329
672
|
# data as a hash:
|
330
673
|
#
|
@@ -463,20 +806,56 @@ module Aws::Connect
|
|
463
806
|
include Aws::Structure
|
464
807
|
end
|
465
808
|
|
466
|
-
#
|
809
|
+
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
810
|
+
# data as a hash:
|
467
811
|
#
|
468
|
-
#
|
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.
|
469
825
|
# @return [String]
|
470
826
|
#
|
471
|
-
#
|
827
|
+
# @!attribute [rw] routing_profile_id
|
828
|
+
# The identifier of the routing profile.
|
829
|
+
# @return [String]
|
472
830
|
#
|
473
|
-
|
474
|
-
|
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)
|
475
841
|
SENSITIVE = []
|
476
842
|
include Aws::Structure
|
477
843
|
end
|
478
844
|
|
479
|
-
#
|
845
|
+
# A resource with the specified name already exists.
|
846
|
+
#
|
847
|
+
# @!attribute [rw] message
|
848
|
+
# @return [String]
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DuplicateResourceException AWS API Documentation
|
851
|
+
#
|
852
|
+
class DuplicateResourceException < Struct.new(
|
853
|
+
:message)
|
854
|
+
SENSITIVE = []
|
855
|
+
include Aws::Structure
|
856
|
+
end
|
857
|
+
|
858
|
+
# Contains the filter to apply when retrieving metrics.
|
480
859
|
#
|
481
860
|
# @note When making an API call, you may pass Filters
|
482
861
|
# data as a hash:
|
@@ -569,16 +948,16 @@ module Aws::Connect
|
|
569
948
|
# The queues, up to 100, or channels, to use to filter the metrics
|
570
949
|
# returned. Metric data is retrieved only for the resources associated
|
571
950
|
# with the queues or channels included in the filter. You can include
|
572
|
-
# both queue IDs and queue ARNs in the same request.
|
573
|
-
#
|
951
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
952
|
+
# `CHAT` channels are supported.
|
574
953
|
# @return [Types::Filters]
|
575
954
|
#
|
576
955
|
# @!attribute [rw] groupings
|
577
956
|
# The grouping applied to the metrics returned. For example, when
|
578
957
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
579
958
|
# than aggregated for all queues. If you group by `CHANNEL`, you
|
580
|
-
# should include a Channels filter.
|
581
|
-
#
|
959
|
+
# should include a Channels filter. Both `VOICE` and `CHAT` channels
|
960
|
+
# are supported.
|
582
961
|
#
|
583
962
|
# If no `Grouping` is included in the request, a summary of metrics is
|
584
963
|
# returned.
|
@@ -586,65 +965,112 @@ module Aws::Connect
|
|
586
965
|
#
|
587
966
|
# @!attribute [rw] current_metrics
|
588
967
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
589
|
-
# The following metrics are available. For a description of
|
590
|
-
#
|
968
|
+
# The following metrics are available. For a description of all the
|
969
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon
|
591
970
|
# Connect Administrator Guide*.
|
592
971
|
#
|
593
972
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
594
973
|
#
|
595
974
|
# : Unit: COUNT
|
596
975
|
#
|
976
|
+
# Name in real-time metrics report: [ACW][2]
|
977
|
+
#
|
597
978
|
# AGENTS\_AVAILABLE
|
598
979
|
#
|
599
980
|
# : Unit: COUNT
|
600
981
|
#
|
982
|
+
# Name in real-time metrics report: [Available][3]
|
983
|
+
#
|
601
984
|
# AGENTS\_ERROR
|
602
985
|
#
|
603
986
|
# : Unit: COUNT
|
604
987
|
#
|
988
|
+
# Name in real-time metrics report: [Error][4]
|
989
|
+
#
|
605
990
|
# AGENTS\_NON\_PRODUCTIVE
|
606
991
|
#
|
607
992
|
# : Unit: COUNT
|
608
993
|
#
|
994
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
995
|
+
#
|
609
996
|
# AGENTS\_ON\_CALL
|
610
997
|
#
|
611
998
|
# : Unit: COUNT
|
612
999
|
#
|
1000
|
+
# Name in real-time metrics report: [On contact][6]
|
1001
|
+
#
|
613
1002
|
# AGENTS\_ON\_CONTACT
|
614
1003
|
#
|
615
1004
|
# : Unit: COUNT
|
616
1005
|
#
|
1006
|
+
# Name in real-time metrics report: [On contact][6]
|
1007
|
+
#
|
617
1008
|
# AGENTS\_ONLINE
|
618
1009
|
#
|
619
1010
|
# : Unit: COUNT
|
620
1011
|
#
|
1012
|
+
# Name in real-time metrics report: [Online][7]
|
1013
|
+
#
|
621
1014
|
# AGENTS\_STAFFED
|
622
1015
|
#
|
623
1016
|
# : Unit: COUNT
|
624
1017
|
#
|
1018
|
+
# Name in real-time metrics report: [Staffed][8]
|
1019
|
+
#
|
625
1020
|
# CONTACTS\_IN\_QUEUE
|
626
1021
|
#
|
627
1022
|
# : Unit: COUNT
|
628
1023
|
#
|
1024
|
+
# Name in real-time metrics report: [In queue][9]
|
1025
|
+
#
|
629
1026
|
# CONTACTS\_SCHEDULED
|
630
1027
|
#
|
631
1028
|
# : Unit: COUNT
|
632
1029
|
#
|
1030
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1031
|
+
#
|
633
1032
|
# OLDEST\_CONTACT\_AGE
|
634
1033
|
#
|
635
1034
|
# : Unit: SECONDS
|
636
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
|
+
#
|
637
1047
|
# SLOTS\_ACTIVE
|
638
1048
|
#
|
639
1049
|
# : Unit: COUNT
|
640
1050
|
#
|
1051
|
+
# Name in real-time metrics report: [Active][12]
|
1052
|
+
#
|
641
1053
|
# SLOTS\_AVAILABLE
|
642
1054
|
#
|
643
1055
|
# : Unit: COUNT
|
644
1056
|
#
|
1057
|
+
# Name in real-time metrics report: [Availability][13]
|
1058
|
+
#
|
645
1059
|
#
|
646
1060
|
#
|
647
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
|
648
1074
|
# @return [Array<Types::CurrentMetric>]
|
649
1075
|
#
|
650
1076
|
# @!attribute [rw] next_token
|
@@ -789,8 +1215,8 @@ module Aws::Connect
|
|
789
1215
|
# The queues, up to 100, or channels, to use to filter the metrics
|
790
1216
|
# returned. Metric data is retrieved only for the resources associated
|
791
1217
|
# with the queues or channels included in the filter. You can include
|
792
|
-
# both queue IDs and queue ARNs in the same request.
|
793
|
-
#
|
1218
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1219
|
+
# `CHAT` channels are supported.
|
794
1220
|
# @return [Types::Filters]
|
795
1221
|
#
|
796
1222
|
# @!attribute [rw] groupings
|
@@ -1294,6 +1720,20 @@ module Aws::Connect
|
|
1294
1720
|
include Aws::Structure
|
1295
1721
|
end
|
1296
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
|
+
|
1297
1737
|
# One or more of the specified parameters are not valid.
|
1298
1738
|
#
|
1299
1739
|
# @!attribute [rw] message
|
@@ -1507,6 +1947,57 @@ module Aws::Connect
|
|
1507
1947
|
include Aws::Structure
|
1508
1948
|
end
|
1509
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
|
+
|
1510
2001
|
# @note When making an API call, you may pass ListQueuesRequest
|
1511
2002
|
# data as a hash:
|
1512
2003
|
#
|
@@ -1564,6 +2055,63 @@ module Aws::Connect
|
|
1564
2055
|
include Aws::Structure
|
1565
2056
|
end
|
1566
2057
|
|
2058
|
+
# @note When making an API call, you may pass ListRoutingProfileQueuesRequest
|
2059
|
+
# data as a hash:
|
2060
|
+
#
|
2061
|
+
# {
|
2062
|
+
# instance_id: "InstanceId", # required
|
2063
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2064
|
+
# next_token: "NextToken",
|
2065
|
+
# max_results: 1,
|
2066
|
+
# }
|
2067
|
+
#
|
2068
|
+
# @!attribute [rw] instance_id
|
2069
|
+
# The identifier of the Amazon Connect instance.
|
2070
|
+
# @return [String]
|
2071
|
+
#
|
2072
|
+
# @!attribute [rw] routing_profile_id
|
2073
|
+
# The identifier of the routing profile.
|
2074
|
+
# @return [String]
|
2075
|
+
#
|
2076
|
+
# @!attribute [rw] next_token
|
2077
|
+
# The token for the next set of results. Use the value returned in the
|
2078
|
+
# previous response in the next request to retrieve the next set of
|
2079
|
+
# results.
|
2080
|
+
# @return [String]
|
2081
|
+
#
|
2082
|
+
# @!attribute [rw] max_results
|
2083
|
+
# The maximimum number of results to return per page.
|
2084
|
+
# @return [Integer]
|
2085
|
+
#
|
2086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesRequest AWS API Documentation
|
2087
|
+
#
|
2088
|
+
class ListRoutingProfileQueuesRequest < Struct.new(
|
2089
|
+
:instance_id,
|
2090
|
+
:routing_profile_id,
|
2091
|
+
:next_token,
|
2092
|
+
:max_results)
|
2093
|
+
SENSITIVE = []
|
2094
|
+
include Aws::Structure
|
2095
|
+
end
|
2096
|
+
|
2097
|
+
# @!attribute [rw] next_token
|
2098
|
+
# If there are additional results, this is the token for the next set
|
2099
|
+
# of results.
|
2100
|
+
# @return [String]
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] routing_profile_queue_config_summary_list
|
2103
|
+
# Information about the routing profiles.
|
2104
|
+
# @return [Array<Types::RoutingProfileQueueConfigSummary>]
|
2105
|
+
#
|
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)
|
2111
|
+
SENSITIVE = []
|
2112
|
+
include Aws::Structure
|
2113
|
+
end
|
2114
|
+
|
1567
2115
|
# @note When making an API call, you may pass ListRoutingProfilesRequest
|
1568
2116
|
# data as a hash:
|
1569
2117
|
#
|
@@ -1799,6 +2347,36 @@ module Aws::Connect
|
|
1799
2347
|
include Aws::Structure
|
1800
2348
|
end
|
1801
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
|
+
|
1802
2380
|
# The contact is not permitted.
|
1803
2381
|
#
|
1804
2382
|
# @!attribute [rw] message
|
@@ -1869,105 +2447,321 @@ module Aws::Connect
|
|
1869
2447
|
include Aws::Structure
|
1870
2448
|
end
|
1871
2449
|
|
1872
|
-
#
|
1873
|
-
#
|
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
|
+
|
2488
|
+
# Contains information about a queue resource for which metrics are
|
2489
|
+
# returned.
|
2490
|
+
#
|
2491
|
+
# @!attribute [rw] id
|
2492
|
+
# The identifier of the queue.
|
2493
|
+
# @return [String]
|
2494
|
+
#
|
2495
|
+
# @!attribute [rw] arn
|
2496
|
+
# The Amazon Resource Name (ARN) of the queue.
|
2497
|
+
# @return [String]
|
2498
|
+
#
|
2499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueReference AWS API Documentation
|
2500
|
+
#
|
2501
|
+
class QueueReference < Struct.new(
|
2502
|
+
:id,
|
2503
|
+
:arn)
|
2504
|
+
SENSITIVE = []
|
2505
|
+
include Aws::Structure
|
2506
|
+
end
|
2507
|
+
|
2508
|
+
# Contains summary information about a queue.
|
2509
|
+
#
|
2510
|
+
# @!attribute [rw] id
|
2511
|
+
# The identifier of the queue.
|
2512
|
+
# @return [String]
|
2513
|
+
#
|
2514
|
+
# @!attribute [rw] arn
|
2515
|
+
# The Amazon Resource Name (ARN) of the queue.
|
2516
|
+
# @return [String]
|
2517
|
+
#
|
2518
|
+
# @!attribute [rw] name
|
2519
|
+
# The name of the queue.
|
2520
|
+
# @return [String]
|
2521
|
+
#
|
2522
|
+
# @!attribute [rw] queue_type
|
2523
|
+
# The type of queue.
|
2524
|
+
# @return [String]
|
2525
|
+
#
|
2526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueSummary AWS API Documentation
|
2527
|
+
#
|
2528
|
+
class QueueSummary < Struct.new(
|
2529
|
+
:id,
|
2530
|
+
:arn,
|
2531
|
+
:name,
|
2532
|
+
:queue_type)
|
2533
|
+
SENSITIVE = []
|
2534
|
+
include Aws::Structure
|
2535
|
+
end
|
2536
|
+
|
2537
|
+
# The specified resource was not found.
|
2538
|
+
#
|
2539
|
+
# @!attribute [rw] message
|
2540
|
+
# The message.
|
2541
|
+
# @return [String]
|
2542
|
+
#
|
2543
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceNotFoundException AWS API Documentation
|
2544
|
+
#
|
2545
|
+
class ResourceNotFoundException < Struct.new(
|
2546
|
+
:message)
|
2547
|
+
SENSITIVE = []
|
2548
|
+
include Aws::Structure
|
2549
|
+
end
|
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.
|
1874
2640
|
#
|
1875
|
-
#
|
1876
|
-
#
|
1877
|
-
# @return [String]
|
2641
|
+
# @note When making an API call, you may pass RoutingProfileQueueConfig
|
2642
|
+
# data as a hash:
|
1878
2643
|
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
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
|
+
# }
|
1882
2652
|
#
|
1883
|
-
#
|
2653
|
+
# @!attribute [rw] queue_reference
|
2654
|
+
# Contains information about a queue resource.
|
2655
|
+
# @return [Types::RoutingProfileQueueReference]
|
1884
2656
|
#
|
1885
|
-
|
1886
|
-
|
1887
|
-
|
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)
|
1888
2682
|
SENSITIVE = []
|
1889
2683
|
include Aws::Structure
|
1890
2684
|
end
|
1891
2685
|
|
1892
|
-
# Contains summary information about a queue.
|
2686
|
+
# Contains summary information about a routing profile queue.
|
1893
2687
|
#
|
1894
|
-
# @!attribute [rw]
|
2688
|
+
# @!attribute [rw] queue_id
|
1895
2689
|
# The identifier of the queue.
|
1896
2690
|
# @return [String]
|
1897
2691
|
#
|
1898
|
-
# @!attribute [rw]
|
2692
|
+
# @!attribute [rw] queue_arn
|
1899
2693
|
# The Amazon Resource Name (ARN) of the queue.
|
1900
2694
|
# @return [String]
|
1901
2695
|
#
|
1902
|
-
# @!attribute [rw]
|
2696
|
+
# @!attribute [rw] queue_name
|
1903
2697
|
# The name of the queue.
|
1904
2698
|
# @return [String]
|
1905
2699
|
#
|
1906
|
-
# @!attribute [rw]
|
1907
|
-
# The
|
1908
|
-
#
|
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].
|
1909
2703
|
#
|
1910
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueSummary AWS API Documentation
|
1911
2704
|
#
|
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
2705
|
#
|
1923
|
-
#
|
1924
|
-
#
|
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.
|
1925
2722
|
# @return [String]
|
1926
2723
|
#
|
1927
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfigSummary AWS API Documentation
|
1928
2725
|
#
|
1929
|
-
class
|
1930
|
-
:
|
2726
|
+
class RoutingProfileQueueConfigSummary < Struct.new(
|
2727
|
+
:queue_id,
|
2728
|
+
:queue_arn,
|
2729
|
+
:queue_name,
|
2730
|
+
:priority,
|
2731
|
+
:delay,
|
2732
|
+
:channel)
|
1931
2733
|
SENSITIVE = []
|
1932
2734
|
include Aws::Structure
|
1933
2735
|
end
|
1934
2736
|
|
1935
|
-
#
|
2737
|
+
# Contains the channel and queue identifier for a routing profile.
|
2738
|
+
#
|
2739
|
+
# @note When making an API call, you may pass RoutingProfileQueueReference
|
1936
2740
|
# data as a hash:
|
1937
2741
|
#
|
1938
2742
|
# {
|
1939
|
-
#
|
1940
|
-
#
|
1941
|
-
# initial_contact_id: "ContactId", # required
|
2743
|
+
# queue_id: "QueueId", # required
|
2744
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
1942
2745
|
# }
|
1943
2746
|
#
|
1944
|
-
# @!attribute [rw]
|
1945
|
-
# The identifier of the
|
1946
|
-
# @return [String]
|
1947
|
-
#
|
1948
|
-
# @!attribute [rw] contact_id
|
1949
|
-
# The identifier of the contact.
|
2747
|
+
# @!attribute [rw] queue_id
|
2748
|
+
# The identifier of the queue.
|
1950
2749
|
# @return [String]
|
1951
2750
|
#
|
1952
|
-
# @!attribute [rw]
|
1953
|
-
# The
|
1954
|
-
#
|
2751
|
+
# @!attribute [rw] channel
|
2752
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2753
|
+
# for this routing profile.
|
1955
2754
|
# @return [String]
|
1956
2755
|
#
|
1957
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueReference AWS API Documentation
|
1958
2757
|
#
|
1959
|
-
class
|
1960
|
-
:
|
1961
|
-
:
|
1962
|
-
:initial_contact_id)
|
2758
|
+
class RoutingProfileQueueReference < Struct.new(
|
2759
|
+
:queue_id,
|
2760
|
+
:channel)
|
1963
2761
|
SENSITIVE = []
|
1964
2762
|
include Aws::Structure
|
1965
2763
|
end
|
1966
2764
|
|
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
2765
|
# Contains summary information about a routing profile.
|
1972
2766
|
#
|
1973
2767
|
# @!attribute [rw] id
|
@@ -2040,7 +2834,14 @@ module Aws::Connect
|
|
2040
2834
|
# @return [String]
|
2041
2835
|
#
|
2042
2836
|
# @!attribute [rw] contact_flow_id
|
2043
|
-
# 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**
|
2044
2845
|
# @return [String]
|
2045
2846
|
#
|
2046
2847
|
# @!attribute [rw] attributes
|
@@ -2175,7 +2976,14 @@ module Aws::Connect
|
|
2175
2976
|
# @return [String]
|
2176
2977
|
#
|
2177
2978
|
# @!attribute [rw] contact_flow_id
|
2178
|
-
# 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**
|
2179
2987
|
# @return [String]
|
2180
2988
|
#
|
2181
2989
|
# @!attribute [rw] instance_id
|
@@ -2480,6 +3288,220 @@ module Aws::Connect
|
|
2480
3288
|
#
|
2481
3289
|
class UpdateContactAttributesResponse < Aws::EmptyStructure; end
|
2482
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
|
+
|
2483
3505
|
# @note When making an API call, you may pass UpdateUserHierarchyRequest
|
2484
3506
|
# data as a hash:
|
2485
3507
|
#
|