@aws-sdk/client-kendra 3.51.0 → 3.52.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 +11 -0
- package/dist-cjs/models/models_0.js +16 -5
- package/dist-cjs/protocols/Aws_json1_1.js +50 -0
- package/dist-es/models/models_0.js +9 -0
- package/dist-es/protocols/Aws_json1_1.js +42 -1
- package/dist-types/Kendra.d.ts +17 -17
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +5 -5
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +2 -2
- package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/QueryCommand.d.ts +2 -2
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +158 -71
- package/dist-types/ts3.4/models/models_0.d.ts +27 -0
- package/package.json +33 -33
|
@@ -34,7 +34,7 @@ export interface AclConfiguration {
|
|
|
34
34
|
* response based on user context. The document is only returned to
|
|
35
35
|
* users that are in one of the groups specified in the
|
|
36
36
|
* <code>UserContext</code> field of the <code>Query</code>
|
|
37
|
-
*
|
|
37
|
+
* API.</p>
|
|
38
38
|
*/
|
|
39
39
|
AllowedGroupsColumnName: string | undefined;
|
|
40
40
|
}
|
|
@@ -494,7 +494,7 @@ export declare enum ErrorCode {
|
|
|
494
494
|
/**
|
|
495
495
|
* <p>Provides information about documents that could not be removed
|
|
496
496
|
* from an index by the <code>BatchDeleteDocument</code>
|
|
497
|
-
*
|
|
497
|
+
* API.</p>
|
|
498
498
|
*/
|
|
499
499
|
export interface BatchDeleteDocumentResponseFailedDocument {
|
|
500
500
|
/**
|
|
@@ -597,8 +597,8 @@ export declare namespace DocumentInfo {
|
|
|
597
597
|
export interface BatchGetDocumentStatusRequest {
|
|
598
598
|
/**
|
|
599
599
|
* <p>The identifier of the index to add documents to. The index ID is
|
|
600
|
-
* returned by the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html">
|
|
601
|
-
* </a>
|
|
600
|
+
* returned by the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html">CreateIndex
|
|
601
|
+
* </a> API.</p>
|
|
602
602
|
*/
|
|
603
603
|
IndexId: string | undefined;
|
|
604
604
|
/**
|
|
@@ -1008,7 +1008,7 @@ export interface Document {
|
|
|
1008
1008
|
* <p>The contents of the document. </p>
|
|
1009
1009
|
* <p>Documents passed to the <code>Blob</code> parameter must be base64
|
|
1010
1010
|
* encoded. Your code might not need to encode the document file bytes
|
|
1011
|
-
* if you're using an Amazon Web Services SDK to call Amazon Kendra
|
|
1011
|
+
* if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are
|
|
1012
1012
|
* calling the Amazon Kendra endpoint directly using REST, you must base64
|
|
1013
1013
|
* encode the contents before sending.</p>
|
|
1014
1014
|
*/
|
|
@@ -1023,6 +1023,11 @@ export interface Document {
|
|
|
1023
1023
|
* attributes to provide additional information for searching, to
|
|
1024
1024
|
* provide facets for refining searches, and to provide additional
|
|
1025
1025
|
* information in the query response.</p>
|
|
1026
|
+
* <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom
|
|
1027
|
+
* attributes that provide information on the synchronization
|
|
1028
|
+
* of documents running on a data source. Note,
|
|
1029
|
+
* 'DataSourceSyncJobId' could be an optional custom attribute
|
|
1030
|
+
* as Amazon Kendra will use the ID of a running sync job.</p>
|
|
1026
1031
|
*/
|
|
1027
1032
|
Attributes?: DocumentAttribute[];
|
|
1028
1033
|
/**
|
|
@@ -1051,24 +1056,18 @@ export interface BatchPutDocumentRequest {
|
|
|
1051
1056
|
/**
|
|
1052
1057
|
* <p>The identifier of the index to add the documents to. You need to
|
|
1053
1058
|
* create the index first using the <code>CreateIndex</code>
|
|
1054
|
-
*
|
|
1059
|
+
* API.</p>
|
|
1055
1060
|
*/
|
|
1056
1061
|
IndexId: string | undefined;
|
|
1057
1062
|
/**
|
|
1058
1063
|
* <p>The Amazon Resource Name (ARN) of a role that is allowed to run the
|
|
1059
|
-
* <code>BatchPutDocument</code>
|
|
1064
|
+
* <code>BatchPutDocument</code> API. For more information, see
|
|
1060
1065
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM
|
|
1061
|
-
*
|
|
1066
|
+
* Roles for Amazon Kendra</a>.</p>
|
|
1062
1067
|
*/
|
|
1063
1068
|
RoleArn?: string;
|
|
1064
1069
|
/**
|
|
1065
1070
|
* <p>One or more documents to add to the index.</p>
|
|
1066
|
-
* <p>Documents can include custom attributes. For example,
|
|
1067
|
-
* 'DataSourceId' and 'DataSourceSyncJobId' are custom
|
|
1068
|
-
* attributes that provide information on the synchronization
|
|
1069
|
-
* of documents running on a data source. Note,
|
|
1070
|
-
* 'DataSourceSyncJobId' could be an optional custom attribute
|
|
1071
|
-
* as Amazon Kendra will use the ID of a running sync job.</p>
|
|
1072
1071
|
* <p>Documents have the following file size limits.</p>
|
|
1073
1072
|
* <ul>
|
|
1074
1073
|
* <li>
|
|
@@ -1088,7 +1087,7 @@ export interface BatchPutDocumentRequest {
|
|
|
1088
1087
|
/**
|
|
1089
1088
|
* <p>Configuration information for altering your document metadata and content during
|
|
1090
1089
|
* the document ingestion process when you use the <code>BatchPutDocument</code>
|
|
1091
|
-
*
|
|
1090
|
+
* API.</p>
|
|
1092
1091
|
* <p>For more information on how to create, modify and delete document metadata,
|
|
1093
1092
|
* or make other content alterations when you ingest documents into Amazon Kendra, see
|
|
1094
1093
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
@@ -1184,13 +1183,13 @@ export declare enum ConfluenceAttachmentFieldName {
|
|
|
1184
1183
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1185
1184
|
* to a Amazon Kendra index field.</p>
|
|
1186
1185
|
* <p>You must first create the index field using the
|
|
1187
|
-
* <code>UpdateIndex</code>
|
|
1186
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1188
1187
|
*/
|
|
1189
1188
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
1190
1189
|
/**
|
|
1191
1190
|
* <p>The name of the field in the data source. </p>
|
|
1192
1191
|
* <p>You must first create the index field using the
|
|
1193
|
-
* <code>UpdateIndex</code>
|
|
1192
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1194
1193
|
*/
|
|
1195
1194
|
DataSourceFieldName?: ConfluenceAttachmentFieldName | string;
|
|
1196
1195
|
/**
|
|
@@ -1228,7 +1227,7 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
1228
1227
|
* <p>Defines how attachment metadata fields should be mapped to index
|
|
1229
1228
|
* fields. Before you can map a field, you must first create an index
|
|
1230
1229
|
* field with a matching type using the console or the
|
|
1231
|
-
* <code>UpdateIndex</code>
|
|
1230
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1232
1231
|
* <p>If you specify the <code>AttachentFieldMappings</code> parameter,
|
|
1233
1232
|
* you must specify at least one field mapping.</p>
|
|
1234
1233
|
*/
|
|
@@ -1255,7 +1254,7 @@ export declare enum ConfluenceBlogFieldName {
|
|
|
1255
1254
|
* <p>Defines the mapping between a blog field in the Confluence data
|
|
1256
1255
|
* source to a Amazon Kendra index field.</p>
|
|
1257
1256
|
* <p>You must first create the index field using the
|
|
1258
|
-
* <code>UpdateIndex</code>
|
|
1257
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1259
1258
|
*/
|
|
1260
1259
|
export interface ConfluenceBlogToIndexFieldMapping {
|
|
1261
1260
|
/**
|
|
@@ -1286,14 +1285,14 @@ export declare namespace ConfluenceBlogToIndexFieldMapping {
|
|
|
1286
1285
|
* <p>Specifies the blog settings for the Confluence data source. Blogs
|
|
1287
1286
|
* are always indexed unless filtered from the index by the
|
|
1288
1287
|
* <code>ExclusionPatterns</code> or <code>InclusionPatterns</code>
|
|
1289
|
-
* fields in the <code>ConfluenceConfiguration</code>
|
|
1288
|
+
* fields in the <code>ConfluenceConfiguration</code> object.</p>
|
|
1290
1289
|
*/
|
|
1291
1290
|
export interface ConfluenceBlogConfiguration {
|
|
1292
1291
|
/**
|
|
1293
1292
|
* <p>Defines how blog metadata fields should be mapped to index fields.
|
|
1294
1293
|
* Before you can map a field, you must first create an index field
|
|
1295
1294
|
* with a matching type using the console or the
|
|
1296
|
-
* <code>UpdateIndex</code>
|
|
1295
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1297
1296
|
* <p>If you specify the <code>BlogFieldMappings</code> parameter, you
|
|
1298
1297
|
* must specify at least one field mapping.</p>
|
|
1299
1298
|
*/
|
|
@@ -1323,7 +1322,7 @@ export declare enum ConfluencePageFieldName {
|
|
|
1323
1322
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1324
1323
|
* to a Amazon Kendra index field.</p>
|
|
1325
1324
|
* <p>You must first create the index field using the
|
|
1326
|
-
* <code>UpdateIndex</code>
|
|
1325
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1327
1326
|
*/
|
|
1328
1327
|
export interface ConfluencePageToIndexFieldMapping {
|
|
1329
1328
|
/**
|
|
@@ -1358,7 +1357,7 @@ export interface ConfluencePageConfiguration {
|
|
|
1358
1357
|
* <p>Defines how page metadata fields should be mapped to index fields.
|
|
1359
1358
|
* Before you can map a field, you must first create an index field
|
|
1360
1359
|
* with a matching type using the console or the
|
|
1361
|
-
* <code>UpdateIndex</code>
|
|
1360
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1362
1361
|
* <p>If you specify the <code>PageFieldMappings</code> parameter, you
|
|
1363
1362
|
* must specify at least one field mapping.</p>
|
|
1364
1363
|
*/
|
|
@@ -1378,9 +1377,9 @@ export declare enum ConfluenceSpaceFieldName {
|
|
|
1378
1377
|
}
|
|
1379
1378
|
/**
|
|
1380
1379
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1381
|
-
* to
|
|
1380
|
+
* to an Amazon Kendra index field.</p>
|
|
1382
1381
|
* <p>You must first create the index field using the
|
|
1383
|
-
* <code>UpdateIndex</code>
|
|
1382
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1384
1383
|
*/
|
|
1385
1384
|
export interface ConfluenceSpaceToIndexFieldMapping {
|
|
1386
1385
|
/**
|
|
@@ -1445,7 +1444,7 @@ export interface ConfluenceSpaceConfiguration {
|
|
|
1445
1444
|
* <p>Defines how space metadata fields should be mapped to index
|
|
1446
1445
|
* fields. Before you can map a field, you must first create an index
|
|
1447
1446
|
* field with a matching type using the console or the
|
|
1448
|
-
* <code>UpdateIndex</code>
|
|
1447
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1449
1448
|
* <p>If you specify the <code>SpaceFieldMappings</code> parameter, you
|
|
1450
1449
|
* must specify at least one field mapping.</p>
|
|
1451
1450
|
*/
|
|
@@ -1573,7 +1572,7 @@ export declare namespace ConfluenceConfiguration {
|
|
|
1573
1572
|
/**
|
|
1574
1573
|
* <p>Maps a column or attribute in the data source to an index field.
|
|
1575
1574
|
* You must first create the fields in the index using the
|
|
1576
|
-
* <code>UpdateIndex</code>
|
|
1575
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1577
1576
|
*/
|
|
1578
1577
|
export interface DataSourceToIndexFieldMapping {
|
|
1579
1578
|
/**
|
|
@@ -1615,7 +1614,7 @@ export interface ColumnConfiguration {
|
|
|
1615
1614
|
/**
|
|
1616
1615
|
* <p>An array of objects that map database column names to the
|
|
1617
1616
|
* corresponding fields in an index. You must first create the fields
|
|
1618
|
-
* in the index using the <code>UpdateIndex</code>
|
|
1617
|
+
* in the index using the <code>UpdateIndex</code> API.</p>
|
|
1619
1618
|
*/
|
|
1620
1619
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1621
1620
|
/**
|
|
@@ -1745,6 +1744,89 @@ export declare namespace DatabaseConfiguration {
|
|
|
1745
1744
|
*/
|
|
1746
1745
|
const filterSensitiveLog: (obj: DatabaseConfiguration) => any;
|
|
1747
1746
|
}
|
|
1747
|
+
export declare enum FsxFileSystemType {
|
|
1748
|
+
WINDOWS = "WINDOWS"
|
|
1749
|
+
}
|
|
1750
|
+
/**
|
|
1751
|
+
* <p>Provides the configuration information to connect to Amazon FSx as
|
|
1752
|
+
* your data source.</p>
|
|
1753
|
+
*/
|
|
1754
|
+
export interface FsxConfiguration {
|
|
1755
|
+
/**
|
|
1756
|
+
* <p>The identifier of the Amazon FSx file system.</p>
|
|
1757
|
+
* <p>You can find your file system ID on the file system dashboard in
|
|
1758
|
+
* the Amazon FSx console. For information on how to create a
|
|
1759
|
+
* file system in Amazon FSx console, using Windows File Server
|
|
1760
|
+
* as an example, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html">Amazon FSx
|
|
1761
|
+
* Getting started guide</a>.</p>
|
|
1762
|
+
*/
|
|
1763
|
+
FileSystemId: string | undefined;
|
|
1764
|
+
/**
|
|
1765
|
+
* <p>The Amazon FSx file system type. Windows is currently the only
|
|
1766
|
+
* supported type.</p>
|
|
1767
|
+
*/
|
|
1768
|
+
FileSystemType: FsxFileSystemType | string | undefined;
|
|
1769
|
+
/**
|
|
1770
|
+
* <p>Provides the configuration information for connecting to an
|
|
1771
|
+
* Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx
|
|
1772
|
+
* instance must reside inside your VPC.</p>
|
|
1773
|
+
*/
|
|
1774
|
+
VpcConfiguration: DataSourceVpcConfiguration | undefined;
|
|
1775
|
+
/**
|
|
1776
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
1777
|
+
* contains the key-value pairs required to connect to your Amazon FSx
|
|
1778
|
+
* file system. Windows is currently the only supported type. The secret must
|
|
1779
|
+
* contain a JSON structure with the following keys:</p>
|
|
1780
|
+
* <ul>
|
|
1781
|
+
* <li>
|
|
1782
|
+
* <p>username—The Active Directory user name, along with the
|
|
1783
|
+
* Domain Name System (DNS) domain name. For example,
|
|
1784
|
+
* <i>user@corp.example.com</i>. The Active Directory
|
|
1785
|
+
* user account must have read and mounting access to the
|
|
1786
|
+
* Amazon FSx file system for Windows.</p>
|
|
1787
|
+
* </li>
|
|
1788
|
+
* <li>
|
|
1789
|
+
* <p>password—The password of the active directory user with
|
|
1790
|
+
* read and mounting access Amazon FSx Windows file system.</p>
|
|
1791
|
+
* </li>
|
|
1792
|
+
* </ul>
|
|
1793
|
+
*/
|
|
1794
|
+
SecretArn?: string;
|
|
1795
|
+
/**
|
|
1796
|
+
* <p>A list of regular expression patterns to include certain files
|
|
1797
|
+
* in your Amazon FSx file system. Files that match the patterns
|
|
1798
|
+
* are included in the index. Files that don't match the patterns are
|
|
1799
|
+
* excluded from the index. If a file matches both an inclusion pattern
|
|
1800
|
+
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
1801
|
+
* and the file isn't included in the index.</p>
|
|
1802
|
+
*/
|
|
1803
|
+
InclusionPatterns?: string[];
|
|
1804
|
+
/**
|
|
1805
|
+
* <p>A list of regular expression patterns to exclude certain files
|
|
1806
|
+
* in your Amazon FSx file system. Files that match the patterns
|
|
1807
|
+
* are excluded from the index. Files that don’t match the patterns are
|
|
1808
|
+
* included in the index. If a file matches both an inclusion pattern
|
|
1809
|
+
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
1810
|
+
* and the file isn't included in the index.</p>
|
|
1811
|
+
*/
|
|
1812
|
+
ExclusionPatterns?: string[];
|
|
1813
|
+
/**
|
|
1814
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
1815
|
+
* map Amazon FSx data source attributes or field names to Amazon Kendra
|
|
1816
|
+
* index field names in Amazon Kendra. To create custom fields, use the
|
|
1817
|
+
* <code>UpdateIndex</code> API before you map to Amazon FSx fields.
|
|
1818
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
1819
|
+
* data source fields</a>. The Amazon FSx data source field names
|
|
1820
|
+
* must exist in your Amazon FSx custom metadata.</p>
|
|
1821
|
+
*/
|
|
1822
|
+
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1823
|
+
}
|
|
1824
|
+
export declare namespace FsxConfiguration {
|
|
1825
|
+
/**
|
|
1826
|
+
* @internal
|
|
1827
|
+
*/
|
|
1828
|
+
const filterSensitiveLog: (obj: FsxConfiguration) => any;
|
|
1829
|
+
}
|
|
1748
1830
|
/**
|
|
1749
1831
|
* <p>Provides configuration information for data sources that connect
|
|
1750
1832
|
* to Google Drive.</p>
|
|
@@ -1781,7 +1863,7 @@ export interface GoogleDriveConfiguration {
|
|
|
1781
1863
|
* <p>If you are using the console, you can define index fields when
|
|
1782
1864
|
* creating the mapping. If you are using the API, you must first
|
|
1783
1865
|
* create the field using the <code>UpdateIndex</code>
|
|
1784
|
-
*
|
|
1866
|
+
* API.</p>
|
|
1785
1867
|
*/
|
|
1786
1868
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1787
1869
|
/**
|
|
@@ -2550,7 +2632,7 @@ export interface SharePointConfiguration {
|
|
|
2550
2632
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
2551
2633
|
* map Microsoft SharePoint attributes to custom fields in the Amazon Kendra
|
|
2552
2634
|
* index. You must first create the index fields using the
|
|
2553
|
-
* <code>UpdateIndex</code>
|
|
2635
|
+
* <code>UpdateIndex</code> API before you map SharePoint
|
|
2554
2636
|
* attributes. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping Data Source
|
|
2555
2637
|
* Fields</a>.</p>
|
|
2556
2638
|
*/
|
|
@@ -2877,7 +2959,7 @@ export interface WorkDocsConfiguration {
|
|
|
2877
2959
|
/**
|
|
2878
2960
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2879
2961
|
* Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first
|
|
2880
|
-
* create the custom index fields using the <code>UpdateIndex</code>
|
|
2962
|
+
* create the custom index fields using the <code>UpdateIndex</code> API before
|
|
2881
2963
|
* you map to Amazon WorkDocs fields. For more information, see
|
|
2882
2964
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2883
2965
|
* Data Source Fields</a>. The Amazon WorkDocs data source field names
|
|
@@ -2941,10 +3023,15 @@ export interface DataSourceConfiguration {
|
|
|
2941
3023
|
*/
|
|
2942
3024
|
WebCrawlerConfiguration?: WebCrawlerConfiguration;
|
|
2943
3025
|
/**
|
|
2944
|
-
* <p>Provides the configuration information to connect to WorkDocs
|
|
3026
|
+
* <p>Provides the configuration information to connect to Amazon WorkDocs
|
|
2945
3027
|
* as your data source.</p>
|
|
2946
3028
|
*/
|
|
2947
3029
|
WorkDocsConfiguration?: WorkDocsConfiguration;
|
|
3030
|
+
/**
|
|
3031
|
+
* <p>Provides the configuration information to connect to Amazon FSx as
|
|
3032
|
+
* your data source.</p>
|
|
3033
|
+
*/
|
|
3034
|
+
FsxConfiguration?: FsxConfiguration;
|
|
2948
3035
|
}
|
|
2949
3036
|
export declare namespace DataSourceConfiguration {
|
|
2950
3037
|
/**
|
|
@@ -2979,6 +3066,7 @@ export declare enum DataSourceType {
|
|
|
2979
3066
|
CONFLUENCE = "CONFLUENCE",
|
|
2980
3067
|
CUSTOM = "CUSTOM",
|
|
2981
3068
|
DATABASE = "DATABASE",
|
|
3069
|
+
FSX = "FSX",
|
|
2982
3070
|
GOOGLEDRIVE = "GOOGLEDRIVE",
|
|
2983
3071
|
ONEDRIVE = "ONEDRIVE",
|
|
2984
3072
|
S3 = "S3",
|
|
@@ -3018,10 +3106,10 @@ export interface CreateDataSourceRequest {
|
|
|
3018
3106
|
*/
|
|
3019
3107
|
Description?: string;
|
|
3020
3108
|
/**
|
|
3021
|
-
* <p>Sets the frequency
|
|
3109
|
+
* <p>Sets the frequency for Amazon Kendra to check the documents in your
|
|
3022
3110
|
* repository and update the index. If you don't set a schedule Amazon Kendra
|
|
3023
3111
|
* will not periodically update the index. You can call the
|
|
3024
|
-
* <code>StartDataSourceSyncJob</code>
|
|
3112
|
+
* <code>StartDataSourceSyncJob</code> API to update the
|
|
3025
3113
|
* index.</p>
|
|
3026
3114
|
* <p>You can't specify the <code>Schedule</code> parameter when the
|
|
3027
3115
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
@@ -3047,7 +3135,7 @@ export interface CreateDataSourceRequest {
|
|
|
3047
3135
|
Tags?: Tag[];
|
|
3048
3136
|
/**
|
|
3049
3137
|
* <p>A token that you provide to identify the request to create a data
|
|
3050
|
-
* source. Multiple calls to the <code>CreateDataSource</code>
|
|
3138
|
+
* source. Multiple calls to the <code>CreateDataSource</code> API with
|
|
3051
3139
|
* the same client token will create only one data source.</p>
|
|
3052
3140
|
*/
|
|
3053
3141
|
ClientToken?: string;
|
|
@@ -3103,7 +3191,7 @@ export interface ContentSourceConfiguration {
|
|
|
3103
3191
|
/**
|
|
3104
3192
|
* <p>
|
|
3105
3193
|
* <code>TRUE</code> to use documents you indexed directly using the
|
|
3106
|
-
* <code>BatchPutDocument</code>
|
|
3194
|
+
* <code>BatchPutDocument</code> API.</p>
|
|
3107
3195
|
*/
|
|
3108
3196
|
DirectPutContent?: boolean;
|
|
3109
3197
|
}
|
|
@@ -3143,7 +3231,7 @@ export interface ExperienceConfiguration {
|
|
|
3143
3231
|
/**
|
|
3144
3232
|
* <p>The identifiers of your data sources and FAQs. Or, you can specify
|
|
3145
3233
|
* that you want to use documents indexed via the <code>BatchPutDocument</code>
|
|
3146
|
-
*
|
|
3234
|
+
* API. This is the content you want to use for your Amazon Kendra experience.</p>
|
|
3147
3235
|
*/
|
|
3148
3236
|
ContentSourceConfiguration?: ContentSourceConfiguration;
|
|
3149
3237
|
/**
|
|
@@ -3169,8 +3257,8 @@ export interface CreateExperienceRequest {
|
|
|
3169
3257
|
IndexId: string | undefined;
|
|
3170
3258
|
/**
|
|
3171
3259
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3260
|
+
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
3261
|
+
* API, and Amazon Web Services SSO that stores your user and group information.
|
|
3174
3262
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
3175
3263
|
*/
|
|
3176
3264
|
RoleArn?: string;
|
|
@@ -3187,7 +3275,7 @@ export interface CreateExperienceRequest {
|
|
|
3187
3275
|
Description?: string;
|
|
3188
3276
|
/**
|
|
3189
3277
|
* <p>A token that you provide to identify the request to create your Amazon Kendra experience.
|
|
3190
|
-
* Multiple calls to the <code>CreateExperience</code>
|
|
3278
|
+
* Multiple calls to the <code>CreateExperience</code> API with the same client
|
|
3191
3279
|
* token creates only one Amazon Kendra experience.</p>
|
|
3192
3280
|
*/
|
|
3193
3281
|
ClientToken?: string;
|
|
@@ -3254,7 +3342,7 @@ export interface CreateFaqRequest {
|
|
|
3254
3342
|
FileFormat?: FaqFileFormat | string;
|
|
3255
3343
|
/**
|
|
3256
3344
|
* <p>A token that you provide to identify the request to create a FAQ. Multiple calls to
|
|
3257
|
-
* the <code>CreateFaqRequest</code>
|
|
3345
|
+
* the <code>CreateFaqRequest</code> API with the same client token will create only
|
|
3258
3346
|
* one FAQ. </p>
|
|
3259
3347
|
*/
|
|
3260
3348
|
ClientToken?: string;
|
|
@@ -3323,7 +3411,7 @@ export declare enum UserGroupResolutionMode {
|
|
|
3323
3411
|
* group's access to documents. You can also map your users to their
|
|
3324
3412
|
* groups for user context filtering using the
|
|
3325
3413
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping
|
|
3326
|
-
*
|
|
3414
|
+
* API</a>.</p>
|
|
3327
3415
|
* <p>To set up an Amazon Web Services SSO identity source in the console to use with
|
|
3328
3416
|
* Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started
|
|
3329
3417
|
* with an Amazon Web Services SSO identity source</a>. You must also grant the required
|
|
@@ -3332,7 +3420,7 @@ export declare enum UserGroupResolutionMode {
|
|
|
3332
3420
|
* Amazon Web Services SSO</a>.</p>
|
|
3333
3421
|
* <p>Amazon Kendra currently does not support using <code>UserGroupResolutionConfiguration</code>
|
|
3334
3422
|
* with an Amazon Web Services organization member account for your Amazon Web Services SSO
|
|
3335
|
-
* identify source. You must create your index in the
|
|
3423
|
+
* identify source. You must create your index in the management account for the organization
|
|
3336
3424
|
* in order to use <code>UserGroupResolutionConfiguration</code>.</p>
|
|
3337
3425
|
*/
|
|
3338
3426
|
export interface UserGroupResolutionConfiguration {
|
|
@@ -3452,7 +3540,7 @@ export interface CreateIndexRequest {
|
|
|
3452
3540
|
* <p>An Identity and Access Management(IAM) role that gives
|
|
3453
3541
|
* Amazon Kendra permissions to access your Amazon CloudWatch logs and
|
|
3454
3542
|
* metrics. This is also the role used when you use the
|
|
3455
|
-
* <code>BatchPutDocument</code>
|
|
3543
|
+
* <code>BatchPutDocument</code> API to index documents from an
|
|
3456
3544
|
* Amazon S3 bucket.</p>
|
|
3457
3545
|
*/
|
|
3458
3546
|
RoleArn: string | undefined;
|
|
@@ -3468,7 +3556,7 @@ export interface CreateIndexRequest {
|
|
|
3468
3556
|
Description?: string;
|
|
3469
3557
|
/**
|
|
3470
3558
|
* <p>A token that you provide to identify the request to create an index.
|
|
3471
|
-
* Multiple calls to the <code>CreateIndex</code>
|
|
3559
|
+
* Multiple calls to the <code>CreateIndex</code> API with the same
|
|
3472
3560
|
* client token will create only one index.</p>
|
|
3473
3561
|
*/
|
|
3474
3562
|
ClientToken?: string;
|
|
@@ -3565,7 +3653,7 @@ export interface CreateQuerySuggestionsBlockListRequest {
|
|
|
3565
3653
|
/**
|
|
3566
3654
|
* <p>The IAM (Identity and Access Management) role used by Amazon Kendra to
|
|
3567
3655
|
* access the block list text file in your S3 bucket.</p>
|
|
3568
|
-
* <p>You need permissions to the role ARN (Amazon Resource Name).
|
|
3656
|
+
* <p>You need permissions to the role ARN (Amazon Web Services Resource Name).
|
|
3569
3657
|
* The role needs S3 read permissions to your file in S3 and needs
|
|
3570
3658
|
* to give STS (Security Token Service) assume role permissions
|
|
3571
3659
|
* to Amazon Kendra.</p>
|
|
@@ -3629,7 +3717,7 @@ export interface CreateThesaurusRequest {
|
|
|
3629
3717
|
SourceS3Path: S3Path | undefined;
|
|
3630
3718
|
/**
|
|
3631
3719
|
* <p>A token that you provide to identify the request to create a
|
|
3632
|
-
* thesaurus. Multiple calls to the <code>CreateThesaurus</code>
|
|
3720
|
+
* thesaurus. Multiple calls to the <code>CreateThesaurus</code> API
|
|
3633
3721
|
* with the same client token will create only one thesaurus.
|
|
3634
3722
|
* </p>
|
|
3635
3723
|
*/
|
|
@@ -3866,7 +3954,7 @@ export interface DescribeDataSourceResponse {
|
|
|
3866
3954
|
*/
|
|
3867
3955
|
Status?: DataSourceStatus | string;
|
|
3868
3956
|
/**
|
|
3869
|
-
* <p>The schedule
|
|
3957
|
+
* <p>The schedule for Amazon Kendra to update the index.</p>
|
|
3870
3958
|
*/
|
|
3871
3959
|
Schedule?: string;
|
|
3872
3960
|
/**
|
|
@@ -3998,8 +4086,8 @@ export interface DescribeExperienceResponse {
|
|
|
3998
4086
|
Status?: ExperienceStatus | string;
|
|
3999
4087
|
/**
|
|
4000
4088
|
* <p>Shows the Amazon Resource Name (ARN) of a role with permission to access
|
|
4001
|
-
* <code>Query</code>
|
|
4002
|
-
* <code>SubmitFeedback</code>
|
|
4089
|
+
* <code>Query</code> API, <code>QuerySuggestions</code> API,
|
|
4090
|
+
* <code>SubmitFeedback</code> API, and Amazon Web Services SSO that stores
|
|
4003
4091
|
* your user and group information.</p>
|
|
4004
4092
|
*/
|
|
4005
4093
|
RoleArn?: string;
|
|
@@ -4692,7 +4780,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
4692
4780
|
* <p>By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code>
|
|
4693
4781
|
* turns off query suggestions for your users. You can change the mode using
|
|
4694
4782
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a>
|
|
4695
|
-
*
|
|
4783
|
+
* API.</p>
|
|
4696
4784
|
*/
|
|
4697
4785
|
Mode?: Mode | string;
|
|
4698
4786
|
/**
|
|
@@ -4796,7 +4884,7 @@ export interface DescribeThesaurusResponse {
|
|
|
4796
4884
|
* more information.
|
|
4797
4885
|
* </p>
|
|
4798
4886
|
* <p>If the status is <code>ACTIVE_BUT_UPDATE_FAILED</code>, it means
|
|
4799
|
-
*
|
|
4887
|
+
* that Amazon Kendra could not ingest the new thesaurus file. The old
|
|
4800
4888
|
* thesaurus file is still active.
|
|
4801
4889
|
* </p>
|
|
4802
4890
|
*/
|
|
@@ -5198,8 +5286,8 @@ export declare namespace ListDataSourcesRequest {
|
|
|
5198
5286
|
const filterSensitiveLog: (obj: ListDataSourcesRequest) => any;
|
|
5199
5287
|
}
|
|
5200
5288
|
/**
|
|
5201
|
-
* <p>Summary information for
|
|
5202
|
-
* to the <code>DescribeDataSource</code>
|
|
5289
|
+
* <p>Summary information for an Amazon Kendra data source. Returned in a call
|
|
5290
|
+
* to the <code>DescribeDataSource</code> API.</p>
|
|
5203
5291
|
*/
|
|
5204
5292
|
export interface DataSourceSummary {
|
|
5205
5293
|
/**
|
|
@@ -5346,7 +5434,7 @@ export declare namespace DataSourceSyncJobMetrics {
|
|
|
5346
5434
|
const filterSensitiveLog: (obj: DataSourceSyncJobMetrics) => any;
|
|
5347
5435
|
}
|
|
5348
5436
|
/**
|
|
5349
|
-
* <p>Provides information about a synchronization job.</p>
|
|
5437
|
+
* <p>Provides information about a data source synchronization job.</p>
|
|
5350
5438
|
*/
|
|
5351
5439
|
export interface DataSourceSyncJob {
|
|
5352
5440
|
/**
|
|
@@ -5354,11 +5442,11 @@ export interface DataSourceSyncJob {
|
|
|
5354
5442
|
*/
|
|
5355
5443
|
ExecutionId?: string;
|
|
5356
5444
|
/**
|
|
5357
|
-
* <p>The UNIX datetime that the synchronization job
|
|
5445
|
+
* <p>The UNIX datetime that the synchronization job started.</p>
|
|
5358
5446
|
*/
|
|
5359
5447
|
StartTime?: Date;
|
|
5360
5448
|
/**
|
|
5361
|
-
* <p>The UNIX datetime that the synchronization job
|
|
5449
|
+
* <p>The UNIX datetime that the synchronization job
|
|
5362
5450
|
* completed.</p>
|
|
5363
5451
|
*/
|
|
5364
5452
|
EndTime?: Date;
|
|
@@ -5379,8 +5467,8 @@ export interface DataSourceSyncJob {
|
|
|
5379
5467
|
ErrorMessage?: string;
|
|
5380
5468
|
/**
|
|
5381
5469
|
* <p>If the <code>Status</code> field is set to <code>FAILED</code>,
|
|
5382
|
-
* the <code>ErrorCode</code> field
|
|
5383
|
-
*
|
|
5470
|
+
* the <code>ErrorCode</code> field indicates the reason the
|
|
5471
|
+
* synchronization failed.</p>
|
|
5384
5472
|
*/
|
|
5385
5473
|
ErrorCode?: ErrorCode | string;
|
|
5386
5474
|
/**
|
|
@@ -5874,7 +5962,7 @@ export interface IndexConfigurationSummary {
|
|
|
5874
5962
|
Name?: string;
|
|
5875
5963
|
/**
|
|
5876
5964
|
* <p>A unique identifier for the index. Use this to identify the index
|
|
5877
|
-
* when you are using
|
|
5965
|
+
* when you are using APIs such as <code>Query</code>,
|
|
5878
5966
|
* <code>DescribeIndex</code>, <code>UpdateIndex</code>, and
|
|
5879
5967
|
* <code>DeleteIndex</code>.</p>
|
|
5880
5968
|
*/
|
|
@@ -5890,7 +5978,7 @@ export interface IndexConfigurationSummary {
|
|
|
5890
5978
|
CreatedAt: Date | undefined;
|
|
5891
5979
|
/**
|
|
5892
5980
|
* <p>The Unix timestamp when the index was last updated by the
|
|
5893
|
-
* <code>UpdateIndex</code>
|
|
5981
|
+
* <code>UpdateIndex</code> API.</p>
|
|
5894
5982
|
*/
|
|
5895
5983
|
UpdatedAt: Date | undefined;
|
|
5896
5984
|
/**
|
|
@@ -6304,7 +6392,7 @@ export declare enum SortOrder {
|
|
|
6304
6392
|
* <p>Specifies the document attribute to use to sort the response to a
|
|
6305
6393
|
* Amazon Kendra query. You can specify a single attribute for sorting. The
|
|
6306
6394
|
* attribute must have the <code>Sortable</code> flag set to
|
|
6307
|
-
*
|
|
6395
|
+
* <code>true</code>, otherwise Amazon Kendra returns an exception.</p>
|
|
6308
6396
|
* <p>You can sort attributes of the following types.</p>
|
|
6309
6397
|
* <ul>
|
|
6310
6398
|
* <li>
|
|
@@ -6391,8 +6479,7 @@ export declare namespace DataSourceGroup {
|
|
|
6391
6479
|
}
|
|
6392
6480
|
/**
|
|
6393
6481
|
* <p>Provides information about the user context for
|
|
6394
|
-
* an
|
|
6395
|
-
* Amazon Kendra index.</p>
|
|
6482
|
+
* an Amazon Kendra index.</p>
|
|
6396
6483
|
* <p>This is used for filtering search results for different users based on their access
|
|
6397
6484
|
* to documents.</p>
|
|
6398
6485
|
* <p>You provide one of the following:</p>
|
|
@@ -6693,7 +6780,7 @@ export declare namespace StopDataSourceSyncJobRequest {
|
|
|
6693
6780
|
/**
|
|
6694
6781
|
* <p>Gathers information about when a particular result was clicked by
|
|
6695
6782
|
* a user. Your application uses the <code>SubmitFeedback</code>
|
|
6696
|
-
*
|
|
6783
|
+
* API to provide click information.</p>
|
|
6697
6784
|
*/
|
|
6698
6785
|
export interface ClickFeedback {
|
|
6699
6786
|
/**
|
|
@@ -6719,7 +6806,7 @@ export declare enum RelevanceType {
|
|
|
6719
6806
|
}
|
|
6720
6807
|
/**
|
|
6721
6808
|
* <p>Provides feedback on how relevant a document is to a search. Your
|
|
6722
|
-
* application uses the <code>SubmitFeedback</code>
|
|
6809
|
+
* application uses the <code>SubmitFeedback</code> API to
|
|
6723
6810
|
* provide relevance information.</p>
|
|
6724
6811
|
*/
|
|
6725
6812
|
export interface RelevanceFeedback {
|
|
@@ -6748,7 +6835,7 @@ export interface SubmitFeedbackRequest {
|
|
|
6748
6835
|
/**
|
|
6749
6836
|
* <p>The identifier of the specific query for which you are submitting
|
|
6750
6837
|
* feedback. The query ID is returned in the response to the
|
|
6751
|
-
* <code>Query</code>
|
|
6838
|
+
* <code>Query</code> API.</p>
|
|
6752
6839
|
*/
|
|
6753
6840
|
QueryId: string | undefined;
|
|
6754
6841
|
/**
|
|
@@ -6892,8 +6979,8 @@ export interface UpdateExperienceRequest {
|
|
|
6892
6979
|
IndexId: string | undefined;
|
|
6893
6980
|
/**
|
|
6894
6981
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
6895
|
-
*
|
|
6896
|
-
*
|
|
6982
|
+
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
6983
|
+
* API, and Amazon Web Services SSO that stores your user and group information.
|
|
6897
6984
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
6898
6985
|
*/
|
|
6899
6986
|
RoleArn?: string;
|
|
@@ -7196,7 +7283,7 @@ export interface QueryRequest {
|
|
|
7196
7283
|
/**
|
|
7197
7284
|
* <p>The unique identifier of the index to search. The identifier is
|
|
7198
7285
|
* returned in the response from the <code>CreateIndex</code>
|
|
7199
|
-
*
|
|
7286
|
+
* API.</p>
|
|
7200
7287
|
*/
|
|
7201
7288
|
IndexId: string | undefined;
|
|
7202
7289
|
/**
|
|
@@ -7243,7 +7330,7 @@ export interface QueryRequest {
|
|
|
7243
7330
|
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
|
|
7244
7331
|
/**
|
|
7245
7332
|
* <p>Query results are returned in pages the size of the
|
|
7246
|
-
*
|
|
7333
|
+
* <code>PageSize</code> parameter. By default, Amazon Kendra returns
|
|
7247
7334
|
* the first page of results. Use this parameter to get result pages after
|
|
7248
7335
|
* the first one.</p>
|
|
7249
7336
|
*/
|