@aws-sdk/client-kendra 3.145.0 → 3.154.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.
@@ -1,5 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@aws-sdk/types";
2
3
  import { KendraServiceException as __BaseException } from "./KendraServiceException";
4
+ import { FacetResult } from "./models_1";
3
5
  /**
4
6
  * <p>Summary information on an access control configuration that you created for
5
7
  * your documents in an index.</p>
@@ -17,7 +19,7 @@ export interface AccessControlConfigurationSummary {
17
19
  */
18
20
  export interface AccessControlListConfiguration {
19
21
  /**
20
- * <p>Path to the Amazon Web Services S3 bucket that contains the ACL files.</p>
22
+ * <p>Path to the Amazon S3 bucket that contains the ACL files.</p>
21
23
  */
22
24
  KeyPath?: string;
23
25
  }
@@ -212,7 +214,12 @@ export interface AlfrescoConfiguration {
212
214
  SecretArn: string | undefined;
213
215
  /**
214
216
  * <p>The path to the SSL certificate stored in an Amazon S3 bucket. You
215
- * use this to connect to Alfresco.</p>
217
+ * use this to connect to Alfresco if you require a secure SSL
218
+ * connection.</p>
219
+ * <p>You can simply generate a self-signed X509 certificate on any computer using
220
+ * OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
221
+ * <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign
222
+ * an X509 certificate</a>.</p>
216
223
  */
217
224
  SslCertificateS3Path: S3Path | undefined;
218
225
  /**
@@ -1351,6 +1358,10 @@ export interface ConfluenceAttachmentConfiguration {
1351
1358
  */
1352
1359
  AttachmentFieldMappings?: ConfluenceAttachmentToIndexFieldMapping[];
1353
1360
  }
