@aws-sdk/client-qconnect 3.936.0 → 3.939.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 (54) hide show
  1. package/dist-cjs/index.js +632 -33
  2. package/dist-es/index.js +1 -0
  3. package/dist-es/models/enums.js +337 -0
  4. package/dist-es/models/models_0.js +1 -276
  5. package/dist-es/models/models_1.js +1 -49
  6. package/dist-es/schemas/schemas_0.js +218 -17
  7. package/dist-types/commands/CreateMessageTemplateCommand.d.ts +126 -1
  8. package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +65 -0
  9. package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -2
  10. package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
  11. package/dist-types/commands/DeleteImportJobCommand.d.ts +1 -1
  12. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
  13. package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
  14. package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteQuickResponseCommand.d.ts +1 -1
  16. package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
  17. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -1
  18. package/dist-types/commands/GetMessageTemplateCommand.d.ts +66 -1
  19. package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
  20. package/dist-types/commands/ListImportJobsCommand.d.ts +1 -1
  21. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
  22. package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +2 -1
  23. package/dist-types/commands/ListMessageTemplatesCommand.d.ts +11 -1
  24. package/dist-types/commands/RenderMessageTemplateCommand.d.ts +66 -1
  25. package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +14 -0
  26. package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +125 -0
  27. package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +65 -0
  28. package/dist-types/index.d.ts +1 -0
  29. package/dist-types/models/enums.d.ts +825 -0
  30. package/dist-types/models/models_0.d.ts +1310 -682
  31. package/dist-types/models/models_1.d.ts +22 -996
  32. package/dist-types/schemas/schemas_0.d.ts +11 -0
  33. package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +4 -2
  34. package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/index.d.ts +1 -0
  50. package/dist-types/ts3.4/models/enums.d.ts +442 -0
  51. package/dist-types/ts3.4/models/models_0.d.ts +411 -364
  52. package/dist-types/ts3.4/models/models_1.d.ts +28 -295
  53. package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
  54. package/package.json +2 -2
@@ -1,935 +1,19 @@
1
- import { ChannelSubtype, Configuration, ContentDataDetails, ContentSummary, DataReference, Document, EmailOverviewChunkDataDetails, EmailResponseChunkDataDetails, ExtendedMessageTemplateData, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttachment, MessageTemplateAttributes, MessageTemplateContentProvider, MessageTemplateData, QueryResultType, QuickResponseDataProvider, RankingData, RecommendationTrigger, RecommendationType, RelevanceLevel, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, VectorIngestionConfiguration } from "./models_0";
1
+ import { ChannelSubtype, ImportJobType, MessageTemplateFilterOperator, MessageTemplateQueryOperator, Order, Priority, QueryResultType, QuickResponseFilterOperator, QuickResponseQueryOperator, QuickResponseStatus, RecommendationType, RelevanceLevel } from "./enums";
2
+ import { ContentDataDetails, ContentSummary, DataReference, Document, EmailOverviewChunkDataDetails, EmailResponseChunkDataDetails, ExternalSourceConfiguration, GroupingConfiguration, ImportJobData, IntentDetectedDataDetails, KnowledgeBaseData, MessageTemplateAttachment, MessageTemplateAttributes, MessageTemplateContentProvider, MessageTemplateData, MessageTemplateSourceConfiguration, MessageTemplateSourceConfigurationSummary, QuickResponseContents, QuickResponseData, QuickResponseDataProvider, RankingData, RecommendationTrigger, SearchExpression, SourceContentDataDetails } from "./models_0";
2
3
  /**
3
- * <p>The container quick response content.</p>
4
4
  * @public
5
5
  */
