aws-sdk-kendra 1.43.0 → 1.46.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +138 -82
- data/lib/aws-sdk-kendra/client_api.rb +38 -0
- data/lib/aws-sdk-kendra/types.rb +451 -196
- data/lib/aws-sdk-kendra.rb +1 -1
- 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: c5205c10b90ac380415aca3028787ff2a5f0ea72d3dec839112932e72d091422
|
4
|
+
data.tar.gz: fb44466f44a1b97775868263f6da2e881d1768b913e2ae57f5ae232ed6fd8d3e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cb856eb198deeff87c3d4ebbe6b600f5c3c212e6615063abc88414441d398bccc2780fd09a70fce8b747d6b05b92c24325ddd19eaca98672a936f945c83b97a9
|
7
|
+
data.tar.gz: ef97604ca2ae0cca132b090121491d394c2e4036944e8abb59b172b617ad36db2a5a8a84e1951ef5ef447ebb42962018dd6f44e3e0af9cdfe36c4cb27ea0f570
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.46.0 (2022-03-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Kendra now suggests spell corrections for a query. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html
|
8
|
+
|
9
|
+
1.45.0 (2022-02-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.44.0 (2022-02-08)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon Kendra now provides a data source connector for Amazon FSx. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-fsx.html
|
18
|
+
|
4
19
|
1.43.0 (2022-02-03)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.46.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -75,6 +76,7 @@ module Aws::Kendra
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -471,7 +473,7 @@ module Aws::Kendra
|
|
471
473
|
end
|
472
474
|
|
473
475
|
# Removes one or more documents from an index. The documents must have
|
474
|
-
# been added with the `BatchPutDocument`
|
476
|
+
# been added with the `BatchPutDocument` API.
|
475
477
|
#
|
476
478
|
# The documents are deleted asynchronously. You can see the progress of
|
477
479
|
# the deletion by using Amazon Web Services CloudWatch. Any error
|
@@ -519,17 +521,16 @@ module Aws::Kendra
|
|
519
521
|
end
|
520
522
|
|
521
523
|
# Returns the indexing status for one or more documents submitted with
|
522
|
-
# the [ BatchPutDocument][1]
|
524
|
+
# the [ BatchPutDocument][1] API.
|
523
525
|
#
|
524
|
-
# When you use the `BatchPutDocument`
|
525
|
-
# asynchronously. You can use the `BatchGetDocumentStatus`
|
526
|
-
#
|
527
|
-
#
|
526
|
+
# When you use the `BatchPutDocument` API, documents are indexed
|
527
|
+
# asynchronously. You can use the `BatchGetDocumentStatus` API to get
|
528
|
+
# the current status of a list of documents so that you can determine if
|
529
|
+
# they have been successfully indexed.
|
528
530
|
#
|
529
|
-
# You can also use the `BatchGetDocumentStatus`
|
530
|
-
#
|
531
|
-
#
|
532
|
-
# status.
|
531
|
+
# You can also use the `BatchGetDocumentStatus` API to check the status
|
532
|
+
# of the [ BatchDeleteDocument][2] API. When a document is deleted from
|
533
|
+
# the index, Amazon Kendra returns `NOT_FOUND` as the status.
|
533
534
|
#
|
534
535
|
#
|
535
536
|
#
|
@@ -538,7 +539,7 @@ module Aws::Kendra
|
|
538
539
|
#
|
539
540
|
# @option params [required, String] :index_id
|
540
541
|
# The identifier of the index to add documents to. The index ID is
|
541
|
-
# returned by the [
|
542
|
+
# returned by the [CreateIndex ][1] API.
|
542
543
|
#
|
543
544
|
#
|
544
545
|
#
|
@@ -599,11 +600,11 @@ module Aws::Kendra
|
|
599
600
|
|
600
601
|
# Adds one or more documents to an index.
|
601
602
|
#
|
602
|
-
# The `BatchPutDocument`
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
603
|
+
# The `BatchPutDocument` API enables you to ingest inline documents or a
|
604
|
+
# set of documents stored in an Amazon S3 bucket. Use this API to ingest
|
605
|
+
# your text and unstructured text into an index, add custom attributes
|
606
|
+
# to the documents, and to attach an access control list to the
|
607
|
+
# documents added to the index.
|
607
608
|
#
|
608
609
|
# The documents are indexed asynchronously. You can see the progress of
|
609
610
|
# the batch using Amazon Web Services CloudWatch. Any error messages
|
@@ -612,11 +613,11 @@ module Aws::Kendra
|
|
612
613
|
#
|
613
614
|
# @option params [required, String] :index_id
|
614
615
|
# The identifier of the index to add the documents to. You need to
|
615
|
-
# create the index first using the `CreateIndex`
|
616
|
+
# create the index first using the `CreateIndex` API.
|
616
617
|
#
|
617
618
|
# @option params [String] :role_arn
|
618
619
|
# The Amazon Resource Name (ARN) of a role that is allowed to run the
|
619
|
-
# `BatchPutDocument`
|
620
|
+
# `BatchPutDocument` API. For more information, see [IAM Roles for
|
620
621
|
# Amazon Kendra][1].
|
621
622
|
#
|
622
623
|
#
|
@@ -626,12 +627,6 @@ module Aws::Kendra
|
|
626
627
|
# @option params [required, Array<Types::Document>] :documents
|
627
628
|
# One or more documents to add to the index.
|
628
629
|
#
|
629
|
-
# Documents can include custom attributes. For example, 'DataSourceId'
|
630
|
-
# and 'DataSourceSyncJobId' are custom attributes that provide
|
631
|
-
# information on the synchronization of documents running on a data
|
632
|
-
# source. Note, 'DataSourceSyncJobId' could be an optional custom
|
633
|
-
# attribute as Amazon Kendra will use the ID of a running sync job.
|
634
|
-
#
|
635
630
|
# Documents have the following file size limits.
|
636
631
|
#
|
637
632
|
# * 5 MB total size for inline documents
|
@@ -650,7 +645,7 @@ module Aws::Kendra
|
|
650
645
|
# @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
|
651
646
|
# Configuration information for altering your document metadata and
|
652
647
|
# content during the document ingestion process when you use the
|
653
|
-
# `BatchPutDocument`
|
648
|
+
# `BatchPutDocument` API.
|
654
649
|
#
|
655
650
|
# For more information on how to create, modify and delete document
|
656
651
|
# metadata, or make other content alterations when you ingest documents
|
@@ -848,7 +843,7 @@ module Aws::Kendra
|
|
848
843
|
# The type of repository that contains the data source.
|
849
844
|
#
|
850
845
|
# @option params [Types::DataSourceConfiguration] :configuration
|
851
|
-
#
|
846
|
+
# Configuration information that is required to access the data source
|
852
847
|
# repository.
|
853
848
|
#
|
854
849
|
# You can't specify the `Configuration` parameter when the `Type`
|
@@ -861,10 +856,10 @@ module Aws::Kendra
|
|
861
856
|
# A description for the data source.
|
862
857
|
#
|
863
858
|
# @option params [String] :schedule
|
864
|
-
# Sets the frequency
|
859
|
+
# Sets the frequency for Amazon Kendra to check the documents in your
|
865
860
|
# repository and update the index. If you don't set a schedule Amazon
|
866
861
|
# Kendra will not periodically update the index. You can call the
|
867
|
-
# `StartDataSourceSyncJob`
|
862
|
+
# `StartDataSourceSyncJob` API to update the index.
|
868
863
|
#
|
869
864
|
# You can't specify the `Schedule` parameter when the `Type` parameter
|
870
865
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -892,8 +887,8 @@ module Aws::Kendra
|
|
892
887
|
#
|
893
888
|
# @option params [String] :client_token
|
894
889
|
# A token that you provide to identify the request to create a data
|
895
|
-
# source. Multiple calls to the `CreateDataSource`
|
896
|
-
#
|
890
|
+
# source. Multiple calls to the `CreateDataSource` API with the same
|
891
|
+
# client token will create only one data source.
|
897
892
|
#
|
898
893
|
# **A suitable default value is auto-generated.** You should normally
|
899
894
|
# not need to pass this option.**
|
@@ -930,7 +925,7 @@ module Aws::Kendra
|
|
930
925
|
# resp = client.create_data_source({
|
931
926
|
# name: "DataSourceName", # required
|
932
927
|
# index_id: "IndexId", # required
|
933
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS
|
928
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX
|
934
929
|
# configuration: {
|
935
930
|
# s3_configuration: {
|
936
931
|
# bucket_name: "S3BucketName", # required
|
@@ -1242,6 +1237,24 @@ module Aws::Kendra
|
|
1242
1237
|
# },
|
1243
1238
|
# ],
|
1244
1239
|
# },
|
1240
|
+
# fsx_configuration: {
|
1241
|
+
# file_system_id: "FileSystemId", # required
|
1242
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
1243
|
+
# vpc_configuration: { # required
|
1244
|
+
# subnet_ids: ["SubnetId"], # required
|
1245
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1246
|
+
# },
|
1247
|
+
# secret_arn: "SecretArn",
|
1248
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1249
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1250
|
+
# field_mappings: [
|
1251
|
+
# {
|
1252
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1253
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1254
|
+
# index_field_name: "IndexFieldName", # required
|
1255
|
+
# },
|
1256
|
+
# ],
|
1257
|
+
# },
|
1245
1258
|
# },
|
1246
1259
|
# description: "Description",
|
1247
1260
|
# schedule: "ScanSchedule",
|
@@ -1341,29 +1354,28 @@ module Aws::Kendra
|
|
1341
1354
|
#
|
1342
1355
|
# @option params [String] :role_arn
|
1343
1356
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
1344
|
-
# `Query`
|
1345
|
-
#
|
1346
|
-
#
|
1347
|
-
# Kendra][1].
|
1357
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon
|
1358
|
+
# Web Services SSO that stores your user and group information. For more
|
1359
|
+
# information, see [IAM roles for Amazon Kendra][1].
|
1348
1360
|
#
|
1349
1361
|
#
|
1350
1362
|
#
|
1351
1363
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
1352
1364
|
#
|
1353
1365
|
# @option params [Types::ExperienceConfiguration] :configuration
|
1354
|
-
#
|
1355
|
-
#
|
1356
|
-
#
|
1357
|
-
#
|
1358
|
-
#
|
1366
|
+
# Configuration information for your Amazon Kendra experience. This
|
1367
|
+
# includes `ContentSourceConfiguration`, which specifies the data source
|
1368
|
+
# IDs and/or FAQ IDs, and `UserIdentityConfiguration`, which specifies
|
1369
|
+
# the user or group information to grant access to your Amazon Kendra
|
1370
|
+
# experience.
|
1359
1371
|
#
|
1360
1372
|
# @option params [String] :description
|
1361
1373
|
# A description for your Amazon Kendra experience.
|
1362
1374
|
#
|
1363
1375
|
# @option params [String] :client_token
|
1364
1376
|
# A token that you provide to identify the request to create your Amazon
|
1365
|
-
# Kendra experience. Multiple calls to the `CreateExperience`
|
1366
|
-
#
|
1377
|
+
# Kendra experience. Multiple calls to the `CreateExperience` API with
|
1378
|
+
# the same client token creates only one Amazon Kendra experience.
|
1367
1379
|
#
|
1368
1380
|
# **A suitable default value is auto-generated.** You should normally
|
1369
1381
|
# not need to pass this option.**
|
@@ -1452,8 +1464,8 @@ module Aws::Kendra
|
|
1452
1464
|
#
|
1453
1465
|
# @option params [String] :client_token
|
1454
1466
|
# A token that you provide to identify the request to create a FAQ.
|
1455
|
-
# Multiple calls to the `CreateFaqRequest`
|
1456
|
-
#
|
1467
|
+
# Multiple calls to the `CreateFaqRequest` API with the same client
|
1468
|
+
# token will create only one FAQ.
|
1457
1469
|
#
|
1458
1470
|
# **A suitable default value is auto-generated.** You should normally
|
1459
1471
|
# not need to pass this option.**
|
@@ -1508,13 +1520,12 @@ module Aws::Kendra
|
|
1508
1520
|
end
|
1509
1521
|
|
1510
1522
|
# Creates a new Amazon Kendra index. Index creation is an asynchronous
|
1511
|
-
#
|
1512
|
-
#
|
1513
|
-
#
|
1523
|
+
# API. To determine if index creation has completed, check the `Status`
|
1524
|
+
# field returned from a call to `DescribeIndex`. The `Status` field is
|
1525
|
+
# set to `ACTIVE` when the index is ready to use.
|
1514
1526
|
#
|
1515
1527
|
# Once the index is active you can index your documents using the
|
1516
|
-
# `BatchPutDocument`
|
1517
|
-
# sources.
|
1528
|
+
# `BatchPutDocument` API or using one of the supported data sources.
|
1518
1529
|
#
|
1519
1530
|
# @option params [required, String] :name
|
1520
1531
|
# The name for the new index.
|
@@ -1539,8 +1550,8 @@ module Aws::Kendra
|
|
1539
1550
|
# @option params [required, String] :role_arn
|
1540
1551
|
# An Identity and Access Management(IAM) role that gives Amazon Kendra
|
1541
1552
|
# permissions to access your Amazon CloudWatch logs and metrics. This is
|
1542
|
-
# also the role used when you use the `BatchPutDocument`
|
1543
|
-
#
|
1553
|
+
# also the role used when you use the `BatchPutDocument` API to index
|
1554
|
+
# documents from an Amazon S3 bucket.
|
1544
1555
|
#
|
1545
1556
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
1546
1557
|
# The identifier of the KMScustomer managed key (CMK) to use to encrypt
|
@@ -1552,8 +1563,8 @@ module Aws::Kendra
|
|
1552
1563
|
#
|
1553
1564
|
# @option params [String] :client_token
|
1554
1565
|
# A token that you provide to identify the request to create an index.
|
1555
|
-
# Multiple calls to the `CreateIndex`
|
1556
|
-
#
|
1566
|
+
# Multiple calls to the `CreateIndex` API with the same client token
|
1567
|
+
# will create only one index.
|
1557
1568
|
#
|
1558
1569
|
# **A suitable default value is auto-generated.** You should normally
|
1559
1570
|
# not need to pass this option.**
|
@@ -1707,9 +1718,10 @@ module Aws::Kendra
|
|
1707
1718
|
# The IAM (Identity and Access Management) role used by Amazon Kendra to
|
1708
1719
|
# access the block list text file in your S3 bucket.
|
1709
1720
|
#
|
1710
|
-
# You need permissions to the role ARN (Amazon
|
1711
|
-
# needs S3 read permissions to your file in S3 and needs
|
1712
|
-
# (Security Token Service) assume role permissions to Amazon
|
1721
|
+
# You need permissions to the role ARN (Amazon Web Services Resource
|
1722
|
+
# Name). The role needs S3 read permissions to your file in S3 and needs
|
1723
|
+
# to give STS (Security Token Service) assume role permissions to Amazon
|
1724
|
+
# Kendra.
|
1713
1725
|
#
|
1714
1726
|
# @option params [Array<Types::Tag>] :tags
|
1715
1727
|
# A tag that you can assign to a block list that categorizes the block
|
@@ -1778,8 +1790,8 @@ module Aws::Kendra
|
|
1778
1790
|
#
|
1779
1791
|
# @option params [String] :client_token
|
1780
1792
|
# A token that you provide to identify the request to create a
|
1781
|
-
# thesaurus. Multiple calls to the `CreateThesaurus`
|
1782
|
-
#
|
1793
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` API with the same
|
1794
|
+
# client token will create only one thesaurus.
|
1783
1795
|
#
|
1784
1796
|
# **A suitable default value is auto-generated.** You should normally
|
1785
1797
|
# not need to pass this option.**
|
@@ -1824,8 +1836,8 @@ module Aws::Kendra
|
|
1824
1836
|
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
1825
1837
|
# the data source is already being deleted. While the data source is
|
1826
1838
|
# being deleted, the `Status` field returned by a call to the
|
1827
|
-
# `DescribeDataSource`
|
1828
|
-
#
|
1839
|
+
# `DescribeDataSource` API is set to `DELETING`. For more information,
|
1840
|
+
# see [Deleting Data Sources][1].
|
1829
1841
|
#
|
1830
1842
|
#
|
1831
1843
|
#
|
@@ -1916,8 +1928,8 @@ module Aws::Kendra
|
|
1916
1928
|
|
1917
1929
|
# Deletes an existing Amazon Kendra index. An exception is not thrown if
|
1918
1930
|
# the index is already being deleted. While the index is being deleted,
|
1919
|
-
# the `Status` field returned by a call to the `DescribeIndex`
|
1920
|
-
#
|
1931
|
+
# the `Status` field returned by a call to the `DescribeIndex` API is
|
1932
|
+
# set to `DELETING`.
|
1921
1933
|
#
|
1922
1934
|
# @option params [required, String] :id
|
1923
1935
|
# The identifier of the index to delete.
|
@@ -2073,7 +2085,7 @@ module Aws::Kendra
|
|
2073
2085
|
req.send_request(options)
|
2074
2086
|
end
|
2075
2087
|
|
2076
|
-
# Gets information about
|
2088
|
+
# Gets information about an Amazon Kendra data source.
|
2077
2089
|
#
|
2078
2090
|
# @option params [required, String] :id
|
2079
2091
|
# The unique identifier of the data source to describe.
|
@@ -2110,7 +2122,7 @@ module Aws::Kendra
|
|
2110
2122
|
# resp.id #=> String
|
2111
2123
|
# resp.index_id #=> String
|
2112
2124
|
# resp.name #=> String
|
2113
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
|
2125
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX"
|
2114
2126
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
2115
2127
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
2116
2128
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -2329,6 +2341,21 @@ module Aws::Kendra
|
|
2329
2341
|
# resp.configuration.work_docs_configuration.field_mappings[0].data_source_field_name #=> String
|
2330
2342
|
# resp.configuration.work_docs_configuration.field_mappings[0].date_field_format #=> String
|
2331
2343
|
# resp.configuration.work_docs_configuration.field_mappings[0].index_field_name #=> String
|
2344
|
+
# resp.configuration.fsx_configuration.file_system_id #=> String
|
2345
|
+
# resp.configuration.fsx_configuration.file_system_type #=> String, one of "WINDOWS"
|
2346
|
+
# resp.configuration.fsx_configuration.vpc_configuration.subnet_ids #=> Array
|
2347
|
+
# resp.configuration.fsx_configuration.vpc_configuration.subnet_ids[0] #=> String
|
2348
|
+
# resp.configuration.fsx_configuration.vpc_configuration.security_group_ids #=> Array
|
2349
|
+
# resp.configuration.fsx_configuration.vpc_configuration.security_group_ids[0] #=> String
|
2350
|
+
# resp.configuration.fsx_configuration.secret_arn #=> String
|
2351
|
+
# resp.configuration.fsx_configuration.inclusion_patterns #=> Array
|
2352
|
+
# resp.configuration.fsx_configuration.inclusion_patterns[0] #=> String
|
2353
|
+
# resp.configuration.fsx_configuration.exclusion_patterns #=> Array
|
2354
|
+
# resp.configuration.fsx_configuration.exclusion_patterns[0] #=> String
|
2355
|
+
# resp.configuration.fsx_configuration.field_mappings #=> Array
|
2356
|
+
# resp.configuration.fsx_configuration.field_mappings[0].data_source_field_name #=> String
|
2357
|
+
# resp.configuration.fsx_configuration.field_mappings[0].date_field_format #=> String
|
2358
|
+
# resp.configuration.fsx_configuration.field_mappings[0].index_field_name #=> String
|
2332
2359
|
# resp.created_at #=> Time
|
2333
2360
|
# resp.updated_at #=> Time
|
2334
2361
|
# resp.description #=> String
|
@@ -3163,7 +3190,7 @@ module Aws::Kendra
|
|
3163
3190
|
# resp.summary_items #=> Array
|
3164
3191
|
# resp.summary_items[0].name #=> String
|
3165
3192
|
# resp.summary_items[0].id #=> String
|
3166
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
|
3193
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX"
|
3167
3194
|
# resp.summary_items[0].created_at #=> Time
|
3168
3195
|
# resp.summary_items[0].updated_at #=> Time
|
3169
3196
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -3767,8 +3794,8 @@ module Aws::Kendra
|
|
3767
3794
|
end
|
3768
3795
|
|
3769
3796
|
# Searches an active index. Use this API to search your documents using
|
3770
|
-
# query. The `Query`
|
3771
|
-
#
|
3797
|
+
# query. The `Query` API enables to do faceted search and to filter
|
3798
|
+
# results based on document attributes.
|
3772
3799
|
#
|
3773
3800
|
# It also enables you to provide user context that Amazon Kendra uses to
|
3774
3801
|
# enforce document access control in the search results.
|
@@ -3790,7 +3817,7 @@ module Aws::Kendra
|
|
3790
3817
|
#
|
3791
3818
|
# @option params [required, String] :index_id
|
3792
3819
|
# The unique identifier of the index to search. The identifier is
|
3793
|
-
# returned in the response from the `CreateIndex`
|
3820
|
+
# returned in the response from the `CreateIndex` API.
|
3794
3821
|
#
|
3795
3822
|
# @option params [String] :query_text
|
3796
3823
|
# The text to search for.
|
@@ -3865,6 +3892,9 @@ module Aws::Kendra
|
|
3865
3892
|
# identifiable information, such as the user's email address, as the
|
3866
3893
|
# `VisitorId`.
|
3867
3894
|
#
|
3895
|
+
# @option params [Types::SpellCorrectionConfiguration] :spell_correction_configuration
|
3896
|
+
# Enables suggested spell corrections for queries.
|
3897
|
+
#
|
3868
3898
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3869
3899
|
#
|
3870
3900
|
# * {Types::QueryResult#query_id #query_id} => String
|
@@ -3872,6 +3902,7 @@ module Aws::Kendra
|
|
3872
3902
|
# * {Types::QueryResult#facet_results #facet_results} => Array<Types::FacetResult>
|
3873
3903
|
# * {Types::QueryResult#total_number_of_results #total_number_of_results} => Integer
|
3874
3904
|
# * {Types::QueryResult#warnings #warnings} => Array<Types::Warning>
|
3905
|
+
# * {Types::QueryResult#spell_corrected_queries #spell_corrected_queries} => Array<Types::SpellCorrectedQuery>
|
3875
3906
|
#
|
3876
3907
|
# @example Request syntax with placeholder values
|
3877
3908
|
#
|
@@ -3995,6 +4026,9 @@ module Aws::Kendra
|
|
3995
4026
|
# ],
|
3996
4027
|
# },
|
3997
4028
|
# visitor_id: "VisitorId",
|
4029
|
+
# spell_correction_configuration: {
|
4030
|
+
# include_query_spell_check_suggestions: false, # required
|
4031
|
+
# },
|
3998
4032
|
# })
|
3999
4033
|
#
|
4000
4034
|
# @example Response structure
|
@@ -4049,6 +4083,13 @@ module Aws::Kendra
|
|
4049
4083
|
# resp.warnings #=> Array
|
4050
4084
|
# resp.warnings[0].message #=> String
|
4051
4085
|
# resp.warnings[0].code #=> String, one of "QUERY_LANGUAGE_INVALID_SYNTAX"
|
4086
|
+
# resp.spell_corrected_queries #=> Array
|
4087
|
+
# resp.spell_corrected_queries[0].suggested_query_text #=> String
|
4088
|
+
# resp.spell_corrected_queries[0].corrections #=> Array
|
4089
|
+
# resp.spell_corrected_queries[0].corrections[0].begin_offset #=> Integer
|
4090
|
+
# resp.spell_corrected_queries[0].corrections[0].end_offset #=> Integer
|
4091
|
+
# resp.spell_corrected_queries[0].corrections[0].term #=> String
|
4092
|
+
# resp.spell_corrected_queries[0].corrections[0].corrected_term #=> String
|
4052
4093
|
#
|
4053
4094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query AWS API Documentation
|
4054
4095
|
#
|
@@ -4093,8 +4134,8 @@ module Aws::Kendra
|
|
4093
4134
|
req.send_request(options)
|
4094
4135
|
end
|
4095
4136
|
|
4096
|
-
# Stops a
|
4097
|
-
# synchronization job.
|
4137
|
+
# Stops a synchronization job that is currently running. You can't stop
|
4138
|
+
# a scheduled synchronization job.
|
4098
4139
|
#
|
4099
4140
|
# @option params [required, String] :id
|
4100
4141
|
# The identifier of the data source for which to stop the
|
@@ -4132,8 +4173,7 @@ module Aws::Kendra
|
|
4132
4173
|
#
|
4133
4174
|
# @option params [required, String] :query_id
|
4134
4175
|
# The identifier of the specific query for which you are submitting
|
4135
|
-
# feedback. The query ID is returned in the response to the `Query`
|
4136
|
-
# operation.
|
4176
|
+
# feedback. The query ID is returned in the response to the `Query` API.
|
4137
4177
|
#
|
4138
4178
|
# @option params [Array<Types::ClickFeedback>] :click_feedback_items
|
4139
4179
|
# Tells Amazon Kendra that a particular search result link was chosen by
|
@@ -4250,7 +4290,8 @@ module Aws::Kendra
|
|
4250
4290
|
# The identifier of the index that contains the data source to update.
|
4251
4291
|
#
|
4252
4292
|
# @option params [Types::DataSourceConfiguration] :configuration
|
4253
|
-
# Configuration information for an Amazon Kendra data source
|
4293
|
+
# Configuration information for an Amazon Kendra data source you want to
|
4294
|
+
# update.
|
4254
4295
|
#
|
4255
4296
|
# @option params [String] :description
|
4256
4297
|
# The new description for the data source.
|
@@ -4604,6 +4645,24 @@ module Aws::Kendra
|
|
4604
4645
|
# },
|
4605
4646
|
# ],
|
4606
4647
|
# },
|
4648
|
+
# fsx_configuration: {
|
4649
|
+
# file_system_id: "FileSystemId", # required
|
4650
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
4651
|
+
# vpc_configuration: { # required
|
4652
|
+
# subnet_ids: ["SubnetId"], # required
|
4653
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4654
|
+
# },
|
4655
|
+
# secret_arn: "SecretArn",
|
4656
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4657
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4658
|
+
# field_mappings: [
|
4659
|
+
# {
|
4660
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4661
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4662
|
+
# index_field_name: "IndexFieldName", # required
|
4663
|
+
# },
|
4664
|
+
# ],
|
4665
|
+
# },
|
4607
4666
|
# },
|
4608
4667
|
# description: "Description",
|
4609
4668
|
# schedule: "ScanSchedule",
|
@@ -4696,19 +4755,16 @@ module Aws::Kendra
|
|
4696
4755
|
#
|
4697
4756
|
# @option params [String] :role_arn
|
4698
4757
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
4699
|
-
# `Query`
|
4700
|
-
#
|
4701
|
-
#
|
4702
|
-
# Kendra][1].
|
4758
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon
|
4759
|
+
# Web Services SSO that stores your user and group information. For more
|
4760
|
+
# information, see [IAM roles for Amazon Kendra][1].
|
4703
4761
|
#
|
4704
4762
|
#
|
4705
4763
|
#
|
4706
4764
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
4707
4765
|
#
|
4708
4766
|
# @option params [Types::ExperienceConfiguration] :configuration
|
4709
|
-
#
|
4710
|
-
# Web Services SSO field name that contains the identifiers of your
|
4711
|
-
# users, such as their emails.
|
4767
|
+
# Configuration information for your Amazon Kendra you want to update.
|
4712
4768
|
#
|
4713
4769
|
# @option params [String] :description
|
4714
4770
|
# The description of your Amazon Kendra experience you want to update.
|
@@ -4760,7 +4816,7 @@ module Aws::Kendra
|
|
4760
4816
|
# A new description for the index.
|
4761
4817
|
#
|
4762
4818
|
# @option params [Array<Types::DocumentMetadataConfiguration>] :document_metadata_configuration_updates
|
4763
|
-
# The document metadata to update.
|
4819
|
+
# The document metadata you want to update.
|
4764
4820
|
#
|
4765
4821
|
# @option params [Types::CapacityUnitsConfiguration] :capacity_units
|
4766
4822
|
# Sets the number of additional storage and query capacity units that
|
@@ -5076,7 +5132,7 @@ module Aws::Kendra
|
|
5076
5132
|
params: params,
|
5077
5133
|
config: config)
|
5078
5134
|
context[:gem_name] = 'aws-sdk-kendra'
|
5079
|
-
context[:gem_version] = '1.
|
5135
|
+
context[:gem_version] = '1.46.0'
|
5080
5136
|
Seahorse::Client::Request.new(handlers, context)
|
5081
5137
|
end
|
5082
5138
|
|