aws-sdk-kendra 1.22.0 → 1.27.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: a5b1f6f700a2e9457090c9fa3be05fa5d10d03b625362a763e92753103541a1a
4
- data.tar.gz: 76b827d689a96cd3dc80034fd6aa8f64769528f296635ff1c9d3ec3e9c0ae665
3
+ metadata.gz: 18f9a0673af8278a3066d865646525130986d0d6fce53f4a84fc8b10efb26e21
4
+ data.tar.gz: 1b782bf81e35136fc3b2fd540bcc97821f38707b6159977a0e6243bc51b33253
5
5
  SHA512:
6
- metadata.gz: c85b240608c91f2212faf2ce73460d686a779196751df375bb72e1094d603c9ff4947106744af7f45af010dc7831ca2d125911ae1be9dcd29fa5324c87014682
7
- data.tar.gz: eb1adc711d6a4d8b3c3436b79b79652b75fea2dfa1da0632e36d0941a146f6b2c09ae7145b2cbea80c3a21fddc3ea68be697624d7d0139fae3f9b99874d656ef
6
+ metadata.gz: e91319bbb2301cbf8c9fb6900922854688faf4fac89b62c2ce9c5e1f5f36265e33cc3e5faa5dbfb581128c06ea406acc49be1b6c168c9920707b87aa28dffd72
7
+ data.tar.gz: ab38e61328b8e4b91f9354a2f23e74b98040d4477742ad86219cfc5de2c79e3ca36423574a13dbe2c6de1b5d45e1a36de594a36d8d9e29cd464a08a760986408
data/CHANGELOG.md CHANGED
@@ -1,6 +1,31 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.27.0 (2021-06-17)
5
+ ------------------
6
+
7
+ * Feature - Amazon Kendra now supports the indexing of web documents for search through the web crawler.
8
+
9
+ 1.26.0 (2021-06-09)
10
+ ------------------
11
+
12
+ * Feature - AWS Kendra now supports checking document status.
13
+
14
+ 1.25.0 (2021-05-27)
15
+ ------------------
16
+
17
+ * Feature - Amazon Kendra now suggests popular queries in order to help guide query typing and help overall accuracy.
18
+
19
+ 1.24.0 (2021-04-21)
20
+ ------------------
21
+
22
+ * Feature - Amazon Kendra now enables users to override index-level boosting configurations for each query.
23
+
24
+ 1.23.0 (2021-04-01)
25
+ ------------------
26
+
27
+ * Feature - AWS Kendra's ServiceNow data source now supports OAuth 2.0 authentication and knowledge article filtering via a ServiceNow query.
28
+
4
29
  1.22.0 (2021-03-10)
5
30
  ------------------
6
31
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.22.0
1
+ 1.27.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.22.0'
51
+ GEM_VERSION = '1.27.0'
52
52
 
53
53
  end
@@ -338,10 +338,10 @@ module Aws::Kendra
338
338
  # @!group API Operations
339
339
 
340
340
  # Removes one or more documents from an index. The documents must have
341
- # been added with the BatchPutDocument operation.
341
+ # been added with the `BatchPutDocument` operation.
342
342
  #
343
343
  # The documents are deleted asynchronously. You can see the progress of
344
- # the deletion by using AWS CloudWatch. Any error messages releated to
344
+ # the deletion by using AWS CloudWatch. Any error messages related to
345
345
  # the processing of the batch are sent to you CloudWatch log.
346
346
  #
347
347
  # @option params [required, String] :index_id
@@ -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
@@ -398,7 +477,7 @@ module Aws::Kendra
398
477
  #
399
478
  # @option params [required, String] :index_id
400
479
  # The identifier of the index to add the documents to. You need to
401
- # create the index first using the CreateIndex operation.
480
+ # create the index first using the `CreateIndex` operation.
402
481
  #
403
482
  # @option params [String] :role_arn
404
483
  # The Amazon Resource Name (ARN) of a role that is allowed to run the
@@ -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
@@ -744,6 +857,7 @@ module Aws::Kendra
744
857
  # index_field_name: "IndexFieldName", # required
745
858
  # },
746
859
  # ],
860
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
747
861
  # },
748
862
  # service_catalog_configuration: {
749
863
  # crawl_attachments: false,
@@ -759,6 +873,7 @@ module Aws::Kendra
759
873
  # },
760
874
  # ],
761
875
  # },
876
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
762
877
  # },
763
878
  # confluence_configuration: {
764
879
  # server_url: "Url", # required
@@ -827,6 +942,37 @@ module Aws::Kendra
827
942
  # exclude_user_accounts: ["UserAccount"],
828
943
  # exclude_shared_drives: ["SharedDriveId"],
829
944
  # },
945
+ # web_crawler_configuration: {
946
+ # urls: { # required
947
+ # seed_url_configuration: {
948
+ # seed_urls: ["SeedUrl"], # required
949
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
950
+ # },
951
+ # site_maps_configuration: {
952
+ # site_maps: ["SiteMap"], # required
953
+ # },
954
+ # },
955
+ # crawl_depth: 1,
956
+ # max_links_per_page: 1,
957
+ # max_content_size_per_page_in_mega_bytes: 1.0,
958
+ # max_urls_per_minute_crawl_rate: 1,
959
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
960
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
961
+ # proxy_configuration: {
962
+ # host: "Host", # required
963
+ # port: 1, # required
964
+ # credentials: "SecretArn",
965
+ # },
966
+ # authentication_configuration: {
967
+ # basic_authentication: [
968
+ # {
969
+ # host: "Host", # required
970
+ # port: 1, # required
971
+ # credentials: "SecretArn", # required
972
+ # },
973
+ # ],
974
+ # },
975
+ # },
830
976
  # },
