aws-sdk-kendra 1.23.0 → 1.28.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 13ef9deb75aa3e25a0f22eb8f435dc97249bbb0a9c8620310bcbccae155309ce
4
- data.tar.gz: 32b19f5f2b1295864ebc017073de00eded9ef29f7385db7ebe114d3b2d085143
3
+ metadata.gz: ad23f2213feec43bb1bad01303faec4550233b265115b63025d296de5e69b523
4
+ data.tar.gz: b9f2be8170c8bec1bee41287cad764f7133bab206edf14c3e697ba6bc764f146
5
5
  SHA512:
6
- metadata.gz: ed3c5d1d147b776e2b8e177b2f0de93dcb226d0cb8a56f1de887e33811fd85cb43dedf3c38121073c0130425450f72e3032b4eb352a3ec923a60a900c9565f1f
7
- data.tar.gz: '0996fde8b0b7b298047a6a5d98e6d08d6b396288b9405c6f25be384cad828b34e073691f4857df3181624d4eecff36867457c1dad33199a3c4b6b477497d7c82'
6
+ metadata.gz: ee6b0f2c618e497f0210d12ef9204eb4e07f50414146b7c83ff11c8891eaf5dadb896f1d0680ac3de2c66aa4b36e26714444fd2cf5070503ba06fc861c6ef4e4
7
+ data.tar.gz: 52d0ccbc0c1932fc289567b69ff8c4d6157abdde51c6f39925150005917a001f4cb4a2fe251d51bf457c15bece3de9f8c63fc79f0aeb5e06648ddf041c41db40
data/CHANGELOG.md CHANGED
@@ -1,6 +1,31 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.28.0 (2021-06-24)
5
+ ------------------
6
+
7
+ * Feature - Amazon Kendra now supports SharePoint 2013 and SharePoint 2016 when using a SharePoint data source.
8
+
9
+ 1.27.0 (2021-06-17)
10
+ ------------------
11
+
12
+ * Feature - Amazon Kendra now supports the indexing of web documents for search through the web crawler.
13
+
14
+ 1.26.0 (2021-06-09)
15
+ ------------------
16
+
17
+ * Feature - AWS Kendra now supports checking document status.
18
+
19
+ 1.25.0 (2021-05-27)
20
+ ------------------
21
+
22
+ * Feature - Amazon Kendra now suggests popular queries in order to help guide query typing and help overall accuracy.
23
+
24
+ 1.24.0 (2021-04-21)
25
+ ------------------
26
+
27
+ * Feature - Amazon Kendra now enables users to override index-level boosting configurations for each query.
28
+
4
29
  1.23.0 (2021-04-01)
5
30
  ------------------
6
31
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.23.0
1
+ 1.28.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
48
48
  # @!group service
49
49
  module Aws::Kendra
50
50
 
51
- GEM_VERSION = '1.23.0'
51
+ GEM_VERSION = '1.28.0'
52
52
 
53
53
  end
@@ -364,7 +364,7 @@ module Aws::Kendra
364
364
  # document_id_list: ["DocumentId"], # required
365
365
  # data_source_sync_job_metric_target: {
366
366
  # data_source_id: "DataSourceId", # required
367
- # data_source_sync_job_id: "DataSourceSyncJobId", # required
367
+ # data_source_sync_job_id: "DataSourceSyncJobId",
368
368
  # },
369
369
  # })
370
370
  #
@@ -384,6 +384,85 @@ module Aws::Kendra
384
384
  req.send_request(options)
385
385
  end
386
386
 
387
+ # Returns the indexing status for one or more documents submitted with
388
+ # the [ BatchPutDocument][1] operation.
389
+ #
390
+ # When you use the `BatchPutDocument` operation, documents are indexed
391
+ # asynchronously. You can use the `BatchGetDocumentStatus` operation to
392
+ # get the current status of a list of documents so that you can
393
+ # determine if they have been successfully indexed.
394
+ #
395
+ # You can also use the `BatchGetDocumentStatus` operation to check the
396
+ # status of the [ BatchDeleteDocument][2] operation. When a document is
397
+ # deleted from the index, Amazon Kendra returns `NOT_FOUND` as the
398
+ # status.
399
+ #
400
+ #
401
+ #
402
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
403
+ # [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html
404
+ #
405
+ # @option params [required, String] :index_id
406
+ # The identifier of the index to add documents to. The index ID is
407
+ # returned by the [ CreateIndex ][1] operation.
408
+ #
409
+ #
410
+ #
411
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
412
+ #
413
+ # @option params [required, Array<Types::DocumentInfo>] :document_info_list
414
+ # A list of `DocumentInfo` objects that identify the documents for which
415
+ # to get the status. You identify the documents by their document ID and
416
+ # optional attributes.
417
+ #
418
+ # @return [Types::BatchGetDocumentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
419
+ #
420
+ # * {Types::BatchGetDocumentStatusResponse#errors #errors} => Array&lt;Types::BatchGetDocumentStatusResponseError&gt;
421
+ # * {Types::BatchGetDocumentStatusResponse#document_status_list #document_status_list} => Array&lt;Types::Status&gt;
422
+ #
423
+ # @example Request syntax with placeholder values
424
+ #
425
+ # resp = client.batch_get_document_status({
426
+ # index_id: "IndexId", # required
427
+ # document_info_list: [ # required
428
+ # {
429
+ # document_id: "DocumentId", # required
430
+ # attributes: [
431
+ # {
432
+ # key: "DocumentAttributeKey", # required
433
+ # value: { # required
434
+ # string_value: "DocumentAttributeStringValue",
435
+ # string_list_value: ["String"],
436
+ # long_value: 1,
437
+ # date_value: Time.now,
438
+ # },
439
+ # },
440
+ # ],
441
+ # },
442
+ # ],
443
+ # })
444
+ #
445
+ # @example Response structure
446
+ #
447
+ # resp.errors #=> Array
448
+ # resp.errors[0].document_id #=> String
449
+ # resp.errors[0].error_code #=> String, one of "InternalError", "InvalidRequest"
450
+ # resp.errors[0].error_message #=> String
451
+ # resp.document_status_list #=> Array
452
+ # resp.document_status_list[0].document_id #=> String
453
+ # resp.document_status_list[0].document_status #=> String, one of "NOT_FOUND", "PROCESSING", "INDEXED", "UPDATED", "FAILED", "UPDATE_FAILED"
454
+ # resp.document_status_list[0].failure_code #=> String
455
+ # resp.document_status_list[0].failure_reason #=> String
456
+ #
457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus AWS API Documentation
458
+ #
459
+ # @overload batch_get_document_status(params = {})
460
+ # @param [Hash] params ({})
461
+ def batch_get_document_status(params = {}, options = {})
462
+ req = build_request(:batch_get_document_status, params)
463
+ req.send_request(options)
464
+ end
465
+
387
466
  # Adds one or more documents to an index.
