@aws-sdk/client-kendra 3.301.0 → 3.303.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 +40 -0
- package/dist-cjs/Kendra.js +75 -0
- package/dist-cjs/commands/BatchDeleteFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/CreateFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/DescribeFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/ListFeaturedResultsSetsCommand.js +45 -0
- package/dist-cjs/commands/UpdateFeaturedResultsSetCommand.js +45 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +381 -438
- package/dist-cjs/models/models_1.js +20 -0
- package/dist-cjs/protocols/Aws_json1_1.js +597 -4
- package/dist-es/Kendra.js +75 -0
- package/dist-es/commands/BatchDeleteFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/CreateFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/DescribeFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/ListFeaturedResultsSetsCommand.js +41 -0
- package/dist-es/commands/UpdateFeaturedResultsSetCommand.js +41 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +377 -434
- package/dist-es/models/models_1.js +18 -1
- package/dist-es/protocols/Aws_json1_1.js +584 -1
- package/dist-types/Kendra.d.ts +163 -132
- package/dist-types/KendraClient.d.ts +7 -2
- package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +1 -1
- package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +6 -6
- package/dist-types/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +88 -0
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +9 -13
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +14 -13
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +17 -20
- package/dist-types/commands/CreateDataSourceCommand.d.ts +3 -4
- package/dist-types/commands/CreateExperienceCommand.d.ts +3 -2
- package/dist-types/commands/CreateFaqCommand.d.ts +6 -6
- package/dist-types/commands/CreateFeaturedResultsSetCommand.d.ts +117 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +3 -2
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +3 -2
- package/dist-types/commands/CreateThesaurusCommand.d.ts +3 -2
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFaqCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +13 -15
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFaqCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFeaturedResultsSetCommand.d.ts +86 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +8 -9
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +1 -1
- package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +3 -2
- package/dist-types/commands/GetSnapshotsCommand.d.ts +3 -4
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +5 -5
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListEntityPersonasCommand.d.ts +1 -1
- package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/ListExperiencesCommand.d.ts +1 -1
- package/dist-types/commands/ListFaqsCommand.d.ts +1 -1
- package/dist-types/commands/ListFeaturedResultsSetsCommand.d.ts +87 -0
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +4 -5
- package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/ListThesauriCommand.d.ts +1 -1
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +15 -21
- package/dist-types/commands/QueryCommand.d.ts +3 -2
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +4 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +20 -20
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateExperienceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +105 -0
- package/dist-types/commands/UpdateIndexCommand.d.ts +4 -3
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1943 -1687
- package/dist-types/models/models_1.d.ts +491 -72
- package/dist-types/protocols/Aws_json1_1.d.ts +15 -0
- package/dist-types/ts3.4/Kendra.d.ts +85 -0
- package/dist-types/ts3.4/KendraClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/BatchDeleteFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListFeaturedResultsSetsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SubmitFeedbackCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateExperienceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFeaturedResultsSetCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +563 -453
- package/dist-types/ts3.4/models/models_1.d.ts +127 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
- package/package.json +34 -34
|
@@ -18,10 +18,11 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
18
18
|
export interface AclConfiguration {
|
|
19
19
|
AllowedGroupsColumnName: string | undefined;
|
|
20
20
|
}
|
|
21
|
-
export declare
|
|
22
|
-
STANDARD
|
|
23
|
-
THESAURUS_SYNONYM
|
|
24
|
-
}
|
|
21
|
+
export declare const HighlightType: {
|
|
22
|
+
readonly STANDARD: "STANDARD";
|
|
23
|
+
readonly THESAURUS_SYNONYM: "THESAURUS_SYNONYM";
|
|
24
|
+
};
|
|
25
|
+
export type HighlightType = (typeof HighlightType)[keyof typeof HighlightType];
|
|
25
26
|
export interface Highlight {
|
|
26
27
|
BeginOffset: number | undefined;
|
|
27
28
|
EndOffset: number | undefined;
|
|
@@ -35,9 +36,11 @@ export interface TextWithHighlights {
|
|
|
35
36
|
export interface AdditionalResultAttributeValue {
|
|
36
37
|
TextWithHighlightsValue?: TextWithHighlights;
|
|
37
38
|
}
|
|
38
|
-
export declare
|
|
39
|
-
TEXT_WITH_HIGHLIGHTS_VALUE
|
|
40
|
-
}
|
|
39
|
+
export declare const AdditionalResultAttributeValueType: {
|
|
40
|
+
readonly TEXT_WITH_HIGHLIGHTS_VALUE: "TEXT_WITH_HIGHLIGHTS_VALUE";
|
|
41
|
+
};
|
|
42
|
+
export type AdditionalResultAttributeValueType =
|
|
43
|
+
(typeof AdditionalResultAttributeValueType)[keyof typeof AdditionalResultAttributeValueType];
|
|
41
44
|
export interface AdditionalResultAttribute {
|
|
42
45
|
Key: string | undefined;
|
|
43
46
|
ValueType: AdditionalResultAttributeValueType | string | undefined;
|
|
@@ -48,11 +51,13 @@ export interface DataSourceToIndexFieldMapping {
|
|
|
48
51
|
DateFieldFormat?: string;
|
|
49
52
|
IndexFieldName: string | undefined;
|
|
50
53
|
}
|
|
51
|
-
export declare
|
|
52
|
-
blog
|
|
53
|
-
documentLibrary
|
|
54
|
-
wiki
|
|
55
|
-
}
|
|
54
|
+
export declare const AlfrescoEntity: {
|
|
55
|
+
readonly blog: "blog";
|
|
56
|
+
readonly documentLibrary: "documentLibrary";
|
|
57
|
+
readonly wiki: "wiki";
|
|
58
|
+
};
|
|
59
|
+
export type AlfrescoEntity =
|
|
60
|
+
(typeof AlfrescoEntity)[keyof typeof AlfrescoEntity];
|
|
56
61
|
export interface S3Path {
|
|
57
62
|
Bucket: string | undefined;
|
|
58
63
|
Key: string | undefined;
|
|
@@ -76,10 +81,11 @@ export interface AlfrescoConfiguration {
|
|
|
76
81
|
ExclusionPatterns?: string[];
|
|
77
82
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
78
83
|
}
|
|
79
|
-
export declare
|
|
80
|
-
GROUP
|
|
81
|
-
USER
|
|
82
|
-
}
|
|
84
|
+
export declare const EntityType: {
|
|
85
|
+
readonly GROUP: "GROUP";
|
|
86
|
+
readonly USER: "USER";
|
|
87
|
+
};
|
|
88
|
+
export type EntityType = (typeof EntityType)[keyof typeof EntityType];
|
|
83
89
|
export interface EntityConfiguration {
|
|
84
90
|
EntityId: string | undefined;
|
|
85
91
|
EntityType: EntityType | string | undefined;
|
|
@@ -136,10 +142,11 @@ export declare class ValidationException extends __BaseException {
|
|
|
136
142
|
opts: __ExceptionOptionType<ValidationException, __BaseException>
|
|
137
143
|
);
|
|
138
144
|
}
|
|
139
|
-
export declare
|
|
140
|
-
OWNER
|
|
141
|
-
VIEWER
|
|
142
|
-
}
|
|
145
|
+
export declare const Persona: {
|
|
146
|
+
readonly OWNER: "OWNER";
|
|
147
|
+
readonly VIEWER: "VIEWER";
|
|
148
|
+
};
|
|
149
|
+
export type Persona = (typeof Persona)[keyof typeof Persona];
|
|
143
150
|
export interface EntityPersonaConfiguration {
|
|
144
151
|
EntityId: string | undefined;
|
|
145
152
|
Persona: Persona | string | undefined;
|
|
@@ -179,10 +186,11 @@ export interface BatchDeleteDocumentRequest {
|
|
|
179
186
|
DocumentIdList: string[] | undefined;
|
|
180
187
|
DataSourceSyncJobMetricTarget?: DataSourceSyncJobMetricTarget;
|
|
181
188
|
}
|
|
182
|
-
export declare
|
|
183
|
-
INTERNAL_ERROR
|
|
184
|
-
INVALID_REQUEST
|
|
185
|
-
}
|
|
189
|
+
export declare const ErrorCode: {
|
|
190
|
+
readonly INTERNAL_ERROR: "InternalError";
|
|
191
|
+
readonly INVALID_REQUEST: "InvalidRequest";
|
|
192
|
+
};
|
|
193
|
+
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
186
194
|
export interface BatchDeleteDocumentResponseFailedDocument {
|
|
187
195
|
Id?: string;
|
|
188
196
|
ErrorCode?: ErrorCode | string;
|
|
@@ -197,6 +205,18 @@ export declare class ConflictException extends __BaseException {
|
|
|
197
205
|
Message?: string;
|
|
198
206
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
199
207
|
}
|
|
208
|
+
export interface BatchDeleteFeaturedResultsSetRequest {
|
|
209
|
+
IndexId: string | undefined;
|
|
210
|
+
FeaturedResultsSetIds: string[] | undefined;
|
|
211
|
+
}
|
|
212
|
+
export interface BatchDeleteFeaturedResultsSetError {
|
|
213
|
+
Id: string | undefined;
|
|
214
|
+
ErrorCode: ErrorCode | string | undefined;
|
|
215
|
+
ErrorMessage: string | undefined;
|
|
216
|
+
}
|
|
217
|
+
export interface BatchDeleteFeaturedResultsSetResponse {
|
|
218
|
+
Errors: BatchDeleteFeaturedResultsSetError[] | undefined;
|
|
219
|
+
}
|
|
200
220
|
export interface DocumentInfo {
|
|
201
221
|
DocumentId: string | undefined;
|
|
202
222
|
Attributes?: DocumentAttribute[];
|
|
@@ -205,14 +225,16 @@ export interface BatchGetDocumentStatusRequest {
|
|
|
205
225
|
IndexId: string | undefined;
|
|
206
226
|
DocumentInfoList: DocumentInfo[] | undefined;
|
|
207
227
|
}
|
|
208
|
-
export declare
|
|
209
|
-
FAILED
|
|
210
|
-
INDEXED
|
|
211
|
-
NOT_FOUND
|
|
212
|
-
PROCESSING
|
|
213
|
-
UPDATED
|
|
214
|
-
UPDATE_FAILED
|
|
215
|
-
}
|
|
228
|
+
export declare const DocumentStatus: {
|
|
229
|
+
readonly FAILED: "FAILED";
|
|
230
|
+
readonly INDEXED: "INDEXED";
|
|
231
|
+
readonly NOT_FOUND: "NOT_FOUND";
|
|
232
|
+
readonly PROCESSING: "PROCESSING";
|
|
233
|
+
readonly UPDATED: "UPDATED";
|
|
234
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
235
|
+
};
|
|
236
|
+
export type DocumentStatus =
|
|
237
|
+
(typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
216
238
|
export interface Status {
|
|
217
239
|
DocumentId?: string;
|
|
218
240
|
DocumentStatus?: DocumentStatus | string;
|
|
@@ -228,19 +250,21 @@ export interface BatchGetDocumentStatusResponse {
|
|
|
228
250
|
Errors?: BatchGetDocumentStatusResponseError[];
|
|
229
251
|
DocumentStatusList?: Status[];
|
|
230
252
|
}
|
|
231
|
-
export declare
|
|
232
|
-
BeginsWith
|
|
233
|
-
Contains
|
|
234
|
-
Equals
|
|
235
|
-
Exists
|
|
236
|
-
GreaterThan
|
|
237
|
-
GreaterThanOrEquals
|
|
238
|
-
LessThan
|
|
239
|
-
LessThanOrEquals
|
|
240
|
-
NotContains
|
|
241
|
-
NotEquals
|
|
242
|
-
NotExists
|
|
243
|
-
}
|
|
253
|
+
export declare const ConditionOperator: {
|
|
254
|
+
readonly BeginsWith: "BeginsWith";
|
|
255
|
+
readonly Contains: "Contains";
|
|
256
|
+
readonly Equals: "Equals";
|
|
257
|
+
readonly Exists: "Exists";
|
|
258
|
+
readonly GreaterThan: "GreaterThan";
|
|
259
|
+
readonly GreaterThanOrEquals: "GreaterThanOrEquals";
|
|
260
|
+
readonly LessThan: "LessThan";
|
|
261
|
+
readonly LessThanOrEquals: "LessThanOrEquals";
|
|
262
|
+
readonly NotContains: "NotContains";
|
|
263
|
+
readonly NotEquals: "NotEquals";
|
|
264
|
+
readonly NotExists: "NotExists";
|
|
265
|
+
};
|
|
266
|
+
export type ConditionOperator =
|
|
267
|
+
(typeof ConditionOperator)[keyof typeof ConditionOperator];
|
|
244
268
|
export interface DocumentAttributeCondition {
|
|
245
269
|
ConditionDocumentAttributeKey: string | undefined;
|
|
246
270
|
Operator: ConditionOperator | string | undefined;
|
|
@@ -267,34 +291,38 @@ export interface CustomDocumentEnrichmentConfiguration {
|
|
|
267
291
|
PostExtractionHookConfiguration?: HookConfiguration;
|
|
268
292
|
RoleArn?: string;
|
|
269
293
|
}
|
|
270
|
-
export declare
|
|
271
|
-
ALLOW
|
|
272
|
-
DENY
|
|
273
|
-
}
|
|
274
|
-
export
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
294
|
+
export declare const ReadAccessType: {
|
|
295
|
+
readonly ALLOW: "ALLOW";
|
|
296
|
+
readonly DENY: "DENY";
|
|
297
|
+
};
|
|
298
|
+
export type ReadAccessType =
|
|
299
|
+
(typeof ReadAccessType)[keyof typeof ReadAccessType];
|
|
300
|
+
export declare const PrincipalType: {
|
|
301
|
+
readonly GROUP: "GROUP";
|
|
302
|
+
readonly USER: "USER";
|
|
303
|
+
};
|
|
304
|
+
export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
|
|
278
305
|
export interface Principal {
|
|
279
306
|
Name: string | undefined;
|
|
280
307
|
Type: PrincipalType | string | undefined;
|
|
281
308
|
Access: ReadAccessType | string | undefined;
|
|
282
309
|
DataSourceId?: string;
|
|
283
310
|
}
|
|
284
|
-
export declare
|
|
285
|
-
CSV
|
|
286
|
-
HTML
|
|
287
|
-
JSON
|
|
288
|
-
MD
|
|
289
|
-
MS_EXCEL
|
|
290
|
-
MS_WORD
|
|
291
|
-
PDF
|
|
292
|
-
PLAIN_TEXT
|
|
293
|
-
PPT
|
|
294
|
-
RTF
|
|
295
|
-
XML
|
|
296
|
-
XSLT
|
|
297
|
-
}
|
|
311
|
+
export declare const ContentType: {
|
|
312
|
+
readonly CSV: "CSV";
|
|
313
|
+
readonly HTML: "HTML";
|
|
314
|
+
readonly JSON: "JSON";
|
|
315
|
+
readonly MD: "MD";
|
|
316
|
+
readonly MS_EXCEL: "MS_EXCEL";
|
|
317
|
+
readonly MS_WORD: "MS_WORD";
|
|
318
|
+
readonly PDF: "PDF";
|
|
319
|
+
readonly PLAIN_TEXT: "PLAIN_TEXT";
|
|
320
|
+
readonly PPT: "PPT";
|
|
321
|
+
readonly RTF: "RTF";
|
|
322
|
+
readonly XML: "XML";
|
|
323
|
+
readonly XSLT: "XSLT";
|
|
324
|
+
};
|
|
325
|
+
export type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
298
326
|
export interface HierarchicalPrincipal {
|
|
299
327
|
PrincipalList: Principal[] | undefined;
|
|
300
328
|
}
|
|
@@ -360,19 +388,21 @@ export interface BoxConfiguration {
|
|
|
360
388
|
ExclusionPatterns?: string[];
|
|
361
389
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
362
390
|
}
|
|
363
|
-
export declare
|
|
364
|
-
AUTHOR
|
|
365
|
-
CONTENT_TYPE
|
|
366
|
-
CREATED_DATE
|
|
367
|
-
DISPLAY_URL
|
|
368
|
-
FILE_SIZE
|
|
369
|
-
ITEM_TYPE
|
|
370
|
-
PARENT_ID
|
|
371
|
-
SPACE_KEY
|
|
372
|
-
SPACE_NAME
|
|
373
|
-
URL
|
|
374
|
-
VERSION
|
|
375
|
-
}
|
|
391
|
+
export declare const ConfluenceAttachmentFieldName: {
|
|
392
|
+
readonly AUTHOR: "AUTHOR";
|
|
393
|
+
readonly CONTENT_TYPE: "CONTENT_TYPE";
|
|
394
|
+
readonly CREATED_DATE: "CREATED_DATE";
|
|
395
|
+
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
396
|
+
readonly FILE_SIZE: "FILE_SIZE";
|
|
397
|
+
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
398
|
+
readonly PARENT_ID: "PARENT_ID";
|
|
399
|
+
readonly SPACE_KEY: "SPACE_KEY";
|
|
400
|
+
readonly SPACE_NAME: "SPACE_NAME";
|
|
401
|
+
readonly URL: "URL";
|
|
402
|
+
readonly VERSION: "VERSION";
|
|
403
|
+
};
|
|
404
|
+
export type ConfluenceAttachmentFieldName =
|
|
405
|
+
(typeof ConfluenceAttachmentFieldName)[keyof typeof ConfluenceAttachmentFieldName];
|
|
376
406
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
377
407
|
DataSourceFieldName?: ConfluenceAttachmentFieldName | string;
|
|
378
408
|
DateFieldFormat?: string;
|
|
@@ -382,21 +412,25 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
382
412
|
CrawlAttachments?: boolean;
|
|
383
413
|
AttachmentFieldMappings?: ConfluenceAttachmentToIndexFieldMapping[];
|
|
384
414
|
}
|
|
385
|
-
export declare
|
|
386
|
-
HTTP_BASIC
|
|
387
|
-
PAT
|
|
388
|
-
}
|
|
389
|
-
export
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
415
|
+
export declare const ConfluenceAuthenticationType: {
|
|
416
|
+
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
417
|
+
readonly PAT: "PAT";
|
|
418
|
+
};
|
|
419
|
+
export type ConfluenceAuthenticationType =
|
|
420
|
+
(typeof ConfluenceAuthenticationType)[keyof typeof ConfluenceAuthenticationType];
|
|
421
|
+
export declare const ConfluenceBlogFieldName: {
|
|
422
|
+
readonly AUTHOR: "AUTHOR";
|
|
423
|
+
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
424
|
+
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
425
|
+
readonly LABELS: "LABELS";
|
|
426
|
+
readonly PUBLISH_DATE: "PUBLISH_DATE";
|
|
427
|
+
readonly SPACE_KEY: "SPACE_KEY";
|
|
428
|
+
readonly SPACE_NAME: "SPACE_NAME";
|
|
429
|
+
readonly URL: "URL";
|
|
430
|
+
readonly VERSION: "VERSION";
|
|
431
|
+
};
|
|
432
|
+
export type ConfluenceBlogFieldName =
|
|
433
|
+
(typeof ConfluenceBlogFieldName)[keyof typeof ConfluenceBlogFieldName];
|
|
400
434
|
export interface ConfluenceBlogToIndexFieldMapping {
|
|
401
435
|
DataSourceFieldName?: ConfluenceBlogFieldName | string;
|
|
402
436
|
DateFieldFormat?: string;
|
|
@@ -405,20 +439,22 @@ export interface ConfluenceBlogToIndexFieldMapping {
|
|
|
405
439
|
export interface ConfluenceBlogConfiguration {
|
|
406
440
|
BlogFieldMappings?: ConfluenceBlogToIndexFieldMapping[];
|
|
407
441
|
}
|
|
408
|
-
export declare
|
|
409
|
-
AUTHOR
|
|
410
|
-
CONTENT_STATUS
|
|
411
|
-
CREATED_DATE
|
|
412
|
-
DISPLAY_URL
|
|
413
|
-
ITEM_TYPE
|
|
414
|
-
LABELS
|
|
415
|
-
MODIFIED_DATE
|
|
416
|
-
PARENT_ID
|
|
417
|
-
SPACE_KEY
|
|
418
|
-
SPACE_NAME
|
|
419
|
-
URL
|
|
420
|
-
VERSION
|
|
421
|
-
}
|
|
442
|
+
export declare const ConfluencePageFieldName: {
|
|
443
|
+
readonly AUTHOR: "AUTHOR";
|
|
444
|
+
readonly CONTENT_STATUS: "CONTENT_STATUS";
|
|
445
|
+
readonly CREATED_DATE: "CREATED_DATE";
|
|
446
|
+
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
447
|
+
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
448
|
+
readonly LABELS: "LABELS";
|
|
449
|
+
readonly MODIFIED_DATE: "MODIFIED_DATE";
|
|
450
|
+
readonly PARENT_ID: "PARENT_ID";
|
|
451
|
+
readonly SPACE_KEY: "SPACE_KEY";
|
|
452
|
+
readonly SPACE_NAME: "SPACE_NAME";
|
|
453
|
+
readonly URL: "URL";
|
|
454
|
+
readonly VERSION: "VERSION";
|
|
455
|
+
};
|
|
456
|
+
export type ConfluencePageFieldName =
|
|
457
|
+
(typeof ConfluencePageFieldName)[keyof typeof ConfluencePageFieldName];
|
|
422
458
|
export interface ConfluencePageToIndexFieldMapping {
|
|
423
459
|
DataSourceFieldName?: ConfluencePageFieldName | string;
|
|
424
460
|
DateFieldFormat?: string;
|
|
@@ -432,12 +468,14 @@ export interface ProxyConfiguration {
|
|
|
432
468
|
Port: number | undefined;
|
|
433
469
|
Credentials?: string;
|
|
434
470
|
}
|
|
435
|
-
export declare
|
|
436
|
-
DISPLAY_URL
|
|
437
|
-
ITEM_TYPE
|
|
438
|
-
SPACE_KEY
|
|
439
|
-
URL
|
|
440
|
-
}
|
|
471
|
+
export declare const ConfluenceSpaceFieldName: {
|
|
472
|
+
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
473
|
+
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
474
|
+
readonly SPACE_KEY: "SPACE_KEY";
|
|
475
|
+
readonly URL: "URL";
|
|
476
|
+
};
|
|
477
|
+
export type ConfluenceSpaceFieldName =
|
|
478
|
+
(typeof ConfluenceSpaceFieldName)[keyof typeof ConfluenceSpaceFieldName];
|
|
441
479
|
export interface ConfluenceSpaceToIndexFieldMapping {
|
|
442
480
|
DataSourceFieldName?: ConfluenceSpaceFieldName | string;
|
|
443
481
|
DateFieldFormat?: string;
|
|
@@ -450,10 +488,12 @@ export interface ConfluenceSpaceConfiguration {
|
|
|
450
488
|
ExcludeSpaces?: string[];
|
|
451
489
|
SpaceFieldMappings?: ConfluenceSpaceToIndexFieldMapping[];
|
|
452
490
|
}
|
|
453
|
-
export declare
|
|
454
|
-
CLOUD
|
|
455
|
-
SERVER
|
|
456
|
-
}
|
|
491
|
+
export declare const ConfluenceVersion: {
|
|
492
|
+
readonly CLOUD: "CLOUD";
|
|
493
|
+
readonly SERVER: "SERVER";
|
|
494
|
+
};
|
|
495
|
+
export type ConfluenceVersion =
|
|
496
|
+
(typeof ConfluenceVersion)[keyof typeof ConfluenceVersion];
|
|
457
497
|
export interface ConfluenceConfiguration {
|
|
458
498
|
ServerUrl: string | undefined;
|
|
459
499
|
SecretArn: string | undefined;
|
|
@@ -482,16 +522,20 @@ export interface ConnectionConfiguration {
|
|
|
482
522
|
TableName: string | undefined;
|
|
483
523
|
SecretArn: string | undefined;
|
|
484
524
|
}
|
|
485
|
-
export declare
|
|
486
|
-
RDS_AURORA_MYSQL
|
|
487
|
-
RDS_AURORA_POSTGRESQL
|
|
488
|
-
RDS_MYSQL
|
|
489
|
-
RDS_POSTGRESQL
|
|
490
|
-
}
|
|
491
|
-
export
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
525
|
+
export declare const DatabaseEngineType: {
|
|
526
|
+
readonly RDS_AURORA_MYSQL: "RDS_AURORA_MYSQL";
|
|
527
|
+
readonly RDS_AURORA_POSTGRESQL: "RDS_AURORA_POSTGRESQL";
|
|
528
|
+
readonly RDS_MYSQL: "RDS_MYSQL";
|
|
529
|
+
readonly RDS_POSTGRESQL: "RDS_POSTGRESQL";
|
|
530
|
+
};
|
|
531
|
+
export type DatabaseEngineType =
|
|
532
|
+
(typeof DatabaseEngineType)[keyof typeof DatabaseEngineType];
|
|
533
|
+
export declare const QueryIdentifiersEnclosingOption: {
|
|
534
|
+
readonly DOUBLE_QUOTES: "DOUBLE_QUOTES";
|
|
535
|
+
readonly NONE: "NONE";
|
|
536
|
+
};
|
|
537
|
+
export type QueryIdentifiersEnclosingOption =
|
|
538
|
+
(typeof QueryIdentifiersEnclosingOption)[keyof typeof QueryIdentifiersEnclosingOption];
|
|
495
539
|
export interface SqlConfiguration {
|
|
496
540
|
QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption | string;
|
|
497
541
|
}
|
|
@@ -503,9 +547,11 @@ export interface DatabaseConfiguration {
|
|
|
503
547
|
AclConfiguration?: AclConfiguration;
|
|
504
548
|
SqlConfiguration?: SqlConfiguration;
|
|
505
549
|
}
|
|
506
|
-
export declare
|
|
507
|
-
WINDOWS
|
|
508
|
-
}
|
|
550
|
+
export declare const FsxFileSystemType: {
|
|
551
|
+
readonly WINDOWS: "WINDOWS";
|
|
552
|
+
};
|
|
553
|
+
export type FsxFileSystemType =
|
|
554
|
+
(typeof FsxFileSystemType)[keyof typeof FsxFileSystemType];
|
|
509
555
|
export interface FsxConfiguration {
|
|
510
556
|
FileSystemId: string | undefined;
|
|
511
557
|
FileSystemType: FsxFileSystemType | string | undefined;
|
|
@@ -533,10 +579,11 @@ export interface SaaSConfiguration {
|
|
|
533
579
|
OrganizationName: string | undefined;
|
|
534
580
|
HostUrl: string | undefined;
|
|
535
581
|
}
|
|
536
|
-
export declare
|
|
537
|
-
ON_PREMISE
|
|
538
|
-
SAAS
|
|
539
|
-
}
|
|
582
|
+
export declare const Type: {
|
|
583
|
+
readonly ON_PREMISE: "ON_PREMISE";
|
|
584
|
+
readonly SAAS: "SAAS";
|
|
585
|
+
};
|
|
586
|
+
export type Type = (typeof Type)[keyof typeof Type];
|
|
540
587
|
export interface GitHubConfiguration {
|
|
541
588
|
SaaSConfiguration?: SaaSConfiguration;
|
|
542
589
|
OnPremiseConfiguration?: OnPremiseConfiguration;
|
|
@@ -570,11 +617,13 @@ export interface GoogleDriveConfiguration {
|
|
|
570
617
|
ExcludeUserAccounts?: string[];
|
|
571
618
|
ExcludeSharedDrives?: string[];
|
|
572
619
|
}
|
|
573
|
-
export declare
|
|
574
|
-
ATTACHMENTS
|
|
575
|
-
COMMENTS
|
|
576
|
-
WORKLOGS
|
|
577
|
-
}
|
|
620
|
+
export declare const IssueSubEntity: {
|
|
621
|
+
readonly ATTACHMENTS: "ATTACHMENTS";
|
|
622
|
+
readonly COMMENTS: "COMMENTS";
|
|
623
|
+
readonly WORKLOGS: "WORKLOGS";
|
|
624
|
+
};
|
|
625
|
+
export type IssueSubEntity =
|
|
626
|
+
(typeof IssueSubEntity)[keyof typeof IssueSubEntity];
|
|
578
627
|
export interface JiraConfiguration {
|
|
579
628
|
JiraAccountUrl: string | undefined;
|
|
580
629
|
SecretArn: string | undefined;
|
|
@@ -630,10 +679,12 @@ export interface S3DataSourceConfiguration {
|
|
|
630
679
|
DocumentsMetadataConfiguration?: DocumentsMetadataConfiguration;
|
|
631
680
|
AccessControlListConfiguration?: AccessControlListConfiguration;
|
|
632
681
|
}
|
|
633
|
-
export declare
|
|
634
|
-
ACTIVE_USER
|
|
635
|
-
STANDARD_USER
|
|
636
|
-
}
|
|
682
|
+
export declare const SalesforceChatterFeedIncludeFilterType: {
|
|
683
|
+
readonly ACTIVE_USER: "ACTIVE_USER";
|
|
684
|
+
readonly STANDARD_USER: "STANDARD_USER";
|
|
685
|
+
};
|
|
686
|
+
export type SalesforceChatterFeedIncludeFilterType =
|
|
687
|
+
(typeof SalesforceChatterFeedIncludeFilterType)[keyof typeof SalesforceChatterFeedIncludeFilterType];
|
|
637
688
|
export interface SalesforceChatterFeedConfiguration {
|
|
638
689
|
DocumentDataFieldName: string | undefined;
|
|
639
690
|
DocumentTitleFieldName?: string;
|
|
@@ -646,11 +697,13 @@ export interface SalesforceCustomKnowledgeArticleTypeConfiguration {
|
|
|
646
697
|
DocumentTitleFieldName?: string;
|
|
647
698
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
648
699
|
}
|
|
649
|
-
export declare
|
|
650
|
-
ARCHIVED
|
|
651
|
-
DRAFT
|
|
652
|
-
PUBLISHED
|
|
653
|
-
}
|
|
700
|
+
export declare const SalesforceKnowledgeArticleState: {
|
|
701
|
+
readonly ARCHIVED: "ARCHIVED";
|
|
702
|
+
readonly DRAFT: "DRAFT";
|
|
703
|
+
readonly PUBLISHED: "PUBLISHED";
|
|
704
|
+
};
|
|
705
|
+
export type SalesforceKnowledgeArticleState =
|
|
706
|
+
(typeof SalesforceKnowledgeArticleState)[keyof typeof SalesforceKnowledgeArticleState];
|
|
654
707
|
export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
655
708
|
DocumentDataFieldName: string | undefined;
|
|
656
709
|
DocumentTitleFieldName?: string;
|
|
@@ -665,25 +718,27 @@ export interface SalesforceStandardObjectAttachmentConfiguration {
|
|
|
665
718
|
DocumentTitleFieldName?: string;
|
|
666
719
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
667
720
|
}
|
|
668
|
-
export declare
|
|
669
|
-
ACCOUNT
|
|
670
|
-
CAMPAIGN
|
|
671
|
-
CASE
|
|
672
|
-
CONTACT
|
|
673
|
-
CONTRACT
|
|
674
|
-
DOCUMENT
|
|
675
|
-
GROUP
|
|
676
|
-
IDEA
|
|
677
|
-
LEAD
|
|
678
|
-
OPPORTUNITY
|
|
679
|
-
PARTNER
|
|
680
|
-
PRICEBOOK
|
|
681
|
-
PRODUCT
|
|
682
|
-
PROFILE
|
|
683
|
-
SOLUTION
|
|
684
|
-
TASK
|
|
685
|
-
USER
|
|
686
|
-
}
|
|
721
|
+
export declare const SalesforceStandardObjectName: {
|
|
722
|
+
readonly ACCOUNT: "ACCOUNT";
|
|
723
|
+
readonly CAMPAIGN: "CAMPAIGN";
|
|
724
|
+
readonly CASE: "CASE";
|
|
725
|
+
readonly CONTACT: "CONTACT";
|
|
726
|
+
readonly CONTRACT: "CONTRACT";
|
|
727
|
+
readonly DOCUMENT: "DOCUMENT";
|
|
728
|
+
readonly GROUP: "GROUP";
|
|
729
|
+
readonly IDEA: "IDEA";
|
|
730
|
+
readonly LEAD: "LEAD";
|
|
731
|
+
readonly OPPORTUNITY: "OPPORTUNITY";
|
|
732
|
+
readonly PARTNER: "PARTNER";
|
|
733
|
+
readonly PRICEBOOK: "PRICEBOOK";
|
|
734
|
+
readonly PRODUCT: "PRODUCT";
|
|
735
|
+
readonly PROFILE: "PROFILE";
|
|
736
|
+
readonly SOLUTION: "SOLUTION";
|
|
737
|
+
readonly TASK: "TASK";
|
|
738
|
+
readonly USER: "USER";
|
|
739
|
+
};
|
|
740
|
+
export type SalesforceStandardObjectName =
|
|
741
|
+
(typeof SalesforceStandardObjectName)[keyof typeof SalesforceStandardObjectName];
|
|
687
742
|
export interface SalesforceStandardObjectConfiguration {
|
|
688
743
|
Name: SalesforceStandardObjectName | string | undefined;
|
|
689
744
|
DocumentDataFieldName: string | undefined;
|
|
@@ -701,10 +756,12 @@ export interface SalesforceConfiguration {
|
|
|
701
756
|
IncludeAttachmentFilePatterns?: string[];
|
|
702
757
|
ExcludeAttachmentFilePatterns?: string[];
|
|
703
758
|
}
|
|
704
|
-
export declare
|
|
705
|
-
HTTP_BASIC
|
|
706
|
-
OAUTH2
|
|
707
|
-
}
|
|
759
|
+
export declare const ServiceNowAuthenticationType: {
|
|
760
|
+
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
761
|
+
readonly OAUTH2: "OAUTH2";
|
|
762
|
+
};
|
|
763
|
+
export type ServiceNowAuthenticationType =
|
|
764
|
+
(typeof ServiceNowAuthenticationType)[keyof typeof ServiceNowAuthenticationType];
|
|
708
765
|
export interface ServiceNowKnowledgeArticleConfiguration {
|
|
709
766
|
CrawlAttachments?: boolean;
|
|
710
767
|
IncludeAttachmentFilePatterns?: string[];
|
|
@@ -722,10 +779,12 @@ export interface ServiceNowServiceCatalogConfiguration {
|
|
|
722
779
|
DocumentTitleFieldName?: string;
|
|
723
780
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
724
781
|
}
|
|
725
|
-
export declare
|
|
726
|
-
LONDON
|
|
727
|
-
OTHERS
|
|
728
|
-
}
|
|
782
|
+
export declare const ServiceNowBuildVersionType: {
|
|
783
|
+
readonly LONDON: "LONDON";
|
|
784
|
+
readonly OTHERS: "OTHERS";
|
|
785
|
+
};
|
|
786
|
+
export type ServiceNowBuildVersionType =
|
|
787
|
+
(typeof ServiceNowBuildVersionType)[keyof typeof ServiceNowBuildVersionType];
|
|
729
788
|
export interface ServiceNowConfiguration {
|
|
730
789
|
HostUrl: string | undefined;
|
|
731
790
|
SecretArn: string | undefined;
|
|
@@ -734,16 +793,20 @@ export interface ServiceNowConfiguration {
|
|
|
734
793
|
ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration;
|
|
735
794
|
AuthenticationType?: ServiceNowAuthenticationType | string;
|
|
736
795
|
}
|
|
737
|
-
export declare
|
|
738
|
-
HTTP_BASIC
|
|
739
|
-
OAUTH2
|
|
740
|
-
}
|
|
741
|
-
export
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
796
|
+
export declare const SharePointOnlineAuthenticationType: {
|
|
797
|
+
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
798
|
+
readonly OAUTH2: "OAUTH2";
|
|
799
|
+
};
|
|
800
|
+
export type SharePointOnlineAuthenticationType =
|
|
801
|
+
(typeof SharePointOnlineAuthenticationType)[keyof typeof SharePointOnlineAuthenticationType];
|
|
802
|
+
export declare const SharePointVersion: {
|
|
803
|
+
readonly SHAREPOINT_2013: "SHAREPOINT_2013";
|
|
804
|
+
readonly SHAREPOINT_2016: "SHAREPOINT_2016";
|
|
805
|
+
readonly SHAREPOINT_2019: "SHAREPOINT_2019";
|
|
806
|
+
readonly SHAREPOINT_ONLINE: "SHAREPOINT_ONLINE";
|
|
807
|
+
};
|
|
808
|
+
export type SharePointVersion =
|
|
809
|
+
(typeof SharePointVersion)[keyof typeof SharePointVersion];
|
|
747
810
|
export interface SharePointConfiguration {
|
|
748
811
|
SharePointVersion: SharePointVersion | string | undefined;
|
|
749
812
|
Urls: string[] | undefined;
|
|
@@ -760,12 +823,13 @@ export interface SharePointConfiguration {
|
|
|
760
823
|
AuthenticationType?: SharePointOnlineAuthenticationType | string;
|
|
761
824
|
ProxyConfiguration?: ProxyConfiguration;
|
|
762
825
|
}
|
|
763
|
-
export declare
|
|
764
|
-
DIRECT_MESSAGE
|
|
765
|
-
GROUP_MESSAGE
|
|
766
|
-
PRIVATE_CHANNEL
|
|
767
|
-
PUBLIC_CHANNEL
|
|
768
|
-
}
|
|
826
|
+
export declare const SlackEntity: {
|
|
827
|
+
readonly DIRECT_MESSAGE: "DIRECT_MESSAGE";
|
|
828
|
+
readonly GROUP_MESSAGE: "GROUP_MESSAGE";
|
|
829
|
+
readonly PRIVATE_CHANNEL: "PRIVATE_CHANNEL";
|
|
830
|
+
readonly PUBLIC_CHANNEL: "PUBLIC_CHANNEL";
|
|
831
|
+
};
|
|
832
|
+
export type SlackEntity = (typeof SlackEntity)[keyof typeof SlackEntity];
|
|
769
833
|
export interface SlackConfiguration {
|
|
770
834
|
TeamId: string | undefined;
|
|
771
835
|
SecretArn: string | undefined;
|
|
@@ -785,11 +849,13 @@ export interface SlackConfiguration {
|
|
|
785
849
|
export interface TemplateConfiguration {
|
|
786
850
|
Template?: __DocumentType;
|
|
787
851
|
}
|
|
788
|
-
export declare
|
|
789
|
-
EVERYTHING
|
|
790
|
-
HOST_ONLY
|
|
791
|
-
SUBDOMAINS
|
|
792
|
-
}
|
|
852
|
+
export declare const WebCrawlerMode: {
|
|
853
|
+
readonly EVERYTHING: "EVERYTHING";
|
|
854
|
+
readonly HOST_ONLY: "HOST_ONLY";
|
|
855
|
+
readonly SUBDOMAINS: "SUBDOMAINS";
|
|
856
|
+
};
|
|
857
|
+
export type WebCrawlerMode =
|
|
858
|
+
(typeof WebCrawlerMode)[keyof typeof WebCrawlerMode];
|
|
793
859
|
export interface SeedUrlConfiguration {
|
|
794
860
|
SeedUrls: string[] | undefined;
|
|
795
861
|
WebCrawlerMode?: WebCrawlerMode | string;
|
|
@@ -844,27 +910,29 @@ export interface Tag {
|
|
|
844
910
|
Key: string | undefined;
|
|
845
911
|
Value: string | undefined;
|
|
846
912
|
}
|
|
847
|
-
export declare
|
|
848
|
-
ALFRESCO
|
|
849
|
-
BOX
|
|
850
|
-
CONFLUENCE
|
|
851
|
-
CUSTOM
|
|
852
|
-
DATABASE
|
|
853
|
-
FSX
|
|
854
|
-
GITHUB
|
|
855
|
-
GOOGLEDRIVE
|
|
856
|
-
JIRA
|
|
857
|
-
ONEDRIVE
|
|
858
|
-
QUIP
|
|
859
|
-
S3
|
|
860
|
-
SALESFORCE
|
|
861
|
-
SERVICENOW
|
|
862
|
-
SHAREPOINT
|
|
863
|
-
SLACK
|
|
864
|
-
TEMPLATE
|
|
865
|
-
WEBCRAWLER
|
|
866
|
-
WORKDOCS
|
|
867
|
-
}
|
|
913
|
+
export declare const DataSourceType: {
|
|
914
|
+
readonly ALFRESCO: "ALFRESCO";
|
|
915
|
+
readonly BOX: "BOX";
|
|
916
|
+
readonly CONFLUENCE: "CONFLUENCE";
|
|
917
|
+
readonly CUSTOM: "CUSTOM";
|
|
918
|
+
readonly DATABASE: "DATABASE";
|
|
919
|
+
readonly FSX: "FSX";
|
|
920
|
+
readonly GITHUB: "GITHUB";
|
|
921
|
+
readonly GOOGLEDRIVE: "GOOGLEDRIVE";
|
|
922
|
+
readonly JIRA: "JIRA";
|
|
923
|
+
readonly ONEDRIVE: "ONEDRIVE";
|
|
924
|
+
readonly QUIP: "QUIP";
|
|
925
|
+
readonly S3: "S3";
|
|
926
|
+
readonly SALESFORCE: "SALESFORCE";
|
|
927
|
+
readonly SERVICENOW: "SERVICENOW";
|
|
928
|
+
readonly SHAREPOINT: "SHAREPOINT";
|
|
929
|
+
readonly SLACK: "SLACK";
|
|
930
|
+
readonly TEMPLATE: "TEMPLATE";
|
|
931
|
+
readonly WEBCRAWLER: "WEBCRAWLER";
|
|
932
|
+
readonly WORKDOCS: "WORKDOCS";
|
|
933
|
+
};
|
|
934
|
+
export type DataSourceType =
|
|
935
|
+
(typeof DataSourceType)[keyof typeof DataSourceType];
|
|
868
936
|
export interface CreateDataSourceRequest {
|
|
869
937
|
Name: string | undefined;
|
|
870
938
|
IndexId: string | undefined;
|
|
@@ -905,11 +973,12 @@ export interface CreateExperienceRequest {
|
|
|
905
973
|
export interface CreateExperienceResponse {
|
|
906
974
|
Id: string | undefined;
|
|
907
975
|
}
|
|
908
|
-
export declare
|
|
909
|
-
CSV
|
|
910
|
-
CSV_WITH_HEADER
|
|
911
|
-
JSON
|
|
912
|
-
}
|
|
976
|
+
export declare const FaqFileFormat: {
|
|
977
|
+
readonly CSV: "CSV";
|
|
978
|
+
readonly CSV_WITH_HEADER: "CSV_WITH_HEADER";
|
|
979
|
+
readonly JSON: "JSON";
|
|
980
|
+
};
|
|
981
|
+
export type FaqFileFormat = (typeof FaqFileFormat)[keyof typeof FaqFileFormat];
|
|
913
982
|
export interface CreateFaqRequest {
|
|
914
983
|
IndexId: string | undefined;
|
|
915
984
|
Name: string | undefined;
|
|
@@ -924,21 +993,75 @@ export interface CreateFaqRequest {
|
|
|
924
993
|
export interface CreateFaqResponse {
|
|
925
994
|
Id?: string;
|
|
926
995
|
}
|
|
927
|
-
export
|
|
928
|
-
|
|
929
|
-
ENTERPRISE_EDITION = "ENTERPRISE_EDITION",
|
|
996
|
+
export interface FeaturedDocument {
|
|
997
|
+
Id?: string;
|
|
930
998
|
}
|
|
931
|
-
export
|
|
932
|
-
|
|
999
|
+
export declare const FeaturedResultsSetStatus: {
|
|
1000
|
+
readonly ACTIVE: "ACTIVE";
|
|
1001
|
+
readonly INACTIVE: "INACTIVE";
|
|
1002
|
+
};
|
|
1003
|
+
export type FeaturedResultsSetStatus =
|
|
1004
|
+
(typeof FeaturedResultsSetStatus)[keyof typeof FeaturedResultsSetStatus];
|
|
1005
|
+
export interface CreateFeaturedResultsSetRequest {
|
|
1006
|
+
IndexId: string | undefined;
|
|
1007
|
+
FeaturedResultsSetName: string | undefined;
|
|
1008
|
+
Description?: string;
|
|
1009
|
+
ClientToken?: string;
|
|
1010
|
+
Status?: FeaturedResultsSetStatus | string;
|
|
1011
|
+
QueryTexts?: string[];
|
|
1012
|
+
FeaturedDocuments?: FeaturedDocument[];
|
|
1013
|
+
Tags?: Tag[];
|
|
933
1014
|
}
|
|
934
|
-
export
|
|
935
|
-
|
|
936
|
-
|
|
1015
|
+
export interface FeaturedResultsSet {
|
|
1016
|
+
FeaturedResultsSetId?: string;
|
|
1017
|
+
FeaturedResultsSetName?: string;
|
|
1018
|
+
Description?: string;
|
|
1019
|
+
Status?: FeaturedResultsSetStatus | string;
|
|
1020
|
+
QueryTexts?: string[];
|
|
1021
|
+
FeaturedDocuments?: FeaturedDocument[];
|
|
1022
|
+
LastUpdatedTimestamp?: number;
|
|
1023
|
+
CreationTimestamp?: number;
|
|
1024
|
+
}
|
|
1025
|
+
export interface CreateFeaturedResultsSetResponse {
|
|
1026
|
+
FeaturedResultsSet?: FeaturedResultsSet;
|
|
1027
|
+
}
|
|
1028
|
+
export interface ConflictingItem {
|
|
1029
|
+
QueryText?: string;
|
|
1030
|
+
SetName?: string;
|
|
1031
|
+
SetId?: string;
|
|
1032
|
+
}
|
|
1033
|
+
export declare class FeaturedResultsConflictException extends __BaseException {
|
|
1034
|
+
readonly name: "FeaturedResultsConflictException";
|
|
1035
|
+
readonly $fault: "client";
|
|
1036
|
+
Message?: string;
|
|
1037
|
+
ConflictingItems?: ConflictingItem[];
|
|
1038
|
+
constructor(
|
|
1039
|
+
opts: __ExceptionOptionType<
|
|
1040
|
+
FeaturedResultsConflictException,
|
|
1041
|
+
__BaseException
|
|
1042
|
+
>
|
|
1043
|
+
);
|
|
937
1044
|
}
|
|
938
|
-
export declare
|
|
939
|
-
|
|
940
|
-
|
|
1045
|
+
export declare const IndexEdition: {
|
|
1046
|
+
readonly DEVELOPER_EDITION: "DEVELOPER_EDITION";
|
|
1047
|
+
readonly ENTERPRISE_EDITION: "ENTERPRISE_EDITION";
|
|
1048
|
+
};
|
|
1049
|
+
export type IndexEdition = (typeof IndexEdition)[keyof typeof IndexEdition];
|
|
1050
|
+
export interface ServerSideEncryptionConfiguration {
|
|
1051
|
+
KmsKeyId?: string;
|
|
941
1052
|
}
|
|
1053
|
+
export declare const UserContextPolicy: {
|
|
1054
|
+
readonly ATTRIBUTE_FILTER: "ATTRIBUTE_FILTER";
|
|
1055
|
+
readonly USER_TOKEN: "USER_TOKEN";
|
|
1056
|
+
};
|
|
1057
|
+
export type UserContextPolicy =
|
|
1058
|
+
(typeof UserContextPolicy)[keyof typeof UserContextPolicy];
|
|
1059
|
+
export declare const UserGroupResolutionMode: {
|
|
1060
|
+
readonly AWS_SSO: "AWS_SSO";
|
|
1061
|
+
readonly NONE: "NONE";
|
|
1062
|
+
};
|
|
1063
|
+
export type UserGroupResolutionMode =
|
|
1064
|
+
(typeof UserGroupResolutionMode)[keyof typeof UserGroupResolutionMode];
|
|
942
1065
|
export interface UserGroupResolutionConfiguration {
|
|
943
1066
|
UserGroupResolutionMode: UserGroupResolutionMode | string | undefined;
|
|
944
1067
|
}
|
|
@@ -946,10 +1069,11 @@ export interface JsonTokenTypeConfiguration {
|
|
|
946
1069
|
UserNameAttributeField: string | undefined;
|
|
947
1070
|
GroupAttributeField: string | undefined;
|
|
948
1071
|
}
|
|
949
|
-
export declare
|
|
950
|
-
SECRET_MANAGER
|
|
951
|
-
URL
|
|
952
|
-
}
|
|
1072
|
+
export declare const KeyLocation: {
|
|
1073
|
+
readonly SECRET_MANAGER: "SECRET_MANAGER";
|
|
1074
|
+
readonly URL: "URL";
|
|
1075
|
+
};
|
|
1076
|
+
export type KeyLocation = (typeof KeyLocation)[keyof typeof KeyLocation];
|
|
953
1077
|
export interface JwtTokenTypeConfiguration {
|
|
954
1078
|
KeyLocation: KeyLocation | string | undefined;
|
|
955
1079
|
URL?: string;
|
|
@@ -1052,13 +1176,15 @@ export interface DescribeDataSourceRequest {
|
|
|
1052
1176
|
Id: string | undefined;
|
|
1053
1177
|
IndexId: string | undefined;
|
|
1054
1178
|
}
|
|
1055
|
-
export declare
|
|
1056
|
-
ACTIVE
|
|
1057
|
-
CREATING
|
|
1058
|
-
DELETING
|
|
1059
|
-
FAILED
|
|
1060
|
-
UPDATING
|
|
1061
|
-
}
|
|
1179
|
+
export declare const DataSourceStatus: {
|
|
1180
|
+
readonly ACTIVE: "ACTIVE";
|
|
1181
|
+
readonly CREATING: "CREATING";
|
|
1182
|
+
readonly DELETING: "DELETING";
|
|
1183
|
+
readonly FAILED: "FAILED";
|
|
1184
|
+
readonly UPDATING: "UPDATING";
|
|
1185
|
+
};
|
|
1186
|
+
export type DataSourceStatus =
|
|
1187
|
+
(typeof DataSourceStatus)[keyof typeof DataSourceStatus];
|
|
1062
1188
|
export interface DescribeDataSourceResponse {
|
|
1063
1189
|
Id?: string;
|
|
1064
1190
|
IndexId?: string;
|
|
@@ -1080,19 +1206,22 @@ export interface DescribeExperienceRequest {
|
|
|
1080
1206
|
Id: string | undefined;
|
|
1081
1207
|
IndexId: string | undefined;
|
|
1082
1208
|
}
|
|
1083
|
-
export declare
|
|
1084
|
-
HOME
|
|
1085
|
-
}
|
|
1209
|
+
export declare const EndpointType: {
|
|
1210
|
+
readonly HOME: "HOME";
|
|
1211
|
+
};
|
|
1212
|
+
export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
1086
1213
|
export interface ExperienceEndpoint {
|
|
1087
1214
|
EndpointType?: EndpointType | string;
|
|
1088
1215
|
Endpoint?: string;
|
|
1089
1216
|
}
|
|
1090
|
-
export declare
|
|
1091
|
-
ACTIVE
|
|
1092
|
-
CREATING
|
|
1093
|
-
DELETING
|
|
1094
|
-
FAILED
|
|
1095
|
-
}
|
|
1217
|
+
export declare const ExperienceStatus: {
|
|
1218
|
+
readonly ACTIVE: "ACTIVE";
|
|
1219
|
+
readonly CREATING: "CREATING";
|
|
1220
|
+
readonly DELETING: "DELETING";
|
|
1221
|
+
readonly FAILED: "FAILED";
|
|
1222
|
+
};
|
|
1223
|
+
export type ExperienceStatus =
|
|
1224
|
+
(typeof ExperienceStatus)[keyof typeof ExperienceStatus];
|
|
1096
1225
|
export interface DescribeExperienceResponse {
|
|
1097
1226
|
Id?: string;
|
|
1098
1227
|
IndexId?: string;
|
|
@@ -1110,13 +1239,14 @@ export interface DescribeFaqRequest {
|
|
|
1110
1239
|
Id: string | undefined;
|
|
1111
1240
|
IndexId: string | undefined;
|
|
1112
1241
|
}
|
|
1113
|
-
export declare
|
|
1114
|
-
ACTIVE
|
|
1115
|
-
CREATING
|
|
1116
|
-
DELETING
|
|
1117
|
-
FAILED
|
|
1118
|
-
UPDATING
|
|
1119
|
-
}
|
|
1242
|
+
export declare const FaqStatus: {
|
|
1243
|
+
readonly ACTIVE: "ACTIVE";
|
|
1244
|
+
readonly CREATING: "CREATING";
|
|
1245
|
+
readonly DELETING: "DELETING";
|
|
1246
|
+
readonly FAILED: "FAILED";
|
|
1247
|
+
readonly UPDATING: "UPDATING";
|
|
1248
|
+
};
|
|
1249
|
+
export type FaqStatus = (typeof FaqStatus)[keyof typeof FaqStatus];
|
|
1120
1250
|
export interface DescribeFaqResponse {
|
|
1121
1251
|
Id?: string;
|
|
1122
1252
|
IndexId?: string;
|
|
@@ -1131,6 +1261,29 @@ export interface DescribeFaqResponse {
|
|
|
1131
1261
|
FileFormat?: FaqFileFormat | string;
|
|
1132
1262
|
LanguageCode?: string;
|
|
1133
1263
|
}
|
|
1264
|
+
export interface DescribeFeaturedResultsSetRequest {
|
|
1265
|
+
IndexId: string | undefined;
|
|
1266
|
+
FeaturedResultsSetId: string | undefined;
|
|
1267
|
+
}
|
|
1268
|
+
export interface FeaturedDocumentMissing {
|
|
1269
|
+
Id?: string;
|
|
1270
|
+
}
|
|
1271
|
+
export interface FeaturedDocumentWithMetadata {
|
|
1272
|
+
Id?: string;
|
|
1273
|
+
Title?: string;
|
|
1274
|
+
URI?: string;
|
|
1275
|
+
}
|
|
1276
|
+
export interface DescribeFeaturedResultsSetResponse {
|
|
1277
|
+
FeaturedResultsSetId?: string;
|
|
1278
|
+
FeaturedResultsSetName?: string;
|
|
1279
|
+
Description?: string;
|
|
1280
|
+
Status?: FeaturedResultsSetStatus | string;
|
|
1281
|
+
QueryTexts?: string[];
|
|
1282
|
+
FeaturedDocumentsWithMetadata?: FeaturedDocumentWithMetadata[];
|
|
1283
|
+
FeaturedDocumentsMissing?: FeaturedDocumentMissing[];
|
|
1284
|
+
LastUpdatedTimestamp?: number;
|
|
1285
|
+
CreationTimestamp?: number;
|
|
1286
|
+
}
|
|
1134
1287
|
export interface DescribeIndexRequest {
|
|
1135
1288
|
Id: string | undefined;
|
|
1136
1289
|
}
|
|
@@ -1138,10 +1291,11 @@ export interface CapacityUnitsConfiguration {
|
|
|
1138
1291
|
StorageCapacityUnits: number | undefined;
|
|
1139
1292
|
QueryCapacityUnits: number | undefined;
|
|
1140
1293
|
}
|
|
1141
|
-
export declare
|
|
1142
|
-
ASCENDING
|
|
1143
|
-
DESCENDING
|
|
1144
|
-
}
|
|
1294
|
+
export declare const Order: {
|
|
1295
|
+
readonly ASCENDING: "ASCENDING";
|
|
1296
|
+
readonly DESCENDING: "DESCENDING";
|
|
1297
|
+
};
|
|
1298
|
+
export type Order = (typeof Order)[keyof typeof Order];
|
|
1145
1299
|
export interface Relevance {
|
|
1146
1300
|
Freshness?: boolean;
|
|
1147
1301
|
Importance?: number;
|
|
@@ -1155,12 +1309,14 @@ export interface Search {
|
|
|
1155
1309
|
Displayable?: boolean;
|
|
1156
1310
|
Sortable?: boolean;
|
|
1157
1311
|
}
|
|
1158
|
-
export declare
|
|
1159
|
-
DATE_VALUE
|
|
1160
|
-
LONG_VALUE
|
|
1161
|
-
STRING_LIST_VALUE
|
|
1162
|
-
STRING_VALUE
|
|
1163
|
-
}
|
|
1312
|
+
export declare const DocumentAttributeValueType: {
|
|
1313
|
+
readonly DATE_VALUE: "DATE_VALUE";
|
|
1314
|
+
readonly LONG_VALUE: "LONG_VALUE";
|
|
1315
|
+
readonly STRING_LIST_VALUE: "STRING_LIST_VALUE";
|
|
1316
|
+
readonly STRING_VALUE: "STRING_VALUE";
|
|
1317
|
+
};
|
|
1318
|
+
export type DocumentAttributeValueType =
|
|
1319
|
+
(typeof DocumentAttributeValueType)[keyof typeof DocumentAttributeValueType];
|
|
1164
1320
|
export interface DocumentMetadataConfiguration {
|
|
1165
1321
|
Name: string | undefined;
|
|
1166
1322
|
Type: DocumentAttributeValueType | string | undefined;
|
|
@@ -1178,14 +1334,15 @@ export interface IndexStatistics {
|
|
|
1178
1334
|
FaqStatistics: FaqStatistics | undefined;
|
|
1179
1335
|
TextDocumentStatistics: TextDocumentStatistics | undefined;
|
|
1180
1336
|
}
|
|
1181
|
-
export declare
|
|
1182
|
-
ACTIVE
|
|
1183
|
-
CREATING
|
|
1184
|
-
DELETING
|
|
1185
|
-
FAILED
|
|
1186
|
-
SYSTEM_UPDATING
|
|
1187
|
-
UPDATING
|
|
1188
|
-
}
|
|
1337
|
+
export declare const IndexStatus: {
|
|
1338
|
+
readonly ACTIVE: "ACTIVE";
|
|
1339
|
+
readonly CREATING: "CREATING";
|
|
1340
|
+
readonly DELETING: "DELETING";
|
|
1341
|
+
readonly FAILED: "FAILED";
|
|
1342
|
+
readonly SYSTEM_UPDATING: "SYSTEM_UPDATING";
|
|
1343
|
+
readonly UPDATING: "UPDATING";
|
|
1344
|
+
};
|
|
1345
|
+
export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
1189
1346
|
export interface DescribeIndexResponse {
|
|
1190
1347
|
Name?: string;
|
|
1191
1348
|
Id?: string;
|
|
@@ -1209,13 +1366,15 @@ export interface DescribePrincipalMappingRequest {
|
|
|
1209
1366
|
DataSourceId?: string;
|
|
1210
1367
|
GroupId: string | undefined;
|
|
1211
1368
|
}
|
|
1212
|
-
export declare
|
|
1213
|
-
DELETED
|
|
1214
|
-
DELETING
|
|
1215
|
-
FAILED
|
|
1216
|
-
PROCESSING
|
|
1217
|
-
SUCCEEDED
|
|
1218
|
-
}
|
|
1369
|
+
export declare const PrincipalMappingStatus: {
|
|
1370
|
+
readonly DELETED: "DELETED";
|
|
1371
|
+
readonly DELETING: "DELETING";
|
|
1372
|
+
readonly FAILED: "FAILED";
|
|
1373
|
+
readonly PROCESSING: "PROCESSING";
|
|
1374
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1375
|
+
};
|
|
1376
|
+
export type PrincipalMappingStatus =
|
|
1377
|
+
(typeof PrincipalMappingStatus)[keyof typeof PrincipalMappingStatus];
|
|
1219
1378
|
export interface GroupOrderingIdSummary {
|
|
1220
1379
|
Status?: PrincipalMappingStatus | string;
|
|
1221
1380
|
LastUpdatedAt?: Date;
|
|
@@ -1233,14 +1392,16 @@ export interface DescribeQuerySuggestionsBlockListRequest {
|
|
|
1233
1392
|
IndexId: string | undefined;
|
|
1234
1393
|
Id: string | undefined;
|
|
1235
1394
|
}
|
|
1236
|
-
export declare
|
|
1237
|
-
ACTIVE
|
|
1238
|
-
ACTIVE_BUT_UPDATE_FAILED
|
|
1239
|
-
CREATING
|
|
1240
|
-
DELETING
|
|
1241
|
-
FAILED
|
|
1242
|
-
UPDATING
|
|
1243
|
-
}
|
|
1395
|
+
export declare const QuerySuggestionsBlockListStatus: {
|
|
1396
|
+
readonly ACTIVE: "ACTIVE";
|
|
1397
|
+
readonly ACTIVE_BUT_UPDATE_FAILED: "ACTIVE_BUT_UPDATE_FAILED";
|
|
1398
|
+
readonly CREATING: "CREATING";
|
|
1399
|
+
readonly DELETING: "DELETING";
|
|
1400
|
+
readonly FAILED: "FAILED";
|
|
1401
|
+
readonly UPDATING: "UPDATING";
|
|
1402
|
+
};
|
|
1403
|
+
export type QuerySuggestionsBlockListStatus =
|
|
1404
|
+
(typeof QuerySuggestionsBlockListStatus)[keyof typeof QuerySuggestionsBlockListStatus];
|
|
1244
1405
|
export interface DescribeQuerySuggestionsBlockListResponse {
|
|
1245
1406
|
IndexId?: string;
|
|
1246
1407
|
Id?: string;
|
|
@@ -1258,14 +1419,17 @@ export interface DescribeQuerySuggestionsBlockListResponse {
|
|
|
1258
1419
|
export interface DescribeQuerySuggestionsConfigRequest {
|
|
1259
1420
|
IndexId: string | undefined;
|
|
1260
1421
|
}
|
|
1261
|
-
export declare
|
|
1262
|
-
ENABLED
|
|
1263
|
-
LEARN_ONLY
|
|
1264
|
-
}
|
|
1265
|
-
export
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1422
|
+
export declare const Mode: {
|
|
1423
|
+
readonly ENABLED: "ENABLED";
|
|
1424
|
+
readonly LEARN_ONLY: "LEARN_ONLY";
|
|
1425
|
+
};
|
|
1426
|
+
export type Mode = (typeof Mode)[keyof typeof Mode];
|
|
1427
|
+
export declare const QuerySuggestionsStatus: {
|
|
1428
|
+
readonly ACTIVE: "ACTIVE";
|
|
1429
|
+
readonly UPDATING: "UPDATING";
|
|
1430
|
+
};
|
|
1431
|
+
export type QuerySuggestionsStatus =
|
|
1432
|
+
(typeof QuerySuggestionsStatus)[keyof typeof QuerySuggestionsStatus];
|
|
1269
1433
|
export interface DescribeQuerySuggestionsConfigResponse {
|
|
1270
1434
|
Mode?: Mode | string;
|
|
1271
1435
|
Status?: QuerySuggestionsStatus | string;
|
|
@@ -1281,14 +1445,16 @@ export interface DescribeThesaurusRequest {
|
|
|
1281
1445
|
Id: string | undefined;
|
|
1282
1446
|
IndexId: string | undefined;
|
|
1283
1447
|
}
|
|
1284
|
-
export declare
|
|
1285
|
-
ACTIVE
|
|
1286
|
-
ACTIVE_BUT_UPDATE_FAILED
|
|
1287
|
-
CREATING
|
|
1288
|
-
DELETING
|
|
1289
|
-
FAILED
|
|
1290
|
-
UPDATING
|
|
1291
|
-
}
|
|
1448
|
+
export declare const ThesaurusStatus: {
|
|
1449
|
+
readonly ACTIVE: "ACTIVE";
|
|
1450
|
+
readonly ACTIVE_BUT_UPDATE_FAILED: "ACTIVE_BUT_UPDATE_FAILED";
|
|
1451
|
+
readonly CREATING: "CREATING";
|
|
1452
|
+
readonly DELETING: "DELETING";
|
|
1453
|
+
readonly FAILED: "FAILED";
|
|
1454
|
+
readonly UPDATING: "UPDATING";
|
|
1455
|
+
};
|
|
1456
|
+
export type ThesaurusStatus =
|
|
1457
|
+
(typeof ThesaurusStatus)[keyof typeof ThesaurusStatus];
|
|
1292
1458
|
export interface DescribeThesaurusResponse {
|
|
1293
1459
|
Id?: string;
|
|
1294
1460
|
IndexId?: string;
|
|
@@ -1344,22 +1510,24 @@ export interface GetQuerySuggestionsResponse {
|
|
|
1344
1510
|
QuerySuggestionsId?: string;
|
|
1345
1511
|
Suggestions?: Suggestion[];
|
|
1346
1512
|
}
|
|
1347
|
-
export declare
|
|
1348
|
-
ONE_MONTH_AGO
|
|
1349
|
-
ONE_WEEK_AGO
|
|
1350
|
-
THIS_MONTH
|
|
1351
|
-
THIS_WEEK
|
|
1352
|
-
TWO_MONTHS_AGO
|
|
1353
|
-
TWO_WEEKS_AGO
|
|
1354
|
-
}
|
|
1355
|
-
export
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1513
|
+
export declare const Interval: {
|
|
1514
|
+
readonly ONE_MONTH_AGO: "ONE_MONTH_AGO";
|
|
1515
|
+
readonly ONE_WEEK_AGO: "ONE_WEEK_AGO";
|
|
1516
|
+
readonly THIS_MONTH: "THIS_MONTH";
|
|
1517
|
+
readonly THIS_WEEK: "THIS_WEEK";
|
|
1518
|
+
readonly TWO_MONTHS_AGO: "TWO_MONTHS_AGO";
|
|
1519
|
+
readonly TWO_WEEKS_AGO: "TWO_WEEKS_AGO";
|
|
1520
|
+
};
|
|
1521
|
+
export type Interval = (typeof Interval)[keyof typeof Interval];
|
|
1522
|
+
export declare const MetricType: {
|
|
1523
|
+
readonly AGG_QUERY_DOC_METRICS: "AGG_QUERY_DOC_METRICS";
|
|
1524
|
+
readonly DOCS_BY_CLICK_COUNT: "DOCS_BY_CLICK_COUNT";
|
|
1525
|
+
readonly QUERIES_BY_COUNT: "QUERIES_BY_COUNT";
|
|
1526
|
+
readonly QUERIES_BY_ZERO_CLICK_RATE: "QUERIES_BY_ZERO_CLICK_RATE";
|
|
1527
|
+
readonly QUERIES_BY_ZERO_RESULT_RATE: "QUERIES_BY_ZERO_RESULT_RATE";
|
|
1528
|
+
readonly TREND_QUERY_DOC_METRICS: "TREND_QUERY_DOC_METRICS";
|
|
1529
|
+
};
|
|
1530
|
+
export type MetricType = (typeof MetricType)[keyof typeof MetricType];
|
|
1363
1531
|
export interface GetSnapshotsRequest {
|
|
1364
1532
|
IndexId: string | undefined;
|
|
1365
1533
|
Interval: Interval | string | undefined;
|
|
@@ -1412,15 +1580,17 @@ export interface ListDataSourcesResponse {
|
|
|
1412
1580
|
SummaryItems?: DataSourceSummary[];
|
|
1413
1581
|
NextToken?: string;
|
|
1414
1582
|
}
|
|
1415
|
-
export declare
|
|
1416
|
-
ABORTED
|
|
1417
|
-
FAILED
|
|
1418
|
-
INCOMPLETE
|
|
1419
|
-
STOPPING
|
|
1420
|
-
SUCCEEDED
|
|
1421
|
-
SYNCING
|
|
1422
|
-
SYNCING_INDEXING
|
|
1423
|
-
}
|
|
1583
|
+
export declare const DataSourceSyncJobStatus: {
|
|
1584
|
+
readonly ABORTED: "ABORTED";
|
|
1585
|
+
readonly FAILED: "FAILED";
|
|
1586
|
+
readonly INCOMPLETE: "INCOMPLETE";
|
|
1587
|
+
readonly STOPPING: "STOPPING";
|
|
1588
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1589
|
+
readonly SYNCING: "SYNCING";
|
|
1590
|
+
readonly SYNCING_INDEXING: "SYNCING_INDEXING";
|
|
1591
|
+
};
|
|
1592
|
+
export type DataSourceSyncJobStatus =
|
|
1593
|
+
(typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus];
|
|
1424
1594
|
export interface ListDataSourceSyncJobsRequest {
|
|
1425
1595
|
Id: string | undefined;
|
|
1426
1596
|
IndexId: string | undefined;
|
|
@@ -1521,6 +1691,22 @@ export interface ListFaqsResponse {
|
|
|
1521
1691
|
NextToken?: string;
|
|
1522
1692
|
FaqSummaryItems?: FaqSummary[];
|
|
1523
1693
|
}
|
|
1694
|
+
export interface ListFeaturedResultsSetsRequest {
|
|
1695
|
+
IndexId: string | undefined;
|
|
1696
|
+
NextToken?: string;
|
|
1697
|
+
MaxResults?: number;
|
|
1698
|
+
}
|
|
1699
|
+
export interface FeaturedResultsSetSummary {
|
|
1700
|
+
FeaturedResultsSetId?: string;
|
|
1701
|
+
FeaturedResultsSetName?: string;
|
|
1702
|
+
Status?: FeaturedResultsSetStatus | string;
|
|
1703
|
+
LastUpdatedTimestamp?: number;
|
|
1704
|
+
CreationTimestamp?: number;
|
|
1705
|
+
}
|
|
1706
|
+
export interface ListFeaturedResultsSetsResponse {
|
|
1707
|
+
FeaturedResultsSetSummaryItems?: FeaturedResultsSetSummary[];
|
|
1708
|
+
NextToken?: string;
|
|
1709
|
+
}
|
|
1524
1710
|
export interface ListGroupsOlderThanOrderingIdRequest {
|
|
1525
1711
|
IndexId: string | undefined;
|
|
1526
1712
|
DataSourceId?: string;
|
|
@@ -1623,15 +1809,18 @@ export interface DocumentRelevanceConfiguration {
|
|
|
1623
1809
|
Name: string | undefined;
|
|
1624
1810
|
Relevance: Relevance | undefined;
|
|
1625
1811
|
}
|
|
1626
|
-
export declare
|
|
1627
|
-
ANSWER
|
|
1628
|
-
DOCUMENT
|
|
1629
|
-
QUESTION_ANSWER
|
|
1630
|
-
}
|
|
1631
|
-
export
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1812
|
+
export declare const QueryResultType: {
|
|
1813
|
+
readonly ANSWER: "ANSWER";
|
|
1814
|
+
readonly DOCUMENT: "DOCUMENT";
|
|
1815
|
+
readonly QUESTION_ANSWER: "QUESTION_ANSWER";
|
|
1816
|
+
};
|
|
1817
|
+
export type QueryResultType =
|
|
1818
|
+
(typeof QueryResultType)[keyof typeof QueryResultType];
|
|
1819
|
+
export declare const SortOrder: {
|
|
1820
|
+
readonly ASC: "ASC";
|
|
1821
|
+
readonly DESC: "DESC";
|
|
1822
|
+
};
|
|
1823
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
1635
1824
|
export interface SortingConfiguration {
|
|
1636
1825
|
DocumentAttributeKey: string | undefined;
|
|
1637
1826
|
SortOrder: SortOrder | string | undefined;
|
|
@@ -1649,17 +1838,32 @@ export interface UserContext {
|
|
|
1649
1838
|
Groups?: string[];
|
|
1650
1839
|
DataSourceGroups?: DataSourceGroup[];
|
|
1651
1840
|
}
|
|
1652
|
-
export
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1841
|
+
export interface FeaturedResultsItem {
|
|
1842
|
+
Id?: string;
|
|
1843
|
+
Type?: QueryResultType | string;
|
|
1844
|
+
AdditionalAttributes?: AdditionalResultAttribute[];
|
|
1845
|
+
DocumentId?: string;
|
|
1846
|
+
DocumentTitle?: TextWithHighlights;
|
|
1847
|
+
DocumentExcerpt?: TextWithHighlights;
|
|
1848
|
+
DocumentURI?: string;
|
|
1849
|
+
DocumentAttributes?: DocumentAttribute[];
|
|
1850
|
+
FeedbackToken?: string;
|
|
1662
1851
|
}
|
|
1852
|
+
export declare const QueryResultFormat: {
|
|
1853
|
+
readonly TABLE: "TABLE";
|
|
1854
|
+
readonly TEXT: "TEXT";
|
|
1855
|
+
};
|
|
1856
|
+
export type QueryResultFormat =
|
|
1857
|
+
(typeof QueryResultFormat)[keyof typeof QueryResultFormat];
|
|
1858
|
+
export declare const ScoreConfidence: {
|
|
1859
|
+
readonly HIGH: "HIGH";
|
|
1860
|
+
readonly LOW: "LOW";
|
|
1861
|
+
readonly MEDIUM: "MEDIUM";
|
|
1862
|
+
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
1863
|
+
readonly VERY_HIGH: "VERY_HIGH";
|
|
1864
|
+
};
|
|
1865
|
+
export type ScoreConfidence =
|
|
1866
|
+
(typeof ScoreConfidence)[keyof typeof ScoreConfidence];
|
|
1663
1867
|
export interface ScoreAttributes {
|
|
1664
1868
|
ScoreConfidence?: ScoreConfidence | string;
|
|
1665
1869
|
}
|
|
@@ -1700,108 +1904,14 @@ export interface SpellCorrectedQuery {
|
|
|
1700
1904
|
SuggestedQueryText?: string;
|
|
1701
1905
|
Corrections?: Correction[];
|
|
1702
1906
|
}
|
|
1703
|
-
export declare
|
|
1704
|
-
QUERY_LANGUAGE_INVALID_SYNTAX
|
|
1705
|
-
}
|
|
1907
|
+
export declare const WarningCode: {
|
|
1908
|
+
readonly QUERY_LANGUAGE_INVALID_SYNTAX: "QUERY_LANGUAGE_INVALID_SYNTAX";
|
|
1909
|
+
};
|
|
1910
|
+
export type WarningCode = (typeof WarningCode)[keyof typeof WarningCode];
|
|
1706
1911
|
export interface Warning {
|
|
1707
1912
|
Message?: string;
|
|
1708
1913
|
Code?: WarningCode | string;
|
|
1709
1914
|
}
|
|
1710
|
-
export declare class ResourceInUseException extends __BaseException {
|
|
1711
|
-
readonly name: "ResourceInUseException";
|
|
1712
|
-
readonly $fault: "client";
|
|
1713
|
-
Message?: string;
|
|
1714
|
-
constructor(
|
|
1715
|
-
opts: __ExceptionOptionType<ResourceInUseException, __BaseException>
|
|
1716
|
-
);
|
|
1717
|
-
}
|
|
1718
|
-
export interface StartDataSourceSyncJobRequest {
|
|
1719
|
-
Id: string | undefined;
|
|
1720
|
-
IndexId: string | undefined;
|
|
1721
|
-
}
|
|
1722
|
-
export interface StartDataSourceSyncJobResponse {
|
|
1723
|
-
ExecutionId?: string;
|
|
1724
|
-
}
|
|
1725
|
-
export interface StopDataSourceSyncJobRequest {
|
|
1726
|
-
Id: string | undefined;
|
|
1727
|
-
IndexId: string | undefined;
|
|
1728
|
-
}
|
|
1729
|
-
export interface ClickFeedback {
|
|
1730
|
-
ResultId: string | undefined;
|
|
1731
|
-
ClickTime: Date | undefined;
|
|
1732
|
-
}
|
|
1733
|
-
export declare enum RelevanceType {
|
|
1734
|
-
NOT_RELEVANT = "NOT_RELEVANT",
|
|
1735
|
-
RELEVANT = "RELEVANT",
|
|
1736
|
-
}
|
|
1737
|
-
export interface RelevanceFeedback {
|
|
1738
|
-
ResultId: string | undefined;
|
|
1739
|
-
RelevanceValue: RelevanceType | string | undefined;
|
|
1740
|
-
}
|
|
1741
|
-
export interface SubmitFeedbackRequest {
|
|
1742
|
-
IndexId: string | undefined;
|
|
1743
|
-
QueryId: string | undefined;
|
|
1744
|
-
ClickFeedbackItems?: ClickFeedback[];
|
|
1745
|
-
RelevanceFeedbackItems?: RelevanceFeedback[];
|
|
1746
|
-
}
|
|
1747
|
-
export interface TagResourceRequest {
|
|
1748
|
-
ResourceARN: string | undefined;
|
|
1749
|
-
Tags: Tag[] | undefined;
|
|
1750
|
-
}
|
|
1751
|
-
export interface TagResourceResponse {}
|
|
1752
|
-
export interface UntagResourceRequest {
|
|
1753
|
-
ResourceARN: string | undefined;
|
|
1754
|
-
TagKeys: string[] | undefined;
|
|
1755
|
-
}
|
|
1756
|
-
export interface UntagResourceResponse {}
|
|
1757
|
-
export interface UpdateAccessControlConfigurationRequest {
|
|
1758
|
-
IndexId: string | undefined;
|
|
1759
|
-
Id: string | undefined;
|
|
1760
|
-
Name?: string;
|
|
1761
|
-
Description?: string;
|
|
1762
|
-
AccessControlList?: Principal[];
|
|
1763
|
-
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
1764
|
-
}
|
|
1765
|
-
export interface UpdateAccessControlConfigurationResponse {}
|
|
1766
|
-
export interface UpdateDataSourceRequest {
|
|
1767
|
-
Id: string | undefined;
|
|
1768
|
-
Name?: string;
|
|
1769
|
-
IndexId: string | undefined;
|
|
1770
|
-
Configuration?: DataSourceConfiguration;
|
|
1771
|
-
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1772
|
-
Description?: string;
|
|
1773
|
-
Schedule?: string;
|
|
1774
|
-
RoleArn?: string;
|
|
1775
|
-
LanguageCode?: string;
|
|
1776
|
-
CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
|
|
1777
|
-
}
|
|
1778
|
-
export interface UpdateExperienceRequest {
|
|
1779
|
-
Id: string | undefined;
|
|
1780
|
-
Name?: string;
|
|
1781
|
-
IndexId: string | undefined;
|
|
1782
|
-
RoleArn?: string;
|
|
1783
|
-
Configuration?: ExperienceConfiguration;
|
|
1784
|
-
Description?: string;
|
|
1785
|
-
}
|
|
1786
|
-
export interface UpdateIndexRequest {
|
|
1787
|
-
Id: string | undefined;
|
|
1788
|
-
Name?: string;
|
|
1789
|
-
RoleArn?: string;
|
|
1790
|
-
Description?: string;
|
|
1791
|
-
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
|
|
1792
|
-
CapacityUnits?: CapacityUnitsConfiguration;
|
|
1793
|
-
UserTokenConfigurations?: UserTokenConfiguration[];
|
|
1794
|
-
UserContextPolicy?: UserContextPolicy | string;
|
|
1795
|
-
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
1796
|
-
}
|
|
1797
|
-
export interface UpdateQuerySuggestionsBlockListRequest {
|
|
1798
|
-
IndexId: string | undefined;
|
|
1799
|
-
Id: string | undefined;
|
|
1800
|
-
Name?: string;
|
|
1801
|
-
Description?: string;
|
|
1802
|
-
SourceS3Path?: S3Path;
|
|
1803
|
-
RoleArn?: string;
|
|
1804
|
-
}
|
|
1805
1915
|
export declare const ServerSideEncryptionConfigurationFilterSensitiveLog: (
|
|
1806
1916
|
obj: ServerSideEncryptionConfiguration
|
|
1807
1917
|
) => any;
|