831
977
  # description: "Description",
832
978
  # schedule: "ScanSchedule",
@@ -944,11 +1090,12 @@ module Aws::Kendra
944
1090
 
945
1091
  # Creates a new Amazon Kendra index. Index creation is an asynchronous
946
1092
  # operation. To determine if index creation has completed, check the
947
- # `Status` field returned from a call to . The `Status` field is set to
948
- # `ACTIVE` when the index is ready to use.
1093
+ # `Status` field returned from a call to `DescribeIndex`. The `Status`
1094
+ # field is set to `ACTIVE` when the index is ready to use.
949
1095
  #
950
1096
  # Once the index is active you can index your documents using the
951
- # operation or using one of the supported data sources.
1097
+ # `BatchPutDocument` operation or using one of the supported data
1098
+ # sources.
952
1099
  #
953
1100
  # @option params [required, String] :name
954
1101
  # The name for the new index.
@@ -1062,6 +1209,107 @@ module Aws::Kendra
1062
1209
  req.send_request(options)
1063
1210
  end
1064
1211
 
1212
+ # Creates a block list to exlcude certain queries from suggestions.
1213
+ #
1214
+ # Any query that contains words or phrases specified in the block list
1215
+ # is blocked or filtered out from being shown as a suggestion.
1216
+ #
1217
+ # You need to provide the file location of your block list text file in
1218
+ # your S3 bucket. In your text file, enter each block word or phrase on
1219
+ # a separate line.
1220
+ #
1221
+ # For information on the current quota limits for block lists, see
1222
+ # [Quotas for Amazon Kendra][1].
1223
+ #
1224
+ #
1225
+ #
1226
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1227
+ #
1228
+ # @option params [required, String] :index_id
1229
+ # The identifier of the index you want to create a query suggestions
1230
+ # block list for.
1231
+ #
1232
+ # @option params [required, String] :name
1233
+ # A user friendly name for the block list.
1234
+ #
1235
+ # For example, the block list named 'offensive-words' includes all
1236
+ # offensive words that could appear in user queries and need to be
1237
+ # blocked from suggestions.
1238
+ #
1239
+ # @option params [String] :description
1240
+ # A user-friendly description for the block list.
1241
+ #
1242
+ # For example, the description "List of all offensive words that can
1243
+ # appear in user queries and need to be blocked from suggestions."
1244
+ #
1245
+ # @option params [required, Types::S3Path] :source_s3_path
1246
+ # The S3 path to your block list text file in your S3 bucket.
1247
+ #
1248
+ # Each block word or phrase should be on a separate line in a text file.
1249
+ #
1250
+ # For information on the current quota limits for block lists, see
1251
+ # [Quotas for Amazon Kendra][1].
1252
+ #
1253
+ #
1254
+ #
1255
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1256
+ #
1257
+ # @option params [String] :client_token
1258
+ # A token that you provide to identify the request to create a query
1259
+ # suggestions block list.
1260
+ #
1261
+ # **A suitable default value is auto-generated.** You should normally
1262
+ # not need to pass this option.**
1263
+ #
1264
+ # @option params [required, String] :role_arn
1265
+ # The IAM (Identity and Access Management) role used by Amazon Kendra to
1266
+ # access the block list text file in your S3 bucket.
1267
+ #
1268
+ # You need permissions to the role ARN (Amazon Resource Name). The role
1269
+ # needs S3 read permissions to your file in S3 and needs to give STS
1270
+ # (Security Token Service) assume role permissions to Amazon Kendra.
1271
+ #
1272
+ # @option params [Array<Types::Tag>] :tags
1273
+ # A tag that you can assign to a block list that categorizes the block
1274
+ # list.
1275
+ #
1276
+ # @return [Types::CreateQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1277
+ #
1278
+ # * {Types::CreateQuerySuggestionsBlockListResponse#id #id} => String
1279
+ #
1280
+ # @example Request syntax with placeholder values
1281
+ #
1282
+ # resp = client.create_query_suggestions_block_list({
1283
+ # index_id: "IndexId", # required
1284
+ # name: "QuerySuggestionsBlockListName", # required
1285
+ # description: "Description",
1286
+ # source_s3_path: { # required
1287
+ # bucket: "S3BucketName", # required
1288
+ # key: "S3ObjectKey", # required
1289
+ # },
1290
+ # client_token: "ClientTokenName",
1291
+ # role_arn: "RoleArn", # required
1292
+ # tags: [
1293
+ # {
1294
+ # key: "TagKey", # required
1295
+ # value: "TagValue", # required
1296
+ # },
1297
+ # ],
1298
+ # })
1299
+ #
1300
+ # @example Response structure
1301
+ #
1302
+ # resp.id #=> String
1303
+ #
1304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList AWS API Documentation
1305
+ #
1306
+ # @overload create_query_suggestions_block_list(params = {})
1307
+ # @param [Hash] params ({})
1308
+ def create_query_suggestions_block_list(params = {}, options = {})
1309
+ req = build_request(:create_query_suggestions_block_list, params)
1310
+ req.send_request(options)
1311
+ end
1312
+
1065
1313
  # Creates a thesaurus for an index. The thesaurus contains a list of
