@aws-sdk/client-connectcases 3.529.1 → 3.535.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.
Files changed (75) hide show
  1. package/dist-types/ConnectCases.d.ts +2 -1
  2. package/dist-types/ConnectCasesClient.d.ts +1 -1
  3. package/dist-types/commands/BatchGetFieldCommand.d.ts +2 -1
  4. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateCaseCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateDomainCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateFieldCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateLayoutCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateRelatedItemCommand.d.ts +2 -1
  10. package/dist-types/commands/CreateTemplateCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteDomainCommand.d.ts +2 -1
  12. package/dist-types/commands/GetCaseAuditEventsCommand.d.ts +2 -1
  13. package/dist-types/commands/GetCaseCommand.d.ts +2 -1
  14. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +2 -1
  15. package/dist-types/commands/GetDomainCommand.d.ts +2 -1
  16. package/dist-types/commands/GetLayoutCommand.d.ts +2 -1
  17. package/dist-types/commands/GetTemplateCommand.d.ts +2 -1
  18. package/dist-types/commands/ListCasesForContactCommand.d.ts +2 -1
  19. package/dist-types/commands/ListDomainsCommand.d.ts +2 -1
  20. package/dist-types/commands/ListFieldOptionsCommand.d.ts +2 -1
  21. package/dist-types/commands/ListFieldsCommand.d.ts +2 -1
  22. package/dist-types/commands/ListLayoutsCommand.d.ts +2 -1
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  24. package/dist-types/commands/ListTemplatesCommand.d.ts +2 -1
  25. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +2 -1
  26. package/dist-types/commands/SearchCasesCommand.d.ts +2 -1
  27. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +2 -1
  28. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  29. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  30. package/dist-types/commands/UpdateCaseCommand.d.ts +2 -1
  31. package/dist-types/commands/UpdateFieldCommand.d.ts +2 -1
  32. package/dist-types/commands/UpdateLayoutCommand.d.ts +2 -1
  33. package/dist-types/commands/UpdateTemplateCommand.d.ts +2 -1
  34. package/dist-types/models/models_0.d.ts +325 -325
  35. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  36. package/dist-types/runtimeConfig.d.ts +2 -2
  37. package/dist-types/runtimeConfig.native.d.ts +2 -2
  38. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  39. package/dist-types/ts3.4/ConnectCases.d.ts +1 -0
  40. package/dist-types/ts3.4/commands/BatchGetFieldCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/BatchPutFieldOptionsCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/CreateCaseCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/CreateFieldCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/CreateLayoutCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/CreateRelatedItemCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/CreateTemplateCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/GetCaseAuditEventsCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/GetCaseCommand.d.ts +7 -0
  51. package/dist-types/ts3.4/commands/GetCaseEventConfigurationCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/GetDomainCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/GetLayoutCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/GetTemplateCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/ListCasesForContactCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/ListFieldOptionsCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/ListFieldsCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/ListLayoutsCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/PutCaseEventConfigurationCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/SearchCasesCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/SearchRelatedItemsCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/UpdateCaseCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/UpdateFieldCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/UpdateLayoutCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  72. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  73. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  74. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  75. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ConnectCasesServiceException as __BaseException } from "./ConnectCasesServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You do not have sufficient access to perform this action.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -13,10 +13,10 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * @public
17
16
  * <p>The requested operation would cause a conflict with the current state of a service
18
17
  * resource associated with the request. Resolve the conflict before retrying this request. See
19
18
  * the accompanying error message for details.</p>
19
+ * @public
20
20
  */