6
- export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
7
- /**
8
- * @public
9
- */
10
- export declare namespace QuickResponseContentProvider {
11
- /**
12
- * <p>The content of the quick response.</p>
13
- * @public
14
- */
15
- interface ContentMember {
16
- content: string;
17
- $unknown?: never;
18
- }
19
- /**
20
- * @public
21
- */
22
- interface $UnknownMember {
23
- content?: never;
24
- $unknown: [string, any];
25
- }
26
- /**
27
- * @deprecated unused in schema-serde mode.
28
- *
29
- */
30
- interface Visitor<T> {
31
- content: (value: string) => T;
32
- _: (name: string, value: any) => T;
33
- }
34
- }
35
- /**
36
- * <p>The content of the quick response stored in different media types.</p>
37
- * @public
38
- */
39
- export interface QuickResponseContents {
40
- /**
41
- * <p>The container quick response content.</p>
42
- * @public
43
- */
44
- plainText?: QuickResponseContentProvider | undefined;
45
- /**
46
- * <p>The container quick response content.</p>
47
- * @public
48
- */
49
- markdown?: QuickResponseContentProvider | undefined;
50
- }
51
- /**
52
- * @public
53
- * @enum
54
- */
55
- export declare const QuickResponseStatus: {
56
- readonly CREATED: "CREATED";
57
- readonly CREATE_FAILED: "CREATE_FAILED";
58
- readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
59
- readonly DELETED: "DELETED";
60
- readonly DELETE_FAILED: "DELETE_FAILED";
61
- readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
62
- readonly UPDATE_FAILED: "UPDATE_FAILED";
63
- readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
64
- };
65
- /**
66
- * @public
67
- */
68
- export type QuickResponseStatus = (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
69
- /**
70
- * <p>Information about the quick response.</p>
71
- * @public
72
- */
73
- export interface QuickResponseData {
74
- /**
75
- * <p>The Amazon Resource Name (ARN) of the quick response.</p>
76
- * @public
77
- */
78
- quickResponseArn: string | undefined;
79
- /**
80
- * <p>The identifier of the quick response.</p>
81
- * @public
82
- */
83
- quickResponseId: string | undefined;
84
- /**
85
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
86
- * @public
87
- */
88
- knowledgeBaseArn: string | undefined;
89
- /**
90
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
91
- * @public
92
- */
93
- knowledgeBaseId: string | undefined;
94
- /**
95
- * <p>The name of the quick response.</p>
96
- * @public
97
- */
98
- name: string | undefined;
99
- /**
100
- * <p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p> </li> </ul>
101
- * @public
102
- */
103
- contentType: string | undefined;
104
- /**
105
- * <p>The status of the quick response data.</p>
106
- * @public
107
- */
108
- status: QuickResponseStatus | undefined;
109
- /**
110
- * <p>The timestamp when the quick response was created.</p>
111
- * @public
112
- */
113
- createdTime: Date | undefined;
114
- /**
115
- * <p>The timestamp when the quick response data was last modified.</p>
116
- * @public
117
- */
118
- lastModifiedTime: Date | undefined;
119
- /**
120
- * <p>The contents of the quick response.</p>
121
- * @public
122
- */
123
- contents?: QuickResponseContents | undefined;
124
- /**
125
- * <p>The description of the quick response.</p>
126
- * @public
127
- */
128
- description?: string | undefined;
129
- /**
130
- * <p>The configuration information of the user groups that the quick response is accessible to.</p>
131
- * @public
132
- */
133
- groupingConfiguration?: GroupingConfiguration | undefined;
134
- /**
135
- * <p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>
136
- * @public
137
- */
138
- shortcutKey?: string | undefined;
139
- /**
140
- * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
141
- * @public
142
- */
143
- lastModifiedBy?: string | undefined;
144
- /**
145
- * <p>Whether the quick response is active.</p>
146
- * @public
147
- */
148
- isActive?: boolean | undefined;
149
- /**
150
- * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
151
- * @public
152
- */
153
- channels?: string[] | undefined;
154
- /**
155
- * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
156
- * @public
157
- */
158
- language?: string | undefined;
159
- /**
160
- * <p>The tags used to organize, track, or control access for this resource.</p>
161
- * @public
162
- */
163
- tags?: Record<string, string> | undefined;
164
- }
165
- /**
166
- * @public
167
- */
168
- export interface CreateQuickResponseResponse {
169
- /**
170
- * <p>The quick response.</p>
171
- * @public
172
- */
173
- quickResponse?: QuickResponseData | undefined;
174
- }
175
- /**
176
- * @public
177
- */
178
- export interface DeactivateMessageTemplateRequest {
179
- /**
180
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
181
- * @public
182
- */
183
- knowledgeBaseId: string | undefined;
184
- /**
185
- * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
186
- * @public
187
- */
188
- messageTemplateId: string | undefined;
189
- /**
190
- * <p>The version number of the message template version to deactivate.</p>
191
- * @public
192
- */
193
- versionNumber: number | undefined;
194
- }
195
- /**
196
- * @public
197
- */
198
- export interface DeactivateMessageTemplateResponse {
199
- /**
200
- * <p>The Amazon Resource Name (ARN) of the message template.</p>
201
- * @public
202
- */
203
- messageTemplateArn: string | undefined;
204
- /**
205
- * <p>The identifier of the message template.</p>
206
- * @public
207
- */
208
- messageTemplateId: string | undefined;
209
- /**
210
- * <p>The version number of the message template version that has been deactivated.</p>
211
- * @public
212
- */
213
- versionNumber: number | undefined;
214
- }
215
- /**
216
- * @public
217
- */
218
- export interface DeleteImportJobRequest {
219
- /**
220
- * <p>The identifier of the knowledge base.</p>
221
- * @public
222
- */
223
- knowledgeBaseId: string | undefined;
224
- /**
225
- * <p>The identifier of the import job to be deleted.</p>
226
- * @public
227
- */
228
- importJobId: string | undefined;
229
- }
230
- /**
231
- * @public
232
- */
233
- export interface DeleteImportJobResponse {
234
- }
235
- /**
236
- * @public
237
- */
238
- export interface DeleteKnowledgeBaseRequest {
239
- /**
240
- * <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
241
- * @public
242
- */
243
- knowledgeBaseId: string | undefined;
244
- }
245
- /**
246
- * @public
247
- */
248
- export interface DeleteKnowledgeBaseResponse {
249
- }
250
- /**
251
- * @public
252
- */
253
- export interface DeleteMessageTemplateRequest {
254
- /**
255
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
256
- * @public
257
- */
258
- knowledgeBaseId: string | undefined;
259
- /**
260
- * <p>The identifier of the message template. Can be either the ID or the ARN.</p>
261
- * @public
262
- */
263
- messageTemplateId: string | undefined;
264
- }
265
- /**
266
- * @public
267
- */
268
- export interface DeleteMessageTemplateResponse {
269
- }
270
- /**
271
- * @public
272
- */
273
- export interface DeleteMessageTemplateAttachmentRequest {
274
- /**
275
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
276
- * @public
277
- */
278
- knowledgeBaseId: string | undefined;
279
- /**
280
- * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
281
- * @public
282
- */
283
- messageTemplateId: string | undefined;
284
- /**
285
- * <p>The identifier of the attachment file.</p>
286
- * @public
287
- */
288
- attachmentId: string | undefined;
289
- }
290
- /**
291
- * @public
292
- */
293
- export interface DeleteMessageTemplateAttachmentResponse {
294
- }
295
- /**
296
- * @public
297
- */
298
- export interface DeleteQuickResponseRequest {
299
- /**
300
- * <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</p>
301
- * @public
302
- */
303
- knowledgeBaseId: string | undefined;
304
- /**
305
- * <p>The identifier of the quick response to delete.</p>
306
- * @public
307
- */
308
- quickResponseId: string | undefined;
309
- }
310
- /**
311
- * @public
312
- */
313
- export interface DeleteQuickResponseResponse {
314
- }
315
- /**
316
- * @public
317
- * @enum
318
- */
319
- export declare const ExternalSource: {
320
- readonly AMAZON_CONNECT: "AMAZON_CONNECT";
321
- };
322
- /**
323
- * @public
324
- */
325
- export type ExternalSource = (typeof ExternalSource)[keyof typeof ExternalSource];
326
- /**
327
- * <p>The configuration information of the external data source.</p>
328
- * @public
329
- */
330
- export interface ExternalSourceConfiguration {
331
- /**
332
- * <p>The type of the external data source.</p>
333
- * @public
334
- */
335
- source: ExternalSource | undefined;
336
- /**
337
- * <p>The configuration information of the external data source.</p>
338
- * @public
339
- */
340
- configuration: Configuration | undefined;
341
- }
342
- /**
343
- * @public
344
- */
345
- export interface GetImportJobRequest {
346
- /**
347
- * <p>The identifier of the import job to retrieve.</p>
348
- * @public
349
- */
350
- importJobId: string | undefined;
351
- /**
352
- * <p>The identifier of the knowledge base that the import job belongs to.</p>
353
- * @public
354
- */
355
- knowledgeBaseId: string | undefined;
356
- }
357
- /**
358
- * @public
359
- * @enum
360
- */
361
- export declare const ImportJobType: {
362
- readonly QUICK_RESPONSES: "QUICK_RESPONSES";
363
- };
364
- /**
365
- * @public
366
- */
367
- export type ImportJobType = (typeof ImportJobType)[keyof typeof ImportJobType];
368
- /**
369
- * @public
370
- * @enum
371
- */
372
- export declare const ImportJobStatus: {
373
- readonly COMPLETE: "COMPLETE";
374
- readonly DELETED: "DELETED";
375
- readonly DELETE_FAILED: "DELETE_FAILED";
376
- readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
377
- readonly FAILED: "FAILED";
378
- readonly START_IN_PROGRESS: "START_IN_PROGRESS";
379
- };
380
- /**
381
- * @public
382
- */
383
- export type ImportJobStatus = (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
384
- /**
385
- * <p>Summary information about the import job.</p>
386
- * @public
387
- */
388
- export interface ImportJobData {
389
- /**
390
- * <p>The identifier of the import job.</p>
391
- * @public
392
- */
393
- importJobId: string | undefined;
394
- /**
395
- * <p>The identifier of the knowledge base.</p>
396
- * @public
397
- */
398
- knowledgeBaseId: string | undefined;
399
- /**
400
- * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
401
- * @public
402
- */
403
- uploadId: string | undefined;
404
- /**
405
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
406
- * @public
407
- */
408
- knowledgeBaseArn: string | undefined;
409
- /**
410
- * <p>The type of the import job.</p>
411
- * @public
412
- */
413
- importJobType: ImportJobType | undefined;
414
- /**
415
- * <p>The status of the import job.</p>
416
- * @public
417
- */
418
- status: ImportJobStatus | undefined;
419
- /**
420
- * <p>The download link to the resource file that is uploaded to the import job.</p>
421
- * @public
422
- */
423
- url: string | undefined;
424
- /**
425
- * <p>The link to download the information of resource data that failed to be imported.</p>
426
- * @public
427
- */
428
- failedRecordReport?: string | undefined;
429
- /**
430
- * <p>The expiration time of the URL as an epoch timestamp.</p>
431
- * @public
432
- */
433
- urlExpiry: Date | undefined;
434
- /**
435
- * <p>The timestamp when the import job was created.</p>
436
- * @public
437
- */
438
- createdTime: Date | undefined;
439
- /**
440
- * <p>The timestamp when the import job data was last modified.</p>
441
- * @public
442
- */
443
- lastModifiedTime: Date | undefined;
444
- /**
445
- * <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
446
- * @public
447
- */
448
- metadata?: Record<string, string> | undefined;
449
- /**
450
- * <p>The configuration information of the external data source.</p>
451
- * @public
452
- */
453
- externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
454
- }
455
- /**
456
- * @public
457
- */
458
- export interface GetImportJobResponse {
459
- /**
460
- * <p>The import job.</p>
461
- * @public
462
- */
463
- importJob?: ImportJobData | undefined;
464
- }
465
- /**
466
- * @public
467
- */
468
- export interface GetKnowledgeBaseRequest {
469
- /**
470
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
471
- * @public
472
- */
473
- knowledgeBaseId: string | undefined;
474
- }
475
- /**
476
- * @public
477
- */
478
- export interface GetKnowledgeBaseResponse {
479
- /**
480
- * <p>The knowledge base.</p>
481
- * @public
482
- */
483
- knowledgeBase?: KnowledgeBaseData | undefined;
484
- }
485
- /**
486
- * @public
487
- */
488
- export interface GetMessageTemplateRequest {
489
- /**
490
- * <p>The identifier of the message template. Can be either the ID or the ARN.</p>
491
- * @public
492
- */
493
- messageTemplateId: string | undefined;
494
- /**
495
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
496
- * @public
497
- */
498
- knowledgeBaseId: string | undefined;
499
- }
500
- /**
501
- * @public
502
- */
503
- export interface GetMessageTemplateResponse {
504
- /**
505
- * <p>The message template.</p>
506
- * @public
507
- */
508
- messageTemplate?: ExtendedMessageTemplateData | undefined;
509
- }
510
- /**
511
- * @public
512
- */
513
- export interface GetQuickResponseRequest {
514
- /**
515
- * <p>The identifier of the quick response.</p>
516
- * @public
517
- */
518
- quickResponseId: string | undefined;
519
- /**
520
- * <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
521
- * @public
522
- */
523
- knowledgeBaseId: string | undefined;
524
- }
525
- /**
526
- * @public
527
- */
528
- export interface GetQuickResponseResponse {
529
- /**
530
- * <p>The quick response.</p>
531
- * @public
532
- */
533
- quickResponse?: QuickResponseData | undefined;
534
- }
535
- /**
536
- * <p>Summary information about the import job.</p>
537
- * @public
538
- */
539
- export interface ImportJobSummary {
540
- /**
541
- * <p>The identifier of the import job.</p>
542
- * @public
543
- */
544
- importJobId: string | undefined;
545
- /**
546
- * <p>The identifier of the knowledge base.</p>
547
- * @public
548
- */
549
- knowledgeBaseId: string | undefined;
550
- /**
551
- * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
552
- * @public
553
- */
554
- uploadId: string | undefined;
555
- /**
556
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
557
- * @public
558
- */
559
- knowledgeBaseArn: string | undefined;
560
- /**
561
- * <p>The type of import job.</p>
562
- * @public
563
- */
564
- importJobType: ImportJobType | undefined;
565
- /**
566
- * <p>The status of the import job.</p>
567
- * @public
568
- */
569
- status: ImportJobStatus | undefined;
570
- /**
571
- * <p>The timestamp when the import job was created.</p>
572
- * @public
573
- */
574
- createdTime: Date | undefined;
575
- /**
576
- * <p>The timestamp when the import job was last modified.</p>
577
- * @public
578
- */
579
- lastModifiedTime: Date | undefined;
580
- /**
581
- * <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
582
- * @public
583
- */
584
- metadata?: Record<string, string> | undefined;
585
- /**
586
- * <p>The configuration information of the external source that the resource data are imported from.</p>
587
- * @public
588
- */
589
- externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
590
- }
591
- /**
592
- * @public
593
- */
594
- export interface ListImportJobsRequest {
595
- /**
596
- * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
597
- * @public
598
- */
599
- nextToken?: string | undefined;
600
- /**
601
- * <p>The maximum number of results to return per page.</p>
602
- * @public
603
- */
604
- maxResults?: number | undefined;
605
- /**
606
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
607
- * @public
608
- */
609
- knowledgeBaseId: string | undefined;
610
- }
611
- /**
612
- * @public
613
- */
614
- export interface ListImportJobsResponse {
615
- /**
616
- * <p>Summary information about the import jobs.</p>
617
- * @public
618
- */
619
- importJobSummaries: ImportJobSummary[] | undefined;
620
- /**
621
- * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
622
- * @public
623
- */
624
- nextToken?: string | undefined;
625
- }
626
- /**
627
- * @public
628
- */
629
- export interface ListKnowledgeBasesRequest {
630
- /**
631
- * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
632
- * @public
633
- */
634
- nextToken?: string | undefined;
635
- /**
636
- * <p>The maximum number of results to return per page.</p>
637
- * @public
638
- */
639
- maxResults?: number | undefined;
640
- }
641
- /**
642
- * <p>Summary information about the knowledge base.</p>
643
- * @public
644
- */
645
- export interface KnowledgeBaseSummary {
646
- /**
647
- * <p>The identifier of the knowledge base.</p>
648
- * @public
649
- */
650
- knowledgeBaseId: string | undefined;
651
- /**
652
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
653
- * @public
654
- */
655
- knowledgeBaseArn: string | undefined;
656
- /**
657
- * <p>The name of the knowledge base.</p>
658
- * @public
659
- */
660
- name: string | undefined;
661
- /**
662
- * <p>The type of knowledge base.</p>
663
- * @public
664
- */
665
- knowledgeBaseType: KnowledgeBaseType | undefined;
666
- /**
667
- * <p>The status of the knowledge base summary.</p>
668
- * @public
669
- */
670
- status: KnowledgeBaseStatus | undefined;
671
- /**
672
- * <p>Configuration information about the external data source.</p>
673
- * @public
674
- */
675
- sourceConfiguration?: SourceConfiguration | undefined;
676
- /**
677
- * <p>Contains details about how to ingest the documents in a data source.</p>
678
- * @public
679
- */
680
- vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
681
- /**
682
- * <p>Information about how to render the content.</p>
683
- * @public
684
- */
685
- renderingConfiguration?: RenderingConfiguration | undefined;
686
- /**
687
- * <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
688
- * @public
689
- */
690
- serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
691
- /**
692
- * <p>The description of the knowledge base.</p>
693
- * @public
694
- */
695
- description?: string | undefined;
696
- /**
697
- * <p>The tags used to organize, track, or control access for this resource.</p>
698
- * @public
699
- */
700
- tags?: Record<string, string> | undefined;
701
- }
702
- /**
703
- * @public
704
- */
705
- export interface ListKnowledgeBasesResponse {
706
- /**
707
- * <p>Information about the knowledge bases.</p>
708
- * @public
709
- */
710
- knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
711
- /**
712
- * <p>If there are additional results, this is the token for the next set of results.</p>
713
- * @public
714
- */
715
- nextToken?: string | undefined;
716
- }
717
- /**
718
- * @public
719
- */
720
- export interface ListMessageTemplatesRequest {
721
- /**
722
- * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
723
- * @public
724
- */
725
- nextToken?: string | undefined;
726
- /**
727
- * <p>The maximum number of results to return per page.</p>
728
- * @public
729
- */
730
- maxResults?: number | undefined;
731
- /**
732
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
733
- * @public
734
- */
735
- knowledgeBaseId: string | undefined;
736
- }
737
- /**
738
- * <p>The summary of the message template.</p>
739
- * @public
740
- */
741
- export interface MessageTemplateSummary {
742
- /**
743
- * <p>The Amazon Resource Name (ARN) of the message template.</p>
744
- * @public
745
- */
746
- messageTemplateArn: string | undefined;
747
- /**
748
- * <p>The identifier of the message template.</p>
749
- * @public
750
- */
751
- messageTemplateId: string | undefined;
752
- /**
753
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
754
- * @public
755
- */
756
- knowledgeBaseArn: string | undefined;
757
- /**
758
- * <p>The identifier of the knowledge base.</p>
759
- * @public
760
- */
761
- knowledgeBaseId: string | undefined;
762
- /**
763
- * <p>The name of the message template.</p>
764
- * @public
765
- */
766
- name: string | undefined;
767
- /**
768
- * <p>The channel subtype this message template applies to.</p>
769
- * @public
770
- */
771
- channelSubtype: ChannelSubtype | undefined;
772
- /**
773
- * <p>The timestamp when the message template was created.</p>
774
- * @public
775
- */
776
- createdTime: Date | undefined;
777
- /**
778
- * <p>The timestamp when the message template data was last modified.</p>
779
- * @public
780
- */
781
- lastModifiedTime: Date | undefined;
782
- /**
783
- * <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
784
- * @public
785
- */
786
- lastModifiedBy: string | undefined;
787
- /**
788
- * <p>The version number of the message template version that is activated.</p>
789
- * @public
790
- */
791
- activeVersionNumber?: number | undefined;
792
- /**
793
- * <p>The description of the message template.</p>
794
- * @public
795
- */
796
- description?: string | undefined;
797
- /**
798
- * <p>The tags used to organize, track, or control access for this resource.</p>
799
- * @public
800
- */
801
- tags?: Record<string, string> | undefined;
802
- }
803
- /**
804
- * @public
805
- */
806
- export interface ListMessageTemplatesResponse {
807
- /**
808
- * <p>Summary information about the message template.</p>
809
- * @public
810
- */
811
- messageTemplateSummaries: MessageTemplateSummary[] | undefined;
812
- /**
813
- * <p>If there are additional results, this is the token for the next set of results.</p>
814
- * @public
815
- */
816
- nextToken?: string | undefined;
817
- }
818
- /**
819
- * @public
820
- */
821
- export interface ListMessageTemplateVersionsRequest {
822
- /**
823
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
824
- * @public
825
- */
826
- knowledgeBaseId: string | undefined;
827
- /**
828
- * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
829
- * @public
830
- */
831
- messageTemplateId: string | undefined;
832
- /**
833
- * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
834
- * @public
835
- */
836
- nextToken?: string | undefined;
837
- /**
838
- * <p>The maximum number of results to return per page.</p>
839
- * @public
840
- */
841
- maxResults?: number | undefined;
842
- }
843
- /**
844
- * <p>The summary of the message template version.</p>
845
- * @public
846
- */
847
- export interface MessageTemplateVersionSummary {
848
- /**
849
- * <p>The Amazon Resource Name (ARN) of the message template.</p>
850
- * @public
851
- */
852
- messageTemplateArn: string | undefined;
853
- /**
854
- * <p>The identifier of the message template.</p>
855
- * @public
856
- */
857
- messageTemplateId: string | undefined;
858
- /**
859
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
860
- * @public
861
- */
862
- knowledgeBaseArn: string | undefined;
863
- /**
864
- * <p>The identifier of the knowledge base.</p>
865
- * @public
866
- */
867
- knowledgeBaseId: string | undefined;
868
- /**
869
- * <p>The name of the message template.</p>
870
- * @public
871
- */
872
- name: string | undefined;
873
- /**
874
- * <p>The channel subtype this message template applies to.</p>
875
- * @public
876
- */
877
- channelSubtype: ChannelSubtype | undefined;
878
- /**
879
- * <p>Whether the version of the message template is activated.</p>
880
- * @public
881
- */
882
- isActive: boolean | undefined;
883
- /**
884
- * <p>The version number of the message template version.</p>
885
- * @public
886
- */
887
- versionNumber: number | undefined;
888
- }
889
- /**
890
- * @public
891
- */
892
- export interface ListMessageTemplateVersionsResponse {
893
- /**
894
- * <p>Summary information about the versions of a message template.</p>
895
- * @public
896
- */
897
- messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
898
- /**
899
- * <p>If there are additional results, this is the token for the next set of results.</p>
900
- * @public
901
- */
902
- nextToken?: string | undefined;
903
- }
904
- /**
905
- * @public
906
- */
907
- export interface RenderMessageTemplateRequest {
908
- /**
909
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
910
- * @public
911
- */
912
- knowledgeBaseId: string | undefined;
913
- /**
914
- * <p>The identifier of the message template. Can be either the ID or the ARN.</p>
915
- * @public
916
- */
917
- messageTemplateId: string | undefined;
6
+ export interface RenderMessageTemplateResponse {
918
7
  /**
919
- * <p>An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.</p>
8
+ * <p>The content of the message template.</p>
920
9
  * @public
921
10
  */
922
- attributes: MessageTemplateAttributes | undefined;
923
- }
924
- /**
925
- * @public
926
- */
927
- export interface RenderMessageTemplateResponse {
11
+ content?: MessageTemplateContentProvider | undefined;
928
12
  /**
929
- * <p>The content of the message template.</p>
13
+ * <p>The source configuration of the message template.</p>
930
14
  * @public
931
15
  */
932
- content: MessageTemplateContentProvider | undefined;
16
+ sourceConfigurationSummary?: MessageTemplateSourceConfigurationSummary | undefined;
933
17
  /**
934
18
  * <p>The attribute keys that are not resolved.</p>
935
19
  * @public
@@ -965,6 +49,11 @@ export interface UpdateMessageTemplateRequest {
965
49
  * @public
966
50
  */
967
51
  language?: string | undefined;
52
+ /**
53
+ * <p>The source configuration of the message template. Only set this argument for WHATSAPP channel subtype.</p>
54
+ * @public
55
+ */
56
+ sourceConfiguration?: MessageTemplateSourceConfiguration | undefined;
968
57
  /**
969
58
  * <p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>
970
59
  * @public
@@ -1272,18 +361,6 @@ export interface SearchContentResponse {
1272
361
  */
1273
362
  nextToken?: string | undefined;
1274
363
  }
1275
- /**
1276
- * @public
1277
- * @enum
1278
- */
1279
- export declare const MessageTemplateFilterOperator: {
1280
- readonly EQUALS: "EQUALS";
1281
- readonly PREFIX: "PREFIX";
1282
- };
1283
- /**
1284
- * @public
1285
- */
1286
- export type MessageTemplateFilterOperator = (typeof MessageTemplateFilterOperator)[keyof typeof MessageTemplateFilterOperator];
1287
364
  /**
1288
365
  * <p>The message template fields to filter the message template query results by. The following is the list of supported field names:</p> <ul> <li> <p>name</p> </li> <li> <p>description</p> </li> <li> <p>channel</p> </li> <li> <p>channelSubtype</p> </li> <li> <p>language</p> </li> <li> <p>qualifier</p> </li> <li> <p>createdTime</p> </li> <li> <p>lastModifiedTime</p> </li> <li> <p>lastModifiedBy</p> </li> <li> <p>groupingConfiguration.criteria</p> </li> <li> <p>groupingConfiguration.values</p> </li> </ul>
1289
366
  * @public
@@ -1310,18 +387,6 @@ export interface MessageTemplateFilterField {
1310
387
  */
1311
388
  includeNoExistence?: boolean | undefined;
1312
389
  }
1313
- /**
1314
- * @public
1315
- * @enum
1316
- */
1317
- export declare const Order: {
1318
- readonly ASC: "ASC";
1319
- readonly DESC: "DESC";
1320
- };
1321
- /**
1322
- * @public
1323
- */
1324
- export type Order = (typeof Order)[keyof typeof Order];
1325
390
  /**
1326
391
  * <p>The message template fields to order the message template query results by. The following is the list of supported field names:</p> <ul> <li> <p>name</p> </li> <li> <p>description</p> </li> <li> <p>channel</p> </li> <li> <p>channelSubtype</p> </li> <li> <p>language</p> </li> <li> <p>qualifier</p> </li> <li> <p>createdTime</p> </li> <li> <p>lastModifiedTime</p> </li> <li> <p>lastModifiedBy</p> </li> <li> <p>groupingConfiguration.criteria</p> </li> <li> <p>groupingConfiguration.values</p> </li> </ul>
1327
392
  * @public
@@ -1338,31 +403,6 @@ export interface MessageTemplateOrderField {
1338
403
  */
1339
404
  order?: Order | undefined;
1340
405
  }
1341
- /**
1342
- * @public
1343
- * @enum
1344
- */
1345
- export declare const MessageTemplateQueryOperator: {
1346
- readonly CONTAINS: "CONTAINS";
1347
- readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
1348
- };
1349
- /**
1350
- * @public
1351
- */
1352
- export type MessageTemplateQueryOperator = (typeof MessageTemplateQueryOperator)[keyof typeof MessageTemplateQueryOperator];
1353
- /**
1354
- * @public
1355
- * @enum
1356
- */
1357
- export declare const Priority: {
1358
- readonly HIGH: "HIGH";
1359
- readonly LOW: "LOW";
1360
- readonly MEDIUM: "MEDIUM";
1361
- };
1362
- /**
1363
- * @public
1364
- */
1365
- export type Priority = (typeof Priority)[keyof typeof Priority];
1366
406
  /**
1367
407
  * <p>The message template fields to query message templates by. The following is the list of supported field names:</p> <ul> <li> <p>name</p> </li> <li> <p>description</p> </li> </ul>
1368
408
  * @public
@@ -1470,6 +510,11 @@ export interface MessageTemplateSearchResultData {
1470
510
  * @public
1471
511
  */
1472
512
  name: string | undefined;
513
+ /**
514
+ * <p>The channel of the message template.</p>
515
+ * @public
516
+ */
517
+ channel?: string | undefined;
1473
518
  /**
1474
519
  * <p>The channel subtype this message template applies to.</p>
1475
520
  * @public
@@ -1505,6 +550,11 @@ export interface MessageTemplateSearchResultData {
1505
550
  * @public
1506
551
  */
1507
552
  description?: string | undefined;
553
+ /**
554
+ * <p>The source configuration summary of the message template.</p>
555
+ * @public
556
+ */
557
+ sourceConfigurationSummary?: MessageTemplateSourceConfigurationSummary | undefined;
1508
558
  /**
1509
559
  * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
1510
560
  * @public
@@ -1536,18 +586,6 @@ export interface SearchMessageTemplatesResponse {
1536
586
  */
1537
587
  nextToken?: string | undefined;
1538
588
  }