1361
+ export declare enum ConfluenceAuthenticationType {
1362
+ HTTP_BASIC = "HTTP_BASIC",
1363
+ PAT = "PAT"
1364
+ }
1354
1365
  export declare enum ConfluenceBlogFieldName {
1355
1366
  AUTHOR = "AUTHOR",
1356
1367
  DISPLAY_URL = "DISPLAY_URL",
@@ -1461,6 +1472,35 @@ export interface ConfluencePageConfiguration {
1461
1472
  */
1462
1473
  PageFieldMappings?: ConfluencePageToIndexFieldMapping[];
1463
1474
  }
1475
+ /**
1476
+ * <p>Provides the configuration information for a web proxy to connect to
1477
+ * website hosts.</p>
1478
+ */
1479
+ export interface ProxyConfiguration {
1480
+ /**
1481
+ * <p>The name of the website host you want to connect to
1482
+ * via a web proxy server.</p>
1483
+ * <p>For example, the host name of https://a.example.com/page1.html
1484
+ * is "a.example.com".</p>
1485
+ */
1486
+ Host: string | undefined;
1487
+ /**
1488
+ * <p>The port number of the website host you want to connect
1489
+ * to via a web proxy server. </p>
1490
+ * <p>For example, the port for https://a.example.com/page1.html
1491
+ * is 443, the standard port for HTTPS.</p>
1492
+ */
1493
+ Port: number | undefined;
1494
+ /**
1495
+ * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
1496
+ * </p>
1497
+ * <p>The credentials are optional. You use a secret if web proxy credentials
1498
+ * are required to connect to a website host. Amazon Kendra currently support basic
1499
+ * authentication to connect to a web proxy server. The secret stores your
1500
+ * credentials.</p>
1501
+ */
1502
+ Credentials?: string;
1503
+ }
1464
1504
  export declare enum ConfluenceSpaceFieldName {
1465
1505
  DISPLAY_URL = "DISPLAY_URL",
1466
1506
  ITEM_TYPE = "ITEM_TYPE",
@@ -1559,10 +1599,13 @@ export interface ConfluenceConfiguration {
1559
1599
  /**
1560
1600
  * <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
1561
1601
  * that contains the user name and password required to connect to the
1562
- * Confluence instance. If you use Confluence cloud, you use a
1602
+ * Confluence instance. If you use Confluence Cloud, you use a
1563
1603
  * generated API token as the password. For more information, see
1564
1604
  * <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html">Using a
1565
1605
  * Confluence data source</a>.</p>
1606
+ * <p>You can also provide authentication credentials in the form of a
1607
+ * personal access token. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html#confluence-authentication">Authentication
1608
+ * for a Confluence data source</a>.</p>
1566
1609
  */
1567
1610
  SecretArn: string | undefined;
1568
1611
  /**
@@ -1607,6 +1650,29 @@ export interface ConfluenceConfiguration {
1607
1650
  * exclusion pattern takes precedence and the content isn't included in the index.</p>
1608
1651
  */
1609
1652
  ExclusionPatterns?: string[];
1653
+ /**
1654
+ * <p>Configuration information to connect to your Confluence URL instance via a web proxy.
1655
+ * You can use this option for Confluence Server.</p>
1656
+ * <p>You must provide the website host name and port number. For example, the host name of
1657
+ * <i>https://a.example.com/page1.html</i> is "a.example.com" and the port
1658
+ * is 443, the standard port for HTTPS.</p>
1659
+ * <p>Web proxy credentials are optional and you can use them to connect to a web proxy
1660
+ * server that requires basic authentication of user name and password. To store web
1661
+ * proxy credentials, you use a secret in Secrets Manager.</p>
1662
+ * <p>It is recommended that you follow best security practices when configuring your
1663
+ * web proxy. This includes setting up throttling, setting up logging and monitoring,
1664
+ * and applying security patches on a regular basis. If you use your web proxy with
1665
+ * multiple data sources, sync jobs that occur at the same time could strain the load
1666
+ * on your proxy. It is recommended you prepare your proxy beforehand for any security
1667
+ * and load requirements.</p>
1668
+ */
1669
+ ProxyConfiguration?: ProxyConfiguration;
1670
+ /**
1671
+ * <p>Whether you want to connect to Confluence using basic authentication of
1672
+ * user name and password, or a personal access token. You can use a personal access
1673
+ * token for Confluence Server.</p>
1674
+ */
1675
+ AuthenticationType?: ConfluenceAuthenticationType | string;
1610
1676
  }
1611
1677
  /**
1612
1678
  * <p>Provides information about how Amazon Kendra should use the columns of
@@ -1870,8 +1936,13 @@ export interface OnPremiseConfiguration {
1870
1936
  */
1871
1937
  OrganizationName: string | undefined;
1872
1938
  /**
1873
- * <p>The path to the SSL certificate stored in an Amazon S3 bucket.
1874
- * You use this to connect to GitHub. </p>
1939
+ * <p>The path to the SSL certificate stored in an Amazon S3 bucket. You
1940
+ * use this to connect to GitHub if you require a secure SSL
1941
+ * connection.</p>
1942
+ * <p>You can simply generate a self-signed X509 certificate on any computer using
1943
+ * OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
1944
+ * <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign
1945
+ * an X509 certificate</a>.</p>
1875
1946
  */
1876
1947
  SslCertificateS3Path: S3Path | undefined;
1877
1948
  }
@@ -2333,7 +2404,8 @@ export interface OneDriveConfiguration {
2333
2404
  */
2334
2405
  export interface QuipConfiguration {
2335
2406
  /**
2336
- * <p>The Quip site domain.</p>
2407
+ * <p>The Quip site domain. For example, <i>https://quip-company.quipdomain.com/browse</i>.
2408
+ * The domain in this example is "quipdomain".</p>
2337
2409
  */
2338
2410
  Domain: string | undefined;
2339
2411
  /**
@@ -2365,7 +2437,11 @@ export interface QuipConfiguration {
2365
2437
  */
2366
2438
  CrawlAttachments?: boolean;
2367
2439
  /**
2368
- * <p>The identifiers of the Quip folders you want to index.</p>
2440
+ * <p>The identifiers of the Quip folders you want to index. You
2441
+ * can find the folder ID in your browser URL when you access your folder
2442
+ * in Quip. For example,
2443
+ * <i>https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name</i>.
2444
+ * The folder ID in this example is "zlLuOVNSarTL".</p>
2369
2445
  */
2370
2446
  FolderIds?: string[];
2371
2447
  /**
@@ -2968,7 +3044,7 @@ export interface SharePointConfiguration {
2968
3044
  */
2969
3045
  SharePointVersion: SharePointVersion | string | undefined;
2970
3046
  /**
2971
- * <p>The Microsoft SharePoint site URLs for the documents you want to indext.</p>
3047
+ * <p>The Microsoft SharePoint site URLs for the documents you want to index.</p>
2972
3048
  */
2973
3049
  Urls: string[] | undefined;
2974
3050
  /**
@@ -3044,8 +3120,13 @@ export interface SharePointConfiguration {
3044
3120
  */
3045
3121
  DisableLocalGroups?: boolean;
3046
3122
  /**
3047
- * <p>The path to the SSL certificate stored in an Amazon S3 bucket. You use
3048
- * this to connect to SharePoint.</p>
3123
+ * <p>The path to the SSL certificate stored in an Amazon S3 bucket. You
3124
+ * use this to connect to SharePoint Server if you require a secure SSL
3125
+ * connection.</p>
3126
+ * <p>You can simply generate a self-signed X509 certificate on any computer using
3127
+ * OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
3128
+ * <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create and sign
3129
+ * an X509 certificate</a>.</p>
3049
3130
  */
3050
3131
  SslCertificateS3Path?: S3Path;
3051
3132
  /**
@@ -3055,6 +3136,23 @@ export interface SharePointConfiguration {
3055
3136
  * SharePoint Online.</p>
3056
3137
  */
3057
3138
  AuthenticationType?: SharePointOnlineAuthenticationType | string;
3139
+ /**
3140
+ * <p>Configuration information to connect to your Microsoft SharePoint site URLs
3141
+ * via instance via a web proxy. You can use this option for SharePoint Server.</p>
3142
+ * <p>You must provide the website host name and port number. For example, the host name of
3143
+ * <i>https://a.example.com/page1.html</i> is "a.example.com" and the port
3144
+ * is 443, the standard port for HTTPS.</p>
3145
+ * <p>Web proxy credentials are optional and you can use them to connect to a web proxy
3146
+ * server that requires basic authentication of user name and password. To store web
3147
+ * proxy credentials, you use a secret in Secrets Manager.</p>
3148
+ * <p>It is recommended that you follow best security practices when configuring your
3149
+ * web proxy. This includes setting up throttling, setting up logging and monitoring,
3150
+ * and applying security patches on a regular basis. If you use your web proxy with
3151
+ * multiple data sources, sync jobs that occur at the same time could strain the load
3152
+ * on your proxy. It is recommended you prepare your proxy beforehand for any security
3153
+ * and load requirements.</p>
3154
+ */
3155
+ ProxyConfiguration?: ProxyConfiguration;
3058
3156
  }
3059
3157
  export declare enum SlackEntity {
3060
3158
  DIRECT_MESSAGE = "DIRECT_MESSAGE",
@@ -3170,33 +3268,24 @@ export interface SlackConfiguration {
3170
3268
  FieldMappings?: DataSourceToIndexFieldMapping[];
3171
3269
  }
3172
3270
  /**
3173
- * <p>Provides the configuration information for a web proxy to connect to
3174
- * website hosts.</p>
3271
+ * <p>Provides a template for the configuration information to connect
3272
+ * to your data source.</p>
3175
3273
  */
3176
- export interface ProxyConfiguration {
3177
- /**
3178
- * <p>The name of the website host you want to connect to
3179
- * via a web proxy server.</p>
3180
- * <p>For example, the host name of https://a.example.com/page1.html
3181
- * is "a.example.com".</p>
3182
- */
3183
- Host: string | undefined;
3184
- /**
3185
- * <p>The port number of the website host you want to connect
3186
- * to via a web proxy server. </p>
3187
- * <p>For example, the port for https://a.example.com/page1.html
3188
- * is 443, the standard port for HTTPS.</p>
3189
- */
3190
- Port: number | undefined;
3274
+ export interface TemplateConfiguration {
3191
3275
  /**
3192
- * <p>Your secret ARN, which you can create in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>
3193
- * </p>
3194
- * <p>The credentials are optional. You use a secret if web proxy credentials
3195
- * are required to connect to a website host. Amazon Kendra currently support basic
3196
- * authentication to connect to a web proxy server. The secret stores your
3197
- * credentials.</p>
3276
+ * <p>The template schema used for the data source.</p>
3277
+ * <p>The following links to the template schema for data sources
3278
+ * where templates are supported:</p>
3279
+ * <ul>
3280
+ * <li>
3281
+ * <p>
3282
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-zendesk.html#zendesk-template-schema">Zendesk
3283
+ * template schema</a>
3284
+ * </p>
3285
+ * </li>
3286
+ * </ul>
3198
3287
  */
3199
- Credentials?: string;
3288
+ Template?: __DocumentType;
3200
3289
  }
3201
3290
  export declare enum WebCrawlerMode {
3202
3291
  EVERYTHING = "EVERYTHING",
@@ -3536,6 +3625,11 @@ export interface DataSourceConfiguration {
3536
3625
  * data source.</p>
3537
3626
  */
3538
3627
  AlfrescoConfiguration?: AlfrescoConfiguration;
3628
+ /**
3629
+ * <p>Provides a template for the configuration information to connect
3630
+ * to your data source.</p>
3631
+ */
3632
+ TemplateConfiguration?: TemplateConfiguration;
3539
3633
  }
3540
3634
  /**
3541
3635
  * <p>A list of key/value pairs that identify an index, FAQ, or data source.
@@ -3571,13 +3665,13 @@ export declare enum DataSourceType {
3571
3665
  SERVICENOW = "SERVICENOW",
3572
3666
  SHAREPOINT = "SHAREPOINT",
3573
3667
  SLACK = "SLACK",
3668
+ TEMPLATE = "TEMPLATE",
3574
3669
  WEBCRAWLER = "WEBCRAWLER",
3575
3670
  WORKDOCS = "WORKDOCS"
3576
3671
  }
3577
3672
  export interface CreateDataSourceRequest {
3578
3673
  /**
3579
- * <p>A unique name for the data source connector. A data source name can't be changed
3580
- * without deleting and recreating the data source connector.</p>
3674
+ * <p>A name for the data source connector.</p>
3581
3675
  */
3582
3676
  Name: string | undefined;
3583
3677
  /**
@@ -3597,6 +3691,11 @@ export interface CreateDataSourceRequest {
3597
3691
  * data sources.</p>
3598
3692
  */
3599
3693
  Configuration?: DataSourceConfiguration;
3694
+ /**
3695
+ * <p>Configuration information for an Amazon Virtual Private Cloud to connect to your
3696
+ * data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
3697
+ */
3698
+ VpcConfiguration?: DataSourceVpcConfiguration;
3600
3699
  /**
3601
3700
  * <p>A description for the data source connector.</p>
3602
3701
  */
@@ -3614,7 +3713,8 @@ export interface CreateDataSourceRequest {
3614
3713
  Schedule?: string;
3615
3714
  /**
3616
3715
  * <p>The Amazon Resource Name (ARN) of a role with permission to access the
3617
- * data source connector. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM Roles for
3716
+ * data source and required resources. For more information, see
3717
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for
3618
3718
  * Amazon Kendra</a>.</p>
3619
3719
  * <p>You can't specify the <code>RoleArn</code> parameter when the
3620
3720
  * <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
@@ -4129,11 +4229,11 @@ export interface DeleteAccessControlConfigurationResponse {
4129
4229
  }
4130
4230
  export interface DeleteDataSourceRequest {
4131
4231
  /**
4132
- * <p>The identifier of the data source you want to delete.</p>
4232
+ * <p>The identifier of the data source connector you want to delete.</p>
4133
4233
  */
4134
4234
  Id: string | undefined;
4135
4235
  /**
4136
- * <p>The identifier of the index used with the data source.</p>
4236
+ * <p>The identifier of the index used with the data source connector.</p>
4137
4237
  */
4138
4238
  IndexId: string | undefined;
4139
4239
  }
@@ -4263,11 +4363,11 @@ export interface DescribeAccessControlConfigurationResponse {
4263
4363
  }
4264
4364
  export interface DescribeDataSourceRequest {
4265
4365
  /**
4266
- * <p>The identifier of the data source.</p>
4366
+ * <p>The identifier of the data source connector.</p>
4267
4367
  */
4268
4368
  Id: string | undefined;
4269
4369
  /**
4270
- * <p>The identifier of the index used with the data source.</p>
4370
+ * <p>The identifier of the index used with the data source connector.</p>
4271
4371
  */
4272
4372
  IndexId: string | undefined;
4273
4373
  }
@@ -4280,41 +4380,46 @@ export declare enum DataSourceStatus {
4280
4380
  }
4281
4381
  export interface DescribeDataSourceResponse {
4282
4382
  /**
4283
- * <p>The identifier of the data source.</p>
4383
+ * <p>The identifier of the data source connector.</p>
4284
4384
  */
4285
4385
  Id?: string;
4286
4386
  /**
4287
- * <p>The identifier of the index that contains the data source.</p>
4387
+ * <p>The identifier of the index used with the data source connector.</p>
4288
4388
  */
4289
4389
  IndexId?: string;
4290
4390
  /**
4291
- * <p>The name that you gave the data source when it was created.</p>
4391
+ * <p>The name for the data source connector.</p>
4292
4392
  */
4293
4393
  Name?: string;
4294
4394
  /**
4295
- * <p>The type of the data source.</p>
4395
+ * <p>The type of the data source. For example, <code>SHAREPOINT</code>.</p>
4296
4396
  */
4297
4397
  Type?: DataSourceType | string;
4298
4398
  /**
4299
- * <p>Configuration details for the data source. This shows how the
4399
+ * <p>Configuration details for the data source connector. This shows how the
4300
4400
  * data source is configured. The configuration options for a data
4301
4401
  * source depend on the data source provider.</p>
4302
4402
  */
4303
4403
  Configuration?: DataSourceConfiguration;
4304
4404
  /**
4305
- * <p>The Unix timestamp of when the data source was created.</p>
4405
+ * <p>Configuration information for an Amazon Virtual Private Cloud to connect to your
4406
+ * data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
4407
+ */
4408
+ VpcConfiguration?: DataSourceVpcConfiguration;
4409
+ /**
4410
+ * <p>The Unix timestamp of when the data source connector was created.</p>
4306
4411
  */
4307
4412
  CreatedAt?: Date;
4308
4413
  /**
4309
- * <p>The Unix timestamp of when the data source was last updated.</p>
4414
+ * <p>The Unix timestamp of when the data source connector was last updated.</p>
4310
4415
  */
4311
4416
  UpdatedAt?: Date;
4312
4417
  /**
4313
- * <p>The description for the data source.</p>
4418
+ * <p>The description for the data source connector.</p>
4314
4419
  */
4315
4420
  Description?: string;
4316
4421
  /**
4317
- * <p>The current status of the data source. When the status is
4422
+ * <p>The current status of the data source connector. When the status is
4318
4423
  * <code>ACTIVE</code> the data source is ready to use. When the status is
4319
4424
  * <code>FAILED</code>, the <code>ErrorMessage</code> field contains the
4320
4425
  * reason that the data source failed.</p>
@@ -4325,8 +4430,8 @@ export interface DescribeDataSourceResponse {
4325
4430
  */
4326
4431
  Schedule?: string;
4327
4432
  /**
4328
- * <p>The Amazon Resource Name (ARN) of the role that enables the data
4329
- * source to access its resources.</p>
4433
+ * <p>The Amazon Resource Name (ARN) of the role with permission to access
4434
+ * the data source and required resources.</p>
4330
4435
  */
4331
4436
  RoleArn?: string;
4332
4437
  /**
@@ -5445,18 +5550,18 @@ export interface ListAccessControlConfigurationsResponse {
5445
5550
  }
5446
5551
  export interface ListDataSourcesRequest {
5447
5552
  /**
5448
- * <p>The identifier of the index used with one or more data sources.</p>
5553
+ * <p>The identifier of the index used with one or more data source connectors.</p>
5449
5554
  */
5450
5555
  IndexId: string | undefined;
5451
5556
  /**
5452
5557
  * <p>If the previous response was incomplete (because there is more data to
5453
5558
  * retrieve), Amazon Kendra returns a pagination token in the response. You
5454
- * can use this pagination token to retrieve the next set of data sources
5559
+ * can use this pagination token to retrieve the next set of data source connectors
5455
5560
  * (<code>DataSourceSummaryItems</code>). </p>
5456
5561
  */
5457
5562
  NextToken?: string;
5458
5563
  /**
5459
- * <p>The maximum number of data sources to return.</p>
5564
+ * <p>The maximum number of data source connectors to return.</p>
5460
5565
  */
5461
5566
  MaxResults?: number;
5462
5567
  }
@@ -5501,13 +5606,13 @@ export interface DataSourceSummary {
5501
5606
  }
5502
5607
  export interface ListDataSourcesResponse {
5503
5608
  /**
5504
- * <p>An array of summary information for one or more data sources.</p>
5609
+ * <p>An array of summary information for one or more data source connector.</p>
5505
5610
  */
5506
5611
  SummaryItems?: DataSourceSummary[];
5507
5612
  /**
5508
5613
  * <p>If the response is truncated, Amazon Kendra returns this token that you
5509
5614
  * can use in the subsequent request to retrieve the next set of data
5510
- * sources. </p>
5615
+ * source connectors.</p>
5511
5616
  */
5512
5617
  NextToken?: string;
5513
5618
  }
@@ -5522,11 +5627,11 @@ export declare enum DataSourceSyncJobStatus {
5522
5627
  }
5523
5628
  export interface ListDataSourceSyncJobsRequest {
5524
5629
  /**
5525
- * <p>The identifier of the data source.</p>
5630
+ * <p>The identifier of the data source connector.</p>
5526
5631
  */
5527
5632
  Id: string | undefined;
5528
5633
  /**
5529
- * <p>The identifier of the index used with the data source.</p>
5634
+ * <p>The identifier of the index used with the data source connector.</p>
5530
5635
  */
5531
5636
  IndexId: string | undefined;
5532
5637
  /**
@@ -5543,11 +5648,11 @@ export interface ListDataSourceSyncJobsRequest {
5543
5648
  MaxResults?: number;
5544
5649
  /**
5545
5650
  * <p>When specified, the synchronization jobs returned in the list are
5546
- * limited to jobs between the specified dates. </p>
5651
+ * limited to jobs between the specified dates.</p>
5547
5652
  */
5548
5653
  StartTimeFilter?: TimeRange;
5549
5654
  /**
5550
- * <p>When specified, only returns synchronization jobs with the
5655
+ * <p>Only returns synchronization jobs with the
5551
5656
  * <code>Status</code> field equal to the specified status.</p>
5552
5657
  */
5553
5658
  StatusFilter?: DataSourceSyncJobStatus | string;
@@ -5637,7 +5742,7 @@ export interface DataSourceSyncJob {
5637
5742
  }
5638
5743
  export interface ListDataSourceSyncJobsResponse {
5639
5744
  /**
5640
- * <p>A history of synchronization jobs for the data source.</p>
5745
+ * <p>A history of synchronization jobs for the data source connector.</p>
5641
5746
  */
5642
5747
  History?: DataSourceSyncJob[];
5643
5748
  /**
@@ -6601,11 +6706,11 @@ export declare class ResourceInUseException extends __BaseException {
6601
6706
  }
6602
6707
  export interface StartDataSourceSyncJobRequest {
6603
6708
  /**
6604
- * <p>The identifier of the data source to synchronize.</p>
6709
+ * <p>The identifier of the data source connector to synchronize.</p>
6605
6710
  */
6606
6711
  Id: string | undefined;
6607
6712
  /**
6608
- * <p>The identifier of the index that contains the data source.</p>
6713
+ * <p>The identifier of the index used with the data source connector.</p>
6609
6714
  */
6610
6715
  IndexId: string | undefined;
6611
6716
  }
@@ -6617,12 +6722,12 @@ export interface StartDataSourceSyncJobResponse {
6617
6722
  }
6618
6723
  export interface StopDataSourceSyncJobRequest {
6619
6724
  /**
6620
- * <p>The identifier of the data source for which to stop the
6725
+ * <p>The identifier of the data source connector for which to stop the
6621
6726
  * synchronization jobs.</p>
6622
6727
  */
6623
6728
  Id: string | undefined;
6624
6729
  /**
6625
- * <p>The identifier of the index that contains the data source.</p>
6730
+ * <p>The identifier of the index used with the data source connector.</p>
6626
6731
  */
6627
6732
  IndexId: string | undefined;
6628
6733
  }
@@ -6748,13 +6853,11 @@ export interface UpdateAccessControlConfigurationResponse {
6748
6853
  }
6749
6854
  export interface UpdateDataSourceRequest {
6750
6855
  /**
6751
- * <p>The identifier of the data source you want to update.</p>
6856
+ * <p>The identifier of the data source connector you want to update.</p>
6752
6857
  */
6753
6858
  Id: string | undefined;
6754
6859
  /**
6755
- * <p>A new name for the data source connector. You must
6756
- * first delete the data source and re-create it to change the
6757
- * name of the data source.</p>
6860
+ * <p>A new name for the data source connector.</p>
6758
6861
  */
6759
6862
  Name?: string;
6760
6863
  /**
@@ -6765,6 +6868,11 @@ export interface UpdateDataSourceRequest {
6765
6868
  * <p>Configuration information you want to update for the data source connector.</p>
6766
6869
  */
6767
6870
  Configuration?: DataSourceConfiguration;
6871
+ /**
6872
+ * <p>Configuration information for an Amazon Virtual Private Cloud to connect to your
6873
+ * data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
6874
+ */
6875
+ VpcConfiguration?: DataSourceVpcConfiguration;
6768
6876
  /**
6769
6877
  * <p>A new description for the data source connector.</p>
6770
6878
  */
@@ -6775,7 +6883,7 @@ export interface UpdateDataSourceRequest {
6775
6883
  Schedule?: string;
6776
6884
  /**
6777
6885
  * <p>The Amazon Resource Name (ARN) of a role with permission to access
6778
- * the data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM Roles for
6886
+ * the data source and required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for
6779
6887
  * Amazon Kendra</a>.</p>
6780
6888
  */
6781
6889
  RoleArn?: string;
@@ -7056,114 +7164,6 @@ export interface DocumentAttributeValueCountPair {
7056
7164
  */
7057
7165
  FacetResults?: FacetResult[];
7058
7166
  }
7059
- /**
7060
- * <p>The facet values for the documents in the response.</p>
7061
- */
7062
- export interface FacetResult {
7063
- /**
7064
- * <p>The key for the facet values. This is the same as the
7065
- * <code>DocumentAttributeKey</code> provided in the query.</p>
7066
- */
7067
- DocumentAttributeKey?: string;
7068
- /**
7069
- * <p>The data type of the facet value. This is the same as the type
7070
- * defined for the index field when it was created.</p>
7071
- */
7072
- DocumentAttributeValueType?: DocumentAttributeValueType | string;
7073
- /**
7074
- * <p>An array of key/value pairs, where the key is the value of the
7075
- * attribute and the count is the number of documents that share the key
7076
- * value.</p>
7077
- */
7078
- DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
7079
- }
7080
- /**
7081
- * <p>Provides filtering the query results based on document
7082
- * attributes.</p>
7083
- * <p>When you use the <code>AndAllFilters</code> or
7084
- * <code>OrAllFilters</code>, filters you can use 2 layers under the
7085
- * first attribute filter. For example, you can use:</p>
7086
- * <p>
7087
- * <code><AndAllFilters></code>
7088
- * </p>
7089
- * <ol>
7090
- * <li>
7091
- * <p>
7092
- * <code> <OrAllFilters></code>
7093
- * </p>
7094
- * </li>
7095
- * <li>
7096
- * <p>
7097
- * <code> <EqualsTo></code>
7098
- * </p>
7099
- * </li>
7100
- * </ol>
7101
- * <p>If you use more than 2 layers, you receive a
7102
- * <code>ValidationException</code> exception with the message
7103
- * "<code>AttributeFilter</code> cannot have a depth of more
7104
- * than 2."</p>
7105
- * <p>If you use more than 10 attribute filters in a given list for
7106
- * <code>AndAllFilters</code> or <code>OrAllFilters</code>, you receive
7107
- * a <code>ValidationException</code> with the message
7108
- * "<code>AttributeFilter</code> cannot have a length of more than 10".</p>
7109
- */
7110
- export interface AttributeFilter {
7111
- /**
7112
- * <p>Performs a logical <code>AND</code> operation on all supplied
7113
- * filters.</p>
7114
- */
7115
- AndAllFilters?: AttributeFilter[];
7116
- /**
7117
- * <p>Performs a logical <code>OR</code> operation on all supplied
7118
- * filters.</p>
7119
- */
7120
- OrAllFilters?: AttributeFilter[];
7121
- /**
7122
- * <p>Performs a logical <code>NOT</code> operation on all supplied
7123
- * filters.</p>
7124
- */
7125
- NotFilter?: AttributeFilter;
7126
- /**
7127
- * <p>Performs an equals operation on two document attributes.</p>
7128
- */
7129
- EqualsTo?: DocumentAttribute;
7130
- /**
7131
- * <p>Returns true when a document contains all of the specified document
7132
- * attributes. This filter is only applicable to
7133
- * <code>StringListValue</code> metadata.</p>
7134
- */
7135
- ContainsAll?: DocumentAttribute;
7136
- /**
7137
- * <p>Returns true when a document contains any of the specified document
7138
- * attributes. This filter is only applicable to
7139
- * <code>StringListValue</code> metadata.</p>
7140
- */
7141
- ContainsAny?: DocumentAttribute;
7142
- /**
7143
- * <p>Performs a greater than operation on two document attributes. Use
7144
- * with a document attribute of type <code>Date</code> or
7145
- * <code>Long</code>.</p>
7146
- */
7147
- GreaterThan?: DocumentAttribute;
7148
- /**
7149
- * <p>Performs a greater or equals than operation on two document
7150
- * attributes. Use with a document attribute of type <code>Date</code>
7151
- * or <code>Long</code>.</p>
7152
- */
7153
- GreaterThanOrEquals?: DocumentAttribute;
7154
- /**
7155
- * <p>Performs a less than operation on two document attributes. Use with
7156
- * a document attribute of type <code>Date</code> or
7157
- * <code>Long</code>.</p>
7158
- */
7159
- LessThan?: DocumentAttribute;
7160
- /**
7161
- * <p>Performs a less than or equals operation on two document attributes.
7162
- * Use with a document attribute of type <code>Date</code> or
7163
- * <code>Long</code>.</p>
7164
- */
7165
- LessThanOrEquals?: DocumentAttribute;
7166
- }
7167
7167
  /**
7168
7168
  * @internal
7169
7169
  */
@@ -7372,6 +7372,10 @@ export declare const ConfluencePageToIndexFieldMappingFilterSensitiveLog: (obj:
7372
7372
  * @internal
7373
7373
  */
7374
7374
  export declare const ConfluencePageConfigurationFilterSensitiveLog: (obj: ConfluencePageConfiguration) => any;
7375
+ /**
7376
+ * @internal
7377
+ */
7378
+ export declare const ProxyConfigurationFilterSensitiveLog: (obj: ProxyConfiguration) => any;
7375
7379
  /**
7376
7380
  * @internal
7377
7381
  */
@@ -7499,7 +7503,7 @@ export declare const SlackConfigurationFilterSensitiveLog: (obj: SlackConfigurat
7499
7503
  /**
7500
7504
  * @internal
7501
7505
  */
7502
- export declare const ProxyConfigurationFilterSensitiveLog: (obj: ProxyConfiguration) => any;
7506
+ export declare const TemplateConfigurationFilterSensitiveLog: (obj: TemplateConfiguration) => any;
7503
7507
  /**
7504
7508
  * @internal
7505
7509
  */
@@ -8088,11 +8092,3 @@ export declare const FacetFilterSensitiveLog: (obj: Facet) => any;
8088
8092
  * @internal
8089
8093
  */
8090
8094
  export declare const DocumentAttributeValueCountPairFilterSensitiveLog: (obj: DocumentAttributeValueCountPair) => any;
8091
- /**
8092
- * @internal
8093
- */
8094
- export declare const FacetResultFilterSensitiveLog: (obj: FacetResult) => any;
8095
- /**
8096
- * @internal
8097
- */
8098
- export declare const AttributeFilterFilterSensitiveLog: (obj: AttributeFilter) => any;