21
21
  export declare class ConflictException extends __BaseException {
22
22
  readonly name: "ConflictException";
@@ -27,21 +27,21 @@ export declare class ConflictException extends __BaseException {
27
27
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
28
28
  }
29
29
  /**
30
- * @public
31
30
  * <p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on
32
31
  * a case template.</p>
33
32
  * <p>This structure will never have any data members. It signifies an empty value on a case
34
33
  * field.</p>
34
+ * @public
35
35
  */
36
36
  export interface EmptyFieldValue {
37
37
  }
38
38
  /**
39
- * @public
40
39
  * <p>Object to store union of Field values.</p>
41
40
  * <note>
42
41
  * <p>The <code>Summary</code> system field accepts 1500 characters while all other fields
43
42
  * accept 500 characters.</p>
44
43
  * </note>
44
+ * @public
45
45
  */
46
46
  export type FieldValueUnion = FieldValueUnion.BooleanValueMember | FieldValueUnion.DoubleValueMember | FieldValueUnion.EmptyValueMember | FieldValueUnion.StringValueMember | FieldValueUnion.UserArnValueMember | FieldValueUnion.$UnknownMember;
47
47
  /**
@@ -49,8 +49,8 @@ export type FieldValueUnion = FieldValueUnion.BooleanValueMember | FieldValueUni
49
49
  */
50
50
  export declare namespace FieldValueUnion {
51
51
  /**
52
- * @public
53
52
  * <p>String value type.</p>
53
+ * @public
54
54
  */
55
55
  interface StringValueMember {
56
56
  stringValue: string;
@@ -61,9 +61,9 @@ export declare namespace FieldValueUnion {
61
61
  $unknown?: never;
62
62
  }
63
63
  /**
64
- * @public
65
64
  * <p>Can be either null, or have a Double number value type. Only one value can be
66
65
  * provided.</p>
66
+ * @public
67
67
  */
68
68
  interface DoubleValueMember {
69
69
  stringValue?: never;
@@ -74,8 +74,8 @@ export declare namespace FieldValueUnion {
74
74
  $unknown?: never;
75
75
  }
76
76
  /**
77
- * @public
78
77
  * <p>Can be either null, or have a Boolean value type. Only one value can be provided.</p>
78
+ * @public
79
79
  */
80
80
  interface BooleanValueMember {
81
81
  stringValue?: never;
@@ -86,8 +86,8 @@ export declare namespace FieldValueUnion {
86
86
  $unknown?: never;
87
87
  }
88
88
  /**
89
- * @public
90
89
  * <p>An empty value.</p>
90
+ * @public
91
91
  */
92
92
  interface EmptyValueMember {
93
93
  stringValue?: never;
@@ -98,8 +98,8 @@ export declare namespace FieldValueUnion {
98
98
  $unknown?: never;
99
99
  }
100
100
  /**
101
- * @public
102
101
  * <p>Represents the user that performed the audit.</p>
102
+ * @public
103
103
  */
104
104
  interface UserArnValueMember {
105
105
  stringValue?: never;
@@ -131,24 +131,24 @@ export declare namespace FieldValueUnion {
131
131
  const visit: <T>(value: FieldValueUnion, visitor: Visitor<T>) => T;
132
132
  }
133
133
  /**
134
- * @public
135
134
  * <p>Object for case field values.</p>
135
+ * @public
136
136
  */
137
137
  export interface FieldValue {
138
138
  /**
139
- * @public
140
139
  * <p>Unique identifier of a field.</p>
140
+ * @public
141
141
  */
142
142
  id: string | undefined;
143
143
  /**
144
- * @public
145
144
  * <p>Union of potential field value types.</p>
145
+ * @public
146
146
  */
147
147
  value: FieldValueUnion | undefined;
148
148
  }
149
149
  /**
150
- * @public
151
150
  * <p>Represents the identity of the person who performed the action.</p>
151
+ * @public
152
152
  */
153
153
  export type UserUnion = UserUnion.UserArnMember | UserUnion.$UnknownMember;
154
154
  /**
@@ -156,8 +156,8 @@ export type UserUnion = UserUnion.UserArnMember | UserUnion.$UnknownMember;
156
156
  */
157
157
  export declare namespace UserUnion {
158
158
  /**
159
- * @public
160
159
  * <p>Represents the Amazon Connect ARN of the user.</p>
160
+ * @public
161
161
  */
162
162
  interface UserArnMember {
163
163
  userArn: string;
@@ -181,32 +181,32 @@ export declare namespace UserUnion {
181
181
  */
182
182
  export interface CreateCaseRequest {
183
183
  /**
184
- * @public
185
184
  * <p>The unique identifier of the Cases domain. </p>
185
+ * @public
186
186
  */
187
187
  domainId: string | undefined;
188
188
  /**
189
- * @public
190
189
  * <p>A unique identifier of a template.</p>
190
+ * @public
191
191
  */
192
192
  templateId: string | undefined;
193
193
  /**
194
- * @public
195
194
  * <p>An array of objects with field ID (matching ListFields/DescribeField) and value union
196
195
  * data.</p>
196
+ * @public
197
197
  */
198
198
  fields: FieldValue[] | undefined;
199
199
  /**
200
- * @public
201
200
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
202
201
  * request. If not provided, the Amazon Web Services
203
202
  * SDK populates this field. For more information about idempotency, see
204
203
  * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
204
+ * @public
205
205
  */
206
206
  clientToken?: string;
207
207
  /**
208
- * @public
209
208
  * <p>Represents the identity of the person who performed the action.</p>
209
+ * @public
210
210
  */
211
211
  performedBy?: UserUnion;
212
212
  }
@@ -215,28 +215,28 @@ export interface CreateCaseRequest {
215
215
  */
216
216
  export interface CreateCaseResponse {
217
217
  /**
218
- * @public
219
218
  * <p>A unique identifier of the case.</p>
219
+ * @public
220
220
  */
221
221
  caseId: string | undefined;
222
222
  /**
223
- * @public
224
223
  * <p>The Amazon Resource Name (ARN) of the case.</p>
224
+ * @public
225
225
  */
226
226
  caseArn: string | undefined;
227
227
  }
228
228
  /**
229
- * @public
230
229
  * <p>We couldn't process your request because of an issue with the server. Try again
231
230
  * later.</p>
231
+ * @public
232
232
  */
233
233
  export declare class InternalServerException extends __BaseException {
234
234
  readonly name: "InternalServerException";
235
235
  readonly $fault: "server";
236
236
  $retryable: {};
237
237
  /**
238
- * @public
239
238
  * <p>Advice to clients on when the call can be safely retried.</p>
239
+ * @public
240
240
  */
241
241
  retryAfterSeconds?: number;
242
242
  /**
@@ -245,21 +245,21 @@ export declare class InternalServerException extends __BaseException {
245
245
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
246
246
  }
247
247
  /**
248
- * @public
249
248
  * <p>We couldn't find the requested resource. Check that your resources exists and were created
250
249
  * in the same Amazon Web Services Region as your request, and try your request again.</p>
250
+ * @public
251
251
  */
252
252
  export declare class ResourceNotFoundException extends __BaseException {
253
253
  readonly name: "ResourceNotFoundException";
254
254
  readonly $fault: "client";
255
255
  /**
256
- * @public
257
256
  * <p>Unique identifier of the resource affected.</p>
257
+ * @public
258
258
  */
259
259
  resourceId: string | undefined;
260
260
  /**
261
- * @public
262
261
  * <p>Type of the resource affected.</p>
262
+ * @public
263
263
  */
264
264
  resourceType: string | undefined;
265
265
  /**
@@ -268,8 +268,8 @@ export declare class ResourceNotFoundException extends __BaseException {
268
268
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
269
269
  }
270
270
  /**
271
- * @public
272
271
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
272
+ * @public
273
273
  */
274
274
  export declare class ThrottlingException extends __BaseException {
275
275
  readonly name: "ThrottlingException";
@@ -281,8 +281,8 @@ export declare class ThrottlingException extends __BaseException {
281
281
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
282
282
  }
283
283
  /**
284
- * @public
285
284
  * <p>The request isn't valid. Check the syntax and try again.</p>
285
+ * @public
286
286
  */
287
287
  export declare class ValidationException extends __BaseException {
288
288
  readonly name: "ValidationException";
@@ -293,13 +293,13 @@ export declare class ValidationException extends __BaseException {
293
293
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
294
294
  }
295
295
  /**
296
- * @public
297
296
  * <p>Object for unique identifier of a field.</p>
297
+ * @public
298
298
  */
299
299
  export interface FieldIdentifier {
300
300
  /**
301
- * @public
302
301
  * <p>Unique identifier of a field.</p>
302
+ * @public
303
303
  */
304
304
  id: string | undefined;
305
305
  }
@@ -308,24 +308,24 @@ export interface FieldIdentifier {
308
308
  */
309
309
  export interface GetCaseRequest {
310
310
  /**
311
- * @public
312
311
  * <p>A unique identifier of the case.</p>
312
+ * @public
313
313
  */
314
314
  caseId: string | undefined;
315
315
  /**
316
- * @public
317
316
  * <p>The unique identifier of the Cases domain. </p>
317
+ * @public
318
318
  */
319
319
  domainId: string | undefined;
320
320
  /**
321
- * @public
322
321
  * <p>A list of unique field identifiers. </p>
322
+ * @public
323
323
  */
324
324
  fields: FieldIdentifier[] | undefined;
325
325
  /**
326
- * @public
327
326
  * <p>The token for the next set of results. Use the value returned in the previous
328
327
  * response in the next request to retrieve the next set of results.</p>
328
+ * @public
329
329
  */
330
330
  nextToken?: string;
331
331
  }
@@ -334,23 +334,23 @@ export interface GetCaseRequest {
334
334
  */
335
335
  export interface GetCaseResponse {
336
336
  /**
337
- * @public
338
337
  * <p>A list of detailed field information. </p>
338
+ * @public
339
339
  */
340
340
  fields: FieldValue[] | undefined;
341
341
  /**
342
- * @public
343
342
  * <p>A unique identifier of a template.</p>
343
+ * @public
344
344
  */
345
345
  templateId: string | undefined;
346
346
  /**
347
- * @public
348
347
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
348
+ * @public
349
349
  */
350
350
  nextToken?: string;
351
351
  /**
352
- * @public
353
352
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
353
+ * @public
354
354
  */
355
355
  tags?: Record<string, string>;
356
356
  }
@@ -359,35 +359,35 @@ export interface GetCaseResponse {
359
359
  */
360
360
  export interface GetCaseAuditEventsRequest {
361
361
  /**
362
- * @public
363
362
  * <p>A unique identifier of the case.</p>
363
+ * @public
364
364
  */
365
365
  caseId: string | undefined;
366
366
  /**
367
- * @public
368
367
  * <p>The unique identifier of the Cases domain.</p>
368
+ * @public
369
369
  */
370
370
  domainId: string | undefined;
371
371
  /**
372
- * @public
373
372
  * <p>The maximum number of audit events to return. The current maximum supported value is 25.
374
373
  * This is also the default when no other value is provided.</p>
374
+ * @public
375
375
  */
376
376
  maxResults?: number;
377
377
  /**
378
- * @public
379
378
  * <p>The token for the next set of results. Use the value returned in the previous response in
380
379
  * the next request to retrieve the next set of results.</p>
380
+ * @public
381
381
  */
382
382
  nextToken?: string;
383
383
  }
384
384
  /**
385
- * @public
386
385
  * <p>Object to store union of Field values.</p>
387
386
  * <important>
388
387
  * <p>This data type is a UNION, so only one of the following members can be specified when
389
388
  * used or returned.</p>
390
389
  * </important>
390
+ * @public
391
391
  */
392
392
  export type AuditEventFieldValueUnion = AuditEventFieldValueUnion.BooleanValueMember | AuditEventFieldValueUnion.DoubleValueMember | AuditEventFieldValueUnion.EmptyValueMember | AuditEventFieldValueUnion.StringValueMember | AuditEventFieldValueUnion.UserArnValueMember | AuditEventFieldValueUnion.$UnknownMember;
393
393
  /**
@@ -395,8 +395,8 @@ export type AuditEventFieldValueUnion = AuditEventFieldValueUnion.BooleanValueMe
395
395
  */
396
396
  export declare namespace AuditEventFieldValueUnion {
397
397
  /**
398
- * @public
399
398
  * <p>Can be either null, or have a String value type. Only one value can be provided.</p>
399
+ * @public
400
400
  */
401
401
  interface StringValueMember {
402
402
  stringValue: string;
@@ -407,8 +407,8 @@ export declare namespace AuditEventFieldValueUnion {
407
407
  $unknown?: never;
408
408
  }
409
409
  /**
410
- * @public
411
410
  * <p>Can be either null, or have a Double value type. Only one value can be provided.</p>
411
+ * @public
412
412
  */
413
413
  interface DoubleValueMember {
414
414
  stringValue?: never;
@@ -419,8 +419,8 @@ export declare namespace AuditEventFieldValueUnion {
419
419
  $unknown?: never;
420
420
  }
421
421
  /**
422
- * @public
423
422
  * <p>Can be either null, or have a Boolean value type. Only one value can be provided.</p>
423
+ * @public
424
424
  */
425
425
  interface BooleanValueMember {
426
426
  stringValue?: never;
@@ -431,11 +431,11 @@ export declare namespace AuditEventFieldValueUnion {
431
431
  $unknown?: never;
432
432
  }
433
433
  /**
434
- * @public
435
434
  * <p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on
436
435
  * a case template.</p>
437
436
  * <p>This structure will never have any data members. It signifies an empty value on a case
438
437
  * field.</p>
438
+ * @public
439
439
  */
440
440
  interface EmptyValueMember {
441
441
  stringValue?: never;
@@ -446,9 +446,9 @@ export declare namespace AuditEventFieldValueUnion {
446
446
  $unknown?: never;
447
447
  }
448
448
  /**
449
- * @public
450
449
  * <p>Can be either null, or have a String value type formatted as an ARN. Only one value can be
451
450
  * provided.</p>
451
+ * @public
452
452
  */
453
453
  interface UserArnValueMember {
454
454
  stringValue?: never;
@@ -480,39 +480,39 @@ export declare namespace AuditEventFieldValueUnion {
480
480
  const visit: <T>(value: AuditEventFieldValueUnion, visitor: Visitor<T>) => T;
481
481
  }
482
482
  /**
483
- * @public
484
483
  * <p>Fields for audit event.</p>
484
+ * @public
485
485
  */
486
486
  export interface AuditEventField {
487
487
  /**
488
- * @public
489
488
  * <p>Unique identifier of field in an Audit History entry.</p>
489
+ * @public
490
490
  */
491
491
  eventFieldId: string | undefined;
492
492
  /**
493
- * @public
494
493
  * <p>Union of potential field value types.</p>
494
+ * @public
495
495
  */
496
496
  oldValue?: AuditEventFieldValueUnion;
497
497
  /**
498
- * @public
499
498
  * <p>Union of potential field value types.</p>
499
+ * @public
500
500
  */
501
501
  newValue: AuditEventFieldValueUnion | undefined;
502
502
  }
503
503
  /**
504
- * @public
505
504
  * <p>Information of the user which performed the audit.</p>
505
+ * @public
506
506
  */
507
507
  export interface AuditEventPerformedBy {
508
508
  /**
509
- * @public
510
509
  * <p>Represents the identity of the person who performed the action.</p>
510
+ * @public
511
511
  */
512
512
  user?: UserUnion;
513
513
  /**
514
- * @public
515
514
  * <p>Unique identifier of an IAM role.</p>
515
+ * @public
516
516
  */
517
517
  iamPrincipalArn: string | undefined;
518
518
  }
@@ -542,38 +542,38 @@ export declare const AuditEventType: {
542
542
  */
543
543
  export type AuditEventType = (typeof AuditEventType)[keyof typeof AuditEventType];
544
544
  /**
545
- * @public
546
545
  * <p>Represents the content of a particular audit event.</p>
546
+ * @public
547
547
  */
548
548
  export interface AuditEvent {
549
549
  /**
550
- * @public
551
550
  * <p>Unique identifier of a case audit history event.</p>
551
+ * @public
552
552
  */
553
553
  eventId: string | undefined;
554
554
  /**
555
- * @public
556
555
  * <p>The Type of an audit history event.</p>
556
+ * @public
557
557
  */
558
558
  type: AuditEventType | undefined;
559
559
  /**
560
- * @public
561
560
  * <p>The Type of the related item.</p>
561
+ * @public
562
562
  */
563
563
  relatedItemType?: RelatedItemType;
564
564
  /**
565
- * @public
566
565
  * <p>Time at which an Audit History event took place.</p>
566
+ * @public
567
567
  */
568
568
  performedTime: Date | undefined;
569
569
  /**
570
- * @public
571
570
  * <p>A list of Case Audit History event fields.</p>
571
+ * @public
572
572
  */
573
573
  fields: AuditEventField[] | undefined;
574
574
  /**
575
- * @public
576
575
  * <p>Information of the user which performed the audit.</p>
576
+ * @public
577
577
  */
578
578
  performedBy?: AuditEventPerformedBy;
579
579
  }
@@ -582,14 +582,14 @@ export interface AuditEvent {
582
582
  */
583
583
  export interface GetCaseAuditEventsResponse {
584
584
  /**
585
- * @public
586
585
  * <p>The token for the next set of results. This is null if there are no more results to
587
586
  * return.</p>
587
+ * @public
588
588
  */
589
589
  nextToken?: string;
590
590
  /**
591
- * @public
592
591
  * <p>A list of case audits where each represents a particular edit of the case.</p>
592
+ * @public
593
593
  */
594
594
  auditEvents: AuditEvent[] | undefined;
595
595
  }
@@ -598,40 +598,40 @@ export interface GetCaseAuditEventsResponse {
598
598
  */
599
599
  export interface ListCasesForContactRequest {
600
600
  /**
601
- * @public
602
601
  * <p>The unique identifier of the Cases domain. </p>
602
+ * @public
603
603
  */
604
604
  domainId: string | undefined;
605
605
  /**
606
- * @public
607
606
  * <p>A unique identifier of a contact in Amazon Connect.</p>
607
+ * @public
608
608
  */
609
609
  contactArn: string | undefined;
610
610
  /**
611
- * @public
612
611
  * <p>The maximum number of results to return per page.</p>
612
+ * @public
613
613
  */
614
614
  maxResults?: number;
615
615
  /**
616
- * @public
617
616
  * <p>The token for the next set of results. Use the value returned in the previous
618
617
  * response in the next request to retrieve the next set of results.</p>
618
+ * @public
619
619
  */
620
620
  nextToken?: string;
621
621
  }
622
622
  /**
623
- * @public
624
623
  * <p>Case summary information.</p>
624
+ * @public
625
625
  */
626
626
  export interface CaseSummary {
627
627
  /**
628
- * @public
629
628
  * <p>A unique identifier of the case.</p>
629
+ * @public
630
630
  */
631
631
  caseId: string | undefined;
632
632
  /**
633
- * @public
634
633
  * <p>A unique identifier of a template.</p>
634
+ * @public
635
635
  */
636
636
  templateId: string | undefined;
637
637
  }
@@ -640,13 +640,13 @@ export interface CaseSummary {
640
640
  */
641
641
  export interface ListCasesForContactResponse {
642
642
  /**
643
- * @public
644
643
  * <p>A list of Case summary information.</p>
644
+ * @public
645
645
  */
646
646
  cases: CaseSummary[] | undefined;
647
647
  /**
648
- * @public
649
648
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
649
+ * @public
650
650
  */
651
651
  nextToken?: string;
652
652
  }
@@ -662,35 +662,35 @@ export declare const CommentBodyTextType: {
662
662
  */
663
663
  export type CommentBodyTextType = (typeof CommentBodyTextType)[keyof typeof CommentBodyTextType];
664
664
  /**
665
- * @public
666
665
  * <p>Represents the content of a <code>Comment</code> to be returned to agents.</p>
666
+ * @public
667
667
  */
668
668
  export interface CommentContent {
669
669
  /**
670
- * @public
671
670
  * <p>Text in the body of a <code>Comment</code> on a case.</p>
671
+ * @public
672
672
  */
673
673
  body: string | undefined;
674
674
  /**
675
- * @public
676
675
  * <p>Type of the text in the box of a <code>Comment</code> on a case.</p>
676
+ * @public
677
677
  */
678
678
  contentType: CommentBodyTextType | undefined;
679
679
  }
680
680
  /**
681
- * @public
682
681
  * <p>An object that represents an Amazon Connect contact object. </p>
682
+ * @public
683
683
  */
684
684
  export interface Contact {
685
685
  /**
686
- * @public
687
686
  * <p>A unique identifier of a contact in Amazon Connect.</p>
687
+ * @public
688
688
  */
689
689
  contactArn: string | undefined;
690
690
  }
691
691
  /**
692
- * @public
693
692
  * <p>Represents the content of a related item to be created.</p>
693
+ * @public
694
694
  */
695
695
  export type RelatedItemInputContent = RelatedItemInputContent.CommentMember | RelatedItemInputContent.ContactMember | RelatedItemInputContent.$UnknownMember;
696
696
  /**
@@ -698,8 +698,8 @@ export type RelatedItemInputContent = RelatedItemInputContent.CommentMember | Re
698
698
  */
699
699
  export declare namespace RelatedItemInputContent {
700
700
  /**
701
- * @public
702
701
  * <p>Object representing a contact in Amazon Connect as an API request field.</p>
702
+ * @public
703
703
  */
704
704
  interface ContactMember {
705
705
  contact: Contact;
@@ -707,8 +707,8 @@ export declare namespace RelatedItemInputContent {
707
707
  $unknown?: never;
708
708
  }
709
709
  /**
710
- * @public
711
710
  * <p>Represents the content of a comment to be returned to agents.</p>
711
+ * @public
712
712
  */
713
713
  interface CommentMember {
714
714
  contact?: never;
@@ -735,28 +735,28 @@ export declare namespace RelatedItemInputContent {
735
735
  */
736
736
  export interface CreateRelatedItemRequest {
737
737
  /**
738
- * @public
739
738
  * <p>The unique identifier of the Cases domain. </p>
739
+ * @public
740
740
  */
741
741
  domainId: string | undefined;
742
742
  /**
743
- * @public
744
743
  * <p>A unique identifier of the case.</p>
744
+ * @public
745
745
  */
746
746
  caseId: string | undefined;
747
747
  /**
748
- * @public
749
748
  * <p>The type of a related item.</p>
749
+ * @public
750
750
  */
751
751
  type: RelatedItemType | undefined;
752
752
  /**
753
- * @public
754
753
  * <p>The content of a related item to be created.</p>
754
+ * @public
755
755
  */
756
756
  content: RelatedItemInputContent | undefined;
757
757
  /**
758
- * @public
759
758
  * <p>Represents the creator of the related item.</p>
759
+ * @public
760
760
  */
761
761
  performedBy?: UserUnion;
762
762
  }
@@ -765,20 +765,20 @@ export interface CreateRelatedItemRequest {
765
765
  */
766
766
  export interface CreateRelatedItemResponse {
767
767
  /**
768
- * @public
769
768
  * <p>The unique identifier of the related item.</p>
769
+ * @public
770
770
  */
771
771
  relatedItemId: string | undefined;
772
772
  /**
773
- * @public
774
773
  * <p>The Amazon Resource Name (ARN) of the related item.</p>
774
+ * @public
775
775
  */
776
776
  relatedItemArn: string | undefined;
777
777
  }
778
778
  /**
779
- * @public
780
779
  * <p>The service quota has been exceeded. For a list of service quotas, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect
781
780
  * Administrator Guide</i>.</p>
781
+ * @public
782
782
  */
783
783
  export declare class ServiceQuotaExceededException extends __BaseException {
784
784
  readonly name: "ServiceQuotaExceededException";
@@ -789,30 +789,30 @@ export declare class ServiceQuotaExceededException extends __BaseException {
789
789
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
790
790
  }
791
791
  /**
792
- * @public
793
792
  * <p>A filter for related items of type <code>Comment</code>.</p>
793
+ * @public
794
794
  */
795
795
  export interface CommentFilter {
796
796
  }
797
797
  /**
798
- * @public
799
798
  * <p>A filter for related items of type <code>Contact</code>.</p>
799
+ * @public
800
800
  */
801
801
  export interface ContactFilter {
802
802
  /**
803
- * @public
804
803
  * <p>A list of channels to filter on for related items of type <code>Contact</code>.</p>
804
+ * @public
805
805
  */
806
806
  channel?: string[];
807
807
  /**
808
- * @public
809
808
  * <p>A unique identifier of a contact in Amazon Connect.</p>
809
+ * @public
810
810
  */
811
811
  contactArn?: string;
812
812
  }
813
813
  /**
814
- * @public
815
814
  * <p>The list of types of related items and their parameters to use for filtering.</p>
815
+ * @public
816
816
  */
817
817
  export type RelatedItemTypeFilter = RelatedItemTypeFilter.CommentMember | RelatedItemTypeFilter.ContactMember | RelatedItemTypeFilter.$UnknownMember;
818
818
  /**
@@ -820,8 +820,8 @@ export type RelatedItemTypeFilter = RelatedItemTypeFilter.CommentMember | Relate
820
820
  */
821
821
  export declare namespace RelatedItemTypeFilter {
822
822
  /**
823
- * @public
824
823
  * <p>A filter for related items of type <code>Contact</code>.</p>
824
+ * @public
825
825
  */
826
826
  interface ContactMember {
827
827
  contact: ContactFilter;
@@ -829,8 +829,8 @@ export declare namespace RelatedItemTypeFilter {
829
829
  $unknown?: never;
830
830
  }
831
831
  /**
832
- * @public
833
832
  * <p>A filter for related items of type <code>Comment</code>.</p>
833
+ * @public
834
834
  */
835
835
  interface CommentMember {
836
836
  contact?: never;
@@ -857,57 +857,57 @@ export declare namespace RelatedItemTypeFilter {
857
857
  */
858
858
  export interface SearchRelatedItemsRequest {
859
859
  /**
860
- * @public
861
860
  * <p>The unique identifier of the Cases domain. </p>
861
+ * @public
862
862
  */
863
863
  domainId: string | undefined;
864
864
  /**
865
- * @public
866
865
  * <p>A unique identifier of the case.</p>
866
+ * @public
867
867
  */
868
868
  caseId: string | undefined;
869
869
  /**
870
- * @public
871
870
  * <p>The maximum number of results to return per page.</p>
871
+ * @public
872
872
  */
873
873
  maxResults?: number;
874
874
  /**
875
- * @public
876
875
  * <p>The token for the next set of results. Use the value returned in the previous
877
876
  * response in the next request to retrieve the next set of results.</p>
877
+ * @public
878
878
  */
879
879
  nextToken?: string;
880
880
  /**
881
- * @public
882
881
  * <p>The list of types of related items and their parameters to use for filtering.</p>
882
+ * @public
883
883
  */
884
884
  filters?: RelatedItemTypeFilter[];
885
885
  }
886
886
  /**
887
- * @public
888
887
  * <p>An object that represents a content of an Amazon Connect contact object.</p>
888
+ * @public
889
889
  */
890
890
  export interface ContactContent {
891
891
  /**
892
- * @public
893
892
  * <p>A unique identifier of a contact in Amazon Connect.</p>
893
+ * @public
894
894
  */
895
895
  contactArn: string | undefined;
896
896
  /**
897
- * @public
898
897
  * <p>A list of channels to filter on for related items of type <code>Contact</code>.</p>
898
+ * @public
899
899
  */
900
900
  channel: string | undefined;
901
901
  /**
902
- * @public
903
902
  * <p>The difference between the <code>InitiationTimestamp</code> and the
904
903
  * <code>DisconnectTimestamp</code> of the contact.</p>
904
+ * @public
905
905
  */
906
906
  connectedToSystemTime: Date | undefined;
907
907
  }
908
908
  /**
909
- * @public
910
909
  * <p>Represents the content of a particular type of related item.</p>
910
+ * @public
911
911
  */
912
912
  export type RelatedItemContent = RelatedItemContent.CommentMember | RelatedItemContent.ContactMember | RelatedItemContent.$UnknownMember;
913
913
  /**
@@ -915,8 +915,8 @@ export type RelatedItemContent = RelatedItemContent.CommentMember | RelatedItemC
915
915
  */
916
916
  export declare namespace RelatedItemContent {
917
917
  /**
918
- * @public
919
918
  * <p>Represents the content of a contact to be returned to agents.</p>
919
+ * @public
920
920
  */
921
921
  interface ContactMember {
922
922
  contact: ContactContent;
@@ -924,8 +924,8 @@ export declare namespace RelatedItemContent {
924
924
  $unknown?: never;
925
925
  }
926
926
  /**
927
- * @public
928
927
  * <p>Represents the content of a comment to be returned to agents.</p>
928
+ * @public
929
929
  */
930
930
  interface CommentMember {
931
931
  contact?: never;
@@ -948,38 +948,38 @@ export declare namespace RelatedItemContent {
948
948
  const visit: <T>(value: RelatedItemContent, visitor: Visitor<T>) => T;
949
949
  }
950
950
  /**
951
- * @public
952
951
  * <p>A list of items that represent RelatedItems.</p>
952
+ * @public
953
953
  */
954
954
  export interface SearchRelatedItemsResponseItem {
955
955
  /**
956
- * @public
957
956
  * <p>Unique identifier of a related item.</p>
957
+ * @public
958
958
  */
959
959
  relatedItemId: string | undefined;
960
960
  /**
961
- * @public
962
961
  * <p>Type of a related item.</p>
962
+ * @public
963
963
  */
964
964
  type: RelatedItemType | undefined;
965
965
  /**
966
- * @public
967
966
  * <p>Time at which a related item was associated with a case.</p>
967
+ * @public
968
968
  */
969
969
  associationTime: Date | undefined;
970
970
  /**
971
- * @public
972
971
  * <p>Represents the content of a particular type of related item.</p>
972
+ * @public
973
973
  */
974
974
  content: RelatedItemContent | undefined;
975
975
  /**
976
- * @public
977
976
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
977
+ * @public
978
978
  */
979
979
  tags?: Record<string, string>;
980
980
  /**
981
- * @public
982
981
  * <p>Represents the creator of the related item.</p>
982
+ * @public
983
983
  */
984
984
  performedBy?: UserUnion;
985
985
  }
@@ -988,19 +988,19 @@ export interface SearchRelatedItemsResponseItem {
988
988
  */
989
989
  export interface SearchRelatedItemsResponse {
990
990
  /**
991
- * @public
992
991
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
992
+ * @public
993
993
  */
994
994
  nextToken?: string;
995
995
  /**
996
- * @public
997
996
  * <p>A list of items related to a case. </p>
997
+ * @public
998
998
  */
999
999
  relatedItems: SearchRelatedItemsResponseItem[] | undefined;
1000
1000
  }
1001
1001
  /**
1002
- * @public
1003
1002
  * <p>A filter for fields. Only one value can be provided.</p>
1003
+ * @public
1004
1004
  */
1005
1005
  export type FieldFilter = FieldFilter.ContainsMember | FieldFilter.EqualToMember | FieldFilter.GreaterThanMember | FieldFilter.GreaterThanOrEqualToMember | FieldFilter.LessThanMember | FieldFilter.LessThanOrEqualToMember | FieldFilter.$UnknownMember;
1006
1006
  /**
@@ -1008,8 +1008,8 @@ export type FieldFilter = FieldFilter.ContainsMember | FieldFilter.EqualToMember
1008
1008
  */
1009
1009
  export declare namespace FieldFilter {
1010
1010
  /**
1011
- * @public
1012
1011
  * <p>Object containing field identifier and value information.</p>
1012
+ * @public
1013
1013
  */
1014
1014
  interface EqualToMember {
1015
1015
  equalTo: FieldValue;
@@ -1021,8 +1021,8 @@ export declare namespace FieldFilter {
1021
1021
  $unknown?: never;
1022
1022
  }
1023
1023
  /**
1024
- * @public
1025
1024
  * <p>Object containing field identifier and value information.</p>
1025
+ * @public
1026
1026
  */
1027
1027
  interface ContainsMember {
1028
1028
  equalTo?: never;
@@ -1034,8 +1034,8 @@ export declare namespace FieldFilter {
1034
1034
  $unknown?: never;
1035
1035
  }
1036
1036
  /**
1037
- * @public
1038
1037
  * <p>Object containing field identifier and value information.</p>
1038
+ * @public
1039
1039
  */
1040
1040
  interface GreaterThanMember {
1041
1041
  equalTo?: never;
@@ -1047,8 +1047,8 @@ export declare namespace FieldFilter {
1047
1047
  $unknown?: never;
1048
1048
  }
1049
1049
  /**
1050
- * @public
1051
1050
  * <p>Object containing field identifier and value information.</p>
1051
+ * @public
1052
1052
  */
1053
1053
  interface GreaterThanOrEqualToMember {
1054
1054
  equalTo?: never;
@@ -1060,8 +1060,8 @@ export declare namespace FieldFilter {
1060
1060
  $unknown?: never;
1061
1061
  }
1062
1062
  /**
1063
- * @public
1064
1063
  * <p>Object containing field identifier and value information.</p>
1064
+ * @public
1065
1065
  */
1066
1066
  interface LessThanMember {
1067
1067
  equalTo?: never;
@@ -1073,8 +1073,8 @@ export declare namespace FieldFilter {
1073
1073
  $unknown?: never;
1074
1074
  }
1075
1075
  /**
1076
- * @public
1077
1076
  * <p>Object containing field identifier and value information. </p>
1077
+ * @public
1078
1078
  */
1079
1079
  interface LessThanOrEqualToMember {
1080
1080
  equalTo?: never;
@@ -1121,44 +1121,44 @@ export declare const Order: {
1121
1121
  */
1122
1122
  export type Order = (typeof Order)[keyof typeof Order];
1123
1123
  /**
1124
- * @public
1125
1124
  * <p>A structured set of sort terms.</p>
1125
+ * @public
1126
1126
  */
1127
1127
  export interface Sort {
1128
1128
  /**
1129
- * @public
1130
1129
  * <p>Unique identifier of a field.</p>
1130
+ * @public
1131
1131
  */
1132
1132
  fieldId: string | undefined;
1133
1133
  /**
1134
- * @public
1135
1134
  * <p>A structured set of sort terms</p>
1135
+ * @public
1136
1136
  */
1137
1137
  sortOrder: Order | undefined;
1138
1138
  }
1139
1139
  /**
1140
- * @public
1141
1140
  * <p>A list of items that represent cases.</p>
1141
+ * @public
1142
1142
  */
1143
1143
  export interface SearchCasesResponseItem {
1144
1144
  /**
1145
- * @public
1146
1145
  * <p>A unique identifier of the case.</p>
1146
+ * @public
1147
1147
  */
1148
1148
  caseId: string | undefined;
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>A unique identifier of a template.</p>
1151
+ * @public
1152
1152
  */
1153
1153
  templateId: string | undefined;
1154
1154
  /**
1155
- * @public
1156
1155
  * <p>List of case field values.</p>
1156
+ * @public
1157
1157
  */
1158
1158
  fields: FieldValue[] | undefined;
1159
1159
  /**
1160
- * @public
1161
1160
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
1161
+ * @public
1162
1162
  */
1163
1163
  tags?: Record<string, string>;
1164
1164
  }
@@ -1167,14 +1167,14 @@ export interface SearchCasesResponseItem {
1167
1167
  */
1168
1168
  export interface SearchCasesResponse {
1169
1169
  /**
1170
- * @public
1171
1170
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1171
+ * @public
1172
1172
  */
1173
1173
  nextToken?: string;
1174
1174
  /**
1175
- * @public
1176
1175
  * <p>A list of case documents where each case contains the properties <code>CaseId</code> and
1177
1176
  * <code>Fields</code> where each field is a complex union structure. </p>
1177
+ * @public
1178
1178
  */
1179
1179
  cases: SearchCasesResponseItem[] | undefined;
1180
1180
  }
@@ -1183,24 +1183,24 @@ export interface SearchCasesResponse {
1183
1183
  */
1184
1184
  export interface UpdateCaseRequest {
1185
1185
  /**
1186
- * @public
1187
1186
  * <p>The unique identifier of the Cases domain. </p>
1187
+ * @public
1188
1188
  */
1189
1189
  domainId: string | undefined;
1190
1190
  /**
1191
- * @public
1192
1191
  * <p>A unique identifier of the case.</p>
1192
+ * @public
1193
1193
  */
1194
1194
  caseId: string | undefined;
1195
1195
  /**
1196
- * @public
1197
1196
  * <p>An array of objects with <code>fieldId</code> (matching ListFields/DescribeField) and
1198
1197
  * value union data, structured identical to <code>CreateCase</code>.</p>
1198
+ * @public
1199
1199
  */
1200
1200
  fields: FieldValue[] | undefined;
1201
1201
  /**
1202
- * @public
1203
1202
  * <p>Represents the identity of the person who performed the action.</p>
1203
+ * @public
1204
1204
  */
1205
1205
  performedBy?: UserUnion;
1206
1206
  }
@@ -1214,9 +1214,9 @@ export interface UpdateCaseResponse {
1214
1214
  */
1215
1215
  export interface CreateDomainRequest {
1216
1216
  /**
1217
- * @public
1218
1217
  * <p>The name for your Cases domain. It must be unique for your Amazon Web Services
1219
1218
  * account.</p>
1219
+ * @public
1220
1220
  */
1221
1221
  name: string | undefined;
1222
1222
  }
@@ -1238,18 +1238,18 @@ export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus];
1238
1238
  */
1239
1239
  export interface CreateDomainResponse {
1240
1240
  /**
1241
- * @public
1242
1241
  * <p>The unique identifier of the Cases domain. </p>
1242
+ * @public
1243
1243
  */
1244
1244
  domainId: string | undefined;
1245
1245
  /**
1246
- * @public
1247
1246
  * <p>The Amazon Resource Name (ARN) for the Cases domain.</p>
1247
+ * @public
1248
1248
  */
1249
1249
  domainArn: string | undefined;
1250
1250
  /**
1251
- * @public
1252
1251
  * <p>The status of the domain.</p>
1252
+ * @public
1253
1253
  */
1254
1254
  domainStatus: DomainStatus | undefined;
1255
1255
  }
@@ -1258,8 +1258,8 @@ export interface CreateDomainResponse {
1258
1258
  */
1259
1259
  export interface DeleteDomainRequest {
1260
1260
  /**
1261
- * @public
1262
1261
  * <p>The unique identifier of the Cases domain. </p>
1262
+ * @public
1263
1263
  */
1264
1264
  domainId: string | undefined;
1265
1265
  }
@@ -1273,65 +1273,65 @@ export interface DeleteDomainResponse {
1273
1273
  */
1274
1274
  export interface GetCaseEventConfigurationRequest {
1275
1275
  /**
1276
- * @public
1277
1276
  * <p>The unique identifier of the Cases domain. </p>
1277
+ * @public
1278
1278
  */
1279
1279
  domainId: string | undefined;
1280
1280
  }
1281
1281
  /**
1282
- * @public
1283
1282
  * <p>Details of what case data is published through the case event stream.</p>
1283
+ * @public
1284
1284
  */
1285
1285
  export interface CaseEventIncludedData {
1286
1286
  /**
1287
- * @public
1288
1287
  * <p>List of field identifiers.</p>
1288
+ * @public
1289
1289
  */
1290
1290
  fields: FieldIdentifier[] | undefined;
1291
1291
  }
1292
1292
  /**
1293
- * @public
1294
1293
  * <p>Details of what related item data is published through the case event stream.</p>
1294
+ * @public
1295
1295
  */
1296
1296
  export interface RelatedItemEventIncludedData {
1297
1297
  /**
1298
- * @public
1299
1298
  * <p>Details of what related item data is published through the case event stream.</p>
1299
+ * @public
1300
1300
  */
1301
1301
  includeContent: boolean | undefined;
1302
1302
  }
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>Details of what case and related item data is published through the case event
1306
1305
  * stream.</p>
1306
+ * @public
1307
1307
  */
1308
1308
  export interface EventIncludedData {
1309
1309
  /**
1310
- * @public
1311
1310
  * <p>Details of what case data is published through the case event stream.</p>
1311
+ * @public
1312
1312
  */
1313
1313
  caseData?: CaseEventIncludedData;
1314
1314
  /**
1315
- * @public
1316
1315
  * <p>Details of what related item data is published through the case event stream.</p>
1316
+ * @public
1317
1317
  */
1318
1318
  relatedItemData?: RelatedItemEventIncludedData;
1319
1319
  }
1320
1320
  /**
1321
- * @public
1322
1321
  * <p>Configuration to enable EventBridge case event delivery and determine what data is
1323
1322
  * delivered.</p>
1323
+ * @public
1324
1324
  */
1325
1325
  export interface EventBridgeConfiguration {
1326
1326
  /**
1327
- * @public
1328
1327
  * <p>Indicates whether the to broadcast case event data to the customer.</p>
1328
+ * @public
1329
1329
  */
1330
1330
  enabled: boolean | undefined;
1331
1331
  /**
1332
- * @public
1333
1332
  * <p>Details of what case and related item data is published through the case event
1334
1333
  * stream.</p>
1334
+ * @public
1335
1335
  */
1336
1336
  includedData?: EventIncludedData;
1337
1337
  }
@@ -1340,9 +1340,9 @@ export interface EventBridgeConfiguration {
1340
1340
  */
1341
1341
  export interface GetCaseEventConfigurationResponse {
1342
1342
  /**
1343
- * @public
1344
1343
  * <p>Configuration to enable EventBridge case event delivery and determine what data is
1345
1344
  * delivered.</p>
1345
+ * @public
1346
1346
  */
1347
1347
  eventBridge: EventBridgeConfiguration | undefined;
1348
1348
  }
@@ -1351,8 +1351,8 @@ export interface GetCaseEventConfigurationResponse {
1351
1351
  */
1352
1352
  export interface GetDomainRequest {
1353
1353
  /**
1354
- * @public
1355
1354
  * <p>The unique identifier of the Cases domain. </p>
1355
+ * @public
1356
1356
  */
1357
1357
  domainId: string | undefined;
1358
1358
  }
@@ -1361,33 +1361,33 @@ export interface GetDomainRequest {
1361
1361
  */
1362
1362
  export interface GetDomainResponse {
1363
1363
  /**
1364
- * @public
1365
1364
  * <p>The unique identifier of the Cases domain. </p>
1365
+ * @public
1366
1366
  */
1367
1367
  domainId: string | undefined;
1368
1368
  /**
1369
- * @public
1370
1369
  * <p>The Amazon Resource Name (ARN) for the Cases domain.</p>
1370
+ * @public
1371
1371
  */
1372
1372
  domainArn: string | undefined;
1373
1373
  /**
1374
- * @public
1375
1374
  * <p>The name of the Cases domain.</p>
1375
+ * @public
1376
1376
  */
1377
1377
  name: string | undefined;
1378
1378
  /**
1379
- * @public
1380
1379
  * <p>The timestamp when the Cases domain was created.</p>
1380
+ * @public
1381
1381
  */
1382
1382
  createdTime: Date | undefined;
1383
1383
  /**
1384
- * @public
1385
1384
  * <p>The status of the Cases domain.</p>
1385
+ * @public
1386
1386
  */
1387
1387
  domainStatus: DomainStatus | undefined;
1388
1388
  /**
1389
- * @public
1390
1389
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
1390
+ * @public
1391
1391
  */
1392
1392
  tags?: Record<string, string>;
1393
1393
  }
@@ -1396,35 +1396,35 @@ export interface GetDomainResponse {
1396
1396
  */
1397
1397
  export interface ListDomainsRequest {
1398
1398
  /**
1399
- * @public
1400
1399
  * <p>The maximum number of results to return per page.</p>
1400
+ * @public
1401
1401
  */
1402
1402
  maxResults?: number;
1403
1403
  /**
1404
- * @public
1405
1404
  * <p>The token for the next set of results. Use the value returned in the previous
1406
1405
  * response in the next request to retrieve the next set of results.</p>
1406
+ * @public
1407
1407
  */
1408
1408
  nextToken?: string;
1409
1409
  }
1410
1410
  /**
1411
- * @public
1412
1411
  * <p>Object for the summarized details of the domain.</p>
1412
+ * @public
1413
1413
  */
1414
1414
  export interface DomainSummary {
1415
1415
  /**
1416
- * @public
1417
1416
  * <p>The unique identifier of the domain.</p>
1417
+ * @public
1418
1418
  */
1419
1419
  domainId: string | undefined;
1420
1420
  /**
1421
- * @public
1422
1421
  * <p>The Amazon Resource Name (ARN) of the domain.</p>
1422
+ * @public
1423
1423
  */
1424
1424
  domainArn: string | undefined;
1425
1425
  /**
1426
- * @public
1427
1426
  * <p>The name of the domain.</p>
1427
+ * @public
1428
1428
  */
1429
1429
  name: string | undefined;
1430
1430
  }
@@ -1433,13 +1433,13 @@ export interface DomainSummary {
1433
1433
  */
1434
1434
  export interface ListDomainsResponse {
1435
1435
  /**
1436
- * @public
1437
1436
  * <p>The Cases domain.</p>
1437
+ * @public
1438
1438
  */
1439
1439
  domains: DomainSummary[] | undefined;
1440
1440
  /**
1441
- * @public
1442
1441
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1442
+ * @public
1443
1443
  */
1444
1444
  nextToken?: string;
1445
1445
  }
@@ -1448,14 +1448,14 @@ export interface ListDomainsResponse {
1448
1448
  */
1449
1449
  export interface PutCaseEventConfigurationRequest {
1450
1450
  /**
1451
- * @public
1452
1451
  * <p>The unique identifier of the Cases domain. </p>
1452
+ * @public
1453
1453
  */
1454
1454
  domainId: string | undefined;
1455
1455
  /**
1456
- * @public
1457
1456
  * <p>Configuration to enable EventBridge case event delivery and determine what data is
1458
1457
  * delivered.</p>
1458
+ * @public
1459
1459
  */
1460
1460
  eventBridge: EventBridgeConfiguration | undefined;
1461
1461
  }
@@ -1469,34 +1469,34 @@ export interface PutCaseEventConfigurationResponse {
1469
1469
  */
1470
1470
  export interface BatchGetFieldRequest {
1471
1471
  /**
1472
- * @public
1473
1472
  * <p>The unique identifier of the Cases domain. </p>
1473
+ * @public
1474
1474
  */
1475
1475
  domainId: string | undefined;
1476
1476
  /**
1477
- * @public
1478
1477
  * <p>A list of unique field identifiers. </p>
1478
+ * @public
1479
1479
  */
1480
1480
  fields: FieldIdentifier[] | undefined;
1481
1481
  }
1482
1482
  /**
1483
- * @public
1484
1483
  * <p>Object for errors on fields.</p>
1484
+ * @public
1485
1485
  */
1486
1486
  export interface FieldError {
1487
1487
  /**
1488
- * @public
1489
1488
  * <p>The field identifier that caused the error.</p>
1489
+ * @public
1490
1490
  */
1491
1491
  id: string | undefined;
1492
1492
  /**
1493
- * @public
1494
1493
  * <p>The error code from getting a field.</p>
1494
+ * @public
1495
1495
  */
1496
1496
  errorCode: string | undefined;
1497
1497
  /**
1498
- * @public
1499
1498
  * <p>The error message from getting a field.</p>
1499
+ * @public
1500
1500
  */
1501
1501
  message?: string;
1502
1502
  }
@@ -1530,43 +1530,43 @@ export declare const FieldType: {
1530
1530
  */
1531
1531
  export type FieldType = (typeof FieldType)[keyof typeof FieldType];
1532
1532
  /**
1533
- * @public
1534
1533
  * <p>Object to store detailed field information.</p>
1534
+ * @public
1535
1535
  */
1536
1536
  export interface GetFieldResponse {
1537
1537
  /**
1538
- * @public
1539
1538
  * <p>Unique identifier of the field.</p>
1539
+ * @public
1540
1540
  */
1541
1541
  fieldId: string | undefined;
1542
1542
  /**
1543
- * @public
1544
1543
  * <p>Name of the field.</p>
1544
+ * @public
1545
1545
  */
1546
1546
  name: string | undefined;
1547
1547
  /**
1548
- * @public
1549
1548
  * <p>The Amazon Resource Name (ARN) of the field.</p>
1549
+ * @public
1550
1550
  */
1551
1551
  fieldArn: string | undefined;
1552
1552
  /**
1553
- * @public
1554
1553
  * <p>Description of the field.</p>
1554
+ * @public
1555
1555
  */
1556
1556
  description?: string;
1557
1557
  /**
1558
- * @public
1559
1558
  * <p>Type of the field.</p>
1559
+ * @public
1560
1560
  */
1561
1561
  type: FieldType | undefined;
1562
1562
  /**
1563
- * @public
1564
1563
  * <p>Namespace of the field.</p>
1564
+ * @public
1565
1565
  */
1566
1566
  namespace: FieldNamespace | undefined;
1567
1567
  /**
1568
- * @public
1569
1568
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
1569
+ * @public
1570
1570
  */
1571
1571
  tags?: Record<string, string>;
1572
1572
  }
@@ -1575,37 +1575,37 @@ export interface GetFieldResponse {
1575
1575
  */
1576
1576
  export interface BatchGetFieldResponse {
1577
1577
  /**
1578
- * @public
1579
1578
  * <p>A list of detailed field information. </p>
1579
+ * @public
1580
1580
  */
1581
1581
  fields: GetFieldResponse[] | undefined;
1582
1582
  /**
1583
- * @public
1584
1583
  * <p>A list of field errors. </p>
1584
+ * @public
1585
1585
  */
1586
1586
  errors: FieldError[] | undefined;
1587
1587
  }
1588
1588
  /**
1589
- * @public
1590
1589
  * <p>Object for field Options information.</p>
1590
+ * @public
1591
1591
  */
1592
1592
  export interface FieldOption {
1593
1593
  /**
1594
- * @public
1595
1594
  * <p>
1596
1595
  * <code>FieldOptionName</code> has max length 100 and disallows trailing spaces.</p>
1596
+ * @public
1597
1597
  */
1598
1598
  name: string | undefined;
1599
1599
  /**
1600
- * @public
1601
1600
  * <p>
1602
1601
  * <code>FieldOptionValue</code> has max length 100 and must be alphanumeric with hyphens and
1603
1602
  * underscores.</p>
1603
+ * @public
1604
1604
  */
1605
1605
  value: string | undefined;
1606
1606
  /**
1607
- * @public
1608
1607
  * <p>Describes whether the <code>FieldOption</code> is active (displayed) or inactive.</p>
1608
+ * @public
1609
1609
  */
1610
1610
  active: boolean | undefined;
1611
1611
  }
@@ -1614,39 +1614,39 @@ export interface FieldOption {
1614
1614
  */
1615
1615
  export interface BatchPutFieldOptionsRequest {
1616
1616
  /**
1617
- * @public
1618
1617
  * <p>The unique identifier of the Cases domain. </p>
1618
+ * @public
1619
1619
  */
1620
1620
  domainId: string | undefined;
1621
1621
  /**
1622
- * @public
1623
1622
  * <p>The unique identifier of a field.</p>
1623
+ * @public
1624
1624
  */
1625
1625
  fieldId: string | undefined;
1626
1626
  /**
1627
- * @public
1628
1627
  * <p>A list of <code>FieldOption</code> objects.</p>
1628
+ * @public
1629
1629
  */
1630
1630
  options: FieldOption[] | undefined;
1631
1631
  }
1632
1632
  /**
1633
- * @public
1634
1633
  * <p>Object for field Options errors.</p>
1634
+ * @public
1635
1635
  */
1636
1636
  export interface FieldOptionError {
1637
1637
  /**
1638
- * @public
1639
1638
  * <p>Error message from creating or updating field option.</p>
1639
+ * @public
1640
1640
  */
1641
1641
  message: string | undefined;
1642
1642
  /**
1643
- * @public
1644
1643
  * <p>Error code from creating or updating field option.</p>
1644
+ * @public
1645
1645
  */
1646
1646
  errorCode: string | undefined;
1647
1647
  /**
1648
- * @public
1649
1648
  * <p>The field option value that caused the error.</p>
1649
+ * @public
1650
1650
  */
1651
1651
  value: string | undefined;
1652
1652
  }
@@ -1655,8 +1655,8 @@ export interface FieldOptionError {
1655
1655
  */
1656
1656
  export interface BatchPutFieldOptionsResponse {
1657
1657
  /**
1658
- * @public
1659
1658
  * <p>A list of field errors. </p>
1659
+ * @public
1660
1660
  */
1661
1661
  errors?: FieldOptionError[];
1662
1662
  }
@@ -1665,23 +1665,23 @@ export interface BatchPutFieldOptionsResponse {
1665
1665
  */
1666
1666
  export interface CreateFieldRequest {
1667
1667
  /**
1668
- * @public
1669
1668
  * <p>The unique identifier of the Cases domain. </p>
1669
+ * @public
1670
1670
  */
1671
1671
  domainId: string | undefined;
1672
1672
  /**
1673
- * @public
1674
1673
  * <p>The name of the field.</p>
1674
+ * @public
1675
1675
  */
1676
1676
  name: string | undefined;
1677
1677
  /**
1678
- * @public
1679
1678
  * <p>Defines the data type, some system constraints, and default display of the field.</p>
1679
+ * @public
1680
1680
  */
1681
1681
  type: FieldType | undefined;
1682
1682
  /**
1683
- * @public
1684
1683
  * <p>The description of the field.</p>
1684
+ * @public
1685
1685
  */
1686
1686
  description?: string;
1687
1687
  }
@@ -1690,13 +1690,13 @@ export interface CreateFieldRequest {
1690
1690
  */
1691
1691
  export interface CreateFieldResponse {
1692
1692
  /**
1693
- * @public
1694
1693
  * <p>The unique identifier of a field.</p>
1694
+ * @public
1695
1695
  */
1696
1696
  fieldId: string | undefined;
1697
1697
  /**
1698
- * @public
1699
1698
  * <p>The Amazon Resource Name (ARN) of the field.</p>
1699
+ * @public
1700
1700
  */
1701
1701
  fieldArn: string | undefined;
1702
1702
  }
@@ -1705,30 +1705,30 @@ export interface CreateFieldResponse {
1705
1705
  */
1706
1706
  export interface ListFieldOptionsRequest {
1707
1707
  /**
1708
- * @public
1709
1708
  * <p>The unique identifier of the Cases domain. </p>
1709
+ * @public
1710
1710
  */
1711
1711
  domainId: string | undefined;
1712
1712
  /**
1713
- * @public
1714
1713
  * <p>The unique identifier of a field.</p>
1714
+ * @public
1715
1715
  */
1716
1716
  fieldId: string | undefined;
1717
1717
  /**
1718
- * @public
1719
1718
  * <p>The maximum number of results to return per page.</p>
1719
+ * @public
1720
1720
  */
1721
1721
  maxResults?: number;
1722
1722
  /**
1723
- * @public
1724
1723
  * <p>The token for the next set of results. Use the value returned in the previous
1725
1724
  * response in the next request to retrieve the next set of results.</p>
1725
+ * @public
1726
1726
  */
1727
1727
  nextToken?: string;
1728
1728
  /**
1729
- * @public
1730
1729
  * <p>A list of <code>FieldOption</code> values to filter on for
1731
1730
  * <code>ListFieldOptions</code>.</p>
1731
+ * @public
1732
1732
  */
1733
1733
  values?: string[];
1734
1734
  }
@@ -1737,13 +1737,13 @@ export interface ListFieldOptionsRequest {
1737
1737
  */
1738
1738
  export interface ListFieldOptionsResponse {
1739
1739
  /**
1740
- * @public
1741
1740
  * <p>A list of <code>FieldOption</code> objects.</p>
1741
+ * @public
1742
1742
  */
1743
1743
  options: FieldOption[] | undefined;
1744
1744
  /**
1745
- * @public
1746
1745
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1746
+ * @public
1747
1747
  */
1748
1748
  nextToken?: string;
1749
1749
  }
@@ -1752,50 +1752,50 @@ export interface ListFieldOptionsResponse {
1752
1752
  */
1753
1753
  export interface ListFieldsRequest {
1754
1754
  /**
1755
- * @public
1756
1755
  * <p>The unique identifier of the Cases domain. </p>
1756
+ * @public
1757
1757
  */
1758
1758
  domainId: string | undefined;
1759
1759
  /**
1760
- * @public
1761
1760
  * <p>The maximum number of results to return per page.</p>
1761
+ * @public
1762
1762
  */
1763
1763
  maxResults?: number;
1764
1764
  /**
1765
- * @public
1766
1765
  * <p>The token for the next set of results. Use the value returned in the previous
1767
1766
  * response in the next request to retrieve the next set of results.</p>
1767
+ * @public
1768
1768
  */
1769
1769
  nextToken?: string;
1770
1770
  }
1771
1771
  /**
1772
- * @public
1773
1772
  * <p>Object for the summarized details of the field.</p>
1773
+ * @public
1774
1774
  */
1775
1775
  export interface FieldSummary {
1776
1776
  /**
1777
- * @public
1778
1777
  * <p>The unique identifier of a field.</p>
1778
+ * @public
1779
1779
  */
1780
1780
  fieldId: string | undefined;
1781
1781
  /**
1782
- * @public
1783
1782
  * <p>The Amazon Resource Name (ARN) of the field.</p>
1783
+ * @public
1784
1784
  */
1785
1785
  fieldArn: string | undefined;
1786
1786
  /**
1787
- * @public
1788
1787
  * <p>Name of the field.</p>
1788
+ * @public
1789
1789
  */
1790
1790
  name: string | undefined;
1791
1791
  /**
1792
- * @public
1793
1792
  * <p>The type of a field.</p>
1793
+ * @public
1794
1794
  */
1795
1795
  type: FieldType | undefined;
1796
1796
  /**
1797
- * @public
1798
1797
  * <p>The namespace of a field.</p>
1798
+ * @public
1799
1799
  */
1800
1800
  namespace: FieldNamespace | undefined;
1801
1801
  }
@@ -1804,13 +1804,13 @@ export interface FieldSummary {
1804
1804
  */
1805
1805
  export interface ListFieldsResponse {
1806
1806
  /**
1807
- * @public
1808
1807
  * <p>List of detailed field information.</p>
1808
+ * @public
1809
1809
  */
1810
1810
  fields: FieldSummary[] | undefined;
1811
1811
  /**
1812
- * @public
1813
1812
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1813
+ * @public
1814
1814
  */
1815
1815
  nextToken?: string;
1816
1816
  }
@@ -1819,23 +1819,23 @@ export interface ListFieldsResponse {
1819
1819
  */
1820
1820
  export interface UpdateFieldRequest {
1821
1821
  /**
1822
- * @public
1823
1822
  * <p>The unique identifier of the Cases domain. </p>
1823
+ * @public
1824
1824
  */
1825
1825
  domainId: string | undefined;
1826
1826
  /**
1827
- * @public
1828
1827
  * <p>The unique identifier of a field.</p>
1828
+ * @public
1829
1829
  */
1830
1830
  fieldId: string | undefined;
1831
1831
  /**
1832
- * @public
1833
1832
  * <p>The name of the field.</p>
1833
+ * @public
1834
1834
  */
1835
1835
  name?: string;
1836
1836
  /**
1837
- * @public
1838
1837
  * <p>The description of a field.</p>
1838
+ * @public
1839
1839
  */
1840
1840
  description?: string;
1841
1841
  }
@@ -1845,35 +1845,35 @@ export interface UpdateFieldRequest {
1845
1845
  export interface UpdateFieldResponse {
1846
1846
  }
1847
1847
  /**
1848
- * @public
1849
1848
  * <p>Object for field related information.</p>
1849
+ * @public
1850
1850
  */
1851
1851
  export interface FieldItem {
1852
1852
  /**
1853
- * @public
1854
1853
  * <p>Unique identifier of a field.</p>
1854
+ * @public
1855
1855
  */
1856
1856
  id: string | undefined;
1857
1857
  }
1858
1858
  /**
1859
- * @public
1860
1859
  * <p>Object for a group of fields and associated properties.</p>
1860
+ * @public
1861
1861
  */
1862
1862
  export interface FieldGroup {
1863
1863
  /**
1864
- * @public
1865
1864
  * <p>Name of the field group.</p>
1865
+ * @public
1866
1866
  */
1867
1867
  name?: string;
1868
1868
  /**
1869
- * @public
1870
1869
  * <p>Represents an ordered list containing field related information.</p>
1870
+ * @public
1871
1871
  */
1872
1872
  fields: FieldItem[] | undefined;
1873
1873
  }
1874
1874
  /**
1875
- * @public
1876
1875
  * <p>This represents a sections within a panel or tab of the page layout.</p>
1876
+ * @public
1877
1877
  */
1878
1878
  export type Section = Section.FieldGroupMember | Section.$UnknownMember;
1879
1879
  /**
@@ -1881,8 +1881,8 @@ export type Section = Section.FieldGroupMember | Section.$UnknownMember;
1881
1881
  */
1882
1882
  export declare namespace Section {
1883
1883
  /**
1884
- * @public
1885
1884
  * <p>Consists of a group of fields and associated properties.</p>
1885
+ * @public
1886
1886
  */
1887
1887
  interface FieldGroupMember {
1888
1888
  fieldGroup: FieldGroup;
@@ -1902,37 +1902,37 @@ export declare namespace Section {
1902
1902
  const visit: <T>(value: Section, visitor: Visitor<T>) => T;
1903
1903
  }
1904
1904
  /**
1905
- * @public
1906
1905
  * <p>Ordered list containing different kinds of sections that can be added. A LayoutSections
1907
1906
  * object can only contain one section.</p>
1907
+ * @public
1908
1908
  */
1909
1909
  export interface LayoutSections {
1910
1910
  /**
1911
- * @public
1912
1911
  * <p>Ordered list containing different kinds of sections that can be added.</p>
1912
+ * @public
1913
1913
  */
1914
1914
  sections?: Section[];
1915
1915
  }
1916
1916
  /**
1917
- * @public
1918
1917
  * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel
1919
1918
  * and More Info tab of agent application. </p>
1919
+ * @public
1920
1920
  */
1921
1921
  export interface BasicLayout {
1922
1922
  /**
1923
- * @public
1924
1923
  * <p>This represents sections in a panel of the page layout.</p>
1924
+ * @public
1925
1925
  */
1926
1926
  topPanel?: LayoutSections;
1927
1927
  /**
1928
- * @public
1929
1928
  * <p>This represents sections in a tab of the page layout.</p>
1929
+ * @public
1930
1930
  */
1931
1931
  moreInfo?: LayoutSections;
1932
1932
  }
1933
1933
  /**
1934
- * @public
1935
1934
  * <p>Object to store union of different versions of layout content.</p>
1935
+ * @public
1936
1936
  */
1937
1937
  export type LayoutContent = LayoutContent.BasicMember | LayoutContent.$UnknownMember;
1938
1938
  /**
@@ -1940,9 +1940,9 @@ export type LayoutContent = LayoutContent.BasicMember | LayoutContent.$UnknownMe
1940
1940
  */
1941
1941
  export declare namespace LayoutContent {
1942
1942
  /**
1943
- * @public
1944
1943
  * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel
1945
1944
  * and More Info tab of Cases user interface.</p>
1945
+ * @public
1946
1946
  */
1947
1947
  interface BasicMember {
1948
1948
  basic: BasicLayout;
@@ -1966,19 +1966,19 @@ export declare namespace LayoutContent {
1966
1966
  */
1967
1967
  export interface CreateLayoutRequest {
1968
1968
  /**
1969
- * @public
1970
1969
  * <p>The unique identifier of the Cases domain. </p>
1970
+ * @public
1971
1971
  */
1972
1972
  domainId: string | undefined;
1973
1973
  /**
1974
- * @public
1975
1974
  * <p>The name of the layout. It must be unique for the Cases domain.</p>
1975
+ * @public
1976
1976
  */
1977
1977
  name: string | undefined;
1978
1978
  /**
1979
- * @public
1980
1979
  * <p>Information about which fields will be present in the layout, and information about the
1981
1980
  * order of the fields.</p>
1981
+ * @public
1982
1982
  */
1983
1983
  content: LayoutContent | undefined;
1984
1984
  }
@@ -1987,13 +1987,13 @@ export interface CreateLayoutRequest {
1987
1987
  */
1988
1988
  export interface CreateLayoutResponse {
1989
1989
  /**
1990
- * @public
1991
1990
  * <p>The unique identifier of the layout.</p>
1991
+ * @public
1992
1992
  */
1993
1993
  layoutId: string | undefined;
1994
1994
  /**
1995
- * @public
1996
1995
  * <p>The Amazon Resource Name (ARN) of the newly created layout.</p>
1996
+ * @public
1997
1997
  */
1998
1998
  layoutArn: string | undefined;
1999
1999
  }
@@ -2002,13 +2002,13 @@ export interface CreateLayoutResponse {
2002
2002
  */
2003
2003
  export interface GetLayoutRequest {
2004
2004
  /**
2005
- * @public
2006
2005
  * <p>The unique identifier of the Cases domain. </p>
2006
+ * @public
2007
2007
  */
2008
2008
  domainId: string | undefined;
2009
2009
  /**
2010
- * @public
2011
2010
  * <p>The unique identifier of the layout.</p>
2011
+ * @public
2012
2012
  */
2013
2013
  layoutId: string | undefined;
2014
2014
  }
@@ -2017,29 +2017,29 @@ export interface GetLayoutRequest {
2017
2017
  */
2018
2018
  export interface GetLayoutResponse {
2019
2019
  /**
2020
- * @public
2021
2020
  * <p>The unique identifier of the layout.</p>
2021
+ * @public
2022
2022
  */
2023
2023
  layoutId: string | undefined;
2024
2024
  /**
2025
- * @public
2026
2025
  * <p>The Amazon Resource Name (ARN) of the newly created layout.</p>
2026
+ * @public
2027
2027
  */
2028
2028
  layoutArn: string | undefined;
2029
2029
  /**
2030
- * @public
2031
2030
  * <p>The name of the layout. It must be unique.</p>
2031
+ * @public
2032
2032
  */
2033
2033
  name: string | undefined;
2034
2034
  /**
2035
- * @public
2036
2035
  * <p>Information about which fields will be present in the layout, the order of the fields, and
2037
2036
  * read-only attribute of the field. </p>
2037
+ * @public
2038
2038
  */
2039
2039
  content: LayoutContent | undefined;
2040
2040
  /**
2041
- * @public
2042
2041
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
2042
+ * @public
2043
2043
  */
2044
2044
  tags?: Record<string, string>;
2045
2045
  }
@@ -2048,40 +2048,40 @@ export interface GetLayoutResponse {
2048
2048
  */
2049
2049
  export interface ListLayoutsRequest {
2050
2050
  /**
2051
- * @public
2052
2051
  * <p>The unique identifier of the Cases domain. </p>
2052
+ * @public
2053
2053
  */
2054
2054
  domainId: string | undefined;
2055
2055
  /**
2056
- * @public
2057
2056
  * <p>The maximum number of results to return per page.</p>
2057
+ * @public
2058
2058
  */
2059
2059
  maxResults?: number;
2060
2060
  /**
2061
- * @public
2062
2061
  * <p>The token for the next set of results. Use the value returned in the previous
2063
2062
  * response in the next request to retrieve the next set of results.</p>
2063
+ * @public
2064
2064
  */
2065
2065
  nextToken?: string;
2066
2066
  }
2067
2067
  /**
2068
- * @public
2069
2068
  * <p>Object for the summarized details of the layout.</p>
2069
+ * @public
2070
2070
  */
2071
2071
  export interface LayoutSummary {
2072
2072
  /**
2073
- * @public
2074
2073
  * <p>The unique identifier for of the layout.</p>
2074
+ * @public
2075
2075
  */
2076
2076
  layoutId: string | undefined;
2077
2077
  /**
2078
- * @public
2079
2078
  * <p>The Amazon Resource Name (ARN) of the layout.</p>
2079
+ * @public
2080
2080
  */
2081
2081
  layoutArn: string | undefined;
2082
2082
  /**
2083
- * @public
2084
2083
  * <p>The name of the layout.</p>
2084
+ * @public
2085
2085
  */
2086
2086
  name: string | undefined;
2087
2087
  }
@@ -2090,13 +2090,13 @@ export interface LayoutSummary {
2090
2090
  */
2091
2091
  export interface ListLayoutsResponse {
2092
2092
  /**
2093
- * @public
2094
2093
  * <p>The layouts for the domain.</p>
2094
+ * @public
2095
2095
  */
2096
2096
  layouts: LayoutSummary[] | undefined;
2097
2097
  /**
2098
- * @public
2099
2098
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
2099
+ * @public
2100
2100
  */
2101
2101
  nextToken?: string;
2102
2102
  }
@@ -2105,24 +2105,24 @@ export interface ListLayoutsResponse {
2105
2105
  */
2106
2106
  export interface UpdateLayoutRequest {
2107
2107
  /**
2108
- * @public
2109
2108
  * <p>The unique identifier of the Cases domain. </p>
2109
+ * @public
2110
2110
  */
2111
2111
  domainId: string | undefined;
2112
2112
  /**
2113
- * @public
2114
2113
  * <p>The unique identifier of the layout.</p>
2114
+ * @public
2115
2115
  */
2116
2116
  layoutId: string | undefined;
2117
2117
  /**
2118
- * @public
2119
2118
  * <p>The name of the layout. It must be unique per domain.</p>
2119
+ * @public
2120
2120
  */
2121
2121
  name?: string;
2122
2122
  /**
2123
- * @public
2124
2123
  * <p>Information about which fields will be present in the layout, the order of the
2125
2124
  * fields.</p>
2125
+ * @public
2126
2126
  */
2127
2127
  content?: LayoutContent;
2128
2128
  }
@@ -2136,8 +2136,8 @@ export interface UpdateLayoutResponse {
2136
2136
  */
2137
2137
  export interface ListTagsForResourceRequest {
2138
2138
  /**
2139
- * @public
2140
2139
  * <p>The Amazon Resource Name (ARN)</p>
2140
+ * @public
2141
2141
  */
2142
2142
  arn: string | undefined;
2143
2143
  }
@@ -2146,8 +2146,8 @@ export interface ListTagsForResourceRequest {
2146
2146
  */
2147
2147
  export interface ListTagsForResourceResponse {
2148
2148
  /**
2149
- * @public
2150
2149
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
2150
+ * @public
2151
2151
  */
2152
2152
  tags?: Record<string, string>;
2153
2153
  }
@@ -2156,35 +2156,35 @@ export interface ListTagsForResourceResponse {
2156
2156
  */
2157
2157
  export interface TagResourceRequest {
2158
2158
  /**
2159
- * @public
2160
2159
  * <p>The Amazon Resource Name (ARN)</p>
2160
+ * @public
2161
2161
  */
2162
2162
  arn: string | undefined;
2163
2163
  /**
2164
- * @public
2165
2164
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
2165
+ * @public
2166
2166
  */
2167
2167
  tags: Record<string, string> | undefined;
2168
2168
  }
2169
2169
  /**
2170
- * @public
2171
2170
  * <p>Object to store configuration of layouts associated to the template.</p>
2171
+ * @public
2172
2172
  */
2173
2173
  export interface LayoutConfiguration {
2174
2174
  /**
2175
- * @public
2176
2175
  * <p> Unique identifier of a layout. </p>
2176
+ * @public
2177
2177
  */
2178
2178
  defaultLayout?: string;
2179
2179
  }
2180
2180
  /**
2181
- * @public
2182
2181
  * <p>List of fields that must have a value provided to create a case.</p>
2182
+ * @public
2183
2183
  */
2184
2184
  export interface RequiredField {
2185
2185
  /**
2186
- * @public
2187
2186
  * <p>Unique identifier of a field.</p>
2187
+ * @public
2188
2188
  */
2189
2189
  fieldId: string | undefined;
2190
2190
  }
@@ -2205,34 +2205,34 @@ export type TemplateStatus = (typeof TemplateStatus)[keyof typeof TemplateStatus
2205
2205
  */
2206
2206
  export interface CreateTemplateRequest {
2207
2207
  /**
2208
- * @public
2209
2208
  * <p>The unique identifier of the Cases domain. </p>
2209
+ * @public
2210
2210
  */
2211
2211
  domainId: string | undefined;
2212
2212
  /**
2213
- * @public
2214
2213
  * <p>A name for the template. It must be unique per domain.</p>
2214
+ * @public
2215
2215
  */
2216
2216
  name: string | undefined;
2217
2217
  /**
2218
- * @public
2219
2218
  * <p>A brief description of the template.</p>
2219
+ * @public
2220
2220
  */
2221
2221
  description?: string;
2222
2222
  /**
2223
- * @public
2224
2223
  * <p>Configuration of layouts associated to the template.</p>
2224
+ * @public
2225
2225
  */
2226
2226
  layoutConfiguration?: LayoutConfiguration;
2227
2227
  /**
2228
- * @public
2229
2228
  * <p>A list of fields that must contain a value for a case to be successfully created with this
2230
2229
  * template.</p>
2230
+ * @public
2231
2231
  */
2232
2232
  requiredFields?: RequiredField[];
2233
2233
  /**
2234
- * @public
2235
2234
  * <p>The status of the template.</p>
2235
+ * @public
2236
2236
  */
2237
2237
  status?: TemplateStatus;
2238
2238
  }
@@ -2241,13 +2241,13 @@ export interface CreateTemplateRequest {
2241
2241
  */
2242
2242
  export interface CreateTemplateResponse {
2243
2243
  /**
2244
- * @public
2245
2244
  * <p>A unique identifier of a template.</p>
2245
+ * @public
2246
2246
  */
2247
2247
  templateId: string | undefined;
2248
2248
  /**
2249
- * @public
2250
2249
  * <p>The Amazon Resource Name (ARN) of the newly created template.</p>
2250
+ * @public
2251
2251
  */
2252
2252
  templateArn: string | undefined;
2253
2253
  }
@@ -2256,13 +2256,13 @@ export interface CreateTemplateResponse {
2256
2256
  */
2257
2257
  export interface GetTemplateRequest {
2258
2258
  /**
2259
- * @public
2260
2259
  * <p>The unique identifier of the Cases domain. </p>
2260
+ * @public
2261
2261
  */
2262
2262
  domainId: string | undefined;
2263
2263
  /**
2264
- * @public
2265
2264
  * <p>A unique identifier of a template.</p>
2265
+ * @public
2266
2266
  */
2267
2267
  templateId: string | undefined;
2268
2268
  }
@@ -2271,44 +2271,44 @@ export interface GetTemplateRequest {
2271
2271
  */
2272
2272
  export interface GetTemplateResponse {
2273
2273
  /**
2274
- * @public
2275
2274
  * <p>A unique identifier of a template.</p>
2275
+ * @public
2276
2276
  */
2277
2277
  templateId: string | undefined;
2278
2278
  /**
2279
- * @public
2280
2279
  * <p>The Amazon Resource Name (ARN) of the template.</p>
2280
+ * @public
2281
2281
  */
2282
2282
  templateArn: string | undefined;
2283
2283
  /**
2284
- * @public
2285
2284
  * <p>The name of the template.</p>
2285
+ * @public
2286
2286
  */
2287
2287
  name: string | undefined;
2288
2288
  /**
2289
- * @public
2290
2289
  * <p>A brief description of the template.</p>
2290
+ * @public
2291
2291
  */
2292
2292
  description?: string;
2293
2293
  /**
2294
- * @public
2295
2294
  * <p>Configuration of layouts associated to the template.</p>
2295
+ * @public
2296
2296
  */
2297
2297
  layoutConfiguration?: LayoutConfiguration;
2298
2298
  /**
2299
- * @public
2300
2299
  * <p>A list of fields that must contain a value for a case to be successfully created with this
2301
2300
  * template.</p>
2301
+ * @public
2302
2302
  */
2303
2303
  requiredFields?: RequiredField[];
2304
2304
  /**
2305
- * @public
2306
2305
  * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
2306
+ * @public
2307
2307
  */
2308
2308
  tags?: Record<string, string>;
2309
2309
  /**
2310
- * @public
2311
2310
  * <p>The status of the template.</p>
2311
+ * @public
2312
2312
  */
2313
2313
  status: TemplateStatus | undefined;
2314
2314
  }
@@ -2317,50 +2317,50 @@ export interface GetTemplateResponse {
2317
2317
  */
2318
2318
  export interface ListTemplatesRequest {
2319
2319
  /**
2320
- * @public
2321
2320
  * <p>The unique identifier of the Cases domain. </p>
2321
+ * @public
2322
2322
  */
2323
2323
  domainId: string | undefined;
2324
2324
  /**
2325
- * @public
2326
2325
  * <p>The maximum number of results to return per page.</p>
2326
+ * @public
2327
2327
  */
2328
2328
  maxResults?: number;
2329
2329
  /**
2330
- * @public
2331
2330
  * <p>The token for the next set of results. Use the value returned in the previous
2332
2331
  * response in the next request to retrieve the next set of results.</p>
2332
+ * @public
2333
2333
  */
2334
2334
  nextToken?: string;
2335
2335
  /**
2336
- * @public
2337
2336
  * <p>A list of status values to filter on.</p>
2337
+ * @public
2338
2338
  */
2339
2339
  status?: TemplateStatus[];
2340
2340
  }
2341
2341
  /**
2342
- * @public
2343
2342
  * <p>Template summary information.</p>
2343
+ * @public
2344
2344
  */
2345
2345
  export interface TemplateSummary {
2346
2346
  /**
2347
- * @public
2348
2347
  * <p>The unique identifier for the template.</p>
2348
+ * @public
2349
2349
  */
2350
2350
  templateId: string | undefined;
2351
2351
  /**
2352
- * @public
2353
2352
  * <p>The Amazon Resource Name (ARN) of the template.</p>
2353
+ * @public
2354
2354
  */
2355
2355
  templateArn: string | undefined;
2356
2356
  /**
2357
- * @public
2358
2357
  * <p>The template name.</p>
2358
+ * @public
2359
2359
  */
2360
2360
  name: string | undefined;
2361
2361
  /**
2362
- * @public
2363
2362
  * <p>The status of the template.</p>
2363
+ * @public
2364
2364
  */
2365
2365
  status: TemplateStatus | undefined;
2366
2366
  }
@@ -2369,13 +2369,13 @@ export interface TemplateSummary {
2369
2369
  */
2370
2370
  export interface ListTemplatesResponse {
2371
2371
  /**
2372
- * @public
2373
2372
  * <p>List of template summary objects.</p>
2373
+ * @public
2374
2374
  */
2375
2375
  templates: TemplateSummary[] | undefined;
2376
2376
  /**
2377
- * @public
2378
2377
  * <p>The token for the next set of results. This is null if there are no more results to return.</p>
2378
+ * @public
2379
2379
  */
2380
2380
  nextToken?: string;
2381
2381
  }
@@ -2384,39 +2384,39 @@ export interface ListTemplatesResponse {
2384
2384
  */
2385
2385
  export interface UpdateTemplateRequest {
2386
2386
  /**
2387
- * @public
2388
2387
  * <p>The unique identifier of the Cases domain. </p>
2388
+ * @public
2389
2389
  */
2390
2390
  domainId: string | undefined;
2391
2391
  /**
2392
- * @public
2393
2392
  * <p>A unique identifier for the template.</p>
2393
+ * @public
2394
2394
  */
2395
2395
  templateId: string | undefined;
2396
2396
  /**
2397
- * @public
2398
2397
  * <p>The name of the template. It must be unique per domain.</p>
2398
+ * @public
2399
2399
  */
2400
2400
  name?: string;
2401
2401
  /**
2402
- * @public
2403
2402
  * <p>A brief description of the template.</p>
2403
+ * @public
2404
2404
  */
2405
2405
  description?: string;
2406
2406
  /**
2407
- * @public
2408
2407
  * <p>Configuration of layouts associated to the template.</p>
2408
+ * @public
2409
2409
  */
2410
2410
  layoutConfiguration?: LayoutConfiguration;
2411
2411
  /**
2412
- * @public
2413
2412
  * <p>A list of fields that must contain a value for a case to be successfully created with this
2414
2413
  * template.</p>
2414
+ * @public
2415
2415
  */
2416
2416
  requiredFields?: RequiredField[];
2417
2417
  /**
2418
- * @public
2419
2418
  * <p>The status of the template.</p>
2419
+ * @public
2420
2420
  */
2421
2421
  status?: TemplateStatus;
2422
2422
  }
@@ -2430,19 +2430,19 @@ export interface UpdateTemplateResponse {
2430
2430
  */
2431
2431
  export interface UntagResourceRequest {
2432
2432
  /**
2433
- * @public
2434
2433
  * <p>The Amazon Resource Name (ARN)</p>
2434
+ * @public
2435
2435
  */
2436
2436
  arn: string | undefined;
2437
2437
  /**
2438
- * @public
2439
2438
  * <p>List of tag keys.</p>
2439
+ * @public
2440
2440
  */
2441
2441
  tagKeys: string[] | undefined;
2442
2442
  }
2443
2443
  /**
2444
- * @public
2445
2444
  * <p>A filter for cases. Only one value can be provided.</p>
2445
+ * @public
2446
2446
  */
2447
2447
  export type CaseFilter = CaseFilter.AndAllMember | CaseFilter.FieldMember | CaseFilter.NotMember | CaseFilter.OrAllMember | CaseFilter.$UnknownMember;
2448
2448
  /**
@@ -2450,8 +2450,8 @@ export type CaseFilter = CaseFilter.AndAllMember | CaseFilter.FieldMember | Case
2450
2450
  */
2451
2451
  export declare namespace CaseFilter {
2452
2452
  /**
2453
- * @public
2454
2453
  * <p>A list of fields to filter on.</p>
2454
+ * @public
2455
2455
  */
2456
2456
  interface FieldMember {
2457
2457
  field: FieldFilter;
@@ -2461,8 +2461,8 @@ export declare namespace CaseFilter {
2461
2461
  $unknown?: never;
2462
2462
  }
2463
2463
  /**
2464
- * @public
2465
2464
  * <p>A filter for cases. Only one value can be provided.</p>
2465
+ * @public
2466
2466
  */
2467
2467
  interface NotMember {
2468
2468
  field?: never;
@@ -2472,8 +2472,8 @@ export declare namespace CaseFilter {
2472
2472
  $unknown?: never;
2473
2473
  }
2474
2474
  /**
2475
- * @public
2476
2475
  * <p>Provides "and all" filtering.</p>
2476
+ * @public
2477
2477
  */
2478
2478
  interface AndAllMember {
2479
2479
  field?: never;
@@ -2483,8 +2483,8 @@ export declare namespace CaseFilter {
2483
2483
  $unknown?: never;
2484
2484
  }
2485
2485
  /**
2486
- * @public
2487
2486
  * <p>Provides "or all" filtering.</p>
2487
+ * @public
2488
2488
  */
2489
2489
  interface OrAllMember {
2490
2490
  field?: never;
@@ -2517,41 +2517,41 @@ export declare namespace CaseFilter {
2517
2517
  */
2518
2518
  export interface SearchCasesRequest {
2519
2519
  /**
2520
- * @public
2521
2520
  * <p>The unique identifier of the Cases domain. </p>
2521
+ * @public
2522
2522
  */
2523
2523
  domainId: string | undefined;
2524
2524
  /**
2525
- * @public
2526
2525
  * <p>The maximum number of cases to return. The current maximum supported value is 25. This is
2527
2526
  * also the default value when no other value is provided.</p>
2527
+ * @public
2528
2528
  */
2529
2529
  maxResults?: number;
2530
2530
  /**
2531
- * @public
2532
2531
  * <p>The token for the next set of results. Use the value returned in the previous
2533
2532
  * response in the next request to retrieve the next set of results.</p>
2533
+ * @public
2534
2534
  */
2535
2535
  nextToken?: string;
2536
2536
  /**
2537
- * @public
2538
2537
  * <p>A word or phrase used to perform a quick search.</p>
2538
+ * @public
2539
2539
  */
2540
2540
  searchTerm?: string;
2541
2541
  /**
2542
- * @public
2543
2542
  * <p>A list of filter objects.</p>
2543
+ * @public
2544
2544
  */
2545
2545
  filter?: CaseFilter;
2546
2546
  /**
2547
- * @public
2548
2547
  * <p>A list of sorts where each sort specifies a field and their sort order to be applied to
2549
2548
  * the results. </p>
2549
+ * @public
2550
2550
  */
2551
2551
  sorts?: Sort[];
2552
2552
  /**
2553
- * @public
2554
2553
  * <p>The list of field identifiers to be returned as part of the response.</p>
2554
+ * @public
2555
2555
  */
2556
2556
  fields?: FieldIdentifier[];
2557
2557
  }