aws-sdk-kendra 1.22.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +22 -14
- data/lib/aws-sdk-kendra/client_api.rb +4 -0
- data/lib/aws-sdk-kendra/types.rb +94 -33
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 13ef9deb75aa3e25a0f22eb8f435dc97249bbb0a9c8620310bcbccae155309ce
|
4
|
+
data.tar.gz: 32b19f5f2b1295864ebc017073de00eded9ef29f7385db7ebe114d3b2d085143
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ed3c5d1d147b776e2b8e177b2f0de93dcb226d0cb8a56f1de887e33811fd85cb43dedf3c38121073c0130425450f72e3032b4eb352a3ec923a60a900c9565f1f
|
7
|
+
data.tar.gz: '0996fde8b0b7b298047a6a5d98e6d08d6b396288b9405c6f25be384cad828b34e073691f4857df3181624d4eecff36867457c1dad33199a3c4b6b477497d7c82'
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.23.0 (2021-04-01)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS Kendra's ServiceNow data source now supports OAuth 2.0 authentication and knowledge article filtering via a ServiceNow query.
|
8
|
+
|
4
9
|
1.22.0 (2021-03-10)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.23.0
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -338,10 +338,10 @@ module Aws::Kendra
|
|
338
338
|
# @!group API Operations
|
339
339
|
|
340
340
|
# Removes one or more documents from an index. The documents must have
|
341
|
-
# been added with the BatchPutDocument operation.
|
341
|
+
# been added with the `BatchPutDocument` operation.
|
342
342
|
#
|
343
343
|
# The documents are deleted asynchronously. You can see the progress of
|
344
|
-
# the deletion by using AWS CloudWatch. Any error messages
|
344
|
+
# the deletion by using AWS CloudWatch. Any error messages related to
|
345
345
|
# the processing of the batch are sent to you CloudWatch log.
|
346
346
|
#
|
347
347
|
# @option params [required, String] :index_id
|
@@ -398,7 +398,7 @@ module Aws::Kendra
|
|
398
398
|
#
|
399
399
|
# @option params [required, String] :index_id
|
400
400
|
# The identifier of the index to add the documents to. You need to
|
401
|
-
# create the index first using the CreateIndex operation.
|
401
|
+
# create the index first using the `CreateIndex` operation.
|
402
402
|
#
|
403
403
|
# @option params [String] :role_arn
|
404
404
|
# The Amazon Resource Name (ARN) of a role that is allowed to run the
|
@@ -744,6 +744,7 @@ module Aws::Kendra
|
|
744
744
|
# index_field_name: "IndexFieldName", # required
|
745
745
|
# },
|
746
746
|
# ],
|
747
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
747
748
|
# },
|
748
749
|
# service_catalog_configuration: {
|
749
750
|
# crawl_attachments: false,
|
@@ -759,6 +760,7 @@ module Aws::Kendra
|
|
759
760
|
# },
|
760
761
|
# ],
|
761
762
|
# },
|
763
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
762
764
|
# },
|
763
765
|
# confluence_configuration: {
|
764
766
|
# server_url: "Url", # required
|
@@ -944,11 +946,12 @@ module Aws::Kendra
|
|
944
946
|
|
945
947
|
# Creates a new Amazon Kendra index. Index creation is an asynchronous
|
946
948
|
# operation. To determine if index creation has completed, check the
|
947
|
-
# `Status` field returned from a call to
|
948
|
-
# `ACTIVE` when the index is ready to use.
|
949
|
+
# `Status` field returned from a call to `DescribeIndex`. The `Status`
|
950
|
+
# field is set to `ACTIVE` when the index is ready to use.
|
949
951
|
#
|
950
952
|
# Once the index is active you can index your documents using the
|
951
|
-
# operation or using one of the supported data
|
953
|
+
# `BatchPutDocument` operation or using one of the supported data
|
954
|
+
# sources.
|
952
955
|
#
|
953
956
|
# @option params [required, String] :name
|
954
957
|
# The name for the new index.
|
@@ -1134,9 +1137,9 @@ module Aws::Kendra
|
|
1134
1137
|
|
1135
1138
|
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
1136
1139
|
# the data source is already being deleted. While the data source is
|
1137
|
-
# being deleted, the `Status` field returned by a call to the
|
1138
|
-
# is set to `DELETING`. For more
|
1139
|
-
# Sources][1].
|
1140
|
+
# being deleted, the `Status` field returned by a call to the
|
1141
|
+
# `DescribeDataSource` operation is set to `DELETING`. For more
|
1142
|
+
# information, see [Deleting Data Sources][1].
|
1140
1143
|
#
|
1141
1144
|
#
|
1142
1145
|
#
|
@@ -1194,7 +1197,7 @@ module Aws::Kendra
|
|
1194
1197
|
|
1195
1198
|
# Deletes an existing Amazon Kendra index. An exception is not thrown if
|
1196
1199
|
# the index is already being deleted. While the index is being deleted,
|
1197
|
-
# the `Status` field returned by a call to the DescribeIndex operation
|
1200
|
+
# the `Status` field returned by a call to the `DescribeIndex` operation
|
1198
1201
|
# is set to `DELETING`.
|
1199
1202
|
#
|
1200
1203
|
# @option params [required, String] :id
|
@@ -1402,6 +1405,7 @@ module Aws::Kendra
|
|
1402
1405
|
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
|
1403
1406
|
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
|
1404
1407
|
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
|
1408
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.filter_query #=> String
|
1405
1409
|
# resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
|
1406
1410
|
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
|
1407
1411
|
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
|
@@ -1413,6 +1417,7 @@ module Aws::Kendra
|
|
1413
1417
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1414
1418
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1415
1419
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
1420
|
+
# resp.configuration.service_now_configuration.authentication_type #=> String, one of "HTTP_BASIC", "OAUTH2"
|
1416
1421
|
# resp.configuration.confluence_configuration.server_url #=> String
|
1417
1422
|
# resp.configuration.confluence_configuration.secret_arn #=> String
|
1418
1423
|
# resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
|
@@ -1984,7 +1989,7 @@ module Aws::Kendra
|
|
1984
1989
|
#
|
1985
1990
|
# @option params [required, String] :index_id
|
1986
1991
|
# The unique identifier of the index to search. The identifier is
|
1987
|
-
# returned in the response from the operation.
|
1992
|
+
# returned in the response from the `CreateIndex` operation.
|
1988
1993
|
#
|
1989
1994
|
# @option params [required, String] :query_text
|
1990
1995
|
# The text to search for.
|
@@ -2280,7 +2285,8 @@ module Aws::Kendra
|
|
2280
2285
|
#
|
2281
2286
|
# @option params [required, String] :query_id
|
2282
2287
|
# The identifier of the specific query for which you are submitting
|
2283
|
-
# feedback. The query ID is returned in the response to the
|
2288
|
+
# feedback. The query ID is returned in the response to the `Query`
|
2289
|
+
# operation.
|
2284
2290
|
#
|
2285
2291
|
# @option params [Array<Types::ClickFeedback>] :click_feedback_items
|
2286
2292
|
# Tells Amazon Kendra that a particular search result link was chosen by
|
@@ -2594,6 +2600,7 @@ module Aws::Kendra
|
|
2594
2600
|
# index_field_name: "IndexFieldName", # required
|
2595
2601
|
# },
|
2596
2602
|
# ],
|
2603
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
2597
2604
|
# },
|
2598
2605
|
# service_catalog_configuration: {
|
2599
2606
|
# crawl_attachments: false,
|
@@ -2609,6 +2616,7 @@ module Aws::Kendra
|
|
2609
2616
|
# },
|
2610
2617
|
# ],
|
2611
2618
|
# },
|
2619
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
2612
2620
|
# },
|
2613
2621
|
# confluence_configuration: {
|
2614
2622
|
# server_url: "Url", # required
|
@@ -2711,7 +2719,7 @@ module Aws::Kendra
|
|
2711
2719
|
# The document metadata to update.
|
2712
2720
|
#
|
2713
2721
|
# @option params [Types::CapacityUnitsConfiguration] :capacity_units
|
2714
|
-
# Sets the number of
|
2722
|
+
# Sets the number of additional storage and query capacity units that
|
2715
2723
|
# should be used by the index. You can change the capacity of the index
|
2716
2724
|
# up to 5 times per day.
|
2717
2725
|
#
|
@@ -2845,7 +2853,7 @@ module Aws::Kendra
|
|
2845
2853
|
params: params,
|
2846
2854
|
config: config)
|
2847
2855
|
context[:gem_name] = 'aws-sdk-kendra'
|
2848
|
-
context[:gem_version] = '1.
|
2856
|
+
context[:gem_version] = '1.23.0'
|
2849
2857
|
Seahorse::Client::Request.new(handlers, context)
|
2850
2858
|
end
|
2851
2859
|
|
@@ -247,10 +247,12 @@ module Aws::Kendra
|
|
247
247
|
SecretArn = Shapes::StringShape.new(name: 'SecretArn')
|
248
248
|
SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
|
249
249
|
ServerSideEncryptionConfiguration = Shapes::StructureShape.new(name: 'ServerSideEncryptionConfiguration')
|
250
|
+
ServiceNowAuthenticationType = Shapes::StringShape.new(name: 'ServiceNowAuthenticationType')
|
250
251
|
ServiceNowBuildVersionType = Shapes::StringShape.new(name: 'ServiceNowBuildVersionType')
|
251
252
|
ServiceNowConfiguration = Shapes::StructureShape.new(name: 'ServiceNowConfiguration')
|
252
253
|
ServiceNowHostUrl = Shapes::StringShape.new(name: 'ServiceNowHostUrl')
|
253
254
|
ServiceNowKnowledgeArticleConfiguration = Shapes::StructureShape.new(name: 'ServiceNowKnowledgeArticleConfiguration')
|
255
|
+
ServiceNowKnowledgeArticleFilterQuery = Shapes::StringShape.new(name: 'ServiceNowKnowledgeArticleFilterQuery')
|
254
256
|
ServiceNowServiceCatalogConfiguration = Shapes::StructureShape.new(name: 'ServiceNowServiceCatalogConfiguration')
|
255
257
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
256
258
|
SharePointConfiguration = Shapes::StructureShape.new(name: 'SharePointConfiguration')
|
@@ -1003,6 +1005,7 @@ module Aws::Kendra
|
|
1003
1005
|
ServiceNowConfiguration.add_member(:service_now_build_version, Shapes::ShapeRef.new(shape: ServiceNowBuildVersionType, required: true, location_name: "ServiceNowBuildVersion"))
|
1004
1006
|
ServiceNowConfiguration.add_member(:knowledge_article_configuration, Shapes::ShapeRef.new(shape: ServiceNowKnowledgeArticleConfiguration, location_name: "KnowledgeArticleConfiguration"))
|
1005
1007
|
ServiceNowConfiguration.add_member(:service_catalog_configuration, Shapes::ShapeRef.new(shape: ServiceNowServiceCatalogConfiguration, location_name: "ServiceCatalogConfiguration"))
|
1008
|
+
ServiceNowConfiguration.add_member(:authentication_type, Shapes::ShapeRef.new(shape: ServiceNowAuthenticationType, location_name: "AuthenticationType"))
|
1006
1009
|
ServiceNowConfiguration.struct_class = Types::ServiceNowConfiguration
|
1007
1010
|
|
1008
1011
|
ServiceNowKnowledgeArticleConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
|
@@ -1011,6 +1014,7 @@ module Aws::Kendra
|
|
1011
1014
|
ServiceNowKnowledgeArticleConfiguration.add_member(:document_data_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, required: true, location_name: "DocumentDataFieldName"))
|
1012
1015
|
ServiceNowKnowledgeArticleConfiguration.add_member(:document_title_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, location_name: "DocumentTitleFieldName"))
|
1013
1016
|
ServiceNowKnowledgeArticleConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings"))
|
1017
|
+
ServiceNowKnowledgeArticleConfiguration.add_member(:filter_query, Shapes::ShapeRef.new(shape: ServiceNowKnowledgeArticleFilterQuery, location_name: "FilterQuery"))
|
1014
1018
|
ServiceNowKnowledgeArticleConfiguration.struct_class = Types::ServiceNowKnowledgeArticleConfiguration
|
1015
1019
|
|
1016
1020
|
ServiceNowServiceCatalogConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -61,7 +61,7 @@ module Aws::Kendra
|
|
61
61
|
# A list of groups, separated by semi-colons, that filters a query
|
62
62
|
# response based on user context. The document is only returned to
|
63
63
|
# users that are in one of the groups specified in the `UserContext`
|
64
|
-
# field of the Query operation.
|
64
|
+
# field of the `Query` operation.
|
65
65
|
# @return [String]
|
66
66
|
#
|
67
67
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
|
@@ -541,7 +541,7 @@ module Aws::Kendra
|
|
541
541
|
end
|
542
542
|
|
543
543
|
# Provides information about documents that could not be removed from an
|
544
|
-
# index by the BatchDeleteDocument operation.
|
544
|
+
# index by the `BatchDeleteDocument` operation.
|
545
545
|
#
|
546
546
|
# @!attribute [rw] id
|
547
547
|
# The identifier of the document that couldn't be removed from the
|
@@ -608,7 +608,7 @@ module Aws::Kendra
|
|
608
608
|
#
|
609
609
|
# @!attribute [rw] index_id
|
610
610
|
# The identifier of the index to add the documents to. You need to
|
611
|
-
# create the index first using the CreateIndex operation.
|
611
|
+
# create the index first using the `CreateIndex` operation.
|
612
612
|
# @return [String]
|
613
613
|
#
|
614
614
|
# @!attribute [rw] role_arn
|
@@ -729,7 +729,7 @@ module Aws::Kendra
|
|
729
729
|
end
|
730
730
|
|
731
731
|
# Gathers information about when a particular result was clicked by a
|
732
|
-
# user. Your application uses the SubmitFeedback operation to provide
|
732
|
+
# user. Your application uses the `SubmitFeedback` operation to provide
|
733
733
|
# click information.
|
734
734
|
#
|
735
735
|
# @note When making an API call, you may pass ClickFeedback
|
@@ -792,7 +792,7 @@ module Aws::Kendra
|
|
792
792
|
# @!attribute [rw] field_mappings
|
793
793
|
# An array of objects that map database column names to the
|
794
794
|
# corresponding fields in an index. You must first create the fields
|
795
|
-
# in the index using the UpdateIndex operation.
|
795
|
+
# in the index using the `UpdateIndex` operation.
|
796
796
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
797
797
|
#
|
798
798
|
# @!attribute [rw] change_detecting_columns
|
@@ -868,7 +868,8 @@ module Aws::Kendra
|
|
868
868
|
# Defines the mapping between a field in the Confluence data source to a
|
869
869
|
# Amazon Kendra index field.
|
870
870
|
#
|
871
|
-
# You must first create the index field using the
|
871
|
+
# You must first create the index field using the `UpdateIndex`
|
872
|
+
# operation.
|
872
873
|
#
|
873
874
|
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
874
875
|
# data as a hash:
|
@@ -882,7 +883,8 @@ module Aws::Kendra
|
|
882
883
|
# @!attribute [rw] data_source_field_name
|
883
884
|
# The name of the field in the data source.
|
884
885
|
#
|
885
|
-
# You must first create the index field using the
|
886
|
+
# You must first create the index field using the `UpdateIndex`
|
887
|
+
# operation.
|
886
888
|
# @return [String]
|
887
889
|
#
|
888
890
|
# @!attribute [rw] date_field_format
|
@@ -909,7 +911,8 @@ module Aws::Kendra
|
|
909
911
|
|
910
912
|
# Specifies the blog settings for the Confluence data source. Blogs are
|
911
913
|
# always indexed unless filtered from the index by the
|
912
|
-
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
914
|
+
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
915
|
+
# `ConfluenceConfiguration` type.
|
913
916
|
#
|
914
917
|
# @note When making an API call, you may pass ConfluenceBlogConfiguration
|
915
918
|
# data as a hash:
|
@@ -945,7 +948,8 @@ module Aws::Kendra
|
|
945
948
|
# Defines the mapping between a blog field in the Confluence data source
|
946
949
|
# to a Amazon Kendra index field.
|
947
950
|
#
|
948
|
-
# You must first create the index field using the
|
951
|
+
# You must first create the index field using the `UpdateIndex`
|
952
|
+
# operation.
|
949
953
|
#
|
950
954
|
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
951
955
|
# data as a hash:
|
@@ -1158,7 +1162,8 @@ module Aws::Kendra
|
|
1158
1162
|
# Defines the mapping between a field in the Confluence data source to a
|
1159
1163
|
# Amazon Kendra index field.
|
1160
1164
|
#
|
1161
|
-
# You must first create the index field using the
|
1165
|
+
# You must first create the index field using the `UpdateIndex`
|
1166
|
+
# operation.
|
1162
1167
|
#
|
1163
1168
|
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
1164
1169
|
# data as a hash:
|
@@ -1271,7 +1276,8 @@ module Aws::Kendra
|
|
1271
1276
|
# Defines the mapping between a field in the Confluence data source to a
|
1272
1277
|
# Amazon Kendra index field.
|
1273
1278
|
#
|
1274
|
-
# You must first create the index field using the
|
1279
|
+
# You must first create the index field using the `UpdateIndex`
|
1280
|
+
# operation.
|
1275
1281
|
#
|
1276
1282
|
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
1277
1283
|
# data as a hash:
|
@@ -1547,6 +1553,7 @@ module Aws::Kendra
|
|
1547
1553
|
# index_field_name: "IndexFieldName", # required
|
1548
1554
|
# },
|
1549
1555
|
# ],
|
1556
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
1550
1557
|
# },
|
1551
1558
|
# service_catalog_configuration: {
|
1552
1559
|
# crawl_attachments: false,
|
@@ -1562,6 +1569,7 @@ module Aws::Kendra
|
|
1562
1569
|
# },
|
1563
1570
|
# ],
|
1564
1571
|
# },
|
1572
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
1565
1573
|
# },
|
1566
1574
|
# confluence_configuration: {
|
1567
1575
|
# server_url: "Url", # required
|
@@ -2249,6 +2257,7 @@ module Aws::Kendra
|
|
2249
2257
|
# index_field_name: "IndexFieldName", # required
|
2250
2258
|
# },
|
2251
2259
|
# ],
|
2260
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
2252
2261
|
# },
|
2253
2262
|
# service_catalog_configuration: {
|
2254
2263
|
# crawl_attachments: false,
|
@@ -2264,6 +2273,7 @@ module Aws::Kendra
|
|
2264
2273
|
# },
|
2265
2274
|
# ],
|
2266
2275
|
# },
|
2276
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
2267
2277
|
# },
|
2268
2278
|
# confluence_configuration: {
|
2269
2279
|
# server_url: "Url", # required
|
@@ -2390,7 +2400,7 @@ module Aws::Kendra
|
|
2390
2400
|
end
|
2391
2401
|
|
2392
2402
|
# Summary information for a Amazon Kendra data source. Returned in a
|
2393
|
-
# call to .
|
2403
|
+
# call to the `DescribeDataSource` operation.
|
2394
2404
|
#
|
2395
2405
|
# @!attribute [rw] name
|
2396
2406
|
# The name of the data source.
|
@@ -2413,7 +2423,7 @@ module Aws::Kendra
|
|
2413
2423
|
# @return [Time]
|
2414
2424
|
#
|
2415
2425
|
# @!attribute [rw] status
|
2416
|
-
# The status of the data source. When the status is `
|
2426
|
+
# The status of the data source. When the status is `ACTIVE` the data
|
2417
2427
|
# source is ready to use.
|
2418
2428
|
# @return [String]
|
2419
2429
|
#
|
@@ -2558,7 +2568,7 @@ module Aws::Kendra
|
|
2558
2568
|
end
|
2559
2569
|
|
2560
2570
|
# Maps a column or attribute in the data source to an index field. You
|
2561
|
-
# must first create the fields in the index using the UpdateIndex
|
2571
|
+
# must first create the fields in the index using the `UpdateIndex`
|
2562
2572
|
# operation.
|
2563
2573
|
#
|
2564
2574
|
# @note When making an API call, you may pass DataSourceToIndexFieldMapping
|
@@ -3062,7 +3072,7 @@ module Aws::Kendra
|
|
3062
3072
|
# @return [String]
|
3063
3073
|
#
|
3064
3074
|
# @!attribute [rw] capacity_units
|
3065
|
-
# For
|
3075
|
+
# For Enterprise edition indexes, you can choose to use additional
|
3066
3076
|
# capacity to meet the needs of your application. This contains the
|
3067
3077
|
# capacity units used for the index. A 0 for the query capacity or the
|
3068
3078
|
# storage capacity indicates that the index is using the default
|
@@ -3629,7 +3639,7 @@ module Aws::Kendra
|
|
3629
3639
|
#
|
3630
3640
|
# If you are using the console, you can define index fields when
|
3631
3641
|
# creating the mapping. If you are using the API, you must first
|
3632
|
-
# create the field using the UpdateIndex operation.
|
3642
|
+
# create the field using the `UpdateIndex` operation.
|
3633
3643
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3634
3644
|
#
|
3635
3645
|
# @!attribute [rw] exclude_mime_types
|
@@ -4441,7 +4451,7 @@ module Aws::Kendra
|
|
4441
4451
|
#
|
4442
4452
|
# @!attribute [rw] index_id
|
4443
4453
|
# The unique identifier of the index to search. The identifier is
|
4444
|
-
# returned in the response from the operation.
|
4454
|
+
# returned in the response from the `CreateIndex` operation.
|
4445
4455
|
# @return [String]
|
4446
4456
|
#
|
4447
4457
|
# @!attribute [rw] query_text
|
@@ -4727,7 +4737,7 @@ module Aws::Kendra
|
|
4727
4737
|
end
|
4728
4738
|
|
4729
4739
|
# Provides feedback on how relevant a document is to a search. Your
|
4730
|
-
# application uses the SubmitFeedback operation to provide relevance
|
4740
|
+
# application uses the `SubmitFeedback` operation to provide relevance
|
4731
4741
|
# information.
|
4732
4742
|
#
|
4733
4743
|
# @note When making an API call, you may pass RelevanceFeedback
|
@@ -5078,7 +5088,7 @@ module Aws::Kendra
|
|
5078
5088
|
# @return [Array<Types::SalesforceStandardObjectConfiguration>]
|
5079
5089
|
#
|
5080
5090
|
# @!attribute [rw] knowledge_article_configuration
|
5081
|
-
# Specifies configuration information for the
|
5091
|
+
# Specifies configuration information for the knowledge article types
|
5082
5092
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
5083
5093
|
# articles and the standard fields of knowledge articles, or the
|
5084
5094
|
# custom fields of custom knowledge articles, but not both.
|
@@ -5183,7 +5193,7 @@ module Aws::Kendra
|
|
5183
5193
|
include Aws::Structure
|
5184
5194
|
end
|
5185
5195
|
|
5186
|
-
# Specifies configuration information for the
|
5196
|
+
# Specifies configuration information for the knowledge article types
|
5187
5197
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
5188
5198
|
# articles and the standard fields of knowledge articles, or the custom
|
5189
5199
|
# fields of custom knowledge articles, but not both
|
@@ -5323,7 +5333,7 @@ module Aws::Kendra
|
|
5323
5333
|
include Aws::Structure
|
5324
5334
|
end
|
5325
5335
|
|
5326
|
-
# Specifies
|
5336
|
+
# Specifies configuration information for indexing a single standard
|
5327
5337
|
# object.
|
5328
5338
|
#
|
5329
5339
|
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
@@ -5353,7 +5363,7 @@ module Aws::Kendra
|
|
5353
5363
|
#
|
5354
5364
|
# @!attribute [rw] document_title_field_name
|
5355
5365
|
# The name of the field in the standard object table that contains the
|
5356
|
-
# document
|
5366
|
+
# document title.
|
5357
5367
|
# @return [String]
|
5358
5368
|
#
|
5359
5369
|
# @!attribute [rw] field_mappings
|
@@ -5485,6 +5495,7 @@ module Aws::Kendra
|
|
5485
5495
|
# index_field_name: "IndexFieldName", # required
|
5486
5496
|
# },
|
5487
5497
|
# ],
|
5498
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5488
5499
|
# },
|
5489
5500
|
# service_catalog_configuration: {
|
5490
5501
|
# crawl_attachments: false,
|
@@ -5500,6 +5511,7 @@ module Aws::Kendra
|
|
5500
5511
|
# },
|
5501
5512
|
# ],
|
5502
5513
|
# },
|
5514
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
5503
5515
|
# }
|
5504
5516
|
#
|
5505
5517
|
# @!attribute [rw] host_url
|
@@ -5529,6 +5541,25 @@ module Aws::Kendra
|
|
5529
5541
|
# the ServiceNow site.
|
5530
5542
|
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
5531
5543
|
#
|
5544
|
+
# @!attribute [rw] authentication_type
|
5545
|
+
# Determines the type of authentication used to connect to the
|
5546
|
+
# ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is
|
5547
|
+
# authenticated using the user name and password provided in the AWS
|
5548
|
+
# Secrets Manager secret in the `SecretArn` field. When you choose
|
5549
|
+
# `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and
|
5550
|
+
# secret provided in the Secrets Manager secret, and the user name and
|
5551
|
+
# password are used to determine which information Amazon Kendra has
|
5552
|
+
# access to.
|
5553
|
+
#
|
5554
|
+
# When you use `OAUTH2` authentication, you must generate a token and
|
5555
|
+
# a client secret using the ServiceNow console. For more information,
|
5556
|
+
# see [Using a ServiceNow data source][1].
|
5557
|
+
#
|
5558
|
+
#
|
5559
|
+
#
|
5560
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
|
5561
|
+
# @return [String]
|
5562
|
+
#
|
5532
5563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
|
5533
5564
|
#
|
5534
5565
|
class ServiceNowConfiguration < Struct.new(
|
@@ -5536,7 +5567,8 @@ module Aws::Kendra
|
|
5536
5567
|
:secret_arn,
|
5537
5568
|
:service_now_build_version,
|
5538
5569
|
:knowledge_article_configuration,
|
5539
|
-
:service_catalog_configuration
|
5570
|
+
:service_catalog_configuration,
|
5571
|
+
:authentication_type)
|
5540
5572
|
SENSITIVE = []
|
5541
5573
|
include Aws::Structure
|
5542
5574
|
end
|
@@ -5560,6 +5592,7 @@ module Aws::Kendra
|
|
5560
5592
|
# index_field_name: "IndexFieldName", # required
|
5561
5593
|
# },
|
5562
5594
|
# ],
|
5595
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5563
5596
|
# }
|
5564
5597
|
#
|
5565
5598
|
# @!attribute [rw] crawl_attachments
|
@@ -5594,6 +5627,20 @@ module Aws::Kendra
|
|
5594
5627
|
# You must create the index field before you map the field.
|
5595
5628
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
5596
5629
|
#
|
5630
|
+
# @!attribute [rw] filter_query
|
5631
|
+
# A query that selects the knowledge articles to index. The query can
|
5632
|
+
# return articles from multiple knowledge bases, and the knowledge
|
5633
|
+
# bases can be public or private.
|
5634
|
+
#
|
5635
|
+
# The query string must be one generated by the ServiceNow console.
|
5636
|
+
# For more information, see [Specifying documents to index with a
|
5637
|
+
# query][1].
|
5638
|
+
#
|
5639
|
+
#
|
5640
|
+
#
|
5641
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
|
5642
|
+
# @return [String]
|
5643
|
+
#
|
5597
5644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
|
5598
5645
|
#
|
5599
5646
|
class ServiceNowKnowledgeArticleConfiguration < Struct.new(
|
@@ -5602,7 +5649,8 @@ module Aws::Kendra
|
|
5602
5649
|
:exclude_attachment_file_patterns,
|
5603
5650
|
:document_data_field_name,
|
5604
5651
|
:document_title_field_name,
|
5605
|
-
:field_mappings
|
5652
|
+
:field_mappings,
|
5653
|
+
:filter_query)
|
5606
5654
|
SENSITIVE = []
|
5607
5655
|
include Aws::Structure
|
5608
5656
|
end
|
@@ -5634,13 +5682,23 @@ module Aws::Kendra
|
|
5634
5682
|
# @return [Boolean]
|
5635
5683
|
#
|
5636
5684
|
# @!attribute [rw] include_attachment_file_patterns
|
5637
|
-
#
|
5638
|
-
# index.
|
5685
|
+
# A list of regular expression patterns. Documents that match the
|
5686
|
+
# patterns are included in the index. Documents that don't match the
|
5687
|
+
# patterns are excluded from the index. If a document matches both an
|
5688
|
+
# exclusion pattern and an inclusion pattern, the document is not
|
5689
|
+
# included in the index.
|
5690
|
+
#
|
5691
|
+
# The regex is applied to the file name of the attachment.
|
5639
5692
|
# @return [Array<String>]
|
5640
5693
|
#
|
5641
5694
|
# @!attribute [rw] exclude_attachment_file_patterns
|
5642
|
-
#
|
5643
|
-
# index.
|
5695
|
+
# A list of regular expression patterns. Documents that match the
|
5696
|
+
# patterns are excluded from the index. Documents that don't match
|
5697
|
+
# the patterns are included in the index. If a document matches both
|
5698
|
+
# an exclusion pattern and an inclusion pattern, the document is not
|
5699
|
+
# included in the index.
|
5700
|
+
#
|
5701
|
+
# The regex is applied to the file name of the attachment.
|
5644
5702
|
# @return [Array<String>]
|
5645
5703
|
#
|
5646
5704
|
# @!attribute [rw] document_data_field_name
|
@@ -5775,9 +5833,9 @@ module Aws::Kendra
|
|
5775
5833
|
# @!attribute [rw] field_mappings
|
5776
5834
|
# A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
|
5777
5835
|
# SharePoint attributes to custom fields in the Amazon Kendra index.
|
5778
|
-
# You must first create the index fields using the
|
5779
|
-
# you map SharePoint attributes. For more
|
5780
|
-
# Data Source Fields][1].
|
5836
|
+
# You must first create the index fields using the `UpdateIndex`
|
5837
|
+
# operation before you map SharePoint attributes. For more
|
5838
|
+
# information, see [Mapping Data Source Fields][1].
|
5781
5839
|
#
|
5782
5840
|
#
|
5783
5841
|
#
|
@@ -5995,7 +6053,8 @@ module Aws::Kendra
|
|
5995
6053
|
#
|
5996
6054
|
# @!attribute [rw] query_id
|
5997
6055
|
# The identifier of the specific query for which you are submitting
|
5998
|
-
# feedback. The query ID is returned in the response to the
|
6056
|
+
# feedback. The query ID is returned in the response to the `Query`
|
6057
|
+
# operation.
|
5999
6058
|
# @return [String]
|
6000
6059
|
#
|
6001
6060
|
# @!attribute [rw] click_feedback_items
|
@@ -6412,6 +6471,7 @@ module Aws::Kendra
|
|
6412
6471
|
# index_field_name: "IndexFieldName", # required
|
6413
6472
|
# },
|
6414
6473
|
# ],
|
6474
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
6415
6475
|
# },
|
6416
6476
|
# service_catalog_configuration: {
|
6417
6477
|
# crawl_attachments: false,
|
@@ -6427,6 +6487,7 @@ module Aws::Kendra
|
|
6427
6487
|
# },
|
6428
6488
|
# ],
|
6429
6489
|
# },
|
6490
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
6430
6491
|
# },
|
6431
6492
|
# confluence_configuration: {
|
6432
6493
|
# server_url: "Url", # required
|
@@ -6621,7 +6682,7 @@ module Aws::Kendra
|
|
6621
6682
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
6622
6683
|
#
|
6623
6684
|
# @!attribute [rw] capacity_units
|
6624
|
-
# Sets the number of
|
6685
|
+
# Sets the number of additional storage and query capacity units that
|
6625
6686
|
# should be used by the index. You can change the capacity of the
|
6626
6687
|
# index up to 5 times per day.
|
6627
6688
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kendra
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.23.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-04-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
|
|
66
66
|
licenses:
|
67
67
|
- Apache-2.0
|
68
68
|
metadata:
|
69
|
-
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
70
|
-
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
69
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-kendra
|
70
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-kendra/CHANGELOG.md
|
71
71
|
post_install_message:
|
72
72
|
rdoc_options: []
|
73
73
|
require_paths:
|