1066
1314
  # synonyms in Solr format.
1067
1315
  #
@@ -1134,9 +1382,9 @@ module Aws::Kendra
1134
1382
 
1135
1383
  # Deletes an Amazon Kendra data source. An exception is not thrown if
1136
1384
  # the data source is already being deleted. While the data source is
1137
- # being deleted, the `Status` field returned by a call to the operation
1138
- # is set to `DELETING`. For more information, see [Deleting Data
1139
- # Sources][1].
1385
+ # being deleted, the `Status` field returned by a call to the
1386
+ # `DescribeDataSource` operation is set to `DELETING`. For more
1387
+ # information, see [Deleting Data Sources][1].
1140
1388
  #
1141
1389
  #
1142
1390
  #
@@ -1194,7 +1442,7 @@ module Aws::Kendra
1194
1442
 
1195
1443
  # Deletes an existing Amazon Kendra index. An exception is not thrown if
1196
1444
  # the index is already being deleted. While the index is being deleted,
1197
- # the `Status` field returned by a call to the DescribeIndex operation
1445
+ # the `Status` field returned by a call to the `DescribeIndex` operation
1198
1446
  # is set to `DELETING`.
1199
1447
  #
1200
1448
  # @option params [required, String] :id
@@ -1217,6 +1465,36 @@ module Aws::Kendra
1217
1465
  req.send_request(options)
1218
1466
  end
1219
1467
 
1468
+ # Deletes a block list used for query suggestions for an index.
1469
+ #
1470
+ # A deleted block list might not take effect right away. Amazon Kendra
1471
+ # needs to refresh the entire suggestions list to add back the queries
1472
+ # that were previously blocked.
1473
+ #
1474
+ # @option params [required, String] :index_id
1475
+ # The identifier of the you want to delete a block list from.
1476
+ #
1477
+ # @option params [required, String] :id
1478
+ # The unique identifier of the block list that needs to be deleted.
1479
+ #
1480
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1481
+ #
1482
+ # @example Request syntax with placeholder values
1483
+ #
1484
+ # resp = client.delete_query_suggestions_block_list({
1485
+ # index_id: "IndexId", # required
1486
+ # id: "QuerySuggestionsBlockListId", # required
1487
+ # })
1488
+ #
1489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList AWS API Documentation
1490
+ #
1491
+ # @overload delete_query_suggestions_block_list(params = {})
1492
+ # @param [Hash] params ({})
1493
+ def delete_query_suggestions_block_list(params = {}, options = {})
1494
+ req = build_request(:delete_query_suggestions_block_list, params)
1495
+ req.send_request(options)
1496
+ end
1497
+
1220
1498
  # Deletes an existing Amazon Kendra thesaurus.
1221
1499
  #
1222
1500
  # @option params [required, String] :id
@@ -1278,7 +1556,7 @@ module Aws::Kendra
1278
1556
  # resp.id #=> String
1279
1557
  # resp.index_id #=> String
1280
1558
  # resp.name #=> String
1281
- # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
1559
+ # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
1282
1560
  # resp.configuration.s3_configuration.bucket_name #=> String
1283
1561
  # resp.configuration.s3_configuration.inclusion_prefixes #=> Array
1284
1562
  # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
@@ -1402,6 +1680,7 @@ module Aws::Kendra
1402
1680
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
1403
1681
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
1404
1682
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
1683
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.filter_query #=> String
1405
1684
  # resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
1406
1685
  # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
1407
1686
  # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
@@ -1413,6 +1692,7 @@ module Aws::Kendra
1413
1692
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
1414
1693
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
1415
1694
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
1695
+ # resp.configuration.service_now_configuration.authentication_type #=> String, one of "HTTP_BASIC", "OAUTH2"
1416
1696
  # resp.configuration.confluence_configuration.server_url #=> String
1417
1697
  # resp.configuration.confluence_configuration.secret_arn #=> String
1418
1698
  # resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
@@ -1462,6 +1742,26 @@ module Aws::Kendra
1462
1742
  # resp.configuration.google_drive_configuration.exclude_user_accounts[0] #=> String
1463
1743
  # resp.configuration.google_drive_configuration.exclude_shared_drives #=> Array
1464
1744
  # resp.configuration.google_drive_configuration.exclude_shared_drives[0] #=> String
