@aws-sdk/client-kendra 3.127.0 → 3.131.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 +32 -0
- package/dist-cjs/Kendra.js +75 -0
- package/dist-cjs/commands/CreateAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/DeleteAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/DescribeAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/ListAccessControlConfigurationsCommand.js +36 -0
- package/dist-cjs/commands/QueryCommand.js +2 -1
- package/dist-cjs/commands/UpdateAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +72 -12
- package/dist-cjs/models/models_1.js +9 -0
- package/dist-cjs/pagination/ListAccessControlConfigurationsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +450 -3
- package/dist-es/Kendra.js +75 -0
- package/dist-es/commands/CreateAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/DeleteAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/DescribeAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/ListAccessControlConfigurationsCommand.js +39 -0
- package/dist-es/commands/QueryCommand.js +2 -1
- package/dist-es/commands/UpdateAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +44 -4
- package/dist-es/models/models_1.js +5 -0
- package/dist-es/pagination/ListAccessControlConfigurationsPaginator.js +75 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +523 -1
- package/dist-types/Kendra.d.ts +99 -11
- package/dist-types/KendraClient.d.ts +7 -2
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +59 -0
- package/dist-types/commands/CreateFaqCommand.d.ts +1 -1
- package/dist-types/commands/CreateIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +38 -0
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +38 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +2 -1
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +38 -0
- package/dist-types/commands/ListThesauriCommand.d.ts +1 -1
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +3 -3
- package/dist-types/commands/QueryCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +54 -0
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +411 -271
- package/dist-types/models/models_1.d.ts +95 -0
- package/dist-types/pagination/ListAccessControlConfigurationsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +15 -0
- package/dist-types/ts3.4/Kendra.d.ts +25 -0
- package/dist-types/ts3.4/KendraClient.d.ts +7 -2
- package/dist-types/ts3.4/commands/CreateAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListAccessControlConfigurationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/QueryCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +125 -32
- package/dist-types/ts3.4/models/models_1.d.ts +33 -0
- package/dist-types/ts3.4/pagination/ListAccessControlConfigurationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +15 -0
- package/package.json +7 -7
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { KendraServiceException as __BaseException } from "./KendraServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* <p>Summary information on an access control configuration that you created for
|
|
5
|
+
* your documents in an index.</p>
|
|
6
|
+
*/
|
|
7
|
+
export interface AccessControlConfigurationSummary {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The identifier of the access control configuration.</p>
|
|
10
|
+
*/
|
|
11
|
+
Id: string | undefined;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace AccessControlConfigurationSummary {
|
|
14
|
+
/**
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
const filterSensitiveLog: (obj: AccessControlConfigurationSummary) => any;
|
|
18
|
+
}
|
|
3
19
|
/**
|
|
4
20
|
* <p>Access Control List files for the documents in a data source. For
|
|
5
21
|
* the format of the file, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html">Access control for S3 data
|
|
@@ -225,6 +241,11 @@ export declare namespace DataSourceVpcConfiguration {
|
|
|
225
241
|
/**
|
|
226
242
|
* <p>Provides the configuration information to connect to Alfresco as your
|
|
227
243
|
* data source.</p>
|
|
244
|
+
* <note>
|
|
245
|
+
* <p>Alfresco data source connector is currently in preview mode. Basic
|
|
246
|
+
* authentication is currently supported. If you would like to use Alfresco
|
|
247
|
+
* connector in production, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
248
|
+
* </note>
|
|
228
249
|
*/
|
|
229
250
|
export interface AlfrescoConfiguration {
|
|
230
251
|
/**
|
|
@@ -261,7 +282,7 @@ export interface AlfrescoConfiguration {
|
|
|
261
282
|
CrawlSystemFolders?: boolean;
|
|
262
283
|
/**
|
|
263
284
|
* <p>
|
|
264
|
-
* <code>TRUE</code> to index comments of
|
|
285
|
+
* <code>TRUE</code> to index comments of blogs and other content.</p>
|
|
265
286
|
*/
|
|
266
287
|
CrawlComments?: boolean;
|
|
267
288
|
/**
|
|
@@ -1124,8 +1145,7 @@ export declare enum PrincipalType {
|
|
|
1124
1145
|
USER = "USER"
|
|
1125
1146
|
}
|
|
1126
1147
|
/**
|
|
1127
|
-
* <p>Provides user and group information for
|
|
1128
|
-
* filtering.</p>
|
|
1148
|
+
* <p>Provides user and group information for <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">user context filtering</a>.</p>
|
|
1129
1149
|
*/
|
|
1130
1150
|
export interface Principal {
|
|
1131
1151
|
/**
|
|
@@ -1137,7 +1157,7 @@ export interface Principal {
|
|
|
1137
1157
|
*/
|
|
1138
1158
|
Type: PrincipalType | string | undefined;
|
|
1139
1159
|
/**
|
|
1140
|
-
* <p>Whether to allow or deny access to the principal.</p>
|
|
1160
|
+
* <p>Whether to allow or deny document access to the principal.</p>
|
|
1141
1161
|
*/
|
|
1142
1162
|
Access: ReadAccessType | string | undefined;
|
|
1143
1163
|
/**
|
|
@@ -1223,8 +1243,10 @@ export interface Document {
|
|
|
1223
1243
|
*/
|
|
1224
1244
|
Attributes?: DocumentAttribute[];
|
|
1225
1245
|
/**
|
|
1226
|
-
* <p>Information on
|
|
1227
|
-
* user context filtering
|
|
1246
|
+
* <p>Information on principals (users and/or groups) and which documents
|
|
1247
|
+
* they should have access to. This is useful for user context filtering,
|
|
1248
|
+
* where search results are filtered based on the user or their group
|
|
1249
|
+
* access to documents.</p>
|
|
1228
1250
|
*/
|
|
1229
1251
|
AccessControlList?: Principal[];
|
|
1230
1252
|
/**
|
|
@@ -1237,6 +1259,11 @@ export interface Document {
|
|
|
1237
1259
|
* field.</p>
|
|
1238
1260
|
*/
|
|
1239
1261
|
ContentType?: ContentType | string;
|
|
1262
|
+
/**
|
|
1263
|
+
* <p>The identifier of the access control configuration that you want
|
|
1264
|
+
* to apply to the document.</p>
|
|
1265
|
+
*/
|
|
1266
|
+
AccessControlConfigurationId?: string;
|
|
1240
1267
|
}
|
|
1241
1268
|
export declare namespace Document {
|
|
1242
1269
|
/**
|
|
@@ -1362,6 +1389,57 @@ export declare namespace ClearQuerySuggestionsRequest {
|
|
|
1362
1389
|
*/
|
|
1363
1390
|
const filterSensitiveLog: (obj: ClearQuerySuggestionsRequest) => any;
|
|
1364
1391
|
}
|
|
1392
|
+
export interface CreateAccessControlConfigurationRequest {
|
|
1393
|
+
/**
|
|
1394
|
+
* <p>The identifier of the index to create an access control configuration for
|
|
1395
|
+
* your documents.</p>
|
|
1396
|
+
*/
|
|
1397
|
+
IndexId: string | undefined;
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>A name for the access control configuration.</p>
|
|
1400
|
+
*/
|
|
1401
|
+
Name: string | undefined;
|
|
1402
|
+
/**
|
|
1403
|
+
* <p>A description for the access control configuration.</p>
|
|
1404
|
+
*/
|
|
1405
|
+
Description?: string;
|
|
1406
|
+
/**
|
|
1407
|
+
* <p>Information on principals (users and/or groups) and which documents they
|
|
1408
|
+
* should have access to. This is useful for user context filtering, where
|
|
1409
|
+
* search results are filtered based on the user or their group access to
|
|
1410
|
+
* documents.</p>
|
|
1411
|
+
*/
|
|
1412
|
+
AccessControlList?: Principal[];
|
|
1413
|
+
/**
|
|
1414
|
+
* <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that
|
|
1415
|
+
* define the hierarchy for which documents users should have access to.</p>
|
|
1416
|
+
*/
|
|
1417
|
+
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>A token that you provide to identify the request to create an access control
|
|
1420
|
+
* configuration. Multiple calls to the <code>CreateAccessControlConfiguration</code>
|
|
1421
|
+
* API with the same client token will create only one access control configuration.</p>
|
|
1422
|
+
*/
|
|
1423
|
+
ClientToken?: string;
|
|
1424
|
+
}
|
|
1425
|
+
export declare namespace CreateAccessControlConfigurationRequest {
|
|
1426
|
+
/**
|
|
1427
|
+
* @internal
|
|
1428
|
+
*/
|
|
1429
|
+
const filterSensitiveLog: (obj: CreateAccessControlConfigurationRequest) => any;
|
|
1430
|
+
}
|
|
1431
|
+
export interface CreateAccessControlConfigurationResponse {
|
|
1432
|
+
/**
|
|
1433
|
+
* <p>The identifier of the access control configuration for your documents in an index.</p>
|
|
1434
|
+
*/
|
|
1435
|
+
Id: string | undefined;
|
|
1436
|
+
}
|
|
1437
|
+
export declare namespace CreateAccessControlConfigurationResponse {
|
|
1438
|
+
/**
|
|
1439
|
+
* @internal
|
|
1440
|
+
*/
|
|
1441
|
+
const filterSensitiveLog: (obj: CreateAccessControlConfigurationResponse) => any;
|
|
1442
|
+
}
|
|
1365
1443
|
/**
|
|
1366
1444
|
* <p>Provides the configuration information to connect to Box as
|
|
1367
1445
|
* your data source.</p>
|
|
@@ -1808,11 +1886,11 @@ export interface ConfluenceConfiguration {
|
|
|
1808
1886
|
* Confluence instance. If you use Confluence cloud, you use a
|
|
1809
1887
|
* generated API token as the password. For more information, see
|
|
1810
1888
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html">Using a
|
|
1811
|
-
*
|
|
1889
|
+
* Confluence data source</a>.</p>
|
|
1812
1890
|
*/
|
|
1813
1891
|
SecretArn: string | undefined;
|
|
1814
1892
|
/**
|
|
1815
|
-
* <p>The version or the type of
|
|
1893
|
+
* <p>The version or the type of Confluence installation to connect to.</p>
|
|
1816
1894
|
*/
|
|
1817
1895
|
Version: ConfluenceVersion | string | undefined;
|
|
1818
1896
|
/**
|
|
@@ -2695,7 +2773,7 @@ export interface QuipConfiguration {
|
|
|
2695
2773
|
*/
|
|
2696
2774
|
CrawlAttachments?: boolean;
|
|
2697
2775
|
/**
|
|
2698
|
-
* <p>The
|
|
2776
|
+
* <p>The identifiers of the Quip folders you want to index.</p>
|
|
2699
2777
|
*/
|
|
2700
2778
|
FolderIds?: string[];
|
|
2701
2779
|
/**
|
|
@@ -3185,8 +3263,8 @@ export declare enum ServiceNowAuthenticationType {
|
|
|
3185
3263
|
*/
|
|
3186
3264
|
export interface ServiceNowKnowledgeArticleConfiguration {
|
|
3187
3265
|
/**
|
|
3188
|
-
* <p>
|
|
3189
|
-
* articles.</p>
|
|
3266
|
+
* <p>
|
|
3267
|
+
* <code>TRUE</code> to index attachments to knowledge articles.</p>
|
|
3190
3268
|
*/
|
|
3191
3269
|
CrawlAttachments?: boolean;
|
|
3192
3270
|
/**
|
|
@@ -3249,8 +3327,8 @@ export declare namespace ServiceNowKnowledgeArticleConfiguration {
|
|
|
3249
3327
|
*/
|
|
3250
3328
|
export interface ServiceNowServiceCatalogConfiguration {
|
|
3251
3329
|
/**
|
|
3252
|
-
* <p>
|
|
3253
|
-
* catalog items
|
|
3330
|
+
* <p>
|
|
3331
|
+
* <code>TRUE</code> to index attachments to service catalog items.</p>
|
|
3254
3332
|
*/
|
|
3255
3333
|
CrawlAttachments?: boolean;
|
|
3256
3334
|
/**
|
|
@@ -3341,11 +3419,9 @@ export interface ServiceNowConfiguration {
|
|
|
3341
3419
|
* <p>The type of authentication used to connect to the
|
|
3342
3420
|
* ServiceNow instance. If you choose <code>HTTP_BASIC</code>, Amazon Kendra is
|
|
3343
3421
|
* authenticated using the user name and password provided in the
|
|
3344
|
-
* Secrets Manager secret in the <code>SecretArn</code> field.
|
|
3345
|
-
* choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the
|
|
3346
|
-
*
|
|
3347
|
-
* user name and password are used to determine which information Amazon Kendra
|
|
3348
|
-
* has access to.</p>
|
|
3422
|
+
* Secrets Manager secret in the <code>SecretArn</code> field. If you
|
|
3423
|
+
* choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the
|
|
3424
|
+
* credentials of client ID, client secret, user name and password.</p>
|
|
3349
3425
|
* <p>When you use <code>OAUTH2</code> authentication, you must generate
|
|
3350
3426
|
* a token and a client secret using the ServiceNow console. For more
|
|
3351
3427
|
* information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html">Using a
|
|
@@ -3806,11 +3882,12 @@ export interface WebCrawlerConfiguration {
|
|
|
3806
3882
|
/**
|
|
3807
3883
|
* <p>Configuration information required to connect to websites using
|
|
3808
3884
|
* authentication.</p>
|
|
3809
|
-
* <p>You can connect to websites using basic authentication of user name and password
|
|
3885
|
+
* <p>You can connect to websites using basic authentication of user name and password.
|
|
3886
|
+
* You use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a> to store
|
|
3887
|
+
* your authentication credentials.</p>
|
|
3810
3888
|
* <p>You must provide the website host name and port number. For example, the host name
|
|
3811
3889
|
* of https://a.example.com/page1.html is "a.example.com" and the port is 443, the
|
|
3812
|
-
* standard port for HTTPS
|
|
3813
|
-
* your authentication credentials.</p>
|
|
3890
|
+
* standard port for HTTPS.</p>
|
|
3814
3891
|
*/
|
|
3815
3892
|
AuthenticationConfiguration?: AuthenticationConfiguration;
|
|
3816
3893
|
}
|
|
@@ -4030,22 +4107,20 @@ export declare enum DataSourceType {
|
|
|
4030
4107
|
}
|
|
4031
4108
|
export interface CreateDataSourceRequest {
|
|
4032
4109
|
/**
|
|
4033
|
-
* <p>A unique name for the data source. A data source name can't be changed
|
|
4034
|
-
* without deleting and recreating the data source.</p>
|
|
4110
|
+
* <p>A unique name for the data source connector. A data source name can't be changed
|
|
4111
|
+
* without deleting and recreating the data source connector.</p>
|
|
4035
4112
|
*/
|
|
4036
4113
|
Name: string | undefined;
|
|
4037
4114
|
/**
|
|
4038
|
-
* <p>The identifier of the index
|
|
4039
|
-
* source.</p>
|
|
4115
|
+
* <p>The identifier of the index you want to use with the data source connector.</p>
|
|
4040
4116
|
*/
|
|
4041
4117
|
IndexId: string | undefined;
|
|
4042
4118
|
/**
|
|
4043
|
-
* <p>The type of
|
|
4119
|
+
* <p>The type of data source repository. For example, <code>SHAREPOINT</code>.</p>
|
|
4044
4120
|
*/
|
|
4045
4121
|
Type: DataSourceType | string | undefined;
|
|
4046
4122
|
/**
|
|
4047
|
-
* <p>Configuration information
|
|
4048
|
-
* repository.</p>
|
|
4123
|
+
* <p>Configuration information to connect to your data source repository.</p>
|
|
4049
4124
|
* <p>You can't specify the <code>Configuration</code> parameter when the
|
|
4050
4125
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
4051
4126
|
* you receive a <code>ValidationException</code> exception.</p>
|
|
@@ -4054,13 +4129,13 @@ export interface CreateDataSourceRequest {
|
|
|
4054
4129
|
*/
|
|
4055
4130
|
Configuration?: DataSourceConfiguration;
|
|
4056
4131
|
/**
|
|
4057
|
-
* <p>A description for the data source.</p>
|
|
4132
|
+
* <p>A description for the data source connector.</p>
|
|
4058
4133
|
*/
|
|
4059
4134
|
Description?: string;
|
|
4060
4135
|
/**
|
|
4061
4136
|
* <p>Sets the frequency for Amazon Kendra to check the documents in your
|
|
4062
|
-
* repository and update the index. If you don't set a schedule
|
|
4063
|
-
* will not periodically update the index. You can call the
|
|
4137
|
+
* data source repository and update the index. If you don't set a schedule
|
|
4138
|
+
* Amazon Kendra will not periodically update the index. You can call the
|
|
4064
4139
|
* <code>StartDataSourceSyncJob</code> API to update the
|
|
4065
4140
|
* index.</p>
|
|
4066
4141
|
* <p>You can't specify the <code>Schedule</code> parameter when the
|
|
@@ -4070,7 +4145,7 @@ export interface CreateDataSourceRequest {
|
|
|
4070
4145
|
Schedule?: string;
|
|
4071
4146
|
/**
|
|
4072
4147
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access the
|
|
4073
|
-
* data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM Roles for
|
|
4148
|
+
* data source connector. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM Roles for
|
|
4074
4149
|
* Amazon Kendra</a>.</p>
|
|
4075
4150
|
* <p>You can't specify the <code>RoleArn</code> parameter when the
|
|
4076
4151
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
@@ -4080,20 +4155,20 @@ export interface CreateDataSourceRequest {
|
|
|
4080
4155
|
*/
|
|
4081
4156
|
RoleArn?: string;
|
|
4082
4157
|
/**
|
|
4083
|
-
* <p>A list of key-value pairs that identify the data source. You can use
|
|
4158
|
+
* <p>A list of key-value pairs that identify the data source connector. You can use
|
|
4084
4159
|
* the tags to identify and organize your resources and to control access to
|
|
4085
4160
|
* resources.</p>
|
|
4086
4161
|
*/
|
|
4087
4162
|
Tags?: Tag[];
|
|
4088
4163
|
/**
|
|
4089
4164
|
* <p>A token that you provide to identify the request to create a data
|
|
4090
|
-
* source. Multiple calls to the <code>CreateDataSource</code> API
|
|
4091
|
-
* the same client token will create only one data source.</p>
|
|
4165
|
+
* source connector. Multiple calls to the <code>CreateDataSource</code> API
|
|
4166
|
+
* with the same client token will create only one data source connector.</p>
|
|
4092
4167
|
*/
|
|
4093
4168
|
ClientToken?: string;
|
|
4094
4169
|
/**
|
|
4095
4170
|
* <p>The code for a language. This allows you to support a language for all
|
|
4096
|
-
* documents when creating the data source. English is supported
|
|
4171
|
+
* documents when creating the data source connector. English is supported
|
|
4097
4172
|
* by default. For more information on supported languages, including their codes,
|
|
4098
4173
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding
|
|
4099
4174
|
* documents in languages other than English</a>.</p>
|
|
@@ -4101,7 +4176,7 @@ export interface CreateDataSourceRequest {
|
|
|
4101
4176
|
LanguageCode?: string;
|
|
4102
4177
|
/**
|
|
4103
4178
|
* <p>Configuration information for altering document metadata and content during the
|
|
4104
|
-
* document ingestion process
|
|
4179
|
+
* document ingestion process.</p>
|
|
4105
4180
|
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
4106
4181
|
* other content alterations when you ingest documents into Amazon Kendra, see
|
|
4107
4182
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
@@ -4117,7 +4192,7 @@ export declare namespace CreateDataSourceRequest {
|
|
|
4117
4192
|
}
|
|
4118
4193
|
export interface CreateDataSourceResponse {
|
|
4119
4194
|
/**
|
|
4120
|
-
* <p>
|
|
4195
|
+
* <p>The identifier of the data source connector.</p>
|
|
4121
4196
|
*/
|
|
4122
4197
|
Id: string | undefined;
|
|
4123
4198
|
}
|
|
@@ -4257,19 +4332,19 @@ export declare enum FaqFileFormat {
|
|
|
4257
4332
|
}
|
|
4258
4333
|
export interface CreateFaqRequest {
|
|
4259
4334
|
/**
|
|
4260
|
-
* <p>The identifier of the index
|
|
4335
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
4261
4336
|
*/
|
|
4262
4337
|
IndexId: string | undefined;
|
|
4263
4338
|
/**
|
|
4264
|
-
* <p>
|
|
4339
|
+
* <p>A name for the FAQ.</p>
|
|
4265
4340
|
*/
|
|
4266
4341
|
Name: string | undefined;
|
|
4267
4342
|
/**
|
|
4268
|
-
* <p>A description
|
|
4343
|
+
* <p>A description for the FAQ.</p>
|
|
4269
4344
|
*/
|
|
4270
4345
|
Description?: string;
|
|
4271
4346
|
/**
|
|
4272
|
-
* <p>The
|
|
4347
|
+
* <p>The path to the FAQ file in S3.</p>
|
|
4273
4348
|
*/
|
|
4274
4349
|
S3Path: S3Path | undefined;
|
|
4275
4350
|
/**
|
|
@@ -4283,7 +4358,7 @@ export interface CreateFaqRequest {
|
|
|
4283
4358
|
*/
|
|
4284
4359
|
Tags?: Tag[];
|
|
4285
4360
|
/**
|
|
4286
|
-
* <p>The format of the input file. You can choose between a basic CSV format, a CSV format
|
|
4361
|
+
* <p>The format of the FAQ input file. You can choose between a basic CSV format, a CSV format
|
|
4287
4362
|
* that includes customs attributes in a header, and a JSON format that includes custom
|
|
4288
4363
|
* attributes.</p>
|
|
4289
4364
|
* <p>The format must match the format of the file stored in the S3 bucket identified in the
|
|
@@ -4358,12 +4433,11 @@ export declare enum UserGroupResolutionMode {
|
|
|
4358
4433
|
/**
|
|
4359
4434
|
* <p>Provides the configuration information to fetch access levels
|
|
4360
4435
|
* of groups and users from an Amazon Web Services Single Sign On identity
|
|
4361
|
-
* source. This is useful for
|
|
4362
|
-
*
|
|
4363
|
-
*
|
|
4364
|
-
* groups
|
|
4365
|
-
*
|
|
4366
|
-
* API</a>.</p>
|
|
4436
|
+
* source. This is useful for user context filtering, where search
|
|
4437
|
+
* results are filtered based on the user or their group access to
|
|
4438
|
+
* documents. You can also use the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping</a>
|
|
4439
|
+
* API to map users to their groups so that you only need to provide
|
|
4440
|
+
* the user ID when you issue the query.</p>
|
|
4367
4441
|
* <p>To set up an Amazon Web Services SSO identity source in the console to use with
|
|
4368
4442
|
* Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started
|
|
4369
4443
|
* with an Amazon Web Services SSO identity source</a>. You must also grant the required
|
|
@@ -4473,7 +4547,7 @@ export declare namespace UserTokenConfiguration {
|
|
|
4473
4547
|
}
|
|
4474
4548
|
export interface CreateIndexRequest {
|
|
4475
4549
|
/**
|
|
4476
|
-
* <p>
|
|
4550
|
+
* <p>A name for the index.</p>
|
|
4477
4551
|
*/
|
|
4478
4552
|
Name: string | undefined;
|
|
4479
4553
|
/**
|
|
@@ -4637,16 +4711,15 @@ export declare namespace CreateQuerySuggestionsBlockListResponse {
|
|
|
4637
4711
|
}
|
|
4638
4712
|
export interface CreateThesaurusRequest {
|
|
4639
4713
|
/**
|
|
4640
|
-
* <p>The
|
|
4641
|
-
* </p>
|
|
4714
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
4642
4715
|
*/
|
|
4643
4716
|
IndexId: string | undefined;
|
|
4644
4717
|
/**
|
|
4645
|
-
* <p>
|
|
4718
|
+
* <p>A name for the thesaurus.</p>
|
|
4646
4719
|
*/
|
|
4647
4720
|
Name: string | undefined;
|
|
4648
4721
|
/**
|
|
4649
|
-
* <p>
|
|
4722
|
+
* <p>A description for the thesaurus.</p>
|
|
4650
4723
|
*/
|
|
4651
4724
|
Description?: string;
|
|
4652
4725
|
/**
|
|
@@ -4663,8 +4736,7 @@ export interface CreateThesaurusRequest {
|
|
|
4663
4736
|
*/
|
|
4664
4737
|
Tags?: Tag[];
|
|
4665
4738
|
/**
|
|
4666
|
-
* <p>The thesaurus file
|
|
4667
|
-
* </p>
|
|
4739
|
+
* <p>The path to the thesaurus file in S3.</p>
|
|
4668
4740
|
*/
|
|
4669
4741
|
SourceS3Path: S3Path | undefined;
|
|
4670
4742
|
/**
|
|
@@ -4694,14 +4766,37 @@ export declare namespace CreateThesaurusResponse {
|
|
|
4694
4766
|
*/
|
|
4695
4767
|
const filterSensitiveLog: (obj: CreateThesaurusResponse) => any;
|
|
4696
4768
|
}
|
|
4769
|
+
export interface DeleteAccessControlConfigurationRequest {
|
|
4770
|
+
/**
|
|
4771
|
+
* <p>The identifier of the index for an access control configuration.</p>
|
|
4772
|
+
*/
|
|
4773
|
+
IndexId: string | undefined;
|
|
4774
|
+
/**
|
|
4775
|
+
* <p>The identifier of the access control configuration you want to delete.</p>
|
|
4776
|
+
*/
|
|
4777
|
+
Id: string | undefined;
|
|
4778
|
+
}
|
|
4779
|
+
export declare namespace DeleteAccessControlConfigurationRequest {
|
|
4780
|
+
/**
|
|
4781
|
+
* @internal
|
|
4782
|
+
*/
|
|
4783
|
+
const filterSensitiveLog: (obj: DeleteAccessControlConfigurationRequest) => any;
|
|
4784
|
+
}
|
|
4785
|
+
export interface DeleteAccessControlConfigurationResponse {
|
|
4786
|
+
}
|
|
4787
|
+
export declare namespace DeleteAccessControlConfigurationResponse {
|
|
4788
|
+
/**
|
|
4789
|
+
* @internal
|
|
4790
|
+
*/
|
|
4791
|
+
const filterSensitiveLog: (obj: DeleteAccessControlConfigurationResponse) => any;
|
|
4792
|
+
}
|
|
4697
4793
|
export interface DeleteDataSourceRequest {
|
|
4698
4794
|
/**
|
|
4699
|
-
* <p>The
|
|
4795
|
+
* <p>The identifier of the data source you want to delete.</p>
|
|
4700
4796
|
*/
|
|
4701
4797
|
Id: string | undefined;
|
|
4702
4798
|
/**
|
|
4703
|
-
* <p>The
|
|
4704
|
-
* source.</p>
|
|
4799
|
+
* <p>The identifier of the index used with the data source.</p>
|
|
4705
4800
|
*/
|
|
4706
4801
|
IndexId: string | undefined;
|
|
4707
4802
|
}
|
|
@@ -4717,7 +4812,7 @@ export interface DeleteExperienceRequest {
|
|
|
4717
4812
|
*/
|
|
4718
4813
|
Id: string | undefined;
|
|
4719
4814
|
/**
|
|
4720
|
-
* <p>The identifier of the index for your Amazon Kendra experience
|
|
4815
|
+
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
4721
4816
|
*/
|
|
4722
4817
|
IndexId: string | undefined;
|
|
4723
4818
|
}
|
|
@@ -4737,11 +4832,11 @@ export declare namespace DeleteExperienceResponse {
|
|
|
4737
4832
|
}
|
|
4738
4833
|
export interface DeleteFaqRequest {
|
|
4739
4834
|
/**
|
|
4740
|
-
* <p>The identifier of the FAQ to remove.</p>
|
|
4835
|
+
* <p>The identifier of the FAQ you want to remove.</p>
|
|
4741
4836
|
*/
|
|
4742
4837
|
Id: string | undefined;
|
|
4743
4838
|
/**
|
|
4744
|
-
* <p>The index
|
|
4839
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
4745
4840
|
*/
|
|
4746
4841
|
IndexId: string | undefined;
|
|
4747
4842
|
}
|
|
@@ -4753,7 +4848,7 @@ export declare namespace DeleteFaqRequest {
|
|
|
4753
4848
|
}
|
|
4754
4849
|
export interface DeleteIndexRequest {
|
|
4755
4850
|
/**
|
|
4756
|
-
* <p>The identifier of the index to delete.</p>
|
|
4851
|
+
* <p>The identifier of the index you want to delete.</p>
|
|
4757
4852
|
*/
|
|
4758
4853
|
Id: string | undefined;
|
|
4759
4854
|
}
|
|
@@ -4770,8 +4865,8 @@ export interface DeletePrincipalMappingRequest {
|
|
|
4770
4865
|
IndexId: string | undefined;
|
|
4771
4866
|
/**
|
|
4772
4867
|
* <p>The identifier of the data source you want to delete a group from.</p>
|
|
4773
|
-
* <p>
|
|
4774
|
-
*
|
|
4868
|
+
* <p>A group can be tied to multiple data sources. You can
|
|
4869
|
+
* delete a group from accessing documents in a certain data source. For example,
|
|
4775
4870
|
* the groups "Research", "Engineering", and "Sales and Marketing" are all tied to
|
|
4776
4871
|
* the company's documents stored in the data sources Confluence and Salesforce.
|
|
4777
4872
|
* You want to delete "Research" and "Engineering" groups from Salesforce, so that
|
|
@@ -4810,11 +4905,11 @@ export declare namespace DeletePrincipalMappingRequest {
|
|
|
4810
4905
|
}
|
|
4811
4906
|
export interface DeleteQuerySuggestionsBlockListRequest {
|
|
4812
4907
|
/**
|
|
4813
|
-
* <p>The identifier of the
|
|
4908
|
+
* <p>The identifier of the index for the block list.</p>
|
|
4814
4909
|
*/
|
|
4815
4910
|
IndexId: string | undefined;
|
|
4816
4911
|
/**
|
|
4817
|
-
* <p>The
|
|
4912
|
+
* <p>The identifier of the block list you want to delete.</p>
|
|
4818
4913
|
*/
|
|
4819
4914
|
Id: string | undefined;
|
|
4820
4915
|
}
|
|
@@ -4826,11 +4921,11 @@ export declare namespace DeleteQuerySuggestionsBlockListRequest {
|
|
|
4826
4921
|
}
|
|
4827
4922
|
export interface DeleteThesaurusRequest {
|
|
4828
4923
|
/**
|
|
4829
|
-
* <p>The identifier of the thesaurus to delete.</p>
|
|
4924
|
+
* <p>The identifier of the thesaurus you want to delete.</p>
|
|
4830
4925
|
*/
|
|
4831
4926
|
Id: string | undefined;
|
|
4832
4927
|
/**
|
|
4833
|
-
* <p>The identifier of the index
|
|
4928
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
4834
4929
|
*/
|
|
4835
4930
|
IndexId: string | undefined;
|
|
4836
4931
|
}
|
|
@@ -4840,13 +4935,61 @@ export declare namespace DeleteThesaurusRequest {
|
|
|
4840
4935
|
*/
|
|
4841
4936
|
const filterSensitiveLog: (obj: DeleteThesaurusRequest) => any;
|
|
4842
4937
|
}
|
|
4938
|
+
export interface DescribeAccessControlConfigurationRequest {
|
|
4939
|
+
/**
|
|
4940
|
+
* <p>The identifier of the index for an access control configuration.</p>
|
|
4941
|
+
*/
|
|
4942
|
+
IndexId: string | undefined;
|
|
4943
|
+
/**
|
|
4944
|
+
* <p>The identifier of the access control configuration you want to get information on.</p>
|
|
4945
|
+
*/
|
|
4946
|
+
Id: string | undefined;
|
|
4947
|
+
}
|
|
4948
|
+
export declare namespace DescribeAccessControlConfigurationRequest {
|
|
4949
|
+
/**
|
|
4950
|
+
* @internal
|
|
4951
|
+
*/
|
|
4952
|
+
const filterSensitiveLog: (obj: DescribeAccessControlConfigurationRequest) => any;
|
|
4953
|
+
}
|
|
4954
|
+
export interface DescribeAccessControlConfigurationResponse {
|
|
4955
|
+
/**
|
|
4956
|
+
* <p>The name for the access control configuration.</p>
|
|
4957
|
+
*/
|
|
4958
|
+
Name: string | undefined;
|
|
4959
|
+
/**
|
|
4960
|
+
* <p>The description for the access control configuration.</p>
|
|
4961
|
+
*/
|
|
4962
|
+
Description?: string;
|
|
4963
|
+
/**
|
|
4964
|
+
* <p>The error message containing details if there are issues processing the access
|
|
4965
|
+
* control configuration.</p>
|
|
4966
|
+
*/
|
|
4967
|
+
ErrorMessage?: string;
|
|
4968
|
+
/**
|
|
4969
|
+
* <p>Information on principals (users and/or groups) and which documents they
|
|
4970
|
+
* should have access to. This is useful for user context filtering, where search
|
|
4971
|
+
* results are filtered based on the user or their group access to documents.</p>
|
|
4972
|
+
*/
|
|
4973
|
+
AccessControlList?: Principal[];
|
|
4974
|
+
/**
|
|
4975
|
+
* <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that
|
|
4976
|
+
* define the hierarchy for which documents users should have access to.</p>
|
|
4977
|
+
*/
|
|
4978
|
+
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
4979
|
+
}
|
|
4980
|
+
export declare namespace DescribeAccessControlConfigurationResponse {
|
|
4981
|
+
/**
|
|
4982
|
+
* @internal
|
|
4983
|
+
*/
|
|
4984
|
+
const filterSensitiveLog: (obj: DescribeAccessControlConfigurationResponse) => any;
|
|
4985
|
+
}
|
|
4843
4986
|
export interface DescribeDataSourceRequest {
|
|
4844
4987
|
/**
|
|
4845
|
-
* <p>The
|
|
4988
|
+
* <p>The identifier of the data source.</p>
|
|
4846
4989
|
*/
|
|
4847
4990
|
Id: string | undefined;
|
|
4848
4991
|
/**
|
|
4849
|
-
* <p>The identifier of the index
|
|
4992
|
+
* <p>The identifier of the index used with the data source.</p>
|
|
4850
4993
|
*/
|
|
4851
4994
|
IndexId: string | undefined;
|
|
4852
4995
|
}
|
|
@@ -4881,8 +5024,9 @@ export interface DescribeDataSourceResponse {
|
|
|
4881
5024
|
*/
|
|
4882
5025
|
Type?: DataSourceType | string;
|
|
4883
5026
|
/**
|
|
4884
|
-
* <p>
|
|
4885
|
-
*
|
|
5027
|
+
* <p>Configuration details for the data source. This shows how the
|
|
5028
|
+
* data source is configured. The configuration options for a data
|
|
5029
|
+
* source depend on the data source provider.</p>
|
|
4886
5030
|
*/
|
|
4887
5031
|
Configuration?: DataSourceConfiguration;
|
|
4888
5032
|
/**
|
|
@@ -4894,7 +5038,7 @@ export interface DescribeDataSourceResponse {
|
|
|
4894
5038
|
*/
|
|
4895
5039
|
UpdatedAt?: Date;
|
|
4896
5040
|
/**
|
|
4897
|
-
* <p>The description
|
|
5041
|
+
* <p>The description for the data source.</p>
|
|
4898
5042
|
*/
|
|
4899
5043
|
Description?: string;
|
|
4900
5044
|
/**
|
|
@@ -4949,8 +5093,7 @@ export interface DescribeExperienceRequest {
|
|
|
4949
5093
|
*/
|
|
4950
5094
|
Id: string | undefined;
|
|
4951
5095
|
/**
|
|
4952
|
-
* <p>The identifier of the index for your Amazon Kendra experience
|
|
4953
|
-
* information on.</p>
|
|
5096
|
+
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
4954
5097
|
*/
|
|
4955
5098
|
IndexId: string | undefined;
|
|
4956
5099
|
}
|
|
@@ -5055,11 +5198,11 @@ export declare namespace DescribeExperienceResponse {
|
|
|
5055
5198
|
}
|
|
5056
5199
|
export interface DescribeFaqRequest {
|
|
5057
5200
|
/**
|
|
5058
|
-
* <p>The
|
|
5201
|
+
* <p>The identifier of the FAQ you want to get information on.</p>
|
|
5059
5202
|
*/
|
|
5060
5203
|
Id: string | undefined;
|
|
5061
5204
|
/**
|
|
5062
|
-
* <p>The identifier of the index
|
|
5205
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
5063
5206
|
*/
|
|
5064
5207
|
IndexId: string | undefined;
|
|
5065
5208
|
}
|
|
@@ -5082,7 +5225,7 @@ export interface DescribeFaqResponse {
|
|
|
5082
5225
|
*/
|
|
5083
5226
|
Id?: string;
|
|
5084
5227
|
/**
|
|
5085
|
-
* <p>The identifier of the index
|
|
5228
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
5086
5229
|
*/
|
|
5087
5230
|
IndexId?: string;
|
|
5088
5231
|
/**
|
|
@@ -5142,7 +5285,7 @@ export declare namespace DescribeFaqResponse {
|
|
|
5142
5285
|
}
|
|
5143
5286
|
export interface DescribeIndexRequest {
|
|
5144
5287
|
/**
|
|
5145
|
-
* <p>The identifier of the index to
|
|
5288
|
+
* <p>The identifier of the index you want to get information on.</p>
|
|
5146
5289
|
*/
|
|
5147
5290
|
Id: string | undefined;
|
|
5148
5291
|
}
|
|
@@ -5192,7 +5335,7 @@ export declare enum Order {
|
|
|
5192
5335
|
DESCENDING = "DESCENDING"
|
|
5193
5336
|
}
|
|
5194
5337
|
/**
|
|
5195
|
-
* <p>Provides information for
|
|
5338
|
+
* <p>Provides information for tuning the relevance of a field
|
|
5196
5339
|
* in a search. When a query includes terms that match the field, the
|
|
5197
5340
|
* results are given a boost in the response based on these tuning
|
|
5198
5341
|
* parameters.</p>
|
|
@@ -5303,7 +5446,8 @@ export declare enum DocumentAttributeValueType {
|
|
|
5303
5446
|
STRING_VALUE = "STRING_VALUE"
|
|
5304
5447
|
}
|
|
5305
5448
|
/**
|
|
5306
|
-
* <p>Specifies the properties
|
|
5449
|
+
* <p>Specifies the properties, such as relevance tuning
|
|
5450
|
+
* and searchability, of an index field.</p>
|
|
5307
5451
|
*/
|
|
5308
5452
|
export interface DocumentMetadataConfiguration {
|
|
5309
5453
|
/**
|
|
@@ -5315,7 +5459,7 @@ export interface DocumentMetadataConfiguration {
|
|
|
5315
5459
|
*/
|
|
5316
5460
|
Type: DocumentAttributeValueType | string | undefined;
|
|
5317
5461
|
/**
|
|
5318
|
-
* <p>Provides
|
|
5462
|
+
* <p>Provides tuning parameters to determine how the field
|
|
5319
5463
|
* affects the search results.</p>
|
|
5320
5464
|
*/
|
|
5321
5465
|
Relevance?: Relevance;
|
|
@@ -5442,8 +5586,9 @@ export interface DescribeIndexResponse {
|
|
|
5442
5586
|
*/
|
|
5443
5587
|
UpdatedAt?: Date;
|
|
5444
5588
|
/**
|
|
5445
|
-
* <p>Configuration
|
|
5446
|
-
* the
|
|
5589
|
+
* <p>Configuration information for document metadata or fields. Document metadata
|
|
5590
|
+
* are fields or attributes associated with your documents. For example, the company
|
|
5591
|
+
* department name associated with each document.</p>
|
|
5447
5592
|
*/
|
|
5448
5593
|
DocumentMetadataConfigurations?: DocumentMetadataConfiguration[];
|
|
5449
5594
|
/**
|
|
@@ -5476,7 +5621,7 @@ export interface DescribeIndexResponse {
|
|
|
5476
5621
|
*/
|
|
5477
5622
|
UserContextPolicy?: UserContextPolicy | string;
|
|
5478
5623
|
/**
|
|
5479
|
-
* <p>
|
|
5624
|
+
* <p>Whether you have enabled the configuration for fetching access
|
|
5480
5625
|
* levels of groups and users from an Amazon Web Services Single Sign On identity source.</p>
|
|
5481
5626
|
*/
|
|
5482
5627
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
@@ -5521,7 +5666,7 @@ export declare enum PrincipalMappingStatus {
|
|
|
5521
5666
|
SUCCEEDED = "SUCCEEDED"
|
|
5522
5667
|
}
|
|
5523
5668
|
/**
|
|
5524
|
-
* <p>
|
|
5669
|
+
* <p>Summary information on the processing of <code>PUT</code> and <code>DELETE</code> actions
|
|
5525
5670
|
* for mapping users to their groups.</p>
|
|
5526
5671
|
*/
|
|
5527
5672
|
export interface GroupOrderingIdSummary {
|
|
@@ -5619,7 +5764,7 @@ export interface DescribeQuerySuggestionsBlockListRequest {
|
|
|
5619
5764
|
*/
|
|
5620
5765
|
IndexId: string | undefined;
|
|
5621
5766
|
/**
|
|
5622
|
-
* <p>The
|
|
5767
|
+
* <p>The identifier of the block list you want to get information on.</p>
|
|
5623
5768
|
*/
|
|
5624
5769
|
Id: string | undefined;
|
|
5625
5770
|
}
|
|
@@ -5639,37 +5784,37 @@ export declare enum QuerySuggestionsBlockListStatus {
|
|
|
5639
5784
|
}
|
|
5640
5785
|
export interface DescribeQuerySuggestionsBlockListResponse {
|
|
5641
5786
|
/**
|
|
5642
|
-
* <p>
|
|
5787
|
+
* <p>The identifier of the index for the block list.</p>
|
|
5643
5788
|
*/
|
|
5644
5789
|
IndexId?: string;
|
|
5645
5790
|
/**
|
|
5646
|
-
* <p>
|
|
5791
|
+
* <p>The identifier of the block list.</p>
|
|
5647
5792
|
*/
|
|
5648
5793
|
Id?: string;
|
|
5649
5794
|
/**
|
|
5650
|
-
* <p>
|
|
5795
|
+
* <p>The name of the block list.</p>
|
|
5651
5796
|
*/
|
|
5652
5797
|
Name?: string;
|
|
5653
5798
|
/**
|
|
5654
|
-
* <p>
|
|
5799
|
+
* <p>The description for the block list.</p>
|
|
5655
5800
|
*/
|
|
5656
5801
|
Description?: string;
|
|
5657
5802
|
/**
|
|
5658
|
-
* <p>
|
|
5659
|
-
* <code>ACTIVE</code
|
|
5803
|
+
* <p>The current status of the block list. When the value is
|
|
5804
|
+
* <code>ACTIVE</code>, the block list is ready for use.</p>
|
|
5660
5805
|
*/
|
|
5661
5806
|
Status?: QuerySuggestionsBlockListStatus | string;
|
|
5662
5807
|
/**
|
|
5663
|
-
* <p>
|
|
5664
|
-
*
|
|
5808
|
+
* <p>The error message containing details if there are issues processing
|
|
5809
|
+
* the block list.</p>
|
|
5665
5810
|
*/
|
|
5666
5811
|
ErrorMessage?: string;
|
|
5667
5812
|
/**
|
|
5668
|
-
* <p>
|
|
5813
|
+
* <p>The date-time a block list for query suggestions was created.</p>
|
|
5669
5814
|
*/
|
|
5670
5815
|
CreatedAt?: Date;
|
|
5671
5816
|
/**
|
|
5672
|
-
* <p>
|
|
5817
|
+
* <p>The date-time a block list for query suggestions was last updated.</p>
|
|
5673
5818
|
*/
|
|
5674
5819
|
UpdatedAt?: Date;
|
|
5675
5820
|
/**
|
|
@@ -5681,16 +5826,16 @@ export interface DescribeQuerySuggestionsBlockListResponse {
|
|
|
5681
5826
|
*/
|
|
5682
5827
|
SourceS3Path?: S3Path;
|
|
5683
5828
|
/**
|
|
5684
|
-
* <p>
|
|
5829
|
+
* <p>The current number of valid, non-empty words or phrases in
|
|
5685
5830
|
* the block list text file.</p>
|
|
5686
5831
|
*/
|
|
5687
5832
|
ItemCount?: number;
|
|
5688
5833
|
/**
|
|
5689
|
-
* <p>
|
|
5834
|
+
* <p>The current size of the block list text file in S3.</p>
|
|
5690
5835
|
*/
|
|
5691
5836
|
FileSizeBytes?: number;
|
|
5692
5837
|
/**
|
|
5693
|
-
* <p>
|
|
5838
|
+
* <p>The IAM (Identity and Access Management) role used by
|
|
5694
5839
|
* Amazon Kendra to access the block list text file in S3.</p>
|
|
5695
5840
|
* <p>The role needs S3 read permissions to your file in S3 and needs to
|
|
5696
5841
|
* give STS (Security Token Service) assume role permissions to
|
|
@@ -5706,8 +5851,8 @@ export declare namespace DescribeQuerySuggestionsBlockListResponse {
|
|
|
5706
5851
|
}
|
|
5707
5852
|
export interface DescribeQuerySuggestionsConfigRequest {
|
|
5708
5853
|
/**
|
|
5709
|
-
* <p>The identifier of the index you want to
|
|
5710
|
-
*
|
|
5854
|
+
* <p>The identifier of the index with query suggestions that you want to get
|
|
5855
|
+
* information on.</p>
|
|
5711
5856
|
*/
|
|
5712
5857
|
IndexId: string | undefined;
|
|
5713
5858
|
}
|
|
@@ -5727,7 +5872,7 @@ export declare enum QuerySuggestionsStatus {
|
|
|
5727
5872
|
}
|
|
5728
5873
|
export interface DescribeQuerySuggestionsConfigResponse {
|
|
5729
5874
|
/**
|
|
5730
|
-
* <p>
|
|
5875
|
+
* <p>Whether query suggestions are currently in
|
|
5731
5876
|
* <code>ENABLED</code> mode or <code>LEARN_ONLY</code> mode.</p>
|
|
5732
5877
|
* <p>By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code>
|
|
5733
5878
|
* turns off query suggestions for your users. You can change the mode using
|
|
@@ -5736,38 +5881,39 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5736
5881
|
*/
|
|
5737
5882
|
Mode?: Mode | string;
|
|
5738
5883
|
/**
|
|
5739
|
-
* <p>
|
|
5740
|
-
*
|
|
5884
|
+
* <p>Whether the status of query suggestions settings is currently
|
|
5885
|
+
* <code>ACTIVE</code> or <code>UPDATING</code>.</p>
|
|
5741
5886
|
* <p>Active means the current settings apply and Updating means your
|
|
5742
5887
|
* changed settings are in the process of applying.</p>
|
|
5743
5888
|
*/
|
|
5744
5889
|
Status?: QuerySuggestionsStatus | string;
|
|
5745
5890
|
/**
|
|
5746
|
-
* <p>
|
|
5891
|
+
* <p>How recent your queries are in your query log time
|
|
5747
5892
|
* window (in days).</p>
|
|
5748
5893
|
*/
|
|
5749
5894
|
QueryLogLookBackWindowInDays?: number;
|
|
5750
5895
|
/**
|
|
5751
|
-
* <p>
|
|
5752
|
-
*
|
|
5896
|
+
* <p>
|
|
5897
|
+
* <code>TRUE</code> to use all queries, otherwise use only queries that include
|
|
5898
|
+
* user information to generate the query suggestions.</p>
|
|
5753
5899
|
*/
|
|
5754
5900
|
IncludeQueriesWithoutUserInformation?: boolean;
|
|
5755
5901
|
/**
|
|
5756
|
-
* <p>
|
|
5902
|
+
* <p>The minimum number of unique users who must search a query in
|
|
5757
5903
|
* order for the query to be eligible to suggest to your users.</p>
|
|
5758
5904
|
*/
|
|
5759
5905
|
MinimumNumberOfQueryingUsers?: number;
|
|
5760
5906
|
/**
|
|
5761
|
-
* <p>
|
|
5907
|
+
* <p>The minimum number of times a query must be searched in order for
|
|
5762
5908
|
* the query to be eligible to suggest to your users.</p>
|
|
5763
5909
|
*/
|
|
5764
5910
|
MinimumQueryCount?: number;
|
|
5765
5911
|
/**
|
|
5766
|
-
* <p>
|
|
5912
|
+
* <p>The date-time query suggestions for an index was last updated.</p>
|
|
5767
5913
|
*/
|
|
5768
5914
|
LastSuggestionsBuildTime?: Date;
|
|
5769
5915
|
/**
|
|
5770
|
-
* <p>
|
|
5916
|
+
* <p>The date-time query suggestions for an index was last cleared.</p>
|
|
5771
5917
|
* <p>After you clear suggestions, Amazon Kendra learns new suggestions based
|
|
5772
5918
|
* on new queries added to the query log from the time you cleared suggestions.
|
|
5773
5919
|
* Amazon Kendra only considers re-occurences of a query from the time you cleared
|
|
@@ -5775,7 +5921,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5775
5921
|
*/
|
|
5776
5922
|
LastClearTime?: Date;
|
|
5777
5923
|
/**
|
|
5778
|
-
* <p>
|
|
5924
|
+
* <p>The current total count of query suggestions for an index.</p>
|
|
5779
5925
|
* <p>This count can change when you update your query suggestions settings,
|
|
5780
5926
|
* if you filter out certain queries from suggestions using a block list,
|
|
5781
5927
|
* and as the query log accumulates more queries for Amazon Kendra to learn from.</p>
|
|
@@ -5790,11 +5936,11 @@ export declare namespace DescribeQuerySuggestionsConfigResponse {
|
|
|
5790
5936
|
}
|
|
5791
5937
|
export interface DescribeThesaurusRequest {
|
|
5792
5938
|
/**
|
|
5793
|
-
* <p>The identifier of the thesaurus to
|
|
5939
|
+
* <p>The identifier of the thesaurus you want to get information on.</p>
|
|
5794
5940
|
*/
|
|
5795
5941
|
Id: string | undefined;
|
|
5796
5942
|
/**
|
|
5797
|
-
* <p>The identifier of the index
|
|
5943
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
5798
5944
|
*/
|
|
5799
5945
|
IndexId: string | undefined;
|
|
5800
5946
|
}
|
|
@@ -5818,7 +5964,7 @@ export interface DescribeThesaurusResponse {
|
|
|
5818
5964
|
*/
|
|
5819
5965
|
Id?: string;
|
|
5820
5966
|
/**
|
|
5821
|
-
* <p>The identifier of the index
|
|
5967
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
5822
5968
|
*/
|
|
5823
5969
|
IndexId?: string;
|
|
5824
5970
|
/**
|
|
@@ -6218,9 +6364,50 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
6218
6364
|
*/
|
|
6219
6365
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
6220
6366
|
}
|
|
6367
|
+
export interface ListAccessControlConfigurationsRequest {
|
|
6368
|
+
/**
|
|
6369
|
+
* <p>The identifier of the index for the access control configuration.</p>
|
|
6370
|
+
*/
|
|
6371
|
+
IndexId: string | undefined;
|
|
6372
|
+
/**
|
|
6373
|
+
* <p>If the previous response was incomplete (because there is more data
|
|
6374
|
+
* to retrieve), Amazon Kendra returns a pagination token in the response.
|
|
6375
|
+
* You can use this pagination token to retrieve the next set of access
|
|
6376
|
+
* control configurations.</p>
|
|
6377
|
+
*/
|
|
6378
|
+
NextToken?: string;
|
|
6379
|
+
/**
|
|
6380
|
+
* <p>The maximum number of access control configurations to return.</p>
|
|
6381
|
+
*/
|
|
6382
|
+
MaxResults?: number;
|
|
6383
|
+
}
|
|
6384
|
+
export declare namespace ListAccessControlConfigurationsRequest {
|
|
6385
|
+
/**
|
|
6386
|
+
* @internal
|
|
6387
|
+
*/
|
|
6388
|
+
const filterSensitiveLog: (obj: ListAccessControlConfigurationsRequest) => any;
|
|
6389
|
+
}
|
|
6390
|
+
export interface ListAccessControlConfigurationsResponse {
|
|
6391
|
+
/**
|
|
6392
|
+
* <p>If the response is truncated, Amazon Kendra returns this token
|
|
6393
|
+
* that you can use in the subsequent request to retrieve the next set of
|
|
6394
|
+
* access control configurations.</p>
|
|
6395
|
+
*/
|
|
6396
|
+
NextToken?: string;
|
|
6397
|
+
/**
|
|
6398
|
+
* <p>The details of your access control configurations.</p>
|
|
6399
|
+
*/
|
|
6400
|
+
AccessControlConfigurations: AccessControlConfigurationSummary[] | undefined;
|
|
6401
|
+
}
|
|
6402
|
+
export declare namespace ListAccessControlConfigurationsResponse {
|
|
6403
|
+
/**
|
|
6404
|
+
* @internal
|
|
6405
|
+
*/
|
|
6406
|
+
const filterSensitiveLog: (obj: ListAccessControlConfigurationsResponse) => any;
|
|
6407
|
+
}
|
|
6221
6408
|
export interface ListDataSourcesRequest {
|
|
6222
6409
|
/**
|
|
6223
|
-
* <p>The identifier of the index
|
|
6410
|
+
* <p>The identifier of the index used with one or more data sources.</p>
|
|
6224
6411
|
*/
|
|
6225
6412
|
IndexId: string | undefined;
|
|
6226
6413
|
/**
|
|
@@ -6319,7 +6506,7 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
6319
6506
|
*/
|
|
6320
6507
|
Id: string | undefined;
|
|
6321
6508
|
/**
|
|
6322
|
-
* <p>The identifier of the index
|
|
6509
|
+
* <p>The identifier of the index used with the data source.</p>
|
|
6323
6510
|
*/
|
|
6324
6511
|
IndexId: string | undefined;
|
|
6325
6512
|
/**
|
|
@@ -6739,8 +6926,8 @@ export declare namespace ListFaqsRequest {
|
|
|
6739
6926
|
const filterSensitiveLog: (obj: ListFaqsRequest) => any;
|
|
6740
6927
|
}
|
|
6741
6928
|
/**
|
|
6742
|
-
* <p>
|
|
6743
|
-
*
|
|
6929
|
+
* <p>Summary information for frequently asked questions and answers
|
|
6930
|
+
* included in an index.</p>
|
|
6744
6931
|
*/
|
|
6745
6932
|
export interface FaqSummary {
|
|
6746
6933
|
/**
|
|
@@ -6841,22 +7028,16 @@ export declare namespace ListGroupsOlderThanOrderingIdRequest {
|
|
|
6841
7028
|
const filterSensitiveLog: (obj: ListGroupsOlderThanOrderingIdRequest) => any;
|
|
6842
7029
|
}
|
|
6843
7030
|
/**
|
|
6844
|
-
* <p>
|
|
6845
|
-
* Group summary information.
|
|
6846
|
-
* </p>
|
|
7031
|
+
* <p>Summary information for groups.</p>
|
|
6847
7032
|
*/
|
|
6848
7033
|
export interface GroupSummary {
|
|
6849
7034
|
/**
|
|
6850
|
-
* <p>
|
|
6851
|
-
* The identifier of the group you want group summary information on.
|
|
6852
|
-
* </p>
|
|
7035
|
+
* <p>The identifier of the group you want group summary information on.</p>
|
|
6853
7036
|
*/
|
|
6854
7037
|
GroupId?: string;
|
|
6855
7038
|
/**
|
|
6856
|
-
* <p>
|
|
6857
|
-
*
|
|
6858
|
-
* action.
|
|
6859
|
-
* </p>
|
|
7039
|
+
* <p>The timestamp identifier used for the latest <code>PUT</code> or <code>DELETE</code>
|
|
7040
|
+
* action.</p>
|
|
6860
7041
|
*/
|
|
6861
7042
|
OrderingId?: number;
|
|
6862
7043
|
}
|
|
@@ -6909,7 +7090,7 @@ export declare namespace ListIndicesRequest {
|
|
|
6909
7090
|
const filterSensitiveLog: (obj: ListIndicesRequest) => any;
|
|
6910
7091
|
}
|
|
6911
7092
|
/**
|
|
6912
|
-
* <p>
|
|
7093
|
+
* <p>Summary information on the configuration of an index.</p>
|
|
6913
7094
|
*/
|
|
6914
7095
|
export interface IndexConfigurationSummary {
|
|
6915
7096
|
/**
|
|
@@ -7097,7 +7278,7 @@ export declare class ResourceUnavailableException extends __BaseException {
|
|
|
7097
7278
|
}
|
|
7098
7279
|
export interface ListThesauriRequest {
|
|
7099
7280
|
/**
|
|
7100
|
-
* <p>The identifier of the index
|
|
7281
|
+
* <p>The identifier of the index with one or more thesauri.</p>
|
|
7101
7282
|
*/
|
|
7102
7283
|
IndexId: string | undefined;
|
|
7103
7284
|
/**
|
|
@@ -7204,9 +7385,9 @@ export declare namespace MemberUser {
|
|
|
7204
7385
|
const filterSensitiveLog: (obj: MemberUser) => any;
|
|
7205
7386
|
}
|
|
7206
7387
|
/**
|
|
7207
|
-
* <p>A list of users or sub groups that belong to a group.
|
|
7208
|
-
*
|
|
7209
|
-
* group
|
|
7388
|
+
* <p>A list of users or sub groups that belong to a group. This is useful for
|
|
7389
|
+
* user context filtering, where search results are filtered based on the user
|
|
7390
|
+
* or their group access to documents.</p>
|
|
7210
7391
|
*/
|
|
7211
7392
|
export interface GroupMembers {
|
|
7212
7393
|
/**
|
|
@@ -7306,15 +7487,14 @@ export declare namespace PutPrincipalMappingRequest {
|
|
|
7306
7487
|
*/
|
|
7307
7488
|
export interface DocumentRelevanceConfiguration {
|
|
7308
7489
|
/**
|
|
7309
|
-
* <p>The name of the
|
|
7310
|
-
* at the index level.</p>
|
|
7490
|
+
* <p>The name of the index field.</p>
|
|
7311
7491
|
*/
|
|
7312
7492
|
Name: string | undefined;
|
|
7313
7493
|
/**
|
|
7314
|
-
* <p>Provides information for
|
|
7315
|
-
*
|
|
7316
|
-
*
|
|
7317
|
-
*
|
|
7494
|
+
* <p>Provides information for tuning the relevance of a field
|
|
7495
|
+
* in a search. When a query includes terms that match the field, the
|
|
7496
|
+
* results are given a boost in the response based on these tuning
|
|
7497
|
+
* parameters.</p>
|
|
7318
7498
|
*/
|
|
7319
7499
|
Relevance: Relevance | undefined;
|
|
7320
7500
|
}
|
|
@@ -7445,8 +7625,13 @@ export declare namespace DataSourceGroup {
|
|
|
7445
7625
|
/**
|
|
7446
7626
|
* <p>Provides information about the user context for
|
|
7447
7627
|
* an Amazon Kendra index.</p>
|
|
7448
|
-
* <p>
|
|
7449
|
-
* to documents
|
|
7628
|
+
* <p>User context filtering is a kind of personalized search with
|
|
7629
|
+
* the benefit of controlling access to documents. For example, not
|
|
7630
|
+
* all teams that search the company portal for information should
|
|
7631
|
+
* access top-secret company documents, nor are these documents
|
|
7632
|
+
* relevant to all users. Only specific users or groups of teams given
|
|
7633
|
+
* access to top-secret documents should see these documents in their
|
|
7634
|
+
* search results.</p>
|
|
7450
7635
|
* <p>You provide one of the following:</p>
|
|
7451
7636
|
* <ul>
|
|
7452
7637
|
* <li>
|
|
@@ -7839,41 +8024,86 @@ export declare namespace UntagResourceResponse {
|
|
|
7839
8024
|
*/
|
|
7840
8025
|
const filterSensitiveLog: (obj: UntagResourceResponse) => any;
|
|
7841
8026
|
}
|
|
8027
|
+
export interface UpdateAccessControlConfigurationRequest {
|
|
8028
|
+
/**
|
|
8029
|
+
* <p>The identifier of the index for an access control configuration.</p>
|
|
8030
|
+
*/
|
|
8031
|
+
IndexId: string | undefined;
|
|
8032
|
+
/**
|
|
8033
|
+
* <p>The identifier of the access control configuration you want to update.</p>
|
|
8034
|
+
*/
|
|
8035
|
+
Id: string | undefined;
|
|
8036
|
+
/**
|
|
8037
|
+
* <p>A new name for the access control configuration.</p>
|
|
8038
|
+
*/
|
|
8039
|
+
Name?: string;
|
|
8040
|
+
/**
|
|
8041
|
+
* <p>A new description for the access control configuration.</p>
|
|
8042
|
+
*/
|
|
8043
|
+
Description?: string;
|
|
8044
|
+
/**
|
|
8045
|
+
* <p>Information you want to update on principals (users and/or groups) and which
|
|
8046
|
+
* documents they should have access to. This is useful for user context filtering,
|
|
8047
|
+
* where search results are filtered based on the user or their group access to
|
|
8048
|
+
* documents.</p>
|
|
8049
|
+
*/
|
|
8050
|
+
AccessControlList?: Principal[];
|
|
8051
|
+
/**
|
|
8052
|
+
* <p>The updated list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that
|
|
8053
|
+
* define the hierarchy for which documents users should have access to.</p>
|
|
8054
|
+
*/
|
|
8055
|
+
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
8056
|
+
}
|
|
8057
|
+
export declare namespace UpdateAccessControlConfigurationRequest {
|
|
8058
|
+
/**
|
|
8059
|
+
* @internal
|
|
8060
|
+
*/
|
|
8061
|
+
const filterSensitiveLog: (obj: UpdateAccessControlConfigurationRequest) => any;
|
|
8062
|
+
}
|
|
8063
|
+
export interface UpdateAccessControlConfigurationResponse {
|
|
8064
|
+
}
|
|
8065
|
+
export declare namespace UpdateAccessControlConfigurationResponse {
|
|
8066
|
+
/**
|
|
8067
|
+
* @internal
|
|
8068
|
+
*/
|
|
8069
|
+
const filterSensitiveLog: (obj: UpdateAccessControlConfigurationResponse) => any;
|
|
8070
|
+
}
|
|
7842
8071
|
export interface UpdateDataSourceRequest {
|
|
7843
8072
|
/**
|
|
7844
|
-
* <p>The
|
|
8073
|
+
* <p>The identifier of the data source you want to update.</p>
|
|
7845
8074
|
*/
|
|
7846
8075
|
Id: string | undefined;
|
|
7847
8076
|
/**
|
|
7848
|
-
* <p>
|
|
7849
|
-
*
|
|
7850
|
-
*
|
|
8077
|
+
* <p>A new name for the data source connector. You must
|
|
8078
|
+
* first delete the data source and re-create it to change the
|
|
8079
|
+
* name of the data source.</p>
|
|
7851
8080
|
*/
|
|
7852
8081
|
Name?: string;
|
|
7853
8082
|
/**
|
|
7854
|
-
* <p>The identifier of the index
|
|
7855
|
-
* update.</p>
|
|
8083
|
+
* <p>The identifier of the index used with the data source connector.</p>
|
|
7856
8084
|
*/
|
|
7857
8085
|
IndexId: string | undefined;
|
|
7858
8086
|
/**
|
|
7859
|
-
* <p>Configuration information
|
|
8087
|
+
* <p>Configuration information you want to update for the data source connector.</p>
|
|
7860
8088
|
*/
|
|
7861
8089
|
Configuration?: DataSourceConfiguration;
|
|
7862
8090
|
/**
|
|
7863
|
-
* <p>
|
|
8091
|
+
* <p>A new description for the data source connector.</p>
|
|
7864
8092
|
*/
|
|
7865
8093
|
Description?: string;
|
|
7866
8094
|
/**
|
|
7867
|
-
* <p>The
|
|
8095
|
+
* <p>The sync schedule you want to update for the data source connector.</p>
|
|
7868
8096
|
*/
|
|
7869
8097
|
Schedule?: string;
|
|
7870
8098
|
/**
|
|
7871
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
7872
|
-
* source
|
|
8099
|
+
* <p>The Amazon Resource Name (ARN) of a role with permission to access
|
|
8100
|
+
* the data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM Roles for
|
|
8101
|
+
* Amazon Kendra</a>.</p>
|
|
7873
8102
|
*/
|
|
7874
8103
|
RoleArn?: string;
|
|
7875
8104
|
/**
|
|
7876
|
-
* <p>The code for a language
|
|
8105
|
+
* <p>The code for a language you want to update for the data source connector.
|
|
8106
|
+
* This allows you to support a language for all
|
|
7877
8107
|
* documents when updating the data source. English is supported
|
|
7878
8108
|
* by default. For more information on supported languages, including their codes,
|
|
7879
8109
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding
|
|
@@ -7881,8 +8111,8 @@ export interface UpdateDataSourceRequest {
|
|
|
7881
8111
|
*/
|
|
7882
8112
|
LanguageCode?: string;
|
|
7883
8113
|
/**
|
|
7884
|
-
* <p>Configuration information for altering document metadata
|
|
7885
|
-
*
|
|
8114
|
+
* <p>Configuration information you want to update for altering document metadata
|
|
8115
|
+
* and content during the document ingestion process.</p>
|
|
7886
8116
|
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
7887
8117
|
* other content alterations when you ingest documents into Amazon Kendra, see
|
|
7888
8118
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
@@ -7902,11 +8132,11 @@ export interface UpdateExperienceRequest {
|
|
|
7902
8132
|
*/
|
|
7903
8133
|
Id: string | undefined;
|
|
7904
8134
|
/**
|
|
7905
|
-
* <p>
|
|
8135
|
+
* <p>A new name for your Amazon Kendra experience.</p>
|
|
7906
8136
|
*/
|
|
7907
8137
|
Name?: string;
|
|
7908
8138
|
/**
|
|
7909
|
-
* <p>The identifier of the index for your Amazon Kendra experience
|
|
8139
|
+
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
7910
8140
|
*/
|
|
7911
8141
|
IndexId: string | undefined;
|
|
7912
8142
|
/**
|
|
@@ -7917,11 +8147,11 @@ export interface UpdateExperienceRequest {
|
|
|
7917
8147
|
*/
|
|
7918
8148
|
RoleArn?: string;
|
|
7919
8149
|
/**
|
|
7920
|
-
* <p>Configuration information for your Amazon Kendra
|
|
8150
|
+
* <p>Configuration information you want to update for your Amazon Kendra experience.</p>
|
|
7921
8151
|
*/
|
|
7922
8152
|
Configuration?: ExperienceConfiguration;
|
|
7923
8153
|
/**
|
|
7924
|
-
* <p>
|
|
8154
|
+
* <p>A new description for your Amazon Kendra experience.</p>
|
|
7925
8155
|
*/
|
|
7926
8156
|
Description?: string;
|
|
7927
8157
|
}
|
|
@@ -7933,16 +8163,17 @@ export declare namespace UpdateExperienceRequest {
|
|
|
7933
8163
|
}
|
|
7934
8164
|
export interface UpdateIndexRequest {
|
|
7935
8165
|
/**
|
|
7936
|
-
* <p>The identifier of the index to update.</p>
|
|
8166
|
+
* <p>The identifier of the index you want to update.</p>
|
|
7937
8167
|
*/
|
|
7938
8168
|
Id: string | undefined;
|
|
7939
8169
|
/**
|
|
7940
|
-
* <p>The name of the index to update.</p>
|
|
8170
|
+
* <p>The name of the index you want to update.</p>
|
|
7941
8171
|
*/
|
|
7942
8172
|
Name?: string;
|
|
7943
8173
|
/**
|
|
7944
|
-
* <p>
|
|
7945
|
-
* Amazon CloudWatch
|
|
8174
|
+
* <p>An Identity and Access Management (IAM) role that
|
|
8175
|
+
* gives Amazon Kendra permission to access Amazon CloudWatch
|
|
8176
|
+
* logs and metrics.</p>
|
|
7946
8177
|
*/
|
|
7947
8178
|
RoleArn?: string;
|
|
7948
8179
|
/**
|
|
@@ -7950,7 +8181,9 @@ export interface UpdateIndexRequest {
|
|
|
7950
8181
|
*/
|
|
7951
8182
|
Description?: string;
|
|
7952
8183
|
/**
|
|
7953
|
-
* <p>The document metadata you want to update
|
|
8184
|
+
* <p>The document metadata configuration you want to update for the index.
|
|
8185
|
+
* Document metadata are fields or attributes associated with your documents.
|
|
8186
|
+
* For example, the company department name associated with each document.</p>
|
|
7954
8187
|
*/
|
|
7955
8188
|
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
|
|
7956
8189
|
/**
|
|
@@ -7985,19 +8218,19 @@ export declare namespace UpdateIndexRequest {
|
|
|
7985
8218
|
}
|
|
7986
8219
|
export interface UpdateQuerySuggestionsBlockListRequest {
|
|
7987
8220
|
/**
|
|
7988
|
-
* <p>The identifier of the index for
|
|
8221
|
+
* <p>The identifier of the index for the block list.</p>
|
|
7989
8222
|
*/
|
|
7990
8223
|
IndexId: string | undefined;
|
|
7991
8224
|
/**
|
|
7992
|
-
* <p>The
|
|
8225
|
+
* <p>The identifier of the block list you want to update.</p>
|
|
7993
8226
|
*/
|
|
7994
8227
|
Id: string | undefined;
|
|
7995
8228
|
/**
|
|
7996
|
-
* <p>
|
|
8229
|
+
* <p>A new name for the block list.</p>
|
|
7997
8230
|
*/
|
|
7998
8231
|
Name?: string;
|
|
7999
8232
|
/**
|
|
8000
|
-
* <p>
|
|
8233
|
+
* <p>A new description for the block list.</p>
|
|
8001
8234
|
*/
|
|
8002
8235
|
Description?: string;
|
|
8003
8236
|
/**
|
|
@@ -8026,7 +8259,7 @@ export declare namespace UpdateQuerySuggestionsBlockListRequest {
|
|
|
8026
8259
|
}
|
|
8027
8260
|
export interface UpdateQuerySuggestionsConfigRequest {
|
|
8028
8261
|
/**
|
|
8029
|
-
* <p>The identifier of the index you want to update
|
|
8262
|
+
* <p> The identifier of the index with query suggestions you want to update.</p>
|
|
8030
8263
|
*/
|
|
8031
8264
|
IndexId: string | undefined;
|
|
8032
8265
|
/**
|
|
@@ -8086,23 +8319,24 @@ export declare namespace UpdateQuerySuggestionsConfigRequest {
|
|
|
8086
8319
|
}
|
|
8087
8320
|
export interface UpdateThesaurusRequest {
|
|
8088
8321
|
/**
|
|
8089
|
-
* <p>The identifier of the thesaurus to update.</p>
|
|
8322
|
+
* <p>The identifier of the thesaurus you want to update.</p>
|
|
8090
8323
|
*/
|
|
8091
8324
|
Id: string | undefined;
|
|
8092
8325
|
/**
|
|
8093
|
-
* <p>
|
|
8326
|
+
* <p>A new name for the thesaurus.</p>
|
|
8094
8327
|
*/
|
|
8095
8328
|
Name?: string;
|
|
8096
8329
|
/**
|
|
8097
|
-
* <p>The identifier of the index
|
|
8330
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
8098
8331
|
*/
|
|
8099
8332
|
IndexId: string | undefined;
|
|
8100
8333
|
/**
|
|
8101
|
-
* <p>
|
|
8334
|
+
* <p>A new description for the thesaurus.</p>
|
|
8102
8335
|
*/
|
|
8103
8336
|
Description?: string;
|
|
8104
8337
|
/**
|
|
8105
|
-
* <p>
|
|
8338
|
+
* <p>An IAM role that gives Amazon Kendra permissions to
|
|
8339
|
+
* access thesaurus file specified in <code>SourceS3Path</code>.</p>
|
|
8106
8340
|
*/
|
|
8107
8341
|
RoleArn?: string;
|
|
8108
8342
|
/**
|
|
@@ -8353,97 +8587,3 @@ export declare namespace QueryResult {
|
|
|
8353
8587
|
*/
|
|
8354
8588
|
const filterSensitiveLog: (obj: QueryResult) => any;
|
|
8355
8589
|
}
|
|
8356
|
-
export interface QueryRequest {
|
|
8357
|
-
/**
|
|
8358
|
-
* <p>The unique identifier of the index to search. The identifier is
|
|
8359
|
-
* returned in the response from the <code>CreateIndex</code>
|
|
8360
|
-
* API.</p>
|
|
8361
|
-
*/
|
|
8362
|
-
IndexId: string | undefined;
|
|
8363
|
-
/**
|
|
8364
|
-
* <p>The text to search for.</p>
|
|
8365
|
-
*/
|
|
8366
|
-
QueryText?: string;
|
|
8367
|
-
/**
|
|
8368
|
-
* <p>Enables filtered searches based on document attributes. You can only
|
|
8369
|
-
* provide one attribute filter; however, the <code>AndAllFilters</code>,
|
|
8370
|
-
* <code>NotFilter</code>, and <code>OrAllFilters</code> parameters
|
|
8371
|
-
* contain a list of other filters.</p>
|
|
8372
|
-
* <p>The <code>AttributeFilter</code> parameter enables you to create a
|
|
8373
|
-
* set of filtering rules that a document must satisfy to be included in
|
|
8374
|
-
* the query results.</p>
|
|
8375
|
-
*/
|
|
8376
|
-
AttributeFilter?: AttributeFilter;
|
|
8377
|
-
/**
|
|
8378
|
-
* <p>An array of documents attributes. Amazon Kendra returns a count for
|
|
8379
|
-
* each attribute key specified. This helps your users narrow their search.</p>
|
|
8380
|
-
*/
|
|
8381
|
-
Facets?: Facet[];
|
|
8382
|
-
/**
|
|
8383
|
-
* <p>An array of document attributes to include in the response.
|
|
8384
|
-
* You can limit the response to include certain document attributes.
|
|
8385
|
-
* By default all document attributes are included in the response.</p>
|
|
8386
|
-
*/
|
|
8387
|
-
RequestedDocumentAttributes?: string[];
|
|
8388
|
-
/**
|
|
8389
|
-
* <p>Sets the type of query. Only results for the specified query type
|
|
8390
|
-
* are returned.</p>
|
|
8391
|
-
*/
|
|
8392
|
-
QueryResultTypeFilter?: QueryResultType | string;
|
|
8393
|
-
/**
|
|
8394
|
-
* <p>Overrides relevance tuning configurations of fields or attributes set at the index level.</p>
|
|
8395
|
-
* <p>If you use this API to override the relevance tuning configured at the index
|
|
8396
|
-
* level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.</p>
|
|
8397
|
-
* <p>If there is relevance tuning configured at the index level, but you do not use this API
|
|
8398
|
-
* to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.</p>
|
|
8399
|
-
* <p>If there is relevance tuning configured for fields at the index level,
|
|
8400
|
-
* but you use this API to override only some of these fields, then for the fields you did not override,
|
|
8401
|
-
* the importance is set to 1.</p>
|
|
8402
|
-
*/
|
|
8403
|
-
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
|
|
8404
|
-
/**
|
|
8405
|
-
* <p>Query results are returned in pages the size of the
|
|
8406
|
-
* <code>PageSize</code> parameter. By default, Amazon Kendra returns
|
|
8407
|
-
* the first page of results. Use this parameter to get result pages after
|
|
8408
|
-
* the first one.</p>
|
|
8409
|
-
*/
|
|
8410
|
-
PageNumber?: number;
|
|
8411
|
-
/**
|
|
8412
|
-
* <p>Sets the number of results that are returned in each page of
|
|
8413
|
-
* results. The default page size is 10. The maximum number of results
|
|
8414
|
-
* returned is 100. If you ask for more than 100 results, only 100 are
|
|
8415
|
-
* returned.</p>
|
|
8416
|
-
*/
|
|
8417
|
-
PageSize?: number;
|
|
8418
|
-
/**
|
|
8419
|
-
* <p>Provides information that determines how the results of the query
|
|
8420
|
-
* are sorted. You can set the field that Amazon Kendra should sort the results
|
|
8421
|
-
* on, and specify whether the results should be sorted in ascending or
|
|
8422
|
-
* descending order. In the case of ties in sorting the results, the
|
|
8423
|
-
* results are sorted by relevance.</p>
|
|
8424
|
-
* <p>If you don't provide sorting configuration, the results are sorted
|
|
8425
|
-
* by the relevance that Amazon Kendra determines for the result.</p>
|
|
8426
|
-
*/
|
|
8427
|
-
SortingConfiguration?: SortingConfiguration;
|
|
8428
|
-
/**
|
|
8429
|
-
* <p>The user context token or user and group information.</p>
|
|
8430
|
-
*/
|
|
8431
|
-
UserContext?: UserContext;
|
|
8432
|
-
/**
|
|
8433
|
-
* <p>Provides an identifier for a specific user. The
|
|
8434
|
-
* <code>VisitorId</code> should be a unique identifier, such as a
|
|
8435
|
-
* GUID. Don't use personally identifiable information, such as the user's
|
|
8436
|
-
* email address, as the <code>VisitorId</code>.</p>
|
|
8437
|
-
*/
|
|
8438
|
-
VisitorId?: string;
|
|
8439
|
-
/**
|
|
8440
|
-
* <p>Enables suggested spell corrections for queries.</p>
|
|
8441
|
-
*/
|
|
8442
|
-
SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
|
|
8443
|
-
}
|
|
8444
|
-
export declare namespace QueryRequest {
|
|
8445
|
-
/**
|
|
8446
|
-
* @internal
|
|
8447
|
-
*/
|
|
8448
|
-
const filterSensitiveLog: (obj: QueryRequest) => any;
|
|
8449
|
-
}
|