@aws-sdk/client-kendra 3.128.0 → 3.135.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 +35 -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 +3 -3
- 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 +77 -18
- package/dist-cjs/models/models_1.js +15 -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 +452 -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 +1 -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 +49 -8
- package/dist-es/models/models_1.js +9 -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 +525 -2
- package/dist-types/Kendra.d.ts +97 -11
- package/dist-types/KendraClient.d.ts +7 -2
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +57 -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 +1 -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 +427 -312
- package/dist-types/models/models_1.d.ts +136 -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 +1 -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 +131 -50
- package/dist-types/ts3.4/models/models_1.d.ts +51 -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
|
|
@@ -3359,6 +3435,10 @@ export declare namespace ServiceNowConfiguration {
|
|
|
3359
3435
|
*/
|
|
3360
3436
|
const filterSensitiveLog: (obj: ServiceNowConfiguration) => any;
|
|
3361
3437
|
}
|
|
3438
|
+
export declare enum SharePointOnlineAuthenticationType {
|
|
3439
|
+
HTTP_BASIC = "HTTP_BASIC",
|
|
3440
|
+
OAUTH2 = "OAUTH2"
|
|
3441
|
+
}
|
|
3362
3442
|
export declare enum SharePointVersion {
|
|
3363
3443
|
SHAREPOINT_2013 = "SHAREPOINT_2013",
|
|
3364
3444
|
SHAREPOINT_2016 = "SHAREPOINT_2016",
|
|
@@ -3385,6 +3465,10 @@ export interface SharePointConfiguration {
|
|
|
3385
3465
|
* domain name as part of the credentials. For
|
|
3386
3466
|
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html">Using a
|
|
3387
3467
|
* Microsoft SharePoint Data Source</a>.</p>
|
|
3468
|
+
* <p>You can also provide OAuth authentication credentials of user name,
|
|
3469
|
+
* password, client ID, and client secret. For more information, see
|
|
3470
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html#sharepoint-authentication">Authentication
|
|
3471
|
+
* for a SharePoint data source</a>.</p>
|
|
3388
3472
|
*/
|
|
3389
3473
|
SecretArn: string | undefined;
|
|
3390
3474
|
/**
|
|
@@ -3450,6 +3534,13 @@ export interface SharePointConfiguration {
|
|
|
3450
3534
|
* this to connect to SharePoint.</p>
|
|
3451
3535
|
*/
|
|
3452
3536
|
SslCertificateS3Path?: S3Path;
|
|
3537
|
+
/**
|
|
3538
|
+
* <p>Whether you want to connect to SharePoint using basic authentication of
|
|
3539
|
+
* user name and password, or OAuth authentication of user name, password,
|
|
3540
|
+
* client ID, and client secret. You can use OAuth authentication for
|
|
3541
|
+
* SharePoint Online.</p>
|
|
3542
|
+
*/
|
|
3543
|
+
AuthenticationType?: SharePointOnlineAuthenticationType | string;
|
|
3453
3544
|
}
|
|
3454
3545
|
export declare namespace SharePointConfiguration {
|
|
3455
3546
|
/**
|
|
@@ -3806,11 +3897,12 @@ export interface WebCrawlerConfiguration {
|
|
|
3806
3897
|
/**
|
|
3807
3898
|
* <p>Configuration information required to connect to websites using
|
|
3808
3899
|
* authentication.</p>
|
|
3809
|
-
* <p>You can connect to websites using basic authentication of user name and password
|
|
3900
|
+
* <p>You can connect to websites using basic authentication of user name and password.
|
|
3901
|
+
* You use a secret in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a> to store
|
|
3902
|
+
* your authentication credentials.</p>
|
|
3810
3903
|
* <p>You must provide the website host name and port number. For example, the host name
|
|
3811
3904
|
* 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>
|
|
3905
|
+
* standard port for HTTPS.</p>
|
|
3814
3906
|
*/
|
|
3815
3907
|
AuthenticationConfiguration?: AuthenticationConfiguration;
|
|
3816
3908
|
}
|
|
@@ -4030,22 +4122,20 @@ export declare enum DataSourceType {
|
|
|
4030
4122
|
}
|
|
4031
4123
|
export interface CreateDataSourceRequest {
|
|
4032
4124
|
/**
|
|
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>
|
|
4125
|
+
* <p>A unique name for the data source connector. A data source name can't be changed
|
|
4126
|
+
* without deleting and recreating the data source connector.</p>
|
|
4035
4127
|
*/
|
|
4036
4128
|
Name: string | undefined;
|
|
4037
4129
|
/**
|
|
4038
|
-
* <p>The identifier of the index
|
|
4039
|
-
* source.</p>
|
|
4130
|
+
* <p>The identifier of the index you want to use with the data source connector.</p>
|
|
4040
4131
|
*/
|
|
4041
4132
|
IndexId: string | undefined;
|
|
4042
4133
|
/**
|
|
4043
|
-
* <p>The type of
|
|
4134
|
+
* <p>The type of data source repository. For example, <code>SHAREPOINT</code>.</p>
|
|
4044
4135
|
*/
|
|
4045
4136
|
Type: DataSourceType | string | undefined;
|
|
4046
4137
|
/**
|
|
4047
|
-
* <p>Configuration information
|
|
4048
|
-
* repository.</p>
|
|
4138
|
+
* <p>Configuration information to connect to your data source repository.</p>
|
|
4049
4139
|
* <p>You can't specify the <code>Configuration</code> parameter when the
|
|
4050
4140
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
4051
4141
|
* you receive a <code>ValidationException</code> exception.</p>
|
|
@@ -4054,13 +4144,13 @@ export interface CreateDataSourceRequest {
|
|
|
4054
4144
|
*/
|
|
4055
4145
|
Configuration?: DataSourceConfiguration;
|
|
4056
4146
|
/**
|
|
4057
|
-
* <p>A description for the data source.</p>
|
|
4147
|
+
* <p>A description for the data source connector.</p>
|
|
4058
4148
|
*/
|
|
4059
4149
|
Description?: string;
|
|
4060
4150
|
/**
|
|
4061
4151
|
* <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
|
|
4152
|
+
* data source repository and update the index. If you don't set a schedule
|
|
4153
|
+
* Amazon Kendra will not periodically update the index. You can call the
|
|
4064
4154
|
* <code>StartDataSourceSyncJob</code> API to update the
|
|
4065
4155
|
* index.</p>
|
|
4066
4156
|
* <p>You can't specify the <code>Schedule</code> parameter when the
|
|
@@ -4070,7 +4160,7 @@ export interface CreateDataSourceRequest {
|
|
|
4070
4160
|
Schedule?: string;
|
|
4071
4161
|
/**
|
|
4072
4162
|
* <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
|
|
4163
|
+
* data source connector. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM Roles for
|
|
4074
4164
|
* Amazon Kendra</a>.</p>
|
|
4075
4165
|
* <p>You can't specify the <code>RoleArn</code> parameter when the
|
|
4076
4166
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
@@ -4080,20 +4170,20 @@ export interface CreateDataSourceRequest {
|
|
|
4080
4170
|
*/
|
|
4081
4171
|
RoleArn?: string;
|
|
4082
4172
|
/**
|
|
4083
|
-
* <p>A list of key-value pairs that identify the data source. You can use
|
|
4173
|
+
* <p>A list of key-value pairs that identify the data source connector. You can use
|
|
4084
4174
|
* the tags to identify and organize your resources and to control access to
|
|
4085
4175
|
* resources.</p>
|
|
4086
4176
|
*/
|
|
4087
4177
|
Tags?: Tag[];
|
|
4088
4178
|
/**
|
|
4089
4179
|
* <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>
|
|
4180
|
+
* source connector. Multiple calls to the <code>CreateDataSource</code> API
|
|
4181
|
+
* with the same client token will create only one data source connector.</p>
|
|
4092
4182
|
*/
|
|
4093
4183
|
ClientToken?: string;
|
|
4094
4184
|
/**
|
|
4095
4185
|
* <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
|
|
4186
|
+
* documents when creating the data source connector. English is supported
|
|
4097
4187
|
* by default. For more information on supported languages, including their codes,
|
|
4098
4188
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding
|
|
4099
4189
|
* documents in languages other than English</a>.</p>
|
|
@@ -4101,7 +4191,7 @@ export interface CreateDataSourceRequest {
|
|
|
4101
4191
|
LanguageCode?: string;
|
|
4102
4192
|
/**
|
|
4103
4193
|
* <p>Configuration information for altering document metadata and content during the
|
|
4104
|
-
* document ingestion process
|
|
4194
|
+
* document ingestion process.</p>
|
|
4105
4195
|
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
4106
4196
|
* other content alterations when you ingest documents into Amazon Kendra, see
|
|
4107
4197
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
@@ -4117,7 +4207,7 @@ export declare namespace CreateDataSourceRequest {
|
|
|
4117
4207
|
}
|
|
4118
4208
|
export interface CreateDataSourceResponse {
|
|
4119
4209
|
/**
|
|
4120
|
-
* <p>
|
|
4210
|
+
* <p>The identifier of the data source connector.</p>
|
|
4121
4211
|
*/
|
|
4122
4212
|
Id: string | undefined;
|
|
4123
4213
|
}
|
|
@@ -4257,19 +4347,19 @@ export declare enum FaqFileFormat {
|
|
|
4257
4347
|
}
|
|
4258
4348
|
export interface CreateFaqRequest {
|
|
4259
4349
|
/**
|
|
4260
|
-
* <p>The identifier of the index
|
|
4350
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
4261
4351
|
*/
|
|
4262
4352
|
IndexId: string | undefined;
|
|
4263
4353
|
/**
|
|
4264
|
-
* <p>
|
|
4354
|
+
* <p>A name for the FAQ.</p>
|
|
4265
4355
|
*/
|
|
4266
4356
|
Name: string | undefined;
|
|
4267
4357
|
/**
|
|
4268
|
-
* <p>A description
|
|
4358
|
+
* <p>A description for the FAQ.</p>
|
|
4269
4359
|
*/
|
|
4270
4360
|
Description?: string;
|
|
4271
4361
|
/**
|
|
4272
|
-
* <p>The
|
|
4362
|
+
* <p>The path to the FAQ file in S3.</p>
|
|
4273
4363
|
*/
|
|
4274
4364
|
S3Path: S3Path | undefined;
|
|
4275
4365
|
/**
|
|
@@ -4283,7 +4373,7 @@ export interface CreateFaqRequest {
|
|
|
4283
4373
|
*/
|
|
4284
4374
|
Tags?: Tag[];
|
|
4285
4375
|
/**
|
|
4286
|
-
* <p>The format of the input file. You can choose between a basic CSV format, a CSV format
|
|
4376
|
+
* <p>The format of the FAQ input file. You can choose between a basic CSV format, a CSV format
|
|
4287
4377
|
* that includes customs attributes in a header, and a JSON format that includes custom
|
|
4288
4378
|
* attributes.</p>
|
|
4289
4379
|
* <p>The format must match the format of the file stored in the S3 bucket identified in the
|
|
@@ -4358,12 +4448,11 @@ export declare enum UserGroupResolutionMode {
|
|
|
4358
4448
|
/**
|
|
4359
4449
|
* <p>Provides the configuration information to fetch access levels
|
|
4360
4450
|
* 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>
|
|
4451
|
+
* source. This is useful for user context filtering, where search
|
|
4452
|
+
* results are filtered based on the user or their group access to
|
|
4453
|
+
* documents. You can also use the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping</a>
|
|
4454
|
+
* API to map users to their groups so that you only need to provide
|
|
4455
|
+
* the user ID when you issue the query.</p>
|
|
4367
4456
|
* <p>To set up an Amazon Web Services SSO identity source in the console to use with
|
|
4368
4457
|
* Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started
|
|
4369
4458
|
* with an Amazon Web Services SSO identity source</a>. You must also grant the required
|
|
@@ -4473,7 +4562,7 @@ export declare namespace UserTokenConfiguration {
|
|
|
4473
4562
|
}
|
|
4474
4563
|
export interface CreateIndexRequest {
|
|
4475
4564
|
/**
|
|
4476
|
-
* <p>
|
|
4565
|
+
* <p>A name for the index.</p>
|
|
4477
4566
|
*/
|
|
4478
4567
|
Name: string | undefined;
|
|
4479
4568
|
/**
|
|
@@ -4637,16 +4726,15 @@ export declare namespace CreateQuerySuggestionsBlockListResponse {
|
|
|
4637
4726
|
}
|
|
4638
4727
|
export interface CreateThesaurusRequest {
|
|
4639
4728
|
/**
|
|
4640
|
-
* <p>The
|
|
4641
|
-
* </p>
|
|
4729
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
4642
4730
|
*/
|
|
4643
4731
|
IndexId: string | undefined;
|
|
4644
4732
|
/**
|
|
4645
|
-
* <p>
|
|
4733
|
+
* <p>A name for the thesaurus.</p>
|
|
4646
4734
|
*/
|
|
4647
4735
|
Name: string | undefined;
|
|
4648
4736
|
/**
|
|
4649
|
-
* <p>
|
|
4737
|
+
* <p>A description for the thesaurus.</p>
|
|
4650
4738
|
*/
|
|
4651
4739
|
Description?: string;
|
|
4652
4740
|
/**
|
|
@@ -4663,8 +4751,7 @@ export interface CreateThesaurusRequest {
|
|
|
4663
4751
|
*/
|
|
4664
4752
|
Tags?: Tag[];
|
|
4665
4753
|
/**
|
|
4666
|
-
* <p>The thesaurus file
|
|
4667
|
-
* </p>
|
|
4754
|
+
* <p>The path to the thesaurus file in S3.</p>
|
|
4668
4755
|
*/
|
|
4669
4756
|
SourceS3Path: S3Path | undefined;
|
|
4670
4757
|
/**
|
|
@@ -4694,14 +4781,37 @@ export declare namespace CreateThesaurusResponse {
|
|
|
4694
4781
|
*/
|
|
4695
4782
|
const filterSensitiveLog: (obj: CreateThesaurusResponse) => any;
|
|
4696
4783
|
}
|
|
4784
|
+
export interface DeleteAccessControlConfigurationRequest {
|
|
4785
|
+
/**
|
|
4786
|
+
* <p>The identifier of the index for an access control configuration.</p>
|
|
4787
|
+
*/
|
|
4788
|
+
IndexId: string | undefined;
|
|
4789
|
+
/**
|
|
4790
|
+
* <p>The identifier of the access control configuration you want to delete.</p>
|
|
4791
|
+
*/
|
|
4792
|
+
Id: string | undefined;
|
|
4793
|
+
}
|
|
4794
|
+
export declare namespace DeleteAccessControlConfigurationRequest {
|
|
4795
|
+
/**
|
|
4796
|
+
* @internal
|
|
4797
|
+
*/
|
|
4798
|
+
const filterSensitiveLog: (obj: DeleteAccessControlConfigurationRequest) => any;
|
|
4799
|
+
}
|
|
4800
|
+
export interface DeleteAccessControlConfigurationResponse {
|
|
4801
|
+
}
|
|
4802
|
+
export declare namespace DeleteAccessControlConfigurationResponse {
|
|
4803
|
+
/**
|
|
4804
|
+
* @internal
|
|
4805
|
+
*/
|
|
4806
|
+
const filterSensitiveLog: (obj: DeleteAccessControlConfigurationResponse) => any;
|
|
4807
|
+
}
|
|
4697
4808
|
export interface DeleteDataSourceRequest {
|
|
4698
4809
|
/**
|
|
4699
|
-
* <p>The
|
|
4810
|
+
* <p>The identifier of the data source you want to delete.</p>
|
|
4700
4811
|
*/
|
|
4701
4812
|
Id: string | undefined;
|
|
4702
4813
|
/**
|
|
4703
|
-
* <p>The
|
|
4704
|
-
* source.</p>
|
|
4814
|
+
* <p>The identifier of the index used with the data source.</p>
|
|
4705
4815
|
*/
|
|
4706
4816
|
IndexId: string | undefined;
|
|
4707
4817
|
}
|
|
@@ -4717,7 +4827,7 @@ export interface DeleteExperienceRequest {
|
|
|
4717
4827
|
*/
|
|
4718
4828
|
Id: string | undefined;
|
|
4719
4829
|
/**
|
|
4720
|
-
* <p>The identifier of the index for your Amazon Kendra experience
|
|
4830
|
+
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
4721
4831
|
*/
|
|
4722
4832
|
IndexId: string | undefined;
|
|
4723
4833
|
}
|
|
@@ -4737,11 +4847,11 @@ export declare namespace DeleteExperienceResponse {
|
|
|
4737
4847
|
}
|
|
4738
4848
|
export interface DeleteFaqRequest {
|
|
4739
4849
|
/**
|
|
4740
|
-
* <p>The identifier of the FAQ to remove.</p>
|
|
4850
|
+
* <p>The identifier of the FAQ you want to remove.</p>
|
|
4741
4851
|
*/
|
|
4742
4852
|
Id: string | undefined;
|
|
4743
4853
|
/**
|
|
4744
|
-
* <p>The index
|
|
4854
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
4745
4855
|
*/
|
|
4746
4856
|
IndexId: string | undefined;
|
|
4747
4857
|
}
|
|
@@ -4753,7 +4863,7 @@ export declare namespace DeleteFaqRequest {
|
|
|
4753
4863
|
}
|
|
4754
4864
|
export interface DeleteIndexRequest {
|
|
4755
4865
|
/**
|
|
4756
|
-
* <p>The identifier of the index to delete.</p>
|
|
4866
|
+
* <p>The identifier of the index you want to delete.</p>
|
|
4757
4867
|
*/
|
|
4758
4868
|
Id: string | undefined;
|
|
4759
4869
|
}
|
|
@@ -4770,8 +4880,8 @@ export interface DeletePrincipalMappingRequest {
|
|
|
4770
4880
|
IndexId: string | undefined;
|
|
4771
4881
|
/**
|
|
4772
4882
|
* <p>The identifier of the data source you want to delete a group from.</p>
|
|
4773
|
-
* <p>
|
|
4774
|
-
*
|
|
4883
|
+
* <p>A group can be tied to multiple data sources. You can
|
|
4884
|
+
* delete a group from accessing documents in a certain data source. For example,
|
|
4775
4885
|
* the groups "Research", "Engineering", and "Sales and Marketing" are all tied to
|
|
4776
4886
|
* the company's documents stored in the data sources Confluence and Salesforce.
|
|
4777
4887
|
* You want to delete "Research" and "Engineering" groups from Salesforce, so that
|
|
@@ -4810,11 +4920,11 @@ export declare namespace DeletePrincipalMappingRequest {
|
|
|
4810
4920
|
}
|
|
4811
4921
|
export interface DeleteQuerySuggestionsBlockListRequest {
|
|
4812
4922
|
/**
|
|
4813
|
-
* <p>The identifier of the
|
|
4923
|
+
* <p>The identifier of the index for the block list.</p>
|
|
4814
4924
|
*/
|
|
4815
4925
|
IndexId: string | undefined;
|
|
4816
4926
|
/**
|
|
4817
|
-
* <p>The
|
|
4927
|
+
* <p>The identifier of the block list you want to delete.</p>
|
|
4818
4928
|
*/
|
|
4819
4929
|
Id: string | undefined;
|
|
4820
4930
|
}
|
|
@@ -4826,11 +4936,11 @@ export declare namespace DeleteQuerySuggestionsBlockListRequest {
|
|
|
4826
4936
|
}
|
|
4827
4937
|
export interface DeleteThesaurusRequest {
|
|
4828
4938
|
/**
|
|
4829
|
-
* <p>The identifier of the thesaurus to delete.</p>
|
|
4939
|
+
* <p>The identifier of the thesaurus you want to delete.</p>
|
|
4830
4940
|
*/
|
|
4831
4941
|
Id: string | undefined;
|
|
4832
4942
|
/**
|
|
4833
|
-
* <p>The identifier of the index
|
|
4943
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
4834
4944
|
*/
|
|
4835
4945
|
IndexId: string | undefined;
|
|
4836
4946
|
}
|
|
@@ -4840,13 +4950,62 @@ export declare namespace DeleteThesaurusRequest {
|
|
|
4840
4950
|
*/
|
|
4841
4951
|
const filterSensitiveLog: (obj: DeleteThesaurusRequest) => any;
|
|
4842
4952
|
}
|
|
4953
|
+
export interface DescribeAccessControlConfigurationRequest {
|
|
4954
|
+
/**
|
|
4955
|
+
* <p>The identifier of the index for an access control configuration.</p>
|
|
4956
|
+
*/
|
|
4957
|
+
IndexId: string | undefined;
|
|
4958
|
+
/**
|
|
4959
|
+
* <p>The identifier of the access control configuration
|
|
4960
|
+
* you want to get information on.</p>
|
|
4961
|
+
*/
|
|
4962
|
+
Id: string | undefined;
|
|
4963
|
+
}
|
|
4964
|
+
export declare namespace DescribeAccessControlConfigurationRequest {
|
|
4965
|
+
/**
|
|
4966
|
+
* @internal
|
|
4967
|
+
*/
|
|
4968
|
+
const filterSensitiveLog: (obj: DescribeAccessControlConfigurationRequest) => any;
|
|
4969
|
+
}
|
|
4970
|
+
export interface DescribeAccessControlConfigurationResponse {
|
|
4971
|
+
/**
|
|
4972
|
+
* <p>The name for the access control configuration.</p>
|
|
4973
|
+
*/
|
|
4974
|
+
Name: string | undefined;
|
|
4975
|
+
/**
|
|
4976
|
+
* <p>The description for the access control configuration.</p>
|
|
4977
|
+
*/
|
|
4978
|
+
Description?: string;
|
|
4979
|
+
/**
|
|
4980
|
+
* <p>The error message containing details if there are issues processing the access
|
|
4981
|
+
* control configuration.</p>
|
|
4982
|
+
*/
|
|
4983
|
+
ErrorMessage?: string;
|
|
4984
|
+
/**
|
|
4985
|
+
* <p>Information on principals (users and/or groups) and which documents they
|
|
4986
|
+
* should have access to. This is useful for user context filtering, where search
|
|
4987
|
+
* results are filtered based on the user or their group access to documents.</p>
|
|
4988
|
+
*/
|
|
4989
|
+
AccessControlList?: Principal[];
|
|
4990
|
+
/**
|
|
4991
|
+
* <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a>
|
|
4992
|
+
* lists that define the hierarchy for which documents users should have access to.</p>
|
|
4993
|
+
*/
|
|
4994
|
+
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
4995
|
+
}
|
|
4996
|
+
export declare namespace DescribeAccessControlConfigurationResponse {
|
|
4997
|
+
/**
|
|
4998
|
+
* @internal
|
|
4999
|
+
*/
|
|
5000
|
+
const filterSensitiveLog: (obj: DescribeAccessControlConfigurationResponse) => any;
|
|
5001
|
+
}
|
|
4843
5002
|
export interface DescribeDataSourceRequest {
|
|
4844
5003
|
/**
|
|
4845
|
-
* <p>The
|
|
5004
|
+
* <p>The identifier of the data source.</p>
|
|
4846
5005
|
*/
|
|
4847
5006
|
Id: string | undefined;
|
|
4848
5007
|
/**
|
|
4849
|
-
* <p>The identifier of the index
|
|
5008
|
+
* <p>The identifier of the index used with the data source.</p>
|
|
4850
5009
|
*/
|
|
4851
5010
|
IndexId: string | undefined;
|
|
4852
5011
|
}
|
|
@@ -4881,8 +5040,9 @@ export interface DescribeDataSourceResponse {
|
|
|
4881
5040
|
*/
|
|
4882
5041
|
Type?: DataSourceType | string;
|
|
4883
5042
|
/**
|
|
4884
|
-
* <p>
|
|
4885
|
-
*
|
|
5043
|
+
* <p>Configuration details for the data source. This shows how the
|
|
5044
|
+
* data source is configured. The configuration options for a data
|
|
5045
|
+
* source depend on the data source provider.</p>
|
|
4886
5046
|
*/
|
|
4887
5047
|
Configuration?: DataSourceConfiguration;
|
|
4888
5048
|
/**
|
|
@@ -4894,7 +5054,7 @@ export interface DescribeDataSourceResponse {
|
|
|
4894
5054
|
*/
|
|
4895
5055
|
UpdatedAt?: Date;
|
|
4896
5056
|
/**
|
|
4897
|
-
* <p>The description
|
|
5057
|
+
* <p>The description for the data source.</p>
|
|
4898
5058
|
*/
|
|
4899
5059
|
Description?: string;
|
|
4900
5060
|
/**
|
|
@@ -4949,8 +5109,7 @@ export interface DescribeExperienceRequest {
|
|
|
4949
5109
|
*/
|
|
4950
5110
|
Id: string | undefined;
|
|
4951
5111
|
/**
|
|
4952
|
-
* <p>The identifier of the index for your Amazon Kendra experience
|
|
4953
|
-
* information on.</p>
|
|
5112
|
+
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
4954
5113
|
*/
|
|
4955
5114
|
IndexId: string | undefined;
|
|
4956
5115
|
}
|
|
@@ -5055,11 +5214,11 @@ export declare namespace DescribeExperienceResponse {
|
|
|
5055
5214
|
}
|
|
5056
5215
|
export interface DescribeFaqRequest {
|
|
5057
5216
|
/**
|
|
5058
|
-
* <p>The
|
|
5217
|
+
* <p>The identifier of the FAQ you want to get information on.</p>
|
|
5059
5218
|
*/
|
|
5060
5219
|
Id: string | undefined;
|
|
5061
5220
|
/**
|
|
5062
|
-
* <p>The identifier of the index
|
|
5221
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
5063
5222
|
*/
|
|
5064
5223
|
IndexId: string | undefined;
|
|
5065
5224
|
}
|
|
@@ -5082,7 +5241,7 @@ export interface DescribeFaqResponse {
|
|
|
5082
5241
|
*/
|
|
5083
5242
|
Id?: string;
|
|
5084
5243
|
/**
|
|
5085
|
-
* <p>The identifier of the index
|
|
5244
|
+
* <p>The identifier of the index for the FAQ.</p>
|
|
5086
5245
|
*/
|
|
5087
5246
|
IndexId?: string;
|
|
5088
5247
|
/**
|
|
@@ -5142,7 +5301,7 @@ export declare namespace DescribeFaqResponse {
|
|
|
5142
5301
|
}
|
|
5143
5302
|
export interface DescribeIndexRequest {
|
|
5144
5303
|
/**
|
|
5145
|
-
* <p>The identifier of the index to
|
|
5304
|
+
* <p>The identifier of the index you want to get information on.</p>
|
|
5146
5305
|
*/
|
|
5147
5306
|
Id: string | undefined;
|
|
5148
5307
|
}
|
|
@@ -5192,7 +5351,7 @@ export declare enum Order {
|
|
|
5192
5351
|
DESCENDING = "DESCENDING"
|
|
5193
5352
|
}
|
|
5194
5353
|
/**
|
|
5195
|
-
* <p>Provides information for
|
|
5354
|
+
* <p>Provides information for tuning the relevance of a field
|
|
5196
5355
|
* in a search. When a query includes terms that match the field, the
|
|
5197
5356
|
* results are given a boost in the response based on these tuning
|
|
5198
5357
|
* parameters.</p>
|
|
@@ -5303,7 +5462,8 @@ export declare enum DocumentAttributeValueType {
|
|
|
5303
5462
|
STRING_VALUE = "STRING_VALUE"
|
|
5304
5463
|
}
|
|
5305
5464
|
/**
|
|
5306
|
-
* <p>Specifies the properties
|
|
5465
|
+
* <p>Specifies the properties, such as relevance tuning
|
|
5466
|
+
* and searchability, of an index field.</p>
|
|
5307
5467
|
*/
|
|
5308
5468
|
export interface DocumentMetadataConfiguration {
|
|
5309
5469
|
/**
|
|
@@ -5315,7 +5475,7 @@ export interface DocumentMetadataConfiguration {
|
|
|
5315
5475
|
*/
|
|
5316
5476
|
Type: DocumentAttributeValueType | string | undefined;
|
|
5317
5477
|
/**
|
|
5318
|
-
* <p>Provides
|
|
5478
|
+
* <p>Provides tuning parameters to determine how the field
|
|
5319
5479
|
* affects the search results.</p>
|
|
5320
5480
|
*/
|
|
5321
5481
|
Relevance?: Relevance;
|
|
@@ -5442,8 +5602,9 @@ export interface DescribeIndexResponse {
|
|
|
5442
5602
|
*/
|
|
5443
5603
|
UpdatedAt?: Date;
|
|
5444
5604
|
/**
|
|
5445
|
-
* <p>Configuration
|
|
5446
|
-
* the
|
|
5605
|
+
* <p>Configuration information for document metadata or fields. Document metadata
|
|
5606
|
+
* are fields or attributes associated with your documents. For example, the company
|
|
5607
|
+
* department name associated with each document.</p>
|
|
5447
5608
|
*/
|
|
5448
5609
|
DocumentMetadataConfigurations?: DocumentMetadataConfiguration[];
|
|
5449
5610
|
/**
|
|
@@ -5476,7 +5637,7 @@ export interface DescribeIndexResponse {
|
|
|
5476
5637
|
*/
|
|
5477
5638
|
UserContextPolicy?: UserContextPolicy | string;
|
|
5478
5639
|
/**
|
|
5479
|
-
* <p>
|
|
5640
|
+
* <p>Whether you have enabled the configuration for fetching access
|
|
5480
5641
|
* levels of groups and users from an Amazon Web Services Single Sign On identity source.</p>
|
|
5481
5642
|
*/
|
|
5482
5643
|
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
@@ -5521,7 +5682,7 @@ export declare enum PrincipalMappingStatus {
|
|
|
5521
5682
|
SUCCEEDED = "SUCCEEDED"
|
|
5522
5683
|
}
|
|
5523
5684
|
/**
|
|
5524
|
-
* <p>
|
|
5685
|
+
* <p>Summary information on the processing of <code>PUT</code> and <code>DELETE</code> actions
|
|
5525
5686
|
* for mapping users to their groups.</p>
|
|
5526
5687
|
*/
|
|
5527
5688
|
export interface GroupOrderingIdSummary {
|
|
@@ -5619,7 +5780,7 @@ export interface DescribeQuerySuggestionsBlockListRequest {
|
|
|
5619
5780
|
*/
|
|
5620
5781
|
IndexId: string | undefined;
|
|
5621
5782
|
/**
|
|
5622
|
-
* <p>The
|
|
5783
|
+
* <p>The identifier of the block list you want to get information on.</p>
|
|
5623
5784
|
*/
|
|
5624
5785
|
Id: string | undefined;
|
|
5625
5786
|
}
|
|
@@ -5639,37 +5800,37 @@ export declare enum QuerySuggestionsBlockListStatus {
|
|
|
5639
5800
|
}
|
|
5640
5801
|
export interface DescribeQuerySuggestionsBlockListResponse {
|
|
5641
5802
|
/**
|
|
5642
|
-
* <p>
|
|
5803
|
+
* <p>The identifier of the index for the block list.</p>
|
|
5643
5804
|
*/
|
|
5644
5805
|
IndexId?: string;
|
|
5645
5806
|
/**
|
|
5646
|
-
* <p>
|
|
5807
|
+
* <p>The identifier of the block list.</p>
|
|
5647
5808
|
*/
|
|
5648
5809
|
Id?: string;
|
|
5649
5810
|
/**
|
|
5650
|
-
* <p>
|
|
5811
|
+
* <p>The name of the block list.</p>
|
|
5651
5812
|
*/
|
|
5652
5813
|
Name?: string;
|
|
5653
5814
|
/**
|
|
5654
|
-
* <p>
|
|
5815
|
+
* <p>The description for the block list.</p>
|
|
5655
5816
|
*/
|
|
5656
5817
|
Description?: string;
|
|
5657
5818
|
/**
|
|
5658
|
-
* <p>
|
|
5659
|
-
* <code>ACTIVE</code
|
|
5819
|
+
* <p>The current status of the block list. When the value is
|
|
5820
|
+
* <code>ACTIVE</code>, the block list is ready for use.</p>
|
|
5660
5821
|
*/
|
|
5661
5822
|
Status?: QuerySuggestionsBlockListStatus | string;
|
|
5662
5823
|
/**
|
|
5663
|
-
* <p>
|
|
5664
|
-
*
|
|
5824
|
+
* <p>The error message containing details if there are issues processing
|
|
5825
|
+
* the block list.</p>
|
|
5665
5826
|
*/
|
|
5666
5827
|
ErrorMessage?: string;
|
|
5667
5828
|
/**
|
|
5668
|
-
* <p>
|
|
5829
|
+
* <p>The date-time a block list for query suggestions was created.</p>
|
|
5669
5830
|
*/
|
|
5670
5831
|
CreatedAt?: Date;
|
|
5671
5832
|
/**
|
|
5672
|
-
* <p>
|
|
5833
|
+
* <p>The date-time a block list for query suggestions was last updated.</p>
|
|
5673
5834
|
*/
|
|
5674
5835
|
UpdatedAt?: Date;
|
|
5675
5836
|
/**
|
|
@@ -5681,16 +5842,16 @@ export interface DescribeQuerySuggestionsBlockListResponse {
|
|
|
5681
5842
|
*/
|
|
5682
5843
|
SourceS3Path?: S3Path;
|
|
5683
5844
|
/**
|
|
5684
|
-
* <p>
|
|
5845
|
+
* <p>The current number of valid, non-empty words or phrases in
|
|
5685
5846
|
* the block list text file.</p>
|
|
5686
5847
|
*/
|
|
5687
5848
|
ItemCount?: number;
|
|
5688
5849
|
/**
|
|
5689
|
-
* <p>
|
|
5850
|
+
* <p>The current size of the block list text file in S3.</p>
|
|
5690
5851
|
*/
|
|
5691
5852
|
FileSizeBytes?: number;
|
|
5692
5853
|
/**
|
|
5693
|
-
* <p>
|
|
5854
|
+
* <p>The IAM (Identity and Access Management) role used by
|
|
5694
5855
|
* Amazon Kendra to access the block list text file in S3.</p>
|
|
5695
5856
|
* <p>The role needs S3 read permissions to your file in S3 and needs to
|
|
5696
5857
|
* give STS (Security Token Service) assume role permissions to
|
|
@@ -5706,8 +5867,8 @@ export declare namespace DescribeQuerySuggestionsBlockListResponse {
|
|
|
5706
5867
|
}
|
|
5707
5868
|
export interface DescribeQuerySuggestionsConfigRequest {
|
|
5708
5869
|
/**
|
|
5709
|
-
* <p>The identifier of the index you want to
|
|
5710
|
-
*
|
|
5870
|
+
* <p>The identifier of the index with query suggestions that you want to get
|
|
5871
|
+
* information on.</p>
|
|
5711
5872
|
*/
|
|
5712
5873
|
IndexId: string | undefined;
|
|
5713
5874
|
}
|
|
@@ -5727,7 +5888,7 @@ export declare enum QuerySuggestionsStatus {
|
|
|
5727
5888
|
}
|
|
5728
5889
|
export interface DescribeQuerySuggestionsConfigResponse {
|
|
5729
5890
|
/**
|
|
5730
|
-
* <p>
|
|
5891
|
+
* <p>Whether query suggestions are currently in
|
|
5731
5892
|
* <code>ENABLED</code> mode or <code>LEARN_ONLY</code> mode.</p>
|
|
5732
5893
|
* <p>By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code>
|
|
5733
5894
|
* turns off query suggestions for your users. You can change the mode using
|
|
@@ -5736,38 +5897,39 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5736
5897
|
*/
|
|
5737
5898
|
Mode?: Mode | string;
|
|
5738
5899
|
/**
|
|
5739
|
-
* <p>
|
|
5740
|
-
*
|
|
5900
|
+
* <p>Whether the status of query suggestions settings is currently
|
|
5901
|
+
* <code>ACTIVE</code> or <code>UPDATING</code>.</p>
|
|
5741
5902
|
* <p>Active means the current settings apply and Updating means your
|
|
5742
5903
|
* changed settings are in the process of applying.</p>
|
|
5743
5904
|
*/
|
|
5744
5905
|
Status?: QuerySuggestionsStatus | string;
|
|
5745
5906
|
/**
|
|
5746
|
-
* <p>
|
|
5907
|
+
* <p>How recent your queries are in your query log time
|
|
5747
5908
|
* window (in days).</p>
|
|
5748
5909
|
*/
|
|
5749
5910
|
QueryLogLookBackWindowInDays?: number;
|
|
5750
5911
|
/**
|
|
5751
|
-
* <p>
|
|
5752
|
-
*
|
|
5912
|
+
* <p>
|
|
5913
|
+
* <code>TRUE</code> to use all queries, otherwise use only queries that include
|
|
5914
|
+
* user information to generate the query suggestions.</p>
|
|
5753
5915
|
*/
|
|
5754
5916
|
IncludeQueriesWithoutUserInformation?: boolean;
|
|
5755
5917
|
/**
|
|
5756
|
-
* <p>
|
|
5918
|
+
* <p>The minimum number of unique users who must search a query in
|
|
5757
5919
|
* order for the query to be eligible to suggest to your users.</p>
|
|
5758
5920
|
*/
|
|
5759
5921
|
MinimumNumberOfQueryingUsers?: number;
|
|
5760
5922
|
/**
|
|
5761
|
-
* <p>
|
|
5923
|
+
* <p>The minimum number of times a query must be searched in order for
|
|
5762
5924
|
* the query to be eligible to suggest to your users.</p>
|
|
5763
5925
|
*/
|
|
5764
5926
|
MinimumQueryCount?: number;
|
|
5765
5927
|
/**
|
|
5766
|
-
* <p>
|
|
5928
|
+
* <p>The date-time query suggestions for an index was last updated.</p>
|
|
5767
5929
|
*/
|
|
5768
5930
|
LastSuggestionsBuildTime?: Date;
|
|
5769
5931
|
/**
|
|
5770
|
-
* <p>
|
|
5932
|
+
* <p>The date-time query suggestions for an index was last cleared.</p>
|
|
5771
5933
|
* <p>After you clear suggestions, Amazon Kendra learns new suggestions based
|
|
5772
5934
|
* on new queries added to the query log from the time you cleared suggestions.
|
|
5773
5935
|
* Amazon Kendra only considers re-occurences of a query from the time you cleared
|
|
@@ -5775,7 +5937,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
5775
5937
|
*/
|
|
5776
5938
|
LastClearTime?: Date;
|
|
5777
5939
|
/**
|
|
5778
|
-
* <p>
|
|
5940
|
+
* <p>The current total count of query suggestions for an index.</p>
|
|
5779
5941
|
* <p>This count can change when you update your query suggestions settings,
|
|
5780
5942
|
* if you filter out certain queries from suggestions using a block list,
|
|
5781
5943
|
* and as the query log accumulates more queries for Amazon Kendra to learn from.</p>
|
|
@@ -5790,11 +5952,11 @@ export declare namespace DescribeQuerySuggestionsConfigResponse {
|
|
|
5790
5952
|
}
|
|
5791
5953
|
export interface DescribeThesaurusRequest {
|
|
5792
5954
|
/**
|
|
5793
|
-
* <p>The identifier of the thesaurus to
|
|
5955
|
+
* <p>The identifier of the thesaurus you want to get information on.</p>
|
|
5794
5956
|
*/
|
|
5795
5957
|
Id: string | undefined;
|
|
5796
5958
|
/**
|
|
5797
|
-
* <p>The identifier of the index
|
|
5959
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
5798
5960
|
*/
|
|
5799
5961
|
IndexId: string | undefined;
|
|
5800
5962
|
}
|
|
@@ -5818,7 +5980,7 @@ export interface DescribeThesaurusResponse {
|
|
|
5818
5980
|
*/
|
|
5819
5981
|
Id?: string;
|
|
5820
5982
|
/**
|
|
5821
|
-
* <p>The identifier of the index
|
|
5983
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
5822
5984
|
*/
|
|
5823
5985
|
IndexId?: string;
|
|
5824
5986
|
/**
|
|
@@ -6218,9 +6380,50 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
6218
6380
|
*/
|
|
6219
6381
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
6220
6382
|
}
|
|
6383
|
+
export interface ListAccessControlConfigurationsRequest {
|
|
6384
|
+
/**
|
|
6385
|
+
* <p>The identifier of the index for the access control configuration.</p>
|
|
6386
|
+
*/
|
|
6387
|
+
IndexId: string | undefined;
|
|
6388
|
+
/**
|
|
6389
|
+
* <p>If the previous response was incomplete (because
|
|
6390
|
+
* there's more data to retrieve), Amazon Kendra returns a pagination token
|
|
6391
|
+
* in the response. You can use this pagination token to retrieve the next set
|
|
6392
|
+
* of access control configurations.</p>
|
|
6393
|
+
*/
|
|
6394
|
+
NextToken?: string;
|
|
6395
|
+
/**
|
|
6396
|
+
* <p>The maximum number of access control configurations to return.</p>
|
|
6397
|
+
*/
|
|
6398
|
+
MaxResults?: number;
|
|
6399
|
+
}
|
|
6400
|
+
export declare namespace ListAccessControlConfigurationsRequest {
|
|
6401
|
+
/**
|
|
6402
|
+
* @internal
|
|
6403
|
+
*/
|
|
6404
|
+
const filterSensitiveLog: (obj: ListAccessControlConfigurationsRequest) => any;
|
|
6405
|
+
}
|
|
6406
|
+
export interface ListAccessControlConfigurationsResponse {
|
|
6407
|
+
/**
|
|
6408
|
+
* <p>If the response is truncated, Amazon Kendra returns this
|
|
6409
|
+
* token, which you can use in the subsequent request to retrieve the
|
|
6410
|
+
* next set of access control configurations.</p>
|
|
6411
|
+
*/
|
|
6412
|
+
NextToken?: string;
|
|
6413
|
+
/**
|
|
6414
|
+
* <p>The details of your access control configurations.</p>
|
|
6415
|
+
*/
|
|
6416
|
+
AccessControlConfigurations: AccessControlConfigurationSummary[] | undefined;
|
|
6417
|
+
}
|
|
6418
|
+
export declare namespace ListAccessControlConfigurationsResponse {
|
|
6419
|
+
/**
|
|
6420
|
+
* @internal
|
|
6421
|
+
*/
|
|
6422
|
+
const filterSensitiveLog: (obj: ListAccessControlConfigurationsResponse) => any;
|
|
6423
|
+
}
|
|
6221
6424
|
export interface ListDataSourcesRequest {
|
|
6222
6425
|
/**
|
|
6223
|
-
* <p>The identifier of the index
|
|
6426
|
+
* <p>The identifier of the index used with one or more data sources.</p>
|
|
6224
6427
|
*/
|
|
6225
6428
|
IndexId: string | undefined;
|
|
6226
6429
|
/**
|
|
@@ -6319,7 +6522,7 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
6319
6522
|
*/
|
|
6320
6523
|
Id: string | undefined;
|
|
6321
6524
|
/**
|
|
6322
|
-
* <p>The identifier of the index
|
|
6525
|
+
* <p>The identifier of the index used with the data source.</p>
|
|
6323
6526
|
*/
|
|
6324
6527
|
IndexId: string | undefined;
|
|
6325
6528
|
/**
|
|
@@ -6739,8 +6942,8 @@ export declare namespace ListFaqsRequest {
|
|
|
6739
6942
|
const filterSensitiveLog: (obj: ListFaqsRequest) => any;
|
|
6740
6943
|
}
|
|
6741
6944
|
/**
|
|
6742
|
-
* <p>
|
|
6743
|
-
*
|
|
6945
|
+
* <p>Summary information for frequently asked questions and answers
|
|
6946
|
+
* included in an index.</p>
|
|
6744
6947
|
*/
|
|
6745
6948
|
export interface FaqSummary {
|
|
6746
6949
|
/**
|
|
@@ -6841,22 +7044,16 @@ export declare namespace ListGroupsOlderThanOrderingIdRequest {
|
|
|
6841
7044
|
const filterSensitiveLog: (obj: ListGroupsOlderThanOrderingIdRequest) => any;
|
|
6842
7045
|
}
|
|
6843
7046
|
/**
|
|
6844
|
-
* <p>
|
|
6845
|
-
* Group summary information.
|
|
6846
|
-
* </p>
|
|
7047
|
+
* <p>Summary information for groups.</p>
|
|
6847
7048
|
*/
|
|
6848
7049
|
export interface GroupSummary {
|
|
6849
7050
|
/**
|
|
6850
|
-
* <p>
|
|
6851
|
-
* The identifier of the group you want group summary information on.
|
|
6852
|
-
* </p>
|
|
7051
|
+
* <p>The identifier of the group you want group summary information on.</p>
|
|
6853
7052
|
*/
|
|
6854
7053
|
GroupId?: string;
|
|
6855
7054
|
/**
|
|
6856
|
-
* <p>
|
|
6857
|
-
*
|
|
6858
|
-
* action.
|
|
6859
|
-
* </p>
|
|
7055
|
+
* <p>The timestamp identifier used for the latest <code>PUT</code> or <code>DELETE</code>
|
|
7056
|
+
* action.</p>
|
|
6860
7057
|
*/
|
|
6861
7058
|
OrderingId?: number;
|
|
6862
7059
|
}
|
|
@@ -6909,7 +7106,7 @@ export declare namespace ListIndicesRequest {
|
|
|
6909
7106
|
const filterSensitiveLog: (obj: ListIndicesRequest) => any;
|
|
6910
7107
|
}
|
|
6911
7108
|
/**
|
|
6912
|
-
* <p>
|
|
7109
|
+
* <p>Summary information on the configuration of an index.</p>
|
|
6913
7110
|
*/
|
|
6914
7111
|
export interface IndexConfigurationSummary {
|
|
6915
7112
|
/**
|
|
@@ -7097,7 +7294,7 @@ export declare class ResourceUnavailableException extends __BaseException {
|
|
|
7097
7294
|
}
|
|
7098
7295
|
export interface ListThesauriRequest {
|
|
7099
7296
|
/**
|
|
7100
|
-
* <p>The identifier of the index
|
|
7297
|
+
* <p>The identifier of the index with one or more thesauri.</p>
|
|
7101
7298
|
*/
|
|
7102
7299
|
IndexId: string | undefined;
|
|
7103
7300
|
/**
|
|
@@ -7204,9 +7401,9 @@ export declare namespace MemberUser {
|
|
|
7204
7401
|
const filterSensitiveLog: (obj: MemberUser) => any;
|
|
7205
7402
|
}
|
|
7206
7403
|
/**
|
|
7207
|
-
* <p>A list of users or sub groups that belong to a group.
|
|
7208
|
-
*
|
|
7209
|
-
* group
|
|
7404
|
+
* <p>A list of users or sub groups that belong to a group. This is useful for
|
|
7405
|
+
* user context filtering, where search results are filtered based on the user
|
|
7406
|
+
* or their group access to documents.</p>
|
|
7210
7407
|
*/
|
|
7211
7408
|
export interface GroupMembers {
|
|
7212
7409
|
/**
|
|
@@ -7306,15 +7503,14 @@ export declare namespace PutPrincipalMappingRequest {
|
|
|
7306
7503
|
*/
|
|
7307
7504
|
export interface DocumentRelevanceConfiguration {
|
|
7308
7505
|
/**
|
|
7309
|
-
* <p>The name of the
|
|
7310
|
-
* at the index level.</p>
|
|
7506
|
+
* <p>The name of the index field.</p>
|
|
7311
7507
|
*/
|
|
7312
7508
|
Name: string | undefined;
|
|
7313
7509
|
/**
|
|
7314
|
-
* <p>Provides information for
|
|
7315
|
-
*
|
|
7316
|
-
*
|
|
7317
|
-
*
|
|
7510
|
+
* <p>Provides information for tuning the relevance of a field
|
|
7511
|
+
* in a search. When a query includes terms that match the field, the
|
|
7512
|
+
* results are given a boost in the response based on these tuning
|
|
7513
|
+
* parameters.</p>
|
|
7318
7514
|
*/
|
|
7319
7515
|
Relevance: Relevance | undefined;
|
|
7320
7516
|
}
|
|
@@ -7445,8 +7641,13 @@ export declare namespace DataSourceGroup {
|
|
|
7445
7641
|
/**
|
|
7446
7642
|
* <p>Provides information about the user context for
|
|
7447
7643
|
* an Amazon Kendra index.</p>
|
|
7448
|
-
* <p>
|
|
7449
|
-
* to documents
|
|
7644
|
+
* <p>User context filtering is a kind of personalized search with
|
|
7645
|
+
* the benefit of controlling access to documents. For example, not
|
|
7646
|
+
* all teams that search the company portal for information should
|
|
7647
|
+
* access top-secret company documents, nor are these documents
|
|
7648
|
+
* relevant to all users. Only specific users or groups of teams given
|
|
7649
|
+
* access to top-secret documents should see these documents in their
|
|
7650
|
+
* search results.</p>
|
|
7450
7651
|
* <p>You provide one of the following:</p>
|
|
7451
7652
|
* <ul>
|
|
7452
7653
|
* <li>
|
|
@@ -7839,41 +8040,86 @@ export declare namespace UntagResourceResponse {
|
|
|
7839
8040
|
*/
|
|
7840
8041
|
const filterSensitiveLog: (obj: UntagResourceResponse) => any;
|
|
7841
8042
|
}
|
|
8043
|
+
export interface UpdateAccessControlConfigurationRequest {
|
|
8044
|
+
/**
|
|
8045
|
+
* <p>The identifier of the index for an access control configuration.</p>
|
|
8046
|
+
*/
|
|
8047
|
+
IndexId: string | undefined;
|
|
8048
|
+
/**
|
|
8049
|
+
* <p>The identifier of the access control configuration you want to update.</p>
|
|
8050
|
+
*/
|
|
8051
|
+
Id: string | undefined;
|
|
8052
|
+
/**
|
|
8053
|
+
* <p>A new name for the access control configuration.</p>
|
|
8054
|
+
*/
|
|
8055
|
+
Name?: string;
|
|
8056
|
+
/**
|
|
8057
|
+
* <p>A new description for the access control configuration.</p>
|
|
8058
|
+
*/
|
|
8059
|
+
Description?: string;
|
|
8060
|
+
/**
|
|
8061
|
+
* <p>Information you want to update on principals (users and/or groups) and which
|
|
8062
|
+
* documents they should have access to. This is useful for user context filtering,
|
|
8063
|
+
* where search results are filtered based on the user or their group access to
|
|
8064
|
+
* documents.</p>
|
|
8065
|
+
*/
|
|
8066
|
+
AccessControlList?: Principal[];
|
|
8067
|
+
/**
|
|
8068
|
+
* <p>The updated list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that
|
|
8069
|
+
* define the hierarchy for which documents users should have access to.</p>
|
|
8070
|
+
*/
|
|
8071
|
+
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
8072
|
+
}
|
|
8073
|
+
export declare namespace UpdateAccessControlConfigurationRequest {
|
|
8074
|
+
/**
|
|
8075
|
+
* @internal
|
|
8076
|
+
*/
|
|
8077
|
+
const filterSensitiveLog: (obj: UpdateAccessControlConfigurationRequest) => any;
|
|
8078
|
+
}
|
|
8079
|
+
export interface UpdateAccessControlConfigurationResponse {
|
|
8080
|
+
}
|
|
8081
|
+
export declare namespace UpdateAccessControlConfigurationResponse {
|
|
8082
|
+
/**
|
|
8083
|
+
* @internal
|
|
8084
|
+
*/
|
|
8085
|
+
const filterSensitiveLog: (obj: UpdateAccessControlConfigurationResponse) => any;
|
|
8086
|
+
}
|
|
7842
8087
|
export interface UpdateDataSourceRequest {
|
|
7843
8088
|
/**
|
|
7844
|
-
* <p>The
|
|
8089
|
+
* <p>The identifier of the data source you want to update.</p>
|
|
7845
8090
|
*/
|
|
7846
8091
|
Id: string | undefined;
|
|
7847
8092
|
/**
|
|
7848
|
-
* <p>
|
|
7849
|
-
*
|
|
7850
|
-
*
|
|
8093
|
+
* <p>A new name for the data source connector. You must
|
|
8094
|
+
* first delete the data source and re-create it to change the
|
|
8095
|
+
* name of the data source.</p>
|
|
7851
8096
|
*/
|
|
7852
8097
|
Name?: string;
|
|
7853
8098
|
/**
|
|
7854
|
-
* <p>The identifier of the index
|
|
7855
|
-
* update.</p>
|
|
8099
|
+
* <p>The identifier of the index used with the data source connector.</p>
|
|
7856
8100
|
*/
|
|
7857
8101
|
IndexId: string | undefined;
|
|
7858
8102
|
/**
|
|
7859
|
-
* <p>Configuration information
|
|
8103
|
+
* <p>Configuration information you want to update for the data source connector.</p>
|
|
7860
8104
|
*/
|
|
7861
8105
|
Configuration?: DataSourceConfiguration;
|
|
7862
8106
|
/**
|
|
7863
|
-
* <p>
|
|
8107
|
+
* <p>A new description for the data source connector.</p>
|
|
7864
8108
|
*/
|
|
7865
8109
|
Description?: string;
|
|
7866
8110
|
/**
|
|
7867
|
-
* <p>The
|
|
8111
|
+
* <p>The sync schedule you want to update for the data source connector.</p>
|
|
7868
8112
|
*/
|
|
7869
8113
|
Schedule?: string;
|
|
7870
8114
|
/**
|
|
7871
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
7872
|
-
* source
|
|
8115
|
+
* <p>The Amazon Resource Name (ARN) of a role with permission to access
|
|
8116
|
+
* the data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM Roles for
|
|
8117
|
+
* Amazon Kendra</a>.</p>
|
|
7873
8118
|
*/
|
|
7874
8119
|
RoleArn?: string;
|
|
7875
8120
|
/**
|
|
7876
|
-
* <p>The code for a language
|
|
8121
|
+
* <p>The code for a language you want to update for the data source connector.
|
|
8122
|
+
* This allows you to support a language for all
|
|
7877
8123
|
* documents when updating the data source. English is supported
|
|
7878
8124
|
* by default. For more information on supported languages, including their codes,
|
|
7879
8125
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding
|
|
@@ -7881,8 +8127,8 @@ export interface UpdateDataSourceRequest {
|
|
|
7881
8127
|
*/
|
|
7882
8128
|
LanguageCode?: string;
|
|
7883
8129
|
/**
|
|
7884
|
-
* <p>Configuration information for altering document metadata
|
|
7885
|
-
*
|
|
8130
|
+
* <p>Configuration information you want to update for altering document metadata
|
|
8131
|
+
* and content during the document ingestion process.</p>
|
|
7886
8132
|
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
7887
8133
|
* other content alterations when you ingest documents into Amazon Kendra, see
|
|
7888
8134
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
@@ -7902,11 +8148,11 @@ export interface UpdateExperienceRequest {
|
|
|
7902
8148
|
*/
|
|
7903
8149
|
Id: string | undefined;
|
|
7904
8150
|
/**
|
|
7905
|
-
* <p>
|
|
8151
|
+
* <p>A new name for your Amazon Kendra experience.</p>
|
|
7906
8152
|
*/
|
|
7907
8153
|
Name?: string;
|
|
7908
8154
|
/**
|
|
7909
|
-
* <p>The identifier of the index for your Amazon Kendra experience
|
|
8155
|
+
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
7910
8156
|
*/
|
|
7911
8157
|
IndexId: string | undefined;
|
|
7912
8158
|
/**
|
|
@@ -7917,11 +8163,11 @@ export interface UpdateExperienceRequest {
|
|
|
7917
8163
|
*/
|
|
7918
8164
|
RoleArn?: string;
|
|
7919
8165
|
/**
|
|
7920
|
-
* <p>Configuration information for your Amazon Kendra
|
|
8166
|
+
* <p>Configuration information you want to update for your Amazon Kendra experience.</p>
|
|
7921
8167
|
*/
|
|
7922
8168
|
Configuration?: ExperienceConfiguration;
|
|
7923
8169
|
/**
|
|
7924
|
-
* <p>
|
|
8170
|
+
* <p>A new description for your Amazon Kendra experience.</p>
|
|
7925
8171
|
*/
|
|
7926
8172
|
Description?: string;
|
|
7927
8173
|
}
|
|
@@ -7933,16 +8179,17 @@ export declare namespace UpdateExperienceRequest {
|
|
|
7933
8179
|
}
|
|
7934
8180
|
export interface UpdateIndexRequest {
|
|
7935
8181
|
/**
|
|
7936
|
-
* <p>The identifier of the index to update.</p>
|
|
8182
|
+
* <p>The identifier of the index you want to update.</p>
|
|
7937
8183
|
*/
|
|
7938
8184
|
Id: string | undefined;
|
|
7939
8185
|
/**
|
|
7940
|
-
* <p>The name of the index to update.</p>
|
|
8186
|
+
* <p>The name of the index you want to update.</p>
|
|
7941
8187
|
*/
|
|
7942
8188
|
Name?: string;
|
|
7943
8189
|
/**
|
|
7944
|
-
* <p>
|
|
7945
|
-
* Amazon CloudWatch
|
|
8190
|
+
* <p>An Identity and Access Management (IAM) role that
|
|
8191
|
+
* gives Amazon Kendra permission to access Amazon CloudWatch
|
|
8192
|
+
* logs and metrics.</p>
|
|
7946
8193
|
*/
|
|
7947
8194
|
RoleArn?: string;
|
|
7948
8195
|
/**
|
|
@@ -7950,7 +8197,9 @@ export interface UpdateIndexRequest {
|
|
|
7950
8197
|
*/
|
|
7951
8198
|
Description?: string;
|
|
7952
8199
|
/**
|
|
7953
|
-
* <p>The document metadata you want to update
|
|
8200
|
+
* <p>The document metadata configuration you want to update for the index.
|
|
8201
|
+
* Document metadata are fields or attributes associated with your documents.
|
|
8202
|
+
* For example, the company department name associated with each document.</p>
|
|
7954
8203
|
*/
|
|
7955
8204
|
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
|
|
7956
8205
|
/**
|
|
@@ -7985,19 +8234,19 @@ export declare namespace UpdateIndexRequest {
|
|
|
7985
8234
|
}
|
|
7986
8235
|
export interface UpdateQuerySuggestionsBlockListRequest {
|
|
7987
8236
|
/**
|
|
7988
|
-
* <p>The identifier of the index for
|
|
8237
|
+
* <p>The identifier of the index for the block list.</p>
|
|
7989
8238
|
*/
|
|
7990
8239
|
IndexId: string | undefined;
|
|
7991
8240
|
/**
|
|
7992
|
-
* <p>The
|
|
8241
|
+
* <p>The identifier of the block list you want to update.</p>
|
|
7993
8242
|
*/
|
|
7994
8243
|
Id: string | undefined;
|
|
7995
8244
|
/**
|
|
7996
|
-
* <p>
|
|
8245
|
+
* <p>A new name for the block list.</p>
|
|
7997
8246
|
*/
|
|
7998
8247
|
Name?: string;
|
|
7999
8248
|
/**
|
|
8000
|
-
* <p>
|
|
8249
|
+
* <p>A new description for the block list.</p>
|
|
8001
8250
|
*/
|
|
8002
8251
|
Description?: string;
|
|
8003
8252
|
/**
|
|
@@ -8026,7 +8275,7 @@ export declare namespace UpdateQuerySuggestionsBlockListRequest {
|
|
|
8026
8275
|
}
|
|
8027
8276
|
export interface UpdateQuerySuggestionsConfigRequest {
|
|
8028
8277
|
/**
|
|
8029
|
-
* <p>The identifier of the index you want to update
|
|
8278
|
+
* <p> The identifier of the index with query suggestions you want to update.</p>
|
|
8030
8279
|
*/
|
|
8031
8280
|
IndexId: string | undefined;
|
|
8032
8281
|
/**
|
|
@@ -8086,23 +8335,24 @@ export declare namespace UpdateQuerySuggestionsConfigRequest {
|
|
|
8086
8335
|
}
|
|
8087
8336
|
export interface UpdateThesaurusRequest {
|
|
8088
8337
|
/**
|
|
8089
|
-
* <p>The identifier of the thesaurus to update.</p>
|
|
8338
|
+
* <p>The identifier of the thesaurus you want to update.</p>
|
|
8090
8339
|
*/
|
|
8091
8340
|
Id: string | undefined;
|
|
8092
8341
|
/**
|
|
8093
|
-
* <p>
|
|
8342
|
+
* <p>A new name for the thesaurus.</p>
|
|
8094
8343
|
*/
|
|
8095
8344
|
Name?: string;
|
|
8096
8345
|
/**
|
|
8097
|
-
* <p>The identifier of the index
|
|
8346
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
8098
8347
|
*/
|
|
8099
8348
|
IndexId: string | undefined;
|
|
8100
8349
|
/**
|
|
8101
|
-
* <p>
|
|
8350
|
+
* <p>A new description for the thesaurus.</p>
|
|
8102
8351
|
*/
|
|
8103
8352
|
Description?: string;
|
|
8104
8353
|
/**
|
|
8105
|
-
* <p>
|
|
8354
|
+
* <p>An IAM role that gives Amazon Kendra permissions to
|
|
8355
|
+
* access thesaurus file specified in <code>SourceS3Path</code>.</p>
|
|
8106
8356
|
*/
|
|
8107
8357
|
RoleArn?: string;
|
|
8108
8358
|
/**
|
|
@@ -8312,138 +8562,3 @@ export declare namespace AttributeFilter {
|
|
|
8312
8562
|
*/
|
|
8313
8563
|
const filterSensitiveLog: (obj: AttributeFilter) => any;
|
|
8314
8564
|
}
|
|
8315
|
-
export interface QueryResult {
|
|
8316
|
-
/**
|
|
8317
|
-
* <p>The unique identifier for the search. You use <code>QueryId</code>
|
|
8318
|
-
* to identify the search when using the feedback API.</p>
|
|
8319
|
-
*/
|
|
8320
|
-
QueryId?: string;
|
|
8321
|
-
/**
|
|
8322
|
-
* <p>The results of the search.</p>
|
|
8323
|
-
*/
|
|
8324
|
-
ResultItems?: QueryResultItem[];
|
|
8325
|
-
/**
|
|
8326
|
-
* <p>Contains the facet results. A <code>FacetResult</code> contains the
|
|
8327
|
-
* counts for each attribute key that was specified in the
|
|
8328
|
-
* <code>Facets</code> input parameter.</p>
|
|
8329
|
-
*/
|
|
8330
|
-
FacetResults?: FacetResult[];
|
|
8331
|
-
/**
|
|
8332
|
-
* <p>The total number of items found by the search; however, you can only
|
|
8333
|
-
* retrieve up to 100 items. For example, if the search found 192 items,
|
|
8334
|
-
* you can only retrieve the first 100 of the items.</p>
|
|
8335
|
-
*/
|
|
8336
|
-
TotalNumberOfResults?: number;
|
|
8337
|
-
/**
|
|
8338
|
-
* <p>A list of warning codes and their messages on problems with your query.</p>
|
|
8339
|
-
* <p>Amazon Kendra currently only supports one type of warning, which is a warning
|
|
8340
|
-
* on invalid syntax used in the query. For examples of invalid query syntax,
|
|
8341
|
-
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching
|
|
8342
|
-
* with advanced query syntax</a>.</p>
|
|
8343
|
-
*/
|
|
8344
|
-
Warnings?: Warning[];
|
|
8345
|
-
/**
|
|
8346
|
-
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
8347
|
-
*/
|
|
8348
|
-
SpellCorrectedQueries?: SpellCorrectedQuery[];
|
|
8349
|
-
}
|
|
8350
|
-
export declare namespace QueryResult {
|
|
8351
|
-
/**
|
|
8352
|
-
* @internal
|
|
8353
|
-
*/
|
|
8354
|
-
const filterSensitiveLog: (obj: QueryResult) => any;
|
|
8355
|
-
}
|
|
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
|
-
}
|