aws-sdk-connect 1.28.0 → 1.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +4 -3
- data/lib/aws-sdk-connect/client.rb +827 -17
- 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 +1189 -42
- 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,8 +77,78 @@ module Aws::Connect
|
|
37
77
|
include Aws::Structure
|
38
78
|
end
|
39
79
|
|
80
|
+
# Contains information about a contact flow.
|
81
|
+
#
|
82
|
+
# @!attribute [rw] arn
|
83
|
+
# The Amazon Resource Name (ARN) of the contact flow.
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] id
|
87
|
+
# The identifier of the contact flow.
|
88
|
+
# @return [String]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] name
|
91
|
+
# The name of the contact flow.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] type
|
95
|
+
# The type of the contact flow. For descriptions of the available
|
96
|
+
# types, see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
97
|
+
# Administrator Guide*.
|
98
|
+
#
|
99
|
+
#
|
100
|
+
#
|
101
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] description
|
105
|
+
# The description of the contact flow.
|
106
|
+
# @return [String]
|
107
|
+
#
|
108
|
+
# @!attribute [rw] content
|
109
|
+
# The content of the contact flow.
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] tags
|
113
|
+
# One or more tags.
|
114
|
+
# @return [Hash<String,String>]
|
115
|
+
#
|
116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlow AWS API Documentation
|
117
|
+
#
|
118
|
+
class ContactFlow < Struct.new(
|
119
|
+
:arn,
|
120
|
+
:id,
|
121
|
+
:name,
|
122
|
+
:type,
|
123
|
+
:description,
|
124
|
+
:content,
|
125
|
+
:tags)
|
126
|
+
SENSITIVE = []
|
127
|
+
include Aws::Structure
|
128
|
+
end
|
129
|
+
|
130
|
+
# The contact flow has not been published.
|
131
|
+
#
|
132
|
+
# @!attribute [rw] message
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowNotPublishedException AWS API Documentation
|
136
|
+
#
|
137
|
+
class ContactFlowNotPublishedException < Struct.new(
|
138
|
+
:message)
|
139
|
+
SENSITIVE = []
|
140
|
+
include Aws::Structure
|
141
|
+
end
|
142
|
+
|
40
143
|
# Contains summary information about a contact flow.
|
41
144
|
#
|
145
|
+
# You can also create and update contact flows using the [Amazon Connect
|
146
|
+
# Flow language][1].
|
147
|
+
#
|
148
|
+
#
|
149
|
+
#
|
150
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
151
|
+
#
|
42
152
|
# @!attribute [rw] id
|
43
153
|
# The identifier of the contact flow.
|
44
154
|
# @return [String]
|
@@ -80,6 +190,172 @@ module Aws::Connect
|
|
80
190
|
include Aws::Structure
|
81
191
|
end
|
82
192
|
|
193
|
+
# @note When making an API call, you may pass CreateContactFlowRequest
|
194
|
+
# data as a hash:
|
195
|
+
#
|
196
|
+
# {
|
197
|
+
# instance_id: "InstanceId", # required
|
198
|
+
# name: "ContactFlowName", # required
|
199
|
+
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
200
|
+
# description: "ContactFlowDescription",
|
201
|
+
# content: "ContactFlowContent", # required
|
202
|
+
# tags: {
|
203
|
+
# "TagKey" => "TagValue",
|
204
|
+
# },
|
205
|
+
# }
|
206
|
+
#
|
207
|
+
# @!attribute [rw] instance_id
|
208
|
+
# The identifier of the Amazon Connect instance.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] name
|
212
|
+
# The name of the contact flow.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @!attribute [rw] type
|
216
|
+
# The type of the contact flow. For descriptions of the available
|
217
|
+
# types, see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
218
|
+
# Administrator Guide*.
|
219
|
+
#
|
220
|
+
#
|
221
|
+
#
|
222
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
223
|
+
# @return [String]
|
224
|
+
#
|
225
|
+
# @!attribute [rw] description
|
226
|
+
# The description of the contact flow.
|
227
|
+
# @return [String]
|
228
|
+
#
|
229
|
+
# @!attribute [rw] content
|
230
|
+
# The content of the contact flow.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @!attribute [rw] tags
|
234
|
+
# One or more tags.
|
235
|
+
# @return [Hash<String,String>]
|
236
|
+
#
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowRequest AWS API Documentation
|
238
|
+
#
|
239
|
+
class CreateContactFlowRequest < Struct.new(
|
240
|
+
:instance_id,
|
241
|
+
:name,
|
242
|
+
:type,
|
243
|
+
:description,
|
244
|
+
:content,
|
245
|
+
:tags)
|
246
|
+
SENSITIVE = []
|
247
|
+
include Aws::Structure
|
248
|
+
end
|
249
|
+
|
250
|
+
# @!attribute [rw] contact_flow_id
|
251
|
+
# The identifier of the contact flow.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] contact_flow_arn
|
255
|
+
# The Amazon Resource Name (ARN) of the contact flow.
|
256
|
+
# @return [String]
|
257
|
+
#
|
258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowResponse AWS API Documentation
|
259
|
+
#
|
260
|
+
class CreateContactFlowResponse < Struct.new(
|
261
|
+
:contact_flow_id,
|
262
|
+
:contact_flow_arn)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# @note When making an API call, you may pass CreateRoutingProfileRequest
|
268
|
+
# data as a hash:
|
269
|
+
#
|
270
|
+
# {
|
271
|
+
# instance_id: "InstanceId", # required
|
272
|
+
# name: "RoutingProfileName", # required
|
273
|
+
# description: "RoutingProfileDescription", # required
|
274
|
+
# default_outbound_queue_id: "QueueId", # required
|
275
|
+
# queue_configs: [
|
276
|
+
# {
|
277
|
+
# queue_reference: { # required
|
278
|
+
# queue_id: "QueueId", # required
|
279
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
280
|
+
# },
|
281
|
+
# priority: 1, # required
|
282
|
+
# delay: 1, # required
|
283
|
+
# },
|
284
|
+
# ],
|
285
|
+
# media_concurrencies: [ # required
|
286
|
+
# {
|
287
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
288
|
+
# concurrency: 1, # required
|
289
|
+
# },
|
290
|
+
# ],
|
291
|
+
# tags: {
|
292
|
+
# "TagKey" => "TagValue",
|
293
|
+
# },
|
294
|
+
# }
|
295
|
+
#
|
296
|
+
# @!attribute [rw] instance_id
|
297
|
+
# The identifier of the Amazon Connect instance.
|
298
|
+
# @return [String]
|
299
|
+
#
|
300
|
+
# @!attribute [rw] name
|
301
|
+
# The name of the routing profile. Must not be more than 127
|
302
|
+
# characters.
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] description
|
306
|
+
# Description of the routing profile. Must not be more than 250
|
307
|
+
# characters.
|
308
|
+
# @return [String]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] default_outbound_queue_id
|
311
|
+
# The default outbound queue for the routing profile.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] queue_configs
|
315
|
+
# The inbound queues associated with the routing profile. If no queue
|
316
|
+
# is added, the agent can only make outbound calls.
|
317
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] media_concurrencies
|
320
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
321
|
+
# for this routing profile.
|
322
|
+
# @return [Array<Types::MediaConcurrency>]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] tags
|
325
|
+
# One or more tags.
|
326
|
+
# @return [Hash<String,String>]
|
327
|
+
#
|
328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfileRequest AWS API Documentation
|
329
|
+
#
|
330
|
+
class CreateRoutingProfileRequest < Struct.new(
|
331
|
+
:instance_id,
|
332
|
+
:name,
|
333
|
+
:description,
|
334
|
+
:default_outbound_queue_id,
|
335
|
+
:queue_configs,
|
336
|
+
:media_concurrencies,
|
337
|
+
:tags)
|
338
|
+
SENSITIVE = []
|
339
|
+
include Aws::Structure
|
340
|
+
end
|
341
|
+
|
342
|
+
# @!attribute [rw] routing_profile_arn
|
343
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] routing_profile_id
|
347
|
+
# The identifier of the routing profile.
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfileResponse AWS API Documentation
|
351
|
+
#
|
352
|
+
class CreateRoutingProfileResponse < Struct.new(
|
353
|
+
:routing_profile_arn,
|
354
|
+
:routing_profile_id)
|
355
|
+
SENSITIVE = []
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
83
359
|
# @note When making an API call, you may pass CreateUserRequest
|
84
360
|
# data as a hash:
|
85
361
|
#
|
@@ -325,6 +601,80 @@ module Aws::Connect
|
|
325
601
|
include Aws::Structure
|
326
602
|
end
|
327
603
|
|
604
|
+
# @note When making an API call, you may pass DescribeContactFlowRequest
|
605
|
+
# data as a hash:
|
606
|
+
#
|
607
|
+
# {
|
608
|
+
# instance_id: "InstanceId", # required
|
609
|
+
# contact_flow_id: "ContactFlowId", # required
|
610
|
+
# }
|
611
|
+
#
|
612
|
+
# @!attribute [rw] instance_id
|
613
|
+
# The identifier of the Amazon Connect instance.
|
614
|
+
# @return [String]
|
615
|
+
#
|
616
|
+
# @!attribute [rw] contact_flow_id
|
617
|
+
# The identifier of the contact flow.
|
618
|
+
# @return [String]
|
619
|
+
#
|
620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowRequest AWS API Documentation
|
621
|
+
#
|
622
|
+
class DescribeContactFlowRequest < Struct.new(
|
623
|
+
:instance_id,
|
624
|
+
:contact_flow_id)
|
625
|
+
SENSITIVE = []
|
626
|
+
include Aws::Structure
|
627
|
+
end
|
628
|
+
|
629
|
+
# @!attribute [rw] contact_flow
|
630
|
+
# Information about the contact flow.
|
631
|
+
# @return [Types::ContactFlow]
|
632
|
+
#
|
633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowResponse AWS API Documentation
|
634
|
+
#
|
635
|
+
class DescribeContactFlowResponse < Struct.new(
|
636
|
+
:contact_flow)
|
637
|
+
SENSITIVE = []
|
638
|
+
include Aws::Structure
|
639
|
+
end
|
640
|
+
|
641
|
+
# @note When making an API call, you may pass DescribeRoutingProfileRequest
|
642
|
+
# data as a hash:
|
643
|
+
#
|
644
|
+
# {
|
645
|
+
# instance_id: "InstanceId", # required
|
646
|
+
# routing_profile_id: "RoutingProfileId", # required
|
647
|
+
# }
|
648
|
+
#
|
649
|
+
# @!attribute [rw] instance_id
|
650
|
+
# The identifier of the Amazon Connect instance.
|
651
|
+
# @return [String]
|
652
|
+
#
|
653
|
+
# @!attribute [rw] routing_profile_id
|
654
|
+
# The identifier of the routing profile.
|
655
|
+
# @return [String]
|
656
|
+
#
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileRequest AWS API Documentation
|
658
|
+
#
|
659
|
+
class DescribeRoutingProfileRequest < Struct.new(
|
660
|
+
:instance_id,
|
661
|
+
:routing_profile_id)
|
662
|
+
SENSITIVE = []
|
663
|
+
include Aws::Structure
|
664
|
+
end
|
665
|
+
|
666
|
+
# @!attribute [rw] routing_profile
|
667
|
+
# The routing profile.
|
668
|
+
# @return [Types::RoutingProfile]
|
669
|
+
#
|
670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileResponse AWS API Documentation
|
671
|
+
#
|
672
|
+
class DescribeRoutingProfileResponse < Struct.new(
|
673
|
+
:routing_profile)
|
674
|
+
SENSITIVE = []
|
675
|
+
include Aws::Structure
|
676
|
+
end
|
677
|
+
|
328
678
|
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
329
679
|
# data as a hash:
|
330
680
|
#
|
@@ -463,6 +813,42 @@ module Aws::Connect
|
|
463
813
|
include Aws::Structure
|
464
814
|
end
|
465
815
|
|
816
|
+
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
817
|
+
# data as a hash:
|
818
|
+
#
|
819
|
+
# {
|
820
|
+
# instance_id: "InstanceId", # required
|
821
|
+
# routing_profile_id: "RoutingProfileId", # required
|
822
|
+
# queue_references: [ # required
|
823
|
+
# {
|
824
|
+
# queue_id: "QueueId", # required
|
825
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
826
|
+
# },
|
827
|
+
# ],
|
828
|
+
# }
|
829
|
+
#
|
830
|
+
# @!attribute [rw] instance_id
|
831
|
+
# The identifier of the Amazon Connect instance.
|
832
|
+
# @return [String]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] routing_profile_id
|
835
|
+
# The identifier of the routing profile.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] queue_references
|
839
|
+
# The queues to disassociate from this routing profile.
|
840
|
+
# @return [Array<Types::RoutingProfileQueueReference>]
|
841
|
+
#
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueuesRequest AWS API Documentation
|
843
|
+
#
|
844
|
+
class DisassociateRoutingProfileQueuesRequest < Struct.new(
|
845
|
+
:instance_id,
|
846
|
+
:routing_profile_id,
|
847
|
+
:queue_references)
|
848
|
+
SENSITIVE = []
|
849
|
+
include Aws::Structure
|
850
|
+
end
|
851
|
+
|
466
852
|
# A resource with the specified name already exists.
|
467
853
|
#
|
468
854
|
# @!attribute [rw] message
|
@@ -569,16 +955,16 @@ module Aws::Connect
|
|
569
955
|
# The queues, up to 100, or channels, to use to filter the metrics
|
570
956
|
# returned. Metric data is retrieved only for the resources associated
|
571
957
|
# with the queues or channels included in the filter. You can include
|
572
|
-
# both queue IDs and queue ARNs in the same request.
|
573
|
-
#
|
958
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
959
|
+
# `CHAT` channels are supported.
|
574
960
|
# @return [Types::Filters]
|
575
961
|
#
|
576
962
|
# @!attribute [rw] groupings
|
577
963
|
# The grouping applied to the metrics returned. For example, when
|
578
964
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
579
965
|
# than aggregated for all queues. If you group by `CHANNEL`, you
|
580
|
-
# should include a Channels filter.
|
581
|
-
#
|
966
|
+
# should include a Channels filter. Both `VOICE` and `CHAT` channels
|
967
|
+
# are supported.
|
582
968
|
#
|
583
969
|
# If no `Grouping` is included in the request, a summary of metrics is
|
584
970
|
# returned.
|
@@ -836,8 +1222,8 @@ module Aws::Connect
|
|
836
1222
|
# The queues, up to 100, or channels, to use to filter the metrics
|
837
1223
|
# returned. Metric data is retrieved only for the resources associated
|
838
1224
|
# with the queues or channels included in the filter. You can include
|
839
|
-
# both queue IDs and queue ARNs in the same request.
|
840
|
-
#
|
1225
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1226
|
+
# `CHAT` channels are supported.
|
841
1227
|
# @return [Types::Filters]
|
842
1228
|
#
|
843
1229
|
# @!attribute [rw] groupings
|
@@ -1341,6 +1727,20 @@ module Aws::Connect
|
|
1341
1727
|
include Aws::Structure
|
1342
1728
|
end
|
1343
1729
|
|
1730
|
+
# The contact flow is not valid.
|
1731
|
+
#
|
1732
|
+
# @!attribute [rw] problems
|
1733
|
+
# The problems with the contact flow. Please fix before trying again.
|
1734
|
+
# @return [Array<Types::ProblemDetail>]
|
1735
|
+
#
|
1736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidContactFlowException AWS API Documentation
|
1737
|
+
#
|
1738
|
+
class InvalidContactFlowException < Struct.new(
|
1739
|
+
:problems)
|
1740
|
+
SENSITIVE = []
|
1741
|
+
include Aws::Structure
|
1742
|
+
end
|
1743
|
+
|
1344
1744
|
# One or more of the specified parameters are not valid.
|
1345
1745
|
#
|
1346
1746
|
# @!attribute [rw] message
|
@@ -1510,8 +1910,117 @@ module Aws::Connect
|
|
1510
1910
|
# The type of phone number.
|
1511
1911
|
# @return [Array<String>]
|
1512
1912
|
#
|
1513
|
-
# @!attribute [rw] phone_number_country_codes
|
1514
|
-
# The ISO country code.
|
1913
|
+
# @!attribute [rw] phone_number_country_codes
|
1914
|
+
# The ISO country code.
|
1915
|
+
# @return [Array<String>]
|
1916
|
+
#
|
1917
|
+
# @!attribute [rw] next_token
|
1918
|
+
# The token for the next set of results. Use the value returned in the
|
1919
|
+
# previous response in the next request to retrieve the next set of
|
1920
|
+
# results.
|
1921
|
+
# @return [String]
|
1922
|
+
#
|
1923
|
+
# @!attribute [rw] max_results
|
1924
|
+
# The maximimum number of results to return per page.
|
1925
|
+
# @return [Integer]
|
1926
|
+
#
|
1927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersRequest AWS API Documentation
|
1928
|
+
#
|
1929
|
+
class ListPhoneNumbersRequest < Struct.new(
|
1930
|
+
:instance_id,
|
1931
|
+
:phone_number_types,
|
1932
|
+
:phone_number_country_codes,
|
1933
|
+
:next_token,
|
1934
|
+
:max_results)
|
1935
|
+
SENSITIVE = []
|
1936
|
+
include Aws::Structure
|
1937
|
+
end
|
1938
|
+
|
1939
|
+
# @!attribute [rw] phone_number_summary_list
|
1940
|
+
# Information about the phone numbers.
|
1941
|
+
# @return [Array<Types::PhoneNumberSummary>]
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] next_token
|
1944
|
+
# If there are additional results, this is the token for the next set
|
1945
|
+
# of results.
|
1946
|
+
# @return [String]
|
1947
|
+
#
|
1948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersResponse AWS API Documentation
|
1949
|
+
#
|
1950
|
+
class ListPhoneNumbersResponse < Struct.new(
|
1951
|
+
:phone_number_summary_list,
|
1952
|
+
:next_token)
|
1953
|
+
SENSITIVE = []
|
1954
|
+
include Aws::Structure
|
1955
|
+
end
|
1956
|
+
|
1957
|
+
# @note When making an API call, you may pass ListPromptsRequest
|
1958
|
+
# data as a hash:
|
1959
|
+
#
|
1960
|
+
# {
|
1961
|
+
# instance_id: "InstanceId", # required
|
1962
|
+
# next_token: "NextToken",
|
1963
|
+
# max_results: 1,
|
1964
|
+
# }
|
1965
|
+
#
|
1966
|
+
# @!attribute [rw] instance_id
|
1967
|
+
# The identifier of the Amazon Connect instance.
|
1968
|
+
# @return [String]
|
1969
|
+
#
|
1970
|
+
# @!attribute [rw] next_token
|
1971
|
+
# The token for the next set of results. Use the value returned in the
|
1972
|
+
# previous response in the next request to retrieve the next set of
|
1973
|
+
# results.
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @!attribute [rw] max_results
|
1977
|
+
# The maximum number of results to return per page.
|
1978
|
+
# @return [Integer]
|
1979
|
+
#
|
1980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsRequest AWS API Documentation
|
1981
|
+
#
|
1982
|
+
class ListPromptsRequest < Struct.new(
|
1983
|
+
:instance_id,
|
1984
|
+
:next_token,
|
1985
|
+
:max_results)
|
1986
|
+
SENSITIVE = []
|
1987
|
+
include Aws::Structure
|
1988
|
+
end
|
1989
|
+
|
1990
|
+
# @!attribute [rw] prompt_summary_list
|
1991
|
+
# Information about the prompts.
|
1992
|
+
# @return [Array<Types::PromptSummary>]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] next_token
|
1995
|
+
# If there are additional results, this is the token for the next set
|
1996
|
+
# of results.
|
1997
|
+
# @return [String]
|
1998
|
+
#
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsResponse AWS API Documentation
|
2000
|
+
#
|
2001
|
+
class ListPromptsResponse < Struct.new(
|
2002
|
+
:prompt_summary_list,
|
2003
|
+
:next_token)
|
2004
|
+
SENSITIVE = []
|
2005
|
+
include Aws::Structure
|
2006
|
+
end
|
2007
|
+
|
2008
|
+
# @note When making an API call, you may pass ListQueuesRequest
|
2009
|
+
# data as a hash:
|
2010
|
+
#
|
2011
|
+
# {
|
2012
|
+
# instance_id: "InstanceId", # required
|
2013
|
+
# queue_types: ["STANDARD"], # accepts STANDARD, AGENT
|
2014
|
+
# next_token: "NextToken",
|
2015
|
+
# max_results: 1,
|
2016
|
+
# }
|
2017
|
+
#
|
2018
|
+
# @!attribute [rw] instance_id
|
2019
|
+
# The identifier of the Amazon Connect instance.
|
2020
|
+
# @return [String]
|
2021
|
+
#
|
2022
|
+
# @!attribute [rw] queue_types
|
2023
|
+
# The type of queue.
|
1515
2024
|
# @return [Array<String>]
|
1516
2025
|
#
|
1517
2026
|
# @!attribute [rw] next_token
|
@@ -1524,42 +2033,41 @@ module Aws::Connect
|
|
1524
2033
|
# The maximimum number of results to return per page.
|
1525
2034
|
# @return [Integer]
|
1526
2035
|
#
|
1527
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesRequest AWS API Documentation
|
1528
2037
|
#
|
1529
|
-
class
|
2038
|
+
class ListQueuesRequest < Struct.new(
|
1530
2039
|
:instance_id,
|
1531
|
-
:
|
1532
|
-
:phone_number_country_codes,
|
2040
|
+
:queue_types,
|
1533
2041
|
:next_token,
|
1534
2042
|
:max_results)
|
1535
2043
|
SENSITIVE = []
|
1536
2044
|
include Aws::Structure
|
1537
2045
|
end
|
1538
2046
|
|
1539
|
-
# @!attribute [rw]
|
1540
|
-
# Information about the
|
1541
|
-
# @return [Array<Types::
|
2047
|
+
# @!attribute [rw] queue_summary_list
|
2048
|
+
# Information about the queues.
|
2049
|
+
# @return [Array<Types::QueueSummary>]
|
1542
2050
|
#
|
1543
2051
|
# @!attribute [rw] next_token
|
1544
2052
|
# If there are additional results, this is the token for the next set
|
1545
2053
|
# of results.
|
1546
2054
|
# @return [String]
|
1547
2055
|
#
|
1548
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesResponse AWS API Documentation
|
1549
2057
|
#
|
1550
|
-
class
|
1551
|
-
:
|
2058
|
+
class ListQueuesResponse < Struct.new(
|
2059
|
+
:queue_summary_list,
|
1552
2060
|
:next_token)
|
1553
2061
|
SENSITIVE = []
|
1554
2062
|
include Aws::Structure
|
1555
2063
|
end
|
1556
2064
|
|
1557
|
-
# @note When making an API call, you may pass
|
2065
|
+
# @note When making an API call, you may pass ListRoutingProfileQueuesRequest
|
1558
2066
|
# data as a hash:
|
1559
2067
|
#
|
1560
2068
|
# {
|
1561
2069
|
# instance_id: "InstanceId", # required
|
1562
|
-
#
|
2070
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1563
2071
|
# next_token: "NextToken",
|
1564
2072
|
# max_results: 1,
|
1565
2073
|
# }
|
@@ -1568,9 +2076,9 @@ module Aws::Connect
|
|
1568
2076
|
# The identifier of the Amazon Connect instance.
|
1569
2077
|
# @return [String]
|
1570
2078
|
#
|
1571
|
-
# @!attribute [rw]
|
1572
|
-
# The
|
1573
|
-
# @return [
|
2079
|
+
# @!attribute [rw] routing_profile_id
|
2080
|
+
# The identifier of the routing profile.
|
2081
|
+
# @return [String]
|
1574
2082
|
#
|
1575
2083
|
# @!attribute [rw] next_token
|
1576
2084
|
# The token for the next set of results. Use the value returned in the
|
@@ -1582,31 +2090,31 @@ module Aws::Connect
|
|
1582
2090
|
# The maximimum number of results to return per page.
|
1583
2091
|
# @return [Integer]
|
1584
2092
|
#
|
1585
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesRequest AWS API Documentation
|
1586
2094
|
#
|
1587
|
-
class
|
2095
|
+
class ListRoutingProfileQueuesRequest < Struct.new(
|
1588
2096
|
:instance_id,
|
1589
|
-
:
|
2097
|
+
:routing_profile_id,
|
1590
2098
|
:next_token,
|
1591
2099
|
:max_results)
|
1592
2100
|
SENSITIVE = []
|
1593
2101
|
include Aws::Structure
|
1594
2102
|
end
|
1595
2103
|
|
1596
|
-
# @!attribute [rw] queue_summary_list
|
1597
|
-
# Information about the queues.
|
1598
|
-
# @return [Array<Types::QueueSummary>]
|
1599
|
-
#
|
1600
2104
|
# @!attribute [rw] next_token
|
1601
2105
|
# If there are additional results, this is the token for the next set
|
1602
2106
|
# of results.
|
1603
2107
|
# @return [String]
|
1604
2108
|
#
|
1605
|
-
#
|
2109
|
+
# @!attribute [rw] routing_profile_queue_config_summary_list
|
2110
|
+
# Information about the routing profiles.
|
2111
|
+
# @return [Array<Types::RoutingProfileQueueConfigSummary>]
|
1606
2112
|
#
|
1607
|
-
|
1608
|
-
|
1609
|
-
|
2113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesResponse AWS API Documentation
|
2114
|
+
#
|
2115
|
+
class ListRoutingProfileQueuesResponse < Struct.new(
|
2116
|
+
:next_token,
|
2117
|
+
:routing_profile_queue_config_summary_list)
|
1610
2118
|
SENSITIVE = []
|
1611
2119
|
include Aws::Structure
|
1612
2120
|
end
|
@@ -1846,6 +2354,36 @@ module Aws::Connect
|
|
1846
2354
|
include Aws::Structure
|
1847
2355
|
end
|
1848
2356
|
|
2357
|
+
# Contains information about which channels are supported, and how many
|
2358
|
+
# contacts an agent can have on a channel simultaneously.
|
2359
|
+
#
|
2360
|
+
# @note When making an API call, you may pass MediaConcurrency
|
2361
|
+
# data as a hash:
|
2362
|
+
#
|
2363
|
+
# {
|
2364
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2365
|
+
# concurrency: 1, # required
|
2366
|
+
# }
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] channel
|
2369
|
+
# The channels that agents can handle in the Contact Control Panel
|
2370
|
+
# (CCP).
|
2371
|
+
# @return [String]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] concurrency
|
2374
|
+
# The number of contacts an agent can have on a channel
|
2375
|
+
# simultaneously.
|
2376
|
+
# @return [Integer]
|
2377
|
+
#
|
2378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MediaConcurrency AWS API Documentation
|
2379
|
+
#
|
2380
|
+
class MediaConcurrency < Struct.new(
|
2381
|
+
:channel,
|
2382
|
+
:concurrency)
|
2383
|
+
SENSITIVE = []
|
2384
|
+
include Aws::Structure
|
2385
|
+
end
|
2386
|
+
|
1849
2387
|
# The contact is not permitted.
|
1850
2388
|
#
|
1851
2389
|
# @!attribute [rw] message
|
@@ -1916,6 +2454,44 @@ module Aws::Connect
|
|
1916
2454
|
include Aws::Structure
|
1917
2455
|
end
|
1918
2456
|
|
2457
|
+
# Information about a problem detail.
|
2458
|
+
#
|
2459
|
+
# @!attribute [rw] message
|
2460
|
+
# The problem detail's message.
|
2461
|
+
# @return [String]
|
2462
|
+
#
|
2463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ProblemDetail AWS API Documentation
|
2464
|
+
#
|
2465
|
+
class ProblemDetail < Struct.new(
|
2466
|
+
:message)
|
2467
|
+
SENSITIVE = []
|
2468
|
+
include Aws::Structure
|
2469
|
+
end
|
2470
|
+
|
2471
|
+
# Contains information about the prompt.
|
2472
|
+
#
|
2473
|
+
# @!attribute [rw] id
|
2474
|
+
# The identifier of the prompt.
|
2475
|
+
# @return [String]
|
2476
|
+
#
|
2477
|
+
# @!attribute [rw] arn
|
2478
|
+
# The Amazon Resource Name (ARN) of the prompt.
|
2479
|
+
# @return [String]
|
2480
|
+
#
|
2481
|
+
# @!attribute [rw] name
|
2482
|
+
# The name of the prompt.
|
2483
|
+
# @return [String]
|
2484
|
+
#
|
2485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PromptSummary AWS API Documentation
|
2486
|
+
#
|
2487
|
+
class PromptSummary < Struct.new(
|
2488
|
+
:id,
|
2489
|
+
:arn,
|
2490
|
+
:name)
|
2491
|
+
SENSITIVE = []
|
2492
|
+
include Aws::Structure
|
2493
|
+
end
|
2494
|
+
|
1919
2495
|
# Contains information about a queue resource for which metrics are
|
1920
2496
|
# returned.
|
1921
2497
|
#
|
@@ -1979,6 +2555,220 @@ module Aws::Connect
|
|
1979
2555
|
include Aws::Structure
|
1980
2556
|
end
|
1981
2557
|
|
2558
|
+
# @note When making an API call, you may pass ResumeContactRecordingRequest
|
2559
|
+
# data as a hash:
|
2560
|
+
#
|
2561
|
+
# {
|
2562
|
+
# instance_id: "InstanceId", # required
|
2563
|
+
# contact_id: "ContactId", # required
|
2564
|
+
# initial_contact_id: "ContactId", # required
|
2565
|
+
# }
|
2566
|
+
#
|
2567
|
+
# @!attribute [rw] instance_id
|
2568
|
+
# The identifier of the Amazon Connect instance.
|
2569
|
+
# @return [String]
|
2570
|
+
#
|
2571
|
+
# @!attribute [rw] contact_id
|
2572
|
+
# The identifier of the contact.
|
2573
|
+
# @return [String]
|
2574
|
+
#
|
2575
|
+
# @!attribute [rw] initial_contact_id
|
2576
|
+
# The identifier of the contact. This is the identifier of the contact
|
2577
|
+
# associated with the first interaction with the contact center.
|
2578
|
+
# @return [String]
|
2579
|
+
#
|
2580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingRequest AWS API Documentation
|
2581
|
+
#
|
2582
|
+
class ResumeContactRecordingRequest < Struct.new(
|
2583
|
+
:instance_id,
|
2584
|
+
:contact_id,
|
2585
|
+
:initial_contact_id)
|
2586
|
+
SENSITIVE = []
|
2587
|
+
include Aws::Structure
|
2588
|
+
end
|
2589
|
+
|
2590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResumeContactRecordingResponse AWS API Documentation
|
2591
|
+
#
|
2592
|
+
class ResumeContactRecordingResponse < Aws::EmptyStructure; end
|
2593
|
+
|
2594
|
+
# Contains information about a routing profile.
|
2595
|
+
#
|
2596
|
+
# @!attribute [rw] instance_id
|
2597
|
+
# The identifier of the Amazon Connect instance.
|
2598
|
+
# @return [String]
|
2599
|
+
#
|
2600
|
+
# @!attribute [rw] name
|
2601
|
+
# The name of the routing profile.
|
2602
|
+
# @return [String]
|
2603
|
+
#
|
2604
|
+
# @!attribute [rw] routing_profile_arn
|
2605
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
2606
|
+
# @return [String]
|
2607
|
+
#
|
2608
|
+
# @!attribute [rw] routing_profile_id
|
2609
|
+
# The identifier of the routing profile.
|
2610
|
+
# @return [String]
|
2611
|
+
#
|
2612
|
+
# @!attribute [rw] description
|
2613
|
+
# The description of the routing profile.
|
2614
|
+
# @return [String]
|
2615
|
+
#
|
2616
|
+
# @!attribute [rw] media_concurrencies
|
2617
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2618
|
+
# for this routing profile.
|
2619
|
+
# @return [Array<Types::MediaConcurrency>]
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] default_outbound_queue_id
|
2622
|
+
# The identifier of the default outbound queue for this routing
|
2623
|
+
# profile.
|
2624
|
+
# @return [String]
|
2625
|
+
#
|
2626
|
+
# @!attribute [rw] tags
|
2627
|
+
# One or more tags.
|
2628
|
+
# @return [Hash<String,String>]
|
2629
|
+
#
|
2630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfile AWS API Documentation
|
2631
|
+
#
|
2632
|
+
class RoutingProfile < Struct.new(
|
2633
|
+
:instance_id,
|
2634
|
+
:name,
|
2635
|
+
:routing_profile_arn,
|
2636
|
+
:routing_profile_id,
|
2637
|
+
:description,
|
2638
|
+
:media_concurrencies,
|
2639
|
+
:default_outbound_queue_id,
|
2640
|
+
:tags)
|
2641
|
+
SENSITIVE = []
|
2642
|
+
include Aws::Structure
|
2643
|
+
end
|
2644
|
+
|
2645
|
+
# Contains information about the queue and channel for which priority
|
2646
|
+
# and delay can be set.
|
2647
|
+
#
|
2648
|
+
# @note When making an API call, you may pass RoutingProfileQueueConfig
|
2649
|
+
# data as a hash:
|
2650
|
+
#
|
2651
|
+
# {
|
2652
|
+
# queue_reference: { # required
|
2653
|
+
# queue_id: "QueueId", # required
|
2654
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2655
|
+
# },
|
2656
|
+
# priority: 1, # required
|
2657
|
+
# delay: 1, # required
|
2658
|
+
# }
|
2659
|
+
#
|
2660
|
+
# @!attribute [rw] queue_reference
|
2661
|
+
# Contains information about a queue resource.
|
2662
|
+
# @return [Types::RoutingProfileQueueReference]
|
2663
|
+
#
|
2664
|
+
# @!attribute [rw] priority
|
2665
|
+
# The order in which contacts are to be handled for the queue. For
|
2666
|
+
# more information, see [Queues: priority and delay][1].
|
2667
|
+
#
|
2668
|
+
#
|
2669
|
+
#
|
2670
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2671
|
+
# @return [Integer]
|
2672
|
+
#
|
2673
|
+
# @!attribute [rw] delay
|
2674
|
+
# The delay, in seconds, a contact should be in the queue before they
|
2675
|
+
# are routed to an available agent. For more information, see [Queues:
|
2676
|
+
# priority and delay][1] in the *Amazon Connect Administrator Guide*.
|
2677
|
+
#
|
2678
|
+
#
|
2679
|
+
#
|
2680
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2681
|
+
# @return [Integer]
|
2682
|
+
#
|
2683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfig AWS API Documentation
|
2684
|
+
#
|
2685
|
+
class RoutingProfileQueueConfig < Struct.new(
|
2686
|
+
:queue_reference,
|
2687
|
+
:priority,
|
2688
|
+
:delay)
|
2689
|
+
SENSITIVE = []
|
2690
|
+
include Aws::Structure
|
2691
|
+
end
|
2692
|
+
|
2693
|
+
# Contains summary information about a routing profile queue.
|
2694
|
+
#
|
2695
|
+
# @!attribute [rw] queue_id
|
2696
|
+
# The identifier of the queue.
|
2697
|
+
# @return [String]
|
2698
|
+
#
|
2699
|
+
# @!attribute [rw] queue_arn
|
2700
|
+
# The Amazon Resource Name (ARN) of the queue.
|
2701
|
+
# @return [String]
|
2702
|
+
#
|
2703
|
+
# @!attribute [rw] queue_name
|
2704
|
+
# The name of the queue.
|
2705
|
+
# @return [String]
|
2706
|
+
#
|
2707
|
+
# @!attribute [rw] priority
|
2708
|
+
# The order in which contacts are to be handled for the queue. For
|
2709
|
+
# more information, see [Queues: priority and delay][1].
|
2710
|
+
#
|
2711
|
+
#
|
2712
|
+
#
|
2713
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2714
|
+
# @return [Integer]
|
2715
|
+
#
|
2716
|
+
# @!attribute [rw] delay
|
2717
|
+
# The delay, in seconds, that a contact should be in the queue before
|
2718
|
+
# they are routed to an available agent. For more information, see
|
2719
|
+
# [Queues: priority and delay][1] in the *Amazon Connect Administrator
|
2720
|
+
# Guide*.
|
2721
|
+
#
|
2722
|
+
#
|
2723
|
+
#
|
2724
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
|
2725
|
+
# @return [Integer]
|
2726
|
+
#
|
2727
|
+
# @!attribute [rw] channel
|
2728
|
+
# The channels this queue supports.
|
2729
|
+
# @return [String]
|
2730
|
+
#
|
2731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueConfigSummary AWS API Documentation
|
2732
|
+
#
|
2733
|
+
class RoutingProfileQueueConfigSummary < Struct.new(
|
2734
|
+
:queue_id,
|
2735
|
+
:queue_arn,
|
2736
|
+
:queue_name,
|
2737
|
+
:priority,
|
2738
|
+
:delay,
|
2739
|
+
:channel)
|
2740
|
+
SENSITIVE = []
|
2741
|
+
include Aws::Structure
|
2742
|
+
end
|
2743
|
+
|
2744
|
+
# Contains the channel and queue identifier for a routing profile.
|
2745
|
+
#
|
2746
|
+
# @note When making an API call, you may pass RoutingProfileQueueReference
|
2747
|
+
# data as a hash:
|
2748
|
+
#
|
2749
|
+
# {
|
2750
|
+
# queue_id: "QueueId", # required
|
2751
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2752
|
+
# }
|
2753
|
+
#
|
2754
|
+
# @!attribute [rw] queue_id
|
2755
|
+
# The identifier of the queue.
|
2756
|
+
# @return [String]
|
2757
|
+
#
|
2758
|
+
# @!attribute [rw] channel
|
2759
|
+
# The channels agents can handle in the Contact Control Panel (CCP)
|
2760
|
+
# for this routing profile.
|
2761
|
+
# @return [String]
|
2762
|
+
#
|
2763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileQueueReference AWS API Documentation
|
2764
|
+
#
|
2765
|
+
class RoutingProfileQueueReference < Struct.new(
|
2766
|
+
:queue_id,
|
2767
|
+
:channel)
|
2768
|
+
SENSITIVE = []
|
2769
|
+
include Aws::Structure
|
2770
|
+
end
|
2771
|
+
|
1982
2772
|
# Contains summary information about a routing profile.
|
1983
2773
|
#
|
1984
2774
|
# @!attribute [rw] id
|
@@ -2051,9 +2841,9 @@ module Aws::Connect
|
|
2051
2841
|
# @return [String]
|
2052
2842
|
#
|
2053
2843
|
# @!attribute [rw] contact_flow_id
|
2054
|
-
# The identifier of the contact flow for the
|
2055
|
-
# ContactFlowId in the Amazon Connect console user interface, on
|
2056
|
-
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2844
|
+
# The identifier of the contact flow for initiating the chat. To see
|
2845
|
+
# the ContactFlowId in the Amazon Connect console user interface, on
|
2846
|
+
# the navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2057
2847
|
# contact flow. On the contact flow page, under the name of the
|
2058
2848
|
# contact flow, choose **Show additional flow information**. The
|
2059
2849
|
# ContactFlowId is the last part of the ARN, shown here in bold:
|
@@ -2116,19 +2906,63 @@ module Aws::Connect
|
|
2116
2906
|
#
|
2117
2907
|
#
|
2118
2908
|
#
|
2119
|
-
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
2909
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
2910
|
+
# @return [String]
|
2911
|
+
#
|
2912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactResponse AWS API Documentation
|
2913
|
+
#
|
2914
|
+
class StartChatContactResponse < Struct.new(
|
2915
|
+
:contact_id,
|
2916
|
+
:participant_id,
|
2917
|
+
:participant_token)
|
2918
|
+
SENSITIVE = []
|
2919
|
+
include Aws::Structure
|
2920
|
+
end
|
2921
|
+
|
2922
|
+
# @note When making an API call, you may pass StartContactRecordingRequest
|
2923
|
+
# data as a hash:
|
2924
|
+
#
|
2925
|
+
# {
|
2926
|
+
# instance_id: "InstanceId", # required
|
2927
|
+
# contact_id: "ContactId", # required
|
2928
|
+
# initial_contact_id: "ContactId", # required
|
2929
|
+
# voice_recording_configuration: { # required
|
2930
|
+
# voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
|
2931
|
+
# },
|
2932
|
+
# }
|
2933
|
+
#
|
2934
|
+
# @!attribute [rw] instance_id
|
2935
|
+
# The identifier of the Amazon Connect instance.
|
2936
|
+
# @return [String]
|
2937
|
+
#
|
2938
|
+
# @!attribute [rw] contact_id
|
2939
|
+
# The identifier of the contact.
|
2940
|
+
# @return [String]
|
2941
|
+
#
|
2942
|
+
# @!attribute [rw] initial_contact_id
|
2943
|
+
# The identifier of the contact. This is the identifier of the contact
|
2944
|
+
# associated with the first interaction with the contact center.
|
2120
2945
|
# @return [String]
|
2121
2946
|
#
|
2122
|
-
#
|
2947
|
+
# @!attribute [rw] voice_recording_configuration
|
2948
|
+
# Who is being recorded.
|
2949
|
+
# @return [Types::VoiceRecordingConfiguration]
|
2123
2950
|
#
|
2124
|
-
|
2951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingRequest AWS API Documentation
|
2952
|
+
#
|
2953
|
+
class StartContactRecordingRequest < Struct.new(
|
2954
|
+
:instance_id,
|
2125
2955
|
:contact_id,
|
2126
|
-
:
|
2127
|
-
:
|
2956
|
+
:initial_contact_id,
|
2957
|
+
:voice_recording_configuration)
|
2128
2958
|
SENSITIVE = []
|
2129
2959
|
include Aws::Structure
|
2130
2960
|
end
|
2131
2961
|
|
2962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactRecordingResponse AWS API Documentation
|
2963
|
+
#
|
2964
|
+
class StartContactRecordingResponse < Aws::EmptyStructure; end
|
2965
|
+
|
2132
2966
|
# @note When making an API call, you may pass StartOutboundVoiceContactRequest
|
2133
2967
|
# data as a hash:
|
2134
2968
|
#
|
@@ -2223,6 +3057,42 @@ module Aws::Connect
|
|
2223
3057
|
include Aws::Structure
|
2224
3058
|
end
|
2225
3059
|
|
3060
|
+
# @note When making an API call, you may pass StopContactRecordingRequest
|
3061
|
+
# data as a hash:
|
3062
|
+
#
|
3063
|
+
# {
|
3064
|
+
# instance_id: "InstanceId", # required
|
3065
|
+
# contact_id: "ContactId", # required
|
3066
|
+
# initial_contact_id: "ContactId", # required
|
3067
|
+
# }
|
3068
|
+
#
|
3069
|
+
# @!attribute [rw] instance_id
|
3070
|
+
# The identifier of the Amazon Connect instance.
|
3071
|
+
# @return [String]
|
3072
|
+
#
|
3073
|
+
# @!attribute [rw] contact_id
|
3074
|
+
# The identifier of the contact.
|
3075
|
+
# @return [String]
|
3076
|
+
#
|
3077
|
+
# @!attribute [rw] initial_contact_id
|
3078
|
+
# The identifier of the contact. This is the identifier of the contact
|
3079
|
+
# associated with the first interaction with the contact center.
|
3080
|
+
# @return [String]
|
3081
|
+
#
|
3082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecordingRequest AWS API Documentation
|
3083
|
+
#
|
3084
|
+
class StopContactRecordingRequest < Struct.new(
|
3085
|
+
:instance_id,
|
3086
|
+
:contact_id,
|
3087
|
+
:initial_contact_id)
|
3088
|
+
SENSITIVE = []
|
3089
|
+
include Aws::Structure
|
3090
|
+
end
|
3091
|
+
|
3092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRecordingResponse AWS API Documentation
|
3093
|
+
#
|
3094
|
+
class StopContactRecordingResponse < Aws::EmptyStructure; end
|
3095
|
+
|
2226
3096
|
# @note When making an API call, you may pass StopContactRequest
|
2227
3097
|
# data as a hash:
|
2228
3098
|
#
|
@@ -2252,6 +3122,42 @@ module Aws::Connect
|
|
2252
3122
|
#
|
2253
3123
|
class StopContactResponse < Aws::EmptyStructure; end
|
2254
3124
|
|
3125
|
+
# @note When making an API call, you may pass SuspendContactRecordingRequest
|
3126
|
+
# data as a hash:
|
3127
|
+
#
|
3128
|
+
# {
|
3129
|
+
# instance_id: "InstanceId", # required
|
3130
|
+
# contact_id: "ContactId", # required
|
3131
|
+
# initial_contact_id: "ContactId", # required
|
3132
|
+
# }
|
3133
|
+
#
|
3134
|
+
# @!attribute [rw] instance_id
|
3135
|
+
# The identifier of the Amazon Connect instance.
|
3136
|
+
# @return [String]
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] contact_id
|
3139
|
+
# The identifier of the contact.
|
3140
|
+
# @return [String]
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] initial_contact_id
|
3143
|
+
# The identifier of the contact. This is the identifier of the contact
|
3144
|
+
# associated with the first interaction with the contact center.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingRequest AWS API Documentation
|
3148
|
+
#
|
3149
|
+
class SuspendContactRecordingRequest < Struct.new(
|
3150
|
+
:instance_id,
|
3151
|
+
:contact_id,
|
3152
|
+
:initial_contact_id)
|
3153
|
+
SENSITIVE = []
|
3154
|
+
include Aws::Structure
|
3155
|
+
end
|
3156
|
+
|
3157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuspendContactRecordingResponse AWS API Documentation
|
3158
|
+
#
|
3159
|
+
class SuspendContactRecordingResponse < Aws::EmptyStructure; end
|
3160
|
+
|
2255
3161
|
# @note When making an API call, you may pass TagResourceRequest
|
2256
3162
|
# data as a hash:
|
2257
3163
|
#
|
@@ -2389,6 +3295,226 @@ module Aws::Connect
|
|
2389
3295
|
#
|
2390
3296
|
class UpdateContactAttributesResponse < Aws::EmptyStructure; end
|
2391
3297
|
|
3298
|
+
# @note When making an API call, you may pass UpdateContactFlowContentRequest
|
3299
|
+
# data as a hash:
|
3300
|
+
#
|
3301
|
+
# {
|
3302
|
+
# instance_id: "InstanceId", # required
|
3303
|
+
# contact_flow_id: "ContactFlowId", # required
|
3304
|
+
# content: "ContactFlowContent", # required
|
3305
|
+
# }
|
3306
|
+
#
|
3307
|
+
# @!attribute [rw] instance_id
|
3308
|
+
# The identifier of the Amazon Connect instance.
|
3309
|
+
# @return [String]
|
3310
|
+
#
|
3311
|
+
# @!attribute [rw] contact_flow_id
|
3312
|
+
# The identifier of the contact flow.
|
3313
|
+
# @return [String]
|
3314
|
+
#
|
3315
|
+
# @!attribute [rw] content
|
3316
|
+
# The JSON string that represents contact flow’s content. For an
|
3317
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
3318
|
+
# language][1] in the *Amazon Connect Administrator Guide*.
|
3319
|
+
#
|
3320
|
+
#
|
3321
|
+
#
|
3322
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
|
3323
|
+
# @return [String]
|
3324
|
+
#
|
3325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContentRequest AWS API Documentation
|
3326
|
+
#
|
3327
|
+
class UpdateContactFlowContentRequest < Struct.new(
|
3328
|
+
:instance_id,
|
3329
|
+
:contact_flow_id,
|
3330
|
+
:content)
|
3331
|
+
SENSITIVE = []
|
3332
|
+
include Aws::Structure
|
3333
|
+
end
|
3334
|
+
|
3335
|
+
# @note When making an API call, you may pass UpdateContactFlowNameRequest
|
3336
|
+
# data as a hash:
|
3337
|
+
#
|
3338
|
+
# {
|
3339
|
+
# instance_id: "InstanceId", # required
|
3340
|
+
# contact_flow_id: "ContactFlowId", # required
|
3341
|
+
# name: "ContactFlowName",
|
3342
|
+
# description: "ContactFlowDescription",
|
3343
|
+
# }
|
3344
|
+
#
|
3345
|
+
# @!attribute [rw] instance_id
|
3346
|
+
# The identifier of the Amazon Connect instance.
|
3347
|
+
# @return [String]
|
3348
|
+
#
|
3349
|
+
# @!attribute [rw] contact_flow_id
|
3350
|
+
# The identifier of the contact flow.
|
3351
|
+
# @return [String]
|
3352
|
+
#
|
3353
|
+
# @!attribute [rw] name
|
3354
|
+
# The name of the contact flow.
|
3355
|
+
# @return [String]
|
3356
|
+
#
|
3357
|
+
# @!attribute [rw] description
|
3358
|
+
# The description of the contact flow.
|
3359
|
+
# @return [String]
|
3360
|
+
#
|
3361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowNameRequest AWS API Documentation
|
3362
|
+
#
|
3363
|
+
class UpdateContactFlowNameRequest < Struct.new(
|
3364
|
+
:instance_id,
|
3365
|
+
:contact_flow_id,
|
3366
|
+
:name,
|
3367
|
+
:description)
|
3368
|
+
SENSITIVE = []
|
3369
|
+
include Aws::Structure
|
3370
|
+
end
|
3371
|
+
|
3372
|
+
# @note When making an API call, you may pass UpdateRoutingProfileConcurrencyRequest
|
3373
|
+
# data as a hash:
|
3374
|
+
#
|
3375
|
+
# {
|
3376
|
+
# instance_id: "InstanceId", # required
|
3377
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3378
|
+
# media_concurrencies: [ # required
|
3379
|
+
# {
|
3380
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3381
|
+
# concurrency: 1, # required
|
3382
|
+
# },
|
3383
|
+
# ],
|
3384
|
+
# }
|
3385
|
+
#
|
3386
|
+
# @!attribute [rw] instance_id
|
3387
|
+
# The identifier of the Amazon Connect instance.
|
3388
|
+
# @return [String]
|
3389
|
+
#
|
3390
|
+
# @!attribute [rw] routing_profile_id
|
3391
|
+
# The identifier of the routing profile.
|
3392
|
+
# @return [String]
|
3393
|
+
#
|
3394
|
+
# @!attribute [rw] media_concurrencies
|
3395
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
3396
|
+
# @return [Array<Types::MediaConcurrency>]
|
3397
|
+
#
|
3398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrencyRequest AWS API Documentation
|
3399
|
+
#
|
3400
|
+
class UpdateRoutingProfileConcurrencyRequest < Struct.new(
|
3401
|
+
:instance_id,
|
3402
|
+
:routing_profile_id,
|
3403
|
+
:media_concurrencies)
|
3404
|
+
SENSITIVE = []
|
3405
|
+
include Aws::Structure
|
3406
|
+
end
|
3407
|
+
|
3408
|
+
# @note When making an API call, you may pass UpdateRoutingProfileDefaultOutboundQueueRequest
|
3409
|
+
# data as a hash:
|
3410
|
+
#
|
3411
|
+
# {
|
3412
|
+
# instance_id: "InstanceId", # required
|
3413
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3414
|
+
# default_outbound_queue_id: "QueueId", # required
|
3415
|
+
# }
|
3416
|
+
#
|
3417
|
+
# @!attribute [rw] instance_id
|
3418
|
+
# The identifier of the Amazon Connect instance.
|
3419
|
+
# @return [String]
|
3420
|
+
#
|
3421
|
+
# @!attribute [rw] routing_profile_id
|
3422
|
+
# The identifier of the routing profile.
|
3423
|
+
# @return [String]
|
3424
|
+
#
|
3425
|
+
# @!attribute [rw] default_outbound_queue_id
|
3426
|
+
# The identifier for the default outbound queue.
|
3427
|
+
# @return [String]
|
3428
|
+
#
|
3429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueueRequest AWS API Documentation
|
3430
|
+
#
|
3431
|
+
class UpdateRoutingProfileDefaultOutboundQueueRequest < Struct.new(
|
3432
|
+
:instance_id,
|
3433
|
+
:routing_profile_id,
|
3434
|
+
:default_outbound_queue_id)
|
3435
|
+
SENSITIVE = []
|
3436
|
+
include Aws::Structure
|
3437
|
+
end
|
3438
|
+
|
3439
|
+
# @note When making an API call, you may pass UpdateRoutingProfileNameRequest
|
3440
|
+
# data as a hash:
|
3441
|
+
#
|
3442
|
+
# {
|
3443
|
+
# instance_id: "InstanceId", # required
|
3444
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3445
|
+
# name: "RoutingProfileName",
|
3446
|
+
# description: "RoutingProfileDescription",
|
3447
|
+
# }
|
3448
|
+
#
|
3449
|
+
# @!attribute [rw] instance_id
|
3450
|
+
# The identifier of the Amazon Connect instance.
|
3451
|
+
# @return [String]
|
3452
|
+
#
|
3453
|
+
# @!attribute [rw] routing_profile_id
|
3454
|
+
# The identifier of the routing profile.
|
3455
|
+
# @return [String]
|
3456
|
+
#
|
3457
|
+
# @!attribute [rw] name
|
3458
|
+
# The name of the routing profile. Must not be more than 127
|
3459
|
+
# characters.
|
3460
|
+
# @return [String]
|
3461
|
+
#
|
3462
|
+
# @!attribute [rw] description
|
3463
|
+
# The description of the routing profile. Must not be more than 250
|
3464
|
+
# characters.
|
3465
|
+
# @return [String]
|
3466
|
+
#
|
3467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileNameRequest AWS API Documentation
|
3468
|
+
#
|
3469
|
+
class UpdateRoutingProfileNameRequest < Struct.new(
|
3470
|
+
:instance_id,
|
3471
|
+
:routing_profile_id,
|
3472
|
+
:name,
|
3473
|
+
:description)
|
3474
|
+
SENSITIVE = []
|
3475
|
+
include Aws::Structure
|
3476
|
+
end
|
3477
|
+
|
3478
|
+
# @note When making an API call, you may pass UpdateRoutingProfileQueuesRequest
|
3479
|
+
# data as a hash:
|
3480
|
+
#
|
3481
|
+
# {
|
3482
|
+
# instance_id: "InstanceId", # required
|
3483
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3484
|
+
# queue_configs: [ # required
|
3485
|
+
# {
|
3486
|
+
# queue_reference: { # required
|
3487
|
+
# queue_id: "QueueId", # required
|
3488
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3489
|
+
# },
|
3490
|
+
# priority: 1, # required
|
3491
|
+
# delay: 1, # required
|
3492
|
+
# },
|
3493
|
+
# ],
|
3494
|
+
# }
|
3495
|
+
#
|
3496
|
+
# @!attribute [rw] instance_id
|
3497
|
+
# The identifier of the Amazon Connect instance.
|
3498
|
+
# @return [String]
|
3499
|
+
#
|
3500
|
+
# @!attribute [rw] routing_profile_id
|
3501
|
+
# The identifier of the routing profile.
|
3502
|
+
# @return [String]
|
3503
|
+
#
|
3504
|
+
# @!attribute [rw] queue_configs
|
3505
|
+
# The queues to be updated for this routing profile.
|
3506
|
+
# @return [Array<Types::RoutingProfileQueueConfig>]
|
3507
|
+
#
|
3508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueuesRequest AWS API Documentation
|
3509
|
+
#
|
3510
|
+
class UpdateRoutingProfileQueuesRequest < Struct.new(
|
3511
|
+
:instance_id,
|
3512
|
+
:routing_profile_id,
|
3513
|
+
:queue_configs)
|
3514
|
+
SENSITIVE = []
|
3515
|
+
include Aws::Structure
|
3516
|
+
end
|
3517
|
+
|
2392
3518
|
# @note When making an API call, you may pass UpdateUserHierarchyRequest
|
2393
3519
|
# data as a hash:
|
2394
3520
|
#
|
@@ -2728,5 +3854,26 @@ module Aws::Connect
|
|
2728
3854
|
include Aws::Structure
|
2729
3855
|
end
|
2730
3856
|
|
3857
|
+
# Contains information about the recording configuration settings.
|
3858
|
+
#
|
3859
|
+
# @note When making an API call, you may pass VoiceRecordingConfiguration
|
3860
|
+
# data as a hash:
|
3861
|
+
#
|
3862
|
+
# {
|
3863
|
+
# voice_recording_track: "FROM_AGENT", # accepts FROM_AGENT, TO_AGENT, ALL
|
3864
|
+
# }
|
3865
|
+
#
|
3866
|
+
# @!attribute [rw] voice_recording_track
|
3867
|
+
# Identifies which track is being recorded.
|
3868
|
+
# @return [String]
|
3869
|
+
#
|
3870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/VoiceRecordingConfiguration AWS API Documentation
|
3871
|
+
#
|
3872
|
+
class VoiceRecordingConfiguration < Struct.new(
|
3873
|
+
:voice_recording_track)
|
3874
|
+
SENSITIVE = []
|
3875
|
+
include Aws::Structure
|
3876
|
+
end
|
3877
|
+
|
2731
3878
|
end
|
2732
3879
|
end
|