1745
+ # resp.configuration.web_crawler_configuration.urls.seed_url_configuration.seed_urls #=> Array
1746
+ # resp.configuration.web_crawler_configuration.urls.seed_url_configuration.seed_urls[0] #=> String
1747
+ # resp.configuration.web_crawler_configuration.urls.seed_url_configuration.web_crawler_mode #=> String, one of "HOST_ONLY", "SUBDOMAINS", "EVERYTHING"
1748
+ # resp.configuration.web_crawler_configuration.urls.site_maps_configuration.site_maps #=> Array
1749
+ # resp.configuration.web_crawler_configuration.urls.site_maps_configuration.site_maps[0] #=> String
1750
+ # resp.configuration.web_crawler_configuration.crawl_depth #=> Integer
1751
+ # resp.configuration.web_crawler_configuration.max_links_per_page #=> Integer
1752
+ # resp.configuration.web_crawler_configuration.max_content_size_per_page_in_mega_bytes #=> Float
1753
+ # resp.configuration.web_crawler_configuration.max_urls_per_minute_crawl_rate #=> Integer
1754
+ # resp.configuration.web_crawler_configuration.url_inclusion_patterns #=> Array
1755
+ # resp.configuration.web_crawler_configuration.url_inclusion_patterns[0] #=> String
1756
+ # resp.configuration.web_crawler_configuration.url_exclusion_patterns #=> Array
1757
+ # resp.configuration.web_crawler_configuration.url_exclusion_patterns[0] #=> String
1758
+ # resp.configuration.web_crawler_configuration.proxy_configuration.host #=> String
1759
+ # resp.configuration.web_crawler_configuration.proxy_configuration.port #=> Integer
1760
+ # resp.configuration.web_crawler_configuration.proxy_configuration.credentials #=> String
1761
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication #=> Array
1762
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].host #=> String
1763
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].port #=> Integer
1764
+ # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].credentials #=> String
1465
1765
  # resp.created_at #=> Time
1466
1766
  # resp.updated_at #=> Time
1467
1767
  # resp.description #=> String
@@ -1612,6 +1912,112 @@ module Aws::Kendra
1612
1912
  req.send_request(options)
1613
1913
  end
1614
1914
 
1915
+ # Describes a block list used for query suggestions for an index.
1916
+ #
1917
+ # This is used to check the current settings that are applied to a block
1918
+ # list.
1919
+ #
1920
+ # @option params [required, String] :index_id
1921
+ # The identifier of the index for the block list.
1922
+ #
1923
+ # @option params [required, String] :id
1924
+ # The unique identifier of the block list.
1925
+ #
1926
+ # @return [Types::DescribeQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1927
+ #
1928
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#index_id #index_id} => String
1929
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#id #id} => String
1930
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#name #name} => String
1931
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#description #description} => String
1932
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#status #status} => String
1933
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#error_message #error_message} => String
1934
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#created_at #created_at} => Time
1935
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#updated_at #updated_at} => Time
1936
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#source_s3_path #source_s3_path} => Types::S3Path
1937
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#item_count #item_count} => Integer
1938
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#file_size_bytes #file_size_bytes} => Integer
1939
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#role_arn #role_arn} => String
1940
+ #
1941
+ # @example Request syntax with placeholder values
1942
+ #
1943
+ # resp = client.describe_query_suggestions_block_list({
1944
+ # index_id: "IndexId", # required
1945
+ # id: "QuerySuggestionsBlockListId", # required
1946
+ # })
1947
+ #
1948
+ # @example Response structure
1949
+ #
1950
+ # resp.index_id #=> String
1951
+ # resp.id #=> String
1952
+ # resp.name #=> String
1953
+ # resp.description #=> String
1954
+ # resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
1955
+ # resp.error_message #=> String
1956
+ # resp.created_at #=> Time
1957
+ # resp.updated_at #=> Time
1958
+ # resp.source_s3_path.bucket #=> String
1959
+ # resp.source_s3_path.key #=> String
1960
+ # resp.item_count #=> Integer
1961
+ # resp.file_size_bytes #=> Integer
1962
+ # resp.role_arn #=> String
1963
+ #
1964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList AWS API Documentation
1965
+ #
1966
+ # @overload describe_query_suggestions_block_list(params = {})
1967
+ # @param [Hash] params ({})
1968
+ def describe_query_suggestions_block_list(params = {}, options = {})
1969
+ req = build_request(:describe_query_suggestions_block_list, params)
1970
+ req.send_request(options)
1971
+ end
1972
+
1973
+ # Describes the settings of query suggestions for an index.
1974
+ #
1975
+ # This is used to check the current settings applied to query
1976
+ # suggestions.
1977
+ #
1978
+ # @option params [required, String] :index_id
1979
+ # The identifier of the index you want to describe query suggestions
1980
+ # settings for.
1981
+ #
1982
+ # @return [Types::DescribeQuerySuggestionsConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1983
+ #
1984
+ # * {Types::DescribeQuerySuggestionsConfigResponse#mode #mode} => String
1985
+ # * {Types::DescribeQuerySuggestionsConfigResponse#status #status} => String
1986
+ # * {Types::DescribeQuerySuggestionsConfigResponse#query_log_look_back_window_in_days #query_log_look_back_window_in_days} => Integer
1987
+ # * {Types::DescribeQuerySuggestionsConfigResponse#include_queries_without_user_information #include_queries_without_user_information} => Boolean
1988
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_number_of_querying_users #minimum_number_of_querying_users} => Integer
1989
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_query_count #minimum_query_count} => Integer
1990
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_suggestions_build_time #last_suggestions_build_time} => Time
1991
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_clear_time #last_clear_time} => Time
1992
+ # * {Types::DescribeQuerySuggestionsConfigResponse#total_suggestions_count #total_suggestions_count} => Integer
1993
+ #
1994
+ # @example Request syntax with placeholder values
1995
+ #
1996
+ # resp = client.describe_query_suggestions_config({
1997
+ # index_id: "IndexId", # required
1998
+ # })
1999
+ #
2000
+ # @example Response structure
2001
+ #
2002
+ # resp.mode #=> String, one of "ENABLED", "LEARN_ONLY"
2003
+ # resp.status #=> String, one of "ACTIVE", "UPDATING"
2004
+ # resp.query_log_look_back_window_in_days #=> Integer
2005
+ # resp.include_queries_without_user_information #=> Boolean
2006
+ # resp.minimum_number_of_querying_users #=> Integer
2007
+ # resp.minimum_query_count #=> Integer
2008
+ # resp.last_suggestions_build_time #=> Time
2009
+ # resp.last_clear_time #=> Time
2010
+ # resp.total_suggestions_count #=> Integer
2011
+ #
2012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig AWS API Documentation
2013
+ #
2014
+ # @overload describe_query_suggestions_config(params = {})
2015
+ # @param [Hash] params ({})
2016
+ def describe_query_suggestions_config(params = {}, options = {})
2017
+ req = build_request(:describe_query_suggestions_config, params)
2018
+ req.send_request(options)
2019
+ end
2020
+
1615
2021
  # Describes an existing Amazon Kendra thesaurus.
