@aws-sdk/client-kendra 3.52.0 → 3.54.1

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.
@@ -1,4 +1,5 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { KendraServiceException as __BaseException } from "./KendraServiceException";
2
3
  /**
3
4
  * <p>Access Control List files for the documents in a data source. For
4
5
  * the format of the file, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html">Access control for S3 data
@@ -19,10 +20,14 @@ export declare namespace AccessControlListConfiguration {
19
20
  /**
20
21
  * <p></p>
21
22
  */
22
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
23
- name: "AccessDeniedException";
24
- $fault: "client";
23
+ export declare class AccessDeniedException extends __BaseException {
24
+ readonly name: "AccessDeniedException";
25
+ readonly $fault: "client";
25
26
  Message?: string;
27
+ /**
28
+ * @internal
29
+ */
30
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
26
31
  }
27
32
  /**
28
33
  * <p>Provides information about the column that should be used for
@@ -148,7 +153,7 @@ export declare enum EntityType {
148
153
  USER = "USER"
149
154
  }
150
155
  /**
151
- * <p>Provides the configuration information of users or groups in
156
+ * <p>Provides the configuration information for users or groups in
152
157
  * your Amazon Web Services SSO identity source to grant access your Amazon Kendra
153
158
  * experience.</p>
154
159
  */
