@aws-sdk/client-qconnect 3.835.0 → 3.840.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/README.md +1 -34
- package/dist-cjs/index.js +50 -14
- package/dist-es/models/models_0.js +12 -13
- package/dist-es/models/models_1.js +14 -1
- package/dist-es/protocols/Aws_restJson1.js +17 -1
- package/dist-types/QConnect.d.ts +1 -34
- package/dist-types/QConnectClient.d.ts +1 -34
- package/dist-types/commands/ActivateMessageTemplateCommand.d.ts +2 -8
- package/dist-types/commands/CreateAIAgentCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIGuardrailCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIGuardrailVersionCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIPromptCommand.d.ts +5 -6
- package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +5 -6
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +3 -9
- package/dist-types/commands/CreateAssistantCommand.d.ts +5 -6
- package/dist-types/commands/CreateContentAssociationCommand.d.ts +6 -25
- package/dist-types/commands/CreateContentCommand.d.ts +5 -6
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +6 -30
- package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +6 -11
- package/dist-types/commands/CreateMessageTemplateCommand.d.ts +3 -10
- package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +3 -16
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +5 -6
- package/dist-types/commands/CreateSessionCommand.d.ts +5 -7
- package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +2 -7
- package/dist-types/commands/DeleteAIAgentCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAIGuardrailCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAIGuardrailVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAIPromptCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAssistantCommand.d.ts +3 -0
- package/dist-types/commands/DeleteContentAssociationCommand.d.ts +4 -4
- package/dist-types/commands/DeleteContentCommand.d.ts +4 -4
- package/dist-types/commands/DeleteImportJobCommand.d.ts +4 -4
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +5 -13
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +2 -7
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +2 -9
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +3 -0
- package/dist-types/commands/GetAIAgentCommand.d.ts +3 -0
- package/dist-types/commands/GetAIGuardrailCommand.d.ts +3 -0
- package/dist-types/commands/GetAIPromptCommand.d.ts +3 -0
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +3 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +3 -0
- package/dist-types/commands/GetContentAssociationCommand.d.ts +4 -4
- package/dist-types/commands/GetContentCommand.d.ts +3 -0
- package/dist-types/commands/GetContentSummaryCommand.d.ts +3 -0
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +3 -0
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +4 -6
- package/dist-types/commands/GetQuickResponseCommand.d.ts +3 -0
- package/dist-types/commands/GetRecommendationsCommand.d.ts +1 -10
- package/dist-types/commands/GetSessionCommand.d.ts +3 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIGuardrailVersionsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIGuardrailsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +3 -0
- package/dist-types/commands/ListAIPromptsCommand.d.ts +3 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +3 -0
- package/dist-types/commands/ListContentAssociationsCommand.d.ts +4 -4
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -2
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -2
- package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +1 -3
- package/dist-types/commands/PutFeedbackCommand.d.ts +1 -2
- package/dist-types/commands/QueryAssistantCommand.d.ts +2 -11
- package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +1 -2
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -5
- package/dist-types/commands/SearchContentCommand.d.ts +4 -2
- package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +3 -0
- package/dist-types/commands/SearchQuickResponsesCommand.d.ts +4 -3
- package/dist-types/commands/SearchSessionsCommand.d.ts +3 -0
- package/dist-types/commands/SendMessageCommand.d.ts +2 -7
- package/dist-types/commands/StartContentUploadCommand.d.ts +4 -6
- package/dist-types/commands/StartImportJobCommand.d.ts +6 -16
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAIGuardrailCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAIPromptCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +1 -2
- package/dist-types/commands/UpdateContentCommand.d.ts +4 -2
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -6
- package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +2 -9
- package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +2 -9
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +5 -6
- package/dist-types/commands/UpdateSessionCommand.d.ts +4 -3
- package/dist-types/commands/UpdateSessionDataCommand.d.ts +3 -0
- package/dist-types/index.d.ts +1 -34
- package/dist-types/models/models_0.d.ts +229 -1216
- package/dist-types/models/models_1.d.ts +185 -393
- package/dist-types/ts3.4/models/models_0.d.ts +7 -25
- package/dist-types/ts3.4/models/models_1.d.ts +26 -1
- package/package.json +18 -18
|
@@ -1,6 +1,112 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
import { ChannelSubtype, Configuration, ContentDataDetails, ContentSummary, DataReference, Document,
|
|
2
|
+
import { ChannelSubtype, Configuration, ContentDataDetails, ContentSummary, DataReference, Document, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttachment, MessageTemplateAttributes, MessageTemplateAttributeType, MessageTemplateContentProvider, MessageTemplateData, QueryResultType, RankingData, RecommendationTrigger, RecommendationType, RelevanceLevel, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, VectorIngestionConfiguration } from "./models_0";
|
|
3
3
|
import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* <p>The extended data of a message template.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface ExtendedMessageTemplateData {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
messageTemplateArn: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The identifier of the message template.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
messageTemplateId: string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
knowledgeBaseArn: string | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* <p>The identifier of the knowledge base.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
knowledgeBaseId: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The name of the message template.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
name: string | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>The timestamp when the message template was created.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
createdTime: Date | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>The timestamp when the message template data was last modified.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
lastModifiedTime: Date | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
lastModifiedBy: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>The content of the message template.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
content: MessageTemplateContentProvider | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* <p>The description of the message template.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
description?: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* <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>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
language?: string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* <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>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* <p>The types of attributes contain the message template.</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
attributeTypes?: MessageTemplateAttributeType[] | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* <p>The message template attachments.</p>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
attachments?: MessageTemplateAttachment[] | undefined;
|
|
89
|
+
/**
|
|
90
|
+
* <p>Whether the version of the message template is activated.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
isActive?: boolean | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>The version number of the message template version.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
versionNumber?: number | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <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>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
messageTemplateContentSha256: string | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
tags?: Record<string, string> | undefined;
|
|
109
|
+
}
|
|
4
110
|
/**
|
|
5
111
|
* @public
|
|
6
112
|
*/
|
|
@@ -61,23 +167,12 @@ export interface CreateQuickResponseRequest {
|
|
|
61
167
|
*/
|
|
62
168
|
content: QuickResponseDataProvider | undefined;
|
|
63
169
|
/**
|
|
64
|
-
* <p>The media type of the quick response content.</p>
|
|
65
|
-
* <ul>
|
|
66
|
-
* <li>
|
|
67
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written
|
|
68
|
-
* in plain text.</p>
|
|
69
|
-
* </li>
|
|
70
|
-
* <li>
|
|
71
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response
|
|
72
|
-
* written in richtext.</p>
|
|
73
|
-
* </li>
|
|
74
|
-
* </ul>
|
|
170
|
+
* <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>
|
|
75
171
|
* @public
|
|
76
172
|
*/
|
|
77
173
|
contentType?: string | undefined;
|
|
78
174
|
/**
|
|
79
|
-
* <p>The configuration information of the user groups that the quick response is accessible
|
|
80
|
-
* to.</p>
|
|
175
|
+
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
81
176
|
* @public
|
|
82
177
|
*/
|
|
83
178
|
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
@@ -87,8 +182,7 @@ export interface CreateQuickResponseRequest {
|
|
|
87
182
|
*/
|
|
88
183
|
description?: string | undefined;
|
|
89
184
|
/**
|
|
90
|
-
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
91
|
-
* knowledge base. </p>
|
|
185
|
+
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base. </p>
|
|
92
186
|
* @public
|
|
93
187
|
*/
|
|
94
188
|
shortcutKey?: string | undefined;
|
|
@@ -103,18 +197,12 @@ export interface CreateQuickResponseRequest {
|
|
|
103
197
|
*/
|
|
104
198
|
channels?: string[] | undefined;
|
|
105
199
|
/**
|
|
106
|
-
* <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>,
|
|
107
|
-
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
108
|
-
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
109
|
-
* </p>
|
|
200
|
+
* <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>
|
|
110
201
|
* @public
|
|
111
202
|
*/
|
|
112
203
|
language?: string | undefined;
|
|
113
204
|
/**
|
|
114
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
115
|
-
* request. If not provided, the Amazon Web Services
|
|
116
|
-
* SDK populates this field. For more information about idempotency, see
|
|
117
|
-
* <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
205
|
+
* <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>
|
|
118
206
|
* @public
|
|
119
207
|
*/
|
|
120
208
|
clientToken?: string | undefined;
|
|
@@ -219,17 +307,7 @@ export interface QuickResponseData {
|
|
|
219
307
|
*/
|
|
220
308
|
name: string | undefined;
|
|
221
309
|
/**
|
|
222
|
-
* <p>The media type of the quick response content.</p>
|
|
223
|
-
* <ul>
|
|
224
|
-
* <li>
|
|
225
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
226
|
-
* in plain text.</p>
|
|
227
|
-
* </li>
|
|
228
|
-
* <li>
|
|
229
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
230
|
-
* written in richtext.</p>
|
|
231
|
-
* </li>
|
|
232
|
-
* </ul>
|
|
310
|
+
* <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>
|
|
233
311
|
* @public
|
|
234
312
|
*/
|
|
235
313
|
contentType: string | undefined;
|
|
@@ -259,20 +337,17 @@ export interface QuickResponseData {
|
|
|
259
337
|
*/
|
|
260
338
|
description?: string | undefined;
|
|
261
339
|
/**
|
|
262
|
-
* <p>The configuration information of the user groups that the quick response is accessible
|
|
263
|
-
* to.</p>
|
|
340
|
+
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
264
341
|
* @public
|
|
265
342
|
*/
|
|
266
343
|
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
267
344
|
/**
|
|
268
|
-
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
269
|
-
* knowledge base.</p>
|
|
345
|
+
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>
|
|
270
346
|
* @public
|
|
271
347
|
*/
|
|
272
348
|
shortcutKey?: string | undefined;
|
|
273
349
|
/**
|
|
274
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
275
|
-
* data.</p>
|
|
350
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
276
351
|
* @public
|
|
277
352
|
*/
|
|
278
353
|
lastModifiedBy?: string | undefined;
|
|
@@ -282,16 +357,12 @@ export interface QuickResponseData {
|
|
|
282
357
|
*/
|
|
283
358
|
isActive?: boolean | undefined;
|
|
284
359
|
/**
|
|
285
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
286
|
-
* The supported contact channel types include <code>Chat</code>.</p>
|
|
360
|
+
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
287
361
|
* @public
|
|
288
362
|
*/
|
|
289
363
|
channels?: string[] | undefined;
|
|
290
364
|
/**
|
|
291
|
-
* <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>,
|
|
292
|
-
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
293
|
-
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
294
|
-
* </p>
|
|
365
|
+
* <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>
|
|
295
366
|
* @public
|
|
296
367
|
*/
|
|
297
368
|
language?: string | undefined;
|
|
@@ -316,14 +387,12 @@ export interface CreateQuickResponseResponse {
|
|
|
316
387
|
*/
|
|
317
388
|
export interface DeactivateMessageTemplateRequest {
|
|
318
389
|
/**
|
|
319
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
320
|
-
* the ARN.</p>
|
|
390
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
321
391
|
* @public
|
|
322
392
|
*/
|
|
323
393
|
knowledgeBaseId: string | undefined;
|
|
324
394
|
/**
|
|
325
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
326
|
-
* any qualifier.</p>
|
|
395
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
327
396
|
* @public
|
|
328
397
|
*/
|
|
329
398
|
messageTemplateId: string | undefined;
|
|
@@ -393,8 +462,7 @@ export interface DeleteKnowledgeBaseResponse {
|
|
|
393
462
|
*/
|
|
394
463
|
export interface DeleteMessageTemplateRequest {
|
|
395
464
|
/**
|
|
396
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
397
|
-
* the ARN.</p>
|
|
465
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
398
466
|
* @public
|
|
399
467
|
*/
|
|
400
468
|
knowledgeBaseId: string | undefined;
|
|
@@ -414,14 +482,12 @@ export interface DeleteMessageTemplateResponse {
|
|
|
414
482
|
*/
|
|
415
483
|
export interface DeleteMessageTemplateAttachmentRequest {
|
|
416
484
|
/**
|
|
417
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
418
|
-
* the ARN.</p>
|
|
485
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
419
486
|
* @public
|
|
420
487
|
*/
|
|
421
488
|
knowledgeBaseId: string | undefined;
|
|
422
489
|
/**
|
|
423
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
424
|
-
* any qualifier.</p>
|
|
490
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
425
491
|
* @public
|
|
426
492
|
*/
|
|
427
493
|
messageTemplateId: string | undefined;
|
|
@@ -636,8 +702,7 @@ export interface GetMessageTemplateRequest {
|
|
|
636
702
|
*/
|
|
637
703
|
messageTemplateId: string | undefined;
|
|
638
704
|
/**
|
|
639
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
640
|
-
* the ARN.</p>
|
|
705
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
641
706
|
* @public
|
|
642
707
|
*/
|
|
643
708
|
knowledgeBaseId: string | undefined;
|
|
@@ -728,8 +793,7 @@ export interface ImportJobSummary {
|
|
|
728
793
|
*/
|
|
729
794
|
metadata?: Record<string, string> | undefined;
|
|
730
795
|
/**
|
|
731
|
-
* <p>The configuration information of the external source that the resource data are imported
|
|
732
|
-
* from.</p>
|
|
796
|
+
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
733
797
|
* @public
|
|
734
798
|
*/
|
|
735
799
|
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
@@ -739,8 +803,7 @@ export interface ImportJobSummary {
|
|
|
739
803
|
*/
|
|
740
804
|
export interface ListImportJobsRequest {
|
|
741
805
|
/**
|
|
742
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
743
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
806
|
+
* <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>
|
|
744
807
|
* @public
|
|
745
808
|
*/
|
|
746
809
|
nextToken?: string | undefined;
|
|
@@ -765,8 +828,7 @@ export interface ListImportJobsResponse {
|
|
|
765
828
|
*/
|
|
766
829
|
importJobSummaries: ImportJobSummary[] | undefined;
|
|
767
830
|
/**
|
|
768
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
769
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
831
|
+
* <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>
|
|
770
832
|
* @public
|
|
771
833
|
*/
|
|
772
834
|
nextToken?: string | undefined;
|
|
@@ -776,8 +838,7 @@ export interface ListImportJobsResponse {
|
|
|
776
838
|
*/
|
|
777
839
|
export interface ListKnowledgeBasesRequest {
|
|
778
840
|
/**
|
|
779
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
780
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
841
|
+
* <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>
|
|
781
842
|
* @public
|
|
782
843
|
*/
|
|
783
844
|
nextToken?: string | undefined;
|
|
@@ -833,13 +894,7 @@ export interface KnowledgeBaseSummary {
|
|
|
833
894
|
*/
|
|
834
895
|
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
835
896
|
/**
|
|
836
|
-
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
837
|
-
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
838
|
-
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
839
|
-
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
840
|
-
* key to invoke Amazon Q in Connect. </p>
|
|
841
|
-
* <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
|
|
842
|
-
* your instance</a>.</p>
|
|
897
|
+
* <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>
|
|
843
898
|
* @public
|
|
844
899
|
*/
|
|
845
900
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
@@ -874,8 +929,7 @@ export interface ListKnowledgeBasesResponse {
|
|
|
874
929
|
*/
|
|
875
930
|
export interface ListMessageTemplatesRequest {
|
|
876
931
|
/**
|
|
877
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
878
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
932
|
+
* <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>
|
|
879
933
|
* @public
|
|
880
934
|
*/
|
|
881
935
|
nextToken?: string | undefined;
|
|
@@ -885,8 +939,7 @@ export interface ListMessageTemplatesRequest {
|
|
|
885
939
|
*/
|
|
886
940
|
maxResults?: number | undefined;
|
|
887
941
|
/**
|
|
888
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
889
|
-
* the ARN.</p>
|
|
942
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
890
943
|
* @public
|
|
891
944
|
*/
|
|
892
945
|
knowledgeBaseId: string | undefined;
|
|
@@ -937,8 +990,7 @@ export interface MessageTemplateSummary {
|
|
|
937
990
|
*/
|
|
938
991
|
lastModifiedTime: Date | undefined;
|
|
939
992
|
/**
|
|
940
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template
|
|
941
|
-
* data.</p>
|
|
993
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
942
994
|
* @public
|
|
943
995
|
*/
|
|
944
996
|
lastModifiedBy: string | undefined;
|
|
@@ -978,20 +1030,17 @@ export interface ListMessageTemplatesResponse {
|
|
|
978
1030
|
*/
|
|
979
1031
|
export interface ListMessageTemplateVersionsRequest {
|
|
980
1032
|
/**
|
|
981
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
982
|
-
* the ARN.</p>
|
|
1033
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
983
1034
|
* @public
|
|
984
1035
|
*/
|
|
985
1036
|
knowledgeBaseId: string | undefined;
|
|
986
1037
|
/**
|
|
987
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
988
|
-
* any qualifier.</p>
|
|
1038
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
989
1039
|
* @public
|
|
990
1040
|
*/
|
|
991
1041
|
messageTemplateId: string | undefined;
|
|
992
1042
|
/**
|
|
993
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
994
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
1043
|
+
* <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>
|
|
995
1044
|
* @public
|
|
996
1045
|
*/
|
|
997
1046
|
nextToken?: string | undefined;
|
|
@@ -1067,8 +1116,7 @@ export interface ListMessageTemplateVersionsResponse {
|
|
|
1067
1116
|
*/
|
|
1068
1117
|
export interface RenderMessageTemplateRequest {
|
|
1069
1118
|
/**
|
|
1070
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
1071
|
-
* the ARN.</p>
|
|
1119
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1072
1120
|
* @public
|
|
1073
1121
|
*/
|
|
1074
1122
|
knowledgeBaseId: string | undefined;
|
|
@@ -1078,10 +1126,7 @@ export interface RenderMessageTemplateRequest {
|
|
|
1078
1126
|
*/
|
|
1079
1127
|
messageTemplateId: string | undefined;
|
|
1080
1128
|
/**
|
|
1081
|
-
* <p>An object that specifies the values to use for variables in the message template. This
|
|
1082
|
-
* object contains different categories of key-value pairs. Each key defines a variable or
|
|
1083
|
-
* placeholder in the message template. The corresponding value defines the value for that
|
|
1084
|
-
* variable.</p>
|
|
1129
|
+
* <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>
|
|
1085
1130
|
* @public
|
|
1086
1131
|
*/
|
|
1087
1132
|
attributes: MessageTemplateAttributes | undefined;
|
|
@@ -1111,14 +1156,12 @@ export interface RenderMessageTemplateResponse {
|
|
|
1111
1156
|
*/
|
|
1112
1157
|
export interface UpdateMessageTemplateRequest {
|
|
1113
1158
|
/**
|
|
1114
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
1115
|
-
* the ARN.</p>
|
|
1159
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1116
1160
|
* @public
|
|
1117
1161
|
*/
|
|
1118
1162
|
knowledgeBaseId: string | undefined;
|
|
1119
1163
|
/**
|
|
1120
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
1121
|
-
* any qualifier.</p>
|
|
1164
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
1122
1165
|
* @public
|
|
1123
1166
|
*/
|
|
1124
1167
|
messageTemplateId: string | undefined;
|
|
@@ -1128,18 +1171,12 @@ export interface UpdateMessageTemplateRequest {
|
|
|
1128
1171
|
*/
|
|
1129
1172
|
content?: MessageTemplateContentProvider | undefined;
|
|
1130
1173
|
/**
|
|
1131
|
-
* <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>,
|
|
1132
|
-
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
1133
|
-
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
1134
|
-
* </p>
|
|
1174
|
+
* <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>
|
|
1135
1175
|
* @public
|
|
1136
1176
|
*/
|
|
1137
1177
|
language?: string | undefined;
|
|
1138
1178
|
/**
|
|
1139
|
-
* <p>An object that specifies the default values to use for variables in the message template.
|
|
1140
|
-
* This object contains different categories of key-value pairs. Each key defines a variable or
|
|
1141
|
-
* placeholder in the message template. The corresponding value defines the default value for
|
|
1142
|
-
* that variable.</p>
|
|
1179
|
+
* <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>
|
|
1143
1180
|
* @public
|
|
1144
1181
|
*/
|
|
1145
1182
|
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
@@ -1159,14 +1196,12 @@ export interface UpdateMessageTemplateResponse {
|
|
|
1159
1196
|
*/
|
|
1160
1197
|
export interface UpdateMessageTemplateMetadataRequest {
|
|
1161
1198
|
/**
|
|
1162
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
1163
|
-
* the ARN.</p>
|
|
1199
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1164
1200
|
* @public
|
|
1165
1201
|
*/
|
|
1166
1202
|
knowledgeBaseId: string | undefined;
|
|
1167
1203
|
/**
|
|
1168
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
1169
|
-
* any qualifier.</p>
|
|
1204
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
1170
1205
|
* @public
|
|
1171
1206
|
*/
|
|
1172
1207
|
messageTemplateId: string | undefined;
|
|
@@ -1201,8 +1236,7 @@ export interface UpdateMessageTemplateMetadataResponse {
|
|
|
1201
1236
|
*/
|
|
1202
1237
|
export interface ListQuickResponsesRequest {
|
|
1203
1238
|
/**
|
|
1204
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1205
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
1239
|
+
* <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>
|
|
1206
1240
|
* @public
|
|
1207
1241
|
*/
|
|
1208
1242
|
nextToken?: string | undefined;
|
|
@@ -1248,17 +1282,7 @@ export interface QuickResponseSummary {
|
|
|
1248
1282
|
*/
|
|
1249
1283
|
name: string | undefined;
|
|
1250
1284
|
/**
|
|
1251
|
-
* <p>The media type of the quick response content.</p>
|
|
1252
|
-
* <ul>
|
|
1253
|
-
* <li>
|
|
1254
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
1255
|
-
* in plain text.</p>
|
|
1256
|
-
* </li>
|
|
1257
|
-
* <li>
|
|
1258
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
1259
|
-
* written in richtext.</p>
|
|
1260
|
-
* </li>
|
|
1261
|
-
* </ul>
|
|
1285
|
+
* <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>
|
|
1262
1286
|
* @public
|
|
1263
1287
|
*/
|
|
1264
1288
|
contentType: string | undefined;
|
|
@@ -1283,8 +1307,7 @@ export interface QuickResponseSummary {
|
|
|
1283
1307
|
*/
|
|
1284
1308
|
description?: string | undefined;
|
|
1285
1309
|
/**
|
|
1286
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
1287
|
-
* data.</p>
|
|
1310
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
1288
1311
|
* @public
|
|
1289
1312
|
*/
|
|
1290
1313
|
lastModifiedBy?: string | undefined;
|
|
@@ -1294,8 +1317,7 @@ export interface QuickResponseSummary {
|
|
|
1294
1317
|
*/
|
|
1295
1318
|
isActive?: boolean | undefined;
|
|
1296
1319
|
/**
|
|
1297
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
1298
|
-
* The supported contact channel types include <code>Chat</code>.</p>
|
|
1320
|
+
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
1299
1321
|
* @public
|
|
1300
1322
|
*/
|
|
1301
1323
|
channels?: string[] | undefined;
|
|
@@ -1315,8 +1337,7 @@ export interface ListQuickResponsesResponse {
|
|
|
1315
1337
|
*/
|
|
1316
1338
|
quickResponseSummaries: QuickResponseSummary[] | undefined;
|
|
1317
1339
|
/**
|
|
1318
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1319
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
1340
|
+
* <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>
|
|
1320
1341
|
* @public
|
|
1321
1342
|
*/
|
|
1322
1343
|
nextToken?: string | undefined;
|
|
@@ -1346,17 +1367,7 @@ export interface UpdateQuickResponseRequest {
|
|
|
1346
1367
|
*/
|
|
1347
1368
|
content?: QuickResponseDataProvider | undefined;
|
|
1348
1369
|
/**
|
|
1349
|
-
* <p>The media type of the quick response content.</p>
|
|
1350
|
-
* <ul>
|
|
1351
|
-
* <li>
|
|
1352
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
1353
|
-
* in plain text.</p>
|
|
1354
|
-
* </li>
|
|
1355
|
-
* <li>
|
|
1356
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
1357
|
-
* written in richtext.</p>
|
|
1358
|
-
* </li>
|
|
1359
|
-
* </ul>
|
|
1370
|
+
* <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>
|
|
1360
1371
|
* @public
|
|
1361
1372
|
*/
|
|
1362
1373
|
contentType?: string | undefined;
|
|
@@ -1381,8 +1392,7 @@ export interface UpdateQuickResponseRequest {
|
|
|
1381
1392
|
*/
|
|
1382
1393
|
removeDescription?: boolean | undefined;
|
|
1383
1394
|
/**
|
|
1384
|
-
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
1385
|
-
* knowledge base.</p>
|
|
1395
|
+
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>
|
|
1386
1396
|
* @public
|
|
1387
1397
|
*/
|
|
1388
1398
|
shortcutKey?: string | undefined;
|
|
@@ -1397,16 +1407,12 @@ export interface UpdateQuickResponseRequest {
|
|
|
1397
1407
|
*/
|
|
1398
1408
|
isActive?: boolean | undefined;
|
|
1399
1409
|
/**
|
|
1400
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
1401
|
-
* The supported contact channel types include <code>Chat</code>.</p>
|
|
1410
|
+
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
1402
1411
|
* @public
|
|
1403
1412
|
*/
|
|
1404
1413
|
channels?: string[] | undefined;
|
|
1405
1414
|
/**
|
|
1406
|
-
* <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>,
|
|
1407
|
-
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
1408
|
-
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
1409
|
-
* </p>
|
|
1415
|
+
* <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>
|
|
1410
1416
|
* @public
|
|
1411
1417
|
*/
|
|
1412
1418
|
language?: string | undefined;
|
|
@@ -1441,8 +1447,7 @@ export interface RemoveKnowledgeBaseTemplateUriResponse {
|
|
|
1441
1447
|
*/
|
|
1442
1448
|
export interface SearchContentRequest {
|
|
1443
1449
|
/**
|
|
1444
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1445
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
1450
|
+
* <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>
|
|
1446
1451
|
* @public
|
|
1447
1452
|
*/
|
|
1448
1453
|
nextToken?: string | undefined;
|
|
@@ -1490,43 +1495,7 @@ export declare const MessageTemplateFilterOperator: {
|
|
|
1490
1495
|
*/
|
|
1491
1496
|
export type MessageTemplateFilterOperator = (typeof MessageTemplateFilterOperator)[keyof typeof MessageTemplateFilterOperator];
|
|
1492
1497
|
/**
|
|
1493
|
-
* <p>The message template fields to filter the message template query results by. The following
|
|
1494
|
-
* is the list of supported field names:</p>
|
|
1495
|
-
* <ul>
|
|
1496
|
-
* <li>
|
|
1497
|
-
* <p>name</p>
|
|
1498
|
-
* </li>
|
|
1499
|
-
* <li>
|
|
1500
|
-
* <p>description</p>
|
|
1501
|
-
* </li>
|
|
1502
|
-
* <li>
|
|
1503
|
-
* <p>channel</p>
|
|
1504
|
-
* </li>
|
|
1505
|
-
* <li>
|
|
1506
|
-
* <p>channelSubtype</p>
|
|
1507
|
-
* </li>
|
|
1508
|
-
* <li>
|
|
1509
|
-
* <p>language</p>
|
|
1510
|
-
* </li>
|
|
1511
|
-
* <li>
|
|
1512
|
-
* <p>qualifier</p>
|
|
1513
|
-
* </li>
|
|
1514
|
-
* <li>
|
|
1515
|
-
* <p>createdTime</p>
|
|
1516
|
-
* </li>
|
|
1517
|
-
* <li>
|
|
1518
|
-
* <p>lastModifiedTime</p>
|
|
1519
|
-
* </li>
|
|
1520
|
-
* <li>
|
|
1521
|
-
* <p>lastModifiedBy</p>
|
|
1522
|
-
* </li>
|
|
1523
|
-
* <li>
|
|
1524
|
-
* <p>groupingConfiguration.criteria</p>
|
|
1525
|
-
* </li>
|
|
1526
|
-
* <li>
|
|
1527
|
-
* <p>groupingConfiguration.values</p>
|
|
1528
|
-
* </li>
|
|
1529
|
-
* </ul>
|
|
1498
|
+
* <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>
|
|
1530
1499
|
* @public
|
|
1531
1500
|
*/
|
|
1532
1501
|
export interface MessageTemplateFilterField {
|
|
@@ -1564,43 +1533,7 @@ export declare const Order: {
|
|
|
1564
1533
|
*/
|
|
1565
1534
|
export type Order = (typeof Order)[keyof typeof Order];
|
|
1566
1535
|
/**
|
|
1567
|
-
* <p>The message template fields to order the message template query results by. The following
|
|
1568
|
-
* is the list of supported field names:</p>
|
|
1569
|
-
* <ul>
|
|
1570
|
-
* <li>
|
|
1571
|
-
* <p>name</p>
|
|
1572
|
-
* </li>
|
|
1573
|
-
* <li>
|
|
1574
|
-
* <p>description</p>
|
|
1575
|
-
* </li>
|
|
1576
|
-
* <li>
|
|
1577
|
-
* <p>channel</p>
|
|
1578
|
-
* </li>
|
|
1579
|
-
* <li>
|
|
1580
|
-
* <p>channelSubtype</p>
|
|
1581
|
-
* </li>
|
|
1582
|
-
* <li>
|
|
1583
|
-
* <p>language</p>
|
|
1584
|
-
* </li>
|
|
1585
|
-
* <li>
|
|
1586
|
-
* <p>qualifier</p>
|
|
1587
|
-
* </li>
|
|
1588
|
-
* <li>
|
|
1589
|
-
* <p>createdTime</p>
|
|
1590
|
-
* </li>
|
|
1591
|
-
* <li>
|
|
1592
|
-
* <p>lastModifiedTime</p>
|
|
1593
|
-
* </li>
|
|
1594
|
-
* <li>
|
|
1595
|
-
* <p>lastModifiedBy</p>
|
|
1596
|
-
* </li>
|
|
1597
|
-
* <li>
|
|
1598
|
-
* <p>groupingConfiguration.criteria</p>
|
|
1599
|
-
* </li>
|
|
1600
|
-
* <li>
|
|
1601
|
-
* <p>groupingConfiguration.values</p>
|
|
1602
|
-
* </li>
|
|
1603
|
-
* </ul>
|
|
1536
|
+
* <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>
|
|
1604
1537
|
* @public
|
|
1605
1538
|
*/
|
|
1606
1539
|
export interface MessageTemplateOrderField {
|
|
@@ -1641,16 +1574,7 @@ export declare const Priority: {
|
|
|
1641
1574
|
*/
|
|
1642
1575
|
export type Priority = (typeof Priority)[keyof typeof Priority];
|
|
1643
1576
|
/**
|
|
1644
|
-
* <p>The message template fields to query message templates by. The following is the list of
|
|
1645
|
-
* supported field names:</p>
|
|
1646
|
-
* <ul>
|
|
1647
|
-
* <li>
|
|
1648
|
-
* <p>name</p>
|
|
1649
|
-
* </li>
|
|
1650
|
-
* <li>
|
|
1651
|
-
* <p>description</p>
|
|
1652
|
-
* </li>
|
|
1653
|
-
* </ul>
|
|
1577
|
+
* <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>
|
|
1654
1578
|
* @public
|
|
1655
1579
|
*/
|
|
1656
1580
|
export interface MessageTemplateQueryField {
|
|
@@ -1670,14 +1594,12 @@ export interface MessageTemplateQueryField {
|
|
|
1670
1594
|
*/
|
|
1671
1595
|
operator: MessageTemplateQueryOperator | undefined;
|
|
1672
1596
|
/**
|
|
1673
|
-
* <p>Whether the query expects only exact matches on the attribute field values. The results of
|
|
1674
|
-
* the query will only include exact matches if this parameter is set to false.</p>
|
|
1597
|
+
* <p>Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.</p>
|
|
1675
1598
|
* @public
|
|
1676
1599
|
*/
|
|
1677
1600
|
allowFuzziness?: boolean | undefined;
|
|
1678
1601
|
/**
|
|
1679
|
-
* <p>The importance of the attribute field when calculating query result relevancy scores. The
|
|
1680
|
-
* value set for this parameter affects the ordering of search results.</p>
|
|
1602
|
+
* <p>The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.</p>
|
|
1681
1603
|
* @public
|
|
1682
1604
|
*/
|
|
1683
1605
|
priority?: Priority | undefined;
|
|
@@ -1708,8 +1630,7 @@ export interface MessageTemplateSearchExpression {
|
|
|
1708
1630
|
*/
|
|
1709
1631
|
export interface SearchMessageTemplatesRequest {
|
|
1710
1632
|
/**
|
|
1711
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
1712
|
-
* the ARN.</p>
|
|
1633
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1713
1634
|
* @public
|
|
1714
1635
|
*/
|
|
1715
1636
|
knowledgeBaseId: string | undefined;
|
|
@@ -1719,8 +1640,7 @@ export interface SearchMessageTemplatesRequest {
|
|
|
1719
1640
|
*/
|
|
1720
1641
|
searchExpression: MessageTemplateSearchExpression | undefined;
|
|
1721
1642
|
/**
|
|
1722
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1723
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
1643
|
+
* <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>
|
|
1724
1644
|
* @public
|
|
1725
1645
|
*/
|
|
1726
1646
|
nextToken?: string | undefined;
|
|
@@ -1776,8 +1696,7 @@ export interface MessageTemplateSearchResultData {
|
|
|
1776
1696
|
*/
|
|
1777
1697
|
lastModifiedTime: Date | undefined;
|
|
1778
1698
|
/**
|
|
1779
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template
|
|
1780
|
-
* data.</p>
|
|
1699
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
1781
1700
|
* @public
|
|
1782
1701
|
*/
|
|
1783
1702
|
lastModifiedBy: string | undefined;
|
|
@@ -1802,10 +1721,7 @@ export interface MessageTemplateSearchResultData {
|
|
|
1802
1721
|
*/
|
|
1803
1722
|
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
1804
1723
|
/**
|
|
1805
|
-
* <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>,
|
|
1806
|
-
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
1807
|
-
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
1808
|
-
* </p>
|
|
1724
|
+
* <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>
|
|
1809
1725
|
* @public
|
|
1810
1726
|
*/
|
|
1811
1727
|
language?: string | undefined;
|
|
@@ -1843,46 +1759,7 @@ export declare const QuickResponseFilterOperator: {
|
|
|
1843
1759
|
*/
|
|
1844
1760
|
export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
|
|
1845
1761
|
/**
|
|
1846
|
-
* <p>The quick response fields to filter the quick response query results by.</p>
|
|
1847
|
-
* <p>The following is the list of supported field names.</p>
|
|
1848
|
-
* <ul>
|
|
1849
|
-
* <li>
|
|
1850
|
-
* <p>name</p>
|
|
1851
|
-
* </li>
|
|
1852
|
-
* <li>
|
|
1853
|
-
* <p>description</p>
|
|
1854
|
-
* </li>
|
|
1855
|
-
* <li>
|
|
1856
|
-
* <p>shortcutKey</p>
|
|
1857
|
-
* </li>
|
|
1858
|
-
* <li>
|
|
1859
|
-
* <p>isActive</p>
|
|
1860
|
-
* </li>
|
|
1861
|
-
* <li>
|
|
1862
|
-
* <p>channels</p>
|
|
1863
|
-
* </li>
|
|
1864
|
-
* <li>
|
|
1865
|
-
* <p>language</p>
|
|
1866
|
-
* </li>
|
|
1867
|
-
* <li>
|
|
1868
|
-
* <p>contentType</p>
|
|
1869
|
-
* </li>
|
|
1870
|
-
* <li>
|
|
1871
|
-
* <p>createdTime</p>
|
|
1872
|
-
* </li>
|
|
1873
|
-
* <li>
|
|
1874
|
-
* <p>lastModifiedTime</p>
|
|
1875
|
-
* </li>
|
|
1876
|
-
* <li>
|
|
1877
|
-
* <p>lastModifiedBy</p>
|
|
1878
|
-
* </li>
|
|
1879
|
-
* <li>
|
|
1880
|
-
* <p>groupingConfiguration.criteria</p>
|
|
1881
|
-
* </li>
|
|
1882
|
-
* <li>
|
|
1883
|
-
* <p>groupingConfiguration.values</p>
|
|
1884
|
-
* </li>
|
|
1885
|
-
* </ul>
|
|
1762
|
+
* <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>
|
|
1886
1763
|
* @public
|
|
1887
1764
|
*/
|
|
1888
1765
|
export interface QuickResponseFilterField {
|
|
@@ -1908,46 +1785,7 @@ export interface QuickResponseFilterField {
|
|
|
1908
1785
|
includeNoExistence?: boolean | undefined;
|
|
1909
1786
|
}
|
|
1910
1787
|
/**
|
|
1911
|
-
* <p>The quick response fields to order the quick response query results by.</p>
|
|
1912
|
-
* <p>The following is the list of supported field names.</p>
|
|
1913
|
-
* <ul>
|
|
1914
|
-
* <li>
|
|
1915
|
-
* <p>name</p>
|
|
1916
|
-
* </li>
|
|
1917
|
-
* <li>
|
|
1918
|
-
* <p>description</p>
|
|
1919
|
-
* </li>
|
|
1920
|
-
* <li>
|
|
1921
|
-
* <p>shortcutKey</p>
|
|
1922
|
-
* </li>
|
|
1923
|
-
* <li>
|
|
1924
|
-
* <p>isActive</p>
|
|
1925
|
-
* </li>
|
|
1926
|
-
* <li>
|
|
1927
|
-
* <p>channels</p>
|
|
1928
|
-
* </li>
|
|
1929
|
-
* <li>
|
|
1930
|
-
* <p>language</p>
|
|
1931
|
-
* </li>
|
|
1932
|
-
* <li>
|
|
1933
|
-
* <p>contentType</p>
|
|
1934
|
-
* </li>
|
|
1935
|
-
* <li>
|
|
1936
|
-
* <p>createdTime</p>
|
|
1937
|
-
* </li>
|
|
1938
|
-
* <li>
|
|
1939
|
-
* <p>lastModifiedTime</p>
|
|
1940
|
-
* </li>
|
|
1941
|
-
* <li>
|
|
1942
|
-
* <p>lastModifiedBy</p>
|
|
1943
|
-
* </li>
|
|
1944
|
-
* <li>
|
|
1945
|
-
* <p>groupingConfiguration.criteria</p>
|
|
1946
|
-
* </li>
|
|
1947
|
-
* <li>
|
|
1948
|
-
* <p>groupingConfiguration.values</p>
|
|
1949
|
-
* </li>
|
|
1950
|
-
* </ul>
|
|
1788
|
+
* <p>The quick response fields to order 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>
|
|
1951
1789
|
* @public
|
|
1952
1790
|
*/
|
|
1953
1791
|
export interface QuickResponseOrderField {
|
|
@@ -1975,22 +1813,7 @@ export declare const QuickResponseQueryOperator: {
|
|
|
1975
1813
|
*/
|
|
1976
1814
|
export type QuickResponseQueryOperator = (typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
|
|
1977
1815
|
/**
|
|
1978
|
-
* <p>The quick response fields to query quick responses by.</p>
|
|
1979
|
-
* <p>The following is the list of supported field names.</p>
|
|
1980
|
-
* <ul>
|
|
1981
|
-
* <li>
|
|
1982
|
-
* <p>content</p>
|
|
1983
|
-
* </li>
|
|
1984
|
-
* <li>
|
|
1985
|
-
* <p>name</p>
|
|
1986
|
-
* </li>
|
|
1987
|
-
* <li>
|
|
1988
|
-
* <p>description</p>
|
|
1989
|
-
* </li>
|
|
1990
|
-
* <li>
|
|
1991
|
-
* <p>shortcutKey</p>
|
|
1992
|
-
* </li>
|
|
1993
|
-
* </ul>
|
|
1816
|
+
* <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>
|
|
1994
1817
|
* @public
|
|
1995
1818
|
*/
|
|
1996
1819
|
export interface QuickResponseQueryField {
|
|
@@ -2010,14 +1833,12 @@ export interface QuickResponseQueryField {
|
|
|
2010
1833
|
*/
|
|
2011
1834
|
operator: QuickResponseQueryOperator | undefined;
|
|
2012
1835
|
/**
|
|
2013
|
-
* <p>Whether the query expects only exact matches on the attribute field values. The results of
|
|
2014
|
-
* the query will only include exact matches if this parameter is set to false.</p>
|
|
1836
|
+
* <p>Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.</p>
|
|
2015
1837
|
* @public
|
|
2016
1838
|
*/
|
|
2017
1839
|
allowFuzziness?: boolean | undefined;
|
|
2018
1840
|
/**
|
|
2019
|
-
* <p>The importance of the attribute field when calculating query result relevancy scores. The
|
|
2020
|
-
* value set for this parameter affects the ordering of search results.</p>
|
|
1841
|
+
* <p>The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.</p>
|
|
2021
1842
|
* @public
|
|
2022
1843
|
*/
|
|
2023
1844
|
priority?: Priority | undefined;
|
|
@@ -2058,8 +1879,7 @@ export interface SearchQuickResponsesRequest {
|
|
|
2058
1879
|
*/
|
|
2059
1880
|
searchExpression: QuickResponseSearchExpression | undefined;
|
|
2060
1881
|
/**
|
|
2061
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2062
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
1882
|
+
* <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>
|
|
2063
1883
|
* @public
|
|
2064
1884
|
*/
|
|
2065
1885
|
nextToken?: string | undefined;
|
|
@@ -2069,8 +1889,7 @@ export interface SearchQuickResponsesRequest {
|
|
|
2069
1889
|
*/
|
|
2070
1890
|
maxResults?: number | undefined;
|
|
2071
1891
|
/**
|
|
2072
|
-
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search
|
|
2073
|
-
* results are returned.</p>
|
|
1892
|
+
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</p>
|
|
2074
1893
|
* @public
|
|
2075
1894
|
*/
|
|
2076
1895
|
attributes?: Record<string, string> | undefined;
|
|
@@ -2106,17 +1925,7 @@ export interface QuickResponseSearchResultData {
|
|
|
2106
1925
|
*/
|
|
2107
1926
|
name: string | undefined;
|
|
2108
1927
|
/**
|
|
2109
|
-
* <p>The media type of the quick response content.</p>
|
|
2110
|
-
* <ul>
|
|
2111
|
-
* <li>
|
|
2112
|
-
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
2113
|
-
* in plain text.</p>
|
|
2114
|
-
* </li>
|
|
2115
|
-
* <li>
|
|
2116
|
-
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
2117
|
-
* written in richtext.</p>
|
|
2118
|
-
* </li>
|
|
2119
|
-
* </ul>
|
|
1928
|
+
* <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>
|
|
2120
1929
|
* @public
|
|
2121
1930
|
*/
|
|
2122
1931
|
contentType: string | undefined;
|
|
@@ -2151,26 +1960,22 @@ export interface QuickResponseSearchResultData {
|
|
|
2151
1960
|
*/
|
|
2152
1961
|
description?: string | undefined;
|
|
2153
1962
|
/**
|
|
2154
|
-
* <p>The configuration information of the user groups that the quick response is accessible
|
|
2155
|
-
* to.</p>
|
|
1963
|
+
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
2156
1964
|
* @public
|
|
2157
1965
|
*/
|
|
2158
1966
|
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
2159
1967
|
/**
|
|
2160
|
-
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
2161
|
-
* knowledge base.</p>
|
|
1968
|
+
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>
|
|
2162
1969
|
* @public
|
|
2163
1970
|
*/
|
|
2164
1971
|
shortcutKey?: string | undefined;
|
|
2165
1972
|
/**
|
|
2166
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search
|
|
2167
|
-
* result data.</p>
|
|
1973
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.</p>
|
|
2168
1974
|
* @public
|
|
2169
1975
|
*/
|
|
2170
1976
|
lastModifiedBy?: string | undefined;
|
|
2171
1977
|
/**
|
|
2172
|
-
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
2173
|
-
* The supported contact channel types include <code>Chat</code>.</p>
|
|
1978
|
+
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
2174
1979
|
* @public
|
|
2175
1980
|
*/
|
|
2176
1981
|
channels?: string[] | undefined;
|
|
@@ -2180,14 +1985,12 @@ export interface QuickResponseSearchResultData {
|
|
|
2180
1985
|
*/
|
|
2181
1986
|
language?: string | undefined;
|
|
2182
1987
|
/**
|
|
2183
|
-
* <p>The user defined contact attributes that are not resolved when the search result is
|
|
2184
|
-
* returned.</p>
|
|
1988
|
+
* <p>The user defined contact attributes that are not resolved when the search result is returned.</p>
|
|
2185
1989
|
* @public
|
|
2186
1990
|
*/
|
|
2187
1991
|
attributesNotInterpolated?: string[] | undefined;
|
|
2188
1992
|
/**
|
|
2189
|
-
* <p>The user defined contact attributes that are resolved when the search result is
|
|
2190
|
-
* returned.</p>
|
|
1993
|
+
* <p>The user defined contact attributes that are resolved when the search result is returned.</p>
|
|
2191
1994
|
* @public
|
|
2192
1995
|
*/
|
|
2193
1996
|
attributesInterpolated?: string[] | undefined;
|
|
@@ -2207,8 +2010,7 @@ export interface SearchQuickResponsesResponse {
|
|
|
2207
2010
|
*/
|
|
2208
2011
|
results: QuickResponseSearchResultData[] | undefined;
|
|
2209
2012
|
/**
|
|
2210
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2211
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
2013
|
+
* <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>
|
|
2212
2014
|
* @public
|
|
2213
2015
|
*/
|
|
2214
2016
|
nextToken?: string | undefined;
|
|
@@ -2263,24 +2065,12 @@ export interface StartContentUploadResponse {
|
|
|
2263
2065
|
*/
|
|
2264
2066
|
export interface StartImportJobRequest {
|
|
2265
2067
|
/**
|
|
2266
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2267
|
-
* <ul>
|
|
2268
|
-
* <li>
|
|
2269
|
-
* <p>For importing Amazon Q in Connect quick responses, this should be a <code>QUICK_RESPONSES</code>
|
|
2270
|
-
* type knowledge base.</p>
|
|
2271
|
-
* </li>
|
|
2272
|
-
* </ul>
|
|
2068
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p> <ul> <li> <p>For importing Amazon Q in Connect quick responses, this should be a <code>QUICK_RESPONSES</code> type knowledge base.</p> </li> </ul>
|
|
2273
2069
|
* @public
|
|
2274
2070
|
*/
|
|
2275
2071
|
knowledgeBaseId: string | undefined;
|
|
2276
2072
|
/**
|
|
2277
|
-
* <p>The type of the import job.</p>
|
|
2278
|
-
* <ul>
|
|
2279
|
-
* <li>
|
|
2280
|
-
* <p>For importing quick response resource, set the value to
|
|
2281
|
-
* <code>QUICK_RESPONSES</code>.</p>
|
|
2282
|
-
* </li>
|
|
2283
|
-
* </ul>
|
|
2073
|
+
* <p>The type of the import job.</p> <ul> <li> <p>For importing quick response resource, set the value to <code>QUICK_RESPONSES</code>.</p> </li> </ul>
|
|
2284
2074
|
* @public
|
|
2285
2075
|
*/
|
|
2286
2076
|
importJobType: ImportJobType | undefined;
|
|
@@ -2300,8 +2090,7 @@ export interface StartImportJobRequest {
|
|
|
2300
2090
|
*/
|
|
2301
2091
|
metadata?: Record<string, string> | undefined;
|
|
2302
2092
|
/**
|
|
2303
|
-
* <p>The configuration information of the external source that the resource data are imported
|
|
2304
|
-
* from.</p>
|
|
2093
|
+
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
2305
2094
|
* @public
|
|
2306
2095
|
*/
|
|
2307
2096
|
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
@@ -2540,8 +2329,7 @@ export interface GenerativeChunkDataDetails {
|
|
|
2540
2329
|
*/
|
|
2541
2330
|
references?: DataSummary[] | undefined;
|
|
2542
2331
|
/**
|
|
2543
|
-
* <p>The token for the next set of chunks. Use the value returned in the previous response in
|
|
2544
|
-
* the next request to retrieve the next set of chunks.</p>
|
|
2332
|
+
* <p>The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.</p>
|
|
2545
2333
|
* @public
|
|
2546
2334
|
*/
|
|
2547
2335
|
nextChunkToken?: string | undefined;
|
|
@@ -2664,6 +2452,10 @@ export interface QueryAssistantResponse {
|
|
|
2664
2452
|
*/
|
|
2665
2453
|
nextToken?: string | undefined;
|
|
2666
2454
|
}
|
|
2455
|
+
/**
|
|
2456
|
+
* @internal
|
|
2457
|
+
*/
|
|
2458
|
+
export declare const ExtendedMessageTemplateDataFilterSensitiveLog: (obj: ExtendedMessageTemplateData) => any;
|
|
2667
2459
|
/**
|
|
2668
2460
|
* @internal
|
|
2669
2461
|
*/
|