1616
2022
  #
1617
2023
  # @option params [required, String] :id
@@ -1669,6 +2075,58 @@ module Aws::Kendra
1669
2075
  req.send_request(options)
1670
2076
  end
1671
2077
 
2078
+ # Fetches the queries that are suggested to your users.
2079
+ #
2080
+ # @option params [required, String] :index_id
2081
+ # The identifier of the index you want to get query suggestions from.
2082
+ #
2083
+ # @option params [required, String] :query_text
2084
+ # The text of a user's query to generate query suggestions.
2085
+ #
2086
+ # A query is suggested if the query prefix matches what a user starts to
2087
+ # type as their query.
2088
+ #
2089
+ # Amazon Kendra does not show any suggestions if a user types fewer than
2090
+ # two characters or more than 60 characters. A query must also have at
2091
+ # least one search result and contain at least one word of more than
2092
+ # four characters.
2093
+ #
2094
+ # @option params [Integer] :max_suggestions_count
2095
+ # The maximum number of query suggestions you want to show to your
2096
+ # users.
2097
+ #
2098
+ # @return [Types::GetQuerySuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2099
+ #
2100
+ # * {Types::GetQuerySuggestionsResponse#query_suggestions_id #query_suggestions_id} => String
2101
+ # * {Types::GetQuerySuggestionsResponse#suggestions #suggestions} => Array&lt;Types::Suggestion&gt;
2102
+ #
2103
+ # @example Request syntax with placeholder values
2104
+ #
2105
+ # resp = client.get_query_suggestions({
2106
+ # index_id: "IndexId", # required
2107
+ # query_text: "SuggestionQueryText", # required
2108
+ # max_suggestions_count: 1,
2109
+ # })
2110
+ #
2111
+ # @example Response structure
2112
+ #
2113
+ # resp.query_suggestions_id #=> String
2114
+ # resp.suggestions #=> Array
2115
+ # resp.suggestions[0].id #=> String
2116
+ # resp.suggestions[0].value.text.text #=> String
2117
+ # resp.suggestions[0].value.text.highlights #=> Array
2118
+ # resp.suggestions[0].value.text.highlights[0].begin_offset #=> Integer
2119
+ # resp.suggestions[0].value.text.highlights[0].end_offset #=> Integer
2120
+ #
2121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions AWS API Documentation
2122
+ #
2123
+ # @overload get_query_suggestions(params = {})
2124
+ # @param [Hash] params ({})
2125
+ def get_query_suggestions(params = {}, options = {})
2126
+ req = build_request(:get_query_suggestions, params)
2127
+ req.send_request(options)
2128
+ end
2129
+
1672
2130
  # Gets statistics about synchronizing Amazon Kendra with a data source.
1673
2131
  #
1674
2132
  # @option params [required, String] :id
@@ -1775,7 +2233,7 @@ module Aws::Kendra
1775
2233
  # resp.summary_items #=> Array
1776
2234
  # resp.summary_items[0].name #=> String
1777
2235
  # resp.summary_items[0].id #=> String
1778
- # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
2236
+ # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
1779
2237
  # resp.summary_items[0].created_at #=> Time
1780
2238
  # resp.summary_items[0].updated_at #=> Time
1781
2239
  # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
@@ -1882,6 +2340,68 @@ module Aws::Kendra
1882
2340
  req.send_request(options)
1883
2341
  end
1884
2342
 
