aws-sdk-kendra 1.17.0 → 1.22.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +123 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-kendra.rb +2 -2
- data/lib/aws-sdk-kendra/client.rb +393 -8
- data/lib/aws-sdk-kendra/client_api.rb +217 -1
- data/lib/aws-sdk-kendra/errors.rb +1 -1
- data/lib/aws-sdk-kendra/resource.rb +1 -1
- data/lib/aws-sdk-kendra/types.rb +811 -22
- metadata +8 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a5b1f6f700a2e9457090c9fa3be05fa5d10d03b625362a763e92753103541a1a
|
|
4
|
+
data.tar.gz: 76b827d689a96cd3dc80034fd6aa8f64769528f296635ff1c9d3ec3e9c0ae665
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c85b240608c91f2212faf2ce73460d686a779196751df375bb72e1094d603c9ff4947106744af7f45af010dc7831ca2d125911ae1be9dcd29fa5324c87014682
|
|
7
|
+
data.tar.gz: eb1adc711d6a4d8b3c3436b79b79652b75fea2dfa1da0632e36d0941a146f6b2c09ae7145b2cbea80c3a21fddc3ea68be697624d7d0139fae3f9b99874d656ef
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
Unreleased Changes
|
|
2
|
+
------------------
|
|
3
|
+
|
|
4
|
+
1.22.0 (2021-03-10)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
8
|
+
|
|
9
|
+
1.21.0 (2021-02-02)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
13
|
+
|
|
14
|
+
1.20.0 (2020-12-10)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Amazon Kendra now supports adding synonyms to an index through the new Thesaurus resource.
|
|
18
|
+
|
|
19
|
+
1.19.0 (2020-12-08)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* 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.
|
|
23
|
+
|
|
24
|
+
1.18.0 (2020-11-05)
|
|
25
|
+
------------------
|
|
26
|
+
|
|
27
|
+
* 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.
|
|
28
|
+
|
|
29
|
+
1.17.0 (2020-10-26)
|
|
30
|
+
------------------
|
|
31
|
+
|
|
32
|
+
* Feature - Amazon Kendra now supports indexing data from Confluence Server.
|
|
33
|
+
|
|
34
|
+
1.16.0 (2020-10-21)
|
|
35
|
+
------------------
|
|
36
|
+
|
|
37
|
+
* 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.
|
|
38
|
+
|
|
39
|
+
1.15.0 (2020-10-21)
|
|
40
|
+
------------------
|
|
41
|
+
|
|
42
|
+
* 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.
|
|
43
|
+
|
|
44
|
+
1.14.0 (2020-09-30)
|
|
45
|
+
------------------
|
|
46
|
+
|
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
48
|
+
|
|
49
|
+
1.13.0 (2020-09-17)
|
|
50
|
+
------------------
|
|
51
|
+
|
|
52
|
+
* Feature - Amazon Kendra now supports additional file formats and metadata for FAQs.
|
|
53
|
+
|
|
54
|
+
1.12.0 (2020-09-15)
|
|
55
|
+
------------------
|
|
56
|
+
|
|
57
|
+
* Feature - Amazon Kendra now returns confidence scores for 'document' query responses.
|
|
58
|
+
|
|
59
|
+
1.11.0 (2020-09-03)
|
|
60
|
+
------------------
|
|
61
|
+
|
|
62
|
+
* Feature - Amazon Kendra now returns confidence scores for both 'answer' and 'question and answer' query responses.
|
|
63
|
+
|
|
64
|
+
1.10.0 (2020-08-25)
|
|
65
|
+
------------------
|
|
66
|
+
|
|
67
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
68
|
+
|
|
69
|
+
1.9.0 (2020-07-24)
|
|
70
|
+
------------------
|
|
71
|
+
|
|
72
|
+
* 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.
|
|
73
|
+
|
|
74
|
+
1.8.0 (2020-06-23)
|
|
75
|
+
------------------
|
|
76
|
+
|
|
77
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
78
|
+
|
|
79
|
+
1.7.1 (2020-06-11)
|
|
80
|
+
------------------
|
|
81
|
+
|
|
82
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
|
83
|
+
|
|
84
|
+
1.7.0 (2020-06-10)
|
|
85
|
+
------------------
|
|
86
|
+
|
|
87
|
+
* Issue - This version has been yanked. (#2327).
|
|
88
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
89
|
+
|
|
90
|
+
1.6.0 (2020-05-28)
|
|
91
|
+
------------------
|
|
92
|
+
|
|
93
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
94
|
+
|
|
95
|
+
1.5.0 (2020-05-11)
|
|
96
|
+
------------------
|
|
97
|
+
|
|
98
|
+
* 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
|
|
99
|
+
|
|
100
|
+
1.4.0 (2020-05-07)
|
|
101
|
+
------------------
|
|
102
|
+
|
|
103
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
104
|
+
|
|
105
|
+
1.3.0 (2020-03-27)
|
|
106
|
+
------------------
|
|
107
|
+
|
|
108
|
+
* 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.
|
|
109
|
+
|
|
110
|
+
1.2.0 (2020-03-09)
|
|
111
|
+
------------------
|
|
112
|
+
|
|
113
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
114
|
+
|
|
115
|
+
1.1.0 (2019-12-10)
|
|
116
|
+
------------------
|
|
117
|
+
|
|
118
|
+
* Feature - 1. Adding DocumentTitleFieldName as an optional configuration for SharePoint. 2. updating s3 object pattern to support all s3 keys.
|
|
119
|
+
|
|
120
|
+
1.0.0 (2019-12-03)
|
|
121
|
+
------------------
|
|
122
|
+
|
|
123
|
+
* 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.22.0
|
data/lib/aws-sdk-kendra.rb
CHANGED
|
@@ -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/
|
|
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.
|
|
51
|
+
GEM_VERSION = '1.22.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/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -566,7 +566,7 @@ module Aws::Kendra
|
|
|
566
566
|
# resp = client.create_data_source({
|
|
567
567
|
# name: "DataSourceName", # required
|
|
568
568
|
# index_id: "IndexId", # required
|
|
569
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE
|
|
569
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
|
|
570
570
|
# configuration: {
|
|
571
571
|
# s3_configuration: {
|
|
572
572
|
# bucket_name: "S3BucketName", # required
|
|
@@ -600,6 +600,7 @@ module Aws::Kendra
|
|
|
600
600
|
# },
|
|
601
601
|
# ],
|
|
602
602
|
# document_title_field_name: "DataSourceFieldName",
|
|
603
|
+
# disable_local_groups: false,
|
|
603
604
|
# },
|
|
604
605
|
# database_configuration: {
|
|
605
606
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
|
@@ -724,6 +725,7 @@ module Aws::Kendra
|
|
|
724
725
|
# index_field_name: "IndexFieldName", # required
|
|
725
726
|
# },
|
|
726
727
|
# ],
|
|
728
|
+
# disable_local_groups: false,
|
|
727
729
|
# },
|
|
728
730
|
# service_now_configuration: {
|
|
729
731
|
# host_url: "ServiceNowHostUrl", # required
|
|
@@ -761,7 +763,7 @@ module Aws::Kendra
|
|
|
761
763
|
# confluence_configuration: {
|
|
762
764
|
# server_url: "Url", # required
|
|
763
765
|
# secret_arn: "SecretArn", # required
|
|
764
|
-
# version: "
|
|
766
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
|
765
767
|
# space_configuration: {
|
|
766
768
|
# crawl_personal_spaces: false,
|
|
767
769
|
# crawl_archived_spaces: false,
|
|
@@ -810,6 +812,21 @@ module Aws::Kendra
|
|
|
810
812
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
811
813
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
812
814
|
# },
|
|
815
|
+
# google_drive_configuration: {
|
|
816
|
+
# secret_arn: "SecretArn", # required
|
|
817
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
818
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
819
|
+
# field_mappings: [
|
|
820
|
+
# {
|
|
821
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
822
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
823
|
+
# index_field_name: "IndexFieldName", # required
|
|
824
|
+
# },
|
|
825
|
+
# ],
|
|
826
|
+
# exclude_mime_types: ["MimeType"],
|
|
827
|
+
# exclude_user_accounts: ["UserAccount"],
|
|
828
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
|
829
|
+
# },
|
|
813
830
|
# },
|
|
814
831
|
# description: "Description",
|
|
815
832
|
# schedule: "ScanSchedule",
|
|
@@ -973,6 +990,24 @@ module Aws::Kendra
|
|
|
973
990
|
# tags to identify and organize your resources and to control access to
|
|
974
991
|
# resources.
|
|
975
992
|
#
|
|
993
|
+
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
|
994
|
+
# The user token configuration.
|
|
995
|
+
#
|
|
996
|
+
# @option params [String] :user_context_policy
|
|
997
|
+
# The user context policy.
|
|
998
|
+
#
|
|
999
|
+
# ATTRIBUTE\_FILTER
|
|
1000
|
+
#
|
|
1001
|
+
# : All indexed content is searchable and displayable for all users. If
|
|
1002
|
+
# there is an access control list, it is ignored. You can filter on
|
|
1003
|
+
# user and group attributes.
|
|
1004
|
+
#
|
|
1005
|
+
# USER\_TOKEN
|
|
1006
|
+
#
|
|
1007
|
+
# : Enables SSO and token-based user access control. All documents with
|
|
1008
|
+
# no access control and all documents accessible to the user will be
|
|
1009
|
+
# searchable and displayable.
|
|
1010
|
+
#
|
|
976
1011
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
977
1012
|
#
|
|
978
1013
|
# * {Types::CreateIndexResponse#id #id} => String
|
|
@@ -994,6 +1029,24 @@ module Aws::Kendra
|
|
|
994
1029
|
# value: "TagValue", # required
|
|
995
1030
|
# },
|
|
996
1031
|
# ],
|
|
1032
|
+
# user_token_configurations: [
|
|
1033
|
+
# {
|
|
1034
|
+
# jwt_token_type_configuration: {
|
|
1035
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
|
1036
|
+
# url: "Url",
|
|
1037
|
+
# secret_manager_arn: "RoleArn",
|
|
1038
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
|
1039
|
+
# group_attribute_field: "GroupAttributeField",
|
|
1040
|
+
# issuer: "Issuer",
|
|
1041
|
+
# claim_regex: "ClaimRegex",
|
|
1042
|
+
# },
|
|
1043
|
+
# json_token_type_configuration: {
|
|
1044
|
+
# user_name_attribute_field: "String", # required
|
|
1045
|
+
# group_attribute_field: "String", # required
|
|
1046
|
+
# },
|
|
1047
|
+
# },
|
|
1048
|
+
# ],
|
|
1049
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
|
997
1050
|
# })
|
|
998
1051
|
#
|
|
999
1052
|
# @example Response structure
|
|
@@ -1009,6 +1062,76 @@ module Aws::Kendra
|
|
|
1009
1062
|
req.send_request(options)
|
|
1010
1063
|
end
|
|
1011
1064
|
|
|
1065
|
+
# Creates a thesaurus for an index. The thesaurus contains a list of
|
|
1066
|
+
# synonyms in Solr format.
|
|
1067
|
+
#
|
|
1068
|
+
# @option params [required, String] :index_id
|
|
1069
|
+
# The unique identifier of the index for the new thesaurus.
|
|
1070
|
+
#
|
|
1071
|
+
# @option params [required, String] :name
|
|
1072
|
+
# The name for the new thesaurus.
|
|
1073
|
+
#
|
|
1074
|
+
# @option params [String] :description
|
|
1075
|
+
# The description for the new thesaurus.
|
|
1076
|
+
#
|
|
1077
|
+
# @option params [required, String] :role_arn
|
|
1078
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
|
1079
|
+
# Kendra permissions to access thesaurus file specified in
|
|
1080
|
+
# `SourceS3Path`.
|
|
1081
|
+
#
|
|
1082
|
+
# @option params [Array<Types::Tag>] :tags
|
|
1083
|
+
# A list of key-value pairs that identify the thesaurus. You can use the
|
|
1084
|
+
# tags to identify and organize your resources and to control access to
|
|
1085
|
+
# resources.
|
|
1086
|
+
#
|
|
1087
|
+
# @option params [required, Types::S3Path] :source_s3_path
|
|
1088
|
+
# The thesaurus file Amazon S3 source path.
|
|
1089
|
+
#
|
|
1090
|
+
# @option params [String] :client_token
|
|
1091
|
+
# A token that you provide to identify the request to create a
|
|
1092
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` operation with the
|
|
1093
|
+
# same client token will create only one index.
|
|
1094
|
+
#
|
|
1095
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1096
|
+
# not need to pass this option.**
|
|
1097
|
+
#
|
|
1098
|
+
# @return [Types::CreateThesaurusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1099
|
+
#
|
|
1100
|
+
# * {Types::CreateThesaurusResponse#id #id} => String
|
|
1101
|
+
#
|
|
1102
|
+
# @example Request syntax with placeholder values
|
|
1103
|
+
#
|
|
1104
|
+
# resp = client.create_thesaurus({
|
|
1105
|
+
# index_id: "IndexId", # required
|
|
1106
|
+
# name: "ThesaurusName", # required
|
|
1107
|
+
# description: "Description",
|
|
1108
|
+
# role_arn: "RoleArn", # required
|
|
1109
|
+
# tags: [
|
|
1110
|
+
# {
|
|
1111
|
+
# key: "TagKey", # required
|
|
1112
|
+
# value: "TagValue", # required
|
|
1113
|
+
# },
|
|
1114
|
+
# ],
|
|
1115
|
+
# source_s3_path: { # required
|
|
1116
|
+
# bucket: "S3BucketName", # required
|
|
1117
|
+
# key: "S3ObjectKey", # required
|
|
1118
|
+
# },
|
|
1119
|
+
# client_token: "ClientTokenName",
|
|
1120
|
+
# })
|
|
1121
|
+
#
|
|
1122
|
+
# @example Response structure
|
|
1123
|
+
#
|
|
1124
|
+
# resp.id #=> String
|
|
1125
|
+
#
|
|
1126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus AWS API Documentation
|
|
1127
|
+
#
|
|
1128
|
+
# @overload create_thesaurus(params = {})
|
|
1129
|
+
# @param [Hash] params ({})
|
|
1130
|
+
def create_thesaurus(params = {}, options = {})
|
|
1131
|
+
req = build_request(:create_thesaurus, params)
|
|
1132
|
+
req.send_request(options)
|
|
1133
|
+
end
|
|
1134
|
+
|
|
1012
1135
|
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
|
1013
1136
|
# the data source is already being deleted. While the data source is
|
|
1014
1137
|
# being deleted, the `Status` field returned by a call to the operation
|
|
@@ -1094,6 +1217,32 @@ module Aws::Kendra
|
|
|
1094
1217
|
req.send_request(options)
|
|
1095
1218
|
end
|
|
1096
1219
|
|
|
1220
|
+
# Deletes an existing Amazon Kendra thesaurus.
|
|
1221
|
+
#
|
|
1222
|
+
# @option params [required, String] :id
|
|
1223
|
+
# The identifier of the thesaurus to delete.
|
|
1224
|
+
#
|
|
1225
|
+
# @option params [required, String] :index_id
|
|
1226
|
+
# The identifier of the index associated with the thesaurus to delete.
|
|
1227
|
+
#
|
|
1228
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1229
|
+
#
|
|
1230
|
+
# @example Request syntax with placeholder values
|
|
1231
|
+
#
|
|
1232
|
+
# resp = client.delete_thesaurus({
|
|
1233
|
+
# id: "ThesaurusId", # required
|
|
1234
|
+
# index_id: "IndexId", # required
|
|
1235
|
+
# })
|
|
1236
|
+
#
|
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus AWS API Documentation
|
|
1238
|
+
#
|
|
1239
|
+
# @overload delete_thesaurus(params = {})
|
|
1240
|
+
# @param [Hash] params ({})
|
|
1241
|
+
def delete_thesaurus(params = {}, options = {})
|
|
1242
|
+
req = build_request(:delete_thesaurus, params)
|
|
1243
|
+
req.send_request(options)
|
|
1244
|
+
end
|
|
1245
|
+
|
|
1097
1246
|
# Gets information about a Amazon Kendra data source.
|
|
1098
1247
|
#
|
|
1099
1248
|
# @option params [required, String] :id
|
|
@@ -1129,7 +1278,7 @@ module Aws::Kendra
|
|
|
1129
1278
|
# resp.id #=> String
|
|
1130
1279
|
# resp.index_id #=> String
|
|
1131
1280
|
# resp.name #=> String
|
|
1132
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
|
1281
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
|
1133
1282
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
|
1134
1283
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
|
1135
1284
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
|
@@ -1158,6 +1307,7 @@ module Aws::Kendra
|
|
|
1158
1307
|
# resp.configuration.share_point_configuration.field_mappings[0].date_field_format #=> String
|
|
1159
1308
|
# resp.configuration.share_point_configuration.field_mappings[0].index_field_name #=> String
|
|
1160
1309
|
# resp.configuration.share_point_configuration.document_title_field_name #=> String
|
|
1310
|
+
# resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
|
|
1161
1311
|
# resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
|
|
1162
1312
|
# resp.configuration.database_configuration.connection_configuration.database_host #=> String
|
|
1163
1313
|
# resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
|
|
@@ -1237,6 +1387,7 @@ module Aws::Kendra
|
|
|
1237
1387
|
# resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
|
1238
1388
|
# resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
|
|
1239
1389
|
# resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
|
|
1390
|
+
# resp.configuration.one_drive_configuration.disable_local_groups #=> Boolean
|
|
1240
1391
|
# resp.configuration.service_now_configuration.host_url #=> String
|
|
1241
1392
|
# resp.configuration.service_now_configuration.secret_arn #=> String
|
|
1242
1393
|
# resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
|
|
@@ -1264,7 +1415,7 @@ module Aws::Kendra
|
|
|
1264
1415
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
|
1265
1416
|
# resp.configuration.confluence_configuration.server_url #=> String
|
|
1266
1417
|
# resp.configuration.confluence_configuration.secret_arn #=> String
|
|
1267
|
-
# resp.configuration.confluence_configuration.version #=> String, one of "SERVER"
|
|
1418
|
+
# resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
|
|
1268
1419
|
# resp.configuration.confluence_configuration.space_configuration.crawl_personal_spaces #=> Boolean
|
|
1269
1420
|
# resp.configuration.confluence_configuration.space_configuration.crawl_archived_spaces #=> Boolean
|
|
1270
1421
|
# resp.configuration.confluence_configuration.space_configuration.include_spaces #=> Array
|
|
@@ -1296,6 +1447,21 @@ module Aws::Kendra
|
|
|
1296
1447
|
# resp.configuration.confluence_configuration.inclusion_patterns[0] #=> String
|
|
1297
1448
|
# resp.configuration.confluence_configuration.exclusion_patterns #=> Array
|
|
1298
1449
|
# resp.configuration.confluence_configuration.exclusion_patterns[0] #=> String
|
|
1450
|
+
# resp.configuration.google_drive_configuration.secret_arn #=> String
|
|
1451
|
+
# resp.configuration.google_drive_configuration.inclusion_patterns #=> Array
|
|
1452
|
+
# resp.configuration.google_drive_configuration.inclusion_patterns[0] #=> String
|
|
1453
|
+
# resp.configuration.google_drive_configuration.exclusion_patterns #=> Array
|
|
1454
|
+
# resp.configuration.google_drive_configuration.exclusion_patterns[0] #=> String
|
|
1455
|
+
# resp.configuration.google_drive_configuration.field_mappings #=> Array
|
|
1456
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
|
1457
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].date_field_format #=> String
|
|
1458
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].index_field_name #=> String
|
|
1459
|
+
# resp.configuration.google_drive_configuration.exclude_mime_types #=> Array
|
|
1460
|
+
# resp.configuration.google_drive_configuration.exclude_mime_types[0] #=> String
|
|
1461
|
+
# resp.configuration.google_drive_configuration.exclude_user_accounts #=> Array
|
|
1462
|
+
# resp.configuration.google_drive_configuration.exclude_user_accounts[0] #=> String
|
|
1463
|
+
# resp.configuration.google_drive_configuration.exclude_shared_drives #=> Array
|
|
1464
|
+
# resp.configuration.google_drive_configuration.exclude_shared_drives[0] #=> String
|
|
1299
1465
|
# resp.created_at #=> Time
|
|
1300
1466
|
# resp.updated_at #=> Time
|
|
1301
1467
|
# resp.description #=> String
|
|
@@ -1386,6 +1552,8 @@ module Aws::Kendra
|
|
|
1386
1552
|
# * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
|
1387
1553
|
# * {Types::DescribeIndexResponse#error_message #error_message} => String
|
|
1388
1554
|
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
|
1555
|
+
# * {Types::DescribeIndexResponse#user_token_configurations #user_token_configurations} => Array<Types::UserTokenConfiguration>
|
|
1556
|
+
# * {Types::DescribeIndexResponse#user_context_policy #user_context_policy} => String
|
|
1389
1557
|
#
|
|
1390
1558
|
# @example Request syntax with placeholder values
|
|
1391
1559
|
#
|
|
@@ -1423,6 +1591,17 @@ module Aws::Kendra
|
|
|
1423
1591
|
# resp.error_message #=> String
|
|
1424
1592
|
# resp.capacity_units.storage_capacity_units #=> Integer
|
|
1425
1593
|
# resp.capacity_units.query_capacity_units #=> Integer
|
|
1594
|
+
# resp.user_token_configurations #=> Array
|
|
1595
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.key_location #=> String, one of "URL", "SECRET_MANAGER"
|
|
1596
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.url #=> String
|
|
1597
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.secret_manager_arn #=> String
|
|
1598
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.user_name_attribute_field #=> String
|
|
1599
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.group_attribute_field #=> String
|
|
1600
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.issuer #=> String
|
|
1601
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.claim_regex #=> String
|
|
1602
|
+
# resp.user_token_configurations[0].json_token_type_configuration.user_name_attribute_field #=> String
|
|
1603
|
+
# resp.user_token_configurations[0].json_token_type_configuration.group_attribute_field #=> String
|
|
1604
|
+
# resp.user_context_policy #=> String, one of "ATTRIBUTE_FILTER", "USER_TOKEN"
|
|
1426
1605
|
#
|
|
1427
1606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
|
1428
1607
|
#
|
|
@@ -1433,6 +1612,63 @@ module Aws::Kendra
|
|
|
1433
1612
|
req.send_request(options)
|
|
1434
1613
|
end
|
|
1435
1614
|
|
|
1615
|
+
# Describes an existing Amazon Kendra thesaurus.
|
|
1616
|
+
#
|
|
1617
|
+
# @option params [required, String] :id
|
|
1618
|
+
# The identifier of the thesaurus to describe.
|
|
1619
|
+
#
|
|
1620
|
+
# @option params [required, String] :index_id
|
|
1621
|
+
# The identifier of the index associated with the thesaurus to describe.
|
|
1622
|
+
#
|
|
1623
|
+
# @return [Types::DescribeThesaurusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1624
|
+
#
|
|
1625
|
+
# * {Types::DescribeThesaurusResponse#id #id} => String
|
|
1626
|
+
# * {Types::DescribeThesaurusResponse#index_id #index_id} => String
|
|
1627
|
+
# * {Types::DescribeThesaurusResponse#name #name} => String
|
|
1628
|
+
# * {Types::DescribeThesaurusResponse#description #description} => String
|
|
1629
|
+
# * {Types::DescribeThesaurusResponse#status #status} => String
|
|
1630
|
+
# * {Types::DescribeThesaurusResponse#error_message #error_message} => String
|
|
1631
|
+
# * {Types::DescribeThesaurusResponse#created_at #created_at} => Time
|
|
1632
|
+
# * {Types::DescribeThesaurusResponse#updated_at #updated_at} => Time
|
|
1633
|
+
# * {Types::DescribeThesaurusResponse#role_arn #role_arn} => String
|
|
1634
|
+
# * {Types::DescribeThesaurusResponse#source_s3_path #source_s3_path} => Types::S3Path
|
|
1635
|
+
# * {Types::DescribeThesaurusResponse#file_size_bytes #file_size_bytes} => Integer
|
|
1636
|
+
# * {Types::DescribeThesaurusResponse#term_count #term_count} => Integer
|
|
1637
|
+
# * {Types::DescribeThesaurusResponse#synonym_rule_count #synonym_rule_count} => Integer
|
|
1638
|
+
#
|
|
1639
|
+
# @example Request syntax with placeholder values
|
|
1640
|
+
#
|
|
1641
|
+
# resp = client.describe_thesaurus({
|
|
1642
|
+
# id: "ThesaurusId", # required
|
|
1643
|
+
# index_id: "IndexId", # required
|
|
1644
|
+
# })
|
|
1645
|
+
#
|
|
1646
|
+
# @example Response structure
|
|
1647
|
+
#
|
|
1648
|
+
# resp.id #=> String
|
|
1649
|
+
# resp.index_id #=> String
|
|
1650
|
+
# resp.name #=> String
|
|
1651
|
+
# resp.description #=> String
|
|
1652
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
|
1653
|
+
# resp.error_message #=> String
|
|
1654
|
+
# resp.created_at #=> Time
|
|
1655
|
+
# resp.updated_at #=> Time
|
|
1656
|
+
# resp.role_arn #=> String
|
|
1657
|
+
# resp.source_s3_path.bucket #=> String
|
|
1658
|
+
# resp.source_s3_path.key #=> String
|
|
1659
|
+
# resp.file_size_bytes #=> Integer
|
|
1660
|
+
# resp.term_count #=> Integer
|
|
1661
|
+
# resp.synonym_rule_count #=> Integer
|
|
1662
|
+
#
|
|
1663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus AWS API Documentation
|
|
1664
|
+
#
|
|
1665
|
+
# @overload describe_thesaurus(params = {})
|
|
1666
|
+
# @param [Hash] params ({})
|
|
1667
|
+
def describe_thesaurus(params = {}, options = {})
|
|
1668
|
+
req = build_request(:describe_thesaurus, params)
|
|
1669
|
+
req.send_request(options)
|
|
1670
|
+
end
|
|
1671
|
+
|
|
1436
1672
|
# Gets statistics about synchronizing Amazon Kendra with a data source.
|
|
1437
1673
|
#
|
|
1438
1674
|
# @option params [required, String] :id
|
|
@@ -1539,7 +1775,7 @@ module Aws::Kendra
|
|
|
1539
1775
|
# resp.summary_items #=> Array
|
|
1540
1776
|
# resp.summary_items[0].name #=> String
|
|
1541
1777
|
# resp.summary_items[0].id #=> String
|
|
1542
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
|
1778
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
|
1543
1779
|
# resp.summary_items[0].created_at #=> Time
|
|
1544
1780
|
# resp.summary_items[0].updated_at #=> Time
|
|
1545
1781
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
|
@@ -1678,6 +1914,52 @@ module Aws::Kendra
|
|
|
1678
1914
|
req.send_request(options)
|
|
1679
1915
|
end
|
|
1680
1916
|
|
|
1917
|
+
# Lists the Amazon Kendra thesauri associated with an index.
|
|
1918
|
+
#
|
|
1919
|
+
# @option params [required, String] :index_id
|
|
1920
|
+
# The identifier of the index associated with the thesaurus to list.
|
|
1921
|
+
#
|
|
1922
|
+
# @option params [String] :next_token
|
|
1923
|
+
# If the previous response was incomplete (because there is more data to
|
|
1924
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
|
1925
|
+
# You can use this pagination token to retrieve the next set of thesauri
|
|
1926
|
+
# (`ThesaurusSummaryItems`).
|
|
1927
|
+
#
|
|
1928
|
+
# @option params [Integer] :max_results
|
|
1929
|
+
# The maximum number of thesauri to return.
|
|
1930
|
+
#
|
|
1931
|
+
# @return [Types::ListThesauriResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1932
|
+
#
|
|
1933
|
+
# * {Types::ListThesauriResponse#next_token #next_token} => String
|
|
1934
|
+
# * {Types::ListThesauriResponse#thesaurus_summary_items #thesaurus_summary_items} => Array<Types::ThesaurusSummary>
|
|
1935
|
+
#
|
|
1936
|
+
# @example Request syntax with placeholder values
|
|
1937
|
+
#
|
|
1938
|
+
# resp = client.list_thesauri({
|
|
1939
|
+
# index_id: "IndexId", # required
|
|
1940
|
+
# next_token: "NextToken",
|
|
1941
|
+
# max_results: 1,
|
|
1942
|
+
# })
|
|
1943
|
+
#
|
|
1944
|
+
# @example Response structure
|
|
1945
|
+
#
|
|
1946
|
+
# resp.next_token #=> String
|
|
1947
|
+
# resp.thesaurus_summary_items #=> Array
|
|
1948
|
+
# resp.thesaurus_summary_items[0].id #=> String
|
|
1949
|
+
# resp.thesaurus_summary_items[0].name #=> String
|
|
1950
|
+
# resp.thesaurus_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
|
1951
|
+
# resp.thesaurus_summary_items[0].created_at #=> Time
|
|
1952
|
+
# resp.thesaurus_summary_items[0].updated_at #=> Time
|
|
1953
|
+
#
|
|
1954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri AWS API Documentation
|
|
1955
|
+
#
|
|
1956
|
+
# @overload list_thesauri(params = {})
|
|
1957
|
+
# @param [Hash] params ({})
|
|
1958
|
+
def list_thesauri(params = {}, options = {})
|
|
1959
|
+
req = build_request(:list_thesauri, params)
|
|
1960
|
+
req.send_request(options)
|
|
1961
|
+
end
|
|
1962
|
+
|
|
1681
1963
|
# Searches an active index. Use this API to search your documents using
|
|
1682
1964
|
# query. The `Query` operation enables to do faceted search and to
|
|
1683
1965
|
# filter results based on document attributes.
|
|
@@ -1751,6 +2033,15 @@ module Aws::Kendra
|
|
|
1751
2033
|
# If you don't provide sorting configuration, the results are sorted by
|
|
1752
2034
|
# the relevance that Amazon Kendra determines for the result.
|
|
1753
2035
|
#
|
|
2036
|
+
# @option params [Types::UserContext] :user_context
|
|
2037
|
+
# The user context token.
|
|
2038
|
+
#
|
|
2039
|
+
# @option params [String] :visitor_id
|
|
2040
|
+
# Provides an identifier for a specific user. The `VisitorId` should be
|
|
2041
|
+
# a unique identifier, such as a GUID. Don't use personally
|
|
2042
|
+
# identifiable information, such as the user's email address, as the
|
|
2043
|
+
# `VisitorId`.
|
|
2044
|
+
#
|
|
1754
2045
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1755
2046
|
#
|
|
1756
2047
|
# * {Types::QueryResult#query_id #query_id} => String
|
|
@@ -1854,6 +2145,10 @@ module Aws::Kendra
|
|
|
1854
2145
|
# document_attribute_key: "DocumentAttributeKey", # required
|
|
1855
2146
|
# sort_order: "DESC", # required, accepts DESC, ASC
|
|
1856
2147
|
# },
|
|
2148
|
+
# user_context: {
|
|
2149
|
+
# token: "Token",
|
|
2150
|
+
# },
|
|
2151
|
+
# visitor_id: "VisitorId",
|
|
1857
2152
|
# })
|
|
1858
2153
|
#
|
|
1859
2154
|
# @example Response structure
|
|
@@ -1870,17 +2165,20 @@ module Aws::Kendra
|
|
|
1870
2165
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].begin_offset #=> Integer
|
|
1871
2166
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].end_offset #=> Integer
|
|
1872
2167
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].top_answer #=> Boolean
|
|
2168
|
+
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
|
1873
2169
|
# resp.result_items[0].document_id #=> String
|
|
1874
2170
|
# resp.result_items[0].document_title.text #=> String
|
|
1875
2171
|
# resp.result_items[0].document_title.highlights #=> Array
|
|
1876
2172
|
# resp.result_items[0].document_title.highlights[0].begin_offset #=> Integer
|
|
1877
2173
|
# resp.result_items[0].document_title.highlights[0].end_offset #=> Integer
|
|
1878
2174
|
# resp.result_items[0].document_title.highlights[0].top_answer #=> Boolean
|
|
2175
|
+
# resp.result_items[0].document_title.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
|
1879
2176
|
# resp.result_items[0].document_excerpt.text #=> String
|
|
1880
2177
|
# resp.result_items[0].document_excerpt.highlights #=> Array
|
|
1881
2178
|
# resp.result_items[0].document_excerpt.highlights[0].begin_offset #=> Integer
|
|
1882
2179
|
# resp.result_items[0].document_excerpt.highlights[0].end_offset #=> Integer
|
|
1883
2180
|
# resp.result_items[0].document_excerpt.highlights[0].top_answer #=> Boolean
|
|
2181
|
+
# resp.result_items[0].document_excerpt.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
|
1884
2182
|
# resp.result_items[0].document_uri #=> String
|
|
1885
2183
|
# resp.result_items[0].document_attributes #=> Array
|
|
1886
2184
|
# resp.result_items[0].document_attributes[0].key #=> String
|
|
@@ -1890,6 +2188,7 @@ module Aws::Kendra
|
|
|
1890
2188
|
# resp.result_items[0].document_attributes[0].value.long_value #=> Integer
|
|
1891
2189
|
# resp.result_items[0].document_attributes[0].value.date_value #=> Time
|
|
1892
2190
|
# resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
|
|
2191
|
+
# resp.result_items[0].feedback_token #=> String
|
|
1893
2192
|
# resp.facet_results #=> Array
|
|
1894
2193
|
# resp.facet_results[0].document_attribute_key #=> String
|
|
1895
2194
|
# resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
|
|
@@ -2151,6 +2450,7 @@ module Aws::Kendra
|
|
|
2151
2450
|
# },
|
|
2152
2451
|
# ],
|
|
2153
2452
|
# document_title_field_name: "DataSourceFieldName",
|
|
2453
|
+
# disable_local_groups: false,
|
|
2154
2454
|
# },
|
|
2155
2455
|
# database_configuration: {
|
|
2156
2456
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
|
@@ -2275,6 +2575,7 @@ module Aws::Kendra
|
|
|
2275
2575
|
# index_field_name: "IndexFieldName", # required
|
|
2276
2576
|
# },
|
|
2277
2577
|
# ],
|
|
2578
|
+
# disable_local_groups: false,
|
|
2278
2579
|
# },
|
|
2279
2580
|
# service_now_configuration: {
|
|
2280
2581
|
# host_url: "ServiceNowHostUrl", # required
|
|
@@ -2312,7 +2613,7 @@ module Aws::Kendra
|
|
|
2312
2613
|
# confluence_configuration: {
|
|
2313
2614
|
# server_url: "Url", # required
|
|
2314
2615
|
# secret_arn: "SecretArn", # required
|
|
2315
|
-
# version: "
|
|
2616
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
|
2316
2617
|
# space_configuration: {
|
|
2317
2618
|
# crawl_personal_spaces: false,
|
|
2318
2619
|
# crawl_archived_spaces: false,
|
|
@@ -2361,6 +2662,21 @@ module Aws::Kendra
|
|
|
2361
2662
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2362
2663
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2363
2664
|
# },
|
|
2665
|
+
# google_drive_configuration: {
|
|
2666
|
+
# secret_arn: "SecretArn", # required
|
|
2667
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2668
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2669
|
+
# field_mappings: [
|
|
2670
|
+
# {
|
|
2671
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
2672
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
2673
|
+
# index_field_name: "IndexFieldName", # required
|
|
2674
|
+
# },
|
|
2675
|
+
# ],
|
|
2676
|
+
# exclude_mime_types: ["MimeType"],
|
|
2677
|
+
# exclude_user_accounts: ["UserAccount"],
|
|
2678
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
|
2679
|
+
# },
|
|
2364
2680
|
# },
|
|
2365
2681
|
# description: "Description",
|
|
2366
2682
|
# schedule: "ScanSchedule",
|
|
@@ -2402,6 +2718,12 @@ module Aws::Kendra
|
|
|
2402
2718
|
# If you are using extra storage units, you can't reduce the storage
|
|
2403
2719
|
# capacity below that required to meet the storage needs for your index.
|
|
2404
2720
|
#
|
|
2721
|
+
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
|
2722
|
+
# The user token configuration.
|
|
2723
|
+
#
|
|
2724
|
+
# @option params [String] :user_context_policy
|
|
2725
|
+
# The user user token context policy.
|
|
2726
|
+
#
|
|
2405
2727
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2406
2728
|
#
|
|
2407
2729
|
# @example Request syntax with placeholder values
|
|
@@ -2436,6 +2758,24 @@ module Aws::Kendra
|
|
|
2436
2758
|
# storage_capacity_units: 1, # required
|
|
2437
2759
|
# query_capacity_units: 1, # required
|
|
2438
2760
|
# },
|
|
2761
|
+
# user_token_configurations: [
|
|
2762
|
+
# {
|
|
2763
|
+
# jwt_token_type_configuration: {
|
|
2764
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
|
2765
|
+
# url: "Url",
|
|
2766
|
+
# secret_manager_arn: "RoleArn",
|
|
2767
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
|
2768
|
+
# group_attribute_field: "GroupAttributeField",
|
|
2769
|
+
# issuer: "Issuer",
|
|
2770
|
+
# claim_regex: "ClaimRegex",
|
|
2771
|
+
# },
|
|
2772
|
+
# json_token_type_configuration: {
|
|
2773
|
+
# user_name_attribute_field: "String", # required
|
|
2774
|
+
# group_attribute_field: "String", # required
|
|
2775
|
+
# },
|
|
2776
|
+
# },
|
|
2777
|
+
# ],
|
|
2778
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
|
2439
2779
|
# })
|
|
2440
2780
|
#
|
|
2441
2781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
|
@@ -2447,6 +2787,51 @@ module Aws::Kendra
|
|
|
2447
2787
|
req.send_request(options)
|
|
2448
2788
|
end
|
|
2449
2789
|
|
|
2790
|
+
# Updates a thesaurus file associated with an index.
|
|
2791
|
+
#
|
|
2792
|
+
# @option params [required, String] :id
|
|
2793
|
+
# The identifier of the thesaurus to update.
|
|
2794
|
+
#
|
|
2795
|
+
# @option params [String] :name
|
|
2796
|
+
# The updated name of the thesaurus.
|
|
2797
|
+
#
|
|
2798
|
+
# @option params [required, String] :index_id
|
|
2799
|
+
# The identifier of the index associated with the thesaurus to update.
|
|
2800
|
+
#
|
|
2801
|
+
# @option params [String] :description
|
|
2802
|
+
# The updated description of the thesaurus.
|
|
2803
|
+
#
|
|
2804
|
+
# @option params [String] :role_arn
|
|
2805
|
+
# The updated role ARN of the thesaurus.
|
|
2806
|
+
#
|
|
2807
|
+
# @option params [Types::S3Path] :source_s3_path
|
|
2808
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
|
2809
|
+
#
|
|
2810
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2811
|
+
#
|
|
2812
|
+
# @example Request syntax with placeholder values
|
|
2813
|
+
#
|
|
2814
|
+
# resp = client.update_thesaurus({
|
|
2815
|
+
# id: "ThesaurusId", # required
|
|
2816
|
+
# name: "ThesaurusName",
|
|
2817
|
+
# index_id: "IndexId", # required
|
|
2818
|
+
# description: "Description",
|
|
2819
|
+
# role_arn: "RoleArn",
|
|
2820
|
+
# source_s3_path: {
|
|
2821
|
+
# bucket: "S3BucketName", # required
|
|
2822
|
+
# key: "S3ObjectKey", # required
|
|
2823
|
+
# },
|
|
2824
|
+
# })
|
|
2825
|
+
#
|
|
2826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus AWS API Documentation
|
|
2827
|
+
#
|
|
2828
|
+
# @overload update_thesaurus(params = {})
|
|
2829
|
+
# @param [Hash] params ({})
|
|
2830
|
+
def update_thesaurus(params = {}, options = {})
|
|
2831
|
+
req = build_request(:update_thesaurus, params)
|
|
2832
|
+
req.send_request(options)
|
|
2833
|
+
end
|
|
2834
|
+
|
|
2450
2835
|
# @!endgroup
|
|
2451
2836
|
|
|
2452
2837
|
# @param params ({})
|
|
@@ -2460,7 +2845,7 @@ module Aws::Kendra
|
|
|
2460
2845
|
params: params,
|
|
2461
2846
|
config: config)
|
|
2462
2847
|
context[:gem_name] = 'aws-sdk-kendra'
|
|
2463
|
-
context[:gem_version] = '1.
|
|
2848
|
+
context[:gem_version] = '1.22.0'
|
|
2464
2849
|
Seahorse::Client::Request.new(handlers, context)
|
|
2465
2850
|
end
|
|
2466
2851
|
|