388
467
  #
389
468
  # The `BatchPutDocument` operation enables you to ingest inline
@@ -412,6 +491,12 @@ module Aws::Kendra
412
491
  # @option params [required, Array<Types::Document>] :documents
413
492
  # One or more documents to add to the index.
414
493
  #
494
+ # Documents can include custom attributes. For example, 'DataSourceId'
495
+ # and 'DataSourceSyncJobId' are custom attributes that provide
496
+ # information on the synchronization of documents running on a data
497
+ # source. Note, 'DataSourceSyncJobId' could be an optional custom
498
+ # attribute as Amazon Kendra will use the ID of a running sync job.
499
+ #
415
500
  # Documents have the following file size limits.
416
501
  #
417
502
  # * 5 MB total size for inline documents
@@ -484,6 +569,34 @@ module Aws::Kendra
484
569
  req.send_request(options)
485
570
  end
486
571
 
572
+ # Clears existing query suggestions from an index.
573
+ #
574
+ # This deletes existing suggestions only, not the queries in the query
575
+ # log. After you clear suggestions, Amazon Kendra learns new suggestions
576
+ # based on new queries added to the query log from the time you cleared
577
+ # suggestions. If you do not see any new suggestions, then please allow
578
+ # Amazon Kendra to collect enough queries to learn new suggestions.
579
+ #
580
+ # @option params [required, String] :index_id
581
+ # The identifier of the index you want to clear query suggestions from.
582
+ #
583
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
584
+ #
585
+ # @example Request syntax with placeholder values
586
+ #
587
+ # resp = client.clear_query_suggestions({
588
+ # index_id: "IndexId", # required
589
+ # })
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions AWS API Documentation
592
+ #
593
+ # @overload clear_query_suggestions(params = {})
594
+ # @param [Hash] params ({})
595
+ def clear_query_suggestions(params = {}, options = {})
596
+ req = build_request(:clear_query_suggestions, params)
597
+ req.send_request(options)
598
+ end
599
+
487
600
  # Creates a data source that you use to with an Amazon Kendra index.
488
601
  #
489
602
  # You specify a name, data source connector type and description for
@@ -566,7 +679,7 @@ module Aws::Kendra
566
679
  # resp = client.create_data_source({
567
680
  # name: "DataSourceName", # required
568
681
  # index_id: "IndexId", # required
569
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
682
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER
570
683
  # configuration: {
571
684
  # s3_configuration: {
572
685
  # bucket_name: "S3BucketName", # required
@@ -581,7 +694,7 @@ module Aws::Kendra
581
694
  # },
582
695
  # },
583
696
  # share_point_configuration: {
584
- # share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
697
+ # share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
585
698
  # urls: ["Url"], # required
586
699
  # secret_arn: "SecretArn", # required
587
700
  # crawl_attachments: false,
@@ -601,6 +714,10 @@ module Aws::Kendra
601
714
  # ],
602
715
  # document_title_field_name: "DataSourceFieldName",
603
716
  # disable_local_groups: false,
717
+ # ssl_certificate_s3_path: {
718
+ # bucket: "S3BucketName", # required
719
+ # key: "S3ObjectKey", # required
720
+ # },
604
721
  # },
605
722
  # database_configuration: {
606
723
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -829,6 +946,37 @@ module Aws::Kendra
829
946
  # exclude_user_accounts: ["UserAccount"],
830
947
  # exclude_shared_drives: ["SharedDriveId"],
831
948
  # },
949
+ # web_crawler_configuration: {
950
+ # urls: { # required
951
+ # seed_url_configuration: {
952
+ # seed_urls: ["SeedUrl"], # required
953
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
954
+ # },
955
+ # site_maps_configuration: {
956
+ # site_maps: ["SiteMap"], # required
957
+ # },
958
+ # },
959
+ # crawl_depth: 1,
960
+ # max_links_per_page: 1,
961
+ # max_content_size_per_page_in_mega_bytes: 1.0,
962
+ # max_urls_per_minute_crawl_rate: 1,
963
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
964
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
965
+ # proxy_configuration: {
966
+ # host: "Host", # required
967
+ # port: 1, # required
968
+ # credentials: "SecretArn",
969
+ # },
970
+ # authentication_configuration: {
971
+ # basic_authentication: [
972
+ # {
973
+ # host: "Host", # required
974
+ # port: 1, # required
975
+ # credentials: "SecretArn", # required
976
+ # },
977
+ # ],
978
+ # },
979
+ # },
832
980
  # },
