@aws-sdk/client-qconnect 3.938.0 → 3.940.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.
- package/dist-cjs/index.js +415 -16
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +337 -0
- package/dist-es/models/models_0.js +1 -288
- package/dist-es/models/models_1.js +1 -49
- package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/CreateMessageTemplateCommand.d.ts +1 -2
- package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +1 -1
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +2 -1
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +825 -0
- package/dist-types/models/models_0.d.ts +1381 -685
- package/dist-types/models/models_1.d.ts +2 -1521
- package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +2 -4
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +442 -0
- package/dist-types/ts3.4/models/models_0.d.ts +411 -376
- package/dist-types/ts3.4/models/models_1.d.ts +21 -435
- package/package.json +5 -5
|
@@ -1,1451 +1,5 @@
|
|
|
1
|
-
import { ChannelSubtype,
|
|
2
|
-
|
|
3
|
-
* <p>Configuration information about the external data source.</p>
|
|
4
|
-
* @public
|
|
5
|
-
*/
|
|
6
|
-
export interface WhatsAppMessageTemplateSourceConfigurationSummary {
|
|
7
|
-
/**
|
|
8
|
-
* <p>The ID of the End User Messaging WhatsApp Business Account to associate with this template.</p>
|
|
9
|
-
* @public
|
|
10
|
-
*/
|
|
11
|
-
businessAccountId: string | undefined;
|
|
12
|
-
/**
|
|
13
|
-
* <p>The ID of WhatsApp template.</p>
|
|
14
|
-
* @public
|
|
15
|
-
*/
|
|
16
|
-
templateId: string | undefined;
|
|
17
|
-
/**
|
|
18
|
-
* <p>The name of the WhatsApp template.</p>
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
|
-
name?: string | undefined;
|
|
22
|
-
/**
|
|
23
|
-
* <p>The language of the WhatsApp template.</p>
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
|
-
language?: string | undefined;
|
|
27
|
-
/**
|
|
28
|
-
* <p>The list of component mapping from WhatsApp template parameters to Message Template attributes.</p>
|
|
29
|
-
* @public
|
|
30
|
-
*/
|
|
31
|
-
components?: string[] | undefined;
|
|
32
|
-
/**
|
|
33
|
-
* <p>The status of the message template.</p>
|
|
34
|
-
* @public
|
|
35
|
-
*/
|
|
36
|
-
status?: WhatsAppSourceConfigurationStatus | undefined;
|
|
37
|
-
/**
|
|
38
|
-
* <p>The status reason of the message template.</p>
|
|
39
|
-
* @public
|
|
40
|
-
*/
|
|
41
|
-
statusReason?: string | undefined;
|
|
42
|
-
}
|
|
43
|
-
/**
|
|
44
|
-
* <p>The container of message template source configuration summary.</p>
|
|
45
|
-
* @public
|
|
46
|
-
*/
|
|
47
|
-
export type MessageTemplateSourceConfigurationSummary = MessageTemplateSourceConfigurationSummary.WhatsAppMember | MessageTemplateSourceConfigurationSummary.$UnknownMember;
|
|
48
|
-
/**
|
|
49
|
-
* @public
|
|
50
|
-
*/
|
|
51
|
-
export declare namespace MessageTemplateSourceConfigurationSummary {
|
|
52
|
-
/**
|
|
53
|
-
* <p>The sourceConfiguration summary of the message template that applies to the WHATSAPP channel subtype.</p>
|
|
54
|
-
* @public
|
|
55
|
-
*/
|
|
56
|
-
interface WhatsAppMember {
|
|
57
|
-
whatsApp: WhatsAppMessageTemplateSourceConfigurationSummary;
|
|
58
|
-
$unknown?: never;
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* @public
|
|
62
|
-
*/
|
|
63
|
-
interface $UnknownMember {
|
|
64
|
-
whatsApp?: never;
|
|
65
|
-
$unknown: [string, any];
|
|
66
|
-
}
|
|
67
|
-
/**
|
|
68
|
-
* @deprecated unused in schema-serde mode.
|
|
69
|
-
*
|
|
70
|
-
*/
|
|
71
|
-
interface Visitor<T> {
|
|
72
|
-
whatsApp: (value: WhatsAppMessageTemplateSourceConfigurationSummary) => T;
|
|
73
|
-
_: (name: string, value: any) => T;
|
|
74
|
-
}
|
|
75
|
-
}
|
|
76
|
-
/**
|
|
77
|
-
* <p>The data of a message template.</p>
|
|
78
|
-
* @public
|
|
79
|
-
*/
|
|
80
|
-
export interface MessageTemplateData {
|
|
81
|
-
/**
|
|
82
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
83
|
-
* @public
|
|
84
|
-
*/
|
|
85
|
-
messageTemplateArn: string | undefined;
|
|
86
|
-
/**
|
|
87
|
-
* <p>The identifier of the message template.</p>
|
|
88
|
-
* @public
|
|
89
|
-
*/
|
|
90
|
-
messageTemplateId: string | undefined;
|
|
91
|
-
/**
|
|
92
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
93
|
-
* @public
|
|
94
|
-
*/
|
|
95
|
-
knowledgeBaseArn: string | undefined;
|
|
96
|
-
/**
|
|
97
|
-
* <p>The identifier of the knowledge base.</p>
|
|
98
|
-
* @public
|
|
99
|
-
*/
|
|
100
|
-
knowledgeBaseId: string | undefined;
|
|
101
|
-
/**
|
|
102
|
-
* <p>The name of the message template.</p>
|
|
103
|
-
* @public
|
|
104
|
-
*/
|
|
105
|
-
name: string | undefined;
|
|
106
|
-
/**
|
|
107
|
-
* <p>The channel of the message template.</p>
|
|
108
|
-
* @public
|
|
109
|
-
*/
|
|
110
|
-
channel?: string | undefined;
|
|
111
|
-
/**
|
|
112
|
-
* <p>The channel subtype this message template applies to.</p>
|
|
113
|
-
* @public
|
|
114
|
-
*/
|
|
115
|
-
channelSubtype: ChannelSubtype | undefined;
|
|
116
|
-
/**
|
|
117
|
-
* <p>The timestamp when the message template was created.</p>
|
|
118
|
-
* @public
|
|
119
|
-
*/
|
|
120
|
-
createdTime: Date | undefined;
|
|
121
|
-
/**
|
|
122
|
-
* <p>The timestamp when the message template data was last modified.</p>
|
|
123
|
-
* @public
|
|
124
|
-
*/
|
|
125
|
-
lastModifiedTime: Date | undefined;
|
|
126
|
-
/**
|
|
127
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
128
|
-
* @public
|
|
129
|
-
*/
|
|
130
|
-
lastModifiedBy: string | undefined;
|
|
131
|
-
/**
|
|
132
|
-
* <p>The content of the message template.</p>
|
|
133
|
-
* @public
|
|
134
|
-
*/
|
|
135
|
-
content?: MessageTemplateContentProvider | undefined;
|
|
136
|
-
/**
|
|
137
|
-
* <p>The description of the message template.</p>
|
|
138
|
-
* @public
|
|
139
|
-
*/
|
|
140
|
-
description?: string | undefined;
|
|
141
|
-
/**
|
|
142
|
-
* <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>
|
|
143
|
-
* @public
|
|
144
|
-
*/
|
|
145
|
-
language?: string | undefined;
|
|
146
|
-
/**
|
|
147
|
-
* <p>The source configuration summary of the message template.</p>
|
|
148
|
-
* @public
|
|
149
|
-
*/
|
|
150
|
-
sourceConfigurationSummary?: MessageTemplateSourceConfigurationSummary | undefined;
|
|
151
|
-
/**
|
|
152
|
-
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
153
|
-
* @public
|
|
154
|
-
*/
|
|
155
|
-
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
156
|
-
/**
|
|
157
|
-
* <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>
|
|
158
|
-
* @public
|
|
159
|
-
*/
|
|
160
|
-
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
161
|
-
/**
|
|
162
|
-
* <p>The types of attributes that the message template contains.</p>
|
|
163
|
-
* @public
|
|
164
|
-
*/
|
|
165
|
-
attributeTypes?: MessageTemplateAttributeType[] | undefined;
|
|
166
|
-
/**
|
|
167
|
-
* <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
|
|
168
|
-
* @public
|
|
169
|
-
*/
|
|
170
|
-
messageTemplateContentSha256: string | undefined;
|
|
171
|
-
/**
|
|
172
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
173
|
-
* @public
|
|
174
|
-
*/
|
|
175
|
-
tags?: Record<string, string> | undefined;
|
|
176
|
-
}
|
|
177
|
-
/**
|
|
178
|
-
* @public
|
|
179
|
-
*/
|
|
180
|
-
export interface CreateMessageTemplateResponse {
|
|
181
|
-
/**
|
|
182
|
-
* <p>The message template.</p>
|
|
183
|
-
* @public
|
|
184
|
-
*/
|
|
185
|
-
messageTemplate?: MessageTemplateData | undefined;
|
|
186
|
-
}
|
|
187
|
-
/**
|
|
188
|
-
* @public
|
|
189
|
-
*/
|
|
190
|
-
export interface CreateMessageTemplateAttachmentRequest {
|
|
191
|
-
/**
|
|
192
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
193
|
-
* @public
|
|
194
|
-
*/
|
|
195
|
-
knowledgeBaseId: string | undefined;
|
|
196
|
-
/**
|
|
197
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
198
|
-
* @public
|
|
199
|
-
*/
|
|
200
|
-
messageTemplateId: string | undefined;
|
|
201
|
-
/**
|
|
202
|
-
* <p>The presentation information for the attachment file.</p>
|
|
203
|
-
* @public
|
|
204
|
-
*/
|
|
205
|
-
contentDisposition: ContentDisposition | undefined;
|
|
206
|
-
/**
|
|
207
|
-
* <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
|
|
208
|
-
* @public
|
|
209
|
-
*/
|
|
210
|
-
name: string | undefined;
|
|
211
|
-
/**
|
|
212
|
-
* <p>The body of the attachment file being uploaded. It should be encoded using base64 encoding.</p>
|
|
213
|
-
* @public
|
|
214
|
-
*/
|
|
215
|
-
body: string | undefined;
|
|
216
|
-
/**
|
|
217
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
218
|
-
* @public
|
|
219
|
-
*/
|
|
220
|
-
clientToken?: string | undefined;
|
|
221
|
-
}
|
|
222
|
-
/**
|
|
223
|
-
* <p>Information about the message template attachment.</p>
|
|
224
|
-
* @public
|
|
225
|
-
*/
|
|
226
|
-
export interface MessageTemplateAttachment {
|
|
227
|
-
/**
|
|
228
|
-
* <p>The presentation information for the attachment file.</p>
|
|
229
|
-
* @public
|
|
230
|
-
*/
|
|
231
|
-
contentDisposition: ContentDisposition | undefined;
|
|
232
|
-
/**
|
|
233
|
-
* <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
|
|
234
|
-
* @public
|
|
235
|
-
*/
|
|
236
|
-
name: string | undefined;
|
|
237
|
-
/**
|
|
238
|
-
* <p>The timestamp when the attachment file was uploaded.</p>
|
|
239
|
-
* @public
|
|
240
|
-
*/
|
|
241
|
-
uploadedTime: Date | undefined;
|
|
242
|
-
/**
|
|
243
|
-
* <p>A pre-signed Amazon S3 URL that can be used to download the attachment file.</p>
|
|
244
|
-
* @public
|
|
245
|
-
*/
|
|
246
|
-
url: string | undefined;
|
|
247
|
-
/**
|
|
248
|
-
* <p>The expiration time of the pre-signed Amazon S3 URL.</p>
|
|
249
|
-
* @public
|
|
250
|
-
*/
|
|
251
|
-
urlExpiry: Date | undefined;
|
|
252
|
-
/**
|
|
253
|
-
* <p>The identifier of the attachment file.</p>
|
|
254
|
-
* @public
|
|
255
|
-
*/
|
|
256
|
-
attachmentId: string | undefined;
|
|
257
|
-
}
|
|
258
|
-
/**
|
|
259
|
-
* @public
|
|
260
|
-
*/
|
|
261
|
-
export interface CreateMessageTemplateAttachmentResponse {
|
|
262
|
-
/**
|
|
263
|
-
* <p>The message template attachment.</p>
|
|
264
|
-
* @public
|
|
265
|
-
*/
|
|
266
|
-
attachment?: MessageTemplateAttachment | undefined;
|
|
267
|
-
}
|
|
268
|
-
/**
|
|
269
|
-
* @public
|
|
270
|
-
*/
|
|
271
|
-
export interface CreateMessageTemplateVersionRequest {
|
|
272
|
-
/**
|
|
273
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
274
|
-
* @public
|
|
275
|
-
*/
|
|
276
|
-
knowledgeBaseId: string | undefined;
|
|
277
|
-
/**
|
|
278
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
279
|
-
* @public
|
|
280
|
-
*/
|
|
281
|
-
messageTemplateId: string | undefined;
|
|
282
|
-
/**
|
|
283
|
-
* <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the <code>$LATEST</code> qualifier by default.</p>
|
|
284
|
-
* @public
|
|
285
|
-
*/
|
|
286
|
-
messageTemplateContentSha256?: string | undefined;
|
|
287
|
-
}
|
|
288
|
-
/**
|
|
289
|
-
* <p>The extended data of a message template.</p>
|
|
290
|
-
* @public
|
|
291
|
-
*/
|
|
292
|
-
export interface ExtendedMessageTemplateData {
|
|
293
|
-
/**
|
|
294
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
295
|
-
* @public
|
|
296
|
-
*/
|
|
297
|
-
messageTemplateArn: string | undefined;
|
|
298
|
-
/**
|
|
299
|
-
* <p>The identifier of the message template.</p>
|
|
300
|
-
* @public
|
|
301
|
-
*/
|
|
302
|
-
messageTemplateId: string | undefined;
|
|
303
|
-
/**
|
|
304
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
305
|
-
* @public
|
|
306
|
-
*/
|
|
307
|
-
knowledgeBaseArn: string | undefined;
|
|
308
|
-
/**
|
|
309
|
-
* <p>The identifier of the knowledge base.</p>
|
|
310
|
-
* @public
|
|
311
|
-
*/
|
|
312
|
-
knowledgeBaseId: string | undefined;
|
|
313
|
-
/**
|
|
314
|
-
* <p>The name of the message template.</p>
|
|
315
|
-
* @public
|
|
316
|
-
*/
|
|
317
|
-
name: string | undefined;
|
|
318
|
-
/**
|
|
319
|
-
* <p>The channel of the message template.</p>
|
|
320
|
-
* @public
|
|
321
|
-
*/
|
|
322
|
-
channel?: string | undefined;
|
|
323
|
-
/**
|
|
324
|
-
* <p>The channel subtype this message template applies to.</p>
|
|
325
|
-
* @public
|
|
326
|
-
*/
|
|
327
|
-
channelSubtype: ChannelSubtype | undefined;
|
|
328
|
-
/**
|
|
329
|
-
* <p>The timestamp when the message template was created.</p>
|
|
330
|
-
* @public
|
|
331
|
-
*/
|
|
332
|
-
createdTime: Date | undefined;
|
|
333
|
-
/**
|
|
334
|
-
* <p>The timestamp when the message template data was last modified.</p>
|
|
335
|
-
* @public
|
|
336
|
-
*/
|
|
337
|
-
lastModifiedTime: Date | undefined;
|
|
338
|
-
/**
|
|
339
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
340
|
-
* @public
|
|
341
|
-
*/
|
|
342
|
-
lastModifiedBy: string | undefined;
|
|
343
|
-
/**
|
|
344
|
-
* <p>The content of the message template.</p>
|
|
345
|
-
* @public
|
|
346
|
-
*/
|
|
347
|
-
content?: MessageTemplateContentProvider | undefined;
|
|
348
|
-
/**
|
|
349
|
-
* <p>The description of the message template.</p>
|
|
350
|
-
* @public
|
|
351
|
-
*/
|
|
352
|
-
description?: string | undefined;
|
|
353
|
-
/**
|
|
354
|
-
* <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>
|
|
355
|
-
* @public
|
|
356
|
-
*/
|
|
357
|
-
language?: string | undefined;
|
|
358
|
-
/**
|
|
359
|
-
* <p>The source configuration summary of the message template.</p>
|
|
360
|
-
* @public
|
|
361
|
-
*/
|
|
362
|
-
sourceConfigurationSummary?: MessageTemplateSourceConfigurationSummary | undefined;
|
|
363
|
-
/**
|
|
364
|
-
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
365
|
-
* @public
|
|
366
|
-
*/
|
|
367
|
-
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
368
|
-
/**
|
|
369
|
-
* <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>
|
|
370
|
-
* @public
|
|
371
|
-
*/
|
|
372
|
-
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
373
|
-
/**
|
|
374
|
-
* <p>The types of attributes contain the message template.</p>
|
|
375
|
-
* @public
|
|
376
|
-
*/
|
|
377
|
-
attributeTypes?: MessageTemplateAttributeType[] | undefined;
|
|
378
|
-
/**
|
|
379
|
-
* <p>The message template attachments.</p>
|
|
380
|
-
* @public
|
|
381
|
-
*/
|
|
382
|
-
attachments?: MessageTemplateAttachment[] | undefined;
|
|
383
|
-
/**
|
|
384
|
-
* <p>Whether the version of the message template is activated.</p>
|
|
385
|
-
* @public
|
|
386
|
-
*/
|
|
387
|
-
isActive?: boolean | undefined;
|
|
388
|
-
/**
|
|
389
|
-
* <p>The version number of the message template version.</p>
|
|
390
|
-
* @public
|
|
391
|
-
*/
|
|
392
|
-
versionNumber?: number | undefined;
|
|
393
|
-
/**
|
|
394
|
-
* <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
|
|
395
|
-
* @public
|
|
396
|
-
*/
|
|
397
|
-
messageTemplateContentSha256: string | undefined;
|
|
398
|
-
/**
|
|
399
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
400
|
-
* @public
|
|
401
|
-
*/
|
|
402
|
-
tags?: Record<string, string> | undefined;
|
|
403
|
-
}
|
|
404
|
-
/**
|
|
405
|
-
* @public
|
|
406
|
-
*/
|
|
407
|
-
export interface CreateMessageTemplateVersionResponse {
|
|
408
|
-
/**
|
|
409
|
-
* <p>The message template.</p>
|
|
410
|
-
* @public
|
|
411
|
-
*/
|
|
412
|
-
messageTemplate?: ExtendedMessageTemplateData | undefined;
|
|
413
|
-
}
|
|
414
|
-
/**
|
|
415
|
-
* <p>The container of quick response data.</p>
|
|
416
|
-
* @public
|
|
417
|
-
*/
|
|
418
|
-
export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
|
|
419
|
-
/**
|
|
420
|
-
* @public
|
|
421
|
-
*/
|
|
422
|
-
export declare namespace QuickResponseDataProvider {
|
|
423
|
-
/**
|
|
424
|
-
* <p>The content of the quick response.</p>
|
|
425
|
-
* @public
|
|
426
|
-
*/
|
|
427
|
-
interface ContentMember {
|
|
428
|
-
content: string;
|
|
429
|
-
$unknown?: never;
|
|
430
|
-
}
|
|
431
|
-
/**
|
|
432
|
-
* @public
|
|
433
|
-
*/
|
|
434
|
-
interface $UnknownMember {
|
|
435
|
-
content?: never;
|
|
436
|
-
$unknown: [string, any];
|
|
437
|
-
}
|
|
438
|
-
/**
|
|
439
|
-
* @deprecated unused in schema-serde mode.
|
|
440
|
-
*
|
|
441
|
-
*/
|
|
442
|
-
interface Visitor<T> {
|
|
443
|
-
content: (value: string) => T;
|
|
444
|
-
_: (name: string, value: any) => T;
|
|
445
|
-
}
|
|
446
|
-
}
|
|
447
|
-
/**
|
|
448
|
-
* @public
|
|
449
|
-
*/
|
|
450
|
-
export interface CreateQuickResponseRequest {
|
|
451
|
-
/**
|
|
452
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
453
|
-
* @public
|
|
454
|
-
*/
|
|
455
|
-
knowledgeBaseId: string | undefined;
|
|
456
|
-
/**
|
|
457
|
-
* <p>The name of the quick response.</p>
|
|
458
|
-
* @public
|
|
459
|
-
*/
|
|
460
|
-
name: string | undefined;
|
|
461
|
-
/**
|
|
462
|
-
* <p>The content of the quick response.</p>
|
|
463
|
-
* @public
|
|
464
|
-
*/
|
|
465
|
-
content: QuickResponseDataProvider | undefined;
|
|
466
|
-
/**
|
|
467
|
-
* <p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p> </li> </ul>
|
|
468
|
-
* @public
|
|
469
|
-
*/
|
|
470
|
-
contentType?: string | undefined;
|
|
471
|
-
/**
|
|
472
|
-
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
473
|
-
* @public
|
|
474
|
-
*/
|
|
475
|
-
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
476
|
-
/**
|
|
477
|
-
* <p>The description of the quick response.</p>
|
|
478
|
-
* @public
|
|
479
|
-
*/
|
|
480
|
-
description?: string | undefined;
|
|
481
|
-
/**
|
|
482
|
-
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base. </p>
|
|
483
|
-
* @public
|
|
484
|
-
*/
|
|
485
|
-
shortcutKey?: string | undefined;
|
|
486
|
-
/**
|
|
487
|
-
* <p>Whether the quick response is active.</p>
|
|
488
|
-
* @public
|
|
489
|
-
*/
|
|
490
|
-
isActive?: boolean | undefined;
|
|
491
|
-
/**
|
|
492
|
-
* <p>The Amazon Connect channels this quick response applies to.</p>
|
|
493
|
-
* @public
|
|
494
|
-
*/
|
|
495
|
-
channels?: string[] | undefined;
|
|
496
|
-
/**
|
|
497
|
-
* <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>
|
|
498
|
-
* @public
|
|
499
|
-
*/
|
|
500
|
-
language?: string | undefined;
|
|
501
|
-
/**
|
|
502
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
503
|
-
* @public
|
|
504
|
-
*/
|
|
505
|
-
clientToken?: string | undefined;
|
|
506
|
-
/**
|
|
507
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
508
|
-
* @public
|
|
509
|
-
*/
|
|
510
|
-
tags?: Record<string, string> | undefined;
|
|
511
|
-
}
|
|
512
|
-
/**
|
|
513
|
-
* <p>The container quick response content.</p>
|
|
514
|
-
* @public
|
|
515
|
-
*/
|
|
516
|
-
export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
|
|
517
|
-
/**
|
|
518
|
-
* @public
|
|
519
|
-
*/
|
|
520
|
-
export declare namespace QuickResponseContentProvider {
|
|
521
|
-
/**
|
|
522
|
-
* <p>The content of the quick response.</p>
|
|
523
|
-
* @public
|
|
524
|
-
*/
|
|
525
|
-
interface ContentMember {
|
|
526
|
-
content: string;
|
|
527
|
-
$unknown?: never;
|
|
528
|
-
}
|
|
529
|
-
/**
|
|
530
|
-
* @public
|
|
531
|
-
*/
|
|
532
|
-
interface $UnknownMember {
|
|
533
|
-
content?: never;
|
|
534
|
-
$unknown: [string, any];
|
|
535
|
-
}
|
|
536
|
-
/**
|
|
537
|
-
* @deprecated unused in schema-serde mode.
|
|
538
|
-
*
|
|
539
|
-
*/
|
|
540
|
-
interface Visitor<T> {
|
|
541
|
-
content: (value: string) => T;
|
|
542
|
-
_: (name: string, value: any) => T;
|
|
543
|
-
}
|
|
544
|
-
}
|
|
545
|
-
/**
|
|
546
|
-
* <p>The content of the quick response stored in different media types.</p>
|
|
547
|
-
* @public
|
|
548
|
-
*/
|
|
549
|
-
export interface QuickResponseContents {
|
|
550
|
-
/**
|
|
551
|
-
* <p>The container quick response content.</p>
|
|
552
|
-
* @public
|
|
553
|
-
*/
|
|
554
|
-
plainText?: QuickResponseContentProvider | undefined;
|
|
555
|
-
/**
|
|
556
|
-
* <p>The container quick response content.</p>
|
|
557
|
-
* @public
|
|
558
|
-
*/
|
|
559
|
-
markdown?: QuickResponseContentProvider | undefined;
|
|
560
|
-
}
|
|
561
|
-
/**
|
|
562
|
-
* @public
|
|
563
|
-
* @enum
|
|
564
|
-
*/
|
|
565
|
-
export declare const QuickResponseStatus: {
|
|
566
|
-
readonly CREATED: "CREATED";
|
|
567
|
-
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
568
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
569
|
-
readonly DELETED: "DELETED";
|
|
570
|
-
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
571
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
572
|
-
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
573
|
-
readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
|
|
574
|
-
};
|
|
575
|
-
/**
|
|
576
|
-
* @public
|
|
577
|
-
*/
|
|
578
|
-
export type QuickResponseStatus = (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
|
|
579
|
-
/**
|
|
580
|
-
* <p>Information about the quick response.</p>
|
|
581
|
-
* @public
|
|
582
|
-
*/
|
|
583
|
-
export interface QuickResponseData {
|
|
584
|
-
/**
|
|
585
|
-
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
586
|
-
* @public
|
|
587
|
-
*/
|
|
588
|
-
quickResponseArn: string | undefined;
|
|
589
|
-
/**
|
|
590
|
-
* <p>The identifier of the quick response.</p>
|
|
591
|
-
* @public
|
|
592
|
-
*/
|
|
593
|
-
quickResponseId: string | undefined;
|
|
594
|
-
/**
|
|
595
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
596
|
-
* @public
|
|
597
|
-
*/
|
|
598
|
-
knowledgeBaseArn: string | undefined;
|
|
599
|
-
/**
|
|
600
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
601
|
-
* @public
|
|
602
|
-
*/
|
|
603
|
-
knowledgeBaseId: string | undefined;
|
|
604
|
-
/**
|
|
605
|
-
* <p>The name of the quick response.</p>
|
|
606
|
-
* @public
|
|
607
|
-
*/
|
|
608
|
-
name: string | undefined;
|
|
609
|
-
/**
|
|
610
|
-
* <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>
|
|
611
|
-
* @public
|
|
612
|
-
*/
|
|
613
|
-
contentType: string | undefined;
|
|
614
|
-
/**
|
|
615
|
-
* <p>The status of the quick response data.</p>
|
|
616
|
-
* @public
|
|
617
|
-
*/
|
|
618
|
-
status: QuickResponseStatus | undefined;
|
|
619
|
-
/**
|
|
620
|
-
* <p>The timestamp when the quick response was created.</p>
|
|
621
|
-
* @public
|
|
622
|
-
*/
|
|
623
|
-
createdTime: Date | undefined;
|
|
624
|
-
/**
|
|
625
|
-
* <p>The timestamp when the quick response data was last modified.</p>
|
|
626
|
-
* @public
|
|
627
|
-
*/
|
|
628
|
-
lastModifiedTime: Date | undefined;
|
|
629
|
-
/**
|
|
630
|
-
* <p>The contents of the quick response.</p>
|
|
631
|
-
* @public
|
|
632
|
-
*/
|
|
633
|
-
contents?: QuickResponseContents | undefined;
|
|
634
|
-
/**
|
|
635
|
-
* <p>The description of the quick response.</p>
|
|
636
|
-
* @public
|
|
637
|
-
*/
|
|
638
|
-
description?: string | undefined;
|
|
639
|
-
/**
|
|
640
|
-
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
641
|
-
* @public
|
|
642
|
-
*/
|
|
643
|
-
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
644
|
-
/**
|
|
645
|
-
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>
|
|
646
|
-
* @public
|
|
647
|
-
*/
|
|
648
|
-
shortcutKey?: string | undefined;
|
|
649
|
-
/**
|
|
650
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
651
|
-
* @public
|
|
652
|
-
*/
|
|
653
|
-
lastModifiedBy?: string | undefined;
|
|
654
|
-
/**
|
|
655
|
-
* <p>Whether the quick response is active.</p>
|
|
656
|
-
* @public
|
|
657
|
-
*/
|
|
658
|
-
isActive?: boolean | undefined;
|
|
659
|
-
/**
|
|
660
|
-
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
661
|
-
* @public
|
|
662
|
-
*/
|
|
663
|
-
channels?: string[] | undefined;
|
|
664
|
-
/**
|
|
665
|
-
* <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>
|
|
666
|
-
* @public
|
|
667
|
-
*/
|
|
668
|
-
language?: string | undefined;
|
|
669
|
-
/**
|
|
670
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
671
|
-
* @public
|
|
672
|
-
*/
|
|
673
|
-
tags?: Record<string, string> | undefined;
|
|
674
|
-
}
|
|
675
|
-
/**
|
|
676
|
-
* @public
|
|
677
|
-
*/
|
|
678
|
-
export interface CreateQuickResponseResponse {
|
|
679
|
-
/**
|
|
680
|
-
* <p>The quick response.</p>
|
|
681
|
-
* @public
|
|
682
|
-
*/
|
|
683
|
-
quickResponse?: QuickResponseData | undefined;
|
|
684
|
-
}
|
|
685
|
-
/**
|
|
686
|
-
* @public
|
|
687
|
-
*/
|
|
688
|
-
export interface DeactivateMessageTemplateRequest {
|
|
689
|
-
/**
|
|
690
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
691
|
-
* @public
|
|
692
|
-
*/
|
|
693
|
-
knowledgeBaseId: string | undefined;
|
|
694
|
-
/**
|
|
695
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
696
|
-
* @public
|
|
697
|
-
*/
|
|
698
|
-
messageTemplateId: string | undefined;
|
|
699
|
-
/**
|
|
700
|
-
* <p>The version number of the message template version to deactivate.</p>
|
|
701
|
-
* @public
|
|
702
|
-
*/
|
|
703
|
-
versionNumber: number | undefined;
|
|
704
|
-
}
|
|
705
|
-
/**
|
|
706
|
-
* @public
|
|
707
|
-
*/
|
|
708
|
-
export interface DeactivateMessageTemplateResponse {
|
|
709
|
-
/**
|
|
710
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
711
|
-
* @public
|
|
712
|
-
*/
|
|
713
|
-
messageTemplateArn: string | undefined;
|
|
714
|
-
/**
|
|
715
|
-
* <p>The identifier of the message template.</p>
|
|
716
|
-
* @public
|
|
717
|
-
*/
|
|
718
|
-
messageTemplateId: string | undefined;
|
|
719
|
-
/**
|
|
720
|
-
* <p>The version number of the message template version that has been deactivated.</p>
|
|
721
|
-
* @public
|
|
722
|
-
*/
|
|
723
|
-
versionNumber: number | undefined;
|
|
724
|
-
}
|
|
725
|
-
/**
|
|
726
|
-
* @public
|
|
727
|
-
*/
|
|
728
|
-
export interface DeleteImportJobRequest {
|
|
729
|
-
/**
|
|
730
|
-
* <p>The identifier of the knowledge base.</p>
|
|
731
|
-
* @public
|
|
732
|
-
*/
|
|
733
|
-
knowledgeBaseId: string | undefined;
|
|
734
|
-
/**
|
|
735
|
-
* <p>The identifier of the import job to be deleted.</p>
|
|
736
|
-
* @public
|
|
737
|
-
*/
|
|
738
|
-
importJobId: string | undefined;
|
|
739
|
-
}
|
|
740
|
-
/**
|
|
741
|
-
* @public
|
|
742
|
-
*/
|
|
743
|
-
export interface DeleteImportJobResponse {
|
|
744
|
-
}
|
|
745
|
-
/**
|
|
746
|
-
* @public
|
|
747
|
-
*/
|
|
748
|
-
export interface DeleteKnowledgeBaseRequest {
|
|
749
|
-
/**
|
|
750
|
-
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
751
|
-
* @public
|
|
752
|
-
*/
|
|
753
|
-
knowledgeBaseId: string | undefined;
|
|
754
|
-
}
|
|
755
|
-
/**
|
|
756
|
-
* @public
|
|
757
|
-
*/
|
|
758
|
-
export interface DeleteKnowledgeBaseResponse {
|
|
759
|
-
}
|
|
760
|
-
/**
|
|
761
|
-
* @public
|
|
762
|
-
*/
|
|
763
|
-
export interface DeleteMessageTemplateRequest {
|
|
764
|
-
/**
|
|
765
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
766
|
-
* @public
|
|
767
|
-
*/
|
|
768
|
-
knowledgeBaseId: string | undefined;
|
|
769
|
-
/**
|
|
770
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
771
|
-
* @public
|
|
772
|
-
*/
|
|
773
|
-
messageTemplateId: string | undefined;
|
|
774
|
-
}
|
|
775
|
-
/**
|
|
776
|
-
* @public
|
|
777
|
-
*/
|
|
778
|
-
export interface DeleteMessageTemplateResponse {
|
|
779
|
-
}
|
|
780
|
-
/**
|
|
781
|
-
* @public
|
|
782
|
-
*/
|
|
783
|
-
export interface DeleteMessageTemplateAttachmentRequest {
|
|
784
|
-
/**
|
|
785
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
786
|
-
* @public
|
|
787
|
-
*/
|
|
788
|
-
knowledgeBaseId: string | undefined;
|
|
789
|
-
/**
|
|
790
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
791
|
-
* @public
|
|
792
|
-
*/
|
|
793
|
-
messageTemplateId: string | undefined;
|
|
794
|
-
/**
|
|
795
|
-
* <p>The identifier of the attachment file.</p>
|
|
796
|
-
* @public
|
|
797
|
-
*/
|
|
798
|
-
attachmentId: string | undefined;
|
|
799
|
-
}
|
|
800
|
-
/**
|
|
801
|
-
* @public
|
|
802
|
-
*/
|
|
803
|
-
export interface DeleteMessageTemplateAttachmentResponse {
|
|
804
|
-
}
|
|
805
|
-
/**
|
|
806
|
-
* @public
|
|
807
|
-
*/
|
|
808
|
-
export interface DeleteQuickResponseRequest {
|
|
809
|
-
/**
|
|
810
|
-
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</p>
|
|
811
|
-
* @public
|
|
812
|
-
*/
|
|
813
|
-
knowledgeBaseId: string | undefined;
|
|
814
|
-
/**
|
|
815
|
-
* <p>The identifier of the quick response to delete.</p>
|
|
816
|
-
* @public
|
|
817
|
-
*/
|
|
818
|
-
quickResponseId: string | undefined;
|
|
819
|
-
}
|
|
820
|
-
/**
|
|
821
|
-
* @public
|
|
822
|
-
*/
|
|
823
|
-
export interface DeleteQuickResponseResponse {
|
|
824
|
-
}
|
|
825
|
-
/**
|
|
826
|
-
* @public
|
|
827
|
-
* @enum
|
|
828
|
-
*/
|
|
829
|
-
export declare const ExternalSource: {
|
|
830
|
-
readonly AMAZON_CONNECT: "AMAZON_CONNECT";
|
|
831
|
-
};
|
|
832
|
-
/**
|
|
833
|
-
* @public
|
|
834
|
-
*/
|
|
835
|
-
export type ExternalSource = (typeof ExternalSource)[keyof typeof ExternalSource];
|
|
836
|
-
/**
|
|
837
|
-
* <p>The configuration information of the external data source.</p>
|
|
838
|
-
* @public
|
|
839
|
-
*/
|
|
840
|
-
export interface ExternalSourceConfiguration {
|
|
841
|
-
/**
|
|
842
|
-
* <p>The type of the external data source.</p>
|
|
843
|
-
* @public
|
|
844
|
-
*/
|
|
845
|
-
source: ExternalSource | undefined;
|
|
846
|
-
/**
|
|
847
|
-
* <p>The configuration information of the external data source.</p>
|
|
848
|
-
* @public
|
|
849
|
-
*/
|
|
850
|
-
configuration: Configuration | undefined;
|
|
851
|
-
}
|
|
852
|
-
/**
|
|
853
|
-
* @public
|
|
854
|
-
*/
|
|
855
|
-
export interface GetImportJobRequest {
|
|
856
|
-
/**
|
|
857
|
-
* <p>The identifier of the import job to retrieve.</p>
|
|
858
|
-
* @public
|
|
859
|
-
*/
|
|
860
|
-
importJobId: string | undefined;
|
|
861
|
-
/**
|
|
862
|
-
* <p>The identifier of the knowledge base that the import job belongs to.</p>
|
|
863
|
-
* @public
|
|
864
|
-
*/
|
|
865
|
-
knowledgeBaseId: string | undefined;
|
|
866
|
-
}
|
|
867
|
-
/**
|
|
868
|
-
* @public
|
|
869
|
-
* @enum
|
|
870
|
-
*/
|
|
871
|
-
export declare const ImportJobType: {
|
|
872
|
-
readonly QUICK_RESPONSES: "QUICK_RESPONSES";
|
|
873
|
-
};
|
|
874
|
-
/**
|
|
875
|
-
* @public
|
|
876
|
-
*/
|
|
877
|
-
export type ImportJobType = (typeof ImportJobType)[keyof typeof ImportJobType];
|
|
878
|
-
/**
|
|
879
|
-
* @public
|
|
880
|
-
* @enum
|
|
881
|
-
*/
|
|
882
|
-
export declare const ImportJobStatus: {
|
|
883
|
-
readonly COMPLETE: "COMPLETE";
|
|
884
|
-
readonly DELETED: "DELETED";
|
|
885
|
-
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
886
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
887
|
-
readonly FAILED: "FAILED";
|
|
888
|
-
readonly START_IN_PROGRESS: "START_IN_PROGRESS";
|
|
889
|
-
};
|
|
890
|
-
/**
|
|
891
|
-
* @public
|
|
892
|
-
*/
|
|
893
|
-
export type ImportJobStatus = (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
|
|
894
|
-
/**
|
|
895
|
-
* <p>Summary information about the import job.</p>
|
|
896
|
-
* @public
|
|
897
|
-
*/
|
|
898
|
-
export interface ImportJobData {
|
|
899
|
-
/**
|
|
900
|
-
* <p>The identifier of the import job.</p>
|
|
901
|
-
* @public
|
|
902
|
-
*/
|
|
903
|
-
importJobId: string | undefined;
|
|
904
|
-
/**
|
|
905
|
-
* <p>The identifier of the knowledge base.</p>
|
|
906
|
-
* @public
|
|
907
|
-
*/
|
|
908
|
-
knowledgeBaseId: string | undefined;
|
|
909
|
-
/**
|
|
910
|
-
* <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>
|
|
911
|
-
* @public
|
|
912
|
-
*/
|
|
913
|
-
uploadId: string | undefined;
|
|
914
|
-
/**
|
|
915
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
916
|
-
* @public
|
|
917
|
-
*/
|
|
918
|
-
knowledgeBaseArn: string | undefined;
|
|
919
|
-
/**
|
|
920
|
-
* <p>The type of the import job.</p>
|
|
921
|
-
* @public
|
|
922
|
-
*/
|
|
923
|
-
importJobType: ImportJobType | undefined;
|
|
924
|
-
/**
|
|
925
|
-
* <p>The status of the import job.</p>
|
|
926
|
-
* @public
|
|
927
|
-
*/
|
|
928
|
-
status: ImportJobStatus | undefined;
|
|
929
|
-
/**
|
|
930
|
-
* <p>The download link to the resource file that is uploaded to the import job.</p>
|
|
931
|
-
* @public
|
|
932
|
-
*/
|
|
933
|
-
url: string | undefined;
|
|
934
|
-
/**
|
|
935
|
-
* <p>The link to download the information of resource data that failed to be imported.</p>
|
|
936
|
-
* @public
|
|
937
|
-
*/
|
|
938
|
-
failedRecordReport?: string | undefined;
|
|
939
|
-
/**
|
|
940
|
-
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
941
|
-
* @public
|
|
942
|
-
*/
|
|
943
|
-
urlExpiry: Date | undefined;
|
|
944
|
-
/**
|
|
945
|
-
* <p>The timestamp when the import job was created.</p>
|
|
946
|
-
* @public
|
|
947
|
-
*/
|
|
948
|
-
createdTime: Date | undefined;
|
|
949
|
-
/**
|
|
950
|
-
* <p>The timestamp when the import job data was last modified.</p>
|
|
951
|
-
* @public
|
|
952
|
-
*/
|
|
953
|
-
lastModifiedTime: Date | undefined;
|
|
954
|
-
/**
|
|
955
|
-
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
956
|
-
* @public
|
|
957
|
-
*/
|
|
958
|
-
metadata?: Record<string, string> | undefined;
|
|
959
|
-
/**
|
|
960
|
-
* <p>The configuration information of the external data source.</p>
|
|
961
|
-
* @public
|
|
962
|
-
*/
|
|
963
|
-
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
964
|
-
}
|
|
965
|
-
/**
|
|
966
|
-
* @public
|
|
967
|
-
*/
|
|
968
|
-
export interface GetImportJobResponse {
|
|
969
|
-
/**
|
|
970
|
-
* <p>The import job.</p>
|
|
971
|
-
* @public
|
|
972
|
-
*/
|
|
973
|
-
importJob?: ImportJobData | undefined;
|
|
974
|
-
}
|
|
975
|
-
/**
|
|
976
|
-
* @public
|
|
977
|
-
*/
|
|
978
|
-
export interface GetKnowledgeBaseRequest {
|
|
979
|
-
/**
|
|
980
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
981
|
-
* @public
|
|
982
|
-
*/
|
|
983
|
-
knowledgeBaseId: string | undefined;
|
|
984
|
-
}
|
|
985
|
-
/**
|
|
986
|
-
* @public
|
|
987
|
-
*/
|
|
988
|
-
export interface GetKnowledgeBaseResponse {
|
|
989
|
-
/**
|
|
990
|
-
* <p>The knowledge base.</p>
|
|
991
|
-
* @public
|
|
992
|
-
*/
|
|
993
|
-
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
994
|
-
}
|
|
995
|
-
/**
|
|
996
|
-
* @public
|
|
997
|
-
*/
|
|
998
|
-
export interface GetMessageTemplateRequest {
|
|
999
|
-
/**
|
|
1000
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
1001
|
-
* @public
|
|
1002
|
-
*/
|
|
1003
|
-
messageTemplateId: string | undefined;
|
|
1004
|
-
/**
|
|
1005
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1006
|
-
* @public
|
|
1007
|
-
*/
|
|
1008
|
-
knowledgeBaseId: string | undefined;
|
|
1009
|
-
}
|
|
1010
|
-
/**
|
|
1011
|
-
* @public
|
|
1012
|
-
*/
|
|
1013
|
-
export interface GetMessageTemplateResponse {
|
|
1014
|
-
/**
|
|
1015
|
-
* <p>The message template.</p>
|
|
1016
|
-
* @public
|
|
1017
|
-
*/
|
|
1018
|
-
messageTemplate?: ExtendedMessageTemplateData | undefined;
|
|
1019
|
-
}
|
|
1020
|
-
/**
|
|
1021
|
-
* @public
|
|
1022
|
-
*/
|
|
1023
|
-
export interface GetQuickResponseRequest {
|
|
1024
|
-
/**
|
|
1025
|
-
* <p>The identifier of the quick response.</p>
|
|
1026
|
-
* @public
|
|
1027
|
-
*/
|
|
1028
|
-
quickResponseId: string | undefined;
|
|
1029
|
-
/**
|
|
1030
|
-
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
|
|
1031
|
-
* @public
|
|
1032
|
-
*/
|
|
1033
|
-
knowledgeBaseId: string | undefined;
|
|
1034
|
-
}
|
|
1035
|
-
/**
|
|
1036
|
-
* @public
|
|
1037
|
-
*/
|
|
1038
|
-
export interface GetQuickResponseResponse {
|
|
1039
|
-
/**
|
|
1040
|
-
* <p>The quick response.</p>
|
|
1041
|
-
* @public
|
|
1042
|
-
*/
|
|
1043
|
-
quickResponse?: QuickResponseData | undefined;
|
|
1044
|
-
}
|
|
1045
|
-
/**
|
|
1046
|
-
* <p>Summary information about the import job.</p>
|
|
1047
|
-
* @public
|
|
1048
|
-
*/
|
|
1049
|
-
export interface ImportJobSummary {
|
|
1050
|
-
/**
|
|
1051
|
-
* <p>The identifier of the import job.</p>
|
|
1052
|
-
* @public
|
|
1053
|
-
*/
|
|
1054
|
-
importJobId: string | undefined;
|
|
1055
|
-
/**
|
|
1056
|
-
* <p>The identifier of the knowledge base.</p>
|
|
1057
|
-
* @public
|
|
1058
|
-
*/
|
|
1059
|
-
knowledgeBaseId: string | undefined;
|
|
1060
|
-
/**
|
|
1061
|
-
* <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>
|
|
1062
|
-
* @public
|
|
1063
|
-
*/
|
|
1064
|
-
uploadId: string | undefined;
|
|
1065
|
-
/**
|
|
1066
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1067
|
-
* @public
|
|
1068
|
-
*/
|
|
1069
|
-
knowledgeBaseArn: string | undefined;
|
|
1070
|
-
/**
|
|
1071
|
-
* <p>The type of import job.</p>
|
|
1072
|
-
* @public
|
|
1073
|
-
*/
|
|
1074
|
-
importJobType: ImportJobType | undefined;
|
|
1075
|
-
/**
|
|
1076
|
-
* <p>The status of the import job.</p>
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
status: ImportJobStatus | undefined;
|
|
1080
|
-
/**
|
|
1081
|
-
* <p>The timestamp when the import job was created.</p>
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
createdTime: Date | undefined;
|
|
1085
|
-
/**
|
|
1086
|
-
* <p>The timestamp when the import job was last modified.</p>
|
|
1087
|
-
* @public
|
|
1088
|
-
*/
|
|
1089
|
-
lastModifiedTime: Date | undefined;
|
|
1090
|
-
/**
|
|
1091
|
-
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
1092
|
-
* @public
|
|
1093
|
-
*/
|
|
1094
|
-
metadata?: Record<string, string> | undefined;
|
|
1095
|
-
/**
|
|
1096
|
-
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
1097
|
-
* @public
|
|
1098
|
-
*/
|
|
1099
|
-
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
1100
|
-
}
|
|
1101
|
-
/**
|
|
1102
|
-
* @public
|
|
1103
|
-
*/
|
|
1104
|
-
export interface ListImportJobsRequest {
|
|
1105
|
-
/**
|
|
1106
|
-
* <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>
|
|
1107
|
-
* @public
|
|
1108
|
-
*/
|
|
1109
|
-
nextToken?: string | undefined;
|
|
1110
|
-
/**
|
|
1111
|
-
* <p>The maximum number of results to return per page.</p>
|
|
1112
|
-
* @public
|
|
1113
|
-
*/
|
|
1114
|
-
maxResults?: number | undefined;
|
|
1115
|
-
/**
|
|
1116
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1117
|
-
* @public
|
|
1118
|
-
*/
|
|
1119
|
-
knowledgeBaseId: string | undefined;
|
|
1120
|
-
}
|
|
1121
|
-
/**
|
|
1122
|
-
* @public
|
|
1123
|
-
*/
|
|
1124
|
-
export interface ListImportJobsResponse {
|
|
1125
|
-
/**
|
|
1126
|
-
* <p>Summary information about the import jobs.</p>
|
|
1127
|
-
* @public
|
|
1128
|
-
*/
|
|
1129
|
-
importJobSummaries: ImportJobSummary[] | undefined;
|
|
1130
|
-
/**
|
|
1131
|
-
* <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>
|
|
1132
|
-
* @public
|
|
1133
|
-
*/
|
|
1134
|
-
nextToken?: string | undefined;
|
|
1135
|
-
}
|
|
1136
|
-
/**
|
|
1137
|
-
* @public
|
|
1138
|
-
*/
|
|
1139
|
-
export interface ListKnowledgeBasesRequest {
|
|
1140
|
-
/**
|
|
1141
|
-
* <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>
|
|
1142
|
-
* @public
|
|
1143
|
-
*/
|
|
1144
|
-
nextToken?: string | undefined;
|
|
1145
|
-
/**
|
|
1146
|
-
* <p>The maximum number of results to return per page.</p>
|
|
1147
|
-
* @public
|
|
1148
|
-
*/
|
|
1149
|
-
maxResults?: number | undefined;
|
|
1150
|
-
}
|
|
1151
|
-
/**
|
|
1152
|
-
* <p>Summary information about the knowledge base.</p>
|
|
1153
|
-
* @public
|
|
1154
|
-
*/
|
|
1155
|
-
export interface KnowledgeBaseSummary {
|
|
1156
|
-
/**
|
|
1157
|
-
* <p>The identifier of the knowledge base.</p>
|
|
1158
|
-
* @public
|
|
1159
|
-
*/
|
|
1160
|
-
knowledgeBaseId: string | undefined;
|
|
1161
|
-
/**
|
|
1162
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1163
|
-
* @public
|
|
1164
|
-
*/
|
|
1165
|
-
knowledgeBaseArn: string | undefined;
|
|
1166
|
-
/**
|
|
1167
|
-
* <p>The name of the knowledge base.</p>
|
|
1168
|
-
* @public
|
|
1169
|
-
*/
|
|
1170
|
-
name: string | undefined;
|
|
1171
|
-
/**
|
|
1172
|
-
* <p>The type of knowledge base.</p>
|
|
1173
|
-
* @public
|
|
1174
|
-
*/
|
|
1175
|
-
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
1176
|
-
/**
|
|
1177
|
-
* <p>The status of the knowledge base summary.</p>
|
|
1178
|
-
* @public
|
|
1179
|
-
*/
|
|
1180
|
-
status: KnowledgeBaseStatus | undefined;
|
|
1181
|
-
/**
|
|
1182
|
-
* <p>Configuration information about the external data source.</p>
|
|
1183
|
-
* @public
|
|
1184
|
-
*/
|
|
1185
|
-
sourceConfiguration?: SourceConfiguration | undefined;
|
|
1186
|
-
/**
|
|
1187
|
-
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
1188
|
-
* @public
|
|
1189
|
-
*/
|
|
1190
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
1191
|
-
/**
|
|
1192
|
-
* <p>Information about how to render the content.</p>
|
|
1193
|
-
* @public
|
|
1194
|
-
*/
|
|
1195
|
-
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
1196
|
-
/**
|
|
1197
|
-
* <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>
|
|
1198
|
-
* @public
|
|
1199
|
-
*/
|
|
1200
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
1201
|
-
/**
|
|
1202
|
-
* <p>The description of the knowledge base.</p>
|
|
1203
|
-
* @public
|
|
1204
|
-
*/
|
|
1205
|
-
description?: string | undefined;
|
|
1206
|
-
/**
|
|
1207
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1208
|
-
* @public
|
|
1209
|
-
*/
|
|
1210
|
-
tags?: Record<string, string> | undefined;
|
|
1211
|
-
}
|
|
1212
|
-
/**
|
|
1213
|
-
* @public
|
|
1214
|
-
*/
|
|
1215
|
-
export interface ListKnowledgeBasesResponse {
|
|
1216
|
-
/**
|
|
1217
|
-
* <p>Information about the knowledge bases.</p>
|
|
1218
|
-
* @public
|
|
1219
|
-
*/
|
|
1220
|
-
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
1221
|
-
/**
|
|
1222
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1223
|
-
* @public
|
|
1224
|
-
*/
|
|
1225
|
-
nextToken?: string | undefined;
|
|
1226
|
-
}
|
|
1227
|
-
/**
|
|
1228
|
-
* @public
|
|
1229
|
-
*/
|
|
1230
|
-
export interface ListMessageTemplatesRequest {
|
|
1231
|
-
/**
|
|
1232
|
-
* <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>
|
|
1233
|
-
* @public
|
|
1234
|
-
*/
|
|
1235
|
-
nextToken?: string | undefined;
|
|
1236
|
-
/**
|
|
1237
|
-
* <p>The maximum number of results to return per page.</p>
|
|
1238
|
-
* @public
|
|
1239
|
-
*/
|
|
1240
|
-
maxResults?: number | undefined;
|
|
1241
|
-
/**
|
|
1242
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1243
|
-
* @public
|
|
1244
|
-
*/
|
|
1245
|
-
knowledgeBaseId: string | undefined;
|
|
1246
|
-
}
|
|
1247
|
-
/**
|
|
1248
|
-
* <p>The summary of the message template.</p>
|
|
1249
|
-
* @public
|
|
1250
|
-
*/
|
|
1251
|
-
export interface MessageTemplateSummary {
|
|
1252
|
-
/**
|
|
1253
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
1254
|
-
* @public
|
|
1255
|
-
*/
|
|
1256
|
-
messageTemplateArn: string | undefined;
|
|
1257
|
-
/**
|
|
1258
|
-
* <p>The identifier of the message template.</p>
|
|
1259
|
-
* @public
|
|
1260
|
-
*/
|
|
1261
|
-
messageTemplateId: string | undefined;
|
|
1262
|
-
/**
|
|
1263
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1264
|
-
* @public
|
|
1265
|
-
*/
|
|
1266
|
-
knowledgeBaseArn: string | undefined;
|
|
1267
|
-
/**
|
|
1268
|
-
* <p>The identifier of the knowledge base.</p>
|
|
1269
|
-
* @public
|
|
1270
|
-
*/
|
|
1271
|
-
knowledgeBaseId: string | undefined;
|
|
1272
|
-
/**
|
|
1273
|
-
* <p>The name of the message template.</p>
|
|
1274
|
-
* @public
|
|
1275
|
-
*/
|
|
1276
|
-
name: string | undefined;
|
|
1277
|
-
/**
|
|
1278
|
-
* <p>The channel this message template applies to.</p>
|
|
1279
|
-
* @public
|
|
1280
|
-
*/
|
|
1281
|
-
channel?: string | undefined;
|
|
1282
|
-
/**
|
|
1283
|
-
* <p>The channel subtype this message template applies to.</p>
|
|
1284
|
-
* @public
|
|
1285
|
-
*/
|
|
1286
|
-
channelSubtype: ChannelSubtype | undefined;
|
|
1287
|
-
/**
|
|
1288
|
-
* <p>The timestamp when the message template was created.</p>
|
|
1289
|
-
* @public
|
|
1290
|
-
*/
|
|
1291
|
-
createdTime: Date | undefined;
|
|
1292
|
-
/**
|
|
1293
|
-
* <p>The timestamp when the message template data was last modified.</p>
|
|
1294
|
-
* @public
|
|
1295
|
-
*/
|
|
1296
|
-
lastModifiedTime: Date | undefined;
|
|
1297
|
-
/**
|
|
1298
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
1299
|
-
* @public
|
|
1300
|
-
*/
|
|
1301
|
-
lastModifiedBy: string | undefined;
|
|
1302
|
-
/**
|
|
1303
|
-
* <p>The container of message template source configuration.</p>
|
|
1304
|
-
* @public
|
|
1305
|
-
*/
|
|
1306
|
-
sourceConfiguration?: MessageTemplateSourceConfiguration | undefined;
|
|
1307
|
-
/**
|
|
1308
|
-
* <p>The version number of the message template version that is activated.</p>
|
|
1309
|
-
* @public
|
|
1310
|
-
*/
|
|
1311
|
-
activeVersionNumber?: number | undefined;
|
|
1312
|
-
/**
|
|
1313
|
-
* <p>The description of the message template.</p>
|
|
1314
|
-
* @public
|
|
1315
|
-
*/
|
|
1316
|
-
description?: string | undefined;
|
|
1317
|
-
/**
|
|
1318
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1319
|
-
* @public
|
|
1320
|
-
*/
|
|
1321
|
-
tags?: Record<string, string> | undefined;
|
|
1322
|
-
}
|
|
1323
|
-
/**
|
|
1324
|
-
* @public
|
|
1325
|
-
*/
|
|
1326
|
-
export interface ListMessageTemplatesResponse {
|
|
1327
|
-
/**
|
|
1328
|
-
* <p>Summary information about the message template.</p>
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
messageTemplateSummaries: MessageTemplateSummary[] | undefined;
|
|
1332
|
-
/**
|
|
1333
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1334
|
-
* @public
|
|
1335
|
-
*/
|
|
1336
|
-
nextToken?: string | undefined;
|
|
1337
|
-
}
|
|
1338
|
-
/**
|
|
1339
|
-
* @public
|
|
1340
|
-
*/
|
|
1341
|
-
export interface ListMessageTemplateVersionsRequest {
|
|
1342
|
-
/**
|
|
1343
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1344
|
-
* @public
|
|
1345
|
-
*/
|
|
1346
|
-
knowledgeBaseId: string | undefined;
|
|
1347
|
-
/**
|
|
1348
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
1349
|
-
* @public
|
|
1350
|
-
*/
|
|
1351
|
-
messageTemplateId: string | undefined;
|
|
1352
|
-
/**
|
|
1353
|
-
* <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>
|
|
1354
|
-
* @public
|
|
1355
|
-
*/
|
|
1356
|
-
nextToken?: string | undefined;
|
|
1357
|
-
/**
|
|
1358
|
-
* <p>The maximum number of results to return per page.</p>
|
|
1359
|
-
* @public
|
|
1360
|
-
*/
|
|
1361
|
-
maxResults?: number | undefined;
|
|
1362
|
-
}
|
|
1363
|
-
/**
|
|
1364
|
-
* <p>The summary of the message template version.</p>
|
|
1365
|
-
* @public
|
|
1366
|
-
*/
|
|
1367
|
-
export interface MessageTemplateVersionSummary {
|
|
1368
|
-
/**
|
|
1369
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
1370
|
-
* @public
|
|
1371
|
-
*/
|
|
1372
|
-
messageTemplateArn: string | undefined;
|
|
1373
|
-
/**
|
|
1374
|
-
* <p>The identifier of the message template.</p>
|
|
1375
|
-
* @public
|
|
1376
|
-
*/
|
|
1377
|
-
messageTemplateId: string | undefined;
|
|
1378
|
-
/**
|
|
1379
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1380
|
-
* @public
|
|
1381
|
-
*/
|
|
1382
|
-
knowledgeBaseArn: string | undefined;
|
|
1383
|
-
/**
|
|
1384
|
-
* <p>The identifier of the knowledge base.</p>
|
|
1385
|
-
* @public
|
|
1386
|
-
*/
|
|
1387
|
-
knowledgeBaseId: string | undefined;
|
|
1388
|
-
/**
|
|
1389
|
-
* <p>The name of the message template.</p>
|
|
1390
|
-
* @public
|
|
1391
|
-
*/
|
|
1392
|
-
name: string | undefined;
|
|
1393
|
-
/**
|
|
1394
|
-
* <p>The channel of the message template.</p>
|
|
1395
|
-
* @public
|
|
1396
|
-
*/
|
|
1397
|
-
channel?: string | undefined;
|
|
1398
|
-
/**
|
|
1399
|
-
* <p>The channel subtype this message template applies to.</p>
|
|
1400
|
-
* @public
|
|
1401
|
-
*/
|
|
1402
|
-
channelSubtype: ChannelSubtype | undefined;
|
|
1403
|
-
/**
|
|
1404
|
-
* <p>Whether the version of the message template is activated.</p>
|
|
1405
|
-
* @public
|
|
1406
|
-
*/
|
|
1407
|
-
isActive: boolean | undefined;
|
|
1408
|
-
/**
|
|
1409
|
-
* <p>The version number of the message template version.</p>
|
|
1410
|
-
* @public
|
|
1411
|
-
*/
|
|
1412
|
-
versionNumber: number | undefined;
|
|
1413
|
-
}
|
|
1414
|
-
/**
|
|
1415
|
-
* @public
|
|
1416
|
-
*/
|
|
1417
|
-
export interface ListMessageTemplateVersionsResponse {
|
|
1418
|
-
/**
|
|
1419
|
-
* <p>Summary information about the versions of a message template.</p>
|
|
1420
|
-
* @public
|
|
1421
|
-
*/
|
|
1422
|
-
messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
|
|
1423
|
-
/**
|
|
1424
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1425
|
-
* @public
|
|
1426
|
-
*/
|
|
1427
|
-
nextToken?: string | undefined;
|
|
1428
|
-
}
|
|
1429
|
-
/**
|
|
1430
|
-
* @public
|
|
1431
|
-
*/
|
|
1432
|
-
export interface RenderMessageTemplateRequest {
|
|
1433
|
-
/**
|
|
1434
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1435
|
-
* @public
|
|
1436
|
-
*/
|
|
1437
|
-
knowledgeBaseId: string | undefined;
|
|
1438
|
-
/**
|
|
1439
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
1440
|
-
* @public
|
|
1441
|
-
*/
|
|
1442
|
-
messageTemplateId: string | undefined;
|
|
1443
|
-
/**
|
|
1444
|
-
* <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>
|
|
1445
|
-
* @public
|
|
1446
|
-
*/
|
|
1447
|
-
attributes: MessageTemplateAttributes | undefined;
|
|
1448
|
-
}
|
|
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";
|
|
1449
3
|
/**
|
|
1450
4
|
* @public
|
|
1451
5
|
*/
|
|
@@ -1807,18 +361,6 @@ export interface SearchContentResponse {
|
|
|
1807
361
|
*/
|
|
1808
362
|
nextToken?: string | undefined;
|
|
1809
363
|
}
|
|
1810
|
-
/**
|
|
1811
|
-
* @public
|
|
1812
|
-
* @enum
|
|
1813
|
-
*/
|
|
1814
|
-
export declare const MessageTemplateFilterOperator: {
|
|
1815
|
-
readonly EQUALS: "EQUALS";
|
|
1816
|
-
readonly PREFIX: "PREFIX";
|
|
1817
|
-
};
|
|
1818
|
-
/**
|
|
1819
|
-
* @public
|
|
1820
|
-
*/
|
|
1821
|
-
export type MessageTemplateFilterOperator = (typeof MessageTemplateFilterOperator)[keyof typeof MessageTemplateFilterOperator];
|
|
1822
364
|
/**
|
|
1823
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>
|
|
1824
366
|
* @public
|
|
@@ -1845,18 +387,6 @@ export interface MessageTemplateFilterField {
|
|
|
1845
387
|
*/
|
|
1846
388
|
includeNoExistence?: boolean | undefined;
|
|
1847
389
|
}
|
|
1848
|
-
/**
|
|
1849
|
-
* @public
|
|
1850
|
-
* @enum
|
|
1851
|
-
*/
|
|
1852
|
-
export declare const Order: {
|
|
1853
|
-
readonly ASC: "ASC";
|
|
1854
|
-
readonly DESC: "DESC";
|
|
1855
|
-
};
|
|
1856
|
-
/**
|
|
1857
|
-
* @public
|
|
1858
|
-
*/
|
|
1859
|
-
export type Order = (typeof Order)[keyof typeof Order];
|
|
1860
390
|
/**
|
|
1861
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>
|
|
1862
392
|
* @public
|
|
@@ -1873,31 +403,6 @@ export interface MessageTemplateOrderField {
|
|
|
1873
403
|
*/
|
|
1874
404
|
order?: Order | undefined;
|
|
1875
405
|
}
|
|
1876
|
-
/**
|
|
1877
|
-
* @public
|
|
1878
|
-
* @enum
|
|
1879
|
-
*/
|
|
1880
|
-
export declare const MessageTemplateQueryOperator: {
|
|
1881
|
-
readonly CONTAINS: "CONTAINS";
|
|
1882
|
-
readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
|
|
1883
|
-
};
|
|
1884
|
-
/**
|
|
1885
|
-
* @public
|
|
1886
|
-
*/
|
|
1887
|
-
export type MessageTemplateQueryOperator = (typeof MessageTemplateQueryOperator)[keyof typeof MessageTemplateQueryOperator];
|
|
1888
|
-
/**
|
|
1889
|
-
* @public
|
|
1890
|
-
* @enum
|
|
1891
|
-
*/
|
|
1892
|
-
export declare const Priority: {
|
|
1893
|
-
readonly HIGH: "HIGH";
|
|
1894
|
-
readonly LOW: "LOW";
|
|
1895
|
-
readonly MEDIUM: "MEDIUM";
|
|
1896
|
-
};
|
|
1897
|
-
/**
|
|
1898
|
-
* @public
|
|
1899
|
-
*/
|
|
1900
|
-
export type Priority = (typeof Priority)[keyof typeof Priority];
|
|
1901
406
|
/**
|
|
1902
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>
|
|
1903
408
|
* @public
|
|
@@ -2081,18 +586,6 @@ export interface SearchMessageTemplatesResponse {
|
|
|
2081
586
|
*/
|
|
2082
587
|
nextToken?: string | undefined;
|
|
2083
588
|
}
|
|
2084
|
-
/**
|
|
2085
|
-
* @public
|
|
2086
|
-
* @enum
|
|
2087
|
-
*/
|
|
2088
|
-
export declare const QuickResponseFilterOperator: {
|
|
2089
|
-
readonly EQUALS: "EQUALS";
|
|
2090
|
-
readonly PREFIX: "PREFIX";
|
|
2091
|
-
};
|
|
2092
|
-
/**
|
|
2093
|
-
* @public
|
|
2094
|
-
*/
|
|
2095
|
-
export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
|
|
2096
589
|
/**
|
|
2097
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>
|
|
2098
591
|
* @public
|
|
@@ -2135,18 +628,6 @@ export interface QuickResponseOrderField {
|
|
|
2135
628
|
*/
|
|
2136
629
|
order?: Order | undefined;
|
|
2137
630
|
}
|
|
2138
|
-
/**
|
|
2139
|
-
* @public
|
|
2140
|
-
* @enum
|
|
2141
|
-
*/
|
|
2142
|
-
export declare const QuickResponseQueryOperator: {
|
|
2143
|
-
readonly CONTAINS: "CONTAINS";
|
|
2144
|
-
readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
|
|
2145
|
-
};
|
|
2146
|
-
/**
|
|
2147
|
-
* @public
|
|
2148
|
-
*/
|
|
2149
|
-
export type QuickResponseQueryOperator = (typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
|
|
2150
631
|
/**
|
|
2151
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>
|
|
2152
633
|
* @public
|