aws-sdk-kendra 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-kendra.rb +47 -0
- data/lib/aws-sdk-kendra/client.rb +1615 -0
- data/lib/aws-sdk-kendra/client_api.rb +1014 -0
- data/lib/aws-sdk-kendra/customizations.rb +0 -0
- data/lib/aws-sdk-kendra/errors.rb +174 -0
- data/lib/aws-sdk-kendra/resource.rb +23 -0
- data/lib/aws-sdk-kendra/types.rb +3340 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,174 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::Kendra
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
class AccessDeniedException < ServiceError
|
14
|
+
|
15
|
+
# @param [Seahorse::Client::RequestContext] context
|
16
|
+
# @param [String] message
|
17
|
+
# @param [Aws::Kendra::Types::AccessDeniedException] data
|
18
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
|
+
super(context, message, data)
|
20
|
+
end
|
21
|
+
|
22
|
+
# @return [String]
|
23
|
+
def message
|
24
|
+
@message || @data[:message]
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
|
29
|
+
class ConflictException < ServiceError
|
30
|
+
|
31
|
+
# @param [Seahorse::Client::RequestContext] context
|
32
|
+
# @param [String] message
|
33
|
+
# @param [Aws::Kendra::Types::ConflictException] data
|
34
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
35
|
+
super(context, message, data)
|
36
|
+
end
|
37
|
+
|
38
|
+
# @return [String]
|
39
|
+
def message
|
40
|
+
@message || @data[:message]
|
41
|
+
end
|
42
|
+
|
43
|
+
end
|
44
|
+
|
45
|
+
class InternalServerException < ServiceError
|
46
|
+
|
47
|
+
# @param [Seahorse::Client::RequestContext] context
|
48
|
+
# @param [String] message
|
49
|
+
# @param [Aws::Kendra::Types::InternalServerException] data
|
50
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
51
|
+
super(context, message, data)
|
52
|
+
end
|
53
|
+
|
54
|
+
# @return [String]
|
55
|
+
def message
|
56
|
+
@message || @data[:message]
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
60
|
+
|
61
|
+
class ResourceAlreadyExistException < ServiceError
|
62
|
+
|
63
|
+
# @param [Seahorse::Client::RequestContext] context
|
64
|
+
# @param [String] message
|
65
|
+
# @param [Aws::Kendra::Types::ResourceAlreadyExistException] data
|
66
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
67
|
+
super(context, message, data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# @return [String]
|
71
|
+
def message
|
72
|
+
@message || @data[:message]
|
73
|
+
end
|
74
|
+
|
75
|
+
end
|
76
|
+
|
77
|
+
class ResourceInUseException < ServiceError
|
78
|
+
|
79
|
+
# @param [Seahorse::Client::RequestContext] context
|
80
|
+
# @param [String] message
|
81
|
+
# @param [Aws::Kendra::Types::ResourceInUseException] data
|
82
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
83
|
+
super(context, message, data)
|
84
|
+
end
|
85
|
+
|
86
|
+
# @return [String]
|
87
|
+
def message
|
88
|
+
@message || @data[:message]
|
89
|
+
end
|
90
|
+
|
91
|
+
end
|
92
|
+
|
93
|
+
class ResourceNotFoundException < ServiceError
|
94
|
+
|
95
|
+
# @param [Seahorse::Client::RequestContext] context
|
96
|
+
# @param [String] message
|
97
|
+
# @param [Aws::Kendra::Types::ResourceNotFoundException] data
|
98
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
99
|
+
super(context, message, data)
|
100
|
+
end
|
101
|
+
|
102
|
+
# @return [String]
|
103
|
+
def message
|
104
|
+
@message || @data[:message]
|
105
|
+
end
|
106
|
+
|
107
|
+
end
|
108
|
+
|
109
|
+
class ResourceUnavailableException < ServiceError
|
110
|
+
|
111
|
+
# @param [Seahorse::Client::RequestContext] context
|
112
|
+
# @param [String] message
|
113
|
+
# @param [Aws::Kendra::Types::ResourceUnavailableException] data
|
114
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
115
|
+
super(context, message, data)
|
116
|
+
end
|
117
|
+
|
118
|
+
# @return [String]
|
119
|
+
def message
|
120
|
+
@message || @data[:message]
|
121
|
+
end
|
122
|
+
|
123
|
+
end
|
124
|
+
|
125
|
+
class ServiceQuotaExceededException < ServiceError
|
126
|
+
|
127
|
+
# @param [Seahorse::Client::RequestContext] context
|
128
|
+
# @param [String] message
|
129
|
+
# @param [Aws::Kendra::Types::ServiceQuotaExceededException] data
|
130
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
131
|
+
super(context, message, data)
|
132
|
+
end
|
133
|
+
|
134
|
+
# @return [String]
|
135
|
+
def message
|
136
|
+
@message || @data[:message]
|
137
|
+
end
|
138
|
+
|
139
|
+
end
|
140
|
+
|
141
|
+
class ThrottlingException < ServiceError
|
142
|
+
|
143
|
+
# @param [Seahorse::Client::RequestContext] context
|
144
|
+
# @param [String] message
|
145
|
+
# @param [Aws::Kendra::Types::ThrottlingException] data
|
146
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
147
|
+
super(context, message, data)
|
148
|
+
end
|
149
|
+
|
150
|
+
# @return [String]
|
151
|
+
def message
|
152
|
+
@message || @data[:message]
|
153
|
+
end
|
154
|
+
|
155
|
+
end
|
156
|
+
|
157
|
+
class ValidationException < ServiceError
|
158
|
+
|
159
|
+
# @param [Seahorse::Client::RequestContext] context
|
160
|
+
# @param [String] message
|
161
|
+
# @param [Aws::Kendra::Types::ValidationException] data
|
162
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
163
|
+
super(context, message, data)
|
164
|
+
end
|
165
|
+
|
166
|
+
# @return [String]
|
167
|
+
def message
|
168
|
+
@message || @data[:message]
|
169
|
+
end
|
170
|
+
|
171
|
+
end
|
172
|
+
|
173
|
+
end
|
174
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::Kendra
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,3340 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::Kendra
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# Access Control List files for the documents in a data source.
|
12
|
+
#
|
13
|
+
# @note When making an API call, you may pass AccessControlListConfiguration
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# key_path: "S3ObjectKey",
|
18
|
+
# }
|
19
|
+
#
|
20
|
+
# @!attribute [rw] key_path
|
21
|
+
# Path to the AWS S3 bucket that contains the ACL files.
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessControlListConfiguration AWS API Documentation
|
25
|
+
#
|
26
|
+
class AccessControlListConfiguration < Struct.new(
|
27
|
+
:key_path)
|
28
|
+
include Aws::Structure
|
29
|
+
end
|
30
|
+
|
31
|
+
# @!attribute [rw] message
|
32
|
+
# @return [String]
|
33
|
+
#
|
34
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessDeniedException AWS API Documentation
|
35
|
+
#
|
36
|
+
class AccessDeniedException < Struct.new(
|
37
|
+
:message)
|
38
|
+
include Aws::Structure
|
39
|
+
end
|
40
|
+
|
41
|
+
# Provides information about the column that should be used for
|
42
|
+
# filtering the query response by groups.
|
43
|
+
#
|
44
|
+
# @note When making an API call, you may pass AclConfiguration
|
45
|
+
# data as a hash:
|
46
|
+
#
|
47
|
+
# {
|
48
|
+
# allowed_groups_column_name: "ColumnName", # required
|
49
|
+
# }
|
50
|
+
#
|
51
|
+
# @!attribute [rw] allowed_groups_column_name
|
52
|
+
# A list of groups, separated by semi-colons, that filters a query
|
53
|
+
# response based on user context. The document is only returned to
|
54
|
+
# users that are in one of the groups specified in the `UserContext`
|
55
|
+
# field of the Query operation.
|
56
|
+
# @return [String]
|
57
|
+
#
|
58
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
|
59
|
+
#
|
60
|
+
class AclConfiguration < Struct.new(
|
61
|
+
:allowed_groups_column_name)
|
62
|
+
include Aws::Structure
|
63
|
+
end
|
64
|
+
|
65
|
+
# @!attribute [rw] key
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] value_type
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] value
|
72
|
+
# @return [Types::AdditionalResultAttributeValue]
|
73
|
+
#
|
74
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AdditionalResultAttribute AWS API Documentation
|
75
|
+
#
|
76
|
+
class AdditionalResultAttribute < Struct.new(
|
77
|
+
:key,
|
78
|
+
:value_type,
|
79
|
+
:value)
|
80
|
+
include Aws::Structure
|
81
|
+
end
|
82
|
+
|
83
|
+
# An attribute returned with a document from a search.
|
84
|
+
#
|
85
|
+
# @!attribute [rw] text_with_highlights_value
|
86
|
+
# The text associated with the attribute and information about the
|
87
|
+
# highlight to apply to the text.
|
88
|
+
# @return [Types::TextWithHighlights]
|
89
|
+
#
|
90
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AdditionalResultAttributeValue AWS API Documentation
|
91
|
+
#
|
92
|
+
class AdditionalResultAttributeValue < Struct.new(
|
93
|
+
:text_with_highlights_value)
|
94
|
+
include Aws::Structure
|
95
|
+
end
|
96
|
+
|
97
|
+
# Provides filtering the query results based on document attributes.
|
98
|
+
#
|
99
|
+
# @note When making an API call, you may pass AttributeFilter
|
100
|
+
# data as a hash:
|
101
|
+
#
|
102
|
+
# {
|
103
|
+
# and_all_filters: [
|
104
|
+
# {
|
105
|
+
# and_all_filters: {
|
106
|
+
# # recursive AttributeFilterList
|
107
|
+
# },
|
108
|
+
# or_all_filters: {
|
109
|
+
# # recursive AttributeFilterList
|
110
|
+
# },
|
111
|
+
# not_filter: {
|
112
|
+
# # recursive AttributeFilter
|
113
|
+
# },
|
114
|
+
# equals_to: {
|
115
|
+
# key: "DocumentAttributeKey", # required
|
116
|
+
# value: { # required
|
117
|
+
# string_value: "DocumentAttributeStringValue",
|
118
|
+
# string_list_value: ["String"],
|
119
|
+
# long_value: 1,
|
120
|
+
# date_value: Time.now,
|
121
|
+
# },
|
122
|
+
# },
|
123
|
+
# contains_all: {
|
124
|
+
# key: "DocumentAttributeKey", # required
|
125
|
+
# value: { # required
|
126
|
+
# string_value: "DocumentAttributeStringValue",
|
127
|
+
# string_list_value: ["String"],
|
128
|
+
# long_value: 1,
|
129
|
+
# date_value: Time.now,
|
130
|
+
# },
|
131
|
+
# },
|
132
|
+
# contains_any: {
|
133
|
+
# key: "DocumentAttributeKey", # required
|
134
|
+
# value: { # required
|
135
|
+
# string_value: "DocumentAttributeStringValue",
|
136
|
+
# string_list_value: ["String"],
|
137
|
+
# long_value: 1,
|
138
|
+
# date_value: Time.now,
|
139
|
+
# },
|
140
|
+
# },
|
141
|
+
# greater_than: {
|
142
|
+
# key: "DocumentAttributeKey", # required
|
143
|
+
# value: { # required
|
144
|
+
# string_value: "DocumentAttributeStringValue",
|
145
|
+
# string_list_value: ["String"],
|
146
|
+
# long_value: 1,
|
147
|
+
# date_value: Time.now,
|
148
|
+
# },
|
149
|
+
# },
|
150
|
+
# greater_than_or_equals: {
|
151
|
+
# key: "DocumentAttributeKey", # required
|
152
|
+
# value: { # required
|
153
|
+
# string_value: "DocumentAttributeStringValue",
|
154
|
+
# string_list_value: ["String"],
|
155
|
+
# long_value: 1,
|
156
|
+
# date_value: Time.now,
|
157
|
+
# },
|
158
|
+
# },
|
159
|
+
# less_than: {
|
160
|
+
# key: "DocumentAttributeKey", # required
|
161
|
+
# value: { # required
|
162
|
+
# string_value: "DocumentAttributeStringValue",
|
163
|
+
# string_list_value: ["String"],
|
164
|
+
# long_value: 1,
|
165
|
+
# date_value: Time.now,
|
166
|
+
# },
|
167
|
+
# },
|
168
|
+
# less_than_or_equals: {
|
169
|
+
# key: "DocumentAttributeKey", # required
|
170
|
+
# value: { # required
|
171
|
+
# string_value: "DocumentAttributeStringValue",
|
172
|
+
# string_list_value: ["String"],
|
173
|
+
# long_value: 1,
|
174
|
+
# date_value: Time.now,
|
175
|
+
# },
|
176
|
+
# },
|
177
|
+
# },
|
178
|
+
# ],
|
179
|
+
# or_all_filters: [
|
180
|
+
# {
|
181
|
+
# and_all_filters: {
|
182
|
+
# # recursive AttributeFilterList
|
183
|
+
# },
|
184
|
+
# or_all_filters: {
|
185
|
+
# # recursive AttributeFilterList
|
186
|
+
# },
|
187
|
+
# not_filter: {
|
188
|
+
# # recursive AttributeFilter
|
189
|
+
# },
|
190
|
+
# equals_to: {
|
191
|
+
# key: "DocumentAttributeKey", # required
|
192
|
+
# value: { # required
|
193
|
+
# string_value: "DocumentAttributeStringValue",
|
194
|
+
# string_list_value: ["String"],
|
195
|
+
# long_value: 1,
|
196
|
+
# date_value: Time.now,
|
197
|
+
# },
|
198
|
+
# },
|
199
|
+
# contains_all: {
|
200
|
+
# key: "DocumentAttributeKey", # required
|
201
|
+
# value: { # required
|
202
|
+
# string_value: "DocumentAttributeStringValue",
|
203
|
+
# string_list_value: ["String"],
|
204
|
+
# long_value: 1,
|
205
|
+
# date_value: Time.now,
|
206
|
+
# },
|
207
|
+
# },
|
208
|
+
# contains_any: {
|
209
|
+
# key: "DocumentAttributeKey", # required
|
210
|
+
# value: { # required
|
211
|
+
# string_value: "DocumentAttributeStringValue",
|
212
|
+
# string_list_value: ["String"],
|
213
|
+
# long_value: 1,
|
214
|
+
# date_value: Time.now,
|
215
|
+
# },
|
216
|
+
# },
|
217
|
+
# greater_than: {
|
218
|
+
# key: "DocumentAttributeKey", # required
|
219
|
+
# value: { # required
|
220
|
+
# string_value: "DocumentAttributeStringValue",
|
221
|
+
# string_list_value: ["String"],
|
222
|
+
# long_value: 1,
|
223
|
+
# date_value: Time.now,
|
224
|
+
# },
|
225
|
+
# },
|
226
|
+
# greater_than_or_equals: {
|
227
|
+
# key: "DocumentAttributeKey", # required
|
228
|
+
# value: { # required
|
229
|
+
# string_value: "DocumentAttributeStringValue",
|
230
|
+
# string_list_value: ["String"],
|
231
|
+
# long_value: 1,
|
232
|
+
# date_value: Time.now,
|
233
|
+
# },
|
234
|
+
# },
|
235
|
+
# less_than: {
|
236
|
+
# key: "DocumentAttributeKey", # required
|
237
|
+
# value: { # required
|
238
|
+
# string_value: "DocumentAttributeStringValue",
|
239
|
+
# string_list_value: ["String"],
|
240
|
+
# long_value: 1,
|
241
|
+
# date_value: Time.now,
|
242
|
+
# },
|
243
|
+
# },
|
244
|
+
# less_than_or_equals: {
|
245
|
+
# key: "DocumentAttributeKey", # required
|
246
|
+
# value: { # required
|
247
|
+
# string_value: "DocumentAttributeStringValue",
|
248
|
+
# string_list_value: ["String"],
|
249
|
+
# long_value: 1,
|
250
|
+
# date_value: Time.now,
|
251
|
+
# },
|
252
|
+
# },
|
253
|
+
# },
|
254
|
+
# ],
|
255
|
+
# not_filter: {
|
256
|
+
# and_all_filters: [
|
257
|
+
# {
|
258
|
+
# # recursive AttributeFilter
|
259
|
+
# },
|
260
|
+
# ],
|
261
|
+
# or_all_filters: [
|
262
|
+
# {
|
263
|
+
# # recursive AttributeFilter
|
264
|
+
# },
|
265
|
+
# ],
|
266
|
+
# not_filter: {
|
267
|
+
# # recursive AttributeFilter
|
268
|
+
# },
|
269
|
+
# equals_to: {
|
270
|
+
# key: "DocumentAttributeKey", # required
|
271
|
+
# value: { # required
|
272
|
+
# string_value: "DocumentAttributeStringValue",
|
273
|
+
# string_list_value: ["String"],
|
274
|
+
# long_value: 1,
|
275
|
+
# date_value: Time.now,
|
276
|
+
# },
|
277
|
+
# },
|
278
|
+
# contains_all: {
|
279
|
+
# key: "DocumentAttributeKey", # required
|
280
|
+
# value: { # required
|
281
|
+
# string_value: "DocumentAttributeStringValue",
|
282
|
+
# string_list_value: ["String"],
|
283
|
+
# long_value: 1,
|
284
|
+
# date_value: Time.now,
|
285
|
+
# },
|
286
|
+
# },
|
287
|
+
# contains_any: {
|
288
|
+
# key: "DocumentAttributeKey", # required
|
289
|
+
# value: { # required
|
290
|
+
# string_value: "DocumentAttributeStringValue",
|
291
|
+
# string_list_value: ["String"],
|
292
|
+
# long_value: 1,
|
293
|
+
# date_value: Time.now,
|
294
|
+
# },
|
295
|
+
# },
|
296
|
+
# greater_than: {
|
297
|
+
# key: "DocumentAttributeKey", # required
|
298
|
+
# value: { # required
|
299
|
+
# string_value: "DocumentAttributeStringValue",
|
300
|
+
# string_list_value: ["String"],
|
301
|
+
# long_value: 1,
|
302
|
+
# date_value: Time.now,
|
303
|
+
# },
|
304
|
+
# },
|
305
|
+
# greater_than_or_equals: {
|
306
|
+
# key: "DocumentAttributeKey", # required
|
307
|
+
# value: { # required
|
308
|
+
# string_value: "DocumentAttributeStringValue",
|
309
|
+
# string_list_value: ["String"],
|
310
|
+
# long_value: 1,
|
311
|
+
# date_value: Time.now,
|
312
|
+
# },
|
313
|
+
# },
|
314
|
+
# less_than: {
|
315
|
+
# key: "DocumentAttributeKey", # required
|
316
|
+
# value: { # required
|
317
|
+
# string_value: "DocumentAttributeStringValue",
|
318
|
+
# string_list_value: ["String"],
|
319
|
+
# long_value: 1,
|
320
|
+
# date_value: Time.now,
|
321
|
+
# },
|
322
|
+
# },
|
323
|
+
# less_than_or_equals: {
|
324
|
+
# key: "DocumentAttributeKey", # required
|
325
|
+
# value: { # required
|
326
|
+
# string_value: "DocumentAttributeStringValue",
|
327
|
+
# string_list_value: ["String"],
|
328
|
+
# long_value: 1,
|
329
|
+
# date_value: Time.now,
|
330
|
+
# },
|
331
|
+
# },
|
332
|
+
# },
|
333
|
+
# equals_to: {
|
334
|
+
# key: "DocumentAttributeKey", # required
|
335
|
+
# value: { # required
|
336
|
+
# string_value: "DocumentAttributeStringValue",
|
337
|
+
# string_list_value: ["String"],
|
338
|
+
# long_value: 1,
|
339
|
+
# date_value: Time.now,
|
340
|
+
# },
|
341
|
+
# },
|
342
|
+
# contains_all: {
|
343
|
+
# key: "DocumentAttributeKey", # required
|
344
|
+
# value: { # required
|
345
|
+
# string_value: "DocumentAttributeStringValue",
|
346
|
+
# string_list_value: ["String"],
|
347
|
+
# long_value: 1,
|
348
|
+
# date_value: Time.now,
|
349
|
+
# },
|
350
|
+
# },
|
351
|
+
# contains_any: {
|
352
|
+
# key: "DocumentAttributeKey", # required
|
353
|
+
# value: { # required
|
354
|
+
# string_value: "DocumentAttributeStringValue",
|
355
|
+
# string_list_value: ["String"],
|
356
|
+
# long_value: 1,
|
357
|
+
# date_value: Time.now,
|
358
|
+
# },
|
359
|
+
# },
|
360
|
+
# greater_than: {
|
361
|
+
# key: "DocumentAttributeKey", # required
|
362
|
+
# value: { # required
|
363
|
+
# string_value: "DocumentAttributeStringValue",
|
364
|
+
# string_list_value: ["String"],
|
365
|
+
# long_value: 1,
|
366
|
+
# date_value: Time.now,
|
367
|
+
# },
|
368
|
+
# },
|
369
|
+
# greater_than_or_equals: {
|
370
|
+
# key: "DocumentAttributeKey", # required
|
371
|
+
# value: { # required
|
372
|
+
# string_value: "DocumentAttributeStringValue",
|
373
|
+
# string_list_value: ["String"],
|
374
|
+
# long_value: 1,
|
375
|
+
# date_value: Time.now,
|
376
|
+
# },
|
377
|
+
# },
|
378
|
+
# less_than: {
|
379
|
+
# key: "DocumentAttributeKey", # required
|
380
|
+
# value: { # required
|
381
|
+
# string_value: "DocumentAttributeStringValue",
|
382
|
+
# string_list_value: ["String"],
|
383
|
+
# long_value: 1,
|
384
|
+
# date_value: Time.now,
|
385
|
+
# },
|
386
|
+
# },
|
387
|
+
# less_than_or_equals: {
|
388
|
+
# key: "DocumentAttributeKey", # required
|
389
|
+
# value: { # required
|
390
|
+
# string_value: "DocumentAttributeStringValue",
|
391
|
+
# string_list_value: ["String"],
|
392
|
+
# long_value: 1,
|
393
|
+
# date_value: Time.now,
|
394
|
+
# },
|
395
|
+
# },
|
396
|
+
# }
|
397
|
+
#
|
398
|
+
# @!attribute [rw] and_all_filters
|
399
|
+
# Performs a logical `AND` operation on all supplied filters.
|
400
|
+
# @return [Array<Types::AttributeFilter>]
|
401
|
+
#
|
402
|
+
# @!attribute [rw] or_all_filters
|
403
|
+
# Performs a logical `OR` operation on all supplied filters.
|
404
|
+
# @return [Array<Types::AttributeFilter>]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] not_filter
|
407
|
+
# Performs a logical `NOT` operation on all supplied filters.
|
408
|
+
# @return [Types::AttributeFilter]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] equals_to
|
411
|
+
# Performs an equals operation on two document attributes.
|
412
|
+
# @return [Types::DocumentAttribute]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] contains_all
|
415
|
+
# Returns true when a document contains all of the specified document
|
416
|
+
# attributes.
|
417
|
+
# @return [Types::DocumentAttribute]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] contains_any
|
420
|
+
# Returns true when a document contains any of the specified document
|
421
|
+
# attributes.
|
422
|
+
# @return [Types::DocumentAttribute]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] greater_than
|
425
|
+
# Performs a greater than operation on two document attributes. Use
|
426
|
+
# with a document attribute of type `Integer` or `Long`.
|
427
|
+
# @return [Types::DocumentAttribute]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] greater_than_or_equals
|
430
|
+
# Performs a greater or equals than operation on two document
|
431
|
+
# attributes. Use with a document attribute of type `Integer` or
|
432
|
+
# `Long`.
|
433
|
+
# @return [Types::DocumentAttribute]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] less_than
|
436
|
+
# Performs a less than operation on two document attributes. Use with
|
437
|
+
# a document attribute of type `Integer` or `Long`.
|
438
|
+
# @return [Types::DocumentAttribute]
|
439
|
+
#
|
440
|
+
# @!attribute [rw] less_than_or_equals
|
441
|
+
# Performs a less than or equals operation on two document attributes.
|
442
|
+
# Use with a document attribute of type `Integer` or `Long`.
|
443
|
+
# @return [Types::DocumentAttribute]
|
444
|
+
#
|
445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeFilter AWS API Documentation
|
446
|
+
#
|
447
|
+
class AttributeFilter < Struct.new(
|
448
|
+
:and_all_filters,
|
449
|
+
:or_all_filters,
|
450
|
+
:not_filter,
|
451
|
+
:equals_to,
|
452
|
+
:contains_all,
|
453
|
+
:contains_any,
|
454
|
+
:greater_than,
|
455
|
+
:greater_than_or_equals,
|
456
|
+
:less_than,
|
457
|
+
:less_than_or_equals)
|
458
|
+
include Aws::Structure
|
459
|
+
end
|
460
|
+
|
461
|
+
# @note When making an API call, you may pass BatchDeleteDocumentRequest
|
462
|
+
# data as a hash:
|
463
|
+
#
|
464
|
+
# {
|
465
|
+
# index_id: "IndexId", # required
|
466
|
+
# document_id_list: ["DocumentId"], # required
|
467
|
+
# }
|
468
|
+
#
|
469
|
+
# @!attribute [rw] index_id
|
470
|
+
# The identifier of the index that contains the documents to delete.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] document_id_list
|
474
|
+
# One or more identifiers for documents to delete from the index.
|
475
|
+
# @return [Array<String>]
|
476
|
+
#
|
477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocumentRequest AWS API Documentation
|
478
|
+
#
|
479
|
+
class BatchDeleteDocumentRequest < Struct.new(
|
480
|
+
:index_id,
|
481
|
+
:document_id_list)
|
482
|
+
include Aws::Structure
|
483
|
+
end
|
484
|
+
|
485
|
+
# @!attribute [rw] failed_documents
|
486
|
+
# A list of documents that could not be removed from the index. Each
|
487
|
+
# entry contains an error message that indicates why the document
|
488
|
+
# couldn't be removed from the index.
|
489
|
+
# @return [Array<Types::BatchDeleteDocumentResponseFailedDocument>]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocumentResponse AWS API Documentation
|
492
|
+
#
|
493
|
+
class BatchDeleteDocumentResponse < Struct.new(
|
494
|
+
:failed_documents)
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
498
|
+
# Provides information about documents that could not be removed from an
|
499
|
+
# index by the BatchDeleteDocument operation.
|
500
|
+
#
|
501
|
+
# @!attribute [rw] id
|
502
|
+
# The identifier of the document that couldn't be removed from the
|
503
|
+
# index.
|
504
|
+
# @return [String]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] error_code
|
507
|
+
# The error code for why the document couldn't be removed from the
|
508
|
+
# index.
|
509
|
+
# @return [String]
|
510
|
+
#
|
511
|
+
# @!attribute [rw] error_message
|
512
|
+
# An explanation for why the document couldn't be removed from the
|
513
|
+
# index.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocumentResponseFailedDocument AWS API Documentation
|
517
|
+
#
|
518
|
+
class BatchDeleteDocumentResponseFailedDocument < Struct.new(
|
519
|
+
:id,
|
520
|
+
:error_code,
|
521
|
+
:error_message)
|
522
|
+
include Aws::Structure
|
523
|
+
end
|
524
|
+
|
525
|
+
# @note When making an API call, you may pass BatchPutDocumentRequest
|
526
|
+
# data as a hash:
|
527
|
+
#
|
528
|
+
# {
|
529
|
+
# index_id: "IndexId", # required
|
530
|
+
# role_arn: "RoleArn",
|
531
|
+
# documents: [ # required
|
532
|
+
# {
|
533
|
+
# id: "DocumentId", # required
|
534
|
+
# title: "Title",
|
535
|
+
# blob: "data",
|
536
|
+
# s3_path: {
|
537
|
+
# bucket: "S3BucketName", # required
|
538
|
+
# key: "S3ObjectKey", # required
|
539
|
+
# },
|
540
|
+
# attributes: [
|
541
|
+
# {
|
542
|
+
# key: "DocumentAttributeKey", # required
|
543
|
+
# value: { # required
|
544
|
+
# string_value: "DocumentAttributeStringValue",
|
545
|
+
# string_list_value: ["String"],
|
546
|
+
# long_value: 1,
|
547
|
+
# date_value: Time.now,
|
548
|
+
# },
|
549
|
+
# },
|
550
|
+
# ],
|
551
|
+
# access_control_list: [
|
552
|
+
# {
|
553
|
+
# name: "PrincipalName", # required
|
554
|
+
# type: "USER", # required, accepts USER, GROUP
|
555
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
556
|
+
# },
|
557
|
+
# ],
|
558
|
+
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
559
|
+
# },
|
560
|
+
# ],
|
561
|
+
# }
|
562
|
+
#
|
563
|
+
# @!attribute [rw] index_id
|
564
|
+
# The identifier of the index to add the documents to. You need to
|
565
|
+
# create the index first using the CreateIndex operation.
|
566
|
+
# @return [String]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] role_arn
|
569
|
+
# The Amazon Resource Name (ARN) of a role that is allowed to run the
|
570
|
+
# `BatchPutDocument` operation. For more information, see [IAM Roles
|
571
|
+
# for Amazon Kendra][1].
|
572
|
+
#
|
573
|
+
#
|
574
|
+
#
|
575
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
# @!attribute [rw] documents
|
579
|
+
# One or more documents to add to the index.
|
580
|
+
#
|
581
|
+
# Each document is limited to 5 Mb, the total size of the list is
|
582
|
+
# limited to 50 Mb.
|
583
|
+
# @return [Array<Types::Document>]
|
584
|
+
#
|
585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentRequest AWS API Documentation
|
586
|
+
#
|
587
|
+
class BatchPutDocumentRequest < Struct.new(
|
588
|
+
:index_id,
|
589
|
+
:role_arn,
|
590
|
+
:documents)
|
591
|
+
include Aws::Structure
|
592
|
+
end
|
593
|
+
|
594
|
+
# @!attribute [rw] failed_documents
|
595
|
+
# A list of documents that were not added to the index because the
|
596
|
+
# document failed a validation check. Each document contains an error
|
597
|
+
# message that indicates why the document couldn't be added to the
|
598
|
+
# index.
|
599
|
+
#
|
600
|
+
# If there was an error adding a document to an index the error is
|
601
|
+
# reported in your AWS CloudWatch log.
|
602
|
+
# @return [Array<Types::BatchPutDocumentResponseFailedDocument>]
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentResponse AWS API Documentation
|
605
|
+
#
|
606
|
+
class BatchPutDocumentResponse < Struct.new(
|
607
|
+
:failed_documents)
|
608
|
+
include Aws::Structure
|
609
|
+
end
|
610
|
+
|
611
|
+
# Provides information about a document that could not be indexed.
|
612
|
+
#
|
613
|
+
# @!attribute [rw] id
|
614
|
+
# The unique identifier of the document.
|
615
|
+
# @return [String]
|
616
|
+
#
|
617
|
+
# @!attribute [rw] error_code
|
618
|
+
# The type of error that caused the document to fail to be indexed.
|
619
|
+
# @return [String]
|
620
|
+
#
|
621
|
+
# @!attribute [rw] error_message
|
622
|
+
# A description of the reason why the document could not be indexed.
|
623
|
+
# @return [String]
|
624
|
+
#
|
625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentResponseFailedDocument AWS API Documentation
|
626
|
+
#
|
627
|
+
class BatchPutDocumentResponseFailedDocument < Struct.new(
|
628
|
+
:id,
|
629
|
+
:error_code,
|
630
|
+
:error_message)
|
631
|
+
include Aws::Structure
|
632
|
+
end
|
633
|
+
|
634
|
+
# Gathers information about when a particular result was clicked by a
|
635
|
+
# user. Your application uses the SubmitFeedback operation to provide
|
636
|
+
# click information.
|
637
|
+
#
|
638
|
+
# @note When making an API call, you may pass ClickFeedback
|
639
|
+
# data as a hash:
|
640
|
+
#
|
641
|
+
# {
|
642
|
+
# result_id: "ResultId", # required
|
643
|
+
# click_time: Time.now, # required
|
644
|
+
# }
|
645
|
+
#
|
646
|
+
# @!attribute [rw] result_id
|
647
|
+
# The unique identifier of the search result that was clicked.
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] click_time
|
651
|
+
# The Unix timestamp of the data and time that the result was clicked.
|
652
|
+
# @return [Time]
|
653
|
+
#
|
654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClickFeedback AWS API Documentation
|
655
|
+
#
|
656
|
+
class ClickFeedback < Struct.new(
|
657
|
+
:result_id,
|
658
|
+
:click_time)
|
659
|
+
include Aws::Structure
|
660
|
+
end
|
661
|
+
|
662
|
+
# Provides information about how Amazon Kendra should use the columns of
|
663
|
+
# a database in an index.
|
664
|
+
#
|
665
|
+
# @note When making an API call, you may pass ColumnConfiguration
|
666
|
+
# data as a hash:
|
667
|
+
#
|
668
|
+
# {
|
669
|
+
# document_id_column_name: "ColumnName", # required
|
670
|
+
# document_data_column_name: "ColumnName", # required
|
671
|
+
# document_title_column_name: "ColumnName",
|
672
|
+
# field_mappings: [
|
673
|
+
# {
|
674
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
675
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
676
|
+
# index_field_name: "IndexFieldName", # required
|
677
|
+
# },
|
678
|
+
# ],
|
679
|
+
# change_detecting_columns: ["ColumnName"], # required
|
680
|
+
# }
|
681
|
+
#
|
682
|
+
# @!attribute [rw] document_id_column_name
|
683
|
+
# The column that provides the document's unique identifier.
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @!attribute [rw] document_data_column_name
|
687
|
+
# The column that contains the contents of the document.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] document_title_column_name
|
691
|
+
# The column that contains the title of the document.
|
692
|
+
# @return [String]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] field_mappings
|
695
|
+
# An array of objects that map database column names to the
|
696
|
+
# corresponding fields in an index. You must first create the fields
|
697
|
+
# in the index using the UpdateIndex operation.
|
698
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] change_detecting_columns
|
701
|
+
# One to five columns that indicate when a document in the database
|
702
|
+
# has changed.
|
703
|
+
# @return [Array<String>]
|
704
|
+
#
|
705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ColumnConfiguration AWS API Documentation
|
706
|
+
#
|
707
|
+
class ColumnConfiguration < Struct.new(
|
708
|
+
:document_id_column_name,
|
709
|
+
:document_data_column_name,
|
710
|
+
:document_title_column_name,
|
711
|
+
:field_mappings,
|
712
|
+
:change_detecting_columns)
|
713
|
+
include Aws::Structure
|
714
|
+
end
|
715
|
+
|
716
|
+
# @!attribute [rw] message
|
717
|
+
# @return [String]
|
718
|
+
#
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConflictException AWS API Documentation
|
720
|
+
#
|
721
|
+
class ConflictException < Struct.new(
|
722
|
+
:message)
|
723
|
+
include Aws::Structure
|
724
|
+
end
|
725
|
+
|
726
|
+
# Provides the information necessary to connect to a database.
|
727
|
+
#
|
728
|
+
# @note When making an API call, you may pass ConnectionConfiguration
|
729
|
+
# data as a hash:
|
730
|
+
#
|
731
|
+
# {
|
732
|
+
# database_host: "DatabaseHost", # required
|
733
|
+
# database_port: 1, # required
|
734
|
+
# database_name: "DatabaseName", # required
|
735
|
+
# table_name: "TableName", # required
|
736
|
+
# secret_arn: "SecretArn", # required
|
737
|
+
# }
|
738
|
+
#
|
739
|
+
# @!attribute [rw] database_host
|
740
|
+
# The name of the host for the database. Can be either a string
|
741
|
+
# (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
|
742
|
+
# @return [String]
|
743
|
+
#
|
744
|
+
# @!attribute [rw] database_port
|
745
|
+
# The port that the database uses for connections.
|
746
|
+
# @return [Integer]
|
747
|
+
#
|
748
|
+
# @!attribute [rw] database_name
|
749
|
+
# The name of the database containing the document data.
|
750
|
+
# @return [String]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] table_name
|
753
|
+
# The name of the table that contains the document data.
|
754
|
+
# @return [String]
|
755
|
+
#
|
756
|
+
# @!attribute [rw] secret_arn
|
757
|
+
# The Amazon Resource Name (ARN) of credentials stored in AWS Secrets
|
758
|
+
# Manager. The credentials should be a user/password pair. For more
|
759
|
+
# information, see [Using a Database Data Source][1]. For more
|
760
|
+
# information about AWS Secrets Manager, see [ What Is AWS Secrets
|
761
|
+
# Manager ][2] in the *AWS Secrets Manager* user guide.
|
762
|
+
#
|
763
|
+
#
|
764
|
+
#
|
765
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html
|
766
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConnectionConfiguration AWS API Documentation
|
770
|
+
#
|
771
|
+
class ConnectionConfiguration < Struct.new(
|
772
|
+
:database_host,
|
773
|
+
:database_port,
|
774
|
+
:database_name,
|
775
|
+
:table_name,
|
776
|
+
:secret_arn)
|
777
|
+
include Aws::Structure
|
778
|
+
end
|
779
|
+
|
780
|
+
# @note When making an API call, you may pass CreateDataSourceRequest
|
781
|
+
# data as a hash:
|
782
|
+
#
|
783
|
+
# {
|
784
|
+
# name: "DataSourceName", # required
|
785
|
+
# index_id: "IndexId", # required
|
786
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE
|
787
|
+
# configuration: { # required
|
788
|
+
# s3_configuration: {
|
789
|
+
# bucket_name: "S3BucketName", # required
|
790
|
+
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
791
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
792
|
+
# documents_metadata_configuration: {
|
793
|
+
# s3_prefix: "S3ObjectKey",
|
794
|
+
# },
|
795
|
+
# access_control_list_configuration: {
|
796
|
+
# key_path: "S3ObjectKey",
|
797
|
+
# },
|
798
|
+
# },
|
799
|
+
# share_point_configuration: {
|
800
|
+
# share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
|
801
|
+
# urls: ["Url"], # required
|
802
|
+
# secret_arn: "SecretArn", # required
|
803
|
+
# crawl_attachments: false,
|
804
|
+
# vpc_configuration: {
|
805
|
+
# subnet_ids: ["SubnetId"], # required
|
806
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
807
|
+
# },
|
808
|
+
# field_mappings: [
|
809
|
+
# {
|
810
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
811
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
812
|
+
# index_field_name: "IndexFieldName", # required
|
813
|
+
# },
|
814
|
+
# ],
|
815
|
+
# },
|
816
|
+
# database_configuration: {
|
817
|
+
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
818
|
+
# connection_configuration: { # required
|
819
|
+
# database_host: "DatabaseHost", # required
|
820
|
+
# database_port: 1, # required
|
821
|
+
# database_name: "DatabaseName", # required
|
822
|
+
# table_name: "TableName", # required
|
823
|
+
# secret_arn: "SecretArn", # required
|
824
|
+
# },
|
825
|
+
# vpc_configuration: {
|
826
|
+
# subnet_ids: ["SubnetId"], # required
|
827
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
828
|
+
# },
|
829
|
+
# column_configuration: { # required
|
830
|
+
# document_id_column_name: "ColumnName", # required
|
831
|
+
# document_data_column_name: "ColumnName", # required
|
832
|
+
# document_title_column_name: "ColumnName",
|
833
|
+
# field_mappings: [
|
834
|
+
# {
|
835
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
836
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
837
|
+
# index_field_name: "IndexFieldName", # required
|
838
|
+
# },
|
839
|
+
# ],
|
840
|
+
# change_detecting_columns: ["ColumnName"], # required
|
841
|
+
# },
|
842
|
+
# acl_configuration: {
|
843
|
+
# allowed_groups_column_name: "ColumnName", # required
|
844
|
+
# },
|
845
|
+
# },
|
846
|
+
# },
|
847
|
+
# description: "Description",
|
848
|
+
# schedule: "ScanSchedule",
|
849
|
+
# role_arn: "RoleArn", # required
|
850
|
+
# }
|
851
|
+
#
|
852
|
+
# @!attribute [rw] name
|
853
|
+
# A unique name for the data source. A data source name can't be
|
854
|
+
# changed without deleting and recreating the data source.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @!attribute [rw] index_id
|
858
|
+
# The identifier of the index that should be associated with this data
|
859
|
+
# source.
|
860
|
+
# @return [String]
|
861
|
+
#
|
862
|
+
# @!attribute [rw] type
|
863
|
+
# The type of repository that contains the data source.
|
864
|
+
# @return [String]
|
865
|
+
#
|
866
|
+
# @!attribute [rw] configuration
|
867
|
+
# The connector configuration information that is required to access
|
868
|
+
# the repository.
|
869
|
+
# @return [Types::DataSourceConfiguration]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] description
|
872
|
+
# A description for the data source.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] schedule
|
876
|
+
# Sets the frequency that Amazon Kendra will check the documents in
|
877
|
+
# your repository and update the index. If you don't set a schedule
|
878
|
+
# Amazon Kendra will not periodically update the index. You can call
|
879
|
+
# the `StartDataSourceSyncJob` operation to update the index.
|
880
|
+
# @return [String]
|
881
|
+
#
|
882
|
+
# @!attribute [rw] role_arn
|
883
|
+
# The Amazon Resource Name (ARN) of a role with permission to access
|
884
|
+
# the data source. For more information, see [IAM Roles for Amazon
|
885
|
+
# Kendra][1].
|
886
|
+
#
|
887
|
+
#
|
888
|
+
#
|
889
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceRequest AWS API Documentation
|
893
|
+
#
|
894
|
+
class CreateDataSourceRequest < Struct.new(
|
895
|
+
:name,
|
896
|
+
:index_id,
|
897
|
+
:type,
|
898
|
+
:configuration,
|
899
|
+
:description,
|
900
|
+
:schedule,
|
901
|
+
:role_arn)
|
902
|
+
include Aws::Structure
|
903
|
+
end
|
904
|
+
|
905
|
+
# @!attribute [rw] id
|
906
|
+
# A unique identifier for the data source.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceResponse AWS API Documentation
|
910
|
+
#
|
911
|
+
class CreateDataSourceResponse < Struct.new(
|
912
|
+
:id)
|
913
|
+
include Aws::Structure
|
914
|
+
end
|
915
|
+
|
916
|
+
# @note When making an API call, you may pass CreateFaqRequest
|
917
|
+
# data as a hash:
|
918
|
+
#
|
919
|
+
# {
|
920
|
+
# index_id: "IndexId", # required
|
921
|
+
# name: "FaqName", # required
|
922
|
+
# description: "Description",
|
923
|
+
# s3_path: { # required
|
924
|
+
# bucket: "S3BucketName", # required
|
925
|
+
# key: "S3ObjectKey", # required
|
926
|
+
# },
|
927
|
+
# role_arn: "RoleArn", # required
|
928
|
+
# }
|
929
|
+
#
|
930
|
+
# @!attribute [rw] index_id
|
931
|
+
# The identifier of the index that contains the FAQ.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] name
|
935
|
+
# The name that should be associated with the FAQ.
|
936
|
+
# @return [String]
|
937
|
+
#
|
938
|
+
# @!attribute [rw] description
|
939
|
+
# A description of the FAQ.
|
940
|
+
# @return [String]
|
941
|
+
#
|
942
|
+
# @!attribute [rw] s3_path
|
943
|
+
# The S3 location of the FAQ input data.
|
944
|
+
# @return [Types::S3Path]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] role_arn
|
947
|
+
# The Amazon Resource Name (ARN) of a role with permission to access
|
948
|
+
# the S3 bucket that contains the FAQs. For more information, see [IAM
|
949
|
+
# Roles for Amazon Kendra][1].
|
950
|
+
#
|
951
|
+
#
|
952
|
+
#
|
953
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
954
|
+
# @return [String]
|
955
|
+
#
|
956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
|
957
|
+
#
|
958
|
+
class CreateFaqRequest < Struct.new(
|
959
|
+
:index_id,
|
960
|
+
:name,
|
961
|
+
:description,
|
962
|
+
:s3_path,
|
963
|
+
:role_arn)
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
967
|
+
# @!attribute [rw] id
|
968
|
+
# The unique identifier of the FAQ.
|
969
|
+
# @return [String]
|
970
|
+
#
|
971
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqResponse AWS API Documentation
|
972
|
+
#
|
973
|
+
class CreateFaqResponse < Struct.new(
|
974
|
+
:id)
|
975
|
+
include Aws::Structure
|
976
|
+
end
|
977
|
+
|
978
|
+
# @note When making an API call, you may pass CreateIndexRequest
|
979
|
+
# data as a hash:
|
980
|
+
#
|
981
|
+
# {
|
982
|
+
# name: "IndexName", # required
|
983
|
+
# role_arn: "RoleArn", # required
|
984
|
+
# server_side_encryption_configuration: {
|
985
|
+
# kms_key_id: "KmsKeyId",
|
986
|
+
# },
|
987
|
+
# description: "Description",
|
988
|
+
# }
|
989
|
+
#
|
990
|
+
# @!attribute [rw] name
|
991
|
+
# The name for the new index.
|
992
|
+
# @return [String]
|
993
|
+
#
|
994
|
+
# @!attribute [rw] role_arn
|
995
|
+
# An IAM role that gives Amazon Kendra permissions to access your
|
996
|
+
# Amazon CloudWatch logs and metrics. This is also the role used when
|
997
|
+
# you use the `BatchPutDocument` operation to index documents from an
|
998
|
+
# Amazon S3 bucket.
|
999
|
+
# @return [String]
|
1000
|
+
#
|
1001
|
+
# @!attribute [rw] server_side_encryption_configuration
|
1002
|
+
# The identifier of the KMS key to use to encrypt data indexed by
|
1003
|
+
# Amazon Kendra.
|
1004
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
1005
|
+
#
|
1006
|
+
# @!attribute [rw] description
|
1007
|
+
# A description for the index.
|
1008
|
+
# @return [String]
|
1009
|
+
#
|
1010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
|
1011
|
+
#
|
1012
|
+
class CreateIndexRequest < Struct.new(
|
1013
|
+
:name,
|
1014
|
+
:role_arn,
|
1015
|
+
:server_side_encryption_configuration,
|
1016
|
+
:description)
|
1017
|
+
include Aws::Structure
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
# @!attribute [rw] id
|
1021
|
+
# The unique identifier of the index. Use this identifier when you
|
1022
|
+
# query an index, set up a data source, or index a document.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexResponse AWS API Documentation
|
1026
|
+
#
|
1027
|
+
class CreateIndexResponse < Struct.new(
|
1028
|
+
:id)
|
1029
|
+
include Aws::Structure
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# Configuration information for a Amazon Kendra data source.
|
1033
|
+
#
|
1034
|
+
# @note When making an API call, you may pass DataSourceConfiguration
|
1035
|
+
# data as a hash:
|
1036
|
+
#
|
1037
|
+
# {
|
1038
|
+
# s3_configuration: {
|
1039
|
+
# bucket_name: "S3BucketName", # required
|
1040
|
+
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
1041
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1042
|
+
# documents_metadata_configuration: {
|
1043
|
+
# s3_prefix: "S3ObjectKey",
|
1044
|
+
# },
|
1045
|
+
# access_control_list_configuration: {
|
1046
|
+
# key_path: "S3ObjectKey",
|
1047
|
+
# },
|
1048
|
+
# },
|
1049
|
+
# share_point_configuration: {
|
1050
|
+
# share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
|
1051
|
+
# urls: ["Url"], # required
|
1052
|
+
# secret_arn: "SecretArn", # required
|
1053
|
+
# crawl_attachments: false,
|
1054
|
+
# vpc_configuration: {
|
1055
|
+
# subnet_ids: ["SubnetId"], # required
|
1056
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1057
|
+
# },
|
1058
|
+
# field_mappings: [
|
1059
|
+
# {
|
1060
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1061
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1062
|
+
# index_field_name: "IndexFieldName", # required
|
1063
|
+
# },
|
1064
|
+
# ],
|
1065
|
+
# },
|
1066
|
+
# database_configuration: {
|
1067
|
+
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
1068
|
+
# connection_configuration: { # required
|
1069
|
+
# database_host: "DatabaseHost", # required
|
1070
|
+
# database_port: 1, # required
|
1071
|
+
# database_name: "DatabaseName", # required
|
1072
|
+
# table_name: "TableName", # required
|
1073
|
+
# secret_arn: "SecretArn", # required
|
1074
|
+
# },
|
1075
|
+
# vpc_configuration: {
|
1076
|
+
# subnet_ids: ["SubnetId"], # required
|
1077
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1078
|
+
# },
|
1079
|
+
# column_configuration: { # required
|
1080
|
+
# document_id_column_name: "ColumnName", # required
|
1081
|
+
# document_data_column_name: "ColumnName", # required
|
1082
|
+
# document_title_column_name: "ColumnName",
|
1083
|
+
# field_mappings: [
|
1084
|
+
# {
|
1085
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1086
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1087
|
+
# index_field_name: "IndexFieldName", # required
|
1088
|
+
# },
|
1089
|
+
# ],
|
1090
|
+
# change_detecting_columns: ["ColumnName"], # required
|
1091
|
+
# },
|
1092
|
+
# acl_configuration: {
|
1093
|
+
# allowed_groups_column_name: "ColumnName", # required
|
1094
|
+
# },
|
1095
|
+
# },
|
1096
|
+
# }
|
1097
|
+
#
|
1098
|
+
# @!attribute [rw] s3_configuration
|
1099
|
+
# Provides information to create a connector for a document repository
|
1100
|
+
# in an Amazon S3 bucket.
|
1101
|
+
# @return [Types::S3DataSourceConfiguration]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] share_point_configuration
|
1104
|
+
# Provides information necessary to create a connector for a Microsoft
|
1105
|
+
# SharePoint site.
|
1106
|
+
# @return [Types::SharePointConfiguration]
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] database_configuration
|
1109
|
+
# Provides information necessary to create a connector for a database.
|
1110
|
+
# @return [Types::DatabaseConfiguration]
|
1111
|
+
#
|
1112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
1113
|
+
#
|
1114
|
+
class DataSourceConfiguration < Struct.new(
|
1115
|
+
:s3_configuration,
|
1116
|
+
:share_point_configuration,
|
1117
|
+
:database_configuration)
|
1118
|
+
include Aws::Structure
|
1119
|
+
end
|
1120
|
+
|
1121
|
+
# Summary information for a Amazon Kendra data source. Returned in a
|
1122
|
+
# call to .
|
1123
|
+
#
|
1124
|
+
# @!attribute [rw] name
|
1125
|
+
# The name of the data source.
|
1126
|
+
# @return [String]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] id
|
1129
|
+
# The unique identifier for the data source.
|
1130
|
+
# @return [String]
|
1131
|
+
#
|
1132
|
+
# @!attribute [rw] type
|
1133
|
+
# The type of the data source.
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] created_at
|
1137
|
+
# The UNIX datetime that the data source was created.
|
1138
|
+
# @return [Time]
|
1139
|
+
#
|
1140
|
+
# @!attribute [rw] updated_at
|
1141
|
+
# The UNIX datetime that the data source was lasted updated.
|
1142
|
+
# @return [Time]
|
1143
|
+
#
|
1144
|
+
# @!attribute [rw] status
|
1145
|
+
# The status of the data source. When the status is `ATIVE` the data
|
1146
|
+
# source is ready to use.
|
1147
|
+
# @return [String]
|
1148
|
+
#
|
1149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSummary AWS API Documentation
|
1150
|
+
#
|
1151
|
+
class DataSourceSummary < Struct.new(
|
1152
|
+
:name,
|
1153
|
+
:id,
|
1154
|
+
:type,
|
1155
|
+
:created_at,
|
1156
|
+
:updated_at,
|
1157
|
+
:status)
|
1158
|
+
include Aws::Structure
|
1159
|
+
end
|
1160
|
+
|
1161
|
+
# Provides information about a synchronization job.
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] execution_id
|
1164
|
+
# A unique identifier for the synchronization job.
|
1165
|
+
# @return [String]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] start_time
|
1168
|
+
# The UNIX datetime that the synchronization job was started.
|
1169
|
+
# @return [Time]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] end_time
|
1172
|
+
# The UNIX datetime that the synchronization job was completed.
|
1173
|
+
# @return [Time]
|
1174
|
+
#
|
1175
|
+
# @!attribute [rw] status
|
1176
|
+
# The execution status of the synchronization job. When the `Status`
|
1177
|
+
# field is set to `SUCCEEDED`, the synchronization job is done. If the
|
1178
|
+
# status code is set to `FAILED`, the `ErrorCode` and `ErrorMessage`
|
1179
|
+
# fields give you the reason for the failure.
|
1180
|
+
# @return [String]
|
1181
|
+
#
|
1182
|
+
# @!attribute [rw] error_message
|
1183
|
+
# If the `Status` field is set to `ERROR`, the `ErrorMessage` field
|
1184
|
+
# contains a description of the error that caused the synchronization
|
1185
|
+
# to fail.
|
1186
|
+
# @return [String]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] error_code
|
1189
|
+
# If the `Status` field is set to `FAILED`, the `ErrorCode` field
|
1190
|
+
# contains a the reason that the synchronization failed.
|
1191
|
+
# @return [String]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] data_source_error_code
|
1194
|
+
# If the reason that the synchronization failed is due to an error
|
1195
|
+
# with the underlying data source, this field contains a code that
|
1196
|
+
# identifies the error.
|
1197
|
+
# @return [String]
|
1198
|
+
#
|
1199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJob AWS API Documentation
|
1200
|
+
#
|
1201
|
+
class DataSourceSyncJob < Struct.new(
|
1202
|
+
:execution_id,
|
1203
|
+
:start_time,
|
1204
|
+
:end_time,
|
1205
|
+
:status,
|
1206
|
+
:error_message,
|
1207
|
+
:error_code,
|
1208
|
+
:data_source_error_code)
|
1209
|
+
include Aws::Structure
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
# Maps a column or attribute in the data source to an index field. You
|
1213
|
+
# must first create the fields in the index using the UpdateIndex
|
1214
|
+
# operation.
|
1215
|
+
#
|
1216
|
+
# @note When making an API call, you may pass DataSourceToIndexFieldMapping
|
1217
|
+
# data as a hash:
|
1218
|
+
#
|
1219
|
+
# {
|
1220
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1221
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1222
|
+
# index_field_name: "IndexFieldName", # required
|
1223
|
+
# }
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] data_source_field_name
|
1226
|
+
# The name of the column or attribute in the data source.
|
1227
|
+
# @return [String]
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] date_field_format
|
1230
|
+
# The type of data stored in the column or attribute.
|
1231
|
+
# @return [String]
|
1232
|
+
#
|
1233
|
+
# @!attribute [rw] index_field_name
|
1234
|
+
# The name of the field in the index.
|
1235
|
+
# @return [String]
|
1236
|
+
#
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceToIndexFieldMapping AWS API Documentation
|
1238
|
+
#
|
1239
|
+
class DataSourceToIndexFieldMapping < Struct.new(
|
1240
|
+
:data_source_field_name,
|
1241
|
+
:date_field_format,
|
1242
|
+
:index_field_name)
|
1243
|
+
include Aws::Structure
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
# Provides information for connecting to an Amazon VPC.
|
1247
|
+
#
|
1248
|
+
# @note When making an API call, you may pass DataSourceVpcConfiguration
|
1249
|
+
# data as a hash:
|
1250
|
+
#
|
1251
|
+
# {
|
1252
|
+
# subnet_ids: ["SubnetId"], # required
|
1253
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1254
|
+
# }
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] subnet_ids
|
1257
|
+
# A list of identifiers for subnets within your Amazon VPC. The
|
1258
|
+
# subnets should be able to connect to each other in the VPC, and they
|
1259
|
+
# should have outgoing access to the Internet through a NAT device.
|
1260
|
+
# @return [Array<String>]
|
1261
|
+
#
|
1262
|
+
# @!attribute [rw] security_group_ids
|
1263
|
+
# A list of identifiers of security groups within your Amazon VPC. The
|
1264
|
+
# security groups should enable Amazon Kendra to connect to the data
|
1265
|
+
# source.
|
1266
|
+
# @return [Array<String>]
|
1267
|
+
#
|
1268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceVpcConfiguration AWS API Documentation
|
1269
|
+
#
|
1270
|
+
class DataSourceVpcConfiguration < Struct.new(
|
1271
|
+
:subnet_ids,
|
1272
|
+
:security_group_ids)
|
1273
|
+
include Aws::Structure
|
1274
|
+
end
|
1275
|
+
|
1276
|
+
# Provides the information necessary to connect a database to an index.
|
1277
|
+
#
|
1278
|
+
# @note When making an API call, you may pass DatabaseConfiguration
|
1279
|
+
# data as a hash:
|
1280
|
+
#
|
1281
|
+
# {
|
1282
|
+
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
1283
|
+
# connection_configuration: { # required
|
1284
|
+
# database_host: "DatabaseHost", # required
|
1285
|
+
# database_port: 1, # required
|
1286
|
+
# database_name: "DatabaseName", # required
|
1287
|
+
# table_name: "TableName", # required
|
1288
|
+
# secret_arn: "SecretArn", # required
|
1289
|
+
# },
|
1290
|
+
# vpc_configuration: {
|
1291
|
+
# subnet_ids: ["SubnetId"], # required
|
1292
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1293
|
+
# },
|
1294
|
+
# column_configuration: { # required
|
1295
|
+
# document_id_column_name: "ColumnName", # required
|
1296
|
+
# document_data_column_name: "ColumnName", # required
|
1297
|
+
# document_title_column_name: "ColumnName",
|
1298
|
+
# field_mappings: [
|
1299
|
+
# {
|
1300
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1301
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1302
|
+
# index_field_name: "IndexFieldName", # required
|
1303
|
+
# },
|
1304
|
+
# ],
|
1305
|
+
# change_detecting_columns: ["ColumnName"], # required
|
1306
|
+
# },
|
1307
|
+
# acl_configuration: {
|
1308
|
+
# allowed_groups_column_name: "ColumnName", # required
|
1309
|
+
# },
|
1310
|
+
# }
|
1311
|
+
#
|
1312
|
+
# @!attribute [rw] database_engine_type
|
1313
|
+
# The type of database engine that runs the database.
|
1314
|
+
# @return [String]
|
1315
|
+
#
|
1316
|
+
# @!attribute [rw] connection_configuration
|
1317
|
+
# The information necessary to connect to a database.
|
1318
|
+
# @return [Types::ConnectionConfiguration]
|
1319
|
+
#
|
1320
|
+
# @!attribute [rw] vpc_configuration
|
1321
|
+
# Provides information for connecting to an Amazon VPC.
|
1322
|
+
# @return [Types::DataSourceVpcConfiguration]
|
1323
|
+
#
|
1324
|
+
# @!attribute [rw] column_configuration
|
1325
|
+
# Information about where the index should get the document
|
1326
|
+
# information from the database.
|
1327
|
+
# @return [Types::ColumnConfiguration]
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] acl_configuration
|
1330
|
+
# Information about the database column that provides information for
|
1331
|
+
# user context filtering.
|
1332
|
+
# @return [Types::AclConfiguration]
|
1333
|
+
#
|
1334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DatabaseConfiguration AWS API Documentation
|
1335
|
+
#
|
1336
|
+
class DatabaseConfiguration < Struct.new(
|
1337
|
+
:database_engine_type,
|
1338
|
+
:connection_configuration,
|
1339
|
+
:vpc_configuration,
|
1340
|
+
:column_configuration,
|
1341
|
+
:acl_configuration)
|
1342
|
+
include Aws::Structure
|
1343
|
+
end
|
1344
|
+
|
1345
|
+
# @note When making an API call, you may pass DeleteFaqRequest
|
1346
|
+
# data as a hash:
|
1347
|
+
#
|
1348
|
+
# {
|
1349
|
+
# id: "FaqId", # required
|
1350
|
+
# index_id: "IndexId", # required
|
1351
|
+
# }
|
1352
|
+
#
|
1353
|
+
# @!attribute [rw] id
|
1354
|
+
# The identifier of the FAQ to remove.
|
1355
|
+
# @return [String]
|
1356
|
+
#
|
1357
|
+
# @!attribute [rw] index_id
|
1358
|
+
# The index to remove the FAQ from.
|
1359
|
+
# @return [String]
|
1360
|
+
#
|
1361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaqRequest AWS API Documentation
|
1362
|
+
#
|
1363
|
+
class DeleteFaqRequest < Struct.new(
|
1364
|
+
:id,
|
1365
|
+
:index_id)
|
1366
|
+
include Aws::Structure
|
1367
|
+
end
|
1368
|
+
|
1369
|
+
# @note When making an API call, you may pass DeleteIndexRequest
|
1370
|
+
# data as a hash:
|
1371
|
+
#
|
1372
|
+
# {
|
1373
|
+
# id: "IndexId", # required
|
1374
|
+
# }
|
1375
|
+
#
|
1376
|
+
# @!attribute [rw] id
|
1377
|
+
# The identifier of the index to delete.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndexRequest AWS API Documentation
|
1381
|
+
#
|
1382
|
+
class DeleteIndexRequest < Struct.new(
|
1383
|
+
:id)
|
1384
|
+
include Aws::Structure
|
1385
|
+
end
|
1386
|
+
|
1387
|
+
# @note When making an API call, you may pass DescribeDataSourceRequest
|
1388
|
+
# data as a hash:
|
1389
|
+
#
|
1390
|
+
# {
|
1391
|
+
# id: "DataSourceId", # required
|
1392
|
+
# index_id: "IndexId", # required
|
1393
|
+
# }
|
1394
|
+
#
|
1395
|
+
# @!attribute [rw] id
|
1396
|
+
# The unique identifier of the data source to describe.
|
1397
|
+
# @return [String]
|
1398
|
+
#
|
1399
|
+
# @!attribute [rw] index_id
|
1400
|
+
# The identifier of the index that contains the data source.
|
1401
|
+
# @return [String]
|
1402
|
+
#
|
1403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceRequest AWS API Documentation
|
1404
|
+
#
|
1405
|
+
class DescribeDataSourceRequest < Struct.new(
|
1406
|
+
:id,
|
1407
|
+
:index_id)
|
1408
|
+
include Aws::Structure
|
1409
|
+
end
|
1410
|
+
|
1411
|
+
# @!attribute [rw] id
|
1412
|
+
# The identifier of the data source.
|
1413
|
+
# @return [String]
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] index_id
|
1416
|
+
# The identifier of the index that contains the data source.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] name
|
1420
|
+
# The name that you gave the data source when it was created.
|
1421
|
+
# @return [String]
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] type
|
1424
|
+
# The type of the data source.
|
1425
|
+
# @return [String]
|
1426
|
+
#
|
1427
|
+
# @!attribute [rw] configuration
|
1428
|
+
# Information that describes where the data source is located and how
|
1429
|
+
# the data source is configured. The specific information in the
|
1430
|
+
# description depends on the data source provider.
|
1431
|
+
# @return [Types::DataSourceConfiguration]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] created_at
|
1434
|
+
# The Unix timestamp of when the data source was created.
|
1435
|
+
# @return [Time]
|
1436
|
+
#
|
1437
|
+
# @!attribute [rw] updated_at
|
1438
|
+
# The Unix timestamp of when the data source was last updated.
|
1439
|
+
# @return [Time]
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] description
|
1442
|
+
# The description of the data source.
|
1443
|
+
# @return [String]
|
1444
|
+
#
|
1445
|
+
# @!attribute [rw] status
|
1446
|
+
# The current status of the data source. When the status is `ACTIVE`
|
1447
|
+
# the data source is ready to use. When the status is `FAILED`, the
|
1448
|
+
# `ErrorMessage` field contains the reason that the data source
|
1449
|
+
# failed.
|
1450
|
+
# @return [String]
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] schedule
|
1453
|
+
# The schedule that Amazon Kendra will update the data source.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] role_arn
|
1457
|
+
# The Amazon Resource Name (ARN) of the role that enables the data
|
1458
|
+
# source to access its resources.
|
1459
|
+
# @return [String]
|
1460
|
+
#
|
1461
|
+
# @!attribute [rw] error_message
|
1462
|
+
# When the `Status` field value is `FAILED`, the `ErrorMessage` field
|
1463
|
+
# contains a description of the error that caused the data source to
|
1464
|
+
# fail.
|
1465
|
+
# @return [String]
|
1466
|
+
#
|
1467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceResponse AWS API Documentation
|
1468
|
+
#
|
1469
|
+
class DescribeDataSourceResponse < Struct.new(
|
1470
|
+
:id,
|
1471
|
+
:index_id,
|
1472
|
+
:name,
|
1473
|
+
:type,
|
1474
|
+
:configuration,
|
1475
|
+
:created_at,
|
1476
|
+
:updated_at,
|
1477
|
+
:description,
|
1478
|
+
:status,
|
1479
|
+
:schedule,
|
1480
|
+
:role_arn,
|
1481
|
+
:error_message)
|
1482
|
+
include Aws::Structure
|
1483
|
+
end
|
1484
|
+
|
1485
|
+
# @note When making an API call, you may pass DescribeFaqRequest
|
1486
|
+
# data as a hash:
|
1487
|
+
#
|
1488
|
+
# {
|
1489
|
+
# id: "FaqId", # required
|
1490
|
+
# index_id: "IndexId", # required
|
1491
|
+
# }
|
1492
|
+
#
|
1493
|
+
# @!attribute [rw] id
|
1494
|
+
# The unique identifier of the FAQ.
|
1495
|
+
# @return [String]
|
1496
|
+
#
|
1497
|
+
# @!attribute [rw] index_id
|
1498
|
+
# The identifier of the index that contains the FAQ.
|
1499
|
+
# @return [String]
|
1500
|
+
#
|
1501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqRequest AWS API Documentation
|
1502
|
+
#
|
1503
|
+
class DescribeFaqRequest < Struct.new(
|
1504
|
+
:id,
|
1505
|
+
:index_id)
|
1506
|
+
include Aws::Structure
|
1507
|
+
end
|
1508
|
+
|
1509
|
+
# @!attribute [rw] id
|
1510
|
+
# The identifier of the FAQ.
|
1511
|
+
# @return [String]
|
1512
|
+
#
|
1513
|
+
# @!attribute [rw] index_id
|
1514
|
+
# The identifier of the index that contains the FAQ.
|
1515
|
+
# @return [String]
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] name
|
1518
|
+
# The name that you gave the FAQ when it was created.
|
1519
|
+
# @return [String]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] description
|
1522
|
+
# The description of the FAQ that you provided when it was created.
|
1523
|
+
# @return [String]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] created_at
|
1526
|
+
# The date and time that the FAQ was created.
|
1527
|
+
# @return [Time]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] updated_at
|
1530
|
+
# The date and time that the FAQ was last updated.
|
1531
|
+
# @return [Time]
|
1532
|
+
#
|
1533
|
+
# @!attribute [rw] s3_path
|
1534
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
1535
|
+
# @return [Types::S3Path]
|
1536
|
+
#
|
1537
|
+
# @!attribute [rw] status
|
1538
|
+
# The status of the FAQ. It is ready to use when the status is
|
1539
|
+
# `ACTIVE`.
|
1540
|
+
# @return [String]
|
1541
|
+
#
|
1542
|
+
# @!attribute [rw] role_arn
|
1543
|
+
# The Amazon Resource Name (ARN) of the role that provides access to
|
1544
|
+
# the S3 bucket containing the input files for the FAQ.
|
1545
|
+
# @return [String]
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] error_message
|
1548
|
+
# If the `Status` field is `FAILED`, the `ErrorMessage` field contains
|
1549
|
+
# the reason why the FAQ failed.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqResponse AWS API Documentation
|
1553
|
+
#
|
1554
|
+
class DescribeFaqResponse < Struct.new(
|
1555
|
+
:id,
|
1556
|
+
:index_id,
|
1557
|
+
:name,
|
1558
|
+
:description,
|
1559
|
+
:created_at,
|
1560
|
+
:updated_at,
|
1561
|
+
:s3_path,
|
1562
|
+
:status,
|
1563
|
+
:role_arn,
|
1564
|
+
:error_message)
|
1565
|
+
include Aws::Structure
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
# @note When making an API call, you may pass DescribeIndexRequest
|
1569
|
+
# data as a hash:
|
1570
|
+
#
|
1571
|
+
# {
|
1572
|
+
# id: "IndexId", # required
|
1573
|
+
# }
|
1574
|
+
#
|
1575
|
+
# @!attribute [rw] id
|
1576
|
+
# The name of the index to describe.
|
1577
|
+
# @return [String]
|
1578
|
+
#
|
1579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexRequest AWS API Documentation
|
1580
|
+
#
|
1581
|
+
class DescribeIndexRequest < Struct.new(
|
1582
|
+
:id)
|
1583
|
+
include Aws::Structure
|
1584
|
+
end
|
1585
|
+
|
1586
|
+
# @!attribute [rw] name
|
1587
|
+
# The name of the index.
|
1588
|
+
# @return [String]
|
1589
|
+
#
|
1590
|
+
# @!attribute [rw] id
|
1591
|
+
# the name of the index.
|
1592
|
+
# @return [String]
|
1593
|
+
#
|
1594
|
+
# @!attribute [rw] role_arn
|
1595
|
+
# The Amazon Resource Name (ARN) of the IAM role that gives Amazon
|
1596
|
+
# Kendra permission to write to your Amazon Cloudwatch logs.
|
1597
|
+
# @return [String]
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] server_side_encryption_configuration
|
1600
|
+
# The identifier of the KMS key used to encrypt your data.
|
1601
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] status
|
1604
|
+
# The current status of the index. When the value is `ACTIVE`, the
|
1605
|
+
# index is ready for use. If the `Status` field value is `FAILED`, the
|
1606
|
+
# `ErrorMessage` field contains a message that explains why.
|
1607
|
+
# @return [String]
|
1608
|
+
#
|
1609
|
+
# @!attribute [rw] description
|
1610
|
+
# The description of the index.
|
1611
|
+
# @return [String]
|
1612
|
+
#
|
1613
|
+
# @!attribute [rw] created_at
|
1614
|
+
# The Unix datetime that the index was created.
|
1615
|
+
# @return [Time]
|
1616
|
+
#
|
1617
|
+
# @!attribute [rw] updated_at
|
1618
|
+
# The Unix datetime that the index was last updated.
|
1619
|
+
# @return [Time]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] document_metadata_configurations
|
1622
|
+
# Configuration settings for any metadata applied to the documents in
|
1623
|
+
# the index.
|
1624
|
+
# @return [Array<Types::DocumentMetadataConfiguration>]
|
1625
|
+
#
|
1626
|
+
# @!attribute [rw] index_statistics
|
1627
|
+
# Provides information about the number of FAQ questions and answers
|
1628
|
+
# and the number of text documents indexed.
|
1629
|
+
# @return [Types::IndexStatistics]
|
1630
|
+
#
|
1631
|
+
# @!attribute [rw] error_message
|
1632
|
+
# When th e`Status` field value is `FAILED`, the `ErrorMessage` field
|
1633
|
+
# contains a message that explains why.
|
1634
|
+
# @return [String]
|
1635
|
+
#
|
1636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
|
1637
|
+
#
|
1638
|
+
class DescribeIndexResponse < Struct.new(
|
1639
|
+
:name,
|
1640
|
+
:id,
|
1641
|
+
:role_arn,
|
1642
|
+
:server_side_encryption_configuration,
|
1643
|
+
:status,
|
1644
|
+
:description,
|
1645
|
+
:created_at,
|
1646
|
+
:updated_at,
|
1647
|
+
:document_metadata_configurations,
|
1648
|
+
:index_statistics,
|
1649
|
+
:error_message)
|
1650
|
+
include Aws::Structure
|
1651
|
+
end
|
1652
|
+
|
1653
|
+
# A document in an index.
|
1654
|
+
#
|
1655
|
+
# @note When making an API call, you may pass Document
|
1656
|
+
# data as a hash:
|
1657
|
+
#
|
1658
|
+
# {
|
1659
|
+
# id: "DocumentId", # required
|
1660
|
+
# title: "Title",
|
1661
|
+
# blob: "data",
|
1662
|
+
# s3_path: {
|
1663
|
+
# bucket: "S3BucketName", # required
|
1664
|
+
# key: "S3ObjectKey", # required
|
1665
|
+
# },
|
1666
|
+
# attributes: [
|
1667
|
+
# {
|
1668
|
+
# key: "DocumentAttributeKey", # required
|
1669
|
+
# value: { # required
|
1670
|
+
# string_value: "DocumentAttributeStringValue",
|
1671
|
+
# string_list_value: ["String"],
|
1672
|
+
# long_value: 1,
|
1673
|
+
# date_value: Time.now,
|
1674
|
+
# },
|
1675
|
+
# },
|
1676
|
+
# ],
|
1677
|
+
# access_control_list: [
|
1678
|
+
# {
|
1679
|
+
# name: "PrincipalName", # required
|
1680
|
+
# type: "USER", # required, accepts USER, GROUP
|
1681
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
1682
|
+
# },
|
1683
|
+
# ],
|
1684
|
+
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
1685
|
+
# }
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] id
|
1688
|
+
# A unique identifier of the document in the index.
|
1689
|
+
# @return [String]
|
1690
|
+
#
|
1691
|
+
# @!attribute [rw] title
|
1692
|
+
# The title of the document.
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] blob
|
1696
|
+
# The contents of the document as a base-64 encoded string.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] s3_path
|
1700
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
1701
|
+
# @return [Types::S3Path]
|
1702
|
+
#
|
1703
|
+
# @!attribute [rw] attributes
|
1704
|
+
# Custom attributes to apply to the document. Use the custom
|
1705
|
+
# attributes to provide additional information for searching, to
|
1706
|
+
# provide facets for refining searches, and to provide additional
|
1707
|
+
# information in the query response.
|
1708
|
+
# @return [Array<Types::DocumentAttribute>]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] access_control_list
|
1711
|
+
# Information to use for user context filtering.
|
1712
|
+
# @return [Array<Types::Principal>]
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] content_type
|
1715
|
+
# The file type of the document in the `Blob` field.
|
1716
|
+
# @return [String]
|
1717
|
+
#
|
1718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Document AWS API Documentation
|
1719
|
+
#
|
1720
|
+
class Document < Struct.new(
|
1721
|
+
:id,
|
1722
|
+
:title,
|
1723
|
+
:blob,
|
1724
|
+
:s3_path,
|
1725
|
+
:attributes,
|
1726
|
+
:access_control_list,
|
1727
|
+
:content_type)
|
1728
|
+
include Aws::Structure
|
1729
|
+
end
|
1730
|
+
|
1731
|
+
# A custom attribute value assigned to a document.
|
1732
|
+
#
|
1733
|
+
# @note When making an API call, you may pass DocumentAttribute
|
1734
|
+
# data as a hash:
|
1735
|
+
#
|
1736
|
+
# {
|
1737
|
+
# key: "DocumentAttributeKey", # required
|
1738
|
+
# value: { # required
|
1739
|
+
# string_value: "DocumentAttributeStringValue",
|
1740
|
+
# string_list_value: ["String"],
|
1741
|
+
# long_value: 1,
|
1742
|
+
# date_value: Time.now,
|
1743
|
+
# },
|
1744
|
+
# }
|
1745
|
+
#
|
1746
|
+
# @!attribute [rw] key
|
1747
|
+
# The identifier for the attribute.
|
1748
|
+
# @return [String]
|
1749
|
+
#
|
1750
|
+
# @!attribute [rw] value
|
1751
|
+
# The value of the attribute.
|
1752
|
+
# @return [Types::DocumentAttributeValue]
|
1753
|
+
#
|
1754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttribute AWS API Documentation
|
1755
|
+
#
|
1756
|
+
class DocumentAttribute < Struct.new(
|
1757
|
+
:key,
|
1758
|
+
:value)
|
1759
|
+
include Aws::Structure
|
1760
|
+
end
|
1761
|
+
|
1762
|
+
# The value of a custom document attribute. You can only provide one
|
1763
|
+
# value for a custom attribute.
|
1764
|
+
#
|
1765
|
+
# @note When making an API call, you may pass DocumentAttributeValue
|
1766
|
+
# data as a hash:
|
1767
|
+
#
|
1768
|
+
# {
|
1769
|
+
# string_value: "DocumentAttributeStringValue",
|
1770
|
+
# string_list_value: ["String"],
|
1771
|
+
# long_value: 1,
|
1772
|
+
# date_value: Time.now,
|
1773
|
+
# }
|
1774
|
+
#
|
1775
|
+
# @!attribute [rw] string_value
|
1776
|
+
# A string, such as "department".
|
1777
|
+
# @return [String]
|
1778
|
+
#
|
1779
|
+
# @!attribute [rw] string_list_value
|
1780
|
+
# A list of strings.
|
1781
|
+
# @return [Array<String>]
|
1782
|
+
#
|
1783
|
+
# @!attribute [rw] long_value
|
1784
|
+
# A long integer value.
|
1785
|
+
# @return [Integer]
|
1786
|
+
#
|
1787
|
+
# @!attribute [rw] date_value
|
1788
|
+
# A date value expressed as seconds from the Unix epoch.
|
1789
|
+
# @return [Time]
|
1790
|
+
#
|
1791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
|
1792
|
+
#
|
1793
|
+
class DocumentAttributeValue < Struct.new(
|
1794
|
+
:string_value,
|
1795
|
+
:string_list_value,
|
1796
|
+
:long_value,
|
1797
|
+
:date_value)
|
1798
|
+
include Aws::Structure
|
1799
|
+
end
|
1800
|
+
|
1801
|
+
# Provides the count of documents that match a particular attribute when
|
1802
|
+
# doing a faceted search.
|
1803
|
+
#
|
1804
|
+
# @!attribute [rw] document_attribute_value
|
1805
|
+
# The value of the attribute. For example, "HR."
|
1806
|
+
# @return [Types::DocumentAttributeValue]
|
1807
|
+
#
|
1808
|
+
# @!attribute [rw] count
|
1809
|
+
# The number of documents in the response that have the attribute
|
1810
|
+
# value for the key.
|
1811
|
+
# @return [Integer]
|
1812
|
+
#
|
1813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValueCountPair AWS API Documentation
|
1814
|
+
#
|
1815
|
+
class DocumentAttributeValueCountPair < Struct.new(
|
1816
|
+
:document_attribute_value,
|
1817
|
+
:count)
|
1818
|
+
include Aws::Structure
|
1819
|
+
end
|
1820
|
+
|
1821
|
+
# Specifies the properties of a custom index field.
|
1822
|
+
#
|
1823
|
+
# @note When making an API call, you may pass DocumentMetadataConfiguration
|
1824
|
+
# data as a hash:
|
1825
|
+
#
|
1826
|
+
# {
|
1827
|
+
# name: "DocumentMetadataConfigurationName", # required
|
1828
|
+
# type: "STRING_VALUE", # required, accepts STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE
|
1829
|
+
# relevance: {
|
1830
|
+
# freshness: false,
|
1831
|
+
# importance: 1,
|
1832
|
+
# duration: "Duration",
|
1833
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1834
|
+
# value_importance_map: {
|
1835
|
+
# "ValueImportanceMapKey" => 1,
|
1836
|
+
# },
|
1837
|
+
# },
|
1838
|
+
# search: {
|
1839
|
+
# facetable: false,
|
1840
|
+
# searchable: false,
|
1841
|
+
# displayable: false,
|
1842
|
+
# },
|
1843
|
+
# }
|
1844
|
+
#
|
1845
|
+
# @!attribute [rw] name
|
1846
|
+
# The name of the index field.
|
1847
|
+
# @return [String]
|
1848
|
+
#
|
1849
|
+
# @!attribute [rw] type
|
1850
|
+
# The data type of the index field.
|
1851
|
+
# @return [String]
|
1852
|
+
#
|
1853
|
+
# @!attribute [rw] relevance
|
1854
|
+
# Provides manual tuning parameters to determine how the field affects
|
1855
|
+
# the search results.
|
1856
|
+
# @return [Types::Relevance]
|
1857
|
+
#
|
1858
|
+
# @!attribute [rw] search
|
1859
|
+
# Provides information about how the field is used during a search.
|
1860
|
+
# @return [Types::Search]
|
1861
|
+
#
|
1862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentMetadataConfiguration AWS API Documentation
|
1863
|
+
#
|
1864
|
+
class DocumentMetadataConfiguration < Struct.new(
|
1865
|
+
:name,
|
1866
|
+
:type,
|
1867
|
+
:relevance,
|
1868
|
+
:search)
|
1869
|
+
include Aws::Structure
|
1870
|
+
end
|
1871
|
+
|
1872
|
+
# Document metadata files that contain information such as the document
|
1873
|
+
# access control information, source URI, document author, and custom
|
1874
|
+
# attributes. Each metadata file contains metadata about a single
|
1875
|
+
# document.
|
1876
|
+
#
|
1877
|
+
# @note When making an API call, you may pass DocumentsMetadataConfiguration
|
1878
|
+
# data as a hash:
|
1879
|
+
#
|
1880
|
+
# {
|
1881
|
+
# s3_prefix: "S3ObjectKey",
|
1882
|
+
# }
|
1883
|
+
#
|
1884
|
+
# @!attribute [rw] s3_prefix
|
1885
|
+
# A prefix used to filter metadata configuration files in the AWS S3
|
1886
|
+
# bucket. The S3 bucket might contain multiple metadata files. Use
|
1887
|
+
# `S3Prefix` to include only the desired metadata files.
|
1888
|
+
# @return [String]
|
1889
|
+
#
|
1890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentsMetadataConfiguration AWS API Documentation
|
1891
|
+
#
|
1892
|
+
class DocumentsMetadataConfiguration < Struct.new(
|
1893
|
+
:s3_prefix)
|
1894
|
+
include Aws::Structure
|
1895
|
+
end
|
1896
|
+
|
1897
|
+
# Information a document attribute
|
1898
|
+
#
|
1899
|
+
# @note When making an API call, you may pass Facet
|
1900
|
+
# data as a hash:
|
1901
|
+
#
|
1902
|
+
# {
|
1903
|
+
# document_attribute_key: "DocumentAttributeKey",
|
1904
|
+
# }
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] document_attribute_key
|
1907
|
+
# The unique key for the document attribute.
|
1908
|
+
# @return [String]
|
1909
|
+
#
|
1910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Facet AWS API Documentation
|
1911
|
+
#
|
1912
|
+
class Facet < Struct.new(
|
1913
|
+
:document_attribute_key)
|
1914
|
+
include Aws::Structure
|
1915
|
+
end
|
1916
|
+
|
1917
|
+
# The facet values for the documents in the response.
|
1918
|
+
#
|
1919
|
+
# @!attribute [rw] document_attribute_key
|
1920
|
+
# The key for the facet values. This is the same as the
|
1921
|
+
# `DocumentAttributeKey` provided in the query.
|
1922
|
+
# @return [String]
|
1923
|
+
#
|
1924
|
+
# @!attribute [rw] document_attribute_value_count_pairs
|
1925
|
+
# An array of key/value pairs, where the key is the value of the
|
1926
|
+
# attribute and the count is the number of documents that share the
|
1927
|
+
# key value.
|
1928
|
+
# @return [Array<Types::DocumentAttributeValueCountPair>]
|
1929
|
+
#
|
1930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FacetResult AWS API Documentation
|
1931
|
+
#
|
1932
|
+
class FacetResult < Struct.new(
|
1933
|
+
:document_attribute_key,
|
1934
|
+
:document_attribute_value_count_pairs)
|
1935
|
+
include Aws::Structure
|
1936
|
+
end
|
1937
|
+
|
1938
|
+
# Provides statistical information about the FAQ questions and answers
|
1939
|
+
# contained in an index.
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] indexed_question_answers_count
|
1942
|
+
# The total number of FAQ questions and answers contained in the
|
1943
|
+
# index.
|
1944
|
+
# @return [Integer]
|
1945
|
+
#
|
1946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqStatistics AWS API Documentation
|
1947
|
+
#
|
1948
|
+
class FaqStatistics < Struct.new(
|
1949
|
+
:indexed_question_answers_count)
|
1950
|
+
include Aws::Structure
|
1951
|
+
end
|
1952
|
+
|
1953
|
+
# Provides information about a frequently asked questions and answer
|
1954
|
+
# contained in an index.
|
1955
|
+
#
|
1956
|
+
# @!attribute [rw] id
|
1957
|
+
# The unique identifier of the FAQ.
|
1958
|
+
# @return [String]
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] name
|
1961
|
+
# The name that you assigned the FAQ when you created or updated the
|
1962
|
+
# FAQ.
|
1963
|
+
# @return [String]
|
1964
|
+
#
|
1965
|
+
# @!attribute [rw] status
|
1966
|
+
# The current status of the FAQ. When the status is `ACTIVE` the FAQ
|
1967
|
+
# is ready for use.
|
1968
|
+
# @return [String]
|
1969
|
+
#
|
1970
|
+
# @!attribute [rw] created_at
|
1971
|
+
# The UNIX datetime that the FAQ was added to the index.
|
1972
|
+
# @return [Time]
|
1973
|
+
#
|
1974
|
+
# @!attribute [rw] updated_at
|
1975
|
+
# The UNIX datetime that the FAQ was last updated.
|
1976
|
+
# @return [Time]
|
1977
|
+
#
|
1978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqSummary AWS API Documentation
|
1979
|
+
#
|
1980
|
+
class FaqSummary < Struct.new(
|
1981
|
+
:id,
|
1982
|
+
:name,
|
1983
|
+
:status,
|
1984
|
+
:created_at,
|
1985
|
+
:updated_at)
|
1986
|
+
include Aws::Structure
|
1987
|
+
end
|
1988
|
+
|
1989
|
+
# Provides information that you can use to highlight a search result so
|
1990
|
+
# that your users can quickly identify terms in the response.
|
1991
|
+
#
|
1992
|
+
# @!attribute [rw] begin_offset
|
1993
|
+
# The zero-based location in the response string where the highlight
|
1994
|
+
# starts.
|
1995
|
+
# @return [Integer]
|
1996
|
+
#
|
1997
|
+
# @!attribute [rw] end_offset
|
1998
|
+
# The zero-based location in the response string where the highlight
|
1999
|
+
# ends.
|
2000
|
+
# @return [Integer]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] top_answer
|
2003
|
+
# Indicates whether the response is the best response. True if this is
|
2004
|
+
# the best response; otherwise, false.
|
2005
|
+
# @return [Boolean]
|
2006
|
+
#
|
2007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Highlight AWS API Documentation
|
2008
|
+
#
|
2009
|
+
class Highlight < Struct.new(
|
2010
|
+
:begin_offset,
|
2011
|
+
:end_offset,
|
2012
|
+
:top_answer)
|
2013
|
+
include Aws::Structure
|
2014
|
+
end
|
2015
|
+
|
2016
|
+
# A summary of information about an index.
|
2017
|
+
#
|
2018
|
+
# @!attribute [rw] name
|
2019
|
+
# The name of the index.
|
2020
|
+
# @return [String]
|
2021
|
+
#
|
2022
|
+
# @!attribute [rw] id
|
2023
|
+
# A unique identifier for the index. Use this to identify the index
|
2024
|
+
# when you are using operations such as `Query`, `DescribeIndex`,
|
2025
|
+
# `UpdateIndex`, and `DeleteIndex`.
|
2026
|
+
# @return [String]
|
2027
|
+
#
|
2028
|
+
# @!attribute [rw] created_at
|
2029
|
+
# The Unix timestamp when the index was created.
|
2030
|
+
# @return [Time]
|
2031
|
+
#
|
2032
|
+
# @!attribute [rw] updated_at
|
2033
|
+
# The Unix timestamp when the index was last updated by the
|
2034
|
+
# `UpdateIndex` operation.
|
2035
|
+
# @return [Time]
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] status
|
2038
|
+
# The current status of the index. When the status is `ACTIVE`, the
|
2039
|
+
# index is ready to search.
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
2042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/IndexConfigurationSummary AWS API Documentation
|
2043
|
+
#
|
2044
|
+
class IndexConfigurationSummary < Struct.new(
|
2045
|
+
:name,
|
2046
|
+
:id,
|
2047
|
+
:created_at,
|
2048
|
+
:updated_at,
|
2049
|
+
:status)
|
2050
|
+
include Aws::Structure
|
2051
|
+
end
|
2052
|
+
|
2053
|
+
# Provides information about the number of documents and the number of
|
2054
|
+
# questions and answers in an index.
|
2055
|
+
#
|
2056
|
+
# @!attribute [rw] faq_statistics
|
2057
|
+
# The number of question and answer topics in the index.
|
2058
|
+
# @return [Types::FaqStatistics]
|
2059
|
+
#
|
2060
|
+
# @!attribute [rw] text_document_statistics
|
2061
|
+
# The number of text documents indexed.
|
2062
|
+
# @return [Types::TextDocumentStatistics]
|
2063
|
+
#
|
2064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/IndexStatistics AWS API Documentation
|
2065
|
+
#
|
2066
|
+
class IndexStatistics < Struct.new(
|
2067
|
+
:faq_statistics,
|
2068
|
+
:text_document_statistics)
|
2069
|
+
include Aws::Structure
|
2070
|
+
end
|
2071
|
+
|
2072
|
+
# @!attribute [rw] message
|
2073
|
+
# @return [String]
|
2074
|
+
#
|
2075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InternalServerException AWS API Documentation
|
2076
|
+
#
|
2077
|
+
class InternalServerException < Struct.new(
|
2078
|
+
:message)
|
2079
|
+
include Aws::Structure
|
2080
|
+
end
|
2081
|
+
|
2082
|
+
# @note When making an API call, you may pass ListDataSourceSyncJobsRequest
|
2083
|
+
# data as a hash:
|
2084
|
+
#
|
2085
|
+
# {
|
2086
|
+
# id: "DataSourceId", # required
|
2087
|
+
# index_id: "IndexId", # required
|
2088
|
+
# next_token: "NextToken",
|
2089
|
+
# max_results: 1,
|
2090
|
+
# start_time_filter: {
|
2091
|
+
# start_time: Time.now,
|
2092
|
+
# end_time: Time.now,
|
2093
|
+
# },
|
2094
|
+
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
|
2095
|
+
# }
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] id
|
2098
|
+
# The identifier of the data source.
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] index_id
|
2102
|
+
# The identifier of the index that contains the data source.
|
2103
|
+
# @return [String]
|
2104
|
+
#
|
2105
|
+
# @!attribute [rw] next_token
|
2106
|
+
# If the result of the previous request to
|
2107
|
+
# `GetDataSourceSyncJobHistory` was truncated, include the `NextToken`
|
2108
|
+
# to fetch the next set of jobs.
|
2109
|
+
# @return [String]
|
2110
|
+
#
|
2111
|
+
# @!attribute [rw] max_results
|
2112
|
+
# The maximum number of synchronization jobs to return in the
|
2113
|
+
# response. If there are fewer results in the list, this response
|
2114
|
+
# contains only the actual results.
|
2115
|
+
# @return [Integer]
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] start_time_filter
|
2118
|
+
# When specified, the synchronization jobs returned in the list are
|
2119
|
+
# limited to jobs between the specified dates.
|
2120
|
+
# @return [Types::TimeRange]
|
2121
|
+
#
|
2122
|
+
# @!attribute [rw] status_filter
|
2123
|
+
# When specified, only returns synchronization jobs with the `Status`
|
2124
|
+
# field equal to the specified status.
|
2125
|
+
# @return [String]
|
2126
|
+
#
|
2127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsRequest AWS API Documentation
|
2128
|
+
#
|
2129
|
+
class ListDataSourceSyncJobsRequest < Struct.new(
|
2130
|
+
:id,
|
2131
|
+
:index_id,
|
2132
|
+
:next_token,
|
2133
|
+
:max_results,
|
2134
|
+
:start_time_filter,
|
2135
|
+
:status_filter)
|
2136
|
+
include Aws::Structure
|
2137
|
+
end
|
2138
|
+
|
2139
|
+
# @!attribute [rw] history
|
2140
|
+
# A history of synchronization jobs for the data source.
|
2141
|
+
# @return [Array<Types::DataSourceSyncJob>]
|
2142
|
+
#
|
2143
|
+
# @!attribute [rw] next_token
|
2144
|
+
# The `GetDataSourceSyncJobHistory` operation returns a page of
|
2145
|
+
# vocabularies at a time. The maximum size of the page is set by the
|
2146
|
+
# `MaxResults` parameter. If there are more jobs in the list than the
|
2147
|
+
# page size, Amazon Kendra returns the NextPage token. Include the
|
2148
|
+
# token in the next request to the `GetDataSourceSyncJobHistory`
|
2149
|
+
# operation to return in the next page of jobs.
|
2150
|
+
# @return [String]
|
2151
|
+
#
|
2152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsResponse AWS API Documentation
|
2153
|
+
#
|
2154
|
+
class ListDataSourceSyncJobsResponse < Struct.new(
|
2155
|
+
:history,
|
2156
|
+
:next_token)
|
2157
|
+
include Aws::Structure
|
2158
|
+
end
|
2159
|
+
|
2160
|
+
# @note When making an API call, you may pass ListDataSourcesRequest
|
2161
|
+
# data as a hash:
|
2162
|
+
#
|
2163
|
+
# {
|
2164
|
+
# index_id: "IndexId", # required
|
2165
|
+
# next_token: "NextToken",
|
2166
|
+
# max_results: 1,
|
2167
|
+
# }
|
2168
|
+
#
|
2169
|
+
# @!attribute [rw] index_id
|
2170
|
+
# The identifier of the index that contains the data source.
|
2171
|
+
# @return [String]
|
2172
|
+
#
|
2173
|
+
# @!attribute [rw] next_token
|
2174
|
+
# If the previous response was incomplete (because there is more data
|
2175
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
2176
|
+
# response. You can use this pagination token to retrieve the next set
|
2177
|
+
# of data sources (`DataSourceSummaryItems`).
|
2178
|
+
# @return [String]
|
2179
|
+
#
|
2180
|
+
# @!attribute [rw] max_results
|
2181
|
+
# The maximum number of data sources to return.
|
2182
|
+
# @return [Integer]
|
2183
|
+
#
|
2184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesRequest AWS API Documentation
|
2185
|
+
#
|
2186
|
+
class ListDataSourcesRequest < Struct.new(
|
2187
|
+
:index_id,
|
2188
|
+
:next_token,
|
2189
|
+
:max_results)
|
2190
|
+
include Aws::Structure
|
2191
|
+
end
|
2192
|
+
|
2193
|
+
# @!attribute [rw] summary_items
|
2194
|
+
# An array of summary information for one or more data sources.
|
2195
|
+
# @return [Array<Types::DataSourceSummary>]
|
2196
|
+
#
|
2197
|
+
# @!attribute [rw] next_token
|
2198
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
2199
|
+
# you can use in the subsequent request to retrieve the next set of
|
2200
|
+
# data sources.
|
2201
|
+
# @return [String]
|
2202
|
+
#
|
2203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesResponse AWS API Documentation
|
2204
|
+
#
|
2205
|
+
class ListDataSourcesResponse < Struct.new(
|
2206
|
+
:summary_items,
|
2207
|
+
:next_token)
|
2208
|
+
include Aws::Structure
|
2209
|
+
end
|
2210
|
+
|
2211
|
+
# @note When making an API call, you may pass ListFaqsRequest
|
2212
|
+
# data as a hash:
|
2213
|
+
#
|
2214
|
+
# {
|
2215
|
+
# index_id: "IndexId", # required
|
2216
|
+
# next_token: "NextToken",
|
2217
|
+
# max_results: 1,
|
2218
|
+
# }
|
2219
|
+
#
|
2220
|
+
# @!attribute [rw] index_id
|
2221
|
+
# The index that contains the FAQ lists.
|
2222
|
+
# @return [String]
|
2223
|
+
#
|
2224
|
+
# @!attribute [rw] next_token
|
2225
|
+
# If the result of the previous request to `ListFaqs` was truncated,
|
2226
|
+
# include the `NextToken` to fetch the next set of FAQs.
|
2227
|
+
# @return [String]
|
2228
|
+
#
|
2229
|
+
# @!attribute [rw] max_results
|
2230
|
+
# The maximum number of FAQs to return in the response. If there are
|
2231
|
+
# fewer results in the list, this response contains only the actual
|
2232
|
+
# results.
|
2233
|
+
# @return [Integer]
|
2234
|
+
#
|
2235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqsRequest AWS API Documentation
|
2236
|
+
#
|
2237
|
+
class ListFaqsRequest < Struct.new(
|
2238
|
+
:index_id,
|
2239
|
+
:next_token,
|
2240
|
+
:max_results)
|
2241
|
+
include Aws::Structure
|
2242
|
+
end
|
2243
|
+
|
2244
|
+
# @!attribute [rw] next_token
|
2245
|
+
# The `ListFaqs` operation returns a page of FAQs at a time. The
|
2246
|
+
# maximum size of the page is set by the `MaxResults` parameter. If
|
2247
|
+
# there are more jobs in the list than the page size, Amazon Kendra
|
2248
|
+
# returns the `NextPage` token. Include the token in the next request
|
2249
|
+
# to the `ListFaqs` operation to return the next page of FAQs.
|
2250
|
+
# @return [String]
|
2251
|
+
#
|
2252
|
+
# @!attribute [rw] faq_summary_items
|
2253
|
+
# information about the FAQs associated with the specified index.
|
2254
|
+
# @return [Array<Types::FaqSummary>]
|
2255
|
+
#
|
2256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqsResponse AWS API Documentation
|
2257
|
+
#
|
2258
|
+
class ListFaqsResponse < Struct.new(
|
2259
|
+
:next_token,
|
2260
|
+
:faq_summary_items)
|
2261
|
+
include Aws::Structure
|
2262
|
+
end
|
2263
|
+
|
2264
|
+
# @note When making an API call, you may pass ListIndicesRequest
|
2265
|
+
# data as a hash:
|
2266
|
+
#
|
2267
|
+
# {
|
2268
|
+
# next_token: "NextToken",
|
2269
|
+
# max_results: 1,
|
2270
|
+
# }
|
2271
|
+
#
|
2272
|
+
# @!attribute [rw] next_token
|
2273
|
+
# If the previous response was incomplete (because there is more data
|
2274
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
2275
|
+
# response. You can use this pagination token to retrieve the next set
|
2276
|
+
# of indexes (`DataSourceSummaryItems`).
|
2277
|
+
# @return [String]
|
2278
|
+
#
|
2279
|
+
# @!attribute [rw] max_results
|
2280
|
+
# The maximum number of data sources to return.
|
2281
|
+
# @return [Integer]
|
2282
|
+
#
|
2283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesRequest AWS API Documentation
|
2284
|
+
#
|
2285
|
+
class ListIndicesRequest < Struct.new(
|
2286
|
+
:next_token,
|
2287
|
+
:max_results)
|
2288
|
+
include Aws::Structure
|
2289
|
+
end
|
2290
|
+
|
2291
|
+
# @!attribute [rw] index_configuration_summary_items
|
2292
|
+
# An array of summary information for one or more indexes.
|
2293
|
+
# @return [Array<Types::IndexConfigurationSummary>]
|
2294
|
+
#
|
2295
|
+
# @!attribute [rw] next_token
|
2296
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
2297
|
+
# you can use in the subsequent request to retrieve the next set of
|
2298
|
+
# indexes.
|
2299
|
+
# @return [String]
|
2300
|
+
#
|
2301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesResponse AWS API Documentation
|
2302
|
+
#
|
2303
|
+
class ListIndicesResponse < Struct.new(
|
2304
|
+
:index_configuration_summary_items,
|
2305
|
+
:next_token)
|
2306
|
+
include Aws::Structure
|
2307
|
+
end
|
2308
|
+
|
2309
|
+
# Provides user and group information for document access filtering.
|
2310
|
+
#
|
2311
|
+
# @note When making an API call, you may pass Principal
|
2312
|
+
# data as a hash:
|
2313
|
+
#
|
2314
|
+
# {
|
2315
|
+
# name: "PrincipalName", # required
|
2316
|
+
# type: "USER", # required, accepts USER, GROUP
|
2317
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
2318
|
+
# }
|
2319
|
+
#
|
2320
|
+
# @!attribute [rw] name
|
2321
|
+
# The name of the user or group.
|
2322
|
+
# @return [String]
|
2323
|
+
#
|
2324
|
+
# @!attribute [rw] type
|
2325
|
+
# The type of principal.
|
2326
|
+
# @return [String]
|
2327
|
+
#
|
2328
|
+
# @!attribute [rw] access
|
2329
|
+
# Whether to allow or deny access to the principal.
|
2330
|
+
# @return [String]
|
2331
|
+
#
|
2332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Principal AWS API Documentation
|
2333
|
+
#
|
2334
|
+
class Principal < Struct.new(
|
2335
|
+
:name,
|
2336
|
+
:type,
|
2337
|
+
:access)
|
2338
|
+
include Aws::Structure
|
2339
|
+
end
|
2340
|
+
|
2341
|
+
# @note When making an API call, you may pass QueryRequest
|
2342
|
+
# data as a hash:
|
2343
|
+
#
|
2344
|
+
# {
|
2345
|
+
# index_id: "IndexId", # required
|
2346
|
+
# query_text: "QueryText", # required
|
2347
|
+
# attribute_filter: {
|
2348
|
+
# and_all_filters: [
|
2349
|
+
# {
|
2350
|
+
# # recursive AttributeFilter
|
2351
|
+
# },
|
2352
|
+
# ],
|
2353
|
+
# or_all_filters: [
|
2354
|
+
# {
|
2355
|
+
# # recursive AttributeFilter
|
2356
|
+
# },
|
2357
|
+
# ],
|
2358
|
+
# not_filter: {
|
2359
|
+
# # recursive AttributeFilter
|
2360
|
+
# },
|
2361
|
+
# equals_to: {
|
2362
|
+
# key: "DocumentAttributeKey", # required
|
2363
|
+
# value: { # required
|
2364
|
+
# string_value: "DocumentAttributeStringValue",
|
2365
|
+
# string_list_value: ["String"],
|
2366
|
+
# long_value: 1,
|
2367
|
+
# date_value: Time.now,
|
2368
|
+
# },
|
2369
|
+
# },
|
2370
|
+
# contains_all: {
|
2371
|
+
# key: "DocumentAttributeKey", # required
|
2372
|
+
# value: { # required
|
2373
|
+
# string_value: "DocumentAttributeStringValue",
|
2374
|
+
# string_list_value: ["String"],
|
2375
|
+
# long_value: 1,
|
2376
|
+
# date_value: Time.now,
|
2377
|
+
# },
|
2378
|
+
# },
|
2379
|
+
# contains_any: {
|
2380
|
+
# key: "DocumentAttributeKey", # required
|
2381
|
+
# value: { # required
|
2382
|
+
# string_value: "DocumentAttributeStringValue",
|
2383
|
+
# string_list_value: ["String"],
|
2384
|
+
# long_value: 1,
|
2385
|
+
# date_value: Time.now,
|
2386
|
+
# },
|
2387
|
+
# },
|
2388
|
+
# greater_than: {
|
2389
|
+
# key: "DocumentAttributeKey", # required
|
2390
|
+
# value: { # required
|
2391
|
+
# string_value: "DocumentAttributeStringValue",
|
2392
|
+
# string_list_value: ["String"],
|
2393
|
+
# long_value: 1,
|
2394
|
+
# date_value: Time.now,
|
2395
|
+
# },
|
2396
|
+
# },
|
2397
|
+
# greater_than_or_equals: {
|
2398
|
+
# key: "DocumentAttributeKey", # required
|
2399
|
+
# value: { # required
|
2400
|
+
# string_value: "DocumentAttributeStringValue",
|
2401
|
+
# string_list_value: ["String"],
|
2402
|
+
# long_value: 1,
|
2403
|
+
# date_value: Time.now,
|
2404
|
+
# },
|
2405
|
+
# },
|
2406
|
+
# less_than: {
|
2407
|
+
# key: "DocumentAttributeKey", # required
|
2408
|
+
# value: { # required
|
2409
|
+
# string_value: "DocumentAttributeStringValue",
|
2410
|
+
# string_list_value: ["String"],
|
2411
|
+
# long_value: 1,
|
2412
|
+
# date_value: Time.now,
|
2413
|
+
# },
|
2414
|
+
# },
|
2415
|
+
# less_than_or_equals: {
|
2416
|
+
# key: "DocumentAttributeKey", # required
|
2417
|
+
# value: { # required
|
2418
|
+
# string_value: "DocumentAttributeStringValue",
|
2419
|
+
# string_list_value: ["String"],
|
2420
|
+
# long_value: 1,
|
2421
|
+
# date_value: Time.now,
|
2422
|
+
# },
|
2423
|
+
# },
|
2424
|
+
# },
|
2425
|
+
# facets: [
|
2426
|
+
# {
|
2427
|
+
# document_attribute_key: "DocumentAttributeKey",
|
2428
|
+
# },
|
2429
|
+
# ],
|
2430
|
+
# requested_document_attributes: ["DocumentAttributeKey"],
|
2431
|
+
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
2432
|
+
# page_number: 1,
|
2433
|
+
# page_size: 1,
|
2434
|
+
# }
|
2435
|
+
#
|
2436
|
+
# @!attribute [rw] index_id
|
2437
|
+
# The unique identifier of the index to search. The identifier is
|
2438
|
+
# returned in the response from the operation.
|
2439
|
+
# @return [String]
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] query_text
|
2442
|
+
# The text to search for.
|
2443
|
+
# @return [String]
|
2444
|
+
#
|
2445
|
+
# @!attribute [rw] attribute_filter
|
2446
|
+
# Enables filtered searches based on document attributes. You can only
|
2447
|
+
# provide one attribute filter; however, the `AndAllFilters`,
|
2448
|
+
# `NotFilter`, and `OrAllFilters` parameters contain a list of other
|
2449
|
+
# filters.
|
2450
|
+
#
|
2451
|
+
# The `AttributeFilter` parameter enables you to create a set of
|
2452
|
+
# filtering rules that a document must satisfy to be included in the
|
2453
|
+
# query results.
|
2454
|
+
# @return [Types::AttributeFilter]
|
2455
|
+
#
|
2456
|
+
# @!attribute [rw] facets
|
2457
|
+
# An array of documents attributes. Amazon Kendra returns a count for
|
2458
|
+
# each attribute key specified. You can use this information to help
|
2459
|
+
# narrow the search for your user.
|
2460
|
+
# @return [Array<Types::Facet>]
|
2461
|
+
#
|
2462
|
+
# @!attribute [rw] requested_document_attributes
|
2463
|
+
# An array of document attributes to include in the response. No other
|
2464
|
+
# document attributes are included in the response. By default all
|
2465
|
+
# document attributes are included in the response.
|
2466
|
+
# @return [Array<String>]
|
2467
|
+
#
|
2468
|
+
# @!attribute [rw] query_result_type_filter
|
2469
|
+
# Sets the type of query. Only results for the specified query type
|
2470
|
+
# are returned.
|
2471
|
+
# @return [String]
|
2472
|
+
#
|
2473
|
+
# @!attribute [rw] page_number
|
2474
|
+
# Query results are returned in pages the size of the `PageSize`
|
2475
|
+
# parameter. By default, Amazon Kendra returns the first page of
|
2476
|
+
# results. Use this parameter to get result pages after the first one.
|
2477
|
+
# @return [Integer]
|
2478
|
+
#
|
2479
|
+
# @!attribute [rw] page_size
|
2480
|
+
# Sets the number of results that are returned in each page of
|
2481
|
+
# results. The default page size is 100.
|
2482
|
+
# @return [Integer]
|
2483
|
+
#
|
2484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
2485
|
+
#
|
2486
|
+
class QueryRequest < Struct.new(
|
2487
|
+
:index_id,
|
2488
|
+
:query_text,
|
2489
|
+
:attribute_filter,
|
2490
|
+
:facets,
|
2491
|
+
:requested_document_attributes,
|
2492
|
+
:query_result_type_filter,
|
2493
|
+
:page_number,
|
2494
|
+
:page_size)
|
2495
|
+
include Aws::Structure
|
2496
|
+
end
|
2497
|
+
|
2498
|
+
# @!attribute [rw] query_id
|
2499
|
+
# The unique identifier for the search. You use `QueryId` to identify
|
2500
|
+
# the search when using the feedback API.
|
2501
|
+
# @return [String]
|
2502
|
+
#
|
2503
|
+
# @!attribute [rw] result_items
|
2504
|
+
# The results of the search.
|
2505
|
+
# @return [Array<Types::QueryResultItem>]
|
2506
|
+
#
|
2507
|
+
# @!attribute [rw] facet_results
|
2508
|
+
# Contains the facet results. A `FacetResult` contains the counts for
|
2509
|
+
# each attribute key that was specified in the `Facets` input
|
2510
|
+
# parameter.
|
2511
|
+
# @return [Array<Types::FacetResult>]
|
2512
|
+
#
|
2513
|
+
# @!attribute [rw] total_number_of_results
|
2514
|
+
# The number of items returned by the search. Use this to determine
|
2515
|
+
# when you have requested the last set of results.
|
2516
|
+
# @return [Integer]
|
2517
|
+
#
|
2518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
2519
|
+
#
|
2520
|
+
class QueryResult < Struct.new(
|
2521
|
+
:query_id,
|
2522
|
+
:result_items,
|
2523
|
+
:facet_results,
|
2524
|
+
:total_number_of_results)
|
2525
|
+
include Aws::Structure
|
2526
|
+
end
|
2527
|
+
|
2528
|
+
# A single query result.
|
2529
|
+
#
|
2530
|
+
# A query result contains information about a document returned by the
|
2531
|
+
# query. This includes the original location of the document, a list of
|
2532
|
+
# attributes assigned to the document, and relevant text from the
|
2533
|
+
# document that satisfies the query.
|
2534
|
+
#
|
2535
|
+
# @!attribute [rw] id
|
2536
|
+
# The unique identifier for the query result.
|
2537
|
+
# @return [String]
|
2538
|
+
#
|
2539
|
+
# @!attribute [rw] type
|
2540
|
+
# The type of document.
|
2541
|
+
# @return [String]
|
2542
|
+
#
|
2543
|
+
# @!attribute [rw] additional_attributes
|
2544
|
+
# @return [Array<Types::AdditionalResultAttribute>]
|
2545
|
+
#
|
2546
|
+
# @!attribute [rw] document_id
|
2547
|
+
# The unique identifier for the document.
|
2548
|
+
# @return [String]
|
2549
|
+
#
|
2550
|
+
# @!attribute [rw] document_title
|
2551
|
+
# The title of the document. Contains the text of the title and
|
2552
|
+
# information for highlighting the relevant terms in the title.
|
2553
|
+
# @return [Types::TextWithHighlights]
|
2554
|
+
#
|
2555
|
+
# @!attribute [rw] document_excerpt
|
2556
|
+
# An extract of the text in the document. Contains information about
|
2557
|
+
# highlighting the relevant terms in the excerpt.
|
2558
|
+
# @return [Types::TextWithHighlights]
|
2559
|
+
#
|
2560
|
+
# @!attribute [rw] document_uri
|
2561
|
+
# The URI of the original location of the document.
|
2562
|
+
# @return [String]
|
2563
|
+
#
|
2564
|
+
# @!attribute [rw] document_attributes
|
2565
|
+
# An array of document attributes for the document that the query
|
2566
|
+
# result maps to. For example, the document author (Author) or the
|
2567
|
+
# source URI (SourceUri) of the document.
|
2568
|
+
# @return [Array<Types::DocumentAttribute>]
|
2569
|
+
#
|
2570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
|
2571
|
+
#
|
2572
|
+
class QueryResultItem < Struct.new(
|
2573
|
+
:id,
|
2574
|
+
:type,
|
2575
|
+
:additional_attributes,
|
2576
|
+
:document_id,
|
2577
|
+
:document_title,
|
2578
|
+
:document_excerpt,
|
2579
|
+
:document_uri,
|
2580
|
+
:document_attributes)
|
2581
|
+
include Aws::Structure
|
2582
|
+
end
|
2583
|
+
|
2584
|
+
# Provides information for manually tuning the relevance of a field in a
|
2585
|
+
# search. When a query includes terms that match the field, the results
|
2586
|
+
# are given a boost in the response based on these tuning parameters.
|
2587
|
+
#
|
2588
|
+
# @note When making an API call, you may pass Relevance
|
2589
|
+
# data as a hash:
|
2590
|
+
#
|
2591
|
+
# {
|
2592
|
+
# freshness: false,
|
2593
|
+
# importance: 1,
|
2594
|
+
# duration: "Duration",
|
2595
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
2596
|
+
# value_importance_map: {
|
2597
|
+
# "ValueImportanceMapKey" => 1,
|
2598
|
+
# },
|
2599
|
+
# }
|
2600
|
+
#
|
2601
|
+
# @!attribute [rw] freshness
|
2602
|
+
# Indicates that this field determines how "fresh" a document is.
|
2603
|
+
# For example, if document 1 was created on November 5, and document 2
|
2604
|
+
# was created on October 31, document 1 is "fresher" than document
|
2605
|
+
# 2. You can only set the `Freshness` field on one `DATE` type field.
|
2606
|
+
# Only applies to `DATE` fields.
|
2607
|
+
# @return [Boolean]
|
2608
|
+
#
|
2609
|
+
# @!attribute [rw] importance
|
2610
|
+
# The relative importance of the field in the search. Larger numbers
|
2611
|
+
# provide more of a boost than smaller numbers.
|
2612
|
+
# @return [Integer]
|
2613
|
+
#
|
2614
|
+
# @!attribute [rw] duration
|
2615
|
+
# Specifies the time period that the boost applies to. For example, to
|
2616
|
+
# make the boost apply to documents with the field value within the
|
2617
|
+
# last month, you would use "2628000s". Once the field value is
|
2618
|
+
# beyond the specified range, the effect of the boost drops off. The
|
2619
|
+
# higher the importance, the faster the effect drops off. If you
|
2620
|
+
# don't specify a value, the default is 3 months. The value of the
|
2621
|
+
# field is a numeric string followed by the character "s", for
|
2622
|
+
# example "86400s" for one day, or "604800s" for one week.
|
2623
|
+
#
|
2624
|
+
# Only applies to `DATE` fields.
|
2625
|
+
# @return [String]
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] rank_order
|
2628
|
+
# Determines how values should be interpreted.
|
2629
|
+
#
|
2630
|
+
# When the `RankOrder` field is `ASCENDING`, higher numbers are
|
2631
|
+
# better. For example, a document with a rating score of 10 is higher
|
2632
|
+
# ranking than a document with a rating score of 1.
|
2633
|
+
#
|
2634
|
+
# When the `RankOrder` field is `DESCENDING`, lower numbers are
|
2635
|
+
# better. For example, in a task tracking application, a priority 1
|
2636
|
+
# task is more important than a priority 5 task.
|
2637
|
+
#
|
2638
|
+
# Only applies to `LONG` and `DOUBLE` fields.
|
2639
|
+
# @return [String]
|
2640
|
+
#
|
2641
|
+
# @!attribute [rw] value_importance_map
|
2642
|
+
# A list of values that should be given a different boost when they
|
2643
|
+
# appear in the result list. For example, if you are boosting a field
|
2644
|
+
# called "department," query terms that match the department field
|
2645
|
+
# are boosted in the result. However, you can add entries from the
|
2646
|
+
# department field to boost documents with those values higher.
|
2647
|
+
#
|
2648
|
+
# For example, you can add entries to the map with names of
|
2649
|
+
# departments. If you add "HR",5 and "Legal",3 those departments
|
2650
|
+
# are given special attention when they appear in the metadata of a
|
2651
|
+
# document. When those terms appear they are given the specified
|
2652
|
+
# importance instead of the regular importance for the boost.
|
2653
|
+
# @return [Hash<String,Integer>]
|
2654
|
+
#
|
2655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Relevance AWS API Documentation
|
2656
|
+
#
|
2657
|
+
class Relevance < Struct.new(
|
2658
|
+
:freshness,
|
2659
|
+
:importance,
|
2660
|
+
:duration,
|
2661
|
+
:rank_order,
|
2662
|
+
:value_importance_map)
|
2663
|
+
include Aws::Structure
|
2664
|
+
end
|
2665
|
+
|
2666
|
+
# Provides feedback on how relevant a document is to a search. Your
|
2667
|
+
# application uses the SubmitFeedback operation to provide relevance
|
2668
|
+
# information.
|
2669
|
+
#
|
2670
|
+
# @note When making an API call, you may pass RelevanceFeedback
|
2671
|
+
# data as a hash:
|
2672
|
+
#
|
2673
|
+
# {
|
2674
|
+
# result_id: "ResultId", # required
|
2675
|
+
# relevance_value: "RELEVANT", # required, accepts RELEVANT, NOT_RELEVANT
|
2676
|
+
# }
|
2677
|
+
#
|
2678
|
+
# @!attribute [rw] result_id
|
2679
|
+
# The unique identifier of the search result that the user provided
|
2680
|
+
# relevance feedback for.
|
2681
|
+
# @return [String]
|
2682
|
+
#
|
2683
|
+
# @!attribute [rw] relevance_value
|
2684
|
+
# Whether to document was relevant or not relevant to the search.
|
2685
|
+
# @return [String]
|
2686
|
+
#
|
2687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RelevanceFeedback AWS API Documentation
|
2688
|
+
#
|
2689
|
+
class RelevanceFeedback < Struct.new(
|
2690
|
+
:result_id,
|
2691
|
+
:relevance_value)
|
2692
|
+
include Aws::Structure
|
2693
|
+
end
|
2694
|
+
|
2695
|
+
# @!attribute [rw] message
|
2696
|
+
# @return [String]
|
2697
|
+
#
|
2698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceAlreadyExistException AWS API Documentation
|
2699
|
+
#
|
2700
|
+
class ResourceAlreadyExistException < Struct.new(
|
2701
|
+
:message)
|
2702
|
+
include Aws::Structure
|
2703
|
+
end
|
2704
|
+
|
2705
|
+
# @!attribute [rw] message
|
2706
|
+
# @return [String]
|
2707
|
+
#
|
2708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceInUseException AWS API Documentation
|
2709
|
+
#
|
2710
|
+
class ResourceInUseException < Struct.new(
|
2711
|
+
:message)
|
2712
|
+
include Aws::Structure
|
2713
|
+
end
|
2714
|
+
|
2715
|
+
# @!attribute [rw] message
|
2716
|
+
# @return [String]
|
2717
|
+
#
|
2718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceNotFoundException AWS API Documentation
|
2719
|
+
#
|
2720
|
+
class ResourceNotFoundException < Struct.new(
|
2721
|
+
:message)
|
2722
|
+
include Aws::Structure
|
2723
|
+
end
|
2724
|
+
|
2725
|
+
# @!attribute [rw] message
|
2726
|
+
# @return [String]
|
2727
|
+
#
|
2728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceUnavailableException AWS API Documentation
|
2729
|
+
#
|
2730
|
+
class ResourceUnavailableException < Struct.new(
|
2731
|
+
:message)
|
2732
|
+
include Aws::Structure
|
2733
|
+
end
|
2734
|
+
|
2735
|
+
# Provides configuration information for a data source to index
|
2736
|
+
# documents in an Amazon S3 bucket.
|
2737
|
+
#
|
2738
|
+
# @note When making an API call, you may pass S3DataSourceConfiguration
|
2739
|
+
# data as a hash:
|
2740
|
+
#
|
2741
|
+
# {
|
2742
|
+
# bucket_name: "S3BucketName", # required
|
2743
|
+
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
2744
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2745
|
+
# documents_metadata_configuration: {
|
2746
|
+
# s3_prefix: "S3ObjectKey",
|
2747
|
+
# },
|
2748
|
+
# access_control_list_configuration: {
|
2749
|
+
# key_path: "S3ObjectKey",
|
2750
|
+
# },
|
2751
|
+
# }
|
2752
|
+
#
|
2753
|
+
# @!attribute [rw] bucket_name
|
2754
|
+
# The name of the bucket that contains the documents.
|
2755
|
+
# @return [String]
|
2756
|
+
#
|
2757
|
+
# @!attribute [rw] inclusion_prefixes
|
2758
|
+
# A list of S3 prefixes for the documents that should be included in
|
2759
|
+
# the index.
|
2760
|
+
# @return [Array<String>]
|
2761
|
+
#
|
2762
|
+
# @!attribute [rw] exclusion_patterns
|
2763
|
+
# A list of glob patterns for documents that should not be indexed. If
|
2764
|
+
# a document that matches an inclusion prefix also matches an
|
2765
|
+
# exclusion pattern, the document is not indexed.
|
2766
|
+
#
|
2767
|
+
# For more information about glob patterns, see [glob
|
2768
|
+
# (programming)][1] in *Wikipedia*.
|
2769
|
+
#
|
2770
|
+
#
|
2771
|
+
#
|
2772
|
+
# [1]: http://wikipedia.org/wiki/Glob_%28programming529
|
2773
|
+
# @return [Array<String>]
|
2774
|
+
#
|
2775
|
+
# @!attribute [rw] documents_metadata_configuration
|
2776
|
+
# Document metadata files that contain information such as the
|
2777
|
+
# document access control information, source URI, document author,
|
2778
|
+
# and custom attributes. Each metadata file contains metadata about a
|
2779
|
+
# single document.
|
2780
|
+
# @return [Types::DocumentsMetadataConfiguration]
|
2781
|
+
#
|
2782
|
+
# @!attribute [rw] access_control_list_configuration
|
2783
|
+
# Provides the path to the S3 bucket that contains the user context
|
2784
|
+
# filtering files for the data source.
|
2785
|
+
# @return [Types::AccessControlListConfiguration]
|
2786
|
+
#
|
2787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3DataSourceConfiguration AWS API Documentation
|
2788
|
+
#
|
2789
|
+
class S3DataSourceConfiguration < Struct.new(
|
2790
|
+
:bucket_name,
|
2791
|
+
:inclusion_prefixes,
|
2792
|
+
:exclusion_patterns,
|
2793
|
+
:documents_metadata_configuration,
|
2794
|
+
:access_control_list_configuration)
|
2795
|
+
include Aws::Structure
|
2796
|
+
end
|
2797
|
+
|
2798
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
2799
|
+
#
|
2800
|
+
# @note When making an API call, you may pass S3Path
|
2801
|
+
# data as a hash:
|
2802
|
+
#
|
2803
|
+
# {
|
2804
|
+
# bucket: "S3BucketName", # required
|
2805
|
+
# key: "S3ObjectKey", # required
|
2806
|
+
# }
|
2807
|
+
#
|
2808
|
+
# @!attribute [rw] bucket
|
2809
|
+
# The name of the S3 bucket that contains the file.
|
2810
|
+
# @return [String]
|
2811
|
+
#
|
2812
|
+
# @!attribute [rw] key
|
2813
|
+
# The name of the file.
|
2814
|
+
# @return [String]
|
2815
|
+
#
|
2816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3Path AWS API Documentation
|
2817
|
+
#
|
2818
|
+
class S3Path < Struct.new(
|
2819
|
+
:bucket,
|
2820
|
+
:key)
|
2821
|
+
include Aws::Structure
|
2822
|
+
end
|
2823
|
+
|
2824
|
+
# Provides information about how a custom index field is used during a
|
2825
|
+
# search.
|
2826
|
+
#
|
2827
|
+
# @note When making an API call, you may pass Search
|
2828
|
+
# data as a hash:
|
2829
|
+
#
|
2830
|
+
# {
|
2831
|
+
# facetable: false,
|
2832
|
+
# searchable: false,
|
2833
|
+
# displayable: false,
|
2834
|
+
# }
|
2835
|
+
#
|
2836
|
+
# @!attribute [rw] facetable
|
2837
|
+
# Indicates that the field can be used to create search facets, a
|
2838
|
+
# count of results for each value in the field. The default is `false`
|
2839
|
+
# .
|
2840
|
+
# @return [Boolean]
|
2841
|
+
#
|
2842
|
+
# @!attribute [rw] searchable
|
2843
|
+
# Determines whether the field is used in the search. If the
|
2844
|
+
# `Searchable` field is `true`, you can use relevance tuning to
|
2845
|
+
# manually tune how Amazon Kendra weights the field in the search. The
|
2846
|
+
# default is `true` for string fields and `false` for number and date
|
2847
|
+
# fields.
|
2848
|
+
# @return [Boolean]
|
2849
|
+
#
|
2850
|
+
# @!attribute [rw] displayable
|
2851
|
+
# Determines whether the field is returned in the query response. The
|
2852
|
+
# default is `true`.
|
2853
|
+
# @return [Boolean]
|
2854
|
+
#
|
2855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search AWS API Documentation
|
2856
|
+
#
|
2857
|
+
class Search < Struct.new(
|
2858
|
+
:facetable,
|
2859
|
+
:searchable,
|
2860
|
+
:displayable)
|
2861
|
+
include Aws::Structure
|
2862
|
+
end
|
2863
|
+
|
2864
|
+
# Provides the identifier of the KMS key used to encrypt data indexed by
|
2865
|
+
# Amazon Kendra.
|
2866
|
+
#
|
2867
|
+
# @note When making an API call, you may pass ServerSideEncryptionConfiguration
|
2868
|
+
# data as a hash:
|
2869
|
+
#
|
2870
|
+
# {
|
2871
|
+
# kms_key_id: "KmsKeyId",
|
2872
|
+
# }
|
2873
|
+
#
|
2874
|
+
# @!attribute [rw] kms_key_id
|
2875
|
+
# The identifier of the KMS key.
|
2876
|
+
# @return [String]
|
2877
|
+
#
|
2878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServerSideEncryptionConfiguration AWS API Documentation
|
2879
|
+
#
|
2880
|
+
class ServerSideEncryptionConfiguration < Struct.new(
|
2881
|
+
:kms_key_id)
|
2882
|
+
include Aws::Structure
|
2883
|
+
end
|
2884
|
+
|
2885
|
+
# @!attribute [rw] message
|
2886
|
+
# @return [String]
|
2887
|
+
#
|
2888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceQuotaExceededException AWS API Documentation
|
2889
|
+
#
|
2890
|
+
class ServiceQuotaExceededException < Struct.new(
|
2891
|
+
:message)
|
2892
|
+
include Aws::Structure
|
2893
|
+
end
|
2894
|
+
|
2895
|
+
# Provides configuration information for connecting to a Microsoft
|
2896
|
+
# SharePoint data source.
|
2897
|
+
#
|
2898
|
+
# @note When making an API call, you may pass SharePointConfiguration
|
2899
|
+
# data as a hash:
|
2900
|
+
#
|
2901
|
+
# {
|
2902
|
+
# share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
|
2903
|
+
# urls: ["Url"], # required
|
2904
|
+
# secret_arn: "SecretArn", # required
|
2905
|
+
# crawl_attachments: false,
|
2906
|
+
# vpc_configuration: {
|
2907
|
+
# subnet_ids: ["SubnetId"], # required
|
2908
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2909
|
+
# },
|
2910
|
+
# field_mappings: [
|
2911
|
+
# {
|
2912
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2913
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2914
|
+
# index_field_name: "IndexFieldName", # required
|
2915
|
+
# },
|
2916
|
+
# ],
|
2917
|
+
# }
|
2918
|
+
#
|
2919
|
+
# @!attribute [rw] share_point_version
|
2920
|
+
# The version of Microsoft SharePoint that you are using as a data
|
2921
|
+
# source.
|
2922
|
+
# @return [String]
|
2923
|
+
#
|
2924
|
+
# @!attribute [rw] urls
|
2925
|
+
# The URLs of the Microsoft SharePoint site that contains the
|
2926
|
+
# documents that should be indexed.
|
2927
|
+
# @return [Array<String>]
|
2928
|
+
#
|
2929
|
+
# @!attribute [rw] secret_arn
|
2930
|
+
# The Amazon Resource Name (ARN) of credentials stored in AWS Secrets
|
2931
|
+
# Manager. The credentials should be a user/password pair. For more
|
2932
|
+
# information, see [Using a Microsoft SharePoint Data Source][1]. For
|
2933
|
+
# more information about AWS Secrets Manager, see [ What Is AWS
|
2934
|
+
# Secrets Manager ][2] in the *AWS Secrets Manager* user guide.
|
2935
|
+
#
|
2936
|
+
#
|
2937
|
+
#
|
2938
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
|
2939
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
|
2940
|
+
# @return [String]
|
2941
|
+
#
|
2942
|
+
# @!attribute [rw] crawl_attachments
|
2943
|
+
# `TRUE` to include attachments to documents stored in your Microsoft
|
2944
|
+
# SharePoint site in the index; otherwise, `FALSE`.
|
2945
|
+
# @return [Boolean]
|
2946
|
+
#
|
2947
|
+
# @!attribute [rw] vpc_configuration
|
2948
|
+
# Provides information for connecting to an Amazon VPC.
|
2949
|
+
# @return [Types::DataSourceVpcConfiguration]
|
2950
|
+
#
|
2951
|
+
# @!attribute [rw] field_mappings
|
2952
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
|
2953
|
+
# SharePoint attributes to custom fields in the Amazon Kendra index.
|
2954
|
+
# You must first create the index fields using the operation before
|
2955
|
+
# you map SharePoint attributes. For more information, see [Mapping
|
2956
|
+
# Data Source Fields][1].
|
2957
|
+
#
|
2958
|
+
#
|
2959
|
+
#
|
2960
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
2961
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
2962
|
+
#
|
2963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
|
2964
|
+
#
|
2965
|
+
class SharePointConfiguration < Struct.new(
|
2966
|
+
:share_point_version,
|
2967
|
+
:urls,
|
2968
|
+
:secret_arn,
|
2969
|
+
:crawl_attachments,
|
2970
|
+
:vpc_configuration,
|
2971
|
+
:field_mappings)
|
2972
|
+
include Aws::Structure
|
2973
|
+
end
|
2974
|
+
|
2975
|
+
# @note When making an API call, you may pass StartDataSourceSyncJobRequest
|
2976
|
+
# data as a hash:
|
2977
|
+
#
|
2978
|
+
# {
|
2979
|
+
# id: "DataSourceId", # required
|
2980
|
+
# index_id: "IndexId", # required
|
2981
|
+
# }
|
2982
|
+
#
|
2983
|
+
# @!attribute [rw] id
|
2984
|
+
# The identifier of the data source to synchronize.
|
2985
|
+
# @return [String]
|
2986
|
+
#
|
2987
|
+
# @!attribute [rw] index_id
|
2988
|
+
# The identifier of the index that contains the data source.
|
2989
|
+
# @return [String]
|
2990
|
+
#
|
2991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJobRequest AWS API Documentation
|
2992
|
+
#
|
2993
|
+
class StartDataSourceSyncJobRequest < Struct.new(
|
2994
|
+
:id,
|
2995
|
+
:index_id)
|
2996
|
+
include Aws::Structure
|
2997
|
+
end
|
2998
|
+
|
2999
|
+
# @!attribute [rw] execution_id
|
3000
|
+
# Identifies a particular synchronization job.
|
3001
|
+
# @return [String]
|
3002
|
+
#
|
3003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJobResponse AWS API Documentation
|
3004
|
+
#
|
3005
|
+
class StartDataSourceSyncJobResponse < Struct.new(
|
3006
|
+
:execution_id)
|
3007
|
+
include Aws::Structure
|
3008
|
+
end
|
3009
|
+
|
3010
|
+
# @note When making an API call, you may pass StopDataSourceSyncJobRequest
|
3011
|
+
# data as a hash:
|
3012
|
+
#
|
3013
|
+
# {
|
3014
|
+
# id: "DataSourceId", # required
|
3015
|
+
# index_id: "IndexId", # required
|
3016
|
+
# }
|
3017
|
+
#
|
3018
|
+
# @!attribute [rw] id
|
3019
|
+
# The identifier of the data source for which to stop the
|
3020
|
+
# synchronization jobs.
|
3021
|
+
# @return [String]
|
3022
|
+
#
|
3023
|
+
# @!attribute [rw] index_id
|
3024
|
+
# The identifier of the index that contains the data source.
|
3025
|
+
# @return [String]
|
3026
|
+
#
|
3027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJobRequest AWS API Documentation
|
3028
|
+
#
|
3029
|
+
class StopDataSourceSyncJobRequest < Struct.new(
|
3030
|
+
:id,
|
3031
|
+
:index_id)
|
3032
|
+
include Aws::Structure
|
3033
|
+
end
|
3034
|
+
|
3035
|
+
# @note When making an API call, you may pass SubmitFeedbackRequest
|
3036
|
+
# data as a hash:
|
3037
|
+
#
|
3038
|
+
# {
|
3039
|
+
# index_id: "IndexId", # required
|
3040
|
+
# query_id: "QueryId", # required
|
3041
|
+
# click_feedback_items: [
|
3042
|
+
# {
|
3043
|
+
# result_id: "ResultId", # required
|
3044
|
+
# click_time: Time.now, # required
|
3045
|
+
# },
|
3046
|
+
# ],
|
3047
|
+
# relevance_feedback_items: [
|
3048
|
+
# {
|
3049
|
+
# result_id: "ResultId", # required
|
3050
|
+
# relevance_value: "RELEVANT", # required, accepts RELEVANT, NOT_RELEVANT
|
3051
|
+
# },
|
3052
|
+
# ],
|
3053
|
+
# }
|
3054
|
+
#
|
3055
|
+
# @!attribute [rw] index_id
|
3056
|
+
# The identifier of the index that was queried.
|
3057
|
+
# @return [String]
|
3058
|
+
#
|
3059
|
+
# @!attribute [rw] query_id
|
3060
|
+
# The identifier of the specific query for which you are submitting
|
3061
|
+
# feedback. The query ID is returned in the response to the operation.
|
3062
|
+
# @return [String]
|
3063
|
+
#
|
3064
|
+
# @!attribute [rw] click_feedback_items
|
3065
|
+
# Tells Amazon Kendra that a particular search result link was chosen
|
3066
|
+
# by the user.
|
3067
|
+
# @return [Array<Types::ClickFeedback>]
|
3068
|
+
#
|
3069
|
+
# @!attribute [rw] relevance_feedback_items
|
3070
|
+
# Provides Amazon Kendra with relevant or not relevant feedback for
|
3071
|
+
# whether a particular item was relevant to the search.
|
3072
|
+
# @return [Array<Types::RelevanceFeedback>]
|
3073
|
+
#
|
3074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedbackRequest AWS API Documentation
|
3075
|
+
#
|
3076
|
+
class SubmitFeedbackRequest < Struct.new(
|
3077
|
+
:index_id,
|
3078
|
+
:query_id,
|
3079
|
+
:click_feedback_items,
|
3080
|
+
:relevance_feedback_items)
|
3081
|
+
include Aws::Structure
|
3082
|
+
end
|
3083
|
+
|
3084
|
+
# Provides information about text documents indexed in an index.
|
3085
|
+
#
|
3086
|
+
# @!attribute [rw] indexed_text_documents_count
|
3087
|
+
# The number of text documents indexed.
|
3088
|
+
# @return [Integer]
|
3089
|
+
#
|
3090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TextDocumentStatistics AWS API Documentation
|
3091
|
+
#
|
3092
|
+
class TextDocumentStatistics < Struct.new(
|
3093
|
+
:indexed_text_documents_count)
|
3094
|
+
include Aws::Structure
|
3095
|
+
end
|
3096
|
+
|
3097
|
+
# Provides text and information about where to highlight the text.
|
3098
|
+
#
|
3099
|
+
# @!attribute [rw] text
|
3100
|
+
# The text to display to the user.
|
3101
|
+
# @return [String]
|
3102
|
+
#
|
3103
|
+
# @!attribute [rw] highlights
|
3104
|
+
# The beginning and end of the text that should be highlighted.
|
3105
|
+
# @return [Array<Types::Highlight>]
|
3106
|
+
#
|
3107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TextWithHighlights AWS API Documentation
|
3108
|
+
#
|
3109
|
+
class TextWithHighlights < Struct.new(
|
3110
|
+
:text,
|
3111
|
+
:highlights)
|
3112
|
+
include Aws::Structure
|
3113
|
+
end
|
3114
|
+
|
3115
|
+
# @!attribute [rw] message
|
3116
|
+
# @return [String]
|
3117
|
+
#
|
3118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ThrottlingException AWS API Documentation
|
3119
|
+
#
|
3120
|
+
class ThrottlingException < Struct.new(
|
3121
|
+
:message)
|
3122
|
+
include Aws::Structure
|
3123
|
+
end
|
3124
|
+
|
3125
|
+
# Provides a range of time.
|
3126
|
+
#
|
3127
|
+
# @note When making an API call, you may pass TimeRange
|
3128
|
+
# data as a hash:
|
3129
|
+
#
|
3130
|
+
# {
|
3131
|
+
# start_time: Time.now,
|
3132
|
+
# end_time: Time.now,
|
3133
|
+
# }
|
3134
|
+
#
|
3135
|
+
# @!attribute [rw] start_time
|
3136
|
+
# The UNIX datetime of the beginning of the time range.
|
3137
|
+
# @return [Time]
|
3138
|
+
#
|
3139
|
+
# @!attribute [rw] end_time
|
3140
|
+
# The UNIX datetime of the end of the time range.
|
3141
|
+
# @return [Time]
|
3142
|
+
#
|
3143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TimeRange AWS API Documentation
|
3144
|
+
#
|
3145
|
+
class TimeRange < Struct.new(
|
3146
|
+
:start_time,
|
3147
|
+
:end_time)
|
3148
|
+
include Aws::Structure
|
3149
|
+
end
|
3150
|
+
|
3151
|
+
# @note When making an API call, you may pass UpdateDataSourceRequest
|
3152
|
+
# data as a hash:
|
3153
|
+
#
|
3154
|
+
# {
|
3155
|
+
# id: "DataSourceId", # required
|
3156
|
+
# name: "DataSourceName",
|
3157
|
+
# index_id: "IndexId", # required
|
3158
|
+
# configuration: {
|
3159
|
+
# s3_configuration: {
|
3160
|
+
# bucket_name: "S3BucketName", # required
|
3161
|
+
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
3162
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3163
|
+
# documents_metadata_configuration: {
|
3164
|
+
# s3_prefix: "S3ObjectKey",
|
3165
|
+
# },
|
3166
|
+
# access_control_list_configuration: {
|
3167
|
+
# key_path: "S3ObjectKey",
|
3168
|
+
# },
|
3169
|
+
# },
|
3170
|
+
# share_point_configuration: {
|
3171
|
+
# share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
|
3172
|
+
# urls: ["Url"], # required
|
3173
|
+
# secret_arn: "SecretArn", # required
|
3174
|
+
# crawl_attachments: false,
|
3175
|
+
# vpc_configuration: {
|
3176
|
+
# subnet_ids: ["SubnetId"], # required
|
3177
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3178
|
+
# },
|
3179
|
+
# field_mappings: [
|
3180
|
+
# {
|
3181
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3182
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3183
|
+
# index_field_name: "IndexFieldName", # required
|
3184
|
+
# },
|
3185
|
+
# ],
|
3186
|
+
# },
|
3187
|
+
# database_configuration: {
|
3188
|
+
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
3189
|
+
# connection_configuration: { # required
|
3190
|
+
# database_host: "DatabaseHost", # required
|
3191
|
+
# database_port: 1, # required
|
3192
|
+
# database_name: "DatabaseName", # required
|
3193
|
+
# table_name: "TableName", # required
|
3194
|
+
# secret_arn: "SecretArn", # required
|
3195
|
+
# },
|
3196
|
+
# vpc_configuration: {
|
3197
|
+
# subnet_ids: ["SubnetId"], # required
|
3198
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3199
|
+
# },
|
3200
|
+
# column_configuration: { # required
|
3201
|
+
# document_id_column_name: "ColumnName", # required
|
3202
|
+
# document_data_column_name: "ColumnName", # required
|
3203
|
+
# document_title_column_name: "ColumnName",
|
3204
|
+
# field_mappings: [
|
3205
|
+
# {
|
3206
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3207
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3208
|
+
# index_field_name: "IndexFieldName", # required
|
3209
|
+
# },
|
3210
|
+
# ],
|
3211
|
+
# change_detecting_columns: ["ColumnName"], # required
|
3212
|
+
# },
|
3213
|
+
# acl_configuration: {
|
3214
|
+
# allowed_groups_column_name: "ColumnName", # required
|
3215
|
+
# },
|
3216
|
+
# },
|
3217
|
+
# },
|
3218
|
+
# description: "Description",
|
3219
|
+
# schedule: "ScanSchedule",
|
3220
|
+
# role_arn: "RoleArn",
|
3221
|
+
# }
|
3222
|
+
#
|
3223
|
+
# @!attribute [rw] id
|
3224
|
+
# The unique identifier of the data source to update.
|
3225
|
+
# @return [String]
|
3226
|
+
#
|
3227
|
+
# @!attribute [rw] name
|
3228
|
+
# The name of the data source to update. The name of the data source
|
3229
|
+
# can't be updated. To rename a data source you must delete the data
|
3230
|
+
# source and re-create it.
|
3231
|
+
# @return [String]
|
3232
|
+
#
|
3233
|
+
# @!attribute [rw] index_id
|
3234
|
+
# The identifier of the index that contains the data source to update.
|
3235
|
+
# @return [String]
|
3236
|
+
#
|
3237
|
+
# @!attribute [rw] configuration
|
3238
|
+
# Configuration information for a Amazon Kendra data source.
|
3239
|
+
# @return [Types::DataSourceConfiguration]
|
3240
|
+
#
|
3241
|
+
# @!attribute [rw] description
|
3242
|
+
# The new description for the data source.
|
3243
|
+
# @return [String]
|
3244
|
+
#
|
3245
|
+
# @!attribute [rw] schedule
|
3246
|
+
# The new update schedule for the data source.
|
3247
|
+
# @return [String]
|
3248
|
+
#
|
3249
|
+
# @!attribute [rw] role_arn
|
3250
|
+
# The Amazon Resource Name (ARN) of the new role to use when the data
|
3251
|
+
# source is accessing resources on your behalf.
|
3252
|
+
# @return [String]
|
3253
|
+
#
|
3254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSourceRequest AWS API Documentation
|
3255
|
+
#
|
3256
|
+
class UpdateDataSourceRequest < Struct.new(
|
3257
|
+
:id,
|
3258
|
+
:name,
|
3259
|
+
:index_id,
|
3260
|
+
:configuration,
|
3261
|
+
:description,
|
3262
|
+
:schedule,
|
3263
|
+
:role_arn)
|
3264
|
+
include Aws::Structure
|
3265
|
+
end
|
3266
|
+
|
3267
|
+
# @note When making an API call, you may pass UpdateIndexRequest
|
3268
|
+
# data as a hash:
|
3269
|
+
#
|
3270
|
+
# {
|
3271
|
+
# id: "IndexId", # required
|
3272
|
+
# name: "IndexName",
|
3273
|
+
# role_arn: "RoleArn",
|
3274
|
+
# description: "Description",
|
3275
|
+
# document_metadata_configuration_updates: [
|
3276
|
+
# {
|
3277
|
+
# name: "DocumentMetadataConfigurationName", # required
|
3278
|
+
# type: "STRING_VALUE", # required, accepts STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE
|
3279
|
+
# relevance: {
|
3280
|
+
# freshness: false,
|
3281
|
+
# importance: 1,
|
3282
|
+
# duration: "Duration",
|
3283
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
3284
|
+
# value_importance_map: {
|
3285
|
+
# "ValueImportanceMapKey" => 1,
|
3286
|
+
# },
|
3287
|
+
# },
|
3288
|
+
# search: {
|
3289
|
+
# facetable: false,
|
3290
|
+
# searchable: false,
|
3291
|
+
# displayable: false,
|
3292
|
+
# },
|
3293
|
+
# },
|
3294
|
+
# ],
|
3295
|
+
# }
|
3296
|
+
#
|
3297
|
+
# @!attribute [rw] id
|
3298
|
+
# The identifier of the index to update.
|
3299
|
+
# @return [String]
|
3300
|
+
#
|
3301
|
+
# @!attribute [rw] name
|
3302
|
+
# The name of the index to update.
|
3303
|
+
# @return [String]
|
3304
|
+
#
|
3305
|
+
# @!attribute [rw] role_arn
|
3306
|
+
# A new IAM role that gives Amazon Kendra permission to access your
|
3307
|
+
# Amazon CloudWatch logs.
|
3308
|
+
# @return [String]
|
3309
|
+
#
|
3310
|
+
# @!attribute [rw] description
|
3311
|
+
# A new description for the index.
|
3312
|
+
# @return [String]
|
3313
|
+
#
|
3314
|
+
# @!attribute [rw] document_metadata_configuration_updates
|
3315
|
+
# The document metadata to update.
|
3316
|
+
# @return [Array<Types::DocumentMetadataConfiguration>]
|
3317
|
+
#
|
3318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndexRequest AWS API Documentation
|
3319
|
+
#
|
3320
|
+
class UpdateIndexRequest < Struct.new(
|
3321
|
+
:id,
|
3322
|
+
:name,
|
3323
|
+
:role_arn,
|
3324
|
+
:description,
|
3325
|
+
:document_metadata_configuration_updates)
|
3326
|
+
include Aws::Structure
|
3327
|
+
end
|
3328
|
+
|
3329
|
+
# @!attribute [rw] message
|
3330
|
+
# @return [String]
|
3331
|
+
#
|
3332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ValidationException AWS API Documentation
|
3333
|
+
#
|
3334
|
+
class ValidationException < Struct.new(
|
3335
|
+
:message)
|
3336
|
+
include Aws::Structure
|
3337
|
+
end
|
3338
|
+
|
3339
|
+
end
|
3340
|
+
end
|