@@ -228,49 +233,69 @@ export declare namespace AssociateEntitiesToExperienceResponse {
228
233
  /**
229
234
  * <p></p>
230
235
  */
231
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
232
- name: "InternalServerException";
233
- $fault: "server";
236
+ export declare class InternalServerException extends __BaseException {
237
+ readonly name: "InternalServerException";
238
+ readonly $fault: "server";
234
239
  Message?: string;
240
+ /**
241
+ * @internal
242
+ */
243
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
235
244
  }
236
245
  /**
237
246
  * <p></p>
238
247
  */
239
- export interface ResourceAlreadyExistException extends __SmithyException, $MetadataBearer {
240
- name: "ResourceAlreadyExistException";
241
- $fault: "client";
248
+ export declare class ResourceAlreadyExistException extends __BaseException {
249
+ readonly name: "ResourceAlreadyExistException";
250
+ readonly $fault: "client";
242
251
  Message?: string;
252
+ /**
253
+ * @internal
254
+ */
255
+ constructor(opts: __ExceptionOptionType<ResourceAlreadyExistException, __BaseException>);
243
256
  }
244
257
  /**
245
258
  * <p></p>
246
259
  */
247
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
248
- name: "ResourceNotFoundException";
249
- $fault: "client";
260
+ export declare class ResourceNotFoundException extends __BaseException {
261
+ readonly name: "ResourceNotFoundException";
262
+ readonly $fault: "client";
250
263
  Message?: string;
264
+ /**
265
+ * @internal
266
+ */
267
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
251
268
  }
252
269
  /**
253
270
  * <p></p>
254
271
  */
255
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
256
- name: "ThrottlingException";
257
- $fault: "client";
272
+ export declare class ThrottlingException extends __BaseException {
273
+ readonly name: "ThrottlingException";
274
+ readonly $fault: "client";
258
275
  Message?: string;
276
+ /**
277
+ * @internal
278
+ */
279
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
259
280
  }
260
281
  /**
261
282
  * <p></p>
262
283
  */
263
- export interface ValidationException extends __SmithyException, $MetadataBearer {
264
- name: "ValidationException";
265
- $fault: "client";
284
+ export declare class ValidationException extends __BaseException {
285
+ readonly name: "ValidationException";
286
+ readonly $fault: "client";
266
287
  Message?: string;
288
+ /**
289
+ * @internal
290
+ */
291
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
267
292
  }
268
293
  export declare enum Persona {
269
294
  OWNER = "OWNER",
270
295
  VIEWER = "VIEWER"
271
296
  }
272
297
  /**
273
- * <p>Provides the configuration information of users or groups in your
298
+ * <p>Provides the configuration information for users or groups in your
274
299
  * Amazon Web Services SSO identity source for access to your Amazon Kendra experience.
275
300
  * Specific permissions are defined for each user or group once they are
276
301
  * granted access to your Amazon Kendra experience.</p>
@@ -536,10 +561,14 @@ export declare namespace BatchDeleteDocumentResponse {
536
561
  /**
537
562
  * <p></p>
538
563
  */
539
- export interface ConflictException extends __SmithyException, $MetadataBearer {
540
- name: "ConflictException";
541
- $fault: "client";
564
+ export declare class ConflictException extends __BaseException {
565
+ readonly name: "ConflictException";
566
+ readonly $fault: "client";
542
567
  Message?: string;
568
+ /**
569
+ * @internal
570
+ */
571
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
543
572
  }
544
573
  /**
545
574
  * <p>Identifies a document for which to retrieve status
@@ -1149,10 +1178,14 @@ export declare namespace BatchPutDocumentResponse {
1149
1178
  /**
1150
1179
  * <p></p>
1151
1180
  */
1152
- export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
1153
- name: "ServiceQuotaExceededException";
1154
- $fault: "client";
1181
+ export declare class ServiceQuotaExceededException extends __BaseException {
1182
+ readonly name: "ServiceQuotaExceededException";
1183
+ readonly $fault: "client";
1155
1184
  Message?: string;
1185
+ /**
1186
+ * @internal
1187
+ */
1188
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
1156
1189
  }
1157
1190
  export interface ClearQuerySuggestionsRequest {
1158
1191
  /**
@@ -1461,7 +1494,7 @@ export declare enum ConfluenceVersion {
1461
1494
  SERVER = "SERVER"
1462
1495
  }
1463
1496
  /**
1464
- * <p>Provides information for connecting to an Amazon VPC.</p>
1497
+ * <p>Provides the configuration information to connect to an Amazon VPC.</p>
1465
1498
  */
1466
1499
  export interface DataSourceVpcConfiguration {
1467
1500
  /**
@@ -1485,8 +1518,8 @@ export declare namespace DataSourceVpcConfiguration {
1485
1518
  const filterSensitiveLog: (obj: DataSourceVpcConfiguration) => any;
1486
1519
  }
1487
1520
  /**
1488
- * <p>Provides configuration information for data sources that connect
1489
- * to Confluence.</p>
1521
+ * <p>Provides the configuration information to connect to Confluence
1522
+ * as your data source.</p>
1490
1523
  */
1491
1524
  export interface ConfluenceConfiguration {
1492
1525
  /**
@@ -1630,7 +1663,7 @@ export declare namespace ColumnConfiguration {
1630
1663
  const filterSensitiveLog: (obj: ColumnConfiguration) => any;
1631
1664
  }
1632
1665
  /**
1633
- * <p>Provides the information necessary to connect to a
1666
+ * <p>Provides the configuration information that's required to connect to a
1634
1667
  * database.</p>
1635
1668
  */
1636
1669
  export interface ConnectionConfiguration {
@@ -1679,7 +1712,7 @@ export declare enum QueryIdentifiersEnclosingOption {
1679
1712
  NONE = "NONE"
1680
1713
  }
1681
1714
  /**
1682
- * <p>Provides information that configures Amazon Kendra to use a SQL
1715
+ * <p>Provides the configuration information to use a SQL
1683
1716
  * database.</p>
1684
1717
  */
1685
1718
  export interface SqlConfiguration {
@@ -1706,7 +1739,7 @@ export declare namespace SqlConfiguration {
1706
1739
  const filterSensitiveLog: (obj: SqlConfiguration) => any;
1707
1740
  }
1708
1741
  /**
1709
- * <p>Provides the information necessary to connect a database to an
1742
+ * <p>Provides the configuration information to connect to a
1710
1743
  * index. </p>
1711
1744
  */
1712
1745
  export interface DatabaseConfiguration {
@@ -1715,11 +1748,11 @@ export interface DatabaseConfiguration {
1715
1748
  */
1716
1749
  DatabaseEngineType: DatabaseEngineType | string | undefined;
1717
1750
  /**
1718
- * <p>The information necessary to connect to a database.</p>
1751
+ * <p>Configuration information that's required to connect to a database.</p>
1719
1752
  */
1720
1753
  ConnectionConfiguration: ConnectionConfiguration | undefined;
1721
1754
  /**
1722
- * <p>Provides information for connecting to an Amazon VPC.</p>
1755
+ * <p>Provides the configuration information to connect to an Amazon VPC.</p>
1723
1756
  */
1724
1757
  VpcConfiguration?: DataSourceVpcConfiguration;
1725
1758
  /**
@@ -1767,7 +1800,7 @@ export interface FsxConfiguration {
1767
1800
  */
1768
1801
  FileSystemType: FsxFileSystemType | string | undefined;
1769
1802
  /**
1770
- * <p>Provides the configuration information for connecting to an
1803
+ * <p>Configuration information for connecting to an
1771
1804
  * Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx
1772
1805
  * instance must reside inside your VPC.</p>
1773
1806
  */
@@ -1786,8 +1819,8 @@ export interface FsxConfiguration {
1786
1819
  * Amazon FSx file system for Windows.</p>
1787
1820
  * </li>
1788
1821
  * <li>
1789
- * <p>password—The password of the active directory user with
1790
- * read and mounting access Amazon FSx Windows file system.</p>
1822
+ * <p>password—The password of the Active Directory user account with
1823
+ * read and mounting access to the Amazon FSx Windows file system.</p>
1791
1824
  * </li>
1792
1825
  * </ul>
1793
1826
  */
@@ -1813,7 +1846,7 @@ export interface FsxConfiguration {
1813
1846
  /**
1814
1847
  * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
1815
1848
  * 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
1849
+ * index field names. To create custom fields, use the
1817
1850
  * <code>UpdateIndex</code> API before you map to Amazon FSx fields.
1818
1851
  * For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
1819
1852
  * data source fields</a>. The Amazon FSx data source field names
@@ -1828,8 +1861,8 @@ export declare namespace FsxConfiguration {
1828
1861
  const filterSensitiveLog: (obj: FsxConfiguration) => any;
1829
1862
  }
1830
1863
  /**
1831
- * <p>Provides configuration information for data sources that connect
1832
- * to Google Drive.</p>
1864
+ * <p>Provides the configuration information to connect to
1865
+ * Google Drive as your data source.</p>
1833
1866
  */
1834
1867
  export interface GoogleDriveConfiguration {
1835
1868
  /**
@@ -1918,8 +1951,8 @@ export declare namespace OneDriveUsers {
1918
1951
  const filterSensitiveLog: (obj: OneDriveUsers) => any;
1919
1952
  }
1920
1953
  /**
1921
- * <p>Provides configuration information for data sources that connect
1922
- * to OneDrive.</p>
1954
+ * <p>Provides the configuration information to connect
1955
+ * to OneDrive as your data source.</p>
1923
1956
  */
1924
1957
  export interface OneDriveConfiguration {
1925
1958
  /**
@@ -1997,8 +2030,8 @@ export declare namespace DocumentsMetadataConfiguration {
1997
2030
  const filterSensitiveLog: (obj: DocumentsMetadataConfiguration) => any;
1998
2031
  }
1999
2032
  /**
2000
- * <p>Provides configuration information for a data source to index
2001
- * documents in an Amazon S3 bucket.</p>
2033
+ * <p>Provides the configuration information to connect to
2034
+ * an Amazon S3 bucket.</p>
2002
2035
  */
2003
2036
  export interface S3DataSourceConfiguration {
2004
2037
  /**
@@ -2089,7 +2122,7 @@ export declare enum SalesforceChatterFeedIncludeFilterType {
2089
2122
  STANDARD_USER = "STANDARD_USER"
2090
2123
  }
2091
2124
  /**
2092
- * <p>Defines configuration for syncing a Salesforce chatter feed. The
2125
+ * <p>The configuration information for syncing a Salesforce chatter feed. The
2093
2126
  * contents of the object comes from the Salesforce FeedItem
2094
2127
  * table.</p>
2095
2128
  */
@@ -2163,7 +2196,7 @@ export declare enum SalesforceKnowledgeArticleState {
2163
2196
  PUBLISHED = "PUBLISHED"
2164
2197
  }
2165
2198
  /**
2166
- * <p>Provides configuration information for standard Salesforce
2199
+ * <p>Configuration information for standard Salesforce
2167
2200
  * knowledge articles.</p>
2168
2201
  */
2169
2202
  export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
@@ -2190,7 +2223,7 @@ export declare namespace SalesforceStandardKnowledgeArticleTypeConfiguration {
2190
2223
  const filterSensitiveLog: (obj: SalesforceStandardKnowledgeArticleTypeConfiguration) => any;
2191
2224
  }
2192
2225
  /**
2193
- * <p>Specifies configuration information for the knowledge article
2226
+ * <p>Provides the configuration information for the knowledge article
2194
2227
  * types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
2195
2228
  * articles and the standard fields of knowledge articles, or the
2196
2229
  * custom fields of custom knowledge articles, but not both </p>
@@ -2203,12 +2236,12 @@ export interface SalesforceKnowledgeArticleConfiguration {
2203
2236
  */
2204
2237
  IncludedStates: (SalesforceKnowledgeArticleState | string)[] | undefined;
2205
2238
  /**
2206
- * <p>Provides configuration information for standard Salesforce
2239
+ * <p>Configuration information for standard Salesforce
2207
2240
  * knowledge articles.</p>
2208
2241
  */
2209
2242
  StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration;
2210
2243
  /**
2211
- * <p>Provides configuration information for custom Salesforce knowledge
2244
+ * <p>Configuration information for custom Salesforce knowledge
2212
2245
  * articles.</p>
2213
2246
  */
2214
2247
  CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfiguration[];
@@ -2220,7 +2253,7 @@ export declare namespace SalesforceKnowledgeArticleConfiguration {
2220
2253
  const filterSensitiveLog: (obj: SalesforceKnowledgeArticleConfiguration) => any;
2221
2254
  }
2222
2255
  /**
2223
- * <p>Provides configuration information for processing attachments to
2256
+ * <p>Provides the configuration information for processing attachments to
2224
2257
  * Salesforce standard objects. </p>
2225
2258
  */
2226
2259
  export interface SalesforceStandardObjectAttachmentConfiguration {
@@ -2260,7 +2293,7 @@ export declare enum SalesforceStandardObjectName {
2260
2293
  USER = "USER"
2261
2294
  }
2262
2295
  /**
2263
- * <p>Specifies configuration information for indexing a single standard
2296
+ * <p>Provides the configuration information for indexing a single standard
2264
2297
  * object.</p>
2265
2298
  */
2266
2299
  export interface SalesforceStandardObjectConfiguration {
@@ -2357,7 +2390,7 @@ export interface SalesforceConfiguration {
2357
2390
  */
2358
2391
  CrawlAttachments?: boolean;
2359
2392
  /**
2360
- * <p>Provides configuration information for processing attachments to
2393
+ * <p>Configuration information for processing attachments to
2361
2394
  * Salesforce standard objects. </p>
2362
2395
  */
2363
2396
  StandardObjectAttachmentConfiguration?: SalesforceStandardObjectAttachmentConfiguration;
@@ -2391,7 +2424,7 @@ export declare enum ServiceNowAuthenticationType {
2391
2424
  OAUTH2 = "OAUTH2"
2392
2425
  }
2393
2426
  /**
2394
- * <p>Provides configuration information for crawling knowledge articles
2427
+ * <p>Provides the configuration information for crawling knowledge articles
2395
2428
  * in the ServiceNow site.</p>
2396
2429
  */
2397
2430
  export interface ServiceNowKnowledgeArticleConfiguration {
@@ -2447,7 +2480,7 @@ export declare namespace ServiceNowKnowledgeArticleConfiguration {
2447
2480
  const filterSensitiveLog: (obj: ServiceNowKnowledgeArticleConfiguration) => any;
2448
2481
  }
2449
2482
  /**
2450
- * <p>Provides configuration information for crawling service catalog
2483
+ * <p>Provides the configuration information for crawling service catalog
2451
2484
  * items in the ServiceNow site</p>
2452
2485
  */
2453
2486
  export interface ServiceNowServiceCatalogConfiguration {
@@ -2501,8 +2534,8 @@ export declare enum ServiceNowBuildVersionType {
2501
2534
  OTHERS = "OTHERS"
2502
2535
  }
2503
2536
  /**
2504
- * <p>Provides configuration information required to connect to a
2505
- * ServiceNow data source.</p>
2537
+ * <p>Provides the configuration information to connect to
2538
+ * ServiceNow as your data source.</p>
2506
2539
  */
2507
2540
  export interface ServiceNowConfiguration {
2508
2541
  /**
@@ -2525,12 +2558,12 @@ export interface ServiceNowConfiguration {
2525
2558
  */
2526
2559
  ServiceNowBuildVersion: ServiceNowBuildVersionType | string | undefined;
2527
2560
  /**
2528
- * <p>Provides configuration information for crawling knowledge articles
2561
+ * <p>Configuration information for crawling knowledge articles
2529
2562
  * in the ServiceNow site.</p>
2530
2563
  */
2531
2564
  KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration;
2532
2565
  /**
2533
- * <p>Provides configuration information for crawling service catalogs
2566
+ * <p>Configuration information for crawling service catalogs
2534
2567
  * in the ServiceNow site.</p>
2535
2568
  */
2536
2569
  ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration;
@@ -2562,8 +2595,8 @@ export declare enum SharePointVersion {
2562
2595
  SHAREPOINT_ONLINE = "SHAREPOINT_ONLINE"
2563
2596
  }
2564
2597
  /**
2565
- * <p>Provides configuration information for connecting to a Microsoft
2566
- * SharePoint data source.</p>
2598
+ * <p>Provides the configuration information to connect to Microsoft
2599
+ * SharePoint as your data source.</p>
2567
2600
  */
2568
2601
  export interface SharePointConfiguration {
2569
2602
  /**
@@ -2625,7 +2658,7 @@ export interface SharePointConfiguration {
2625
2658
  */
2626
2659
  ExclusionPatterns?: string[];
2627
2660
  /**
2628
- * <p>Provides information for connecting to an Amazon VPC.</p>
2661
+ * <p>Provides the configuration information to connect to an Amazon VPC.</p>
2629
2662
  */
2630
2663
  VpcConfiguration?: DataSourceVpcConfiguration;
2631
2664
  /**
@@ -2701,7 +2734,7 @@ export declare enum WebCrawlerMode {
2701
2734
  SUBDOMAINS = "SUBDOMAINS"
2702
2735
  }
2703
2736
  /**
2704
- * <p>Provides the configuration information of the seed or starting point URLs to crawl.</p>
2737
+ * <p>Provides the configuration information for the seed or starting point URLs to crawl.</p>
2705
2738
  * <p>
2706
2739
  * <i>When selecting websites to index, you must adhere to
2707
2740
  * the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
@@ -2749,7 +2782,7 @@ export declare namespace SeedUrlConfiguration {
2749
2782
  const filterSensitiveLog: (obj: SeedUrlConfiguration) => any;
2750
2783
  }
2751
2784
  /**
2752
- * <p>Provides the configuration information of the sitemap URLs to crawl.</p>
2785
+ * <p>Provides the configuration information for the sitemap URLs to crawl.</p>
2753
2786
  * <p>
2754
2787
  * <i>When selecting websites to index, you must adhere to
2755
2788
  * the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
@@ -2787,7 +2820,7 @@ export declare namespace SiteMapsConfiguration {
2787
2820
  */
2788
2821
  export interface Urls {
2789
2822
  /**
2790
- * <p>Provides the configuration of the seed or starting point URLs of the websites
2823
+ * <p>Configuration of the seed or starting point URLs of the websites
2791
2824
  * you want to crawl.</p>
2792
2825
  * <p>You can choose to crawl only the website host names, or the website host names
2793
2826
  * with subdomains, or the website host names with subdomains and other domains
@@ -2796,7 +2829,7 @@ export interface Urls {
2796
2829
  */
2797
2830
  SeedUrlConfiguration?: SeedUrlConfiguration;
2798
2831
  /**
2799
- * <p>Provides the configuration of the sitemap URLs of the websites you want to crawl.</p>
2832
+ * <p>Configuration of the sitemap URLs of the websites you want to crawl.</p>
2800
2833
  * <p>Only URLs belonging to the same website host names are crawled. You can list up to
2801
2834
  * three sitemap URLs.</p>
2802
2835
  */
@@ -2873,7 +2906,7 @@ export interface WebCrawlerConfiguration {
2873
2906
  */
2874
2907
  UrlExclusionPatterns?: string[];
2875
2908
  /**
2876
- * <p>Provides configuration information required to connect to your internal
2909
+ * <p>Configuration information required to connect to your internal
2877
2910
  * websites via a web proxy.</p>
2878
2911
  * <p>You must provide the website host name and port number. For example, the
2879
2912
  * host name of https://a.example.com/page1.html is "a.example.com" and the
@@ -2884,7 +2917,7 @@ export interface WebCrawlerConfiguration {
2884
2917
  */
2885
2918
  ProxyConfiguration?: ProxyConfiguration;
2886
2919
  /**
2887
- * <p>Provides configuration information required to connect to websites using
2920
+ * <p>Configuration information required to connect to websites using
2888
2921
  * authentication.</p>
2889
2922
  * <p>You can connect to websites using basic authentication of user name and password.</p>
2890
2923
  * <p>You must provide the website host name and port number. For example, the host name
@@ -2974,37 +3007,37 @@ export declare namespace WorkDocsConfiguration {
2974
3007
  const filterSensitiveLog: (obj: WorkDocsConfiguration) => any;
2975
3008
  }
2976
3009
  /**
2977
- * <p>Configuration information for an Amazon Kendra data source.</p>
3010
+ * <p>Provides the configuration information for an Amazon Kendra data source.</p>
2978
3011
  */
2979
3012
  export interface DataSourceConfiguration {
2980
3013
  /**
2981
- * <p>Provides information to create a data source connector for a
2982
- * document repository in an Amazon S3 bucket.</p>
3014
+ * <p>Provides the configuration information to connect to an Amazon S3
3015
+ * bucket as your data source.</p>
2983
3016
  */
2984
3017
  S3Configuration?: S3DataSourceConfiguration;
2985
3018
  /**
2986
- * <p>Provides information necessary to create a data source connector
2987
- * for a Microsoft SharePoint site.</p>
3019
+ * <p>Provides the configuration information to connect to Microsoft SharePoint
3020
+ * as your data source.</p>
2988
3021
  */
2989
3022
  SharePointConfiguration?: SharePointConfiguration;
2990
3023
  /**
2991
- * <p>Provides information necessary to create a data source connector
2992
- * for a database.</p>
3024
+ * <p>Provides the configuration information to connect to a database as
3025
+ * your data source.</p>
2993
3026
  */
2994
3027
  DatabaseConfiguration?: DatabaseConfiguration;
2995
3028
  /**
2996
- * <p>Provides configuration information for data sources that connect
2997
- * to a Salesforce site.</p>
3029
+ * <p>Provides the configuration information to connect to
3030
+ * Salesforce as your data source.</p>
2998
3031
  */
2999
3032
  SalesforceConfiguration?: SalesforceConfiguration;
3000
3033
  /**
3001
- * <p>Provides configuration for data sources that connect to Microsoft
3002
- * OneDrive.</p>
3034
+ * <p>Provides the configuration information to connect to Microsoft
3035
+ * OneDrive as your data source.</p>
3003
3036
  */
3004
3037
  OneDriveConfiguration?: OneDriveConfiguration;
3005
3038
  /**
3006
- * <p>Provides configuration for data sources that connect to ServiceNow
3007
- * instances.</p>
3039
+ * <p>Provides the configuration information to connect to ServiceNow
3040
+ * as your data source.</p>
3008
3041
  */
3009
3042
  ServiceNowConfiguration?: ServiceNowConfiguration;
3010
3043
  /**
@@ -3013,8 +3046,8 @@ export interface DataSourceConfiguration {
3013
3046
  */
3014
3047
  ConfluenceConfiguration?: ConfluenceConfiguration;
3015
3048
  /**
3016
- * <p>Provides configuration for data sources that connect to Google
3017
- * Drive. </p>
3049
+ * <p>Provides the configuration information to connect to Google
3050
+ * Drive as your data source. </p>
3018
3051
  */
3019
3052
  GoogleDriveConfiguration?: GoogleDriveConfiguration;
3020
3053
  /**
@@ -3092,7 +3125,7 @@ export interface CreateDataSourceRequest {
3092
3125
  */
3093
3126
  Type: DataSourceType | string | undefined;
3094
3127
  /**
3095
- * <p>The connector configuration information that is required to access the
3128
+ * <p>Configuration information that is required to access the data source
3096
3129
  * repository.</p>
3097
3130
  * <p>You can't specify the <code>Configuration</code> parameter when the
3098
3131
  * <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
@@ -3176,7 +3209,7 @@ export declare namespace CreateDataSourceResponse {
3176
3209
  const filterSensitiveLog: (obj: CreateDataSourceResponse) => any;
3177
3210
  }
3178
3211
  /**
3179
- * <p>Configuration information for your content sources, such as data sources,
3212
+ * <p>Provides the configuration information for your content sources, such as data sources,
3180
3213
  * FAQs, and content indexed directly via <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>.</p>
3181
3214
  */
3182
3215
  export interface ContentSourceConfiguration {
@@ -3202,7 +3235,7 @@ export declare namespace ContentSourceConfiguration {
3202
3235
  const filterSensitiveLog: (obj: ContentSourceConfiguration) => any;
3203
3236
  }
3204
3237
  /**
3205
- * <p>Configuration information for the identifiers of your users.</p>
3238
+ * <p>Provides the configuration information for the identifiers of your users.</p>
3206
3239
  */
3207
3240
  export interface UserIdentityConfiguration {
3208
3241
  /**
@@ -3223,7 +3256,7 @@ export declare namespace UserIdentityConfiguration {
3223
3256
  const filterSensitiveLog: (obj: UserIdentityConfiguration) => any;
3224
3257
  }
3225
3258
  /**
3226
- * <p>Specifies the configuration information for your Amazon Kendra experience. This includes
3259
+ * <p>Provides the configuration information for your Amazon Kendra experience. This includes
3227
3260
  * the data source IDs and/or FAQ IDs, and user or group information to grant access
3228
3261
  * to your Amazon Kendra experience.</p>
3229
3262
  */
@@ -3263,7 +3296,7 @@ export interface CreateExperienceRequest {
3263
3296
  */
3264
3297
  RoleArn?: string;
3265
3298
  /**
3266
- * <p>Provides the configuration information for your Amazon Kendra experience. This includes
3299
+ * <p>Configuration information for your Amazon Kendra experience. This includes
3267
3300
  * <code>ContentSourceConfiguration</code>, which specifies the data source IDs
3268
3301
  * and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the
3269
3302
  * user or group information to grant access to your Amazon Kendra experience.</p>
@@ -3439,7 +3472,7 @@ export declare namespace UserGroupResolutionConfiguration {
3439
3472
  const filterSensitiveLog: (obj: UserGroupResolutionConfiguration) => any;
3440
3473
  }
3441
3474
  /**
3442
- * <p>Configuration information for the JSON token type.</p>
3475
+ * <p>Provides the configuration information for the JSON token type.</p>
3443
3476
  */
3444
3477
  export interface JsonTokenTypeConfiguration {
3445
3478
  /**
@@ -3462,7 +3495,7 @@ export declare enum KeyLocation {
3462
3495
  URL = "URL"
3463
3496
  }
3464
3497
  /**
3465
- * <p>Configuration information for the JWT token type.</p>
3498
+ * <p>Provides the configuration information for the JWT token type.</p>
3466
3499
  */
3467
3500
  export interface JwtTokenTypeConfiguration {
3468
3501
  /**
@@ -3501,7 +3534,7 @@ export declare namespace JwtTokenTypeConfiguration {
3501
3534
  const filterSensitiveLog: (obj: JwtTokenTypeConfiguration) => any;
3502
3535
  }
3503
3536
  /**
3504
- * <p>Provides configuration information for a token configuration.</p>
3537
+ * <p>Provides the configuration information for a token.</p>
3505
3538
  */
3506
3539
  export interface UserTokenConfiguration {
3507
3540
  /**
@@ -3929,8 +3962,7 @@ export interface DescribeDataSourceResponse {
3929
3962
  */
3930
3963
  Type?: DataSourceType | string;
3931
3964
  /**
3932
- * <p>Information that describes where the data source is located and how
3933
- * the data source is configured. The specific information in the description
3965
+ * <p>Describes how the data source is configured. The specific information in the description
3934
3966
  * depends on the data source provider.</p>
3935
3967
  */
3936
3968
  Configuration?: DataSourceConfiguration;
@@ -4013,7 +4045,7 @@ export declare enum EndpointType {
4013
4045
  HOME = "HOME"
4014
4046
  }
4015
4047
  /**
4016
- * <p>Provides the configuration information of the endpoint for your Amazon Kendra
4048
+ * <p>Provides the configuration information for the endpoint for your Amazon Kendra
4017
4049
  * experience.</p>
4018
4050
  */
4019
4051
  export interface ExperienceEndpoint {
@@ -5257,10 +5289,14 @@ export declare namespace GetSnapshotsResponse {
5257
5289
  /**
5258
5290
  * <p>The input to the request is not valid.</p>
5259
5291
  */
5260
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
5261
- name: "InvalidRequestException";
5262
- $fault: "client";
5292
+ export declare class InvalidRequestException extends __BaseException {
5293
+ readonly name: "InvalidRequestException";
5294
+ readonly $fault: "client";
5263
5295
  Message?: string;
5296
+ /**
5297
+ * @internal
5298
+ */
5299
+ constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
5264
5300
  }
5265
5301
  export interface ListDataSourcesRequest {
5266
5302
  /**
@@ -5953,7 +5989,7 @@ export declare namespace ListIndicesRequest {
5953
5989
  const filterSensitiveLog: (obj: ListIndicesRequest) => any;
5954
5990
  }
5955
5991
  /**
5956
- * <p>A summary of information about an index.</p>
5992
+ * <p>A summary of information on the configuration of an index.</p>
5957
5993
  */
5958
5994
  export interface IndexConfigurationSummary {
5959
5995
  /**
@@ -5995,7 +6031,7 @@ export declare namespace IndexConfigurationSummary {
5995
6031
  }
5996
6032
  export interface ListIndicesResponse {
5997
6033
  /**
5998
- * <p>An array of summary information for one or more indexes.</p>
6034
+ * <p>An array of summary information on the configuration of one or more indexes.</p>
5999
6035
  */
6000
6036
  IndexConfigurationSummaryItems?: IndexConfigurationSummary[];
6001
6037
  /**
@@ -6130,10 +6166,14 @@ export declare namespace ListTagsForResourceResponse {
6130
6166
  /**
6131
6167
  * <p></p>
6132
6168
  */
6133
- export interface ResourceUnavailableException extends __SmithyException, $MetadataBearer {
6134
- name: "ResourceUnavailableException";
6135
- $fault: "client";
6169
+ export declare class ResourceUnavailableException extends __BaseException {
6170
+ readonly name: "ResourceUnavailableException";
6171
+ readonly $fault: "client";
6136
6172
  Message?: string;
6173
+ /**
6174
+ * @internal
6175
+ */
6176
+ constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
6137
6177
  }
6138
6178
  export interface ListThesauriRequest {
6139
6179
  /**
@@ -6452,9 +6492,29 @@ export declare namespace SortingConfiguration {
6452
6492
  const filterSensitiveLog: (obj: SortingConfiguration) => any;
6453
6493
  }
6454
6494
  /**
6455
- * <p>
6456
- * Data source information for user context filtering.
6457
- * </p>
6495
+ * <p>Provides the configuration information for suggested query spell corrections.</p>
6496
+ * <p>Suggested spell corrections are based on words that appear in your indexed documents
6497
+ * and how closely a corrected word matches a misspelled word.</p>
6498
+ * <p>This feature is designed with certain defaults or limits. For information on the
6499
+ * current limits and how to request more support for some limits, see the
6500
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html">Spell
6501
+ * Checker documentation</a>.</p>
6502
+ */
6503
+ export interface SpellCorrectionConfiguration {
6504
+ /**
6505
+ * <p>
6506
+ * <code>TRUE</code> to suggest spell corrections for queries.</p>
6507
+ */
6508
+ IncludeQuerySpellCheckSuggestions: boolean | undefined;
6509
+ }
6510
+ export declare namespace SpellCorrectionConfiguration {
6511
+ /**
6512
+ * @internal
6513
+ */
6514
+ const filterSensitiveLog: (obj: SpellCorrectionConfiguration) => any;
6515
+ }
6516
+ /**
6517
+ * <p>Data source information for user context filtering.</p>
6458
6518
  */
6459
6519
  export interface DataSourceGroup {
6460
6520
  /**
@@ -6665,6 +6725,54 @@ export declare namespace QueryResultItem {
6665
6725
  */
6666
6726
  const filterSensitiveLog: (obj: QueryResultItem) => any;
6667
6727
  }
6728
+ /**
6729
+ * <p>A corrected misspelled word in a query.</p>
6730
+ */
6731
+ export interface Correction {
6732
+ /**
6733
+ * <p>The zero-based location in the response string or text where
6734
+ * the corrected word starts.</p>
6735
+ */
6736
+ BeginOffset?: number;
6737
+ /**
6738
+ * <p>The zero-based location in the response string or text where
6739
+ * the corrected word ends.</p>
6740
+ */
6741
+ EndOffset?: number;
6742
+ /**
6743
+ * <p>The string or text of a misspelled word in a query.</p>
6744
+ */
6745
+ Term?: string;
6746
+ /**
6747
+ * <p>The string or text of a corrected misspelled word in a query.</p>
6748
+ */
6749
+ CorrectedTerm?: string;
6750
+ }
6751
+ export declare namespace Correction {
6752
+ /**
6753
+ * @internal
6754
+ */
6755
+ const filterSensitiveLog: (obj: Correction) => any;
6756
+ }
6757
+ /**
6758
+ * <p>A query with suggested spell corrections. </p>
6759
+ */
6760
+ export interface SpellCorrectedQuery {
6761
+ /**
6762
+ * <p>The query with the suggested spell corrections.</p>
6763
+ */
6764
+ SuggestedQueryText?: string;
6765
+ /**
6766
+ * <p>The corrected misspelled word or words in a query.</p>
6767
+ */
6768
+ Corrections?: Correction[];
6769
+ }
6770
+ export declare namespace SpellCorrectedQuery {
6771
+ /**
6772
+ * @internal
6773
+ */
6774
+ const filterSensitiveLog: (obj: SpellCorrectedQuery) => any;
6775
+ }
6668
6776
  export declare enum WarningCode {
6669
6777
  QUERY_LANGUAGE_INVALID_SYNTAX = "QUERY_LANGUAGE_INVALID_SYNTAX"
6670
6778
  }
@@ -6717,6 +6825,10 @@ export interface QueryResult {
6717
6825
  * with advanced query syntax</a>.</p>
6718
6826
  */
6719
6827
  Warnings?: Warning[];
6828
+ /**
6829
+ * <p>A list of information related to suggested spell corrections for a query.</p>
6830
+ */
6831
+ SpellCorrectedQueries?: SpellCorrectedQuery[];
6720
6832
  }
6721
6833
  export declare namespace QueryResult {
6722
6834
  /**
@@ -6727,10 +6839,14 @@ export declare namespace QueryResult {
6727
6839
  /**
6728
6840
  * <p></p>
6729
6841
  */
6730
- export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
6731
- name: "ResourceInUseException";
6732
- $fault: "client";
6842
+ export declare class ResourceInUseException extends __BaseException {
6843
+ readonly name: "ResourceInUseException";
6844
+ readonly $fault: "client";
6733
6845
  Message?: string;
6846
+ /**
6847
+ * @internal
6848
+ */
6849
+ constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
6734
6850
  }
6735
6851
  export interface StartDataSourceSyncJobRequest {
6736
6852
  /**
@@ -6924,7 +7040,7 @@ export interface UpdateDataSourceRequest {
6924
7040
  */
6925
7041
  IndexId: string | undefined;
6926
7042
  /**
6927
- * <p>Configuration information for an Amazon Kendra data source.</p>
7043
+ * <p>Configuration information for an Amazon Kendra data source you want to update.</p>
6928
7044
  */
6929
7045
  Configuration?: DataSourceConfiguration;
6930
7046
  /**
@@ -6985,8 +7101,7 @@ export interface UpdateExperienceRequest {
6985
7101
  */
6986
7102
  RoleArn?: string;
6987
7103
  /**
6988
- * <p>Provides the user configuration information. This includes the Amazon Web Services SSO
6989
- * field name that contains the identifiers of your users, such as their emails.</p>
7104
+ * <p>Configuration information for your Amazon Kendra you want to update.</p>
6990
7105
  */
6991
7106
  Configuration?: ExperienceConfiguration;
6992
7107
  /**
@@ -7019,7 +7134,7 @@ export interface UpdateIndexRequest {
7019
7134
  */
7020
7135
  Description?: string;
7021
7136
  /**
7022
- * <p>The document metadata to update. </p>
7137
+ * <p>The document metadata you want to update.</p>
7023
7138
  */
7024
7139
  DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
7025
7140
  /**
@@ -7363,6 +7478,10 @@ export interface QueryRequest {
7363
7478
  * email address, as the <code>VisitorId</code>.</p>
7364
7479
  */
7365
7480
  VisitorId?: string;
7481
+ /**
7482
+ * <p>Enables suggested spell corrections for queries.</p>
7483
+ */
7484
+ SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
7366
7485
  }
7367
7486
  export declare namespace QueryRequest {
7368
7487
  /**