2343
+ # Lists the block lists used for query suggestions for an index.
2344
+ #
2345
+ # For information on the current quota limits for block lists, see
2346
+ # [Quotas for Amazon Kendra][1].
2347
+ #
2348
+ #
2349
+ #
2350
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2351
+ #
2352
+ # @option params [required, String] :index_id
2353
+ # The identifier of the index for a list of all block lists that exist
2354
+ # for that index.
2355
+ #
2356
+ # For information on the current quota limits for block lists, see
2357
+ # [Quotas for Amazon Kendra][1].
2358
+ #
2359
+ #
2360
+ #
2361
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2362
+ #
2363
+ # @option params [String] :next_token
2364
+ # If the previous response was incomplete (because there is more data to
2365
+ # retrieve), Amazon Kendra returns a pagination token in the response.
2366
+ # You can use this pagination token to retrieve the next set of block
2367
+ # lists (`BlockListSummaryItems`).
2368
+ #
2369
+ # @option params [Integer] :max_results
2370
+ # The maximum number of block lists to return.
2371
+ #
2372
+ # @return [Types::ListQuerySuggestionsBlockListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2373
+ #
2374
+ # * {Types::ListQuerySuggestionsBlockListsResponse#block_list_summary_items #block_list_summary_items} => Array&lt;Types::QuerySuggestionsBlockListSummary&gt;
2375
+ # * {Types::ListQuerySuggestionsBlockListsResponse#next_token #next_token} => String
2376
+ #
2377
+ # @example Request syntax with placeholder values
2378
+ #
2379
+ # resp = client.list_query_suggestions_block_lists({
2380
+ # index_id: "IndexId", # required
2381
+ # next_token: "NextToken",
2382
+ # max_results: 1,
2383
+ # })
2384
+ #
2385
+ # @example Response structure
2386
+ #
2387
+ # resp.block_list_summary_items #=> Array
2388
+ # resp.block_list_summary_items[0].id #=> String
2389
+ # resp.block_list_summary_items[0].name #=> String
2390
+ # resp.block_list_summary_items[0].status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
2391
+ # resp.block_list_summary_items[0].created_at #=> Time
2392
+ # resp.block_list_summary_items[0].updated_at #=> Time
2393
+ # resp.block_list_summary_items[0].item_count #=> Integer
2394
+ # resp.next_token #=> String
2395
+ #
2396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists AWS API Documentation
2397
+ #
2398
+ # @overload list_query_suggestions_block_lists(params = {})
2399
+ # @param [Hash] params ({})
2400
+ def list_query_suggestions_block_lists(params = {}, options = {})
2401
+ req = build_request(:list_query_suggestions_block_lists, params)
2402
+ req.send_request(options)
2403
+ end
2404
+
1885
2405
  # Gets a list of tags associated with a specified resource. Indexes,
1886
2406
  # FAQs, and data sources can have tags associated with them.
1887
2407
  #
@@ -1984,7 +2504,7 @@ module Aws::Kendra
1984
2504
  #
1985
2505
  # @option params [required, String] :index_id
1986
2506
  # The unique identifier of the index to search. The identifier is
1987
- # returned in the response from the operation.
2507
+ # returned in the response from the `CreateIndex` operation.
1988
2508
  #
1989
2509
  # @option params [required, String] :query_text
1990
2510
  # The text to search for.
@@ -2013,6 +2533,23 @@ module Aws::Kendra
2013
2533
  # Sets the type of query. Only results for the specified query type are
2014
2534
  # returned.
2015
2535
  #
2536
+ # @option params [Array<Types::DocumentRelevanceConfiguration>] :document_relevance_override_configurations
2537
+ # Overrides relevance tuning configurations of fields or attributes set
2538
+ # at the index level.
2539
+ #
2540
+ # If you use this API to override the relevance tuning configured at the
2541
+ # index level, but there is no relevance tuning configured at the index
2542
+ # level, then Amazon Kendra does not apply any relevance tuning.
2543
+ #
2544
+ # If there is relevance tuning configured at the index level, but you do
2545
+ # not use this API to override any relevance tuning in the index, then
2546
+ # Amazon Kendra uses the relevance tuning that is configured at the
2547
+ # index level.
2548
+ #
2549
+ # If there is relevance tuning configured for fields at the index level,
2550
+ # but you use this API to override only some of these fields, then for
2551
+ # the fields you did not override, the importance is set to 1.
2552
+ #
2016
2553
  # @option params [Integer] :page_number
2017
2554
  # Query results are returned in pages the size of the `PageSize`
2018
2555
  # parameter. By default, Amazon Kendra returns the first page of
@@ -2139,6 +2676,20 @@ module Aws::Kendra
2139
2676
  # ],
2140
2677
  # requested_document_attributes: ["DocumentAttributeKey"],
2141
2678
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
2679
+ # document_relevance_override_configurations: [
2680
+ # {
2681
+ # name: "DocumentMetadataConfigurationName", # required
2682
+ # relevance: { # required
2683
+ # freshness: false,
2684
+ # importance: 1,
2685
+ # duration: "Duration",
2686
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
2687
+ # value_importance_map: {
2688
+ # "ValueImportanceMapKey" => 1,
2689
+ # },
2690
+ # },
2691
+ # },
2692
+ # ],
2142
2693
  # page_number: 1,
2143
2694
  # page_size: 1,
2144
2695
  # sorting_configuration: {
@@ -2280,7 +2831,8 @@ module Aws::Kendra
2280
2831
  #
2281
2832
  # @option params [required, String] :query_id
2282
2833
  # The identifier of the specific query for which you are submitting
2283
- # feedback. The query ID is returned in the response to the operation.
2834
+ # feedback. The query ID is returned in the response to the `Query`
2835
+ # operation.
2284
2836
  #