833
981
  # description: "Description",
834
982
  # schedule: "ScanSchedule",
@@ -1065,6 +1213,107 @@ module Aws::Kendra
1065
1213
  req.send_request(options)
1066
1214
  end
1067
1215
 
1216
+ # Creates a block list to exlcude certain queries from suggestions.
1217
+ #
1218
+ # Any query that contains words or phrases specified in the block list
1219
+ # is blocked or filtered out from being shown as a suggestion.
1220
+ #
1221
+ # You need to provide the file location of your block list text file in
1222
+ # your S3 bucket. In your text file, enter each block word or phrase on
1223
+ # a separate line.
1224
+ #
1225
+ # For information on the current quota limits for block lists, see
1226
+ # [Quotas for Amazon Kendra][1].
1227
+ #
1228
+ #
1229
+ #
1230
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1231
+ #
1232
+ # @option params [required, String] :index_id
1233
+ # The identifier of the index you want to create a query suggestions
1234
+ # block list for.
1235
+ #
1236
+ # @option params [required, String] :name
1237
+ # A user friendly name for the block list.
1238
+ #
1239
+ # For example, the block list named 'offensive-words' includes all
1240
+ # offensive words that could appear in user queries and need to be
1241
+ # blocked from suggestions.
1242
+ #
1243
+ # @option params [String] :description
1244
+ # A user-friendly description for the block list.
1245
+ #
1246
+ # For example, the description "List of all offensive words that can
1247
+ # appear in user queries and need to be blocked from suggestions."
1248
+ #
1249
+ # @option params [required, Types::S3Path] :source_s3_path
1250
+ # The S3 path to your block list text file in your S3 bucket.
1251
+ #
1252
+ # Each block word or phrase should be on a separate line in a text file.
1253
+ #
1254
+ # For information on the current quota limits for block lists, see
1255
+ # [Quotas for Amazon Kendra][1].
1256
+ #
1257
+ #
1258
+ #
1259
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1260
+ #
1261
+ # @option params [String] :client_token
1262
+ # A token that you provide to identify the request to create a query
1263
+ # suggestions block list.
1264
+ #
1265
+ # **A suitable default value is auto-generated.** You should normally
1266
+ # not need to pass this option.**
1267
+ #
1268
+ # @option params [required, String] :role_arn
1269
+ # The IAM (Identity and Access Management) role used by Amazon Kendra to
1270
+ # access the block list text file in your S3 bucket.
1271
+ #
1272
+ # You need permissions to the role ARN (Amazon Resource Name). The role
1273
+ # needs S3 read permissions to your file in S3 and needs to give STS
1274
+ # (Security Token Service) assume role permissions to Amazon Kendra.
1275
+ #
1276
+ # @option params [Array<Types::Tag>] :tags
1277
+ # A tag that you can assign to a block list that categorizes the block
1278
+ # list.
1279
+ #
1280
+ # @return [Types::CreateQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1281
+ #
1282
+ # * {Types::CreateQuerySuggestionsBlockListResponse#id #id} => String
1283
+ #
1284
+ # @example Request syntax with placeholder values
1285
+ #
1286
+ # resp = client.create_query_suggestions_block_list({
1287
+ # index_id: "IndexId", # required
1288
+ # name: "QuerySuggestionsBlockListName", # required
1289
+ # description: "Description",
1290
+ # source_s3_path: { # required
1291
+ # bucket: "S3BucketName", # required
1292
+ # key: "S3ObjectKey", # required
1293
+ # },
1294
+ # client_token: "ClientTokenName",
1295
+ # role_arn: "RoleArn", # required
1296
+ # tags: [
1297
+ # {
1298
+ # key: "TagKey", # required
1299
+ # value: "TagValue", # required
1300
+ # },
1301
+ # ],
1302
+ # })
1303
+ #
1304
+ # @example Response structure
1305
+ #
1306
+ # resp.id #=> String
1307
+ #
1308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList AWS API Documentation
1309
+ #
1310
+ # @overload create_query_suggestions_block_list(params = {})
1311
+ # @param [Hash] params ({})
1312
+ def create_query_suggestions_block_list(params = {}, options = {})
1313
+ req = build_request(:create_query_suggestions_block_list, params)
1314
+ req.send_request(options)
1315
+ end
1316
+
1068
1317
  # Creates a thesaurus for an index. The thesaurus contains a list of
1069
1318
  # synonyms in Solr format.
1070
1319
  #
@@ -1220,6 +1469,36 @@ module Aws::Kendra
1220
1469
  req.send_request(options)
1221
1470
  end
1222
1471
 
1472
+ # Deletes a block list used for query suggestions for an index.
1473
+ #
1474
+ # A deleted block list might not take effect right away. Amazon Kendra
1475
+ # needs to refresh the entire suggestions list to add back the queries
1476
+ # that were previously blocked.
1477
+ #
1478
+ # @option params [required, String] :index_id
1479
+ # The identifier of the you want to delete a block list from.
1480
+ #
1481
+ # @option params [required, String] :id
1482
+ # The unique identifier of the block list that needs to be deleted.
1483
+ #
1484
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1485
+ #
1486
+ # @example Request syntax with placeholder values
1487
+ #
1488
+ # resp = client.delete_query_suggestions_block_list({
1489
+ # index_id: "IndexId", # required
1490
+ # id: "QuerySuggestionsBlockListId", # required
1491
+ # })
1492
+ #
1493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList AWS API Documentation
1494
+ #
1495
+ # @overload delete_query_suggestions_block_list(params = {})
1496
+ # @param [Hash] params ({})
1497
+ def delete_query_suggestions_block_list(params = {}, options = {})
1498
+ req = build_request(:delete_query_suggestions_block_list, params)
1499
+ req.send_request(options)
1500
+ end
1501
+
1223
1502
  # Deletes an existing Amazon Kendra thesaurus.
