aws-sdk-kendra 1.41.0 → 1.42.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +11 -3
- data/lib/aws-sdk-kendra/client_api.rb +18 -1
- data/lib/aws-sdk-kendra/types.rb +55 -10
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 34b195b939363a4d9ab4281bbab5fda30476fd89ef587f69b843d64eae31fe99
|
4
|
+
data.tar.gz: 913e2608207629ea75392386994ff6f83fc8ce85fce0c7ed86f30a042f821c18
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3aa92e253a6d0bf3c680733ea040506bfcb2809958164360d67e48589c791599c185d88d6ea0fdeaad82fdc5b7dd263c8f14281a2618f09d599065795cad7c4b
|
7
|
+
data.tar.gz: e1324182a10d542171bb12c0152131cbb36ef2aa0ef0e3dac5c704def3056ffabc5fd7fb3646f425c94c8fe91fec6e1fb1ba5d462e7d40de3a32b5fe610ef78d
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.42.0
|
@@ -1406,6 +1406,8 @@ module Aws::Kendra
|
|
1406
1406
|
# Creates an new set of frequently asked question (FAQ) questions and
|
1407
1407
|
# answers.
|
1408
1408
|
#
|
1409
|
+
# Adding FAQs to an index is an asynchronous operation.
|
1410
|
+
#
|
1409
1411
|
# @option params [required, String] :index_id
|
1410
1412
|
# The identifier of the index that contains the FAQ.
|
1411
1413
|
#
|
@@ -3020,6 +3022,8 @@ module Aws::Kendra
|
|
3020
3022
|
# * {Types::GetSnapshotsResponse#snapshots_data #snapshots_data} => Array<Array<String>>
|
3021
3023
|
# * {Types::GetSnapshotsResponse#next_token #next_token} => String
|
3022
3024
|
#
|
3025
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3026
|
+
#
|
3023
3027
|
# @example Request syntax with placeholder values
|
3024
3028
|
#
|
3025
3029
|
# resp = client.get_snapshots({
|
@@ -3786,7 +3790,7 @@ module Aws::Kendra
|
|
3786
3790
|
# The unique identifier of the index to search. The identifier is
|
3787
3791
|
# returned in the response from the `CreateIndex` operation.
|
3788
3792
|
#
|
3789
|
-
# @option params [
|
3793
|
+
# @option params [String] :query_text
|
3790
3794
|
# The text to search for.
|
3791
3795
|
#
|
3792
3796
|
# @option params [Types::AttributeFilter] :attribute_filter
|
@@ -3865,12 +3869,13 @@ module Aws::Kendra
|
|
3865
3869
|
# * {Types::QueryResult#result_items #result_items} => Array<Types::QueryResultItem>
|
3866
3870
|
# * {Types::QueryResult#facet_results #facet_results} => Array<Types::FacetResult>
|
3867
3871
|
# * {Types::QueryResult#total_number_of_results #total_number_of_results} => Integer
|
3872
|
+
# * {Types::QueryResult#warnings #warnings} => Array<Types::Warning>
|
3868
3873
|
#
|
3869
3874
|
# @example Request syntax with placeholder values
|
3870
3875
|
#
|
3871
3876
|
# resp = client.query({
|
3872
3877
|
# index_id: "IndexId", # required
|
3873
|
-
# query_text: "QueryText",
|
3878
|
+
# query_text: "QueryText",
|
3874
3879
|
# attribute_filter: {
|
3875
3880
|
# and_all_filters: [
|
3876
3881
|
# {
|
@@ -4039,6 +4044,9 @@ module Aws::Kendra
|
|
4039
4044
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.date_value #=> Time
|
4040
4045
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].count #=> Integer
|
4041
4046
|
# resp.total_number_of_results #=> Integer
|
4047
|
+
# resp.warnings #=> Array
|
4048
|
+
# resp.warnings[0].message #=> String
|
4049
|
+
# resp.warnings[0].code #=> String, one of "QUERY_LANGUAGE_INVALID_SYNTAX"
|
4042
4050
|
#
|
4043
4051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query AWS API Documentation
|
4044
4052
|
#
|
@@ -5066,7 +5074,7 @@ module Aws::Kendra
|
|
5066
5074
|
params: params,
|
5067
5075
|
config: config)
|
5068
5076
|
context[:gem_name] = 'aws-sdk-kendra'
|
5069
|
-
context[:gem_version] = '1.
|
5077
|
+
context[:gem_version] = '1.42.0'
|
5070
5078
|
Seahorse::Client::Request.new(handlers, context)
|
5071
5079
|
end
|
5072
5080
|
|
@@ -471,6 +471,10 @@ module Aws::Kendra
|
|
471
471
|
ValueImportanceMapKey = Shapes::StringShape.new(name: 'ValueImportanceMapKey')
|
472
472
|
VisitorId = Shapes::StringShape.new(name: 'VisitorId')
|
473
473
|
VpcSecurityGroupId = Shapes::StringShape.new(name: 'VpcSecurityGroupId')
|
474
|
+
Warning = Shapes::StructureShape.new(name: 'Warning')
|
475
|
+
WarningCode = Shapes::StringShape.new(name: 'WarningCode')
|
476
|
+
WarningList = Shapes::ListShape.new(name: 'WarningList')
|
477
|
+
WarningMessage = Shapes::StringShape.new(name: 'WarningMessage')
|
474
478
|
WebCrawlerConfiguration = Shapes::StructureShape.new(name: 'WebCrawlerConfiguration')
|
475
479
|
WebCrawlerMode = Shapes::StringShape.new(name: 'WebCrawlerMode')
|
476
480
|
WorkDocsConfiguration = Shapes::StructureShape.new(name: 'WorkDocsConfiguration')
|
@@ -1452,7 +1456,7 @@ module Aws::Kendra
|
|
1452
1456
|
PutPrincipalMappingRequest.struct_class = Types::PutPrincipalMappingRequest
|
1453
1457
|
|
1454
1458
|
QueryRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
1455
|
-
QueryRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: QueryText,
|
1459
|
+
QueryRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: QueryText, location_name: "QueryText"))
|
1456
1460
|
QueryRequest.add_member(:attribute_filter, Shapes::ShapeRef.new(shape: AttributeFilter, location_name: "AttributeFilter"))
|
1457
1461
|
QueryRequest.add_member(:facets, Shapes::ShapeRef.new(shape: FacetList, location_name: "Facets"))
|
1458
1462
|
QueryRequest.add_member(:requested_document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "RequestedDocumentAttributes"))
|
@@ -1469,6 +1473,7 @@ module Aws::Kendra
|
|
1469
1473
|
QueryResult.add_member(:result_items, Shapes::ShapeRef.new(shape: QueryResultItemList, location_name: "ResultItems"))
|
1470
1474
|
QueryResult.add_member(:facet_results, Shapes::ShapeRef.new(shape: FacetResultList, location_name: "FacetResults"))
|
1471
1475
|
QueryResult.add_member(:total_number_of_results, Shapes::ShapeRef.new(shape: Integer, location_name: "TotalNumberOfResults"))
|
1476
|
+
QueryResult.add_member(:warnings, Shapes::ShapeRef.new(shape: WarningList, location_name: "Warnings"))
|
1472
1477
|
QueryResult.struct_class = Types::QueryResult
|
1473
1478
|
|
1474
1479
|
QueryResultItem.add_member(:id, Shapes::ShapeRef.new(shape: ResultId, location_name: "Id"))
|
@@ -1835,6 +1840,12 @@ module Aws::Kendra
|
|
1835
1840
|
ValueImportanceMap.key = Shapes::ShapeRef.new(shape: ValueImportanceMapKey)
|
1836
1841
|
ValueImportanceMap.value = Shapes::ShapeRef.new(shape: Importance)
|
1837
1842
|
|
1843
|
+
Warning.add_member(:message, Shapes::ShapeRef.new(shape: WarningMessage, location_name: "Message"))
|
1844
|
+
Warning.add_member(:code, Shapes::ShapeRef.new(shape: WarningCode, location_name: "Code"))
|
1845
|
+
Warning.struct_class = Types::Warning
|
1846
|
+
|
1847
|
+
WarningList.member = Shapes::ShapeRef.new(shape: Warning)
|
1848
|
+
|
1838
1849
|
WebCrawlerConfiguration.add_member(:urls, Shapes::ShapeRef.new(shape: Urls, required: true, location_name: "Urls"))
|
1839
1850
|
WebCrawlerConfiguration.add_member(:crawl_depth, Shapes::ShapeRef.new(shape: CrawlDepth, location_name: "CrawlDepth"))
|
1840
1851
|
WebCrawlerConfiguration.add_member(:max_links_per_page, Shapes::ShapeRef.new(shape: MaxLinksPerPage, location_name: "MaxLinksPerPage"))
|
@@ -2303,6 +2314,12 @@ module Aws::Kendra
|
|
2303
2314
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2304
2315
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
2305
2316
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2317
|
+
o[:pager] = Aws::Pager.new(
|
2318
|
+
limit_key: "max_results",
|
2319
|
+
tokens: {
|
2320
|
+
"next_token" => "next_token"
|
2321
|
+
}
|
2322
|
+
)
|
2306
2323
|
end)
|
2307
2324
|
|
2308
2325
|
api.add_operation(:list_data_source_sync_jobs, Seahorse::Model::Operation.new.tap do |o|
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -5038,6 +5038,13 @@ module Aws::Kendra
|
|
5038
5038
|
|
5039
5039
|
# A custom attribute value assigned to a document.
|
5040
5040
|
#
|
5041
|
+
# For more information on how to create custom document attributes, see
|
5042
|
+
# [Custom Attributes][1].
|
5043
|
+
#
|
5044
|
+
#
|
5045
|
+
#
|
5046
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html
|
5047
|
+
#
|
5041
5048
|
# @note When making an API call, you may pass DocumentAttribute
|
5042
5049
|
# data as a hash:
|
5043
5050
|
#
|
@@ -5235,9 +5242,9 @@ module Aws::Kendra
|
|
5235
5242
|
# A date expressed as an ISO 8601 string.
|
5236
5243
|
#
|
5237
5244
|
# It is important for the time zone to be included in the ISO 8601
|
5238
|
-
# date-time format. For example,
|
5239
|
-
# date-time format for March 25th 2012 at 12:30PM (plus 10
|
5240
|
-
# Central European Time.
|
5245
|
+
# date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO
|
5246
|
+
# 8601 date-time format for March 25th 2012 at 12:30PM (plus 10
|
5247
|
+
# seconds) in Central European Time.
|
5241
5248
|
# @return [Time]
|
5242
5249
|
#
|
5243
5250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
|
@@ -6289,18 +6296,17 @@ module Aws::Kendra
|
|
6289
6296
|
# advanced alterations on the original or raw documents. If you want to
|
6290
6297
|
# apply advanced alterations on the Amazon Kendra structured documents,
|
6291
6298
|
# you must configure your Lambda function using
|
6292
|
-
# [PostExtractionHookConfiguration][
|
6299
|
+
# [PostExtractionHookConfiguration][1]. You can only invoke one Lambda
|
6293
6300
|
# function. However, this function can invoke other functions it
|
6294
6301
|
# requires.
|
6295
6302
|
#
|
6296
6303
|
# For more information, see [Customizing document metadata during the
|
6297
|
-
# ingestion process][
|
6304
|
+
# ingestion process][2].
|
6298
6305
|
#
|
6299
6306
|
#
|
6300
6307
|
#
|
6301
|
-
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/
|
6302
|
-
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/
|
6303
|
-
# [3]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
|
6308
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html
|
6309
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
|
6304
6310
|
#
|
6305
6311
|
# @note When making an API call, you may pass HookConfiguration
|
6306
6312
|
# data as a hash:
|
@@ -7649,7 +7655,7 @@ module Aws::Kendra
|
|
7649
7655
|
#
|
7650
7656
|
# {
|
7651
7657
|
# index_id: "IndexId", # required
|
7652
|
-
# query_text: "QueryText",
|
7658
|
+
# query_text: "QueryText",
|
7653
7659
|
# attribute_filter: {
|
7654
7660
|
# and_all_filters: [
|
7655
7661
|
# {
|
@@ -7900,13 +7906,27 @@ module Aws::Kendra
|
|
7900
7906
|
# items, you can only retrieve the first 100 of the items.
|
7901
7907
|
# @return [Integer]
|
7902
7908
|
#
|
7909
|
+
# @!attribute [rw] warnings
|
7910
|
+
# A list of warning codes and their messages on problems with your
|
7911
|
+
# query.
|
7912
|
+
#
|
7913
|
+
# Amazon Kendra currently only supports one type of warning, which is
|
7914
|
+
# a warning on invalid syntax used in the query. For examples of
|
7915
|
+
# invalid query syntax, see [Searching with advanced query syntax][1].
|
7916
|
+
#
|
7917
|
+
#
|
7918
|
+
#
|
7919
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
|
7920
|
+
# @return [Array<Types::Warning>]
|
7921
|
+
#
|
7903
7922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
7904
7923
|
#
|
7905
7924
|
class QueryResult < Struct.new(
|
7906
7925
|
:query_id,
|
7907
7926
|
:result_items,
|
7908
7927
|
:facet_results,
|
7909
|
-
:total_number_of_results
|
7928
|
+
:total_number_of_results,
|
7929
|
+
:warnings)
|
7910
7930
|
SENSITIVE = []
|
7911
7931
|
include Aws::Structure
|
7912
7932
|
end
|
@@ -10887,6 +10907,12 @@ module Aws::Kendra
|
|
10887
10907
|
# permissions to use Amazon Web Services SSO with Amazon Kendra. For
|
10888
10908
|
# more information, see [IAM roles for Amazon Web Services SSO][3].
|
10889
10909
|
#
|
10910
|
+
# Amazon Kendra currently does not support using
|
10911
|
+
# `UserGroupResolutionConfiguration` with an Amazon Web Services
|
10912
|
+
# organization member account for your Amazon Web Services SSO identify
|
10913
|
+
# source. You must create your index in the parent account for the
|
10914
|
+
# organization in order to use `UserGroupResolutionConfiguration`.
|
10915
|
+
#
|
10890
10916
|
#
|
10891
10917
|
#
|
10892
10918
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html
|
@@ -10998,6 +11024,25 @@ module Aws::Kendra
|
|
10998
11024
|
include Aws::Structure
|
10999
11025
|
end
|
11000
11026
|
|
11027
|
+
# The warning code and message that explains a problem with a query.
|
11028
|
+
#
|
11029
|
+
# @!attribute [rw] message
|
11030
|
+
# The message that explains the problem with the query.
|
11031
|
+
# @return [String]
|
11032
|
+
#
|
11033
|
+
# @!attribute [rw] code
|
11034
|
+
# The code used to show the type of warning for the query.
|
11035
|
+
# @return [String]
|
11036
|
+
#
|
11037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Warning AWS API Documentation
|
11038
|
+
#
|
11039
|
+
class Warning < Struct.new(
|
11040
|
+
:message,
|
11041
|
+
:code)
|
11042
|
+
SENSITIVE = []
|
11043
|
+
include Aws::Structure
|
11044
|
+
end
|
11045
|
+
|
11001
11046
|
# Provides the configuration information required for Amazon Kendra Web
|
11002
11047
|
# Crawler.
|
11003
11048
|
#
|
data/lib/aws-sdk-kendra.rb
CHANGED
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.42.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:
|
11
|
+
date: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|