aws-sdk-connectcases 1.0.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 +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-connectcases/client.rb +1885 -0
- data/lib/aws-sdk-connectcases/client_api.rb +1202 -0
- data/lib/aws-sdk-connectcases/customizations.rb +0 -0
- data/lib/aws-sdk-connectcases/errors.rb +173 -0
- data/lib/aws-sdk-connectcases/resource.rb +26 -0
- data/lib/aws-sdk-connectcases/types.rb +2844 -0
- data/lib/aws-sdk-connectcases.rb +53 -0
- metadata +90 -0
@@ -0,0 +1,2844 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ConnectCases
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Content specific to `BasicLayout` type. It configures fields in the
|
27
|
+
# top panel and More Info tab of agent application.
|
28
|
+
#
|
29
|
+
# @note When making an API call, you may pass BasicLayout
|
30
|
+
# data as a hash:
|
31
|
+
#
|
32
|
+
# {
|
33
|
+
# more_info: {
|
34
|
+
# sections: [
|
35
|
+
# {
|
36
|
+
# field_group: {
|
37
|
+
# fields: [ # required
|
38
|
+
# {
|
39
|
+
# id: "FieldId", # required
|
40
|
+
# },
|
41
|
+
# ],
|
42
|
+
# name: "FieldGroupNameString",
|
43
|
+
# },
|
44
|
+
# },
|
45
|
+
# ],
|
46
|
+
# },
|
47
|
+
# top_panel: {
|
48
|
+
# sections: [
|
49
|
+
# {
|
50
|
+
# field_group: {
|
51
|
+
# fields: [ # required
|
52
|
+
# {
|
53
|
+
# id: "FieldId", # required
|
54
|
+
# },
|
55
|
+
# ],
|
56
|
+
# name: "FieldGroupNameString",
|
57
|
+
# },
|
58
|
+
# },
|
59
|
+
# ],
|
60
|
+
# },
|
61
|
+
# }
|
62
|
+
#
|
63
|
+
# @!attribute [rw] more_info
|
64
|
+
# This represents sections in a tab of the page layout.
|
65
|
+
# @return [Types::LayoutSections]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] top_panel
|
68
|
+
# This represents sections in a panel of the page layout.
|
69
|
+
# @return [Types::LayoutSections]
|
70
|
+
#
|
71
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BasicLayout AWS API Documentation
|
72
|
+
#
|
73
|
+
class BasicLayout < Struct.new(
|
74
|
+
:more_info,
|
75
|
+
:top_panel)
|
76
|
+
SENSITIVE = []
|
77
|
+
include Aws::Structure
|
78
|
+
end
|
79
|
+
|
80
|
+
# @note When making an API call, you may pass BatchGetFieldRequest
|
81
|
+
# data as a hash:
|
82
|
+
#
|
83
|
+
# {
|
84
|
+
# domain_id: "DomainId", # required
|
85
|
+
# fields: [ # required
|
86
|
+
# {
|
87
|
+
# id: "FieldId", # required
|
88
|
+
# },
|
89
|
+
# ],
|
90
|
+
# }
|
91
|
+
#
|
92
|
+
# @!attribute [rw] domain_id
|
93
|
+
# The unique identifier of the Cases domain.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] fields
|
97
|
+
# A list of unique field identifiers.
|
98
|
+
# @return [Array<Types::FieldIdentifier>]
|
99
|
+
#
|
100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetFieldRequest AWS API Documentation
|
101
|
+
#
|
102
|
+
class BatchGetFieldRequest < Struct.new(
|
103
|
+
:domain_id,
|
104
|
+
:fields)
|
105
|
+
SENSITIVE = []
|
106
|
+
include Aws::Structure
|
107
|
+
end
|
108
|
+
|
109
|
+
# @!attribute [rw] errors
|
110
|
+
# A list of field errors.
|
111
|
+
# @return [Array<Types::FieldError>]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] fields
|
114
|
+
# A list of detailed field information.
|
115
|
+
# @return [Array<Types::GetFieldResponse>]
|
116
|
+
#
|
117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchGetFieldResponse AWS API Documentation
|
118
|
+
#
|
119
|
+
class BatchGetFieldResponse < Struct.new(
|
120
|
+
:errors,
|
121
|
+
:fields)
|
122
|
+
SENSITIVE = []
|
123
|
+
include Aws::Structure
|
124
|
+
end
|
125
|
+
|
126
|
+
# @note When making an API call, you may pass BatchPutFieldOptionsRequest
|
127
|
+
# data as a hash:
|
128
|
+
#
|
129
|
+
# {
|
130
|
+
# domain_id: "DomainId", # required
|
131
|
+
# field_id: "FieldId", # required
|
132
|
+
# options: [ # required
|
133
|
+
# {
|
134
|
+
# active: false, # required
|
135
|
+
# name: "FieldOptionName", # required
|
136
|
+
# value: "FieldOptionValue", # required
|
137
|
+
# },
|
138
|
+
# ],
|
139
|
+
# }
|
140
|
+
#
|
141
|
+
# @!attribute [rw] domain_id
|
142
|
+
# The unique identifier of the Cases domain.
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] field_id
|
146
|
+
# The unique identifier of a field.
|
147
|
+
# @return [String]
|
148
|
+
#
|
149
|
+
# @!attribute [rw] options
|
150
|
+
# A list of `FieldOption` objects.
|
151
|
+
# @return [Array<Types::FieldOption>]
|
152
|
+
#
|
153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchPutFieldOptionsRequest AWS API Documentation
|
154
|
+
#
|
155
|
+
class BatchPutFieldOptionsRequest < Struct.new(
|
156
|
+
:domain_id,
|
157
|
+
:field_id,
|
158
|
+
:options)
|
159
|
+
SENSITIVE = []
|
160
|
+
include Aws::Structure
|
161
|
+
end
|
162
|
+
|
163
|
+
# @!attribute [rw] errors
|
164
|
+
# A list of field errors.
|
165
|
+
# @return [Array<Types::FieldOptionError>]
|
166
|
+
#
|
167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/BatchPutFieldOptionsResponse AWS API Documentation
|
168
|
+
#
|
169
|
+
class BatchPutFieldOptionsResponse < Struct.new(
|
170
|
+
:errors)
|
171
|
+
SENSITIVE = []
|
172
|
+
include Aws::Structure
|
173
|
+
end
|
174
|
+
|
175
|
+
# Details of what case data is published through the case event stream.
|
176
|
+
#
|
177
|
+
# @note When making an API call, you may pass CaseEventIncludedData
|
178
|
+
# data as a hash:
|
179
|
+
#
|
180
|
+
# {
|
181
|
+
# fields: [ # required
|
182
|
+
# {
|
183
|
+
# id: "FieldId", # required
|
184
|
+
# },
|
185
|
+
# ],
|
186
|
+
# }
|
187
|
+
#
|
188
|
+
# @!attribute [rw] fields
|
189
|
+
# List of field identifiers.
|
190
|
+
# @return [Array<Types::FieldIdentifier>]
|
191
|
+
#
|
192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CaseEventIncludedData AWS API Documentation
|
193
|
+
#
|
194
|
+
class CaseEventIncludedData < Struct.new(
|
195
|
+
:fields)
|
196
|
+
SENSITIVE = []
|
197
|
+
include Aws::Structure
|
198
|
+
end
|
199
|
+
|
200
|
+
# A filter for cases. Only one value can be provided.
|
201
|
+
#
|
202
|
+
# @note CaseFilter is a union - when making an API calls you must set exactly one of the members.
|
203
|
+
#
|
204
|
+
# @!attribute [rw] and_all
|
205
|
+
# Provides "and all" filtering.
|
206
|
+
# @return [Array<Types::CaseFilter>]
|
207
|
+
#
|
208
|
+
# @!attribute [rw] field
|
209
|
+
# A list of fields to filter on.
|
210
|
+
# @return [Types::FieldFilter]
|
211
|
+
#
|
212
|
+
# @!attribute [rw] not
|
213
|
+
# A filter for cases. Only one value can be provided.
|
214
|
+
# @return [Types::CaseFilter]
|
215
|
+
#
|
216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CaseFilter AWS API Documentation
|
217
|
+
#
|
218
|
+
class CaseFilter < Struct.new(
|
219
|
+
:and_all,
|
220
|
+
:field,
|
221
|
+
:not,
|
222
|
+
:unknown)
|
223
|
+
SENSITIVE = []
|
224
|
+
include Aws::Structure
|
225
|
+
include Aws::Structure::Union
|
226
|
+
|
227
|
+
class AndAll < CaseFilter; end
|
228
|
+
class Field < CaseFilter; end
|
229
|
+
class Not < CaseFilter; end
|
230
|
+
class Unknown < CaseFilter; end
|
231
|
+
end
|
232
|
+
|
233
|
+
# Case summary information.
|
234
|
+
#
|
235
|
+
# @!attribute [rw] case_id
|
236
|
+
# A unique identifier of the case.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] template_id
|
240
|
+
# A unique identifier of a template.
|
241
|
+
# @return [String]
|
242
|
+
#
|
243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CaseSummary AWS API Documentation
|
244
|
+
#
|
245
|
+
class CaseSummary < Struct.new(
|
246
|
+
:case_id,
|
247
|
+
:template_id)
|
248
|
+
SENSITIVE = []
|
249
|
+
include Aws::Structure
|
250
|
+
end
|
251
|
+
|
252
|
+
# Represents the content of a `Comment` to be returned to agents.
|
253
|
+
#
|
254
|
+
# @note When making an API call, you may pass CommentContent
|
255
|
+
# data as a hash:
|
256
|
+
#
|
257
|
+
# {
|
258
|
+
# body: "CommentBody", # required
|
259
|
+
# content_type: "Text/Plain", # required, accepts Text/Plain
|
260
|
+
# }
|
261
|
+
#
|
262
|
+
# @!attribute [rw] body
|
263
|
+
# Text in the body of a `Comment` on a case.
|
264
|
+
# @return [String]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] content_type
|
267
|
+
# Type of the text in the box of a `Comment` on a case.
|
268
|
+
# @return [String]
|
269
|
+
#
|
270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CommentContent AWS API Documentation
|
271
|
+
#
|
272
|
+
class CommentContent < Struct.new(
|
273
|
+
:body,
|
274
|
+
:content_type)
|
275
|
+
SENSITIVE = []
|
276
|
+
include Aws::Structure
|
277
|
+
end
|
278
|
+
|
279
|
+
# A filter for related items of type `Comment`.
|
280
|
+
#
|
281
|
+
# @api private
|
282
|
+
#
|
283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CommentFilter AWS API Documentation
|
284
|
+
#
|
285
|
+
class CommentFilter < Aws::EmptyStructure; end
|
286
|
+
|
287
|
+
# The requested operation would cause a conflict with the current state
|
288
|
+
# of a service resource associated with the request. Resolve the
|
289
|
+
# conflict before retrying this request. See the accompanying error
|
290
|
+
# message for details.
|
291
|
+
#
|
292
|
+
# @!attribute [rw] message
|
293
|
+
# @return [String]
|
294
|
+
#
|
295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ConflictException AWS API Documentation
|
296
|
+
#
|
297
|
+
class ConflictException < Struct.new(
|
298
|
+
:message)
|
299
|
+
SENSITIVE = []
|
300
|
+
include Aws::Structure
|
301
|
+
end
|
302
|
+
|
303
|
+
# An object that represents an Amazon Connect contact object.
|
304
|
+
#
|
305
|
+
# @note When making an API call, you may pass Contact
|
306
|
+
# data as a hash:
|
307
|
+
#
|
308
|
+
# {
|
309
|
+
# contact_arn: "ContactArn", # required
|
310
|
+
# }
|
311
|
+
#
|
312
|
+
# @!attribute [rw] contact_arn
|
313
|
+
# A unique identifier of a contact in Amazon Connect.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/Contact AWS API Documentation
|
317
|
+
#
|
318
|
+
class Contact < Struct.new(
|
319
|
+
:contact_arn)
|
320
|
+
SENSITIVE = []
|
321
|
+
include Aws::Structure
|
322
|
+
end
|
323
|
+
|
324
|
+
# An object that represents a content of an Amazon Connect contact
|
325
|
+
# object.
|
326
|
+
#
|
327
|
+
# @!attribute [rw] channel
|
328
|
+
# A list of channels to filter on for related items of type `Contact`.
|
329
|
+
# @return [String]
|
330
|
+
#
|
331
|
+
# @!attribute [rw] connected_to_system_time
|
332
|
+
# The difference between the `InitiationTimestamp` and the
|
333
|
+
# `DisconnectTimestamp` of the contact.
|
334
|
+
# @return [Time]
|
335
|
+
#
|
336
|
+
# @!attribute [rw] contact_arn
|
337
|
+
# A unique identifier of a contact in Amazon Connect.
|
338
|
+
# @return [String]
|
339
|
+
#
|
340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ContactContent AWS API Documentation
|
341
|
+
#
|
342
|
+
class ContactContent < Struct.new(
|
343
|
+
:channel,
|
344
|
+
:connected_to_system_time,
|
345
|
+
:contact_arn)
|
346
|
+
SENSITIVE = []
|
347
|
+
include Aws::Structure
|
348
|
+
end
|
349
|
+
|
350
|
+
# A filter for related items of type `Contact`.
|
351
|
+
#
|
352
|
+
# @note When making an API call, you may pass ContactFilter
|
353
|
+
# data as a hash:
|
354
|
+
#
|
355
|
+
# {
|
356
|
+
# channel: ["Channel"],
|
357
|
+
# contact_arn: "ContactArn",
|
358
|
+
# }
|
359
|
+
#
|
360
|
+
# @!attribute [rw] channel
|
361
|
+
# A list of channels to filter on for related items of type `Contact`.
|
362
|
+
# @return [Array<String>]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] contact_arn
|
365
|
+
# A unique identifier of a contact in Amazon Connect.
|
366
|
+
# @return [String]
|
367
|
+
#
|
368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ContactFilter AWS API Documentation
|
369
|
+
#
|
370
|
+
class ContactFilter < Struct.new(
|
371
|
+
:channel,
|
372
|
+
:contact_arn)
|
373
|
+
SENSITIVE = []
|
374
|
+
include Aws::Structure
|
375
|
+
end
|
376
|
+
|
377
|
+
# @note When making an API call, you may pass CreateCaseRequest
|
378
|
+
# data as a hash:
|
379
|
+
#
|
380
|
+
# {
|
381
|
+
# client_token: "CreateCaseRequestClientTokenString",
|
382
|
+
# domain_id: "DomainId", # required
|
383
|
+
# fields: [ # required
|
384
|
+
# {
|
385
|
+
# id: "FieldId", # required
|
386
|
+
# value: { # required
|
387
|
+
# boolean_value: false,
|
388
|
+
# double_value: 1.0,
|
389
|
+
# string_value: "FieldValueUnionStringValueString",
|
390
|
+
# },
|
391
|
+
# },
|
392
|
+
# ],
|
393
|
+
# template_id: "TemplateId", # required
|
394
|
+
# }
|
395
|
+
#
|
396
|
+
# @!attribute [rw] client_token
|
397
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
398
|
+
# idempotency of the request.
|
399
|
+
#
|
400
|
+
# **A suitable default value is auto-generated.** You should normally
|
401
|
+
# not need to pass this option.
|
402
|
+
# @return [String]
|
403
|
+
#
|
404
|
+
# @!attribute [rw] domain_id
|
405
|
+
# The unique identifier of the Cases domain.
|
406
|
+
# @return [String]
|
407
|
+
#
|
408
|
+
# @!attribute [rw] fields
|
409
|
+
# An array of objects with field ID (matching
|
410
|
+
# ListFields/DescribeField) and value union data.
|
411
|
+
# @return [Array<Types::FieldValue>]
|
412
|
+
#
|
413
|
+
# @!attribute [rw] template_id
|
414
|
+
# A unique identifier of a template.
|
415
|
+
# @return [String]
|
416
|
+
#
|
417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateCaseRequest AWS API Documentation
|
418
|
+
#
|
419
|
+
class CreateCaseRequest < Struct.new(
|
420
|
+
:client_token,
|
421
|
+
:domain_id,
|
422
|
+
:fields,
|
423
|
+
:template_id)
|
424
|
+
SENSITIVE = []
|
425
|
+
include Aws::Structure
|
426
|
+
end
|
427
|
+
|
428
|
+
# @!attribute [rw] case_arn
|
429
|
+
# The Amazon Resource Name (ARN) of the case.
|
430
|
+
# @return [String]
|
431
|
+
#
|
432
|
+
# @!attribute [rw] case_id
|
433
|
+
# A unique identifier of the case.
|
434
|
+
# @return [String]
|
435
|
+
#
|
436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateCaseResponse AWS API Documentation
|
437
|
+
#
|
438
|
+
class CreateCaseResponse < Struct.new(
|
439
|
+
:case_arn,
|
440
|
+
:case_id)
|
441
|
+
SENSITIVE = []
|
442
|
+
include Aws::Structure
|
443
|
+
end
|
444
|
+
|
445
|
+
# @note When making an API call, you may pass CreateDomainRequest
|
446
|
+
# data as a hash:
|
447
|
+
#
|
448
|
+
# {
|
449
|
+
# name: "DomainName", # required
|
450
|
+
# }
|
451
|
+
#
|
452
|
+
# @!attribute [rw] name
|
453
|
+
# The name for your Cases domain. It must be unique for your Amazon
|
454
|
+
# Web Services account.
|
455
|
+
# @return [String]
|
456
|
+
#
|
457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateDomainRequest AWS API Documentation
|
458
|
+
#
|
459
|
+
class CreateDomainRequest < Struct.new(
|
460
|
+
:name)
|
461
|
+
SENSITIVE = []
|
462
|
+
include Aws::Structure
|
463
|
+
end
|
464
|
+
|
465
|
+
# @!attribute [rw] domain_arn
|
466
|
+
# The Amazon Resource Name (ARN) for the Cases domain.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @!attribute [rw] domain_id
|
470
|
+
# The unique identifier of the Cases domain.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] domain_status
|
474
|
+
# The status of the domain.
|
475
|
+
# @return [String]
|
476
|
+
#
|
477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateDomainResponse AWS API Documentation
|
478
|
+
#
|
479
|
+
class CreateDomainResponse < Struct.new(
|
480
|
+
:domain_arn,
|
481
|
+
:domain_id,
|
482
|
+
:domain_status)
|
483
|
+
SENSITIVE = []
|
484
|
+
include Aws::Structure
|
485
|
+
end
|
486
|
+
|
487
|
+
# @note When making an API call, you may pass CreateFieldRequest
|
488
|
+
# data as a hash:
|
489
|
+
#
|
490
|
+
# {
|
491
|
+
# description: "FieldDescription",
|
492
|
+
# domain_id: "DomainId", # required
|
493
|
+
# name: "FieldName", # required
|
494
|
+
# type: "Text", # required, accepts Text, Number, Boolean, DateTime, SingleSelect
|
495
|
+
# }
|
496
|
+
#
|
497
|
+
# @!attribute [rw] description
|
498
|
+
# The description of the field.
|
499
|
+
# @return [String]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] domain_id
|
502
|
+
# The unique identifier of the Cases domain.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] name
|
506
|
+
# The name of the field.
|
507
|
+
# @return [String]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] type
|
510
|
+
# Defines the data type, some system constraints, and default display
|
511
|
+
# of the field.
|
512
|
+
# @return [String]
|
513
|
+
#
|
514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateFieldRequest AWS API Documentation
|
515
|
+
#
|
516
|
+
class CreateFieldRequest < Struct.new(
|
517
|
+
:description,
|
518
|
+
:domain_id,
|
519
|
+
:name,
|
520
|
+
:type)
|
521
|
+
SENSITIVE = []
|
522
|
+
include Aws::Structure
|
523
|
+
end
|
524
|
+
|
525
|
+
# @!attribute [rw] field_arn
|
526
|
+
# The Amazon Resource Name (ARN) of the field.
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] field_id
|
530
|
+
# The unique identifier of a field.
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateFieldResponse AWS API Documentation
|
534
|
+
#
|
535
|
+
class CreateFieldResponse < Struct.new(
|
536
|
+
:field_arn,
|
537
|
+
:field_id)
|
538
|
+
SENSITIVE = []
|
539
|
+
include Aws::Structure
|
540
|
+
end
|
541
|
+
|
542
|
+
# @note When making an API call, you may pass CreateLayoutRequest
|
543
|
+
# data as a hash:
|
544
|
+
#
|
545
|
+
# {
|
546
|
+
# content: { # required
|
547
|
+
# basic: {
|
548
|
+
# more_info: {
|
549
|
+
# sections: [
|
550
|
+
# {
|
551
|
+
# field_group: {
|
552
|
+
# fields: [ # required
|
553
|
+
# {
|
554
|
+
# id: "FieldId", # required
|
555
|
+
# },
|
556
|
+
# ],
|
557
|
+
# name: "FieldGroupNameString",
|
558
|
+
# },
|
559
|
+
# },
|
560
|
+
# ],
|
561
|
+
# },
|
562
|
+
# top_panel: {
|
563
|
+
# sections: [
|
564
|
+
# {
|
565
|
+
# field_group: {
|
566
|
+
# fields: [ # required
|
567
|
+
# {
|
568
|
+
# id: "FieldId", # required
|
569
|
+
# },
|
570
|
+
# ],
|
571
|
+
# name: "FieldGroupNameString",
|
572
|
+
# },
|
573
|
+
# },
|
574
|
+
# ],
|
575
|
+
# },
|
576
|
+
# },
|
577
|
+
# },
|
578
|
+
# domain_id: "DomainId", # required
|
579
|
+
# name: "LayoutName", # required
|
580
|
+
# }
|
581
|
+
#
|
582
|
+
# @!attribute [rw] content
|
583
|
+
# Information about which fields will be present in the layout, and
|
584
|
+
# information about the order of the fields.
|
585
|
+
# @return [Types::LayoutContent]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] domain_id
|
588
|
+
# The unique identifier of the Cases domain.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] name
|
592
|
+
# The name of the layout. It must be unique for the Cases domain.
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateLayoutRequest AWS API Documentation
|
596
|
+
#
|
597
|
+
class CreateLayoutRequest < Struct.new(
|
598
|
+
:content,
|
599
|
+
:domain_id,
|
600
|
+
:name)
|
601
|
+
SENSITIVE = []
|
602
|
+
include Aws::Structure
|
603
|
+
end
|
604
|
+
|
605
|
+
# @!attribute [rw] layout_arn
|
606
|
+
# The Amazon Resource Name (ARN) of the newly created layout.
|
607
|
+
# @return [String]
|
608
|
+
#
|
609
|
+
# @!attribute [rw] layout_id
|
610
|
+
# The unique identifier of the layout.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateLayoutResponse AWS API Documentation
|
614
|
+
#
|
615
|
+
class CreateLayoutResponse < Struct.new(
|
616
|
+
:layout_arn,
|
617
|
+
:layout_id)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
622
|
+
# @note When making an API call, you may pass CreateRelatedItemRequest
|
623
|
+
# data as a hash:
|
624
|
+
#
|
625
|
+
# {
|
626
|
+
# case_id: "CaseId", # required
|
627
|
+
# content: { # required
|
628
|
+
# comment: {
|
629
|
+
# body: "CommentBody", # required
|
630
|
+
# content_type: "Text/Plain", # required, accepts Text/Plain
|
631
|
+
# },
|
632
|
+
# contact: {
|
633
|
+
# contact_arn: "ContactArn", # required
|
634
|
+
# },
|
635
|
+
# },
|
636
|
+
# domain_id: "DomainId", # required
|
637
|
+
# type: "Contact", # required, accepts Contact, Comment
|
638
|
+
# }
|
639
|
+
#
|
640
|
+
# @!attribute [rw] case_id
|
641
|
+
# A unique identifier of the case.
|
642
|
+
# @return [String]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] content
|
645
|
+
# The content of a related item to be created.
|
646
|
+
# @return [Types::RelatedItemInputContent]
|
647
|
+
#
|
648
|
+
# @!attribute [rw] domain_id
|
649
|
+
# The unique identifier of the Cases domain.
|
650
|
+
# @return [String]
|
651
|
+
#
|
652
|
+
# @!attribute [rw] type
|
653
|
+
# The type of a related item.
|
654
|
+
# @return [String]
|
655
|
+
#
|
656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateRelatedItemRequest AWS API Documentation
|
657
|
+
#
|
658
|
+
class CreateRelatedItemRequest < Struct.new(
|
659
|
+
:case_id,
|
660
|
+
:content,
|
661
|
+
:domain_id,
|
662
|
+
:type)
|
663
|
+
SENSITIVE = []
|
664
|
+
include Aws::Structure
|
665
|
+
end
|
666
|
+
|
667
|
+
# @!attribute [rw] related_item_arn
|
668
|
+
# The Amazon Resource Name (ARN) of the related item.
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] related_item_id
|
672
|
+
# The unique identifier of the related item.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateRelatedItemResponse AWS API Documentation
|
676
|
+
#
|
677
|
+
class CreateRelatedItemResponse < Struct.new(
|
678
|
+
:related_item_arn,
|
679
|
+
:related_item_id)
|
680
|
+
SENSITIVE = []
|
681
|
+
include Aws::Structure
|
682
|
+
end
|
683
|
+
|
684
|
+
# @note When making an API call, you may pass CreateTemplateRequest
|
685
|
+
# data as a hash:
|
686
|
+
#
|
687
|
+
# {
|
688
|
+
# description: "TemplateDescription",
|
689
|
+
# domain_id: "DomainId", # required
|
690
|
+
# layout_configuration: {
|
691
|
+
# default_layout: "LayoutId",
|
692
|
+
# },
|
693
|
+
# name: "TemplateName", # required
|
694
|
+
# required_fields: [
|
695
|
+
# {
|
696
|
+
# field_id: "FieldId", # required
|
697
|
+
# },
|
698
|
+
# ],
|
699
|
+
# }
|
700
|
+
#
|
701
|
+
# @!attribute [rw] description
|
702
|
+
# A brief description of the template.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] domain_id
|
706
|
+
# The unique identifier of the Cases domain.
|
707
|
+
# @return [String]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] layout_configuration
|
710
|
+
# Configuration of layouts associated to the template.
|
711
|
+
# @return [Types::LayoutConfiguration]
|
712
|
+
#
|
713
|
+
# @!attribute [rw] name
|
714
|
+
# A name for the template. It must be unique per domain.
|
715
|
+
# @return [String]
|
716
|
+
#
|
717
|
+
# @!attribute [rw] required_fields
|
718
|
+
# A list of fields that must contain a value for a case to be
|
719
|
+
# successfully created with this template.
|
720
|
+
# @return [Array<Types::RequiredField>]
|
721
|
+
#
|
722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateTemplateRequest AWS API Documentation
|
723
|
+
#
|
724
|
+
class CreateTemplateRequest < Struct.new(
|
725
|
+
:description,
|
726
|
+
:domain_id,
|
727
|
+
:layout_configuration,
|
728
|
+
:name,
|
729
|
+
:required_fields)
|
730
|
+
SENSITIVE = []
|
731
|
+
include Aws::Structure
|
732
|
+
end
|
733
|
+
|
734
|
+
# @!attribute [rw] template_arn
|
735
|
+
# The Amazon Resource Name (ARN) of the newly created template.
|
736
|
+
# @return [String]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] template_id
|
739
|
+
# A unique identifier of a template.
|
740
|
+
# @return [String]
|
741
|
+
#
|
742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateTemplateResponse AWS API Documentation
|
743
|
+
#
|
744
|
+
class CreateTemplateResponse < Struct.new(
|
745
|
+
:template_arn,
|
746
|
+
:template_id)
|
747
|
+
SENSITIVE = []
|
748
|
+
include Aws::Structure
|
749
|
+
end
|
750
|
+
|
751
|
+
# Object for the summarized details of the domain.
|
752
|
+
#
|
753
|
+
# @!attribute [rw] domain_arn
|
754
|
+
# The Amazon Resource Name (ARN) of the domain.
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] domain_id
|
758
|
+
# The unique identifier of the domain.
|
759
|
+
# @return [String]
|
760
|
+
#
|
761
|
+
# @!attribute [rw] name
|
762
|
+
# The name of the domain.
|
763
|
+
# @return [String]
|
764
|
+
#
|
765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/DomainSummary AWS API Documentation
|
766
|
+
#
|
767
|
+
class DomainSummary < Struct.new(
|
768
|
+
:domain_arn,
|
769
|
+
:domain_id,
|
770
|
+
:name)
|
771
|
+
SENSITIVE = []
|
772
|
+
include Aws::Structure
|
773
|
+
end
|
774
|
+
|
775
|
+
# Configuration to enable EventBridge case event delivery and determine
|
776
|
+
# what data is delivered.
|
777
|
+
#
|
778
|
+
# @note When making an API call, you may pass EventBridgeConfiguration
|
779
|
+
# data as a hash:
|
780
|
+
#
|
781
|
+
# {
|
782
|
+
# enabled: false, # required
|
783
|
+
# included_data: {
|
784
|
+
# case_data: {
|
785
|
+
# fields: [ # required
|
786
|
+
# {
|
787
|
+
# id: "FieldId", # required
|
788
|
+
# },
|
789
|
+
# ],
|
790
|
+
# },
|
791
|
+
# related_item_data: {
|
792
|
+
# include_content: false, # required
|
793
|
+
# },
|
794
|
+
# },
|
795
|
+
# }
|
796
|
+
#
|
797
|
+
# @!attribute [rw] enabled
|
798
|
+
# Indicates whether the to broadcast case event data to the customer.
|
799
|
+
# @return [Boolean]
|
800
|
+
#
|
801
|
+
# @!attribute [rw] included_data
|
802
|
+
# Details of what case and related item data is published through the
|
803
|
+
# case event stream.
|
804
|
+
# @return [Types::EventIncludedData]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/EventBridgeConfiguration AWS API Documentation
|
807
|
+
#
|
808
|
+
class EventBridgeConfiguration < Struct.new(
|
809
|
+
:enabled,
|
810
|
+
:included_data)
|
811
|
+
SENSITIVE = []
|
812
|
+
include Aws::Structure
|
813
|
+
end
|
814
|
+
|
815
|
+
# Details of what case and related item data is published through the
|
816
|
+
# case event stream.
|
817
|
+
#
|
818
|
+
# @note When making an API call, you may pass EventIncludedData
|
819
|
+
# data as a hash:
|
820
|
+
#
|
821
|
+
# {
|
822
|
+
# case_data: {
|
823
|
+
# fields: [ # required
|
824
|
+
# {
|
825
|
+
# id: "FieldId", # required
|
826
|
+
# },
|
827
|
+
# ],
|
828
|
+
# },
|
829
|
+
# related_item_data: {
|
830
|
+
# include_content: false, # required
|
831
|
+
# },
|
832
|
+
# }
|
833
|
+
#
|
834
|
+
# @!attribute [rw] case_data
|
835
|
+
# Details of what case data is published through the case event
|
836
|
+
# stream.
|
837
|
+
# @return [Types::CaseEventIncludedData]
|
838
|
+
#
|
839
|
+
# @!attribute [rw] related_item_data
|
840
|
+
# Details of what related item data is published through the case
|
841
|
+
# event stream.
|
842
|
+
# @return [Types::RelatedItemEventIncludedData]
|
843
|
+
#
|
844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/EventIncludedData AWS API Documentation
|
845
|
+
#
|
846
|
+
class EventIncludedData < Struct.new(
|
847
|
+
:case_data,
|
848
|
+
:related_item_data)
|
849
|
+
SENSITIVE = []
|
850
|
+
include Aws::Structure
|
851
|
+
end
|
852
|
+
|
853
|
+
# Object for errors on fields.
|
854
|
+
#
|
855
|
+
# @!attribute [rw] error_code
|
856
|
+
# The error code from getting a field.
|
857
|
+
# @return [String]
|
858
|
+
#
|
859
|
+
# @!attribute [rw] id
|
860
|
+
# The field identifier that caused the error.
|
861
|
+
# @return [String]
|
862
|
+
#
|
863
|
+
# @!attribute [rw] message
|
864
|
+
# The error message from getting a field.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldError AWS API Documentation
|
868
|
+
#
|
869
|
+
class FieldError < Struct.new(
|
870
|
+
:error_code,
|
871
|
+
:id,
|
872
|
+
:message)
|
873
|
+
SENSITIVE = []
|
874
|
+
include Aws::Structure
|
875
|
+
end
|
876
|
+
|
877
|
+
# A filter for fields. Only one value can be provided.
|
878
|
+
#
|
879
|
+
# @note FieldFilter is a union - when making an API calls you must set exactly one of the members.
|
880
|
+
#
|
881
|
+
# @!attribute [rw] contains
|
882
|
+
# Object containing field identifier and value information.
|
883
|
+
# @return [Types::FieldValue]
|
884
|
+
#
|
885
|
+
# @!attribute [rw] equal_to
|
886
|
+
# Object containing field identifier and value information.
|
887
|
+
# @return [Types::FieldValue]
|
888
|
+
#
|
889
|
+
# @!attribute [rw] greater_than
|
890
|
+
# Object containing field identifier and value information.
|
891
|
+
# @return [Types::FieldValue]
|
892
|
+
#
|
893
|
+
# @!attribute [rw] greater_than_or_equal_to
|
894
|
+
# Object containing field identifier and value information.
|
895
|
+
# @return [Types::FieldValue]
|
896
|
+
#
|
897
|
+
# @!attribute [rw] less_than
|
898
|
+
# Object containing field identifier and value information.
|
899
|
+
# @return [Types::FieldValue]
|
900
|
+
#
|
901
|
+
# @!attribute [rw] less_than_or_equal_to
|
902
|
+
# Object containing field identifier and value information.
|
903
|
+
# @return [Types::FieldValue]
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldFilter AWS API Documentation
|
906
|
+
#
|
907
|
+
class FieldFilter < Struct.new(
|
908
|
+
:contains,
|
909
|
+
:equal_to,
|
910
|
+
:greater_than,
|
911
|
+
:greater_than_or_equal_to,
|
912
|
+
:less_than,
|
913
|
+
:less_than_or_equal_to,
|
914
|
+
:unknown)
|
915
|
+
SENSITIVE = []
|
916
|
+
include Aws::Structure
|
917
|
+
include Aws::Structure::Union
|
918
|
+
|
919
|
+
class Contains < FieldFilter; end
|
920
|
+
class EqualTo < FieldFilter; end
|
921
|
+
class GreaterThan < FieldFilter; end
|
922
|
+
class GreaterThanOrEqualTo < FieldFilter; end
|
923
|
+
class LessThan < FieldFilter; end
|
924
|
+
class LessThanOrEqualTo < FieldFilter; end
|
925
|
+
class Unknown < FieldFilter; end
|
926
|
+
end
|
927
|
+
|
928
|
+
# Object for a group of fields and associated properties.
|
929
|
+
#
|
930
|
+
# @note When making an API call, you may pass FieldGroup
|
931
|
+
# data as a hash:
|
932
|
+
#
|
933
|
+
# {
|
934
|
+
# fields: [ # required
|
935
|
+
# {
|
936
|
+
# id: "FieldId", # required
|
937
|
+
# },
|
938
|
+
# ],
|
939
|
+
# name: "FieldGroupNameString",
|
940
|
+
# }
|
941
|
+
#
|
942
|
+
# @!attribute [rw] fields
|
943
|
+
# Represents an ordered list containing field related information.
|
944
|
+
# @return [Array<Types::FieldItem>]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] name
|
947
|
+
# Name of the field group.
|
948
|
+
# @return [String]
|
949
|
+
#
|
950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldGroup AWS API Documentation
|
951
|
+
#
|
952
|
+
class FieldGroup < Struct.new(
|
953
|
+
:fields,
|
954
|
+
:name)
|
955
|
+
SENSITIVE = []
|
956
|
+
include Aws::Structure
|
957
|
+
end
|
958
|
+
|
959
|
+
# Object for unique identifier of a field.
|
960
|
+
#
|
961
|
+
# @note When making an API call, you may pass FieldIdentifier
|
962
|
+
# data as a hash:
|
963
|
+
#
|
964
|
+
# {
|
965
|
+
# id: "FieldId", # required
|
966
|
+
# }
|
967
|
+
#
|
968
|
+
# @!attribute [rw] id
|
969
|
+
# Unique identifier of a field.
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldIdentifier AWS API Documentation
|
973
|
+
#
|
974
|
+
class FieldIdentifier < Struct.new(
|
975
|
+
:id)
|
976
|
+
SENSITIVE = []
|
977
|
+
include Aws::Structure
|
978
|
+
end
|
979
|
+
|
980
|
+
# Object for field related information.
|
981
|
+
#
|
982
|
+
# @note When making an API call, you may pass FieldItem
|
983
|
+
# data as a hash:
|
984
|
+
#
|
985
|
+
# {
|
986
|
+
# id: "FieldId", # required
|
987
|
+
# }
|
988
|
+
#
|
989
|
+
# @!attribute [rw] id
|
990
|
+
# Unique identifier of a field.
|
991
|
+
# @return [String]
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldItem AWS API Documentation
|
994
|
+
#
|
995
|
+
class FieldItem < Struct.new(
|
996
|
+
:id)
|
997
|
+
SENSITIVE = []
|
998
|
+
include Aws::Structure
|
999
|
+
end
|
1000
|
+
|
1001
|
+
# Object for field Options information.
|
1002
|
+
#
|
1003
|
+
# @note When making an API call, you may pass FieldOption
|
1004
|
+
# data as a hash:
|
1005
|
+
#
|
1006
|
+
# {
|
1007
|
+
# active: false, # required
|
1008
|
+
# name: "FieldOptionName", # required
|
1009
|
+
# value: "FieldOptionValue", # required
|
1010
|
+
# }
|
1011
|
+
#
|
1012
|
+
# @!attribute [rw] active
|
1013
|
+
# Describes whether the `FieldOption` is active (displayed) or
|
1014
|
+
# inactive.
|
1015
|
+
# @return [Boolean]
|
1016
|
+
#
|
1017
|
+
# @!attribute [rw] name
|
1018
|
+
# `FieldOptionName` has max length 100 and disallows trailing spaces.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] value
|
1022
|
+
# `FieldOptionValue` has max length 100 and must be alphanumeric with
|
1023
|
+
# hyphens and underscores.
|
1024
|
+
# @return [String]
|
1025
|
+
#
|
1026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldOption AWS API Documentation
|
1027
|
+
#
|
1028
|
+
class FieldOption < Struct.new(
|
1029
|
+
:active,
|
1030
|
+
:name,
|
1031
|
+
:value)
|
1032
|
+
SENSITIVE = []
|
1033
|
+
include Aws::Structure
|
1034
|
+
end
|
1035
|
+
|
1036
|
+
# Object for field Options errors.
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] error_code
|
1039
|
+
# Error code from creating or updating field option.
|
1040
|
+
# @return [String]
|
1041
|
+
#
|
1042
|
+
# @!attribute [rw] message
|
1043
|
+
# Error message from creating or updating field option.
|
1044
|
+
# @return [String]
|
1045
|
+
#
|
1046
|
+
# @!attribute [rw] value
|
1047
|
+
# The field option value that caused the error.
|
1048
|
+
# @return [String]
|
1049
|
+
#
|
1050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldOptionError AWS API Documentation
|
1051
|
+
#
|
1052
|
+
class FieldOptionError < Struct.new(
|
1053
|
+
:error_code,
|
1054
|
+
:message,
|
1055
|
+
:value)
|
1056
|
+
SENSITIVE = []
|
1057
|
+
include Aws::Structure
|
1058
|
+
end
|
1059
|
+
|
1060
|
+
# Object for the summarized details of the field.
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] field_arn
|
1063
|
+
# The Amazon Resource Name (ARN) of the field.
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] field_id
|
1067
|
+
# The unique identifier of a field.
|
1068
|
+
# @return [String]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] name
|
1071
|
+
# Name of the field.
|
1072
|
+
# @return [String]
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] namespace
|
1075
|
+
# The namespace of a field.
|
1076
|
+
# @return [String]
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] type
|
1079
|
+
# The type of a field.
|
1080
|
+
# @return [String]
|
1081
|
+
#
|
1082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldSummary AWS API Documentation
|
1083
|
+
#
|
1084
|
+
class FieldSummary < Struct.new(
|
1085
|
+
:field_arn,
|
1086
|
+
:field_id,
|
1087
|
+
:name,
|
1088
|
+
:namespace,
|
1089
|
+
:type)
|
1090
|
+
SENSITIVE = []
|
1091
|
+
include Aws::Structure
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
# Object for case field values.
|
1095
|
+
#
|
1096
|
+
# @note When making an API call, you may pass FieldValue
|
1097
|
+
# data as a hash:
|
1098
|
+
#
|
1099
|
+
# {
|
1100
|
+
# id: "FieldId", # required
|
1101
|
+
# value: { # required
|
1102
|
+
# boolean_value: false,
|
1103
|
+
# double_value: 1.0,
|
1104
|
+
# string_value: "FieldValueUnionStringValueString",
|
1105
|
+
# },
|
1106
|
+
# }
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] id
|
1109
|
+
# Unique identifier of a field.
|
1110
|
+
# @return [String]
|
1111
|
+
#
|
1112
|
+
# @!attribute [rw] value
|
1113
|
+
# Union of potential field value types.
|
1114
|
+
# @return [Types::FieldValueUnion]
|
1115
|
+
#
|
1116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldValue AWS API Documentation
|
1117
|
+
#
|
1118
|
+
class FieldValue < Struct.new(
|
1119
|
+
:id,
|
1120
|
+
:value)
|
1121
|
+
SENSITIVE = []
|
1122
|
+
include Aws::Structure
|
1123
|
+
end
|
1124
|
+
|
1125
|
+
# Object to store union of Field values.
|
1126
|
+
#
|
1127
|
+
# @note FieldValueUnion is a union - when making an API calls you must set exactly one of the members.
|
1128
|
+
#
|
1129
|
+
# @note FieldValueUnion is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FieldValueUnion corresponding to the set member.
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] boolean_value
|
1132
|
+
# Can be either null, or have a Boolean value type. Only one value can
|
1133
|
+
# be provided.
|
1134
|
+
# @return [Boolean]
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] double_value
|
1137
|
+
# Can be either null, or have a Double number value type. Only one
|
1138
|
+
# value can be provided.
|
1139
|
+
# @return [Float]
|
1140
|
+
#
|
1141
|
+
# @!attribute [rw] string_value
|
1142
|
+
# String value type.
|
1143
|
+
# @return [String]
|
1144
|
+
#
|
1145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/FieldValueUnion AWS API Documentation
|
1146
|
+
#
|
1147
|
+
class FieldValueUnion < Struct.new(
|
1148
|
+
:boolean_value,
|
1149
|
+
:double_value,
|
1150
|
+
:string_value,
|
1151
|
+
:unknown)
|
1152
|
+
SENSITIVE = []
|
1153
|
+
include Aws::Structure
|
1154
|
+
include Aws::Structure::Union
|
1155
|
+
|
1156
|
+
class BooleanValue < FieldValueUnion; end
|
1157
|
+
class DoubleValue < FieldValueUnion; end
|
1158
|
+
class StringValue < FieldValueUnion; end
|
1159
|
+
class Unknown < FieldValueUnion; end
|
1160
|
+
end
|
1161
|
+
|
1162
|
+
# @note When making an API call, you may pass GetCaseEventConfigurationRequest
|
1163
|
+
# data as a hash:
|
1164
|
+
#
|
1165
|
+
# {
|
1166
|
+
# domain_id: "DomainId", # required
|
1167
|
+
# }
|
1168
|
+
#
|
1169
|
+
# @!attribute [rw] domain_id
|
1170
|
+
# The unique identifier of the Cases domain.
|
1171
|
+
# @return [String]
|
1172
|
+
#
|
1173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseEventConfigurationRequest AWS API Documentation
|
1174
|
+
#
|
1175
|
+
class GetCaseEventConfigurationRequest < Struct.new(
|
1176
|
+
:domain_id)
|
1177
|
+
SENSITIVE = []
|
1178
|
+
include Aws::Structure
|
1179
|
+
end
|
1180
|
+
|
1181
|
+
# @!attribute [rw] event_bridge
|
1182
|
+
# Configuration to enable EventBridge case event delivery and
|
1183
|
+
# determine what data is delivered.
|
1184
|
+
# @return [Types::EventBridgeConfiguration]
|
1185
|
+
#
|
1186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseEventConfigurationResponse AWS API Documentation
|
1187
|
+
#
|
1188
|
+
class GetCaseEventConfigurationResponse < Struct.new(
|
1189
|
+
:event_bridge)
|
1190
|
+
SENSITIVE = []
|
1191
|
+
include Aws::Structure
|
1192
|
+
end
|
1193
|
+
|
1194
|
+
# @note When making an API call, you may pass GetCaseRequest
|
1195
|
+
# data as a hash:
|
1196
|
+
#
|
1197
|
+
# {
|
1198
|
+
# case_id: "CaseId", # required
|
1199
|
+
# domain_id: "DomainId", # required
|
1200
|
+
# fields: [ # required
|
1201
|
+
# {
|
1202
|
+
# id: "FieldId", # required
|
1203
|
+
# },
|
1204
|
+
# ],
|
1205
|
+
# next_token: "NextToken",
|
1206
|
+
# }
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] case_id
|
1209
|
+
# A unique identifier of the case.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @!attribute [rw] domain_id
|
1213
|
+
# The unique identifier of the Cases domain.
|
1214
|
+
# @return [String]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] fields
|
1217
|
+
# A list of unique field identifiers.
|
1218
|
+
# @return [Array<Types::FieldIdentifier>]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] next_token
|
1221
|
+
# The token for the next set of results. Use the value returned in the
|
1222
|
+
# previous response in the next request to retrieve the next set of
|
1223
|
+
# results.
|
1224
|
+
# @return [String]
|
1225
|
+
#
|
1226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseRequest AWS API Documentation
|
1227
|
+
#
|
1228
|
+
class GetCaseRequest < Struct.new(
|
1229
|
+
:case_id,
|
1230
|
+
:domain_id,
|
1231
|
+
:fields,
|
1232
|
+
:next_token)
|
1233
|
+
SENSITIVE = []
|
1234
|
+
include Aws::Structure
|
1235
|
+
end
|
1236
|
+
|
1237
|
+
# @!attribute [rw] fields
|
1238
|
+
# A list of detailed field information.
|
1239
|
+
# @return [Array<Types::FieldValue>]
|
1240
|
+
#
|
1241
|
+
# @!attribute [rw] next_token
|
1242
|
+
# The token for the next set of results. This is null if there are no
|
1243
|
+
# more results to return.
|
1244
|
+
# @return [String]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] tags
|
1247
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
1248
|
+
# are used to organize, track, or control access for this resource.
|
1249
|
+
# @return [Hash<String,String>]
|
1250
|
+
#
|
1251
|
+
# @!attribute [rw] template_id
|
1252
|
+
# A unique identifier of a template.
|
1253
|
+
# @return [String]
|
1254
|
+
#
|
1255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetCaseResponse AWS API Documentation
|
1256
|
+
#
|
1257
|
+
class GetCaseResponse < Struct.new(
|
1258
|
+
:fields,
|
1259
|
+
:next_token,
|
1260
|
+
:tags,
|
1261
|
+
:template_id)
|
1262
|
+
SENSITIVE = []
|
1263
|
+
include Aws::Structure
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
# @note When making an API call, you may pass GetDomainRequest
|
1267
|
+
# data as a hash:
|
1268
|
+
#
|
1269
|
+
# {
|
1270
|
+
# domain_id: "DomainId", # required
|
1271
|
+
# }
|
1272
|
+
#
|
1273
|
+
# @!attribute [rw] domain_id
|
1274
|
+
# The unique identifier of the Cases domain.
|
1275
|
+
# @return [String]
|
1276
|
+
#
|
1277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetDomainRequest AWS API Documentation
|
1278
|
+
#
|
1279
|
+
class GetDomainRequest < Struct.new(
|
1280
|
+
:domain_id)
|
1281
|
+
SENSITIVE = []
|
1282
|
+
include Aws::Structure
|
1283
|
+
end
|
1284
|
+
|
1285
|
+
# @!attribute [rw] created_time
|
1286
|
+
# The timestamp when the Cases domain was created.
|
1287
|
+
# @return [Time]
|
1288
|
+
#
|
1289
|
+
# @!attribute [rw] domain_arn
|
1290
|
+
# The Amazon Resource Name (ARN) for the Cases domain.
|
1291
|
+
# @return [String]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] domain_id
|
1294
|
+
# The unique identifier of the Cases domain.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] domain_status
|
1298
|
+
# The status of the Cases domain.
|
1299
|
+
# @return [String]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] name
|
1302
|
+
# The name of the Cases domain.
|
1303
|
+
# @return [String]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] tags
|
1306
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
1307
|
+
# are used to organize, track, or control access for this resource.
|
1308
|
+
# @return [Hash<String,String>]
|
1309
|
+
#
|
1310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetDomainResponse AWS API Documentation
|
1311
|
+
#
|
1312
|
+
class GetDomainResponse < Struct.new(
|
1313
|
+
:created_time,
|
1314
|
+
:domain_arn,
|
1315
|
+
:domain_id,
|
1316
|
+
:domain_status,
|
1317
|
+
:name,
|
1318
|
+
:tags)
|
1319
|
+
SENSITIVE = []
|
1320
|
+
include Aws::Structure
|
1321
|
+
end
|
1322
|
+
|
1323
|
+
# Object to store detailed field information.
|
1324
|
+
#
|
1325
|
+
# @!attribute [rw] description
|
1326
|
+
# Description of the field.
|
1327
|
+
# @return [String]
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] field_arn
|
1330
|
+
# The Amazon Resource Name (ARN) of the field.
|
1331
|
+
# @return [String]
|
1332
|
+
#
|
1333
|
+
# @!attribute [rw] field_id
|
1334
|
+
# Unique identifier of the field.
|
1335
|
+
# @return [String]
|
1336
|
+
#
|
1337
|
+
# @!attribute [rw] name
|
1338
|
+
# Name of the field.
|
1339
|
+
# @return [String]
|
1340
|
+
#
|
1341
|
+
# @!attribute [rw] namespace
|
1342
|
+
# Namespace of the field.
|
1343
|
+
# @return [String]
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] tags
|
1346
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
1347
|
+
# are used to organize, track, or control access for this resource.
|
1348
|
+
# @return [Hash<String,String>]
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] type
|
1351
|
+
# Type of the field.
|
1352
|
+
# @return [String]
|
1353
|
+
#
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetFieldResponse AWS API Documentation
|
1355
|
+
#
|
1356
|
+
class GetFieldResponse < Struct.new(
|
1357
|
+
:description,
|
1358
|
+
:field_arn,
|
1359
|
+
:field_id,
|
1360
|
+
:name,
|
1361
|
+
:namespace,
|
1362
|
+
:tags,
|
1363
|
+
:type)
|
1364
|
+
SENSITIVE = []
|
1365
|
+
include Aws::Structure
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# @note When making an API call, you may pass GetLayoutRequest
|
1369
|
+
# data as a hash:
|
1370
|
+
#
|
1371
|
+
# {
|
1372
|
+
# domain_id: "DomainId", # required
|
1373
|
+
# layout_id: "LayoutId", # required
|
1374
|
+
# }
|
1375
|
+
#
|
1376
|
+
# @!attribute [rw] domain_id
|
1377
|
+
# The unique identifier of the Cases domain.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] layout_id
|
1381
|
+
# The unique identifier of the layout.
|
1382
|
+
# @return [String]
|
1383
|
+
#
|
1384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetLayoutRequest AWS API Documentation
|
1385
|
+
#
|
1386
|
+
class GetLayoutRequest < Struct.new(
|
1387
|
+
:domain_id,
|
1388
|
+
:layout_id)
|
1389
|
+
SENSITIVE = []
|
1390
|
+
include Aws::Structure
|
1391
|
+
end
|
1392
|
+
|
1393
|
+
# @!attribute [rw] content
|
1394
|
+
# Information about which fields will be present in the layout, the
|
1395
|
+
# order of the fields, and read-only attribute of the field.
|
1396
|
+
# @return [Types::LayoutContent]
|
1397
|
+
#
|
1398
|
+
# @!attribute [rw] layout_arn
|
1399
|
+
# The Amazon Resource Name (ARN) of the newly created layout.
|
1400
|
+
# @return [String]
|
1401
|
+
#
|
1402
|
+
# @!attribute [rw] layout_id
|
1403
|
+
# The unique identifier of the layout.
|
1404
|
+
# @return [String]
|
1405
|
+
#
|
1406
|
+
# @!attribute [rw] name
|
1407
|
+
# The name of the layout. It must be unique.
|
1408
|
+
# @return [String]
|
1409
|
+
#
|
1410
|
+
# @!attribute [rw] tags
|
1411
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
1412
|
+
# are used to organize, track, or control access for this resource.
|
1413
|
+
# @return [Hash<String,String>]
|
1414
|
+
#
|
1415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetLayoutResponse AWS API Documentation
|
1416
|
+
#
|
1417
|
+
class GetLayoutResponse < Struct.new(
|
1418
|
+
:content,
|
1419
|
+
:layout_arn,
|
1420
|
+
:layout_id,
|
1421
|
+
:name,
|
1422
|
+
:tags)
|
1423
|
+
SENSITIVE = []
|
1424
|
+
include Aws::Structure
|
1425
|
+
end
|
1426
|
+
|
1427
|
+
# @note When making an API call, you may pass GetTemplateRequest
|
1428
|
+
# data as a hash:
|
1429
|
+
#
|
1430
|
+
# {
|
1431
|
+
# domain_id: "DomainId", # required
|
1432
|
+
# template_id: "TemplateId", # required
|
1433
|
+
# }
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] domain_id
|
1436
|
+
# The unique identifier of the Cases domain.
|
1437
|
+
# @return [String]
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] template_id
|
1440
|
+
# A unique identifier of a template.
|
1441
|
+
# @return [String]
|
1442
|
+
#
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetTemplateRequest AWS API Documentation
|
1444
|
+
#
|
1445
|
+
class GetTemplateRequest < Struct.new(
|
1446
|
+
:domain_id,
|
1447
|
+
:template_id)
|
1448
|
+
SENSITIVE = []
|
1449
|
+
include Aws::Structure
|
1450
|
+
end
|
1451
|
+
|
1452
|
+
# @!attribute [rw] description
|
1453
|
+
# A brief description of the template.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] layout_configuration
|
1457
|
+
# Configuration of layouts associated to the template.
|
1458
|
+
# @return [Types::LayoutConfiguration]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] name
|
1461
|
+
# The name of the template.
|
1462
|
+
# @return [String]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] required_fields
|
1465
|
+
# A list of fields that must contain a value for a case to be
|
1466
|
+
# successfully created with this template.
|
1467
|
+
# @return [Array<Types::RequiredField>]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] tags
|
1470
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
1471
|
+
# are used to organize, track, or control access for this resource.
|
1472
|
+
# @return [Hash<String,String>]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] template_arn
|
1475
|
+
# The Amazon Resource Name (ARN) of the template.
|
1476
|
+
# @return [String]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] template_id
|
1479
|
+
# A unique identifier of a template.
|
1480
|
+
# @return [String]
|
1481
|
+
#
|
1482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetTemplateResponse AWS API Documentation
|
1483
|
+
#
|
1484
|
+
class GetTemplateResponse < Struct.new(
|
1485
|
+
:description,
|
1486
|
+
:layout_configuration,
|
1487
|
+
:name,
|
1488
|
+
:required_fields,
|
1489
|
+
:tags,
|
1490
|
+
:template_arn,
|
1491
|
+
:template_id)
|
1492
|
+
SENSITIVE = []
|
1493
|
+
include Aws::Structure
|
1494
|
+
end
|
1495
|
+
|
1496
|
+
# We couldn't process your request because of an issue with the server.
|
1497
|
+
# Try again later.
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] message
|
1500
|
+
# @return [String]
|
1501
|
+
#
|
1502
|
+
# @!attribute [rw] retry_after_seconds
|
1503
|
+
# Advice to clients on when the call can be safely retried.
|
1504
|
+
# @return [Integer]
|
1505
|
+
#
|
1506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/InternalServerException AWS API Documentation
|
1507
|
+
#
|
1508
|
+
class InternalServerException < Struct.new(
|
1509
|
+
:message,
|
1510
|
+
:retry_after_seconds)
|
1511
|
+
SENSITIVE = []
|
1512
|
+
include Aws::Structure
|
1513
|
+
end
|
1514
|
+
|
1515
|
+
# Object to store configuration of layouts associated to the template.
|
1516
|
+
#
|
1517
|
+
# @note When making an API call, you may pass LayoutConfiguration
|
1518
|
+
# data as a hash:
|
1519
|
+
#
|
1520
|
+
# {
|
1521
|
+
# default_layout: "LayoutId",
|
1522
|
+
# }
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] default_layout
|
1525
|
+
# Unique identifier of a layout.
|
1526
|
+
# @return [String]
|
1527
|
+
#
|
1528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/LayoutConfiguration AWS API Documentation
|
1529
|
+
#
|
1530
|
+
class LayoutConfiguration < Struct.new(
|
1531
|
+
:default_layout)
|
1532
|
+
SENSITIVE = []
|
1533
|
+
include Aws::Structure
|
1534
|
+
end
|
1535
|
+
|
1536
|
+
# Object to store union of different versions of layout content.
|
1537
|
+
#
|
1538
|
+
# @note LayoutContent is a union - when making an API calls you must set exactly one of the members.
|
1539
|
+
#
|
1540
|
+
# @note LayoutContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of LayoutContent corresponding to the set member.
|
1541
|
+
#
|
1542
|
+
# @!attribute [rw] basic
|
1543
|
+
# Content specific to `BasicLayout` type. It configures fields in the
|
1544
|
+
# top panel and More Info tab of Cases user interface.
|
1545
|
+
# @return [Types::BasicLayout]
|
1546
|
+
#
|
1547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/LayoutContent AWS API Documentation
|
1548
|
+
#
|
1549
|
+
class LayoutContent < Struct.new(
|
1550
|
+
:basic,
|
1551
|
+
:unknown)
|
1552
|
+
SENSITIVE = []
|
1553
|
+
include Aws::Structure
|
1554
|
+
include Aws::Structure::Union
|
1555
|
+
|
1556
|
+
class Basic < LayoutContent; end
|
1557
|
+
class Unknown < LayoutContent; end
|
1558
|
+
end
|
1559
|
+
|
1560
|
+
# Ordered list containing different kinds of sections that can be added.
|
1561
|
+
# A LayoutSections object can only contain one section.
|
1562
|
+
#
|
1563
|
+
# @note When making an API call, you may pass LayoutSections
|
1564
|
+
# data as a hash:
|
1565
|
+
#
|
1566
|
+
# {
|
1567
|
+
# sections: [
|
1568
|
+
# {
|
1569
|
+
# field_group: {
|
1570
|
+
# fields: [ # required
|
1571
|
+
# {
|
1572
|
+
# id: "FieldId", # required
|
1573
|
+
# },
|
1574
|
+
# ],
|
1575
|
+
# name: "FieldGroupNameString",
|
1576
|
+
# },
|
1577
|
+
# },
|
1578
|
+
# ],
|
1579
|
+
# }
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] sections
|
1582
|
+
# Ordered list containing different kinds of sections that can be
|
1583
|
+
# added.
|
1584
|
+
# @return [Array<Types::Section>]
|
1585
|
+
#
|
1586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/LayoutSections AWS API Documentation
|
1587
|
+
#
|
1588
|
+
class LayoutSections < Struct.new(
|
1589
|
+
:sections)
|
1590
|
+
SENSITIVE = []
|
1591
|
+
include Aws::Structure
|
1592
|
+
end
|
1593
|
+
|
1594
|
+
# Object for the summarized details of the layout.
|
1595
|
+
#
|
1596
|
+
# @!attribute [rw] layout_arn
|
1597
|
+
# The Amazon Resource Name (ARN) of the layout.
|
1598
|
+
# @return [String]
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] layout_id
|
1601
|
+
# The unique identifier for of the layout.
|
1602
|
+
# @return [String]
|
1603
|
+
#
|
1604
|
+
# @!attribute [rw] name
|
1605
|
+
# The name of the layout.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/LayoutSummary AWS API Documentation
|
1609
|
+
#
|
1610
|
+
class LayoutSummary < Struct.new(
|
1611
|
+
:layout_arn,
|
1612
|
+
:layout_id,
|
1613
|
+
:name)
|
1614
|
+
SENSITIVE = []
|
1615
|
+
include Aws::Structure
|
1616
|
+
end
|
1617
|
+
|
1618
|
+
# @note When making an API call, you may pass ListCasesForContactRequest
|
1619
|
+
# data as a hash:
|
1620
|
+
#
|
1621
|
+
# {
|
1622
|
+
# contact_arn: "ContactArn", # required
|
1623
|
+
# domain_id: "DomainId", # required
|
1624
|
+
# max_results: 1,
|
1625
|
+
# next_token: "NextToken",
|
1626
|
+
# }
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] contact_arn
|
1629
|
+
# A unique identifier of a contact in Amazon Connect.
|
1630
|
+
# @return [String]
|
1631
|
+
#
|
1632
|
+
# @!attribute [rw] domain_id
|
1633
|
+
# The unique identifier of the Cases domain.
|
1634
|
+
# @return [String]
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] max_results
|
1637
|
+
# The maximum number of results to return per page.
|
1638
|
+
# @return [Integer]
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] next_token
|
1641
|
+
# The token for the next set of results. Use the value returned in the
|
1642
|
+
# previous response in the next request to retrieve the next set of
|
1643
|
+
# results.
|
1644
|
+
# @return [String]
|
1645
|
+
#
|
1646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListCasesForContactRequest AWS API Documentation
|
1647
|
+
#
|
1648
|
+
class ListCasesForContactRequest < Struct.new(
|
1649
|
+
:contact_arn,
|
1650
|
+
:domain_id,
|
1651
|
+
:max_results,
|
1652
|
+
:next_token)
|
1653
|
+
SENSITIVE = []
|
1654
|
+
include Aws::Structure
|
1655
|
+
end
|
1656
|
+
|
1657
|
+
# @!attribute [rw] cases
|
1658
|
+
# A list of Case summary information.
|
1659
|
+
# @return [Array<Types::CaseSummary>]
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] next_token
|
1662
|
+
# The token for the next set of results. This is null if there are no
|
1663
|
+
# more results to return.
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListCasesForContactResponse AWS API Documentation
|
1667
|
+
#
|
1668
|
+
class ListCasesForContactResponse < Struct.new(
|
1669
|
+
:cases,
|
1670
|
+
:next_token)
|
1671
|
+
SENSITIVE = []
|
1672
|
+
include Aws::Structure
|
1673
|
+
end
|
1674
|
+
|
1675
|
+
# @note When making an API call, you may pass ListDomainsRequest
|
1676
|
+
# data as a hash:
|
1677
|
+
#
|
1678
|
+
# {
|
1679
|
+
# max_results: 1,
|
1680
|
+
# next_token: "NextToken",
|
1681
|
+
# }
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] max_results
|
1684
|
+
# The maximum number of results to return per page.
|
1685
|
+
# @return [Integer]
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] next_token
|
1688
|
+
# The token for the next set of results. Use the value returned in the
|
1689
|
+
# previous response in the next request to retrieve the next set of
|
1690
|
+
# results.
|
1691
|
+
# @return [String]
|
1692
|
+
#
|
1693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListDomainsRequest AWS API Documentation
|
1694
|
+
#
|
1695
|
+
class ListDomainsRequest < Struct.new(
|
1696
|
+
:max_results,
|
1697
|
+
:next_token)
|
1698
|
+
SENSITIVE = []
|
1699
|
+
include Aws::Structure
|
1700
|
+
end
|
1701
|
+
|
1702
|
+
# @!attribute [rw] domains
|
1703
|
+
# The Cases domain.
|
1704
|
+
# @return [Array<Types::DomainSummary>]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] next_token
|
1707
|
+
# The token for the next set of results. This is null if there are no
|
1708
|
+
# more results to return.
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListDomainsResponse AWS API Documentation
|
1712
|
+
#
|
1713
|
+
class ListDomainsResponse < Struct.new(
|
1714
|
+
:domains,
|
1715
|
+
:next_token)
|
1716
|
+
SENSITIVE = []
|
1717
|
+
include Aws::Structure
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
# @note When making an API call, you may pass ListFieldOptionsRequest
|
1721
|
+
# data as a hash:
|
1722
|
+
#
|
1723
|
+
# {
|
1724
|
+
# domain_id: "DomainId", # required
|
1725
|
+
# field_id: "FieldId", # required
|
1726
|
+
# max_results: 1,
|
1727
|
+
# next_token: "NextToken",
|
1728
|
+
# values: ["Value"],
|
1729
|
+
# }
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] domain_id
|
1732
|
+
# The unique identifier of the Cases domain.
|
1733
|
+
# @return [String]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] field_id
|
1736
|
+
# The unique identifier of a field.
|
1737
|
+
# @return [String]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] max_results
|
1740
|
+
# The maximum number of results to return per page.
|
1741
|
+
# @return [Integer]
|
1742
|
+
#
|
1743
|
+
# @!attribute [rw] next_token
|
1744
|
+
# The token for the next set of results. Use the value returned in the
|
1745
|
+
# previous response in the next request to retrieve the next set of
|
1746
|
+
# results.
|
1747
|
+
# @return [String]
|
1748
|
+
#
|
1749
|
+
# @!attribute [rw] values
|
1750
|
+
# A list of `FieldOption` values to filter on for `ListFieldOptions`.
|
1751
|
+
# @return [Array<String>]
|
1752
|
+
#
|
1753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFieldOptionsRequest AWS API Documentation
|
1754
|
+
#
|
1755
|
+
class ListFieldOptionsRequest < Struct.new(
|
1756
|
+
:domain_id,
|
1757
|
+
:field_id,
|
1758
|
+
:max_results,
|
1759
|
+
:next_token,
|
1760
|
+
:values)
|
1761
|
+
SENSITIVE = []
|
1762
|
+
include Aws::Structure
|
1763
|
+
end
|
1764
|
+
|
1765
|
+
# @!attribute [rw] next_token
|
1766
|
+
# The token for the next set of results. This is null if there are no
|
1767
|
+
# more results to return.
|
1768
|
+
# @return [String]
|
1769
|
+
#
|
1770
|
+
# @!attribute [rw] options
|
1771
|
+
# A list of `FieldOption` objects.
|
1772
|
+
# @return [Array<Types::FieldOption>]
|
1773
|
+
#
|
1774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFieldOptionsResponse AWS API Documentation
|
1775
|
+
#
|
1776
|
+
class ListFieldOptionsResponse < Struct.new(
|
1777
|
+
:next_token,
|
1778
|
+
:options)
|
1779
|
+
SENSITIVE = []
|
1780
|
+
include Aws::Structure
|
1781
|
+
end
|
1782
|
+
|
1783
|
+
# @note When making an API call, you may pass ListFieldsRequest
|
1784
|
+
# data as a hash:
|
1785
|
+
#
|
1786
|
+
# {
|
1787
|
+
# domain_id: "DomainId", # required
|
1788
|
+
# max_results: 1,
|
1789
|
+
# next_token: "NextToken",
|
1790
|
+
# }
|
1791
|
+
#
|
1792
|
+
# @!attribute [rw] domain_id
|
1793
|
+
# The unique identifier of the Cases domain.
|
1794
|
+
# @return [String]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] max_results
|
1797
|
+
# The maximum number of results to return per page.
|
1798
|
+
# @return [Integer]
|
1799
|
+
#
|
1800
|
+
# @!attribute [rw] next_token
|
1801
|
+
# The token for the next set of results. Use the value returned in the
|
1802
|
+
# previous response in the next request to retrieve the next set of
|
1803
|
+
# results.
|
1804
|
+
# @return [String]
|
1805
|
+
#
|
1806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFieldsRequest AWS API Documentation
|
1807
|
+
#
|
1808
|
+
class ListFieldsRequest < Struct.new(
|
1809
|
+
:domain_id,
|
1810
|
+
:max_results,
|
1811
|
+
:next_token)
|
1812
|
+
SENSITIVE = []
|
1813
|
+
include Aws::Structure
|
1814
|
+
end
|
1815
|
+
|
1816
|
+
# @!attribute [rw] fields
|
1817
|
+
# List of detailed field information.
|
1818
|
+
# @return [Array<Types::FieldSummary>]
|
1819
|
+
#
|
1820
|
+
# @!attribute [rw] next_token
|
1821
|
+
# The token for the next set of results. This is null if there are no
|
1822
|
+
# more results to return.
|
1823
|
+
# @return [String]
|
1824
|
+
#
|
1825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListFieldsResponse AWS API Documentation
|
1826
|
+
#
|
1827
|
+
class ListFieldsResponse < Struct.new(
|
1828
|
+
:fields,
|
1829
|
+
:next_token)
|
1830
|
+
SENSITIVE = []
|
1831
|
+
include Aws::Structure
|
1832
|
+
end
|
1833
|
+
|
1834
|
+
# @note When making an API call, you may pass ListLayoutsRequest
|
1835
|
+
# data as a hash:
|
1836
|
+
#
|
1837
|
+
# {
|
1838
|
+
# domain_id: "DomainId", # required
|
1839
|
+
# max_results: 1,
|
1840
|
+
# next_token: "NextToken",
|
1841
|
+
# }
|
1842
|
+
#
|
1843
|
+
# @!attribute [rw] domain_id
|
1844
|
+
# The unique identifier of the Cases domain.
|
1845
|
+
# @return [String]
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] max_results
|
1848
|
+
# The maximum number of results to return per page.
|
1849
|
+
# @return [Integer]
|
1850
|
+
#
|
1851
|
+
# @!attribute [rw] next_token
|
1852
|
+
# The token for the next set of results. Use the value returned in the
|
1853
|
+
# previous response in the next request to retrieve the next set of
|
1854
|
+
# results.
|
1855
|
+
# @return [String]
|
1856
|
+
#
|
1857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListLayoutsRequest AWS API Documentation
|
1858
|
+
#
|
1859
|
+
class ListLayoutsRequest < Struct.new(
|
1860
|
+
:domain_id,
|
1861
|
+
:max_results,
|
1862
|
+
:next_token)
|
1863
|
+
SENSITIVE = []
|
1864
|
+
include Aws::Structure
|
1865
|
+
end
|
1866
|
+
|
1867
|
+
# @!attribute [rw] layouts
|
1868
|
+
# The layouts for the domain.
|
1869
|
+
# @return [Array<Types::LayoutSummary>]
|
1870
|
+
#
|
1871
|
+
# @!attribute [rw] next_token
|
1872
|
+
# The token for the next set of results. This is null if there are no
|
1873
|
+
# more results to return.
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListLayoutsResponse AWS API Documentation
|
1877
|
+
#
|
1878
|
+
class ListLayoutsResponse < Struct.new(
|
1879
|
+
:layouts,
|
1880
|
+
:next_token)
|
1881
|
+
SENSITIVE = []
|
1882
|
+
include Aws::Structure
|
1883
|
+
end
|
1884
|
+
|
1885
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1886
|
+
# data as a hash:
|
1887
|
+
#
|
1888
|
+
# {
|
1889
|
+
# arn: "Arn", # required
|
1890
|
+
# }
|
1891
|
+
#
|
1892
|
+
# @!attribute [rw] arn
|
1893
|
+
# The Amazon Resource Name (ARN)
|
1894
|
+
# @return [String]
|
1895
|
+
#
|
1896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListTagsForResourceRequest AWS API Documentation
|
1897
|
+
#
|
1898
|
+
class ListTagsForResourceRequest < Struct.new(
|
1899
|
+
:arn)
|
1900
|
+
SENSITIVE = []
|
1901
|
+
include Aws::Structure
|
1902
|
+
end
|
1903
|
+
|
1904
|
+
# @!attribute [rw] tags
|
1905
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
1906
|
+
# are used to organize, track, or control access for this resource.
|
1907
|
+
# @return [Hash<String,String>]
|
1908
|
+
#
|
1909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListTagsForResourceResponse AWS API Documentation
|
1910
|
+
#
|
1911
|
+
class ListTagsForResourceResponse < Struct.new(
|
1912
|
+
:tags)
|
1913
|
+
SENSITIVE = []
|
1914
|
+
include Aws::Structure
|
1915
|
+
end
|
1916
|
+
|
1917
|
+
# @note When making an API call, you may pass ListTemplatesRequest
|
1918
|
+
# data as a hash:
|
1919
|
+
#
|
1920
|
+
# {
|
1921
|
+
# domain_id: "DomainId", # required
|
1922
|
+
# max_results: 1,
|
1923
|
+
# next_token: "NextToken",
|
1924
|
+
# }
|
1925
|
+
#
|
1926
|
+
# @!attribute [rw] domain_id
|
1927
|
+
# The unique identifier of the Cases domain.
|
1928
|
+
# @return [String]
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] max_results
|
1931
|
+
# The maximum number of results to return per page.
|
1932
|
+
# @return [Integer]
|
1933
|
+
#
|
1934
|
+
# @!attribute [rw] next_token
|
1935
|
+
# The token for the next set of results. Use the value returned in the
|
1936
|
+
# previous response in the next request to retrieve the next set of
|
1937
|
+
# results.
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListTemplatesRequest AWS API Documentation
|
1941
|
+
#
|
1942
|
+
class ListTemplatesRequest < Struct.new(
|
1943
|
+
:domain_id,
|
1944
|
+
:max_results,
|
1945
|
+
:next_token)
|
1946
|
+
SENSITIVE = []
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# @!attribute [rw] next_token
|
1951
|
+
# The token for the next set of results. This is null if there are no
|
1952
|
+
# more results to return.
|
1953
|
+
# @return [String]
|
1954
|
+
#
|
1955
|
+
# @!attribute [rw] templates
|
1956
|
+
# List of template summary objects.
|
1957
|
+
# @return [Array<Types::TemplateSummary>]
|
1958
|
+
#
|
1959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ListTemplatesResponse AWS API Documentation
|
1960
|
+
#
|
1961
|
+
class ListTemplatesResponse < Struct.new(
|
1962
|
+
:next_token,
|
1963
|
+
:templates)
|
1964
|
+
SENSITIVE = []
|
1965
|
+
include Aws::Structure
|
1966
|
+
end
|
1967
|
+
|
1968
|
+
# @note When making an API call, you may pass PutCaseEventConfigurationRequest
|
1969
|
+
# data as a hash:
|
1970
|
+
#
|
1971
|
+
# {
|
1972
|
+
# domain_id: "DomainId", # required
|
1973
|
+
# event_bridge: { # required
|
1974
|
+
# enabled: false, # required
|
1975
|
+
# included_data: {
|
1976
|
+
# case_data: {
|
1977
|
+
# fields: [ # required
|
1978
|
+
# {
|
1979
|
+
# id: "FieldId", # required
|
1980
|
+
# },
|
1981
|
+
# ],
|
1982
|
+
# },
|
1983
|
+
# related_item_data: {
|
1984
|
+
# include_content: false, # required
|
1985
|
+
# },
|
1986
|
+
# },
|
1987
|
+
# },
|
1988
|
+
# }
|
1989
|
+
#
|
1990
|
+
# @!attribute [rw] domain_id
|
1991
|
+
# The unique identifier of the Cases domain.
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] event_bridge
|
1995
|
+
# Configuration to enable EventBridge case event delivery and
|
1996
|
+
# determine what data is delivered.
|
1997
|
+
# @return [Types::EventBridgeConfiguration]
|
1998
|
+
#
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/PutCaseEventConfigurationRequest AWS API Documentation
|
2000
|
+
#
|
2001
|
+
class PutCaseEventConfigurationRequest < Struct.new(
|
2002
|
+
:domain_id,
|
2003
|
+
:event_bridge)
|
2004
|
+
SENSITIVE = []
|
2005
|
+
include Aws::Structure
|
2006
|
+
end
|
2007
|
+
|
2008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/PutCaseEventConfigurationResponse AWS API Documentation
|
2009
|
+
#
|
2010
|
+
class PutCaseEventConfigurationResponse < Aws::EmptyStructure; end
|
2011
|
+
|
2012
|
+
# Represents the content of a particular type of related item.
|
2013
|
+
#
|
2014
|
+
# @note RelatedItemContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RelatedItemContent corresponding to the set member.
|
2015
|
+
#
|
2016
|
+
# @!attribute [rw] comment
|
2017
|
+
# Represents the content of a comment to be returned to agents.
|
2018
|
+
# @return [Types::CommentContent]
|
2019
|
+
#
|
2020
|
+
# @!attribute [rw] contact
|
2021
|
+
# Represents the content of a contact to be returned to agents.
|
2022
|
+
# @return [Types::ContactContent]
|
2023
|
+
#
|
2024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemContent AWS API Documentation
|
2025
|
+
#
|
2026
|
+
class RelatedItemContent < Struct.new(
|
2027
|
+
:comment,
|
2028
|
+
:contact,
|
2029
|
+
:unknown)
|
2030
|
+
SENSITIVE = []
|
2031
|
+
include Aws::Structure
|
2032
|
+
include Aws::Structure::Union
|
2033
|
+
|
2034
|
+
class Comment < RelatedItemContent; end
|
2035
|
+
class Contact < RelatedItemContent; end
|
2036
|
+
class Unknown < RelatedItemContent; end
|
2037
|
+
end
|
2038
|
+
|
2039
|
+
# Details of what related item data is published through the case event
|
2040
|
+
# stream.
|
2041
|
+
#
|
2042
|
+
# @note When making an API call, you may pass RelatedItemEventIncludedData
|
2043
|
+
# data as a hash:
|
2044
|
+
#
|
2045
|
+
# {
|
2046
|
+
# include_content: false, # required
|
2047
|
+
# }
|
2048
|
+
#
|
2049
|
+
# @!attribute [rw] include_content
|
2050
|
+
# Details of what related item data is published through the case
|
2051
|
+
# event stream.
|
2052
|
+
# @return [Boolean]
|
2053
|
+
#
|
2054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemEventIncludedData AWS API Documentation
|
2055
|
+
#
|
2056
|
+
class RelatedItemEventIncludedData < Struct.new(
|
2057
|
+
:include_content)
|
2058
|
+
SENSITIVE = []
|
2059
|
+
include Aws::Structure
|
2060
|
+
end
|
2061
|
+
|
2062
|
+
# Represents the content of a related item to be created.
|
2063
|
+
#
|
2064
|
+
# @note RelatedItemInputContent is a union - when making an API calls you must set exactly one of the members.
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] comment
|
2067
|
+
# Represents the content of a comment to be returned to agents.
|
2068
|
+
# @return [Types::CommentContent]
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] contact
|
2071
|
+
# Object representing a contact in Amazon Connect as an API request
|
2072
|
+
# field.
|
2073
|
+
# @return [Types::Contact]
|
2074
|
+
#
|
2075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemInputContent AWS API Documentation
|
2076
|
+
#
|
2077
|
+
class RelatedItemInputContent < Struct.new(
|
2078
|
+
:comment,
|
2079
|
+
:contact,
|
2080
|
+
:unknown)
|
2081
|
+
SENSITIVE = []
|
2082
|
+
include Aws::Structure
|
2083
|
+
include Aws::Structure::Union
|
2084
|
+
|
2085
|
+
class Comment < RelatedItemInputContent; end
|
2086
|
+
class Contact < RelatedItemInputContent; end
|
2087
|
+
class Unknown < RelatedItemInputContent; end
|
2088
|
+
end
|
2089
|
+
|
2090
|
+
# The list of types of related items and their parameters to use for
|
2091
|
+
# filtering.
|
2092
|
+
#
|
2093
|
+
# @note RelatedItemTypeFilter is a union - when making an API calls you must set exactly one of the members.
|
2094
|
+
#
|
2095
|
+
# @!attribute [rw] comment
|
2096
|
+
# A filter for related items of type `Comment`.
|
2097
|
+
# @return [Types::CommentFilter]
|
2098
|
+
#
|
2099
|
+
# @!attribute [rw] contact
|
2100
|
+
# A filter for related items of type `Contact`.
|
2101
|
+
# @return [Types::ContactFilter]
|
2102
|
+
#
|
2103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RelatedItemTypeFilter AWS API Documentation
|
2104
|
+
#
|
2105
|
+
class RelatedItemTypeFilter < Struct.new(
|
2106
|
+
:comment,
|
2107
|
+
:contact,
|
2108
|
+
:unknown)
|
2109
|
+
SENSITIVE = []
|
2110
|
+
include Aws::Structure
|
2111
|
+
include Aws::Structure::Union
|
2112
|
+
|
2113
|
+
class Comment < RelatedItemTypeFilter; end
|
2114
|
+
class Contact < RelatedItemTypeFilter; end
|
2115
|
+
class Unknown < RelatedItemTypeFilter; end
|
2116
|
+
end
|
2117
|
+
|
2118
|
+
# List of fields that must have a value provided to create a case.
|
2119
|
+
#
|
2120
|
+
# @note When making an API call, you may pass RequiredField
|
2121
|
+
# data as a hash:
|
2122
|
+
#
|
2123
|
+
# {
|
2124
|
+
# field_id: "FieldId", # required
|
2125
|
+
# }
|
2126
|
+
#
|
2127
|
+
# @!attribute [rw] field_id
|
2128
|
+
# Unique identifier of a field.
|
2129
|
+
# @return [String]
|
2130
|
+
#
|
2131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/RequiredField AWS API Documentation
|
2132
|
+
#
|
2133
|
+
class RequiredField < Struct.new(
|
2134
|
+
:field_id)
|
2135
|
+
SENSITIVE = []
|
2136
|
+
include Aws::Structure
|
2137
|
+
end
|
2138
|
+
|
2139
|
+
# We couldn't find the requested resource. Check that your resources
|
2140
|
+
# exists and were created in the same Amazon Web Services Region as your
|
2141
|
+
# request, and try your request again.
|
2142
|
+
#
|
2143
|
+
# @!attribute [rw] message
|
2144
|
+
# @return [String]
|
2145
|
+
#
|
2146
|
+
# @!attribute [rw] resource_id
|
2147
|
+
# Unique identifier of the resource affected.
|
2148
|
+
# @return [String]
|
2149
|
+
#
|
2150
|
+
# @!attribute [rw] resource_type
|
2151
|
+
# Type of the resource affected.
|
2152
|
+
# @return [String]
|
2153
|
+
#
|
2154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ResourceNotFoundException AWS API Documentation
|
2155
|
+
#
|
2156
|
+
class ResourceNotFoundException < Struct.new(
|
2157
|
+
:message,
|
2158
|
+
:resource_id,
|
2159
|
+
:resource_type)
|
2160
|
+
SENSITIVE = []
|
2161
|
+
include Aws::Structure
|
2162
|
+
end
|
2163
|
+
|
2164
|
+
# @note When making an API call, you may pass SearchCasesRequest
|
2165
|
+
# data as a hash:
|
2166
|
+
#
|
2167
|
+
# {
|
2168
|
+
# domain_id: "DomainId", # required
|
2169
|
+
# fields: [
|
2170
|
+
# {
|
2171
|
+
# id: "FieldId", # required
|
2172
|
+
# },
|
2173
|
+
# ],
|
2174
|
+
# filter: {
|
2175
|
+
# and_all: [
|
2176
|
+
# {
|
2177
|
+
# # recursive CaseFilter
|
2178
|
+
# },
|
2179
|
+
# ],
|
2180
|
+
# field: {
|
2181
|
+
# contains: {
|
2182
|
+
# id: "FieldId", # required
|
2183
|
+
# value: { # required
|
2184
|
+
# boolean_value: false,
|
2185
|
+
# double_value: 1.0,
|
2186
|
+
# string_value: "FieldValueUnionStringValueString",
|
2187
|
+
# },
|
2188
|
+
# },
|
2189
|
+
# equal_to: {
|
2190
|
+
# id: "FieldId", # required
|
2191
|
+
# value: { # required
|
2192
|
+
# boolean_value: false,
|
2193
|
+
# double_value: 1.0,
|
2194
|
+
# string_value: "FieldValueUnionStringValueString",
|
2195
|
+
# },
|
2196
|
+
# },
|
2197
|
+
# greater_than: {
|
2198
|
+
# id: "FieldId", # required
|
2199
|
+
# value: { # required
|
2200
|
+
# boolean_value: false,
|
2201
|
+
# double_value: 1.0,
|
2202
|
+
# string_value: "FieldValueUnionStringValueString",
|
2203
|
+
# },
|
2204
|
+
# },
|
2205
|
+
# greater_than_or_equal_to: {
|
2206
|
+
# id: "FieldId", # required
|
2207
|
+
# value: { # required
|
2208
|
+
# boolean_value: false,
|
2209
|
+
# double_value: 1.0,
|
2210
|
+
# string_value: "FieldValueUnionStringValueString",
|
2211
|
+
# },
|
2212
|
+
# },
|
2213
|
+
# less_than: {
|
2214
|
+
# id: "FieldId", # required
|
2215
|
+
# value: { # required
|
2216
|
+
# boolean_value: false,
|
2217
|
+
# double_value: 1.0,
|
2218
|
+
# string_value: "FieldValueUnionStringValueString",
|
2219
|
+
# },
|
2220
|
+
# },
|
2221
|
+
# less_than_or_equal_to: {
|
2222
|
+
# id: "FieldId", # required
|
2223
|
+
# value: { # required
|
2224
|
+
# boolean_value: false,
|
2225
|
+
# double_value: 1.0,
|
2226
|
+
# string_value: "FieldValueUnionStringValueString",
|
2227
|
+
# },
|
2228
|
+
# },
|
2229
|
+
# },
|
2230
|
+
# not: {
|
2231
|
+
# # recursive CaseFilter
|
2232
|
+
# },
|
2233
|
+
# },
|
2234
|
+
# max_results: 1,
|
2235
|
+
# next_token: "NextToken",
|
2236
|
+
# search_term: "SearchCasesRequestSearchTermString",
|
2237
|
+
# sorts: [
|
2238
|
+
# {
|
2239
|
+
# field_id: "FieldId", # required
|
2240
|
+
# sort_order: "Asc", # required, accepts Asc, Desc
|
2241
|
+
# },
|
2242
|
+
# ],
|
2243
|
+
# }
|
2244
|
+
#
|
2245
|
+
# @!attribute [rw] domain_id
|
2246
|
+
# The unique identifier of the Cases domain.
|
2247
|
+
# @return [String]
|
2248
|
+
#
|
2249
|
+
# @!attribute [rw] fields
|
2250
|
+
# The list of field identifiers to be returned as part of the
|
2251
|
+
# response.
|
2252
|
+
# @return [Array<Types::FieldIdentifier>]
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] filter
|
2255
|
+
# A list of filter objects.
|
2256
|
+
# @return [Types::CaseFilter]
|
2257
|
+
#
|
2258
|
+
# @!attribute [rw] max_results
|
2259
|
+
# The maximum number of cases to return. The current maximum supported
|
2260
|
+
# value is 25. This is also the default value when no other value is
|
2261
|
+
# provided.
|
2262
|
+
# @return [Integer]
|
2263
|
+
#
|
2264
|
+
# @!attribute [rw] next_token
|
2265
|
+
# The token for the next set of results. Use the value returned in the
|
2266
|
+
# previous response in the next request to retrieve the next set of
|
2267
|
+
# results.
|
2268
|
+
# @return [String]
|
2269
|
+
#
|
2270
|
+
# @!attribute [rw] search_term
|
2271
|
+
# A word or phrase used to perform a quick search.
|
2272
|
+
# @return [String]
|
2273
|
+
#
|
2274
|
+
# @!attribute [rw] sorts
|
2275
|
+
# A list of sorts where each sort specifies a field and their sort
|
2276
|
+
# order to be applied to the results.
|
2277
|
+
# @return [Array<Types::Sort>]
|
2278
|
+
#
|
2279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchCasesRequest AWS API Documentation
|
2280
|
+
#
|
2281
|
+
class SearchCasesRequest < Struct.new(
|
2282
|
+
:domain_id,
|
2283
|
+
:fields,
|
2284
|
+
:filter,
|
2285
|
+
:max_results,
|
2286
|
+
:next_token,
|
2287
|
+
:search_term,
|
2288
|
+
:sorts)
|
2289
|
+
SENSITIVE = []
|
2290
|
+
include Aws::Structure
|
2291
|
+
end
|
2292
|
+
|
2293
|
+
# @!attribute [rw] cases
|
2294
|
+
# A list of case documents where each case contains the properties
|
2295
|
+
# `CaseId` and `Fields` where each field is a complex union structure.
|
2296
|
+
# @return [Array<Types::SearchCasesResponseItem>]
|
2297
|
+
#
|
2298
|
+
# @!attribute [rw] next_token
|
2299
|
+
# The token for the next set of results. This is null if there are no
|
2300
|
+
# more results to return.
|
2301
|
+
# @return [String]
|
2302
|
+
#
|
2303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchCasesResponse AWS API Documentation
|
2304
|
+
#
|
2305
|
+
class SearchCasesResponse < Struct.new(
|
2306
|
+
:cases,
|
2307
|
+
:next_token)
|
2308
|
+
SENSITIVE = []
|
2309
|
+
include Aws::Structure
|
2310
|
+
end
|
2311
|
+
|
2312
|
+
# A list of items that represent cases.
|
2313
|
+
#
|
2314
|
+
# @!attribute [rw] case_id
|
2315
|
+
# A unique identifier of the case.
|
2316
|
+
# @return [String]
|
2317
|
+
#
|
2318
|
+
# @!attribute [rw] fields
|
2319
|
+
# List of case field values.
|
2320
|
+
# @return [Array<Types::FieldValue>]
|
2321
|
+
#
|
2322
|
+
# @!attribute [rw] tags
|
2323
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
2324
|
+
# are used to organize, track, or control access for this resource.
|
2325
|
+
# @return [Hash<String,String>]
|
2326
|
+
#
|
2327
|
+
# @!attribute [rw] template_id
|
2328
|
+
# A unique identifier of a template.
|
2329
|
+
# @return [String]
|
2330
|
+
#
|
2331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchCasesResponseItem AWS API Documentation
|
2332
|
+
#
|
2333
|
+
class SearchCasesResponseItem < Struct.new(
|
2334
|
+
:case_id,
|
2335
|
+
:fields,
|
2336
|
+
:tags,
|
2337
|
+
:template_id)
|
2338
|
+
SENSITIVE = []
|
2339
|
+
include Aws::Structure
|
2340
|
+
end
|
2341
|
+
|
2342
|
+
# @note When making an API call, you may pass SearchRelatedItemsRequest
|
2343
|
+
# data as a hash:
|
2344
|
+
#
|
2345
|
+
# {
|
2346
|
+
# case_id: "CaseId", # required
|
2347
|
+
# domain_id: "DomainId", # required
|
2348
|
+
# filters: [
|
2349
|
+
# {
|
2350
|
+
# comment: {
|
2351
|
+
# },
|
2352
|
+
# contact: {
|
2353
|
+
# channel: ["Channel"],
|
2354
|
+
# contact_arn: "ContactArn",
|
2355
|
+
# },
|
2356
|
+
# },
|
2357
|
+
# ],
|
2358
|
+
# max_results: 1,
|
2359
|
+
# next_token: "NextToken",
|
2360
|
+
# }
|
2361
|
+
#
|
2362
|
+
# @!attribute [rw] case_id
|
2363
|
+
# A unique identifier of the case.
|
2364
|
+
# @return [String]
|
2365
|
+
#
|
2366
|
+
# @!attribute [rw] domain_id
|
2367
|
+
# The unique identifier of the Cases domain.
|
2368
|
+
# @return [String]
|
2369
|
+
#
|
2370
|
+
# @!attribute [rw] filters
|
2371
|
+
# The list of types of related items and their parameters to use for
|
2372
|
+
# filtering.
|
2373
|
+
# @return [Array<Types::RelatedItemTypeFilter>]
|
2374
|
+
#
|
2375
|
+
# @!attribute [rw] max_results
|
2376
|
+
# The maximum number of results to return per page.
|
2377
|
+
# @return [Integer]
|
2378
|
+
#
|
2379
|
+
# @!attribute [rw] next_token
|
2380
|
+
# The token for the next set of results. Use the value returned in the
|
2381
|
+
# previous response in the next request to retrieve the next set of
|
2382
|
+
# results.
|
2383
|
+
# @return [String]
|
2384
|
+
#
|
2385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchRelatedItemsRequest AWS API Documentation
|
2386
|
+
#
|
2387
|
+
class SearchRelatedItemsRequest < Struct.new(
|
2388
|
+
:case_id,
|
2389
|
+
:domain_id,
|
2390
|
+
:filters,
|
2391
|
+
:max_results,
|
2392
|
+
:next_token)
|
2393
|
+
SENSITIVE = []
|
2394
|
+
include Aws::Structure
|
2395
|
+
end
|
2396
|
+
|
2397
|
+
# @!attribute [rw] next_token
|
2398
|
+
# The token for the next set of results. This is null if there are no
|
2399
|
+
# more results to return.
|
2400
|
+
# @return [String]
|
2401
|
+
#
|
2402
|
+
# @!attribute [rw] related_items
|
2403
|
+
# A list of items related to a case.
|
2404
|
+
# @return [Array<Types::SearchRelatedItemsResponseItem>]
|
2405
|
+
#
|
2406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchRelatedItemsResponse AWS API Documentation
|
2407
|
+
#
|
2408
|
+
class SearchRelatedItemsResponse < Struct.new(
|
2409
|
+
:next_token,
|
2410
|
+
:related_items)
|
2411
|
+
SENSITIVE = []
|
2412
|
+
include Aws::Structure
|
2413
|
+
end
|
2414
|
+
|
2415
|
+
# A list of items that represent RelatedItems.
|
2416
|
+
#
|
2417
|
+
# @!attribute [rw] association_time
|
2418
|
+
# Time at which a related item was associated with a case.
|
2419
|
+
# @return [Time]
|
2420
|
+
#
|
2421
|
+
# @!attribute [rw] content
|
2422
|
+
# Represents the content of a particular type of related item.
|
2423
|
+
# @return [Types::RelatedItemContent]
|
2424
|
+
#
|
2425
|
+
# @!attribute [rw] related_item_id
|
2426
|
+
# Unique identifier of a related item.
|
2427
|
+
# @return [String]
|
2428
|
+
#
|
2429
|
+
# @!attribute [rw] tags
|
2430
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
2431
|
+
# are used to organize, track, or control access for this resource.
|
2432
|
+
# @return [Hash<String,String>]
|
2433
|
+
#
|
2434
|
+
# @!attribute [rw] type
|
2435
|
+
# Type of a related item.
|
2436
|
+
# @return [String]
|
2437
|
+
#
|
2438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/SearchRelatedItemsResponseItem AWS API Documentation
|
2439
|
+
#
|
2440
|
+
class SearchRelatedItemsResponseItem < Struct.new(
|
2441
|
+
:association_time,
|
2442
|
+
:content,
|
2443
|
+
:related_item_id,
|
2444
|
+
:tags,
|
2445
|
+
:type)
|
2446
|
+
SENSITIVE = []
|
2447
|
+
include Aws::Structure
|
2448
|
+
end
|
2449
|
+
|
2450
|
+
# This represents a sections within a panel or tab of the page layout.
|
2451
|
+
#
|
2452
|
+
# @note Section is a union - when making an API calls you must set exactly one of the members.
|
2453
|
+
#
|
2454
|
+
# @note Section is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Section corresponding to the set member.
|
2455
|
+
#
|
2456
|
+
# @!attribute [rw] field_group
|
2457
|
+
# Consists of a group of fields and associated properties.
|
2458
|
+
# @return [Types::FieldGroup]
|
2459
|
+
#
|
2460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/Section AWS API Documentation
|
2461
|
+
#
|
2462
|
+
class Section < Struct.new(
|
2463
|
+
:field_group,
|
2464
|
+
:unknown)
|
2465
|
+
SENSITIVE = []
|
2466
|
+
include Aws::Structure
|
2467
|
+
include Aws::Structure::Union
|
2468
|
+
|
2469
|
+
class FieldGroup < Section; end
|
2470
|
+
class Unknown < Section; end
|
2471
|
+
end
|
2472
|
+
|
2473
|
+
# The service quota has been exceeded. For a list of service quotas, see
|
2474
|
+
# [Amazon Connect Service Quotas][1] in the *Amazon Connect
|
2475
|
+
# Administrator Guide*.
|
2476
|
+
#
|
2477
|
+
#
|
2478
|
+
#
|
2479
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
2480
|
+
#
|
2481
|
+
# @!attribute [rw] message
|
2482
|
+
# @return [String]
|
2483
|
+
#
|
2484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ServiceQuotaExceededException AWS API Documentation
|
2485
|
+
#
|
2486
|
+
class ServiceQuotaExceededException < Struct.new(
|
2487
|
+
:message)
|
2488
|
+
SENSITIVE = []
|
2489
|
+
include Aws::Structure
|
2490
|
+
end
|
2491
|
+
|
2492
|
+
# A structured set of sort terms.
|
2493
|
+
#
|
2494
|
+
# @note When making an API call, you may pass Sort
|
2495
|
+
# data as a hash:
|
2496
|
+
#
|
2497
|
+
# {
|
2498
|
+
# field_id: "FieldId", # required
|
2499
|
+
# sort_order: "Asc", # required, accepts Asc, Desc
|
2500
|
+
# }
|
2501
|
+
#
|
2502
|
+
# @!attribute [rw] field_id
|
2503
|
+
# Unique identifier of a field.
|
2504
|
+
# @return [String]
|
2505
|
+
#
|
2506
|
+
# @!attribute [rw] sort_order
|
2507
|
+
# A structured set of sort terms
|
2508
|
+
# @return [String]
|
2509
|
+
#
|
2510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/Sort AWS API Documentation
|
2511
|
+
#
|
2512
|
+
class Sort < Struct.new(
|
2513
|
+
:field_id,
|
2514
|
+
:sort_order)
|
2515
|
+
SENSITIVE = []
|
2516
|
+
include Aws::Structure
|
2517
|
+
end
|
2518
|
+
|
2519
|
+
# @note When making an API call, you may pass TagResourceRequest
|
2520
|
+
# data as a hash:
|
2521
|
+
#
|
2522
|
+
# {
|
2523
|
+
# arn: "Arn", # required
|
2524
|
+
# tags: { # required
|
2525
|
+
# "String" => "String",
|
2526
|
+
# },
|
2527
|
+
# }
|
2528
|
+
#
|
2529
|
+
# @!attribute [rw] arn
|
2530
|
+
# The Amazon Resource Name (ARN)
|
2531
|
+
# @return [String]
|
2532
|
+
#
|
2533
|
+
# @!attribute [rw] tags
|
2534
|
+
# A map of of key-value pairs that represent tags on a resource. Tags
|
2535
|
+
# are used to organize, track, or control access for this resource.
|
2536
|
+
# @return [Hash<String,String>]
|
2537
|
+
#
|
2538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/TagResourceRequest AWS API Documentation
|
2539
|
+
#
|
2540
|
+
class TagResourceRequest < Struct.new(
|
2541
|
+
:arn,
|
2542
|
+
:tags)
|
2543
|
+
SENSITIVE = []
|
2544
|
+
include Aws::Structure
|
2545
|
+
end
|
2546
|
+
|
2547
|
+
# Template summary information.
|
2548
|
+
#
|
2549
|
+
# @!attribute [rw] name
|
2550
|
+
# The template name.
|
2551
|
+
# @return [String]
|
2552
|
+
#
|
2553
|
+
# @!attribute [rw] template_arn
|
2554
|
+
# The Amazon Resource Name (ARN) of the template.
|
2555
|
+
# @return [String]
|
2556
|
+
#
|
2557
|
+
# @!attribute [rw] template_id
|
2558
|
+
# The unique identifier for the template.
|
2559
|
+
# @return [String]
|
2560
|
+
#
|
2561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/TemplateSummary AWS API Documentation
|
2562
|
+
#
|
2563
|
+
class TemplateSummary < Struct.new(
|
2564
|
+
:name,
|
2565
|
+
:template_arn,
|
2566
|
+
:template_id)
|
2567
|
+
SENSITIVE = []
|
2568
|
+
include Aws::Structure
|
2569
|
+
end
|
2570
|
+
|
2571
|
+
# The rate has been exceeded for this API. Please try again after a few
|
2572
|
+
# minutes.
|
2573
|
+
#
|
2574
|
+
# @!attribute [rw] message
|
2575
|
+
# @return [String]
|
2576
|
+
#
|
2577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ThrottlingException AWS API Documentation
|
2578
|
+
#
|
2579
|
+
class ThrottlingException < Struct.new(
|
2580
|
+
:message)
|
2581
|
+
SENSITIVE = []
|
2582
|
+
include Aws::Structure
|
2583
|
+
end
|
2584
|
+
|
2585
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
2586
|
+
# data as a hash:
|
2587
|
+
#
|
2588
|
+
# {
|
2589
|
+
# arn: "Arn", # required
|
2590
|
+
# tag_keys: ["TagKey"], # required
|
2591
|
+
# }
|
2592
|
+
#
|
2593
|
+
# @!attribute [rw] arn
|
2594
|
+
# The Amazon Resource Name (ARN)
|
2595
|
+
# @return [String]
|
2596
|
+
#
|
2597
|
+
# @!attribute [rw] tag_keys
|
2598
|
+
# List of tag keys.
|
2599
|
+
# @return [Array<String>]
|
2600
|
+
#
|
2601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UntagResourceRequest AWS API Documentation
|
2602
|
+
#
|
2603
|
+
class UntagResourceRequest < Struct.new(
|
2604
|
+
:arn,
|
2605
|
+
:tag_keys)
|
2606
|
+
SENSITIVE = []
|
2607
|
+
include Aws::Structure
|
2608
|
+
end
|
2609
|
+
|
2610
|
+
# @note When making an API call, you may pass UpdateCaseRequest
|
2611
|
+
# data as a hash:
|
2612
|
+
#
|
2613
|
+
# {
|
2614
|
+
# case_id: "CaseId", # required
|
2615
|
+
# domain_id: "DomainId", # required
|
2616
|
+
# fields: [ # required
|
2617
|
+
# {
|
2618
|
+
# id: "FieldId", # required
|
2619
|
+
# value: { # required
|
2620
|
+
# boolean_value: false,
|
2621
|
+
# double_value: 1.0,
|
2622
|
+
# string_value: "FieldValueUnionStringValueString",
|
2623
|
+
# },
|
2624
|
+
# },
|
2625
|
+
# ],
|
2626
|
+
# }
|
2627
|
+
#
|
2628
|
+
# @!attribute [rw] case_id
|
2629
|
+
# A unique identifier of the case.
|
2630
|
+
# @return [String]
|
2631
|
+
#
|
2632
|
+
# @!attribute [rw] domain_id
|
2633
|
+
# The unique identifier of the Cases domain.
|
2634
|
+
# @return [String]
|
2635
|
+
#
|
2636
|
+
# @!attribute [rw] fields
|
2637
|
+
# An array of objects with `fieldId` (matching
|
2638
|
+
# ListFields/DescribeField) and value union data, structured identical
|
2639
|
+
# to `CreateCase`.
|
2640
|
+
# @return [Array<Types::FieldValue>]
|
2641
|
+
#
|
2642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCaseRequest AWS API Documentation
|
2643
|
+
#
|
2644
|
+
class UpdateCaseRequest < Struct.new(
|
2645
|
+
:case_id,
|
2646
|
+
:domain_id,
|
2647
|
+
:fields)
|
2648
|
+
SENSITIVE = []
|
2649
|
+
include Aws::Structure
|
2650
|
+
end
|
2651
|
+
|
2652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateCaseResponse AWS API Documentation
|
2653
|
+
#
|
2654
|
+
class UpdateCaseResponse < Aws::EmptyStructure; end
|
2655
|
+
|
2656
|
+
# @note When making an API call, you may pass UpdateFieldRequest
|
2657
|
+
# data as a hash:
|
2658
|
+
#
|
2659
|
+
# {
|
2660
|
+
# description: "FieldDescription",
|
2661
|
+
# domain_id: "DomainId", # required
|
2662
|
+
# field_id: "FieldId", # required
|
2663
|
+
# name: "FieldName",
|
2664
|
+
# }
|
2665
|
+
#
|
2666
|
+
# @!attribute [rw] description
|
2667
|
+
# The description of a field.
|
2668
|
+
# @return [String]
|
2669
|
+
#
|
2670
|
+
# @!attribute [rw] domain_id
|
2671
|
+
# The unique identifier of the Cases domain.
|
2672
|
+
# @return [String]
|
2673
|
+
#
|
2674
|
+
# @!attribute [rw] field_id
|
2675
|
+
# The unique identifier of a field.
|
2676
|
+
# @return [String]
|
2677
|
+
#
|
2678
|
+
# @!attribute [rw] name
|
2679
|
+
# The name of the field.
|
2680
|
+
# @return [String]
|
2681
|
+
#
|
2682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateFieldRequest AWS API Documentation
|
2683
|
+
#
|
2684
|
+
class UpdateFieldRequest < Struct.new(
|
2685
|
+
:description,
|
2686
|
+
:domain_id,
|
2687
|
+
:field_id,
|
2688
|
+
:name)
|
2689
|
+
SENSITIVE = []
|
2690
|
+
include Aws::Structure
|
2691
|
+
end
|
2692
|
+
|
2693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateFieldResponse AWS API Documentation
|
2694
|
+
#
|
2695
|
+
class UpdateFieldResponse < Aws::EmptyStructure; end
|
2696
|
+
|
2697
|
+
# @note When making an API call, you may pass UpdateLayoutRequest
|
2698
|
+
# data as a hash:
|
2699
|
+
#
|
2700
|
+
# {
|
2701
|
+
# content: {
|
2702
|
+
# basic: {
|
2703
|
+
# more_info: {
|
2704
|
+
# sections: [
|
2705
|
+
# {
|
2706
|
+
# field_group: {
|
2707
|
+
# fields: [ # required
|
2708
|
+
# {
|
2709
|
+
# id: "FieldId", # required
|
2710
|
+
# },
|
2711
|
+
# ],
|
2712
|
+
# name: "FieldGroupNameString",
|
2713
|
+
# },
|
2714
|
+
# },
|
2715
|
+
# ],
|
2716
|
+
# },
|
2717
|
+
# top_panel: {
|
2718
|
+
# sections: [
|
2719
|
+
# {
|
2720
|
+
# field_group: {
|
2721
|
+
# fields: [ # required
|
2722
|
+
# {
|
2723
|
+
# id: "FieldId", # required
|
2724
|
+
# },
|
2725
|
+
# ],
|
2726
|
+
# name: "FieldGroupNameString",
|
2727
|
+
# },
|
2728
|
+
# },
|
2729
|
+
# ],
|
2730
|
+
# },
|
2731
|
+
# },
|
2732
|
+
# },
|
2733
|
+
# domain_id: "DomainId", # required
|
2734
|
+
# layout_id: "LayoutId", # required
|
2735
|
+
# name: "LayoutName",
|
2736
|
+
# }
|
2737
|
+
#
|
2738
|
+
# @!attribute [rw] content
|
2739
|
+
# Information about which fields will be present in the layout, the
|
2740
|
+
# order of the fields, and a read-only attribute of the field.
|
2741
|
+
# @return [Types::LayoutContent]
|
2742
|
+
#
|
2743
|
+
# @!attribute [rw] domain_id
|
2744
|
+
# The unique identifier of the Cases domain.
|
2745
|
+
# @return [String]
|
2746
|
+
#
|
2747
|
+
# @!attribute [rw] layout_id
|
2748
|
+
# The unique identifier of the layout.
|
2749
|
+
# @return [String]
|
2750
|
+
#
|
2751
|
+
# @!attribute [rw] name
|
2752
|
+
# The name of the layout. It must be unique per domain.
|
2753
|
+
# @return [String]
|
2754
|
+
#
|
2755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateLayoutRequest AWS API Documentation
|
2756
|
+
#
|
2757
|
+
class UpdateLayoutRequest < Struct.new(
|
2758
|
+
:content,
|
2759
|
+
:domain_id,
|
2760
|
+
:layout_id,
|
2761
|
+
:name)
|
2762
|
+
SENSITIVE = []
|
2763
|
+
include Aws::Structure
|
2764
|
+
end
|
2765
|
+
|
2766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateLayoutResponse AWS API Documentation
|
2767
|
+
#
|
2768
|
+
class UpdateLayoutResponse < Aws::EmptyStructure; end
|
2769
|
+
|
2770
|
+
# @note When making an API call, you may pass UpdateTemplateRequest
|
2771
|
+
# data as a hash:
|
2772
|
+
#
|
2773
|
+
# {
|
2774
|
+
# description: "TemplateDescription",
|
2775
|
+
# domain_id: "DomainId", # required
|
2776
|
+
# layout_configuration: {
|
2777
|
+
# default_layout: "LayoutId",
|
2778
|
+
# },
|
2779
|
+
# name: "TemplateName",
|
2780
|
+
# required_fields: [
|
2781
|
+
# {
|
2782
|
+
# field_id: "FieldId", # required
|
2783
|
+
# },
|
2784
|
+
# ],
|
2785
|
+
# template_id: "TemplateId", # required
|
2786
|
+
# }
|
2787
|
+
#
|
2788
|
+
# @!attribute [rw] description
|
2789
|
+
# A brief description of the template.
|
2790
|
+
# @return [String]
|
2791
|
+
#
|
2792
|
+
# @!attribute [rw] domain_id
|
2793
|
+
# The unique identifier of the Cases domain.
|
2794
|
+
# @return [String]
|
2795
|
+
#
|
2796
|
+
# @!attribute [rw] layout_configuration
|
2797
|
+
# Configuration of layouts associated to the template.
|
2798
|
+
# @return [Types::LayoutConfiguration]
|
2799
|
+
#
|
2800
|
+
# @!attribute [rw] name
|
2801
|
+
# The name of the template. It must be unique per domain.
|
2802
|
+
# @return [String]
|
2803
|
+
#
|
2804
|
+
# @!attribute [rw] required_fields
|
2805
|
+
# A list of fields that must contain a value for a case to be
|
2806
|
+
# successfully created with this template.
|
2807
|
+
# @return [Array<Types::RequiredField>]
|
2808
|
+
#
|
2809
|
+
# @!attribute [rw] template_id
|
2810
|
+
# A unique identifier for the template.
|
2811
|
+
# @return [String]
|
2812
|
+
#
|
2813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateTemplateRequest AWS API Documentation
|
2814
|
+
#
|
2815
|
+
class UpdateTemplateRequest < Struct.new(
|
2816
|
+
:description,
|
2817
|
+
:domain_id,
|
2818
|
+
:layout_configuration,
|
2819
|
+
:name,
|
2820
|
+
:required_fields,
|
2821
|
+
:template_id)
|
2822
|
+
SENSITIVE = []
|
2823
|
+
include Aws::Structure
|
2824
|
+
end
|
2825
|
+
|
2826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateTemplateResponse AWS API Documentation
|
2827
|
+
#
|
2828
|
+
class UpdateTemplateResponse < Aws::EmptyStructure; end
|
2829
|
+
|
2830
|
+
# The request isn't valid. Check the syntax and try again.
|
2831
|
+
#
|
2832
|
+
# @!attribute [rw] message
|
2833
|
+
# @return [String]
|
2834
|
+
#
|
2835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/ValidationException AWS API Documentation
|
2836
|
+
#
|
2837
|
+
class ValidationException < Struct.new(
|
2838
|
+
:message)
|
2839
|
+
SENSITIVE = []
|
2840
|
+
include Aws::Structure
|
2841
|
+
end
|
2842
|
+
|
2843
|
+
end
|
2844
|
+
end
|