@aws-sdk/client-kendra 3.50.0 → 3.53.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/CHANGELOG.md +30 -0
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/KendraServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +172 -6
- package/dist-cjs/protocols/Aws_json1_1.js +741 -2572
- package/dist-es/index.js +1 -0
- package/dist-es/models/KendraServiceException.js +12 -0
- package/dist-es/models/models_0.js +154 -1
- package/dist-es/protocols/Aws_json1_1.js +1492 -2772
- package/dist-types/Kendra.d.ts +17 -17
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +5 -5
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +2 -2
- package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/QueryCommand.d.ts +2 -2
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/KendraServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +237 -105
- package/dist-types/ts3.4/Kendra.d.ts +280 -0
- package/dist-types/ts3.4/KendraClient.d.ts +128 -0
- package/dist-types/ts3.4/commands/AssociateEntitiesToExperienceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/AssociatePersonasToEntitiesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/BatchDeleteDocumentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/BatchGetDocumentStatusCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/BatchPutDocumentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ClearQuerySuggestionsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateDataSourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateExperienceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateFaqCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateIndexCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateQuerySuggestionsBlockListCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateThesaurusCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteExperienceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteFaqCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteIndexCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeletePrincipalMappingCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteThesaurusCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeDataSourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeExperienceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeFaqCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeIndexCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribePrincipalMappingCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeQuerySuggestionsConfigCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeThesaurusCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DisassociateEntitiesFromExperienceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DisassociatePersonasFromEntitiesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetQuerySuggestionsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetSnapshotsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListDataSourceSyncJobsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListEntityPersonasCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExperienceEntitiesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExperiencesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListFaqsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListIndicesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListQuerySuggestionsBlockListsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListThesauriCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/PutPrincipalMappingCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/QueryCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SubmitFeedbackCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateExperienceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsConfigCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateThesaurusCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +55 -0
- package/dist-types/ts3.4/endpoints.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/KendraServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +3355 -0
- package/dist-types/ts3.4/pagination/GetSnapshotsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListDataSourceSyncJobsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListDataSourcesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListEntityPersonasPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListExperienceEntitiesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListExperiencesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListIndicesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +8 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +167 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +38 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +38 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +37 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
- package/package.json +33 -33
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { KendraServiceException as __BaseException } from "./KendraServiceException";
|
|
2
3
|
/**
|
|
3
4
|
* <p>Access Control List files for the documents in a data source. For
|
|
4
5
|
* the format of the file, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html">Access control for S3 data
|
|
@@ -19,10 +20,14 @@ export declare namespace AccessControlListConfiguration {
|
|
|
19
20
|
/**
|
|
20
21
|
* <p></p>
|
|
21
22
|
*/
|
|
22
|
-
export
|
|
23
|
-
name: "AccessDeniedException";
|
|
24
|
-
$fault: "client";
|
|
23
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
24
|
+
readonly name: "AccessDeniedException";
|
|
25
|
+
readonly $fault: "client";
|
|
25
26
|
Message?: string;
|
|
27
|
+
/**
|
|
28
|
+
* @internal
|
|
29
|
+
*/
|
|
30
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
26
31
|
}
|
|
27
32
|
/**
|
|
28
33
|
* <p>Provides information about the column that should be used for
|
|
@@ -34,7 +39,7 @@ export interface AclConfiguration {
|
|
|
34
39
|
* response based on user context. The document is only returned to
|
|
35
40
|
* users that are in one of the groups specified in the
|
|
36
41
|
* <code>UserContext</code> field of the <code>Query</code>
|
|
37
|
-
*
|
|
42
|
+
* API.</p>
|
|
38
43
|
*/
|
|
39
44
|
AllowedGroupsColumnName: string | undefined;
|
|
40
45
|
}
|
|
@@ -228,42 +233,62 @@ export declare namespace AssociateEntitiesToExperienceResponse {
|
|
|
228
233
|
/**
|
|
229
234
|
* <p></p>
|
|
230
235
|
*/
|
|
231
|
-
export
|
|
232
|
-
name: "InternalServerException";
|
|
233
|
-
$fault: "server";
|
|
236
|
+
export declare class InternalServerException extends __BaseException {
|
|
237
|
+
readonly name: "InternalServerException";
|
|
238
|
+
readonly $fault: "server";
|
|
234
239
|
Message?: string;
|
|
240
|
+
/**
|
|
241
|
+
* @internal
|
|
242
|
+
*/
|
|
243
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
235
244
|
}
|
|
236
245
|
/**
|
|
237
246
|
* <p></p>
|
|
238
247
|
*/
|
|
239
|
-
export
|
|
240
|
-
name: "ResourceAlreadyExistException";
|
|
241
|
-
$fault: "client";
|
|
248
|
+
export declare class ResourceAlreadyExistException extends __BaseException {
|
|
249
|
+
readonly name: "ResourceAlreadyExistException";
|
|
250
|
+
readonly $fault: "client";
|
|
242
251
|
Message?: string;
|
|
252
|
+
/**
|
|
253
|
+
* @internal
|
|
254
|
+
*/
|
|
255
|
+
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistException, __BaseException>);
|
|
243
256
|
}
|
|
244
257
|
/**
|
|
245
258
|
* <p></p>
|
|
246
259
|
*/
|
|
247
|
-
export
|
|
248
|
-
name: "ResourceNotFoundException";
|
|
249
|
-
$fault: "client";
|
|
260
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
261
|
+
readonly name: "ResourceNotFoundException";
|
|
262
|
+
readonly $fault: "client";
|
|
250
263
|
Message?: string;
|
|
264
|
+
/**
|
|
265
|
+
* @internal
|
|
266
|
+
*/
|
|
267
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
251
268
|
}
|
|
252
269
|
/**
|
|
253
270
|
* <p></p>
|
|
254
271
|
*/
|
|
255
|
-
export
|
|
256
|
-
name: "ThrottlingException";
|
|
257
|
-
$fault: "client";
|
|
272
|
+
export declare class ThrottlingException extends __BaseException {
|
|
273
|
+
readonly name: "ThrottlingException";
|
|
274
|
+
readonly $fault: "client";
|
|
258
275
|
Message?: string;
|
|
276
|
+
/**
|
|
277
|
+
* @internal
|
|
278
|
+
*/
|
|
279
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
259
280
|
}
|
|
260
281
|
/**
|
|
261
282
|
* <p></p>
|
|
262
283
|
*/
|
|
263
|
-
export
|
|
264
|
-
name: "ValidationException";
|
|
265
|
-
$fault: "client";
|
|
284
|
+
export declare class ValidationException extends __BaseException {
|
|
285
|
+
readonly name: "ValidationException";
|
|
286
|
+
readonly $fault: "client";
|
|
266
287
|
Message?: string;
|
|
288
|
+
/**
|
|
289
|
+
* @internal
|
|
290
|
+
*/
|
|
291
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
267
292
|
}
|
|
268
293
|
export declare enum Persona {
|
|
269
294
|
OWNER = "OWNER",
|
|
@@ -494,7 +519,7 @@ export declare enum ErrorCode {
|
|
|
494
519
|
/**
|
|
495
520
|
* <p>Provides information about documents that could not be removed
|
|
496
521
|
* from an index by the <code>BatchDeleteDocument</code>
|
|
497
|
-
*
|
|
522
|
+
* API.</p>
|
|
498
523
|
*/
|
|
499
524
|
export interface BatchDeleteDocumentResponseFailedDocument {
|
|
500
525
|
/**
|
|
@@ -536,10 +561,14 @@ export declare namespace BatchDeleteDocumentResponse {
|
|
|
536
561
|
/**
|
|
537
562
|
* <p></p>
|
|
538
563
|
*/
|
|
539
|
-
export
|
|
540
|
-
name: "ConflictException";
|
|
541
|
-
$fault: "client";
|
|
564
|
+
export declare class ConflictException extends __BaseException {
|
|
565
|
+
readonly name: "ConflictException";
|
|
566
|
+
readonly $fault: "client";
|
|
542
567
|
Message?: string;
|
|
568
|
+
/**
|
|
569
|
+
* @internal
|
|
570
|
+
*/
|
|
571
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
543
572
|
}
|
|
544
573
|
/**
|
|
545
574
|
* <p>Identifies a document for which to retrieve status
|
|
@@ -597,8 +626,8 @@ export declare namespace DocumentInfo {
|
|
|
597
626
|
export interface BatchGetDocumentStatusRequest {
|
|
598
627
|
/**
|
|
599
628
|
* <p>The identifier of the index to add documents to. The index ID is
|
|
600
|
-
* returned by the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html">
|
|
601
|
-
* </a>
|
|
629
|
+
* returned by the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html">CreateIndex
|
|
630
|
+
* </a> API.</p>
|
|
602
631
|
*/
|
|
603
632
|
IndexId: string | undefined;
|
|
604
633
|
/**
|
|
@@ -1008,7 +1037,7 @@ export interface Document {
|
|
|
1008
1037
|
* <p>The contents of the document. </p>
|
|
1009
1038
|
* <p>Documents passed to the <code>Blob</code> parameter must be base64
|
|
1010
1039
|
* encoded. Your code might not need to encode the document file bytes
|
|
1011
|
-
* if you're using an Amazon Web Services SDK to call Amazon Kendra
|
|
1040
|
+
* if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are
|
|
1012
1041
|
* calling the Amazon Kendra endpoint directly using REST, you must base64
|
|
1013
1042
|
* encode the contents before sending.</p>
|
|
1014
1043
|
*/
|
|
@@ -1023,6 +1052,11 @@ export interface Document {
|
|
|
1023
1052
|
* attributes to provide additional information for searching, to
|
|
1024
1053
|
* provide facets for refining searches, and to provide additional
|
|
1025
1054
|
* information in the query response.</p>
|
|
1055
|
+
* <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom
|
|
1056
|
+
* attributes that provide information on the synchronization
|
|
1057
|
+
* of documents running on a data source. Note,
|
|
1058
|
+
* 'DataSourceSyncJobId' could be an optional custom attribute
|
|
1059
|
+
* as Amazon Kendra will use the ID of a running sync job.</p>
|
|
1026
1060
|
*/
|
|
1027
1061
|
Attributes?: DocumentAttribute[];
|
|
1028
1062
|
/**
|
|
@@ -1051,24 +1085,18 @@ export interface BatchPutDocumentRequest {
|
|
|
1051
1085
|
/**
|
|
1052
1086
|
* <p>The identifier of the index to add the documents to. You need to
|
|
1053
1087
|
* create the index first using the <code>CreateIndex</code>
|
|
1054
|
-
*
|
|
1088
|
+
* API.</p>
|
|
1055
1089
|
*/
|
|
1056
1090
|
IndexId: string | undefined;
|
|
1057
1091
|
/**
|
|
1058
1092
|
* <p>The Amazon Resource Name (ARN) of a role that is allowed to run the
|
|
1059
|
-
* <code>BatchPutDocument</code>
|
|
1093
|
+
* <code>BatchPutDocument</code> API. For more information, see
|
|
1060
1094
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM
|
|
1061
|
-
*
|
|
1095
|
+
* Roles for Amazon Kendra</a>.</p>
|
|
1062
1096
|
*/
|
|
1063
1097
|
RoleArn?: string;
|
|
1064
1098
|
/**
|
|
1065
1099
|
* <p>One or more documents to add to the index.</p>
|
|
1066
|
-
* <p>Documents can include custom attributes. For example,
|
|
1067
|
-
* 'DataSourceId' and 'DataSourceSyncJobId' are custom
|
|
1068
|
-
* attributes that provide information on the synchronization
|
|
1069
|
-
* of documents running on a data source. Note,
|
|
1070
|
-
* 'DataSourceSyncJobId' could be an optional custom attribute
|
|
1071
|
-
* as Amazon Kendra will use the ID of a running sync job.</p>
|
|
1072
1100
|
* <p>Documents have the following file size limits.</p>
|
|
1073
1101
|
* <ul>
|
|
1074
1102
|
* <li>
|
|
@@ -1088,7 +1116,7 @@ export interface BatchPutDocumentRequest {
|
|
|
1088
1116
|
/**
|
|
1089
1117
|
* <p>Configuration information for altering your document metadata and content during
|
|
1090
1118
|
* the document ingestion process when you use the <code>BatchPutDocument</code>
|
|
1091
|
-
*
|
|
1119
|
+
* API.</p>
|
|
1092
1120
|
* <p>For more information on how to create, modify and delete document metadata,
|
|
1093
1121
|
* or make other content alterations when you ingest documents into Amazon Kendra, see
|
|
1094
1122
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
@@ -1150,10 +1178,14 @@ export declare namespace BatchPutDocumentResponse {
|
|
|
1150
1178
|
/**
|
|
1151
1179
|
* <p></p>
|
|
1152
1180
|
*/
|
|
1153
|
-
export
|
|
1154
|
-
name: "ServiceQuotaExceededException";
|
|
1155
|
-
$fault: "client";
|
|
1181
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1182
|
+
readonly name: "ServiceQuotaExceededException";
|
|
1183
|
+
readonly $fault: "client";
|
|
1156
1184
|
Message?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* @internal
|
|
1187
|
+
*/
|
|
1188
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
1157
1189
|
}
|
|
1158
1190
|
export interface ClearQuerySuggestionsRequest {
|
|
1159
1191
|
/**
|
|
@@ -1184,13 +1216,13 @@ export declare enum ConfluenceAttachmentFieldName {
|
|
|
1184
1216
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1185
1217
|
* to a Amazon Kendra index field.</p>
|
|
1186
1218
|
* <p>You must first create the index field using the
|
|
1187
|
-
* <code>UpdateIndex</code>
|
|
1219
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1188
1220
|
*/
|
|
1189
1221
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
1190
1222
|
/**
|
|
1191
1223
|
* <p>The name of the field in the data source. </p>
|
|
1192
1224
|
* <p>You must first create the index field using the
|
|
1193
|
-
* <code>UpdateIndex</code>
|
|
1225
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1194
1226
|
*/
|
|
1195
1227
|
DataSourceFieldName?: ConfluenceAttachmentFieldName | string;
|
|
1196
1228
|
/**
|
|
@@ -1228,7 +1260,7 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
1228
1260
|
* <p>Defines how attachment metadata fields should be mapped to index
|
|
1229
1261
|
* fields. Before you can map a field, you must first create an index
|
|
1230
1262
|
* field with a matching type using the console or the
|
|
1231
|
-
* <code>UpdateIndex</code>
|
|
1263
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1232
1264
|
* <p>If you specify the <code>AttachentFieldMappings</code> parameter,
|
|
1233
1265
|
* you must specify at least one field mapping.</p>
|
|
1234
1266
|
*/
|
|
@@ -1255,7 +1287,7 @@ export declare enum ConfluenceBlogFieldName {
|
|
|
1255
1287
|
* <p>Defines the mapping between a blog field in the Confluence data
|
|
1256
1288
|
* source to a Amazon Kendra index field.</p>
|
|
1257
1289
|
* <p>You must first create the index field using the
|
|
1258
|
-
* <code>UpdateIndex</code>
|
|
1290
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1259
1291
|
*/
|
|
1260
1292
|
export interface ConfluenceBlogToIndexFieldMapping {
|
|
1261
1293
|
/**
|
|
@@ -1286,14 +1318,14 @@ export declare namespace ConfluenceBlogToIndexFieldMapping {
|
|
|
1286
1318
|
* <p>Specifies the blog settings for the Confluence data source. Blogs
|
|
1287
1319
|
* are always indexed unless filtered from the index by the
|
|
1288
1320
|
* <code>ExclusionPatterns</code> or <code>InclusionPatterns</code>
|
|
1289
|
-
* fields in the <code>ConfluenceConfiguration</code>
|
|
1321
|
+
* fields in the <code>ConfluenceConfiguration</code> object.</p>
|
|
1290
1322
|
*/
|
|
1291
1323
|
export interface ConfluenceBlogConfiguration {
|
|
1292
1324
|
/**
|
|
1293
1325
|
* <p>Defines how blog metadata fields should be mapped to index fields.
|
|
1294
1326
|
* Before you can map a field, you must first create an index field
|
|
1295
1327
|
* with a matching type using the console or the
|
|
1296
|
-
* <code>UpdateIndex</code>
|
|
1328
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1297
1329
|
* <p>If you specify the <code>BlogFieldMappings</code> parameter, you
|
|
1298
1330
|
* must specify at least one field mapping.</p>
|
|
1299
1331
|
*/
|
|
@@ -1323,7 +1355,7 @@ export declare enum ConfluencePageFieldName {
|
|
|
1323
1355
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1324
1356
|
* to a Amazon Kendra index field.</p>
|
|
1325
1357
|
* <p>You must first create the index field using the
|
|
1326
|
-
* <code>UpdateIndex</code>
|
|
1358
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1327
1359
|
*/
|
|
1328
1360
|
export interface ConfluencePageToIndexFieldMapping {
|
|
1329
1361
|
/**
|
|
@@ -1358,7 +1390,7 @@ export interface ConfluencePageConfiguration {
|
|
|
1358
1390
|
* <p>Defines how page metadata fields should be mapped to index fields.
|
|
1359
1391
|
* Before you can map a field, you must first create an index field
|
|
1360
1392
|
* with a matching type using the console or the
|
|
1361
|
-
* <code>UpdateIndex</code>
|
|
1393
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1362
1394
|
* <p>If you specify the <code>PageFieldMappings</code> parameter, you
|
|
1363
1395
|
* must specify at least one field mapping.</p>
|
|
1364
1396
|
*/
|
|
@@ -1378,9 +1410,9 @@ export declare enum ConfluenceSpaceFieldName {
|
|
|
1378
1410
|
}
|
|
1379
1411
|
/**
|
|
1380
1412
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1381
|
-
* to
|
|
1413
|
+
* to an Amazon Kendra index field.</p>
|
|
1382
1414
|
* <p>You must first create the index field using the
|
|
1383
|
-
* <code>UpdateIndex</code>
|
|
1415
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1384
1416
|
*/
|
|
1385
1417
|
export interface ConfluenceSpaceToIndexFieldMapping {
|
|
1386
1418
|
/**
|
|
@@ -1445,7 +1477,7 @@ export interface ConfluenceSpaceConfiguration {
|
|
|
1445
1477
|
* <p>Defines how space metadata fields should be mapped to index
|
|
1446
1478
|
* fields. Before you can map a field, you must first create an index
|
|
1447
1479
|
* field with a matching type using the console or the
|
|
1448
|
-
* <code>UpdateIndex</code>
|
|
1480
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1449
1481
|
* <p>If you specify the <code>SpaceFieldMappings</code> parameter, you
|
|
1450
1482
|
* must specify at least one field mapping.</p>
|
|
1451
1483
|
*/
|
|
@@ -1573,7 +1605,7 @@ export declare namespace ConfluenceConfiguration {
|
|
|
1573
1605
|
/**
|
|
1574
1606
|
* <p>Maps a column or attribute in the data source to an index field.
|
|
1575
1607
|
* You must first create the fields in the index using the
|
|
1576
|
-
* <code>UpdateIndex</code>
|
|
1608
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1577
1609
|
*/
|
|
1578
1610
|
export interface DataSourceToIndexFieldMapping {
|
|
1579
1611
|
/**
|
|
@@ -1615,7 +1647,7 @@ export interface ColumnConfiguration {
|
|
|
1615
1647
|
/**
|
|
1616
1648
|
* <p>An array of objects that map database column names to the
|
|
1617
1649
|
* corresponding fields in an index. You must first create the fields
|
|
1618
|
-
* in the index using the <code>UpdateIndex</code>
|
|
1650
|
+
* in the index using the <code>UpdateIndex</code> API.</p>
|
|
1619
1651
|
*/
|
|
1620
1652
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1621
1653
|
/**
|
|
@@ -1745,6 +1777,89 @@ export declare namespace DatabaseConfiguration {
|
|
|
1745
1777
|
*/
|
|
1746
1778
|
const filterSensitiveLog: (obj: DatabaseConfiguration) => any;
|
|
1747
1779
|
}
|
|
1780
|
+
export declare enum FsxFileSystemType {
|
|
1781
|
+
WINDOWS = "WINDOWS"
|
|
1782
|
+
}
|
|
1783
|
+
/**
|
|
1784
|
+
* <p>Provides the configuration information to connect to Amazon FSx as
|
|
1785
|
+
* your data source.</p>
|
|
1786
|
+
*/
|
|
1787
|
+
export interface FsxConfiguration {
|
|
1788
|
+
/**
|
|
1789
|
+
* <p>The identifier of the Amazon FSx file system.</p>
|
|
1790
|
+
* <p>You can find your file system ID on the file system dashboard in
|
|
1791
|
+
* the Amazon FSx console. For information on how to create a
|
|
1792
|
+
* file system in Amazon FSx console, using Windows File Server
|
|
1793
|
+
* as an example, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html">Amazon FSx
|
|
1794
|
+
* Getting started guide</a>.</p>
|
|
1795
|
+
*/
|
|
1796
|
+
FileSystemId: string | undefined;
|
|
1797
|
+
/**
|
|
1798
|
+
* <p>The Amazon FSx file system type. Windows is currently the only
|
|
1799
|
+
* supported type.</p>
|
|
1800
|
+
*/
|
|
1801
|
+
FileSystemType: FsxFileSystemType | string | undefined;
|
|
1802
|
+
/**
|
|
1803
|
+
* <p>Provides the configuration information for connecting to an
|
|
1804
|
+
* Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx
|
|
1805
|
+
* instance must reside inside your VPC.</p>
|
|
1806
|
+
*/
|
|
1807
|
+
VpcConfiguration: DataSourceVpcConfiguration | undefined;
|
|
1808
|
+
/**
|
|
1809
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
1810
|
+
* contains the key-value pairs required to connect to your Amazon FSx
|
|
1811
|
+
* file system. Windows is currently the only supported type. The secret must
|
|
1812
|
+
* contain a JSON structure with the following keys:</p>
|
|
1813
|
+
* <ul>
|
|
1814
|
+
* <li>
|
|
1815
|
+
* <p>username—The Active Directory user name, along with the
|
|
1816
|
+
* Domain Name System (DNS) domain name. For example,
|
|
1817
|
+
* <i>user@corp.example.com</i>. The Active Directory
|
|
1818
|
+
* user account must have read and mounting access to the
|
|
1819
|
+
* Amazon FSx file system for Windows.</p>
|
|
1820
|
+
* </li>
|
|
1821
|
+
* <li>
|
|
1822
|
+
* <p>password—The password of the active directory user with
|
|
1823
|
+
* read and mounting access Amazon FSx Windows file system.</p>
|
|
1824
|
+
* </li>
|
|
1825
|
+
* </ul>
|
|
1826
|
+
*/
|
|
1827
|
+
SecretArn?: string;
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>A list of regular expression patterns to include certain files
|
|
1830
|
+
* in your Amazon FSx file system. Files that match the patterns
|
|
1831
|
+
* are included in the index. Files that don't match the patterns are
|
|
1832
|
+
* excluded from the index. If a file matches both an inclusion pattern
|
|
1833
|
+
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
1834
|
+
* and the file isn't included in the index.</p>
|
|
1835
|
+
*/
|
|
1836
|
+
InclusionPatterns?: string[];
|
|
1837
|
+
/**
|
|
1838
|
+
* <p>A list of regular expression patterns to exclude certain files
|
|
1839
|
+
* in your Amazon FSx file system. Files that match the patterns
|
|
1840
|
+
* are excluded from the index. Files that don’t match the patterns are
|
|
1841
|
+
* included in the index. If a file matches both an inclusion pattern
|
|
1842
|
+
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
1843
|
+
* and the file isn't included in the index.</p>
|
|
1844
|
+
*/
|
|
1845
|
+
ExclusionPatterns?: string[];
|
|
1846
|
+
/**
|
|
1847
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
1848
|
+
* map Amazon FSx data source attributes or field names to Amazon Kendra
|
|
1849
|
+
* index field names in Amazon Kendra. To create custom fields, use the
|
|
1850
|
+
* <code>UpdateIndex</code> API before you map to Amazon FSx fields.
|
|
1851
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
1852
|
+
* data source fields</a>. The Amazon FSx data source field names
|
|
1853
|
+
* must exist in your Amazon FSx custom metadata.</p>
|
|
1854
|
+
*/
|
|
1855
|
+
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1856
|
+
}
|
|
1857
|
+
export declare namespace FsxConfiguration {
|
|
1858
|
+
/**
|
|
1859
|
+
* @internal
|
|
1860
|
+
*/
|
|
1861
|
+
const filterSensitiveLog: (obj: FsxConfiguration) => any;
|
|
1862
|
+
}
|
|
1748
1863
|
/**
|
|
1749
1864
|
* <p>Provides configuration information for data sources that connect
|
|
1750
1865
|
* to Google Drive.</p>
|
|
@@ -1781,7 +1896,7 @@ export interface GoogleDriveConfiguration {
|
|
|
1781
1896
|
* <p>If you are using the console, you can define index fields when
|
|
1782
1897
|
* creating the mapping. If you are using the API, you must first
|
|
1783
1898
|
* create the field using the <code>UpdateIndex</code>
|
|
1784
|
-
*
|
|
1899
|
+
* API.</p>
|
|
1785
1900
|
*/
|
|
1786
1901
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1787
1902
|
/**
|
|
@@ -2550,7 +2665,7 @@ export interface SharePointConfiguration {
|
|
|
2550
2665
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
2551
2666
|
* map Microsoft SharePoint attributes to custom fields in the Amazon Kendra
|
|
2552
2667
|
* index. You must first create the index fields using the
|
|
2553
|
-
* <code>UpdateIndex</code>
|
|
2668
|
+
* <code>UpdateIndex</code> API before you map SharePoint
|
|
2554
2669
|
* attributes. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping Data Source
|
|
2555
2670
|
* Fields</a>.</p>
|
|
2556
2671
|
*/
|
|
@@ -2877,7 +2992,7 @@ export interface WorkDocsConfiguration {
|
|
|
2877
2992
|
/**
|
|
2878
2993
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2879
2994
|
* Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first
|
|
2880
|
-
* create the custom index fields using the <code>UpdateIndex</code>
|
|
2995
|
+
* create the custom index fields using the <code>UpdateIndex</code> API before
|
|
2881
2996
|
* you map to Amazon WorkDocs fields. For more information, see
|
|
2882
2997
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2883
2998
|
* Data Source Fields</a>. The Amazon WorkDocs data source field names
|
|
@@ -2941,10 +3056,15 @@ export interface DataSourceConfiguration {
|
|
|
2941
3056
|
*/
|
|
2942
3057
|
WebCrawlerConfiguration?: WebCrawlerConfiguration;
|
|
2943
3058
|
/**
|
|
2944
|
-
* <p>Provides the configuration information to connect to WorkDocs
|
|
3059
|
+
* <p>Provides the configuration information to connect to Amazon WorkDocs
|
|
2945
3060
|
* as your data source.</p>
|
|
2946
3061
|
*/
|
|
2947
3062
|
WorkDocsConfiguration?: WorkDocsConfiguration;
|
|
3063
|
+
/**
|
|
3064
|
+
* <p>Provides the configuration information to connect to Amazon FSx as
|
|
3065
|
+
* your data source.</p>
|
|
3066
|
+
*/
|
|
3067
|
+
FsxConfiguration?: FsxConfiguration;
|
|
2948
3068
|
}
|
|
2949
3069
|
export declare namespace DataSourceConfiguration {
|
|
2950
3070
|
/**
|
|
@@ -2979,6 +3099,7 @@ export declare enum DataSourceType {
|
|
|
2979
3099
|
CONFLUENCE = "CONFLUENCE",
|
|
2980
3100
|
CUSTOM = "CUSTOM",
|
|
2981
3101
|
DATABASE = "DATABASE",
|
|
3102
|
+
FSX = "FSX",
|
|
2982
3103
|
GOOGLEDRIVE = "GOOGLEDRIVE",
|
|
2983
3104
|
ONEDRIVE = "ONEDRIVE",
|
|
2984
3105
|
S3 = "S3",
|
|
@@ -3018,10 +3139,10 @@ export interface CreateDataSourceRequest {
|
|
|
3018
3139
|
*/
|
|
3019
3140
|
Description?: string;
|
|
3020
3141
|
/**
|
|
3021
|
-
* <p>Sets the frequency
|
|
3142
|
+
* <p>Sets the frequency for Amazon Kendra to check the documents in your
|
|
3022
3143
|
* repository and update the index. If you don't set a schedule Amazon Kendra
|
|
3023
3144
|
* will not periodically update the index. You can call the
|
|
3024
|
-
* <code>StartDataSourceSyncJob</code>
|
|
3145
|
+
* <code>StartDataSourceSyncJob</code> API to update the
|
|
3025
3146
|
* index.</p>
|
|
3026
3147
|
* <p>You can't specify the <code>Schedule</code> parameter when the
|
|
3027
3148
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
@@ -3047,7 +3168,7 @@ export interface CreateDataSourceRequest {
|
|
|
3047
3168
|
Tags?: Tag[];
|
|
3048
3169
|
/**
|
|
3049
3170
|
* <p>A token that you provide to identify the request to create a data
|
|
3050
|
-
* source. Multiple calls to the <code>CreateDataSource</code>
|
|
3171
|
+
* source. Multiple calls to the <code>CreateDataSource</code> API with
|
|
3051
3172
|
* the same client token will create only one data source.</p>
|
|
3052
3173
|
*/
|
|
3053
3174
|
ClientToken?: string;
|
|
@@ -3103,7 +3224,7 @@ export interface ContentSourceConfiguration {
|
|
|
3103
3224
|
/**
|
|
3104
3225
|
* <p>
|
|
3105
3226
|
* <code>TRUE</code> to use documents you indexed directly using the
|
|
3106
|
-
* <code>BatchPutDocument</code>
|
|
3227
|
+
* <code>BatchPutDocument</code> API.</p>
|
|
3107
3228
|
*/
|
|
3108
3229
|
DirectPutContent?: boolean;
|
|
3109
3230
|
}
|
|
@@ -3143,7 +3264,7 @@ export interface ExperienceConfiguration {
|
|
|
3143
3264
|
/**
|
|
3144
3265
|
* <p>The identifiers of your data sources and FAQs. Or, you can specify
|
|
3145
3266
|
* that you want to use documents indexed via the <code>BatchPutDocument</code>
|
|
3146
|
-
*
|
|
3267
|
+
* API. This is the content you want to use for your Amazon Kendra experience.</p>
|
|
3147
3268
|
*/
|
|
3148
3269
|
ContentSourceConfiguration?: ContentSourceConfiguration;
|
|
3149
3270
|
/**
|
|
@@ -3169,8 +3290,8 @@ export interface CreateExperienceRequest {
|
|
|
3169
3290
|
IndexId: string | undefined;
|
|
3170
3291
|
/**
|
|
3171
3292
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3293
|
+
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
3294
|
+
* API, and Amazon Web Services SSO that stores your user and group information.
|
|
3174
3295
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
3175
3296
|
*/
|
|
3176
3297
|
RoleArn?: string;
|
|
@@ -3187,7 +3308,7 @@ export interface CreateExperienceRequest {
|
|
|
3187
3308
|
Description?: string;
|
|
3188
3309
|
/**
|
|
3189
3310
|
* <p>A token that you provide to identify the request to create your Amazon Kendra experience.
|
|
3190
|
-
* Multiple calls to the <code>CreateExperience</code>
|
|
3311
|
+
* Multiple calls to the <code>CreateExperience</code> API with the same client
|
|
3191
3312
|
* token creates only one Amazon Kendra experience.</p>
|
|
3192
3313
|
*/
|
|
3193
3314
|
ClientToken?: string;
|
|
@@ -3254,7 +3375,7 @@ export interface CreateFaqRequest {
|
|
|
3254
3375
|
FileFormat?: FaqFileFormat | string;
|
|
3255
3376
|
/**
|
|
3256
3377
|
* <p>A token that you provide to identify the request to create a FAQ. Multiple calls to
|
|
3257
|
-
* the <code>CreateFaqRequest</code>
|
|
3378
|
+
* the <code>CreateFaqRequest</code> API with the same client token will create only
|
|
3258
3379
|
* one FAQ. </p>
|
|
3259
3380
|
*/
|
|
3260
3381
|
ClientToken?: string;
|
|
@@ -3323,7 +3444,7 @@ export declare enum UserGroupResolutionMode {
|
|
|
3323
3444
|
* group's access to documents. You can also map your users to their
|
|
3324
3445
|
* groups for user context filtering using the
|
|
3325
3446
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping
|
|
3326
|
-
*
|
|
3447
|
+
* API</a>.</p>
|
|
3327
3448
|
* <p>To set up an Amazon Web Services SSO identity source in the console to use with
|
|
3328
3449
|
* Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started
|
|
3329
3450
|
* with an Amazon Web Services SSO identity source</a>. You must also grant the required
|
|
@@ -3332,7 +3453,7 @@ export declare enum UserGroupResolutionMode {
|
|
|
3332
3453
|
* Amazon Web Services SSO</a>.</p>
|
|
3333
3454
|
* <p>Amazon Kendra currently does not support using <code>UserGroupResolutionConfiguration</code>
|
|
3334
3455
|
* with an Amazon Web Services organization member account for your Amazon Web Services SSO
|
|
3335
|
-
* identify source. You must create your index in the
|
|
3456
|
+
* identify source. You must create your index in the management account for the organization
|
|
3336
3457
|
* in order to use <code>UserGroupResolutionConfiguration</code>.</p>
|
|
3337
3458
|
*/
|
|
3338
3459
|
export interface UserGroupResolutionConfiguration {
|
|
@@ -3452,7 +3573,7 @@ export interface CreateIndexRequest {
|
|
|
3452
3573
|
* <p>An Identity and Access Management(IAM) role that gives
|
|
3453
3574
|
* Amazon Kendra permissions to access your Amazon CloudWatch logs and
|
|
3454
3575
|
* metrics. This is also the role used when you use the
|
|
3455
|
-
* <code>BatchPutDocument</code>
|
|
3576
|
+
* <code>BatchPutDocument</code> API to index documents from an
|
|
3456
3577
|
* Amazon S3 bucket.</p>
|
|
3457
3578
|
*/
|
|
3458
3579
|
RoleArn: string | undefined;
|
|
@@ -3468,7 +3589,7 @@ export interface CreateIndexRequest {
|
|
|
3468
3589
|
Description?: string;
|
|
3469
3590
|
/**
|
|
3470
3591
|
* <p>A token that you provide to identify the request to create an index.
|
|
3471
|
-
* Multiple calls to the <code>CreateIndex</code>
|
|
3592
|
+
* Multiple calls to the <code>CreateIndex</code> API with the same
|
|
3472
3593
|
* client token will create only one index.</p>
|
|
3473
3594
|
*/
|
|
3474
3595
|
ClientToken?: string;
|
|
@@ -3565,7 +3686,7 @@ export interface CreateQuerySuggestionsBlockListRequest {
|
|
|
3565
3686
|
/**
|
|
3566
3687
|
* <p>The IAM (Identity and Access Management) role used by Amazon Kendra to
|
|
3567
3688
|
* access the block list text file in your S3 bucket.</p>
|
|
3568
|
-
* <p>You need permissions to the role ARN (Amazon Resource Name).
|
|
3689
|
+
* <p>You need permissions to the role ARN (Amazon Web Services Resource Name).
|
|
3569
3690
|
* The role needs S3 read permissions to your file in S3 and needs
|
|
3570
3691
|
* to give STS (Security Token Service) assume role permissions
|
|
3571
3692
|
* to Amazon Kendra.</p>
|
|
@@ -3629,7 +3750,7 @@ export interface CreateThesaurusRequest {
|
|
|
3629
3750
|
SourceS3Path: S3Path | undefined;
|
|
3630
3751
|
/**
|
|
3631
3752
|
* <p>A token that you provide to identify the request to create a
|
|
3632
|
-
* thesaurus. Multiple calls to the <code>CreateThesaurus</code>
|
|
3753
|
+
* thesaurus. Multiple calls to the <code>CreateThesaurus</code> API
|
|
3633
3754
|
* with the same client token will create only one thesaurus.
|
|
3634
3755
|
* </p>
|
|
3635
3756
|
*/
|
|
@@ -3866,7 +3987,7 @@ export interface DescribeDataSourceResponse {
|
|
|
3866
3987
|
*/
|
|
3867
3988
|
Status?: DataSourceStatus | string;
|
|
3868
3989
|
/**
|
|
3869
|
-
* <p>The schedule
|
|
3990
|
+
* <p>The schedule for Amazon Kendra to update the index.</p>
|
|
3870
3991
|
*/
|
|
3871
3992
|
Schedule?: string;
|
|
3872
3993
|
/**
|
|
@@ -3998,8 +4119,8 @@ export interface DescribeExperienceResponse {
|
|
|
3998
4119
|
Status?: ExperienceStatus | string;
|
|
3999
4120
|
/**
|
|
4000
4121
|
* <p>Shows the Amazon Resource Name (ARN) of a role with permission to access
|
|
4001
|
-
* <code>Query</code>
|
|
4002
|
-
* <code>SubmitFeedback</code>
|
|
4122
|
+
* <code>Query</code> API, <code>QuerySuggestions</code> API,
|
|
4123
|
+
* <code>SubmitFeedback</code> API, and Amazon Web Services SSO that stores
|
|
4003
4124
|
* your user and group information.</p>
|
|
4004
4125
|
*/
|
|
4005
4126
|
RoleArn?: string;
|
|
@@ -4692,7 +4813,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
4692
4813
|
* <p>By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code>
|
|
4693
4814
|
* turns off query suggestions for your users. You can change the mode using
|
|
4694
4815
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a>
|
|
4695
|
-
*
|
|
4816
|
+
* API.</p>
|
|
4696
4817
|
*/
|
|
4697
4818
|
Mode?: Mode | string;
|
|
4698
4819
|
/**
|
|
@@ -4796,7 +4917,7 @@ export interface DescribeThesaurusResponse {
|
|
|
4796
4917
|
* more information.
|
|
4797
4918
|
* </p>
|
|
4798
4919
|
* <p>If the status is <code>ACTIVE_BUT_UPDATE_FAILED</code>, it means
|
|
4799
|
-
*
|
|
4920
|
+
* that Amazon Kendra could not ingest the new thesaurus file. The old
|
|
4800
4921
|
* thesaurus file is still active.
|
|
4801
4922
|
* </p>
|
|
4802
4923
|
*/
|
|
@@ -5169,10 +5290,14 @@ export declare namespace GetSnapshotsResponse {
|
|
|
5169
5290
|
/**
|
|
5170
5291
|
* <p>The input to the request is not valid.</p>
|
|
5171
5292
|
*/
|
|
5172
|
-
export
|
|
5173
|
-
name: "InvalidRequestException";
|
|
5174
|
-
$fault: "client";
|
|
5293
|
+
export declare class InvalidRequestException extends __BaseException {
|
|
5294
|
+
readonly name: "InvalidRequestException";
|
|
5295
|
+
readonly $fault: "client";
|
|
5175
5296
|
Message?: string;
|
|
5297
|
+
/**
|
|
5298
|
+
* @internal
|
|
5299
|
+
*/
|
|
5300
|
+
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
5176
5301
|
}
|
|
5177
5302
|
export interface ListDataSourcesRequest {
|
|
5178
5303
|
/**
|
|
@@ -5198,8 +5323,8 @@ export declare namespace ListDataSourcesRequest {
|
|
|
5198
5323
|
const filterSensitiveLog: (obj: ListDataSourcesRequest) => any;
|
|
5199
5324
|
}
|
|
5200
5325
|
/**
|
|
5201
|
-
* <p>Summary information for
|
|
5202
|
-
* to the <code>DescribeDataSource</code>
|
|
5326
|
+
* <p>Summary information for an Amazon Kendra data source. Returned in a call
|
|
5327
|
+
* to the <code>DescribeDataSource</code> API.</p>
|
|
5203
5328
|
*/
|
|
5204
5329
|
export interface DataSourceSummary {
|
|
5205
5330
|
/**
|
|
@@ -5346,7 +5471,7 @@ export declare namespace DataSourceSyncJobMetrics {
|
|
|
5346
5471
|
const filterSensitiveLog: (obj: DataSourceSyncJobMetrics) => any;
|
|
5347
5472
|
}
|
|
5348
5473
|
/**
|
|
5349
|
-
* <p>Provides information about a synchronization job.</p>
|
|
5474
|
+
* <p>Provides information about a data source synchronization job.</p>
|
|
5350
5475
|
*/
|
|
5351
5476
|
export interface DataSourceSyncJob {
|
|
5352
5477
|
/**
|
|
@@ -5354,11 +5479,11 @@ export interface DataSourceSyncJob {
|
|
|
5354
5479
|
*/
|
|
5355
5480
|
ExecutionId?: string;
|
|
5356
5481
|
/**
|
|
5357
|
-
* <p>The UNIX datetime that the synchronization job
|
|
5482
|
+
* <p>The UNIX datetime that the synchronization job started.</p>
|
|
5358
5483
|
*/
|
|
5359
5484
|
StartTime?: Date;
|
|
5360
5485
|
/**
|
|
5361
|
-
* <p>The UNIX datetime that the synchronization job
|
|
5486
|
+
* <p>The UNIX datetime that the synchronization job
|
|
5362
5487
|
* completed.</p>
|
|
5363
5488
|
*/
|
|
5364
5489
|
EndTime?: Date;
|
|
@@ -5379,8 +5504,8 @@ export interface DataSourceSyncJob {
|
|
|
5379
5504
|
ErrorMessage?: string;
|
|
5380
5505
|
/**
|
|
5381
5506
|
* <p>If the <code>Status</code> field is set to <code>FAILED</code>,
|
|
5382
|
-
* the <code>ErrorCode</code> field
|
|
5383
|
-
*
|
|
5507
|
+
* the <code>ErrorCode</code> field indicates the reason the
|
|
5508
|
+
* synchronization failed.</p>
|
|
5384
5509
|
*/
|
|
5385
5510
|
ErrorCode?: ErrorCode | string;
|
|
5386
5511
|
/**
|
|
@@ -5874,7 +5999,7 @@ export interface IndexConfigurationSummary {
|
|
|
5874
5999
|
Name?: string;
|
|
5875
6000
|
/**
|
|
5876
6001
|
* <p>A unique identifier for the index. Use this to identify the index
|
|
5877
|
-
* when you are using
|
|
6002
|
+
* when you are using APIs such as <code>Query</code>,
|
|
5878
6003
|
* <code>DescribeIndex</code>, <code>UpdateIndex</code>, and
|
|
5879
6004
|
* <code>DeleteIndex</code>.</p>
|
|
5880
6005
|
*/
|
|
@@ -5890,7 +6015,7 @@ export interface IndexConfigurationSummary {
|
|
|
5890
6015
|
CreatedAt: Date | undefined;
|
|
5891
6016
|
/**
|
|
5892
6017
|
* <p>The Unix timestamp when the index was last updated by the
|
|
5893
|
-
* <code>UpdateIndex</code>
|
|
6018
|
+
* <code>UpdateIndex</code> API.</p>
|
|
5894
6019
|
*/
|
|
5895
6020
|
UpdatedAt: Date | undefined;
|
|
5896
6021
|
/**
|
|
@@ -6042,10 +6167,14 @@ export declare namespace ListTagsForResourceResponse {
|
|
|
6042
6167
|
/**
|
|
6043
6168
|
* <p></p>
|
|
6044
6169
|
*/
|
|
6045
|
-
export
|
|
6046
|
-
name: "ResourceUnavailableException";
|
|
6047
|
-
$fault: "client";
|
|
6170
|
+
export declare class ResourceUnavailableException extends __BaseException {
|
|
6171
|
+
readonly name: "ResourceUnavailableException";
|
|
6172
|
+
readonly $fault: "client";
|
|
6048
6173
|
Message?: string;
|
|
6174
|
+
/**
|
|
6175
|
+
* @internal
|
|
6176
|
+
*/
|
|
6177
|
+
constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
|
|
6049
6178
|
}
|
|
6050
6179
|
export interface ListThesauriRequest {
|
|
6051
6180
|
/**
|
|
@@ -6304,7 +6433,7 @@ export declare enum SortOrder {
|
|
|
6304
6433
|
* <p>Specifies the document attribute to use to sort the response to a
|
|
6305
6434
|
* Amazon Kendra query. You can specify a single attribute for sorting. The
|
|
6306
6435
|
* attribute must have the <code>Sortable</code> flag set to
|
|
6307
|
-
*
|
|
6436
|
+
* <code>true</code>, otherwise Amazon Kendra returns an exception.</p>
|
|
6308
6437
|
* <p>You can sort attributes of the following types.</p>
|
|
6309
6438
|
* <ul>
|
|
6310
6439
|
* <li>
|
|
@@ -6391,8 +6520,7 @@ export declare namespace DataSourceGroup {
|
|
|
6391
6520
|
}
|
|
6392
6521
|
/**
|
|
6393
6522
|
* <p>Provides information about the user context for
|
|
6394
|
-
* an
|
|
6395
|
-
* Amazon Kendra index.</p>
|
|
6523
|
+
* an Amazon Kendra index.</p>
|
|
6396
6524
|
* <p>This is used for filtering search results for different users based on their access
|
|
6397
6525
|
* to documents.</p>
|
|
6398
6526
|
* <p>You provide one of the following:</p>
|
|
@@ -6640,10 +6768,14 @@ export declare namespace QueryResult {
|
|
|
6640
6768
|
/**
|
|
6641
6769
|
* <p></p>
|
|
6642
6770
|
*/
|
|
6643
|
-
export
|
|
6644
|
-
name: "ResourceInUseException";
|
|
6645
|
-
$fault: "client";
|
|
6771
|
+
export declare class ResourceInUseException extends __BaseException {
|
|
6772
|
+
readonly name: "ResourceInUseException";
|
|
6773
|
+
readonly $fault: "client";
|
|
6646
6774
|
Message?: string;
|
|
6775
|
+
/**
|
|
6776
|
+
* @internal
|
|
6777
|
+
*/
|
|
6778
|
+
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
6647
6779
|
}
|
|
6648
6780
|
export interface StartDataSourceSyncJobRequest {
|
|
6649
6781
|
/**
|
|
@@ -6693,7 +6825,7 @@ export declare namespace StopDataSourceSyncJobRequest {
|
|
|
6693
6825
|
/**
|
|
6694
6826
|
* <p>Gathers information about when a particular result was clicked by
|
|
6695
6827
|
* a user. Your application uses the <code>SubmitFeedback</code>
|
|
6696
|
-
*
|
|
6828
|
+
* API to provide click information.</p>
|
|
6697
6829
|
*/
|
|
6698
6830
|
export interface ClickFeedback {
|
|
6699
6831
|
/**
|
|
@@ -6719,7 +6851,7 @@ export declare enum RelevanceType {
|
|
|
6719
6851
|
}
|
|
6720
6852
|
/**
|
|
6721
6853
|
* <p>Provides feedback on how relevant a document is to a search. Your
|
|
6722
|
-
* application uses the <code>SubmitFeedback</code>
|
|
6854
|
+
* application uses the <code>SubmitFeedback</code> API to
|
|
6723
6855
|
* provide relevance information.</p>
|
|
6724
6856
|
*/
|
|
6725
6857
|
export interface RelevanceFeedback {
|
|
@@ -6748,7 +6880,7 @@ export interface SubmitFeedbackRequest {
|
|
|
6748
6880
|
/**
|
|
6749
6881
|
* <p>The identifier of the specific query for which you are submitting
|
|
6750
6882
|
* feedback. The query ID is returned in the response to the
|
|
6751
|
-
* <code>Query</code>
|
|
6883
|
+
* <code>Query</code> API.</p>
|
|
6752
6884
|
*/
|
|
6753
6885
|
QueryId: string | undefined;
|
|
6754
6886
|
/**
|
|
@@ -6892,8 +7024,8 @@ export interface UpdateExperienceRequest {
|
|
|
6892
7024
|
IndexId: string | undefined;
|
|
6893
7025
|
/**
|
|
6894
7026
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
6895
|
-
*
|
|
6896
|
-
*
|
|
7027
|
+
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
7028
|
+
* API, and Amazon Web Services SSO that stores your user and group information.
|
|
6897
7029
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
6898
7030
|
*/
|
|
6899
7031
|
RoleArn?: string;
|
|
@@ -7196,7 +7328,7 @@ export interface QueryRequest {
|
|
|
7196
7328
|
/**
|
|
7197
7329
|
* <p>The unique identifier of the index to search. The identifier is
|
|
7198
7330
|
* returned in the response from the <code>CreateIndex</code>
|
|
7199
|
-
*
|
|
7331
|
+
* API.</p>
|
|
7200
7332
|
*/
|
|
7201
7333
|
IndexId: string | undefined;
|
|
7202
7334
|
/**
|
|
@@ -7243,7 +7375,7 @@ export interface QueryRequest {
|
|
|
7243
7375
|
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
|
|
7244
7376
|
/**
|
|
7245
7377
|
* <p>Query results are returned in pages the size of the
|
|
7246
|
-
*
|
|
7378
|
+
* <code>PageSize</code> parameter. By default, Amazon Kendra returns
|
|
7247
7379
|
* the first page of results. Use this parameter to get result pages after
|
|
7248
7380
|
* the first one.</p>
|
|
7249
7381
|
*/
|