aws-sdk-kendra 1.40.0 → 1.44.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +134 -74
- data/lib/aws-sdk-kendra/client_api.rb +31 -1
- data/lib/aws-sdk-kendra/types.rb +314 -110
- 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: abe1bc813d061f547ea24edfc597f09fe983e200804638c93c753a6301820dcf
|
4
|
+
data.tar.gz: 573e0884d3d9004ae916b1cb97c36502797321a1a3443c76ab2488c5663fb9d0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b0f6e733e9393924459c4becb7a5e0b760bdfe06c2aa3079f3e4644a5e5d37098252bbc865fafb5dadf0d0b919a1f6786d222c8b2fa81d7bf9457821c18f0cf8
|
7
|
+
data.tar.gz: a81755a0ff8dbb97208b8882e243fb799d484f43f9ecb0df75a899b5c4bb0b98ff4312c69df5dcea129a670362f16056710ca88959de1e98c930b480cfacde81
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.44.0 (2022-02-08)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* 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
|
8
|
+
|
9
|
+
1.43.0 (2022-02-03)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.42.0 (2022-01-11)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon Kendra now supports advanced query language and query-less search.
|
18
|
+
|
19
|
+
1.41.0 (2021-12-21)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.40.0 (2021-12-01)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.44.0
|
@@ -27,6 +27,8 @@ 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/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::Kendra
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
82
|
|
@@ -175,6 +179,10 @@ module Aws::Kendra
|
|
175
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
178
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
187
|
# Set to true to disable SDK automatically adding host prefix
|
180
188
|
# to default service endpoint when available.
|
@@ -307,7 +315,7 @@ module Aws::Kendra
|
|
307
315
|
# seconds to wait when opening a HTTP session before raising a
|
308
316
|
# `Timeout::Error`.
|
309
317
|
#
|
310
|
-
# @option options [
|
318
|
+
# @option options [Float] :http_read_timeout (60) The default
|
311
319
|
# number of seconds to wait for response data. This value can
|
312
320
|
# safely be set per-request on the session.
|
313
321
|
#
|
@@ -323,6 +331,9 @@ module Aws::Kendra
|
|
323
331
|
# disables this behaviour. This value can safely be set per
|
324
332
|
# request on the session.
|
325
333
|
#
|
334
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
335
|
+
# in seconds.
|
336
|
+
#
|
326
337
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
327
338
|
# HTTP debug output will be sent to the `:logger`.
|
328
339
|
#
|
@@ -460,7 +471,7 @@ module Aws::Kendra
|
|
460
471
|
end
|
461
472
|
|
462
473
|
# Removes one or more documents from an index. The documents must have
|
463
|
-
# been added with the `BatchPutDocument`
|
474
|
+
# been added with the `BatchPutDocument` API.
|
464
475
|
#
|
465
476
|
# The documents are deleted asynchronously. You can see the progress of
|
466
477
|
# the deletion by using Amazon Web Services CloudWatch. Any error
|
@@ -508,17 +519,16 @@ module Aws::Kendra
|
|
508
519
|
end
|
509
520
|
|
510
521
|
# Returns the indexing status for one or more documents submitted with
|
511
|
-
# the [ BatchPutDocument][1]
|
522
|
+
# the [ BatchPutDocument][1] API.
|
512
523
|
#
|
513
|
-
# When you use the `BatchPutDocument`
|
514
|
-
# asynchronously. You can use the `BatchGetDocumentStatus`
|
515
|
-
#
|
516
|
-
#
|
524
|
+
# When you use the `BatchPutDocument` API, documents are indexed
|
525
|
+
# asynchronously. You can use the `BatchGetDocumentStatus` API to get
|
526
|
+
# the current status of a list of documents so that you can determine if
|
527
|
+
# they have been successfully indexed.
|
517
528
|
#
|
518
|
-
# You can also use the `BatchGetDocumentStatus`
|
519
|
-
#
|
520
|
-
#
|
521
|
-
# status.
|
529
|
+
# You can also use the `BatchGetDocumentStatus` API to check the status
|
530
|
+
# of the [ BatchDeleteDocument][2] API. When a document is deleted from
|
531
|
+
# the index, Amazon Kendra returns `NOT_FOUND` as the status.
|
522
532
|
#
|
523
533
|
#
|
524
534
|
#
|
@@ -527,7 +537,7 @@ module Aws::Kendra
|
|
527
537
|
#
|
528
538
|
# @option params [required, String] :index_id
|
529
539
|
# The identifier of the index to add documents to. The index ID is
|
530
|
-
# returned by the [
|
540
|
+
# returned by the [CreateIndex ][1] API.
|
531
541
|
#
|
532
542
|
#
|
533
543
|
#
|
@@ -588,11 +598,11 @@ module Aws::Kendra
|
|
588
598
|
|
589
599
|
# Adds one or more documents to an index.
|
590
600
|
#
|
591
|
-
# The `BatchPutDocument`
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
601
|
+
# The `BatchPutDocument` API enables you to ingest inline documents or a
|
602
|
+
# set of documents stored in an Amazon S3 bucket. Use this API to ingest
|
603
|
+
# your text and unstructured text into an index, add custom attributes
|
604
|
+
# to the documents, and to attach an access control list to the
|
605
|
+
# documents added to the index.
|
596
606
|
#
|
597
607
|
# The documents are indexed asynchronously. You can see the progress of
|
598
608
|
# the batch using Amazon Web Services CloudWatch. Any error messages
|
@@ -601,11 +611,11 @@ module Aws::Kendra
|
|
601
611
|
#
|
602
612
|
# @option params [required, String] :index_id
|
603
613
|
# The identifier of the index to add the documents to. You need to
|
604
|
-
# create the index first using the `CreateIndex`
|
614
|
+
# create the index first using the `CreateIndex` API.
|
605
615
|
#
|
606
616
|
# @option params [String] :role_arn
|
607
617
|
# The Amazon Resource Name (ARN) of a role that is allowed to run the
|
608
|
-
# `BatchPutDocument`
|
618
|
+
# `BatchPutDocument` API. For more information, see [IAM Roles for
|
609
619
|
# Amazon Kendra][1].
|
610
620
|
#
|
611
621
|
#
|
@@ -615,12 +625,6 @@ module Aws::Kendra
|
|
615
625
|
# @option params [required, Array<Types::Document>] :documents
|
616
626
|
# One or more documents to add to the index.
|
617
627
|
#
|
618
|
-
# Documents can include custom attributes. For example, 'DataSourceId'
|
619
|
-
# and 'DataSourceSyncJobId' are custom attributes that provide
|
620
|
-
# information on the synchronization of documents running on a data
|
621
|
-
# source. Note, 'DataSourceSyncJobId' could be an optional custom
|
622
|
-
# attribute as Amazon Kendra will use the ID of a running sync job.
|
623
|
-
#
|
624
628
|
# Documents have the following file size limits.
|
625
629
|
#
|
626
630
|
# * 5 MB total size for inline documents
|
@@ -639,7 +643,7 @@ module Aws::Kendra
|
|
639
643
|
# @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
|
640
644
|
# Configuration information for altering your document metadata and
|
641
645
|
# content during the document ingestion process when you use the
|
642
|
-
# `BatchPutDocument`
|
646
|
+
# `BatchPutDocument` API.
|
643
647
|
#
|
644
648
|
# For more information on how to create, modify and delete document
|
645
649
|
# metadata, or make other content alterations when you ingest documents
|
@@ -850,10 +854,10 @@ module Aws::Kendra
|
|
850
854
|
# A description for the data source.
|
851
855
|
#
|
852
856
|
# @option params [String] :schedule
|
853
|
-
# Sets the frequency
|
857
|
+
# Sets the frequency for Amazon Kendra to check the documents in your
|
854
858
|
# repository and update the index. If you don't set a schedule Amazon
|
855
859
|
# Kendra will not periodically update the index. You can call the
|
856
|
-
# `StartDataSourceSyncJob`
|
860
|
+
# `StartDataSourceSyncJob` API to update the index.
|
857
861
|
#
|
858
862
|
# You can't specify the `Schedule` parameter when the `Type` parameter
|
859
863
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -881,8 +885,8 @@ module Aws::Kendra
|
|
881
885
|
#
|
882
886
|
# @option params [String] :client_token
|
883
887
|
# A token that you provide to identify the request to create a data
|
884
|
-
# source. Multiple calls to the `CreateDataSource`
|
885
|
-
#
|
888
|
+
# source. Multiple calls to the `CreateDataSource` API with the same
|
889
|
+
# client token will create only one data source.
|
886
890
|
#
|
887
891
|
# **A suitable default value is auto-generated.** You should normally
|
888
892
|
# not need to pass this option.**
|
@@ -919,7 +923,7 @@ module Aws::Kendra
|
|
919
923
|
# resp = client.create_data_source({
|
920
924
|
# name: "DataSourceName", # required
|
921
925
|
# index_id: "IndexId", # required
|
922
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS
|
926
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX
|
923
927
|
# configuration: {
|
924
928
|
# s3_configuration: {
|
925
929
|
# bucket_name: "S3BucketName", # required
|
@@ -1231,6 +1235,24 @@ module Aws::Kendra
|
|
1231
1235
|
# },
|
1232
1236
|
# ],
|
1233
1237
|
# },
|
1238
|
+
# fsx_configuration: {
|
1239
|
+
# file_system_id: "FileSystemId", # required
|
1240
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
1241
|
+
# vpc_configuration: { # required
|
1242
|
+
# subnet_ids: ["SubnetId"], # required
|
1243
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1244
|
+
# },
|
1245
|
+
# secret_arn: "SecretArn",
|
1246
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1247
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1248
|
+
# field_mappings: [
|
1249
|
+
# {
|
1250
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1251
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1252
|
+
# index_field_name: "IndexFieldName", # required
|
1253
|
+
# },
|
1254
|
+
# ],
|
1255
|
+
# },
|
1234
1256
|
# },
|
1235
1257
|
# description: "Description",
|
1236
1258
|
# schedule: "ScanSchedule",
|
@@ -1330,10 +1352,9 @@ module Aws::Kendra
|
|
1330
1352
|
#
|
1331
1353
|
# @option params [String] :role_arn
|
1332
1354
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
1333
|
-
# `Query`
|
1334
|
-
#
|
1335
|
-
#
|
1336
|
-
# Kendra][1].
|
1355
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon
|
1356
|
+
# Web Services SSO that stores your user and group information. For more
|
1357
|
+
# information, see [IAM roles for Amazon Kendra][1].
|
1337
1358
|
#
|
1338
1359
|
#
|
1339
1360
|
#
|
@@ -1351,8 +1372,8 @@ module Aws::Kendra
|
|
1351
1372
|
#
|
1352
1373
|
# @option params [String] :client_token
|
1353
1374
|
# A token that you provide to identify the request to create your Amazon
|
1354
|
-
# Kendra experience. Multiple calls to the `CreateExperience`
|
1355
|
-
#
|
1375
|
+
# Kendra experience. Multiple calls to the `CreateExperience` API with
|
1376
|
+
# the same client token creates only one Amazon Kendra experience.
|
1356
1377
|
#
|
1357
1378
|
# **A suitable default value is auto-generated.** You should normally
|
1358
1379
|
# not need to pass this option.**
|
@@ -1397,6 +1418,8 @@ module Aws::Kendra
|
|
1397
1418
|
# Creates an new set of frequently asked question (FAQ) questions and
|
1398
1419
|
# answers.
|
1399
1420
|
#
|
1421
|
+
# Adding FAQs to an index is an asynchronous operation.
|
1422
|
+
#
|
1400
1423
|
# @option params [required, String] :index_id
|
1401
1424
|
# The identifier of the index that contains the FAQ.
|
1402
1425
|
#
|
@@ -1439,8 +1462,8 @@ module Aws::Kendra
|
|
1439
1462
|
#
|
1440
1463
|
# @option params [String] :client_token
|
1441
1464
|
# A token that you provide to identify the request to create a FAQ.
|
1442
|
-
# Multiple calls to the `CreateFaqRequest`
|
1443
|
-
#
|
1465
|
+
# Multiple calls to the `CreateFaqRequest` API with the same client
|
1466
|
+
# token will create only one FAQ.
|
1444
1467
|
#
|
1445
1468
|
# **A suitable default value is auto-generated.** You should normally
|
1446
1469
|
# not need to pass this option.**
|
@@ -1495,13 +1518,12 @@ module Aws::Kendra
|
|
1495
1518
|
end
|
1496
1519
|
|
1497
1520
|
# Creates a new Amazon Kendra index. Index creation is an asynchronous
|
1498
|
-
#
|
1499
|
-
#
|
1500
|
-
#
|
1521
|
+
# API. To determine if index creation has completed, check the `Status`
|
1522
|
+
# field returned from a call to `DescribeIndex`. The `Status` field is
|
1523
|
+
# set to `ACTIVE` when the index is ready to use.
|
1501
1524
|
#
|
1502
1525
|
# Once the index is active you can index your documents using the
|
1503
|
-
# `BatchPutDocument`
|
1504
|
-
# sources.
|
1526
|
+
# `BatchPutDocument` API or using one of the supported data sources.
|
1505
1527
|
#
|
1506
1528
|
# @option params [required, String] :name
|
1507
1529
|
# The name for the new index.
|
@@ -1526,8 +1548,8 @@ module Aws::Kendra
|
|
1526
1548
|
# @option params [required, String] :role_arn
|
1527
1549
|
# An Identity and Access Management(IAM) role that gives Amazon Kendra
|
1528
1550
|
# permissions to access your Amazon CloudWatch logs and metrics. This is
|
1529
|
-
# also the role used when you use the `BatchPutDocument`
|
1530
|
-
#
|
1551
|
+
# also the role used when you use the `BatchPutDocument` API to index
|
1552
|
+
# documents from an Amazon S3 bucket.
|
1531
1553
|
#
|
1532
1554
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
1533
1555
|
# The identifier of the KMScustomer managed key (CMK) to use to encrypt
|
@@ -1539,8 +1561,8 @@ module Aws::Kendra
|
|
1539
1561
|
#
|
1540
1562
|
# @option params [String] :client_token
|
1541
1563
|
# A token that you provide to identify the request to create an index.
|
1542
|
-
# Multiple calls to the `CreateIndex`
|
1543
|
-
#
|
1564
|
+
# Multiple calls to the `CreateIndex` API with the same client token
|
1565
|
+
# will create only one index.
|
1544
1566
|
#
|
1545
1567
|
# **A suitable default value is auto-generated.** You should normally
|
1546
1568
|
# not need to pass this option.**
|
@@ -1694,9 +1716,10 @@ module Aws::Kendra
|
|
1694
1716
|
# The IAM (Identity and Access Management) role used by Amazon Kendra to
|
1695
1717
|
# access the block list text file in your S3 bucket.
|
1696
1718
|
#
|
1697
|
-
# You need permissions to the role ARN (Amazon
|
1698
|
-
# needs S3 read permissions to your file in S3 and needs
|
1699
|
-
# (Security Token Service) assume role permissions to Amazon
|
1719
|
+
# You need permissions to the role ARN (Amazon Web Services Resource
|
1720
|
+
# Name). The role needs S3 read permissions to your file in S3 and needs
|
1721
|
+
# to give STS (Security Token Service) assume role permissions to Amazon
|
1722
|
+
# Kendra.
|
1700
1723
|
#
|
1701
1724
|
# @option params [Array<Types::Tag>] :tags
|
1702
1725
|
# A tag that you can assign to a block list that categorizes the block
|
@@ -1765,8 +1788,8 @@ module Aws::Kendra
|
|
1765
1788
|
#
|
1766
1789
|
# @option params [String] :client_token
|
1767
1790
|
# A token that you provide to identify the request to create a
|
1768
|
-
# thesaurus. Multiple calls to the `CreateThesaurus`
|
1769
|
-
#
|
1791
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` API with the same
|
1792
|
+
# client token will create only one thesaurus.
|
1770
1793
|
#
|
1771
1794
|
# **A suitable default value is auto-generated.** You should normally
|
1772
1795
|
# not need to pass this option.**
|
@@ -1811,8 +1834,8 @@ module Aws::Kendra
|
|
1811
1834
|
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
1812
1835
|
# the data source is already being deleted. While the data source is
|
1813
1836
|
# being deleted, the `Status` field returned by a call to the
|
1814
|
-
# `DescribeDataSource`
|
1815
|
-
#
|
1837
|
+
# `DescribeDataSource` API is set to `DELETING`. For more information,
|
1838
|
+
# see [Deleting Data Sources][1].
|
1816
1839
|
#
|
1817
1840
|
#
|
1818
1841
|
#
|
@@ -1903,8 +1926,8 @@ module Aws::Kendra
|
|
1903
1926
|
|
1904
1927
|
# Deletes an existing Amazon Kendra index. An exception is not thrown if
|
1905
1928
|
# the index is already being deleted. While the index is being deleted,
|
1906
|
-
# the `Status` field returned by a call to the `DescribeIndex`
|
1907
|
-
#
|
1929
|
+
# the `Status` field returned by a call to the `DescribeIndex` API is
|
1930
|
+
# set to `DELETING`.
|
1908
1931
|
#
|
1909
1932
|
# @option params [required, String] :id
|
1910
1933
|
# The identifier of the index to delete.
|
@@ -2060,7 +2083,7 @@ module Aws::Kendra
|
|
2060
2083
|
req.send_request(options)
|
2061
2084
|
end
|
2062
2085
|
|
2063
|
-
# Gets information about
|
2086
|
+
# Gets information about an Amazon Kendra data source.
|
2064
2087
|
#
|
2065
2088
|
# @option params [required, String] :id
|
2066
2089
|
# The unique identifier of the data source to describe.
|
@@ -2097,7 +2120,7 @@ module Aws::Kendra
|
|
2097
2120
|
# resp.id #=> String
|
2098
2121
|
# resp.index_id #=> String
|
2099
2122
|
# resp.name #=> String
|
2100
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
|
2123
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX"
|
2101
2124
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
2102
2125
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
2103
2126
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -2316,6 +2339,21 @@ module Aws::Kendra
|
|
2316
2339
|
# resp.configuration.work_docs_configuration.field_mappings[0].data_source_field_name #=> String
|
2317
2340
|
# resp.configuration.work_docs_configuration.field_mappings[0].date_field_format #=> String
|
2318
2341
|
# resp.configuration.work_docs_configuration.field_mappings[0].index_field_name #=> String
|
2342
|
+
# resp.configuration.fsx_configuration.file_system_id #=> String
|
2343
|
+
# resp.configuration.fsx_configuration.file_system_type #=> String, one of "WINDOWS"
|
2344
|
+
# resp.configuration.fsx_configuration.vpc_configuration.subnet_ids #=> Array
|
2345
|
+
# resp.configuration.fsx_configuration.vpc_configuration.subnet_ids[0] #=> String
|
2346
|
+
# resp.configuration.fsx_configuration.vpc_configuration.security_group_ids #=> Array
|
2347
|
+
# resp.configuration.fsx_configuration.vpc_configuration.security_group_ids[0] #=> String
|
2348
|
+
# resp.configuration.fsx_configuration.secret_arn #=> String
|
2349
|
+
# resp.configuration.fsx_configuration.inclusion_patterns #=> Array
|
2350
|
+
# resp.configuration.fsx_configuration.inclusion_patterns[0] #=> String
|
2351
|
+
# resp.configuration.fsx_configuration.exclusion_patterns #=> Array
|
2352
|
+
# resp.configuration.fsx_configuration.exclusion_patterns[0] #=> String
|
2353
|
+
# resp.configuration.fsx_configuration.field_mappings #=> Array
|
2354
|
+
# resp.configuration.fsx_configuration.field_mappings[0].data_source_field_name #=> String
|
2355
|
+
# resp.configuration.fsx_configuration.field_mappings[0].date_field_format #=> String
|
2356
|
+
# resp.configuration.fsx_configuration.field_mappings[0].index_field_name #=> String
|
2319
2357
|
# resp.created_at #=> Time
|
2320
2358
|
# resp.updated_at #=> Time
|
2321
2359
|
# resp.description #=> String
|
@@ -3011,6 +3049,8 @@ module Aws::Kendra
|
|
3011
3049
|
# * {Types::GetSnapshotsResponse#snapshots_data #snapshots_data} => Array<Array<String>>
|
3012
3050
|
# * {Types::GetSnapshotsResponse#next_token #next_token} => String
|
3013
3051
|
#
|
3052
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3053
|
+
#
|
3014
3054
|
# @example Request syntax with placeholder values
|
3015
3055
|
#
|
3016
3056
|
# resp = client.get_snapshots({
|
@@ -3148,7 +3188,7 @@ module Aws::Kendra
|
|
3148
3188
|
# resp.summary_items #=> Array
|
3149
3189
|
# resp.summary_items[0].name #=> String
|
3150
3190
|
# resp.summary_items[0].id #=> String
|
3151
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
|
3191
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX"
|
3152
3192
|
# resp.summary_items[0].created_at #=> Time
|
3153
3193
|
# resp.summary_items[0].updated_at #=> Time
|
3154
3194
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -3752,8 +3792,8 @@ module Aws::Kendra
|
|
3752
3792
|
end
|
3753
3793
|
|
3754
3794
|
# Searches an active index. Use this API to search your documents using
|
3755
|
-
# query. The `Query`
|
3756
|
-
#
|
3795
|
+
# query. The `Query` API enables to do faceted search and to filter
|
3796
|
+
# results based on document attributes.
|
3757
3797
|
#
|
3758
3798
|
# It also enables you to provide user context that Amazon Kendra uses to
|
3759
3799
|
# enforce document access control in the search results.
|
@@ -3775,9 +3815,9 @@ module Aws::Kendra
|
|
3775
3815
|
#
|
3776
3816
|
# @option params [required, String] :index_id
|
3777
3817
|
# The unique identifier of the index to search. The identifier is
|
3778
|
-
# returned in the response from the `CreateIndex`
|
3818
|
+
# returned in the response from the `CreateIndex` API.
|
3779
3819
|
#
|
3780
|
-
# @option params [
|
3820
|
+
# @option params [String] :query_text
|
3781
3821
|
# The text to search for.
|
3782
3822
|
#
|
3783
3823
|
# @option params [Types::AttributeFilter] :attribute_filter
|
@@ -3856,12 +3896,13 @@ module Aws::Kendra
|
|
3856
3896
|
# * {Types::QueryResult#result_items #result_items} => Array<Types::QueryResultItem>
|
3857
3897
|
# * {Types::QueryResult#facet_results #facet_results} => Array<Types::FacetResult>
|
3858
3898
|
# * {Types::QueryResult#total_number_of_results #total_number_of_results} => Integer
|
3899
|
+
# * {Types::QueryResult#warnings #warnings} => Array<Types::Warning>
|
3859
3900
|
#
|
3860
3901
|
# @example Request syntax with placeholder values
|
3861
3902
|
#
|
3862
3903
|
# resp = client.query({
|
3863
3904
|
# index_id: "IndexId", # required
|
3864
|
-
# query_text: "QueryText",
|
3905
|
+
# query_text: "QueryText",
|
3865
3906
|
# attribute_filter: {
|
3866
3907
|
# and_all_filters: [
|
3867
3908
|
# {
|
@@ -4030,6 +4071,9 @@ module Aws::Kendra
|
|
4030
4071
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.date_value #=> Time
|
4031
4072
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].count #=> Integer
|
4032
4073
|
# resp.total_number_of_results #=> Integer
|
4074
|
+
# resp.warnings #=> Array
|
4075
|
+
# resp.warnings[0].message #=> String
|
4076
|
+
# resp.warnings[0].code #=> String, one of "QUERY_LANGUAGE_INVALID_SYNTAX"
|
4033
4077
|
#
|
4034
4078
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query AWS API Documentation
|
4035
4079
|
#
|
@@ -4074,8 +4118,8 @@ module Aws::Kendra
|
|
4074
4118
|
req.send_request(options)
|
4075
4119
|
end
|
4076
4120
|
|
4077
|
-
# Stops a
|
4078
|
-
# synchronization job.
|
4121
|
+
# Stops a synchronization job that is currently running. You can't stop
|
4122
|
+
# a scheduled synchronization job.
|
4079
4123
|
#
|
4080
4124
|
# @option params [required, String] :id
|
4081
4125
|
# The identifier of the data source for which to stop the
|
@@ -4113,8 +4157,7 @@ module Aws::Kendra
|
|
4113
4157
|
#
|
4114
4158
|
# @option params [required, String] :query_id
|
4115
4159
|
# The identifier of the specific query for which you are submitting
|
4116
|
-
# feedback. The query ID is returned in the response to the `Query`
|
4117
|
-
# operation.
|
4160
|
+
# feedback. The query ID is returned in the response to the `Query` API.
|
4118
4161
|
#
|
4119
4162
|
# @option params [Array<Types::ClickFeedback>] :click_feedback_items
|
4120
4163
|
# Tells Amazon Kendra that a particular search result link was chosen by
|
@@ -4585,6 +4628,24 @@ module Aws::Kendra
|
|
4585
4628
|
# },
|
4586
4629
|
# ],
|
4587
4630
|
# },
|
4631
|
+
# fsx_configuration: {
|
4632
|
+
# file_system_id: "FileSystemId", # required
|
4633
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
4634
|
+
# vpc_configuration: { # required
|
4635
|
+
# subnet_ids: ["SubnetId"], # required
|
4636
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4637
|
+
# },
|
4638
|
+
# secret_arn: "SecretArn",
|
4639
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4640
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4641
|
+
# field_mappings: [
|
4642
|
+
# {
|
4643
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4644
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4645
|
+
# index_field_name: "IndexFieldName", # required
|
4646
|
+
# },
|
4647
|
+
# ],
|
4648
|
+
# },
|
4588
4649
|
# },
|
4589
4650
|
# description: "Description",
|
4590
4651
|
# schedule: "ScanSchedule",
|
@@ -4677,10 +4738,9 @@ module Aws::Kendra
|
|
4677
4738
|
#
|
4678
4739
|
# @option params [String] :role_arn
|
4679
4740
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
4680
|
-
# `Query`
|
4681
|
-
#
|
4682
|
-
#
|
4683
|
-
# Kendra][1].
|
4741
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon
|
4742
|
+
# Web Services SSO that stores your user and group information. For more
|
4743
|
+
# information, see [IAM roles for Amazon Kendra][1].
|
4684
4744
|
#
|
4685
4745
|
#
|
4686
4746
|
#
|
@@ -5057,7 +5117,7 @@ module Aws::Kendra
|
|
5057
5117
|
params: params,
|
5058
5118
|
config: config)
|
5059
5119
|
context[:gem_name] = 'aws-sdk-kendra'
|
5060
|
-
context[:gem_version] = '1.
|
5120
|
+
context[:gem_version] = '1.44.0'
|
5061
5121
|
Seahorse::Client::Request.new(handlers, context)
|
5062
5122
|
end
|
5063
5123
|
|
@@ -220,6 +220,9 @@ module Aws::Kendra
|
|
220
220
|
FaqSummary = Shapes::StructureShape.new(name: 'FaqSummary')
|
221
221
|
FaqSummaryItems = Shapes::ListShape.new(name: 'FaqSummaryItems')
|
222
222
|
FeedbackToken = Shapes::StringShape.new(name: 'FeedbackToken')
|
223
|
+
FileSystemId = Shapes::StringShape.new(name: 'FileSystemId')
|
224
|
+
FsxConfiguration = Shapes::StructureShape.new(name: 'FsxConfiguration')
|
225
|
+
FsxFileSystemType = Shapes::StringShape.new(name: 'FsxFileSystemType')
|
223
226
|
GetQuerySuggestionsRequest = Shapes::StructureShape.new(name: 'GetQuerySuggestionsRequest')
|
224
227
|
GetQuerySuggestionsResponse = Shapes::StructureShape.new(name: 'GetQuerySuggestionsResponse')
|
225
228
|
GetSnapshotsRequest = Shapes::StructureShape.new(name: 'GetSnapshotsRequest')
|
@@ -471,6 +474,10 @@ module Aws::Kendra
|
|
471
474
|
ValueImportanceMapKey = Shapes::StringShape.new(name: 'ValueImportanceMapKey')
|
472
475
|
VisitorId = Shapes::StringShape.new(name: 'VisitorId')
|
473
476
|
VpcSecurityGroupId = Shapes::StringShape.new(name: 'VpcSecurityGroupId')
|
477
|
+
Warning = Shapes::StructureShape.new(name: 'Warning')
|
478
|
+
WarningCode = Shapes::StringShape.new(name: 'WarningCode')
|
479
|
+
WarningList = Shapes::ListShape.new(name: 'WarningList')
|
480
|
+
WarningMessage = Shapes::StringShape.new(name: 'WarningMessage')
|
474
481
|
WebCrawlerConfiguration = Shapes::StructureShape.new(name: 'WebCrawlerConfiguration')
|
475
482
|
WebCrawlerMode = Shapes::StringShape.new(name: 'WebCrawlerMode')
|
476
483
|
WorkDocsConfiguration = Shapes::StructureShape.new(name: 'WorkDocsConfiguration')
|
@@ -776,6 +783,7 @@ module Aws::Kendra
|
|
776
783
|
DataSourceConfiguration.add_member(:google_drive_configuration, Shapes::ShapeRef.new(shape: GoogleDriveConfiguration, location_name: "GoogleDriveConfiguration"))
|
777
784
|
DataSourceConfiguration.add_member(:web_crawler_configuration, Shapes::ShapeRef.new(shape: WebCrawlerConfiguration, location_name: "WebCrawlerConfiguration"))
|
778
785
|
DataSourceConfiguration.add_member(:work_docs_configuration, Shapes::ShapeRef.new(shape: WorkDocsConfiguration, location_name: "WorkDocsConfiguration"))
|
786
|
+
DataSourceConfiguration.add_member(:fsx_configuration, Shapes::ShapeRef.new(shape: FsxConfiguration, location_name: "FsxConfiguration"))
|
779
787
|
DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
|
780
788
|
|
781
789
|
DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId"))
|
@@ -1184,6 +1192,15 @@ module Aws::Kendra
|
|
1184
1192
|
|
1185
1193
|
FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
|
1186
1194
|
|
1195
|
+
FsxConfiguration.add_member(:file_system_id, Shapes::ShapeRef.new(shape: FileSystemId, required: true, location_name: "FileSystemId"))
|
1196
|
+
FsxConfiguration.add_member(:file_system_type, Shapes::ShapeRef.new(shape: FsxFileSystemType, required: true, location_name: "FileSystemType"))
|
1197
|
+
FsxConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, required: true, location_name: "VpcConfiguration"))
|
1198
|
+
FsxConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
|
1199
|
+
FsxConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
1200
|
+
FsxConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
1201
|
+
FsxConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings"))
|
1202
|
+
FsxConfiguration.struct_class = Types::FsxConfiguration
|
1203
|
+
|
1187
1204
|
GetQuerySuggestionsRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
1188
1205
|
GetQuerySuggestionsRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: SuggestionQueryText, required: true, location_name: "QueryText"))
|
1189
1206
|
GetQuerySuggestionsRequest.add_member(:max_suggestions_count, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxSuggestionsCount"))
|
@@ -1452,7 +1469,7 @@ module Aws::Kendra
|
|
1452
1469
|
PutPrincipalMappingRequest.struct_class = Types::PutPrincipalMappingRequest
|
1453
1470
|
|
1454
1471
|
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,
|
1472
|
+
QueryRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: QueryText, location_name: "QueryText"))
|
1456
1473
|
QueryRequest.add_member(:attribute_filter, Shapes::ShapeRef.new(shape: AttributeFilter, location_name: "AttributeFilter"))
|
1457
1474
|
QueryRequest.add_member(:facets, Shapes::ShapeRef.new(shape: FacetList, location_name: "Facets"))
|
1458
1475
|
QueryRequest.add_member(:requested_document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "RequestedDocumentAttributes"))
|
@@ -1469,6 +1486,7 @@ module Aws::Kendra
|
|
1469
1486
|
QueryResult.add_member(:result_items, Shapes::ShapeRef.new(shape: QueryResultItemList, location_name: "ResultItems"))
|
1470
1487
|
QueryResult.add_member(:facet_results, Shapes::ShapeRef.new(shape: FacetResultList, location_name: "FacetResults"))
|
1471
1488
|
QueryResult.add_member(:total_number_of_results, Shapes::ShapeRef.new(shape: Integer, location_name: "TotalNumberOfResults"))
|
1489
|
+
QueryResult.add_member(:warnings, Shapes::ShapeRef.new(shape: WarningList, location_name: "Warnings"))
|
1472
1490
|
QueryResult.struct_class = Types::QueryResult
|
1473
1491
|
|
1474
1492
|
QueryResultItem.add_member(:id, Shapes::ShapeRef.new(shape: ResultId, location_name: "Id"))
|
@@ -1835,6 +1853,12 @@ module Aws::Kendra
|
|
1835
1853
|
ValueImportanceMap.key = Shapes::ShapeRef.new(shape: ValueImportanceMapKey)
|
1836
1854
|
ValueImportanceMap.value = Shapes::ShapeRef.new(shape: Importance)
|
1837
1855
|
|
1856
|
+
Warning.add_member(:message, Shapes::ShapeRef.new(shape: WarningMessage, location_name: "Message"))
|
1857
|
+
Warning.add_member(:code, Shapes::ShapeRef.new(shape: WarningCode, location_name: "Code"))
|
1858
|
+
Warning.struct_class = Types::Warning
|
1859
|
+
|
1860
|
+
WarningList.member = Shapes::ShapeRef.new(shape: Warning)
|
1861
|
+
|
1838
1862
|
WebCrawlerConfiguration.add_member(:urls, Shapes::ShapeRef.new(shape: Urls, required: true, location_name: "Urls"))
|
1839
1863
|
WebCrawlerConfiguration.add_member(:crawl_depth, Shapes::ShapeRef.new(shape: CrawlDepth, location_name: "CrawlDepth"))
|
1840
1864
|
WebCrawlerConfiguration.add_member(:max_links_per_page, Shapes::ShapeRef.new(shape: MaxLinksPerPage, location_name: "MaxLinksPerPage"))
|
@@ -2303,6 +2327,12 @@ module Aws::Kendra
|
|
2303
2327
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2304
2328
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
2305
2329
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2330
|
+
o[:pager] = Aws::Pager.new(
|
2331
|
+
limit_key: "max_results",
|
2332
|
+
tokens: {
|
2333
|
+
"next_token" => "next_token"
|
2334
|
+
}
|
2335
|
+
)
|
2306
2336
|
end)
|
2307
2337
|
|
2308
2338
|
api.add_operation(:list_data_source_sync_jobs, Seahorse::Model::Operation.new.tap do |o|
|