1224
1503
  #
1225
1504
  # @option params [required, String] :id
@@ -1281,7 +1560,7 @@ module Aws::Kendra
1281
1560
  # resp.id #=> String
1282
1561
  # resp.index_id #=> String
1283
1562
  # resp.name #=> String
1284
- # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
1563
+ # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
1285
1564
  # resp.configuration.s3_configuration.bucket_name #=> String
1286
1565
  # resp.configuration.s3_configuration.inclusion_prefixes #=> Array
1287
1566
  # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
@@ -1291,7 +1570,7 @@ module Aws::Kendra
1291
1570
  # resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
1292
1571
  # resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
1293
1572
  # resp.configuration.s3_configuration.access_control_list_configuration.key_path #=> String
1294
- # resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_ONLINE"
1573
+ # resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_2013", "SHAREPOINT_2016", "SHAREPOINT_ONLINE"
1295
1574
  # resp.configuration.share_point_configuration.urls #=> Array
1296
1575
  # resp.configuration.share_point_configuration.urls[0] #=> String
1297
1576
  # resp.configuration.share_point_configuration.secret_arn #=> String
@@ -1311,6 +1590,8 @@ module Aws::Kendra
1311
1590
  # resp.configuration.share_point_configuration.field_mappings[0].index_field_name #=> String
1312
1591
  # resp.configuration.share_point_configuration.document_title_field_name #=> String
1313
1592
  # resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
1593
+ # resp.configuration.share_point_configuration.ssl_certificate_s3_path.bucket #=> String
1594
+ # resp.configuration.share_point_configuration.ssl_certificate_s3_path.key #=> String
1314
1595
  # resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
1315
1596
  # resp.configuration.database_configuration.connection_configuration.database_host #=> String
1316
1597
  # resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
@@ -1467,6 +1748,26 @@ module Aws::Kendra
1467
1748
  # resp.configuration.google_drive_configuration.exclude_user_accounts[0] #=> String
1468
1749
  # resp.configuration.google_drive_configuration.exclude_shared_drives #=> Array
1469
1750
  # resp.configuration.google_drive_configuration.exclude_shared_drives[0] #=> String
1751
+ # resp.configuration.web_crawler_configuration.urls.seed_url_configuration.seed_urls #=> Array
1752
+ # resp.configuration.web_crawler_configuration.urls.seed_url_configuration.seed_urls[0] #=> String
1753
+ # resp.configuration.web_crawler_configuration.urls.seed_url_configuration.web_crawler_mode #=> String, one of "HOST_ONLY", "SUBDOMAINS", "EVERYTHING"
1754
+ # resp.configuration.web_crawler_configuration.urls.site_maps_configuration.site_maps #=> Array
1755
+ # resp.configuration.web_crawler_configuration.urls.site_maps_configuration.site_maps[0] #=> String
1756
+ # resp.configuration.web_crawler_configuration.crawl_depth #=> Integer
1757
+ # resp.configuration.web_crawler_configuration.max_links_per_page #=> Integer
1758
+ # resp.configuration.web_crawler_configuration.max_content_size_per_page_in_mega_bytes #=> Float
1759
+ # resp.configuration.web_crawler_configuration.max_urls_per_minute_crawl_rate #=> Integer
1760
+ # resp.configuration.web_crawler_configuration.url_inclusion_patterns #=> Array
1761
+ # resp.configuration.web_crawler_configuration.url_inclusion_patterns[0] #=> String
1762
+ # resp.configuration.web_crawler_configuration.url_exclusion_patterns #=> Array
1763
+ # resp.configuration.web_crawler_configuration.url_exclusion_patterns[0] #=> String
1764
+ # resp.configuration.web_crawler_configuration.proxy_configuration.host #=> String
1765
+ # resp.configuration.web_crawler_configuration.proxy_configuration.port #=> Integer
1766
+ # resp.configuration.web_crawler_configuration.proxy_configuration.credentials #=> String
1767
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication #=> Array
1768
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].host #=> String
1769
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].port #=> Integer
1770
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].credentials #=> String
1470
1771
  # resp.created_at #=> Time
1471
1772
  # resp.updated_at #=> Time
1472
1773
  # resp.description #=> String
@@ -1617,6 +1918,112 @@ module Aws::Kendra
1617
1918
  req.send_request(options)
1618
1919
  end
1619
1920
 