2285
2837
  # @option params [Array<Types::ClickFeedback>] :click_feedback_items
2286
2838
  # Tells Amazon Kendra that a particular search result link was chosen by
@@ -2594,6 +3146,7 @@ module Aws::Kendra
2594
3146
  # index_field_name: "IndexFieldName", # required
2595
3147
  # },
2596
3148
  # ],
3149
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
2597
3150
  # },
2598
3151
  # service_catalog_configuration: {
2599
3152
  # crawl_attachments: false,
@@ -2609,6 +3162,7 @@ module Aws::Kendra
2609
3162
  # },
2610
3163
  # ],
2611
3164
  # },
3165
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
2612
3166
  # },
2613
3167
  # confluence_configuration: {
2614
3168
  # server_url: "Url", # required
@@ -2677,6 +3231,37 @@ module Aws::Kendra
2677
3231
  # exclude_user_accounts: ["UserAccount"],
2678
3232
  # exclude_shared_drives: ["SharedDriveId"],
2679
3233
  # },
3234
+ # web_crawler_configuration: {
3235
+ # urls: { # required
3236
+ # seed_url_configuration: {
3237
+ # seed_urls: ["SeedUrl"], # required
3238
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
3239
+ # },
3240
+ # site_maps_configuration: {
3241
+ # site_maps: ["SiteMap"], # required
3242
+ # },
3243
+ # },
3244
+ # crawl_depth: 1,
3245
+ # max_links_per_page: 1,
3246
+ # max_content_size_per_page_in_mega_bytes: 1.0,
3247
+ # max_urls_per_minute_crawl_rate: 1,
3248
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3249
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3250
+ # proxy_configuration: {
3251
+ # host: "Host", # required
3252
+ # port: 1, # required
3253
+ # credentials: "SecretArn",
3254
+ # },
3255
+ # authentication_configuration: {
3256
+ # basic_authentication: [
3257
+ # {
3258
+ # host: "Host", # required
3259
+ # port: 1, # required
3260
+ # credentials: "SecretArn", # required
3261
+ # },
3262
+ # ],
3263
+ # },
3264
+ # },
2680
3265
  # },
2681
3266
  # description: "Description",
2682
3267
  # schedule: "ScanSchedule",
@@ -2711,7 +3296,7 @@ module Aws::Kendra
2711
3296
  # The document metadata to update.
2712
3297
  #
2713
3298
  # @option params [Types::CapacityUnitsConfiguration] :capacity_units
2714
- # Sets the number of addtional storage and query capacity units that
3299
+ # Sets the number of additional storage and query capacity units that
2715
3300
  # should be used by the index. You can change the capacity of the index
2716
3301
  # up to 5 times per day.
2717
3302
  #
@@ -2787,6 +3372,167 @@ module Aws::Kendra
2787
3372
  req.send_request(options)
2788
3373
  end
2789
3374
 
