aws-sdk-kendra 1.21.0 → 1.26.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 47b37022e82d6271bd8e602d716ea47eb03a98dc5459286fb6b6a44d3630a075
4
- data.tar.gz: 1c5305e571616e5b6d1cc85983632c73bae315cdae7f4b576d105ff4d518a842
3
+ metadata.gz: db6db0d7989bf395d9d66113616dd832292db250ceae884e79f1ff68fc72c2da
4
+ data.tar.gz: 5d5c1a752c7eb99a07c0c60f67b913244b2731f0301eb4918171af9bdbe95ba6
5
5
  SHA512:
6
- metadata.gz: 44fefd8e6ad681230a830344db62eb457f0b7dfbd4ce267485b9013abd3edc506555e9f51e0df7bb79b0b369da4b2b3f604ac88d7446320fc071b8d488c9d62a
7
- data.tar.gz: 23d72b42572dcc70b93c8097b124b0230135902d7618512f8cd199eb0cb5d9c1c502fe86897284ceb96592a64e1c459cd1151e7e0736b9cd641380dc1d15c012
6
+ metadata.gz: 3c11d993010e54b7ba55c7503fa00b331b0b34da815eac768955ec402bc436885327483dceac3b85a46da932002ad9be3049b3db2bac82eae20ed84900e5be53
7
+ data.tar.gz: 13d14d88704eb78936b534371ef132863b4db06403b68648b7e3a03a53da263a1a2e5641e6cc5d5678241270af4b94960de35301e5cfb0c1fc1f3062400f121a
data/CHANGELOG.md ADDED
@@ -0,0 +1,143 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.26.0 (2021-06-09)
5
+ ------------------
6
+
7
+ * Feature - AWS Kendra now supports checking document status.
8
+
9
+ 1.25.0 (2021-05-27)
10
+ ------------------
11
+
12
+ * Feature - Amazon Kendra now suggests popular queries in order to help guide query typing and help overall accuracy.
13
+
14
+ 1.24.0 (2021-04-21)
15
+ ------------------
16
+
17
+ * Feature - Amazon Kendra now enables users to override index-level boosting configurations for each query.
18
+
19
+ 1.23.0 (2021-04-01)
20
+ ------------------
21
+
22
+ * Feature - AWS Kendra's ServiceNow data source now supports OAuth 2.0 authentication and knowledge article filtering via a ServiceNow query.
23
+
24
+ 1.22.0 (2021-03-10)
25
+ ------------------
26
+
27
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
28
+
29
+ 1.21.0 (2021-02-02)
30
+ ------------------
31
+
32
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
33
+
34
+ 1.20.0 (2020-12-10)
35
+ ------------------
36
+
37
+ * Feature - Amazon Kendra now supports adding synonyms to an index through the new Thesaurus resource.
38
+
39
+ 1.19.0 (2020-12-08)
40
+ ------------------
41
+
42
+ * Feature - 1. Amazon Kendra connector for Google Drive repositories 2. Amazon Kendra's relevance ranking models are regularly tuned for each customer by capturing end-user search patterns and feedback.
43
+
44
+ 1.18.0 (2020-11-05)
45
+ ------------------
46
+
47
+ * Feature - Amazon Kendra now supports providing user context in your query requests, Tokens can be JSON or JWT format. This release also introduces support for Confluence cloud datasources.
48
+
49
+ 1.17.0 (2020-10-26)
50
+ ------------------
51
+
52
+ * Feature - Amazon Kendra now supports indexing data from Confluence Server.
53
+
54
+ 1.16.0 (2020-10-21)
55
+ ------------------
56
+
57
+ * Feature - This release adds custom data sources: a new data source type that gives you full control of the documents added, modified or deleted during a data source sync while providing run history metrics.
58
+
59
+ 1.15.0 (2020-10-21)
60
+ ------------------
61
+
62
+ * Feature - This release adds custom data sources: a new data source type that gives you full control of the documents added, modified or deleted during a data source sync while providing run history metrics.
63
+
64
+ 1.14.0 (2020-09-30)
65
+ ------------------
66
+
67
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
68
+
69
+ 1.13.0 (2020-09-17)
70
+ ------------------
71
+
72
+ * Feature - Amazon Kendra now supports additional file formats and metadata for FAQs.
73
+
74
+ 1.12.0 (2020-09-15)
75
+ ------------------
76
+
77
+ * Feature - Amazon Kendra now returns confidence scores for 'document' query responses.
78
+
79
+ 1.11.0 (2020-09-03)
80
+ ------------------
81
+
82
+ * Feature - Amazon Kendra now returns confidence scores for both 'answer' and 'question and answer' query responses.
83
+
84
+ 1.10.0 (2020-08-25)
85
+ ------------------
86
+
87
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
88
+
89
+ 1.9.0 (2020-07-24)
90
+ ------------------
91
+
92
+ * Feature - Amazon Kendra now supports sorting query results based on document attributes. Amazon Kendra also introduced an option to enclose table and column names with double quotes for database data sources.
93
+
94
+ 1.8.0 (2020-06-23)
95
+ ------------------
96
+
97
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
98
+
99
+ 1.7.1 (2020-06-11)
100
+ ------------------
101
+
102
+ * Issue - Republish previous version with correct dependency on `aws-sdk-core`.
103
+
104
+ 1.7.0 (2020-06-10)
105
+ ------------------
106
+
107
+ * Issue - This version has been yanked. (#2327).
108
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
109
+
110
+ 1.6.0 (2020-05-28)
111
+ ------------------
112
+
113
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
114
+
115
+ 1.5.0 (2020-05-11)
116
+ ------------------
117
+
118
+ * Feature - Amazon Kendra is now generally available. As part of general availability, we are launching * Developer edition * Ability to scale your Amazon Kendra index with capacity units * Support for new connectors * Support for new tagging API's * Support for Deleting data source * Metrics for data source sync operations * Metrics for query & storage utilization
119
+
120
+ 1.4.0 (2020-05-07)
121
+ ------------------
122
+
123
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
124
+
125
+ 1.3.0 (2020-03-27)
126
+ ------------------
127
+
128
+ * Feature - The Amazon Kendra Microsoft SharePoint data source now supports include and exclude regular expressions and change log features. Include and exclude regular expressions enable you to provide a list of regular expressions to match the display URL of SharePoint documents to either include or exclude documents respectively. When you enable the changelog feature it enables Amazon Kendra to use the SharePoint change log to determine which documents to update in the index.
129
+
130
+ 1.2.0 (2020-03-09)
131
+ ------------------
132
+
133
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
134
+
135
+ 1.1.0 (2019-12-10)
136
+ ------------------
137
+
138
+ * Feature - 1. Adding DocumentTitleFieldName as an optional configuration for SharePoint. 2. updating s3 object pattern to support all s3 keys.
139
+
140
+ 1.0.0 (2019-12-03)
141
+ ------------------
142
+
143
+ * Feature - Initial release of `aws-sdk-kendra`.
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.26.0
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -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.21.0'
51
+ GEM_VERSION = '1.26.0'
52
52
 
53
53
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -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
@@ -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
@@ -944,11 +1059,12 @@ module Aws::Kendra
944
1059
 
945
1060
  # Creates a new Amazon Kendra index. Index creation is an asynchronous
946
1061
  # 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.
1062
+ # `Status` field returned from a call to `DescribeIndex`. The `Status`
1063
+ # field is set to `ACTIVE` when the index is ready to use.
949
1064
  #
950
1065
  # Once the index is active you can index your documents using the
951
- # operation or using one of the supported data sources.
1066
+ # `BatchPutDocument` operation or using one of the supported data
1067
+ # sources.
952
1068
  #
953
1069
  # @option params [required, String] :name
954
1070
  # The name for the new index.
@@ -1062,6 +1178,107 @@ module Aws::Kendra
1062
1178
  req.send_request(options)
1063
1179
  end
1064
1180
 
1181
+ # Creates a block list to exlcude certain queries from suggestions.
1182
+ #
1183
+ # Any query that contains words or phrases specified in the block list
1184
+ # is blocked or filtered out from being shown as a suggestion.
1185
+ #
1186
+ # You need to provide the file location of your block list text file in
1187
+ # your S3 bucket. In your text file, enter each block word or phrase on
1188
+ # a separate line.
1189
+ #
1190
+ # For information on the current quota limits for block lists, see
1191
+ # [Quotas for Amazon Kendra][1].
1192
+ #
1193
+ #
1194
+ #
1195
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1196
+ #
1197
+ # @option params [required, String] :index_id
1198
+ # The identifier of the index you want to create a query suggestions
1199
+ # block list for.
1200
+ #
1201
+ # @option params [required, String] :name
1202
+ # A user friendly name for the block list.
1203
+ #
1204
+ # For example, the block list named 'offensive-words' includes all
1205
+ # offensive words that could appear in user queries and need to be
1206
+ # blocked from suggestions.
1207
+ #
1208
+ # @option params [String] :description
1209
+ # A user-friendly description for the block list.
1210
+ #
1211
+ # For example, the description "List of all offensive words that can
1212
+ # appear in user queries and need to be blocked from suggestions."
1213
+ #
1214
+ # @option params [required, Types::S3Path] :source_s3_path
1215
+ # The S3 path to your block list text file in your S3 bucket.
1216
+ #
1217
+ # Each block word or phrase should be on a separate line in a text file.
1218
+ #
1219
+ # For information on the current quota limits for block lists, see
1220
+ # [Quotas for Amazon Kendra][1].
1221
+ #
1222
+ #
1223
+ #
1224
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1225
+ #
1226
+ # @option params [String] :client_token
1227
+ # A token that you provide to identify the request to create a query
1228
+ # suggestions block list.
1229
+ #
1230
+ # **A suitable default value is auto-generated.** You should normally
1231
+ # not need to pass this option.**
1232
+ #
1233
+ # @option params [required, String] :role_arn
1234
+ # The IAM (Identity and Access Management) role used by Amazon Kendra to
1235
+ # access the block list text file in your S3 bucket.
1236
+ #
1237
+ # You need permissions to the role ARN (Amazon Resource Name). The role
1238
+ # needs S3 read permissions to your file in S3 and needs to give STS
1239
+ # (Security Token Service) assume role permissions to Amazon Kendra.
1240
+ #
1241
+ # @option params [Array<Types::Tag>] :tags
1242
+ # A tag that you can assign to a block list that categorizes the block
1243
+ # list.
1244
+ #
1245
+ # @return [Types::CreateQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1246
+ #
1247
+ # * {Types::CreateQuerySuggestionsBlockListResponse#id #id} => String
1248
+ #
1249
+ # @example Request syntax with placeholder values
1250
+ #
1251
+ # resp = client.create_query_suggestions_block_list({
1252
+ # index_id: "IndexId", # required
1253
+ # name: "QuerySuggestionsBlockListName", # required
1254
+ # description: "Description",
1255
+ # source_s3_path: { # required
1256
+ # bucket: "S3BucketName", # required
1257
+ # key: "S3ObjectKey", # required
1258
+ # },
1259
+ # client_token: "ClientTokenName",
1260
+ # role_arn: "RoleArn", # required
1261
+ # tags: [
1262
+ # {
1263
+ # key: "TagKey", # required
1264
+ # value: "TagValue", # required
1265
+ # },
1266
+ # ],
1267
+ # })
1268
+ #
1269
+ # @example Response structure
1270
+ #
1271
+ # resp.id #=> String
1272
+ #
1273
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList AWS API Documentation
1274
+ #
1275
+ # @overload create_query_suggestions_block_list(params = {})
1276
+ # @param [Hash] params ({})
1277
+ def create_query_suggestions_block_list(params = {}, options = {})
1278
+ req = build_request(:create_query_suggestions_block_list, params)
1279
+ req.send_request(options)
1280
+ end
1281
+
1065
1282
  # Creates a thesaurus for an index. The thesaurus contains a list of
1066
1283
  # synonyms in Solr format.
1067
1284
  #
@@ -1134,9 +1351,9 @@ module Aws::Kendra
1134
1351
 
1135
1352
  # Deletes an Amazon Kendra data source. An exception is not thrown if
1136
1353
  # 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].
1354
+ # being deleted, the `Status` field returned by a call to the
1355
+ # `DescribeDataSource` operation is set to `DELETING`. For more
1356
+ # information, see [Deleting Data Sources][1].
1140
1357
  #
1141
1358
  #
1142
1359
  #
@@ -1194,7 +1411,7 @@ module Aws::Kendra
1194
1411
 
1195
1412
  # Deletes an existing Amazon Kendra index. An exception is not thrown if
1196
1413
  # the index is already being deleted. While the index is being deleted,
1197
- # the `Status` field returned by a call to the DescribeIndex operation
1414
+ # the `Status` field returned by a call to the `DescribeIndex` operation
1198
1415
  # is set to `DELETING`.
1199
1416
  #
1200
1417
  # @option params [required, String] :id
@@ -1217,6 +1434,36 @@ module Aws::Kendra
1217
1434
  req.send_request(options)
1218
1435
  end
1219
1436
 
1437
+ # Deletes a block list used for query suggestions for an index.
1438
+ #
1439
+ # A deleted block list might not take effect right away. Amazon Kendra
1440
+ # needs to refresh the entire suggestions list to add back the queries
1441
+ # that were previously blocked.
1442
+ #
1443
+ # @option params [required, String] :index_id
1444
+ # The identifier of the you want to delete a block list from.
1445
+ #
1446
+ # @option params [required, String] :id
1447
+ # The unique identifier of the block list that needs to be deleted.
1448
+ #
1449
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1450
+ #
1451
+ # @example Request syntax with placeholder values
1452
+ #
1453
+ # resp = client.delete_query_suggestions_block_list({
1454
+ # index_id: "IndexId", # required
1455
+ # id: "QuerySuggestionsBlockListId", # required
1456
+ # })
1457
+ #
1458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList AWS API Documentation
1459
+ #
1460
+ # @overload delete_query_suggestions_block_list(params = {})
1461
+ # @param [Hash] params ({})
1462
+ def delete_query_suggestions_block_list(params = {}, options = {})
1463
+ req = build_request(:delete_query_suggestions_block_list, params)
1464
+ req.send_request(options)
1465
+ end
1466
+
1220
1467
  # Deletes an existing Amazon Kendra thesaurus.
1221
1468
  #
1222
1469
  # @option params [required, String] :id
@@ -1402,6 +1649,7 @@ module Aws::Kendra
1402
1649
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
1403
1650
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
1404
1651
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
1652
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.filter_query #=> String
1405
1653
  # resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
1406
1654
  # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
1407
1655
  # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
@@ -1413,6 +1661,7 @@ module Aws::Kendra
1413
1661
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
1414
1662
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
1415
1663
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
1664
+ # resp.configuration.service_now_configuration.authentication_type #=> String, one of "HTTP_BASIC", "OAUTH2"
1416
1665
  # resp.configuration.confluence_configuration.server_url #=> String
1417
1666
  # resp.configuration.confluence_configuration.secret_arn #=> String
1418
1667
  # resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
@@ -1612,6 +1861,112 @@ module Aws::Kendra
1612
1861
  req.send_request(options)
1613
1862
  end
1614
1863
 
1864
+ # Describes a block list used for query suggestions for an index.
1865
+ #
1866
+ # This is used to check the current settings that are applied to a block
1867
+ # list.
1868
+ #
1869
+ # @option params [required, String] :index_id
1870
+ # The identifier of the index for the block list.
1871
+ #
1872
+ # @option params [required, String] :id
1873
+ # The unique identifier of the block list.
1874
+ #
1875
+ # @return [Types::DescribeQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1876
+ #
1877
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#index_id #index_id} => String
1878
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#id #id} => String
1879
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#name #name} => String
1880
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#description #description} => String
1881
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#status #status} => String
1882
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#error_message #error_message} => String
1883
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#created_at #created_at} => Time
1884
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#updated_at #updated_at} => Time
1885
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#source_s3_path #source_s3_path} => Types::S3Path
1886
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#item_count #item_count} => Integer
1887
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#file_size_bytes #file_size_bytes} => Integer
1888
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#role_arn #role_arn} => String
1889
+ #
1890
+ # @example Request syntax with placeholder values
1891
+ #
1892
+ # resp = client.describe_query_suggestions_block_list({
1893
+ # index_id: "IndexId", # required
1894
+ # id: "QuerySuggestionsBlockListId", # required
1895
+ # })
1896
+ #
1897
+ # @example Response structure
1898
+ #
1899
+ # resp.index_id #=> String
1900
+ # resp.id #=> String
1901
+ # resp.name #=> String
1902
+ # resp.description #=> String
1903
+ # resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
1904
+ # resp.error_message #=> String
1905
+ # resp.created_at #=> Time
1906
+ # resp.updated_at #=> Time
1907
+ # resp.source_s3_path.bucket #=> String
1908
+ # resp.source_s3_path.key #=> String
1909
+ # resp.item_count #=> Integer
1910
+ # resp.file_size_bytes #=> Integer
1911
+ # resp.role_arn #=> String
1912
+ #
1913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList AWS API Documentation
1914
+ #
1915
+ # @overload describe_query_suggestions_block_list(params = {})
1916
+ # @param [Hash] params ({})
1917
+ def describe_query_suggestions_block_list(params = {}, options = {})
1918
+ req = build_request(:describe_query_suggestions_block_list, params)
1919
+ req.send_request(options)
1920
+ end
1921
+
1922
+ # Describes the settings of query suggestions for an index.
1923
+ #
1924
+ # This is used to check the current settings applied to query
1925
+ # suggestions.
1926
+ #
1927
+ # @option params [required, String] :index_id
1928
+ # The identifier of the index you want to describe query suggestions
1929
+ # settings for.
1930
+ #
1931
+ # @return [Types::DescribeQuerySuggestionsConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1932
+ #
1933
+ # * {Types::DescribeQuerySuggestionsConfigResponse#mode #mode} => String
1934
+ # * {Types::DescribeQuerySuggestionsConfigResponse#status #status} => String
1935
+ # * {Types::DescribeQuerySuggestionsConfigResponse#query_log_look_back_window_in_days #query_log_look_back_window_in_days} => Integer
1936
+ # * {Types::DescribeQuerySuggestionsConfigResponse#include_queries_without_user_information #include_queries_without_user_information} => Boolean
1937
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_number_of_querying_users #minimum_number_of_querying_users} => Integer
1938
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_query_count #minimum_query_count} => Integer
1939
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_suggestions_build_time #last_suggestions_build_time} => Time
1940
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_clear_time #last_clear_time} => Time
1941
+ # * {Types::DescribeQuerySuggestionsConfigResponse#total_suggestions_count #total_suggestions_count} => Integer
1942
+ #
1943
+ # @example Request syntax with placeholder values
1944
+ #
1945
+ # resp = client.describe_query_suggestions_config({
1946
+ # index_id: "IndexId", # required
1947
+ # })
1948
+ #
1949
+ # @example Response structure
1950
+ #
1951
+ # resp.mode #=> String, one of "ENABLED", "LEARN_ONLY"
1952
+ # resp.status #=> String, one of "ACTIVE", "UPDATING"
1953
+ # resp.query_log_look_back_window_in_days #=> Integer
1954
+ # resp.include_queries_without_user_information #=> Boolean
1955
+ # resp.minimum_number_of_querying_users #=> Integer
1956
+ # resp.minimum_query_count #=> Integer
1957
+ # resp.last_suggestions_build_time #=> Time
1958
+ # resp.last_clear_time #=> Time
1959
+ # resp.total_suggestions_count #=> Integer
1960
+ #
1961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig AWS API Documentation
1962
+ #
1963
+ # @overload describe_query_suggestions_config(params = {})
1964
+ # @param [Hash] params ({})
1965
+ def describe_query_suggestions_config(params = {}, options = {})
1966
+ req = build_request(:describe_query_suggestions_config, params)
1967
+ req.send_request(options)
1968
+ end
1969
+
1615
1970
  # Describes an existing Amazon Kendra thesaurus.
1616
1971
  #
1617
1972
  # @option params [required, String] :id
@@ -1669,6 +2024,58 @@ module Aws::Kendra
1669
2024
  req.send_request(options)
1670
2025
  end
1671
2026
 
2027
+ # Fetches the queries that are suggested to your users.
2028
+ #
2029
+ # @option params [required, String] :index_id
2030
+ # The identifier of the index you want to get query suggestions from.
2031
+ #
2032
+ # @option params [required, String] :query_text
2033
+ # The text of a user's query to generate query suggestions.
2034
+ #
2035
+ # A query is suggested if the query prefix matches what a user starts to
2036
+ # type as their query.
2037
+ #
2038
+ # Amazon Kendra does not show any suggestions if a user types fewer than
2039
+ # two characters or more than 60 characters. A query must also have at
2040
+ # least one search result and contain at least one word of more than
2041
+ # four characters.
2042
+ #
2043
+ # @option params [Integer] :max_suggestions_count
2044
+ # The maximum number of query suggestions you want to show to your
2045
+ # users.
2046
+ #
2047
+ # @return [Types::GetQuerySuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2048
+ #
2049
+ # * {Types::GetQuerySuggestionsResponse#query_suggestions_id #query_suggestions_id} => String
2050
+ # * {Types::GetQuerySuggestionsResponse#suggestions #suggestions} => Array&lt;Types::Suggestion&gt;
2051
+ #
2052
+ # @example Request syntax with placeholder values
2053
+ #
2054
+ # resp = client.get_query_suggestions({
2055
+ # index_id: "IndexId", # required
2056
+ # query_text: "SuggestionQueryText", # required
2057
+ # max_suggestions_count: 1,
2058
+ # })
2059
+ #
2060
+ # @example Response structure
2061
+ #
2062
+ # resp.query_suggestions_id #=> String
2063
+ # resp.suggestions #=> Array
2064
+ # resp.suggestions[0].id #=> String
2065
+ # resp.suggestions[0].value.text.text #=> String
2066
+ # resp.suggestions[0].value.text.highlights #=> Array
2067
+ # resp.suggestions[0].value.text.highlights[0].begin_offset #=> Integer
2068
+ # resp.suggestions[0].value.text.highlights[0].end_offset #=> Integer
2069
+ #
2070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions AWS API Documentation
2071
+ #
2072
+ # @overload get_query_suggestions(params = {})
2073
+ # @param [Hash] params ({})
2074
+ def get_query_suggestions(params = {}, options = {})
2075
+ req = build_request(:get_query_suggestions, params)
2076
+ req.send_request(options)
2077
+ end
2078
+
1672
2079
  # Gets statistics about synchronizing Amazon Kendra with a data source.
1673
2080
  #
1674
2081
  # @option params [required, String] :id
@@ -1882,6 +2289,68 @@ module Aws::Kendra
1882
2289
  req.send_request(options)
1883
2290
  end
1884
2291
 
2292
+ # Lists the block lists used for query suggestions for an index.
2293
+ #
2294
+ # For information on the current quota limits for block lists, see
2295
+ # [Quotas for Amazon Kendra][1].
2296
+ #
2297
+ #
2298
+ #
2299
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2300
+ #
2301
+ # @option params [required, String] :index_id
2302
+ # The identifier of the index for a list of all block lists that exist
2303
+ # for that index.
2304
+ #
2305
+ # For information on the current quota limits for block lists, see
2306
+ # [Quotas for Amazon Kendra][1].
2307
+ #
2308
+ #
2309
+ #
2310
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2311
+ #
2312
+ # @option params [String] :next_token
2313
+ # If the previous response was incomplete (because there is more data to
2314
+ # retrieve), Amazon Kendra returns a pagination token in the response.
2315
+ # You can use this pagination token to retrieve the next set of block
2316
+ # lists (`BlockListSummaryItems`).
2317
+ #
2318
+ # @option params [Integer] :max_results
2319
+ # The maximum number of block lists to return.
2320
+ #
2321
+ # @return [Types::ListQuerySuggestionsBlockListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2322
+ #
2323
+ # * {Types::ListQuerySuggestionsBlockListsResponse#block_list_summary_items #block_list_summary_items} => Array&lt;Types::QuerySuggestionsBlockListSummary&gt;
2324
+ # * {Types::ListQuerySuggestionsBlockListsResponse#next_token #next_token} => String
2325
+ #
2326
+ # @example Request syntax with placeholder values
2327
+ #
2328
+ # resp = client.list_query_suggestions_block_lists({
2329
+ # index_id: "IndexId", # required
2330
+ # next_token: "NextToken",
2331
+ # max_results: 1,
2332
+ # })
2333
+ #
2334
+ # @example Response structure
2335
+ #
2336
+ # resp.block_list_summary_items #=> Array
2337
+ # resp.block_list_summary_items[0].id #=> String
2338
+ # resp.block_list_summary_items[0].name #=> String
2339
+ # resp.block_list_summary_items[0].status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
2340
+ # resp.block_list_summary_items[0].created_at #=> Time
2341
+ # resp.block_list_summary_items[0].updated_at #=> Time
2342
+ # resp.block_list_summary_items[0].item_count #=> Integer
2343
+ # resp.next_token #=> String
2344
+ #
2345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists AWS API Documentation
2346
+ #
2347
+ # @overload list_query_suggestions_block_lists(params = {})
2348
+ # @param [Hash] params ({})
2349
+ def list_query_suggestions_block_lists(params = {}, options = {})
2350
+ req = build_request(:list_query_suggestions_block_lists, params)
2351
+ req.send_request(options)
2352
+ end
2353
+
1885
2354
  # Gets a list of tags associated with a specified resource. Indexes,
1886
2355
  # FAQs, and data sources can have tags associated with them.
1887
2356
  #
@@ -1984,7 +2453,7 @@ module Aws::Kendra
1984
2453
  #
1985
2454
  # @option params [required, String] :index_id
1986
2455
  # The unique identifier of the index to search. The identifier is
1987
- # returned in the response from the operation.
2456
+ # returned in the response from the `CreateIndex` operation.
1988
2457
  #
1989
2458
  # @option params [required, String] :query_text
1990
2459
  # The text to search for.
@@ -2013,6 +2482,23 @@ module Aws::Kendra
2013
2482
  # Sets the type of query. Only results for the specified query type are
2014
2483
  # returned.
2015
2484
  #
2485
+ # @option params [Array<Types::DocumentRelevanceConfiguration>] :document_relevance_override_configurations
2486
+ # Overrides relevance tuning configurations of fields or attributes set
2487
+ # at the index level.
2488
+ #
2489
+ # If you use this API to override the relevance tuning configured at the
2490
+ # index level, but there is no relevance tuning configured at the index
2491
+ # level, then Amazon Kendra does not apply any relevance tuning.
2492
+ #
2493
+ # If there is relevance tuning configured at the index level, but you do
2494
+ # not use this API to override any relevance tuning in the index, then
2495
+ # Amazon Kendra uses the relevance tuning that is configured at the
2496
+ # index level.
2497
+ #
2498
+ # If there is relevance tuning configured for fields at the index level,
2499
+ # but you use this API to override only some of these fields, then for
2500
+ # the fields you did not override, the importance is set to 1.
2501
+ #
2016
2502
  # @option params [Integer] :page_number
2017
2503
  # Query results are returned in pages the size of the `PageSize`
2018
2504
  # parameter. By default, Amazon Kendra returns the first page of
@@ -2139,6 +2625,20 @@ module Aws::Kendra
2139
2625
  # ],
2140
2626
  # requested_document_attributes: ["DocumentAttributeKey"],
2141
2627
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
2628
+ # document_relevance_override_configurations: [
2629
+ # {
2630
+ # name: "DocumentMetadataConfigurationName", # required
2631
+ # relevance: { # required
2632
+ # freshness: false,
2633
+ # importance: 1,
2634
+ # duration: "Duration",
2635
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
2636
+ # value_importance_map: {
2637
+ # "ValueImportanceMapKey" => 1,
2638
+ # },
2639
+ # },
2640
+ # },
2641
+ # ],
2142
2642
  # page_number: 1,
2143
2643
  # page_size: 1,
2144
2644
  # sorting_configuration: {
@@ -2280,7 +2780,8 @@ module Aws::Kendra
2280
2780
  #
2281
2781
  # @option params [required, String] :query_id
2282
2782
  # The identifier of the specific query for which you are submitting
2283
- # feedback. The query ID is returned in the response to the operation.
2783
+ # feedback. The query ID is returned in the response to the `Query`
2784
+ # operation.
2284
2785
  #
2285
2786
  # @option params [Array<Types::ClickFeedback>] :click_feedback_items
2286
2787
  # Tells Amazon Kendra that a particular search result link was chosen by
@@ -2594,6 +3095,7 @@ module Aws::Kendra
2594
3095
  # index_field_name: "IndexFieldName", # required
2595
3096
  # },
2596
3097
  # ],
3098
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
2597
3099
  # },
2598
3100
  # service_catalog_configuration: {
2599
3101
  # crawl_attachments: false,
@@ -2609,6 +3111,7 @@ module Aws::Kendra
2609
3111
  # },
2610
3112
  # ],
2611
3113
  # },
3114
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
2612
3115
  # },
2613
3116
  # confluence_configuration: {
2614
3117
  # server_url: "Url", # required
@@ -2711,7 +3214,7 @@ module Aws::Kendra
2711
3214
  # The document metadata to update.
2712
3215
  #
2713
3216
  # @option params [Types::CapacityUnitsConfiguration] :capacity_units
2714
- # Sets the number of addtional storage and query capacity units that
3217
+ # Sets the number of additional storage and query capacity units that
2715
3218
  # should be used by the index. You can change the capacity of the index
2716
3219
  # up to 5 times per day.
2717
3220
  #
@@ -2787,6 +3290,167 @@ module Aws::Kendra
2787
3290
  req.send_request(options)
2788
3291
  end
2789
3292
 
3293
+ # Updates a block list used for query suggestions for an index.
3294
+ #
3295
+ # Updates to a block list might not take effect right away. Amazon
3296
+ # Kendra needs to refresh the entire suggestions list to apply any
3297
+ # updates to the block list. Other changes not related to the block list
3298
+ # apply immediately.
3299
+ #
3300
+ # If a block list is updating, then you need to wait for the first
3301
+ # update to finish before submitting another update.
3302
+ #
3303
+ # Amazon Kendra supports partial updates, so you only need to provide
3304
+ # the fields you want to update.
3305
+ #
3306
+ # @option params [required, String] :index_id
3307
+ # The identifier of the index for a block list.
3308
+ #
3309
+ # @option params [required, String] :id
3310
+ # The unique identifier of a block list.
3311
+ #
3312
+ # @option params [String] :name
3313
+ # The name of a block list.
3314
+ #
3315
+ # @option params [String] :description
3316
+ # The description for a block list.
3317
+ #
3318
+ # @option params [Types::S3Path] :source_s3_path
3319
+ # The S3 path where your block list text file sits in S3.
3320
+ #
3321
+ # If you update your block list and provide the same path to the block
3322
+ # list text file in S3, then Amazon Kendra reloads the file to refresh
3323
+ # the block list. Amazon Kendra does not automatically refresh your
3324
+ # block list. You need to call the `UpdateQuerySuggestionsBlockList` API
3325
+ # to refresh you block list.
3326
+ #
3327
+ # If you update your block list, then Amazon Kendra asynchronously
3328
+ # refreshes all query suggestions with the latest content in the S3
3329
+ # file. This means changes might not take effect immediately.
3330
+ #
3331
+ # @option params [String] :role_arn
3332
+ # The IAM (Identity and Access Management) role used to access the block
3333
+ # list text file in S3.
3334
+ #
3335
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3336
+ #
3337
+ # @example Request syntax with placeholder values
3338
+ #
3339
+ # resp = client.update_query_suggestions_block_list({
3340
+ # index_id: "IndexId", # required
3341
+ # id: "QuerySuggestionsBlockListId", # required
3342
+ # name: "QuerySuggestionsBlockListName",
3343
+ # description: "Description",
3344
+ # source_s3_path: {
3345
+ # bucket: "S3BucketName", # required
3346
+ # key: "S3ObjectKey", # required
3347
+ # },
3348
+ # role_arn: "RoleArn",
3349
+ # })
3350
+ #
3351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList AWS API Documentation
3352
+ #
3353
+ # @overload update_query_suggestions_block_list(params = {})
3354
+ # @param [Hash] params ({})
3355
+ def update_query_suggestions_block_list(params = {}, options = {})
3356
+ req = build_request(:update_query_suggestions_block_list, params)
3357
+ req.send_request(options)
3358
+ end
3359
+
3360
+ # Updates the settings of query suggestions for an index.
3361
+ #
3362
+ # Amazon Kendra supports partial updates, so you only need to provide
3363
+ # the fields you want to update.
3364
+ #
3365
+ # If an update is currently processing (i.e. 'happening'), you need to
3366
+ # wait for the update to finish before making another update.
3367
+ #
3368
+ # Updates to query suggestions settings might not take effect right
3369
+ # away. The time for your updated settings to take effect depends on the
3370
+ # updates made and the number of search queries in your index.
3371
+ #
3372
+ # You can still enable/disable query suggestions at any time.
3373
+ #
3374
+ # @option params [required, String] :index_id
3375
+ # The identifier of the index you want to update query suggestions
3376
+ # settings for.
3377
+ #
3378
+ # @option params [String] :mode
3379
+ # Set the mode to `ENABLED` or `LEARN_ONLY`.
3380
+ #
3381
+ # By default, Amazon Kendra enables query suggestions. `LEARN_ONLY` mode
3382
+ # allows you to turn off query suggestions. You can to update this at
3383
+ # any time.
3384
+ #
3385
+ # In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
3386
+ # queries to keep suggestions up to date for when you are ready to
3387
+ # switch to ENABLED mode again.
3388
+ #
3389
+ # @option params [Integer] :query_log_look_back_window_in_days
3390
+ # How recent your queries are in your query log time window.
3391
+ #
3392
+ # The time window is the number of days from current day to past days.
3393
+ #
3394
+ # By default, Amazon Kendra sets this to 180.
3395
+ #
3396
+ # @option params [Boolean] :include_queries_without_user_information
3397
+ # `TRUE` to include queries without user information (i.e. all queries,
3398
+ # irrespective of the user), otherwise `FALSE` to only include queries
3399
+ # with user information.
3400
+ #
3401
+ # If you pass user information to Amazon Kendra along with the queries,
3402
+ # you can set this flag to `FALSE` and instruct Amazon Kendra to only
3403
+ # consider queries with user information.
3404
+ #
3405
+ # If you set to `FALSE`, Amazon Kendra only considers queries searched
3406
+ # at least `MinimumQueryCount` times across
3407
+ # `MinimumNumberOfQueryingUsers` unique users for suggestions.
3408
+ #
3409
+ # If you set to `TRUE`, Amazon Kendra ignores all user information and
3410
+ # learns from all queries.
3411
+ #
3412
+ # @option params [Integer] :minimum_number_of_querying_users
3413
+ # The minimum number of unique users who must search a query in order
3414
+ # for the query to be eligible to suggest to your users.
3415
+ #
3416
+ # Increasing this number might decrease the number of suggestions.
3417
+ # However, this ensures a query is searched by many users and is truly
3418
+ # popular to suggest to users.
3419
+ #
3420
+ # How you tune this setting depends on your specific needs.
3421
+ #
3422
+ # @option params [Integer] :minimum_query_count
3423
+ # The the minimum number of times a query must be searched in order to
3424
+ # be eligible to suggest to your users.
3425
+ #
3426
+ # Decreasing this number increases the number of suggestions. However,
3427
+ # this affects the quality of suggestions as it sets a low bar for a
3428
+ # query to be considered popular to suggest to users.
3429
+ #
3430
+ # How you tune this setting depends on your specific needs.
3431
+ #
3432
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3433
+ #
3434
+ # @example Request syntax with placeholder values
3435
+ #
3436
+ # resp = client.update_query_suggestions_config({
3437
+ # index_id: "IndexId", # required
3438
+ # mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
3439
+ # query_log_look_back_window_in_days: 1,
3440
+ # include_queries_without_user_information: false,
3441
+ # minimum_number_of_querying_users: 1,
3442
+ # minimum_query_count: 1,
3443
+ # })
3444
+ #
3445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig AWS API Documentation
3446
+ #
3447
+ # @overload update_query_suggestions_config(params = {})
3448
+ # @param [Hash] params ({})
3449
+ def update_query_suggestions_config(params = {}, options = {})
3450
+ req = build_request(:update_query_suggestions_config, params)
3451
+ req.send_request(options)
3452
+ end
3453
+
2790
3454
  # Updates a thesaurus file associated with an index.
2791
3455
  #
2792
3456
  # @option params [required, String] :id
@@ -2845,7 +3509,7 @@ module Aws::Kendra
2845
3509
  params: params,
2846
3510
  config: config)
2847
3511
  context[:gem_name] = 'aws-sdk-kendra'
2848
- context[:gem_version] = '1.21.0'
3512
+ context[:gem_version] = '1.26.0'
2849
3513
  Seahorse::Client::Request.new(handlers, context)
2850
3514
  end
2851
3515