1921
+ # Describes a block list used for query suggestions for an index.
1922
+ #
1923
+ # This is used to check the current settings that are applied to a block
1924
+ # list.
1925
+ #
1926
+ # @option params [required, String] :index_id
1927
+ # The identifier of the index for the block list.
1928
+ #
1929
+ # @option params [required, String] :id
1930
+ # The unique identifier of the block list.
1931
+ #
1932
+ # @return [Types::DescribeQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1933
+ #
1934
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#index_id #index_id} => String
1935
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#id #id} => String
1936
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#name #name} => String
1937
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#description #description} => String
1938
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#status #status} => String
1939
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#error_message #error_message} => String
1940
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#created_at #created_at} => Time
1941
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#updated_at #updated_at} => Time
1942
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#source_s3_path #source_s3_path} => Types::S3Path
1943
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#item_count #item_count} => Integer
1944
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#file_size_bytes #file_size_bytes} => Integer
1945
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#role_arn #role_arn} => String
1946
+ #
1947
+ # @example Request syntax with placeholder values
1948
+ #
1949
+ # resp = client.describe_query_suggestions_block_list({
1950
+ # index_id: "IndexId", # required
1951
+ # id: "QuerySuggestionsBlockListId", # required
1952
+ # })
1953
+ #
1954
+ # @example Response structure
1955
+ #
1956
+ # resp.index_id #=> String
1957
+ # resp.id #=> String
1958
+ # resp.name #=> String
1959
+ # resp.description #=> String
1960
+ # resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
1961
+ # resp.error_message #=> String
1962
+ # resp.created_at #=> Time
1963
+ # resp.updated_at #=> Time
1964
+ # resp.source_s3_path.bucket #=> String
1965
+ # resp.source_s3_path.key #=> String
1966
+ # resp.item_count #=> Integer
1967
+ # resp.file_size_bytes #=> Integer
1968
+ # resp.role_arn #=> String
1969
+ #
1970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList AWS API Documentation
1971
+ #
1972
+ # @overload describe_query_suggestions_block_list(params = {})
1973
+ # @param [Hash] params ({})
1974
+ def describe_query_suggestions_block_list(params = {}, options = {})
1975
+ req = build_request(:describe_query_suggestions_block_list, params)
1976
+ req.send_request(options)
1977
+ end
1978
+
1979
+ # Describes the settings of query suggestions for an index.
1980
+ #
1981
+ # This is used to check the current settings applied to query
1982
+ # suggestions.
1983
+ #
1984
+ # @option params [required, String] :index_id
1985
+ # The identifier of the index you want to describe query suggestions
1986
+ # settings for.
1987
+ #
1988
+ # @return [Types::DescribeQuerySuggestionsConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1989
+ #
1990
+ # * {Types::DescribeQuerySuggestionsConfigResponse#mode #mode} => String
1991
+ # * {Types::DescribeQuerySuggestionsConfigResponse#status #status} => String
1992
+ # * {Types::DescribeQuerySuggestionsConfigResponse#query_log_look_back_window_in_days #query_log_look_back_window_in_days} => Integer
1993
+ # * {Types::DescribeQuerySuggestionsConfigResponse#include_queries_without_user_information #include_queries_without_user_information} => Boolean
1994
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_number_of_querying_users #minimum_number_of_querying_users} => Integer
1995
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_query_count #minimum_query_count} => Integer
1996
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_suggestions_build_time #last_suggestions_build_time} => Time
1997
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_clear_time #last_clear_time} => Time
1998
+ # * {Types::DescribeQuerySuggestionsConfigResponse#total_suggestions_count #total_suggestions_count} => Integer
1999
+ #
2000
+ # @example Request syntax with placeholder values
2001
+ #
2002
+ # resp = client.describe_query_suggestions_config({
2003
+ # index_id: "IndexId", # required
2004
+ # })
2005
+ #
2006
+ # @example Response structure
2007
+ #
2008
+ # resp.mode #=> String, one of "ENABLED", "LEARN_ONLY"
2009
+ # resp.status #=> String, one of "ACTIVE", "UPDATING"
2010
+ # resp.query_log_look_back_window_in_days #=> Integer
2011
+ # resp.include_queries_without_user_information #=> Boolean
2012
+ # resp.minimum_number_of_querying_users #=> Integer
2013
+ # resp.minimum_query_count #=> Integer
2014
+ # resp.last_suggestions_build_time #=> Time
2015
+ # resp.last_clear_time #=> Time
2016
+ # resp.total_suggestions_count #=> Integer
2017
+ #
2018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig AWS API Documentation
2019
+ #
2020
+ # @overload describe_query_suggestions_config(params = {})
2021
+ # @param [Hash] params ({})
2022
+ def describe_query_suggestions_config(params = {}, options = {})
2023
+ req = build_request(:describe_query_suggestions_config, params)
2024
+ req.send_request(options)
2025
+ end
2026
+
1620
2027
  # Describes an existing Amazon Kendra thesaurus.
1621
2028
  #
1622
2029
  # @option params [required, String] :id
@@ -1674,6 +2081,58 @@ module Aws::Kendra
1674
2081
  req.send_request(options)
1675
2082
  end
1676
2083
 
2084
+ # Fetches the queries that are suggested to your users.
2085
+ #
2086
+ # @option params [required, String] :index_id
2087
+ # The identifier of the index you want to get query suggestions from.
2088
+ #
2089
+ # @option params [required, String] :query_text
2090
+ # The text of a user's query to generate query suggestions.
2091
+ #
2092
+ # A query is suggested if the query prefix matches what a user starts to
2093
+ # type as their query.
2094
+ #
2095
+ # Amazon Kendra does not show any suggestions if a user types fewer than
2096
+ # two characters or more than 60 characters. A query must also have at
2097
+ # least one search result and contain at least one word of more than
2098
+ # four characters.
2099
+ #
2100
+ # @option params [Integer] :max_suggestions_count
2101
+ # The maximum number of query suggestions you want to show to your
2102
+ # users.
2103
+ #
2104
+ # @return [Types::GetQuerySuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2105
+ #
2106
+ # * {Types::GetQuerySuggestionsResponse#query_suggestions_id #query_suggestions_id} => String
2107
+ # * {Types::GetQuerySuggestionsResponse#suggestions #suggestions} => Array&lt;Types::Suggestion&gt;
2108
+ #
2109
+ # @example Request syntax with placeholder values
2110
+ #
2111
+ # resp = client.get_query_suggestions({
2112
+ # index_id: "IndexId", # required
2113
+ # query_text: "SuggestionQueryText", # required
2114
+ # max_suggestions_count: 1,
2115
+ # })
2116
+ #
2117
+ # @example Response structure
2118
+ #
2119
+ # resp.query_suggestions_id #=> String
2120
+ # resp.suggestions #=> Array
2121
+ # resp.suggestions[0].id #=> String
2122
+ # resp.suggestions[0].value.text.text #=> String
2123
+ # resp.suggestions[0].value.text.highlights #=> Array
2124
+ # resp.suggestions[0].value.text.highlights[0].begin_offset #=> Integer
2125
+ # resp.suggestions[0].value.text.highlights[0].end_offset #=> Integer
2126
+ #
2127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions AWS API Documentation
2128
+ #
2129
+ # @overload get_query_suggestions(params = {})
2130
+ # @param [Hash] params ({})
2131
+ def get_query_suggestions(params = {}, options = {})
2132
+ req = build_request(:get_query_suggestions, params)
2133
+ req.send_request(options)
2134
+ end
2135
+
1677
2136
  # Gets statistics about synchronizing Amazon Kendra with a data source.