3375
+ # Updates a block list used for query suggestions for an index.
3376
+ #
3377
+ # Updates to a block list might not take effect right away. Amazon
3378
+ # Kendra needs to refresh the entire suggestions list to apply any
3379
+ # updates to the block list. Other changes not related to the block list
3380
+ # apply immediately.
3381
+ #
3382
+ # If a block list is updating, then you need to wait for the first
3383
+ # update to finish before submitting another update.
3384
+ #
3385
+ # Amazon Kendra supports partial updates, so you only need to provide
3386
+ # the fields you want to update.
3387
+ #
3388
+ # @option params [required, String] :index_id
3389
+ # The identifier of the index for a block list.
3390
+ #
3391
+ # @option params [required, String] :id
3392
+ # The unique identifier of a block list.
3393
+ #
3394
+ # @option params [String] :name
3395
+ # The name of a block list.
3396
+ #
3397
+ # @option params [String] :description
3398
+ # The description for a block list.
3399
+ #
3400
+ # @option params [Types::S3Path] :source_s3_path
3401
+ # The S3 path where your block list text file sits in S3.
3402
+ #
3403
+ # If you update your block list and provide the same path to the block
3404
+ # list text file in S3, then Amazon Kendra reloads the file to refresh
3405
+ # the block list. Amazon Kendra does not automatically refresh your
3406
+ # block list. You need to call the `UpdateQuerySuggestionsBlockList` API
3407
+ # to refresh you block list.
3408
+ #
3409
+ # If you update your block list, then Amazon Kendra asynchronously
3410
+ # refreshes all query suggestions with the latest content in the S3
3411
+ # file. This means changes might not take effect immediately.
3412
+ #
3413
+ # @option params [String] :role_arn
3414
+ # The IAM (Identity and Access Management) role used to access the block
3415
+ # list text file in S3.
3416
+ #
3417
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3418
+ #
3419
+ # @example Request syntax with placeholder values
3420
+ #
3421
+ # resp = client.update_query_suggestions_block_list({
3422
+ # index_id: "IndexId", # required
3423
+ # id: "QuerySuggestionsBlockListId", # required
3424
+ # name: "QuerySuggestionsBlockListName",
3425
+ # description: "Description",
3426
+ # source_s3_path: {
3427
+ # bucket: "S3BucketName", # required
3428
+ # key: "S3ObjectKey", # required
3429
+ # },
3430
+ # role_arn: "RoleArn",
3431
+ # })
3432
+ #
3433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList AWS API Documentation
3434
+ #
3435
+ # @overload update_query_suggestions_block_list(params = {})
3436
+ # @param [Hash] params ({})
3437
+ def update_query_suggestions_block_list(params = {}, options = {})
3438
+ req = build_request(:update_query_suggestions_block_list, params)
3439
+ req.send_request(options)
3440
+ end
3441
+
3442
+ # Updates the settings of query suggestions for an index.
3443
+ #
3444
+ # Amazon Kendra supports partial updates, so you only need to provide
3445
+ # the fields you want to update.
3446
+ #
3447
+ # If an update is currently processing (i.e. 'happening'), you need to
3448
+ # wait for the update to finish before making another update.
3449
+ #
3450
+ # Updates to query suggestions settings might not take effect right
3451
+ # away. The time for your updated settings to take effect depends on the
3452
+ # updates made and the number of search queries in your index.
3453
+ #
3454
+ # You can still enable/disable query suggestions at any time.
3455
+ #
3456
+ # @option params [required, String] :index_id
3457
+ # The identifier of the index you want to update query suggestions
3458
+ # settings for.
3459
+ #
3460
+ # @option params [String] :mode
3461
+ # Set the mode to `ENABLED` or `LEARN_ONLY`.
3462
+ #
3463
+ # By default, Amazon Kendra enables query suggestions. `LEARN_ONLY` mode
3464
+ # allows you to turn off query suggestions. You can to update this at
3465
+ # any time.
3466
+ #
3467
+ # In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
3468
+ # queries to keep suggestions up to date for when you are ready to
3469
+ # switch to ENABLED mode again.
3470
+ #
3471
+ # @option params [Integer] :query_log_look_back_window_in_days
3472
+ # How recent your queries are in your query log time window.
3473
+ #
3474
+ # The time window is the number of days from current day to past days.
3475
+ #
3476
+ # By default, Amazon Kendra sets this to 180.
3477
+ #
3478
+ # @option params [Boolean] :include_queries_without_user_information
3479
+ # `TRUE` to include queries without user information (i.e. all queries,
3480
+ # irrespective of the user), otherwise `FALSE` to only include queries
3481
+ # with user information.
3482
+ #
3483
+ # If you pass user information to Amazon Kendra along with the queries,
3484
+ # you can set this flag to `FALSE` and instruct Amazon Kendra to only
3485
+ # consider queries with user information.
3486
+ #
3487
+ # If you set to `FALSE`, Amazon Kendra only considers queries searched
3488
+ # at least `MinimumQueryCount` times across
3489
+ # `MinimumNumberOfQueryingUsers` unique users for suggestions.
3490
+ #
3491
+ # If you set to `TRUE`, Amazon Kendra ignores all user information and
3492
+ # learns from all queries.
3493
+ #
3494
+ # @option params [Integer] :minimum_number_of_querying_users
3495
+ # The minimum number of unique users who must search a query in order
3496
+ # for the query to be eligible to suggest to your users.
3497
+ #
3498
+ # Increasing this number might decrease the number of suggestions.
3499
+ # However, this ensures a query is searched by many users and is truly
3500
+ # popular to suggest to users.
3501
+ #
3502
+ # How you tune this setting depends on your specific needs.
3503
+ #
3504
+ # @option params [Integer] :minimum_query_count
3505
+ # The the minimum number of times a query must be searched in order to
3506
+ # be eligible to suggest to your users.
3507
+ #
3508
+ # Decreasing this number increases the number of suggestions. However,
3509
+ # this affects the quality of suggestions as it sets a low bar for a
3510
+ # query to be considered popular to suggest to users.
3511
+ #
3512
+ # How you tune this setting depends on your specific needs.
3513
+ #
3514
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3515
+ #
3516
+ # @example Request syntax with placeholder values
3517
+ #
3518
+ # resp = client.update_query_suggestions_config({
3519
+ # index_id: "IndexId", # required
3520
+ # mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
3521
+ # query_log_look_back_window_in_days: 1,
3522
+ # include_queries_without_user_information: false,
3523
+ # minimum_number_of_querying_users: 1,
3524
+ # minimum_query_count: 1,
3525
+ # })
3526
+ #
3527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig AWS API Documentation
3528
+ #
3529
+ # @overload update_query_suggestions_config(params = {})
3530
+ # @param [Hash] params ({})
3531
+ def update_query_suggestions_config(params = {}, options = {})
3532
+ req = build_request(:update_query_suggestions_config, params)
3533
+ req.send_request(options)
3534
+ end
3535
+
2790
3536
  # Updates a thesaurus file associated with an index.
2791
3537
  #
2792
3538
  # @option params [required, String] :id
@@ -2845,7 +3591,7 @@ module Aws::Kendra
2845
3591
  params: params,
2846
3592
  config: config)
2847
3593
  context[:gem_name] = 'aws-sdk-kendra'
2848
- context[:gem_version] = '1.22.0'
3594
+ context[:gem_version] = '1.27.0'
2849
3595
  Seahorse::Client::Request.new(handlers, context)
2850
3596
  end
2851
3597