1539
- /**
1540
- * @public
1541
- * @enum
1542
- */
1543
- export declare const QuickResponseFilterOperator: {
1544
- readonly EQUALS: "EQUALS";
1545
- readonly PREFIX: "PREFIX";
1546
- };
1547
- /**
1548
- * @public
1549
- */
1550
- export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
1551
589
  /**
1552
590
  * <p>The quick response fields to filter the quick response query results by.</p> <p>The following is the list of supported field names.</p> <ul> <li> <p>name</p> </li> <li> <p>description</p> </li> <li> <p>shortcutKey</p> </li> <li> <p>isActive</p> </li> <li> <p>channels</p> </li> <li> <p>language</p> </li> <li> <p>contentType</p> </li> <li> <p>createdTime</p> </li> <li> <p>lastModifiedTime</p> </li> <li> <p>lastModifiedBy</p> </li> <li> <p>groupingConfiguration.criteria</p> </li> <li> <p>groupingConfiguration.values</p> </li> </ul>
1553
591
  * @public
@@ -1590,18 +628,6 @@ export interface QuickResponseOrderField {
1590
628
  */
1591
629
  order?: Order | undefined;
1592
630
  }
1593
- /**
1594
- * @public
1595
- * @enum
1596
- */
1597
- export declare const QuickResponseQueryOperator: {
1598
- readonly CONTAINS: "CONTAINS";
1599
- readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
1600
- };
1601
- /**
1602
- * @public
1603
- */
1604
- export type QuickResponseQueryOperator = (typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
1605
631
  /**
1606
632
  * <p>The quick response fields to query quick responses by.</p> <p>The following is the list of supported field names.</p> <ul> <li> <p>content</p> </li> <li> <p>name</p> </li> <li> <p>description</p> </li> <li> <p>shortcutKey</p> </li> </ul>
1607
633
  * @public