1678
2137
  #
1679
2138
  # @option params [required, String] :id
@@ -1780,7 +2239,7 @@ module Aws::Kendra
1780
2239
  # resp.summary_items #=> Array
1781
2240
  # resp.summary_items[0].name #=> String
1782
2241
  # resp.summary_items[0].id #=> String
1783
- # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
2242
+ # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
1784
2243
  # resp.summary_items[0].created_at #=> Time
1785
2244
  # resp.summary_items[0].updated_at #=> Time
1786
2245
  # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
@@ -1887,6 +2346,68 @@ module Aws::Kendra
1887
2346
  req.send_request(options)
1888
2347
  end
1889
2348
 
2349
+ # Lists the block lists used for query suggestions for an index.
2350
+ #
2351
+ # For information on the current quota limits for block lists, see
2352
+ # [Quotas for Amazon Kendra][1].
2353
+ #
2354
+ #
2355
+ #
2356
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2357
+ #
2358
+ # @option params [required, String] :index_id
2359
+ # The identifier of the index for a list of all block lists that exist
2360
+ # for that index.
2361
+ #
2362
+ # For information on the current quota limits for block lists, see
2363
+ # [Quotas for Amazon Kendra][1].
2364
+ #
2365
+ #
2366
+ #
2367
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2368
+ #
2369
+ # @option params [String] :next_token
2370
+ # If the previous response was incomplete (because there is more data to
2371
+ # retrieve), Amazon Kendra returns a pagination token in the response.
2372
+ # You can use this pagination token to retrieve the next set of block
2373
+ # lists (`BlockListSummaryItems`).
2374
+ #
2375
+ # @option params [Integer] :max_results
2376
+ # The maximum number of block lists to return.
2377
+ #
2378
+ # @return [Types::ListQuerySuggestionsBlockListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2379
+ #
2380
+ # * {Types::ListQuerySuggestionsBlockListsResponse#block_list_summary_items #block_list_summary_items} => Array&lt;Types::QuerySuggestionsBlockListSummary&gt;
2381
+ # * {Types::ListQuerySuggestionsBlockListsResponse#next_token #next_token} => String
2382
+ #
2383
+ # @example Request syntax with placeholder values
2384
+ #
2385
+ # resp = client.list_query_suggestions_block_lists({
2386
+ # index_id: "IndexId", # required
2387
+ # next_token: "NextToken",
2388
+ # max_results: 1,
2389
+ # })
2390
+ #
2391
+ # @example Response structure
2392
+ #
2393
+ # resp.block_list_summary_items #=> Array
2394
+ # resp.block_list_summary_items[0].id #=> String
2395
+ # resp.block_list_summary_items[0].name #=> String
2396
+ # resp.block_list_summary_items[0].status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
2397
+ # resp.block_list_summary_items[0].created_at #=> Time
2398
+ # resp.block_list_summary_items[0].updated_at #=> Time
2399
+ # resp.block_list_summary_items[0].item_count #=> Integer
2400
+ # resp.next_token #=> String
2401
+ #
2402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists AWS API Documentation
2403
+ #
2404
+ # @overload list_query_suggestions_block_lists(params = {})
2405
+ # @param [Hash] params ({})
2406
+ def list_query_suggestions_block_lists(params = {}, options = {})
2407
+ req = build_request(:list_query_suggestions_block_lists, params)
2408
+ req.send_request(options)
2409
+ end
2410
+
1890
2411
  # Gets a list of tags associated with a specified resource. Indexes,
1891
2412
  # FAQs, and data sources can have tags associated with them.
1892
2413
  #
@@ -2018,6 +2539,23 @@ module Aws::Kendra
2018
2539
  # Sets the type of query. Only results for the specified query type are
2019
2540
  # returned.
2020
2541
  #
2542
+ # @option params [Array<Types::DocumentRelevanceConfiguration>] :document_relevance_override_configurations
2543
+ # Overrides relevance tuning configurations of fields or attributes set
2544
+ # at the index level.
2545
+ #
2546
+ # If you use this API to override the relevance tuning configured at the
2547
+ # index level, but there is no relevance tuning configured at the index
2548
+ # level, then Amazon Kendra does not apply any relevance tuning.
2549
+ #
2550
+ # If there is relevance tuning configured at the index level, but you do
2551
+ # not use this API to override any relevance tuning in the index, then
2552
+ # Amazon Kendra uses the relevance tuning that is configured at the
2553
+ # index level.
2554
+ #
2555
+ # If there is relevance tuning configured for fields at the index level,
2556
+ # but you use this API to override only some of these fields, then for
2557
+ # the fields you did not override, the importance is set to 1.
2558
+ #
2021
2559
  # @option params [Integer] :page_number
2022
2560
  # Query results are returned in pages the size of the `PageSize`
2023
2561
  # parameter. By default, Amazon Kendra returns the first page of
@@ -2144,6 +2682,20 @@ module Aws::Kendra
2144
2682
  # ],
2145
2683
  # requested_document_attributes: ["DocumentAttributeKey"],
2146
2684
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
2685
+ # document_relevance_override_configurations: [
2686
+ # {
2687
+ # name: "DocumentMetadataConfigurationName", # required
2688
+ # relevance: { # required
2689
+ # freshness: false,
2690
+ # importance: 1,
2691
+ # duration: "Duration",
2692
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
2693
+ # value_importance_map: {
2694
+ # "ValueImportanceMapKey" => 1,
2695
+ # },
2696
+ # },
2697
+ # },
2698
+ # ],
2147
2699
  # page_number: 1,
2148
2700
  # page_size: 1,
2149
2701
  # sorting_configuration: {
@@ -2437,7 +2989,7 @@ module Aws::Kendra
2437
2989
  # },
2438
2990
  # },
2439
2991
  # share_point_configuration: {
2440
- # share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
2992
+ # share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
2441
2993
  # urls: ["Url"], # required
2442
2994
  # secret_arn: "SecretArn", # required
2443
2995
  # crawl_attachments: false,
@@ -2457,6 +3009,10 @@ module Aws::Kendra
2457
3009
  # ],
2458
3010
  # document_title_field_name: "DataSourceFieldName",
2459
3011
  # disable_local_groups: false,
3012
+ # ssl_certificate_s3_path: {
3013
+ # bucket: "S3BucketName", # required
3014
+ # key: "S3ObjectKey", # required
3015
+ # },
2460
3016
  # },
2461
3017
  # database_configuration: {
2462
3018
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -2685,6 +3241,37 @@ module Aws::Kendra
2685
3241
  # exclude_user_accounts: ["UserAccount"],
2686
3242
  # exclude_shared_drives: ["SharedDriveId"],
2687
3243
  # },
3244
+ # web_crawler_configuration: {
3245
+ # urls: { # required
3246
+ # seed_url_configuration: {
3247
+ # seed_urls: ["SeedUrl"], # required
3248
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
3249
+ # },
3250
+ # site_maps_configuration: {
3251
+ # site_maps: ["SiteMap"], # required
3252
+ # },
3253
+ # },
3254
+ # crawl_depth: 1,
3255
+ # max_links_per_page: 1,
3256
+ # max_content_size_per_page_in_mega_bytes: 1.0,
3257
+ # max_urls_per_minute_crawl_rate: 1,
3258
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3259
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3260
+ # proxy_configuration: {
3261
+ # host: "Host", # required
3262
+ # port: 1, # required
3263
+ # credentials: "SecretArn",
3264
+ # },
3265
+ # authentication_configuration: {
3266
+ # basic_authentication: [
3267
+ # {
3268
+ # host: "Host", # required
3269
+ # port: 1, # required
3270
+ # credentials: "SecretArn", # required
3271
+ # },
3272
+ # ],
3273
+ # },
3274
+ # },
2688
3275
  # },
2689
3276
  # description: "Description",
2690
3277
  # schedule: "ScanSchedule",
@@ -2795,6 +3382,167 @@ module Aws::Kendra
2795
3382
  req.send_request(options)
2796
3383
  end
2797
3384
 
3385
+ # Updates a block list used for query suggestions for an index.
3386
+ #
3387
+ # Updates to a block list might not take effect right away. Amazon
3388
+ # Kendra needs to refresh the entire suggestions list to apply any
3389
+ # updates to the block list. Other changes not related to the block list
3390
+ # apply immediately.
3391
+ #
3392
+ # If a block list is updating, then you need to wait for the first
3393
+ # update to finish before submitting another update.
3394
+ #
3395
+ # Amazon Kendra supports partial updates, so you only need to provide
3396
+ # the fields you want to update.
3397
+ #
3398
+ # @option params [required, String] :index_id
3399
+ # The identifier of the index for a block list.
3400
+ #
3401
+ # @option params [required, String] :id
3402
+ # The unique identifier of a block list.
3403
+ #
3404
+ # @option params [String] :name
3405
+ # The name of a block list.
3406
+ #
3407
+ # @option params [String] :description
3408
+ # The description for a block list.
3409
+ #
3410
+ # @option params [Types::S3Path] :source_s3_path
3411
+ # The S3 path where your block list text file sits in S3.
3412
+ #
3413
+ # If you update your block list and provide the same path to the block
3414
+ # list text file in S3, then Amazon Kendra reloads the file to refresh
3415
+ # the block list. Amazon Kendra does not automatically refresh your
3416
+ # block list. You need to call the `UpdateQuerySuggestionsBlockList` API
3417
+ # to refresh you block list.
3418
+ #
3419
+ # If you update your block list, then Amazon Kendra asynchronously
3420
+ # refreshes all query suggestions with the latest content in the S3
3421
+ # file. This means changes might not take effect immediately.
3422
+ #
3423
+ # @option params [String] :role_arn
3424
+ # The IAM (Identity and Access Management) role used to access the block
3425
+ # list text file in S3.
3426
+ #
3427
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3428
+ #
3429
+ # @example Request syntax with placeholder values
3430
+ #
3431
+ # resp = client.update_query_suggestions_block_list({
3432
+ # index_id: "IndexId", # required
3433
+ # id: "QuerySuggestionsBlockListId", # required
3434
+ # name: "QuerySuggestionsBlockListName",
3435
+ # description: "Description",
3436
+ # source_s3_path: {
3437
+ # bucket: "S3BucketName", # required
3438
+ # key: "S3ObjectKey", # required
3439
+ # },
3440
+ # role_arn: "RoleArn",
3441
+ # })
3442
+ #
3443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList AWS API Documentation
3444
+ #
3445
+ # @overload update_query_suggestions_block_list(params = {})
3446
+ # @param [Hash] params ({})
3447
+ def update_query_suggestions_block_list(params = {}, options = {})
3448
+ req = build_request(:update_query_suggestions_block_list, params)
3449
+ req.send_request(options)
3450
+ end
3451
+
3452
+ # Updates the settings of query suggestions for an index.
3453
+ #
3454
+ # Amazon Kendra supports partial updates, so you only need to provide
3455
+ # the fields you want to update.
3456
+ #
3457
+ # If an update is currently processing (i.e. 'happening'), you need to
3458
+ # wait for the update to finish before making another update.
3459
+ #
3460
+ # Updates to query suggestions settings might not take effect right
3461
+ # away. The time for your updated settings to take effect depends on the
3462
+ # updates made and the number of search queries in your index.
3463
+ #
3464
+ # You can still enable/disable query suggestions at any time.
3465
+ #
3466
+ # @option params [required, String] :index_id
3467
+ # The identifier of the index you want to update query suggestions
3468
+ # settings for.
3469
+ #
3470
+ # @option params [String] :mode
3471
+ # Set the mode to `ENABLED` or `LEARN_ONLY`.
3472
+ #
3473
+ # By default, Amazon Kendra enables query suggestions. `LEARN_ONLY` mode
3474
+ # allows you to turn off query suggestions. You can to update this at
3475
+ # any time.
3476
+ #
3477
+ # In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
3478
+ # queries to keep suggestions up to date for when you are ready to
3479
+ # switch to ENABLED mode again.
3480
+ #
3481
+ # @option params [Integer] :query_log_look_back_window_in_days
3482
+ # How recent your queries are in your query log time window.
3483
+ #
3484
+ # The time window is the number of days from current day to past days.
3485
+ #
3486
+ # By default, Amazon Kendra sets this to 180.
3487
+ #
3488
+ # @option params [Boolean] :include_queries_without_user_information
3489
+ # `TRUE` to include queries without user information (i.e. all queries,
3490
+ # irrespective of the user), otherwise `FALSE` to only include queries
3491
+ # with user information.
3492
+ #
3493
+ # If you pass user information to Amazon Kendra along with the queries,
3494
+ # you can set this flag to `FALSE` and instruct Amazon Kendra to only
3495
+ # consider queries with user information.
3496
+ #
3497
+ # If you set to `FALSE`, Amazon Kendra only considers queries searched
3498
+ # at least `MinimumQueryCount` times across
3499
+ # `MinimumNumberOfQueryingUsers` unique users for suggestions.
3500
+ #
3501
+ # If you set to `TRUE`, Amazon Kendra ignores all user information and
3502
+ # learns from all queries.
3503
+ #
3504
+ # @option params [Integer] :minimum_number_of_querying_users
3505
+ # The minimum number of unique users who must search a query in order
3506
+ # for the query to be eligible to suggest to your users.
3507
+ #
3508
+ # Increasing this number might decrease the number of suggestions.
3509
+ # However, this ensures a query is searched by many users and is truly
3510
+ # popular to suggest to users.
3511
+ #
3512
+ # How you tune this setting depends on your specific needs.
3513
+ #
3514
+ # @option params [Integer] :minimum_query_count
3515
+ # The the minimum number of times a query must be searched in order to
3516
+ # be eligible to suggest to your users.
3517
+ #
3518
+ # Decreasing this number increases the number of suggestions. However,
3519
+ # this affects the quality of suggestions as it sets a low bar for a
3520
+ # query to be considered popular to suggest to users.
3521
+ #
3522
+ # How you tune this setting depends on your specific needs.
3523
+ #
3524
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3525
+ #
3526
+ # @example Request syntax with placeholder values
3527
+ #
3528
+ # resp = client.update_query_suggestions_config({
3529
+ # index_id: "IndexId", # required
3530
+ # mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
3531
+ # query_log_look_back_window_in_days: 1,
3532
+ # include_queries_without_user_information: false,
3533
+ # minimum_number_of_querying_users: 1,
3534
+ # minimum_query_count: 1,
3535
+ # })
3536
+ #
3537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig AWS API Documentation
3538
+ #
3539
+ # @overload update_query_suggestions_config(params = {})
3540
+ # @param [Hash] params ({})
3541
+ def update_query_suggestions_config(params = {}, options = {})
3542
+ req = build_request(:update_query_suggestions_config, params)
3543
+ req.send_request(options)
3544
+ end
3545
+
2798
3546
  # Updates a thesaurus file associated with an index.
2799
3547
  #
2800
3548
  # @option params [required, String] :id
@@ -2853,7 +3601,7 @@ module Aws::Kendra
2853
3601
  params: params,
2854
3602
  config: config)
2855
3603
  context[:gem_name] = 'aws-sdk-kendra'
2856
- context[:gem_version] = '1.23.0'
3604
+ context[:gem_version] = '1.28.0'
2857
3605
  Seahorse::Client::Request.new(handlers, context)
2858
3606
  end
2859
3607