aws-sdk-kendra 1.43.0 → 1.44.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1965cfb27afc0c0a1f446f384a993995bf9d940385768f57db4c734772f2fc67
4
- data.tar.gz: 3fcbf198aca174f4267870e6efc4bfec579966b54c4745d1ae2642c3bb1db8c1
3
+ metadata.gz: abe1bc813d061f547ea24edfc597f09fe983e200804638c93c753a6301820dcf
4
+ data.tar.gz: 573e0884d3d9004ae916b1cb97c36502797321a1a3443c76ab2488c5663fb9d0
5
5
  SHA512:
6
- metadata.gz: f2ac02f7249668c087953bc22a82176392e7e3cfb62804b347758ccf2f1b02f8a3e4be36a3f4c3200dde1740febd2511ffe1b2ca8ffc232834b8488aabed80a8
7
- data.tar.gz: 5e79772d4a4cac34d279ba88e7d6cb3536f418d3733a4c5563af7e5a51aefbf1e02f500690a5a18351f7ed01f870dd343d7e59d34cd6317803a6dd4d20f8e73a
6
+ metadata.gz: b0f6e733e9393924459c4becb7a5e0b760bdfe06c2aa3079f3e4644a5e5d37098252bbc865fafb5dadf0d0b919a1f6786d222c8b2fa81d7bf9457821c18f0cf8
7
+ data.tar.gz: a81755a0ff8dbb97208b8882e243fb799d484f43f9ecb0df75a899b5c4bb0b98ff4312c69df5dcea129a670362f16056710ca88959de1e98c930b480cfacde81
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
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
+
4
9
  1.43.0 (2022-02-03)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.43.0
1
+ 1.44.0
@@ -471,7 +471,7 @@ module Aws::Kendra
471
471
  end
472
472
 
473
473
  # Removes one or more documents from an index. The documents must have
474
- # been added with the `BatchPutDocument` operation.
474
+ # been added with the `BatchPutDocument` API.
475
475
  #
476
476
  # The documents are deleted asynchronously. You can see the progress of
477
477
  # the deletion by using Amazon Web Services CloudWatch. Any error
@@ -519,17 +519,16 @@ module Aws::Kendra
519
519
  end
520
520
 
521
521
  # Returns the indexing status for one or more documents submitted with
522
- # the [ BatchPutDocument][1] operation.
522
+ # the [ BatchPutDocument][1] API.
523
523
  #
524
- # When you use the `BatchPutDocument` operation, documents are indexed
525
- # asynchronously. You can use the `BatchGetDocumentStatus` operation to
526
- # get the current status of a list of documents so that you can
527
- # determine if they have been successfully indexed.
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.
528
528
  #
529
- # You can also use the `BatchGetDocumentStatus` operation to check the
530
- # status of the [ BatchDeleteDocument][2] operation. When a document is
531
- # deleted from the index, Amazon Kendra returns `NOT_FOUND` as the
532
- # 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.
533
532
  #
534
533
  #
535
534
  #
@@ -538,7 +537,7 @@ module Aws::Kendra
538
537
  #
539
538
  # @option params [required, String] :index_id
540
539
  # The identifier of the index to add documents to. The index ID is
541
- # returned by the [ CreateIndex ][1] operation.
540
+ # returned by the [CreateIndex ][1] API.
542
541
  #
543
542
  #
544
543
  #
@@ -599,11 +598,11 @@ module Aws::Kendra
599
598
 
600
599
  # Adds one or more documents to an index.
601
600
  #
602
- # The `BatchPutDocument` operation enables you to ingest inline
603
- # documents or a set of documents stored in an Amazon S3 bucket. Use
604
- # this operation to ingest your text and unstructured text into an
605
- # index, add custom attributes to the documents, and to attach an access
606
- # control list to the documents added to the index.
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.
607
606
  #
608
607
  # The documents are indexed asynchronously. You can see the progress of
609
608
  # the batch using Amazon Web Services CloudWatch. Any error messages
@@ -612,11 +611,11 @@ module Aws::Kendra
612
611
  #
613
612
  # @option params [required, String] :index_id
614
613
  # The identifier of the index to add the documents to. You need to
615
- # create the index first using the `CreateIndex` operation.
614
+ # create the index first using the `CreateIndex` API.
616
615
  #
617
616
  # @option params [String] :role_arn
618
617
  # The Amazon Resource Name (ARN) of a role that is allowed to run the
619
- # `BatchPutDocument` operation. For more information, see [IAM Roles for
618
+ # `BatchPutDocument` API. For more information, see [IAM Roles for
620
619
  # Amazon Kendra][1].
621
620
  #
622
621
  #
@@ -626,12 +625,6 @@ module Aws::Kendra
626
625
  # @option params [required, Array<Types::Document>] :documents
627
626
  # One or more documents to add to the index.
628
627
  #
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
628
  # Documents have the following file size limits.
636
629
  #
637
630
  # * 5 MB total size for inline documents
@@ -650,7 +643,7 @@ module Aws::Kendra
650
643
  # @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
651
644
  # Configuration information for altering your document metadata and
652
645
  # content during the document ingestion process when you use the
653
- # `BatchPutDocument` operation.
646
+ # `BatchPutDocument` API.
654
647
  #
655
648
  # For more information on how to create, modify and delete document
656
649
  # metadata, or make other content alterations when you ingest documents
@@ -861,10 +854,10 @@ module Aws::Kendra
861
854
  # A description for the data source.
862
855
  #
863
856
  # @option params [String] :schedule
864
- # Sets the frequency that Amazon Kendra will check the documents in your
857
+ # Sets the frequency for Amazon Kendra to check the documents in your
865
858
  # repository and update the index. If you don't set a schedule Amazon
866
859
  # Kendra will not periodically update the index. You can call the
867
- # `StartDataSourceSyncJob` operation to update the index.
860
+ # `StartDataSourceSyncJob` API to update the index.
868
861
  #
869
862
  # You can't specify the `Schedule` parameter when the `Type` parameter
870
863
  # is set to `CUSTOM`. If you do, you receive a `ValidationException`
@@ -892,8 +885,8 @@ module Aws::Kendra
892
885
  #
893
886
  # @option params [String] :client_token
894
887
  # A token that you provide to identify the request to create a data
895
- # source. Multiple calls to the `CreateDataSource` operation with the
896
- # same client token will create only one data source.
888
+ # source. Multiple calls to the `CreateDataSource` API with the same
889
+ # client token will create only one data source.
897
890
  #
898
891
  # **A suitable default value is auto-generated.** You should normally
899
892
  # not need to pass this option.**
@@ -930,7 +923,7 @@ module Aws::Kendra
930
923
  # resp = client.create_data_source({
931
924
  # name: "DataSourceName", # required
932
925
  # index_id: "IndexId", # required
933
- # 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
934
927
  # configuration: {
935
928
  # s3_configuration: {
936
929
  # bucket_name: "S3BucketName", # required
@@ -1242,6 +1235,24 @@ module Aws::Kendra
1242
1235
  # },
1243
1236
  # ],
1244
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
+ # },
1245
1256
  # },
1246
1257
  # description: "Description",
1247
1258
  # schedule: "ScanSchedule",
@@ -1341,10 +1352,9 @@ module Aws::Kendra
1341
1352
  #
1342
1353
  # @option params [String] :role_arn
1343
1354
  # The Amazon Resource Name (ARN) of a role with permission to access
1344
- # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback`
1345
- # operations, and Amazon Web Services SSO that stores your user and
1346
- # group information. For more information, see [IAM roles for Amazon
1347
- # 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].
1348
1358
  #
1349
1359
  #
1350
1360
  #
@@ -1362,8 +1372,8 @@ module Aws::Kendra
1362
1372
  #
1363
1373
  # @option params [String] :client_token
1364
1374
  # A token that you provide to identify the request to create your Amazon
1365
- # Kendra experience. Multiple calls to the `CreateExperience` operation
1366
- # with the same client token creates only one Amazon Kendra experience.
1375
+ # Kendra experience. Multiple calls to the `CreateExperience` API with
1376
+ # the same client token creates only one Amazon Kendra experience.
1367
1377
  #
1368
1378
  # **A suitable default value is auto-generated.** You should normally
1369
1379
  # not need to pass this option.**
@@ -1452,8 +1462,8 @@ module Aws::Kendra
1452
1462
  #
1453
1463
  # @option params [String] :client_token
1454
1464
  # A token that you provide to identify the request to create a FAQ.
1455
- # Multiple calls to the `CreateFaqRequest` operation with the same
1456
- # client token will create only one FAQ.
1465
+ # Multiple calls to the `CreateFaqRequest` API with the same client
1466
+ # token will create only one FAQ.
1457
1467
  #
1458
1468
  # **A suitable default value is auto-generated.** You should normally
1459
1469
  # not need to pass this option.**
@@ -1508,13 +1518,12 @@ module Aws::Kendra
1508
1518
  end
1509
1519
 
1510
1520
  # Creates a new Amazon Kendra index. Index creation is an asynchronous
1511
- # operation. To determine if index creation has completed, check the
1512
- # `Status` field returned from a call to `DescribeIndex`. The `Status`
1513
- # field is set to `ACTIVE` when the index is ready to use.
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.
1514
1524
  #
1515
1525
  # Once the index is active you can index your documents using the
1516
- # `BatchPutDocument` operation or using one of the supported data
1517
- # sources.
1526
+ # `BatchPutDocument` API or using one of the supported data sources.
1518
1527
  #
1519
1528
  # @option params [required, String] :name
1520
1529
  # The name for the new index.
@@ -1539,8 +1548,8 @@ module Aws::Kendra
1539
1548
  # @option params [required, String] :role_arn
1540
1549
  # An Identity and Access Management(IAM) role that gives Amazon Kendra
1541
1550
  # permissions to access your Amazon CloudWatch logs and metrics. This is
1542
- # also the role used when you use the `BatchPutDocument` operation to
1543
- # index documents from an Amazon S3 bucket.
1551
+ # also the role used when you use the `BatchPutDocument` API to index
1552
+ # documents from an Amazon S3 bucket.
1544
1553
  #
1545
1554
  # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
1546
1555
  # The identifier of the KMScustomer managed key (CMK) to use to encrypt
@@ -1552,8 +1561,8 @@ module Aws::Kendra
1552
1561
  #
1553
1562
  # @option params [String] :client_token
1554
1563
  # A token that you provide to identify the request to create an index.
1555
- # Multiple calls to the `CreateIndex` operation with the same client
1556
- # token will create only one index.
1564
+ # Multiple calls to the `CreateIndex` API with the same client token
1565
+ # will create only one index.
1557
1566
  #
1558
1567
  # **A suitable default value is auto-generated.** You should normally
1559
1568
  # not need to pass this option.**
@@ -1707,9 +1716,10 @@ module Aws::Kendra
1707
1716
  # The IAM (Identity and Access Management) role used by Amazon Kendra to
1708
1717
  # access the block list text file in your S3 bucket.
1709
1718
  #
1710
- # You need permissions to the role ARN (Amazon Resource Name). The role
1711
- # needs S3 read permissions to your file in S3 and needs to give STS
1712
- # (Security Token Service) assume role permissions to Amazon Kendra.
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.
1713
1723
  #
1714
1724
  # @option params [Array<Types::Tag>] :tags
1715
1725
  # A tag that you can assign to a block list that categorizes the block
@@ -1778,8 +1788,8 @@ module Aws::Kendra
1778
1788
  #
1779
1789
  # @option params [String] :client_token
1780
1790
  # A token that you provide to identify the request to create a
1781
- # thesaurus. Multiple calls to the `CreateThesaurus` operation with the
1782
- # same client token will create only one thesaurus.
1791
+ # thesaurus. Multiple calls to the `CreateThesaurus` API with the same
1792
+ # client token will create only one thesaurus.
1783
1793
  #
1784
1794
  # **A suitable default value is auto-generated.** You should normally
1785
1795
  # not need to pass this option.**
@@ -1824,8 +1834,8 @@ module Aws::Kendra
1824
1834
  # Deletes an Amazon Kendra data source. An exception is not thrown if
1825
1835
  # the data source is already being deleted. While the data source is
1826
1836
  # being deleted, the `Status` field returned by a call to the
1827
- # `DescribeDataSource` operation is set to `DELETING`. For more
1828
- # information, see [Deleting Data Sources][1].
1837
+ # `DescribeDataSource` API is set to `DELETING`. For more information,
1838
+ # see [Deleting Data Sources][1].
1829
1839
  #
1830
1840
  #
1831
1841
  #
@@ -1916,8 +1926,8 @@ module Aws::Kendra
1916
1926
 
1917
1927
  # Deletes an existing Amazon Kendra index. An exception is not thrown if
1918
1928
  # the index is already being deleted. While the index is being deleted,
1919
- # the `Status` field returned by a call to the `DescribeIndex` operation
1920
- # is set to `DELETING`.
1929
+ # the `Status` field returned by a call to the `DescribeIndex` API is
1930
+ # set to `DELETING`.
1921
1931
  #
1922
1932
  # @option params [required, String] :id
1923
1933
  # The identifier of the index to delete.
@@ -2073,7 +2083,7 @@ module Aws::Kendra
2073
2083
  req.send_request(options)
2074
2084
  end
2075
2085
 
2076
- # Gets information about a Amazon Kendra data source.
2086
+ # Gets information about an Amazon Kendra data source.
2077
2087
  #
2078
2088
  # @option params [required, String] :id
2079
2089
  # The unique identifier of the data source to describe.
@@ -2110,7 +2120,7 @@ module Aws::Kendra
2110
2120
  # resp.id #=> String
2111
2121
  # resp.index_id #=> String
2112
2122
  # resp.name #=> String
2113
- # 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"
2114
2124
  # resp.configuration.s3_configuration.bucket_name #=> String
2115
2125
  # resp.configuration.s3_configuration.inclusion_prefixes #=> Array
2116
2126
  # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
@@ -2329,6 +2339,21 @@ module Aws::Kendra
2329
2339
  # resp.configuration.work_docs_configuration.field_mappings[0].data_source_field_name #=> String
2330
2340
  # resp.configuration.work_docs_configuration.field_mappings[0].date_field_format #=> String
2331
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
2332
2357
  # resp.created_at #=> Time
2333
2358
  # resp.updated_at #=> Time
2334
2359
  # resp.description #=> String
@@ -3163,7 +3188,7 @@ module Aws::Kendra
3163
3188
  # resp.summary_items #=> Array
3164
3189
  # resp.summary_items[0].name #=> String
3165
3190
  # 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"
3191
+ # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX"
3167
3192
  # resp.summary_items[0].created_at #=> Time
3168
3193
  # resp.summary_items[0].updated_at #=> Time
3169
3194
  # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
@@ -3767,8 +3792,8 @@ module Aws::Kendra
3767
3792
  end
3768
3793
 
3769
3794
  # Searches an active index. Use this API to search your documents using
3770
- # query. The `Query` operation enables to do faceted search and to
3771
- # filter results based on document attributes.
3795
+ # query. The `Query` API enables to do faceted search and to filter
3796
+ # results based on document attributes.
3772
3797
  #
3773
3798
  # It also enables you to provide user context that Amazon Kendra uses to
3774
3799
  # enforce document access control in the search results.
@@ -3790,7 +3815,7 @@ module Aws::Kendra
3790
3815
  #
3791
3816
  # @option params [required, String] :index_id
3792
3817
  # The unique identifier of the index to search. The identifier is
3793
- # returned in the response from the `CreateIndex` operation.
3818
+ # returned in the response from the `CreateIndex` API.
3794
3819
  #
3795
3820
  # @option params [String] :query_text
3796
3821
  # The text to search for.
@@ -4093,8 +4118,8 @@ module Aws::Kendra
4093
4118
  req.send_request(options)
4094
4119
  end
4095
4120
 
4096
- # Stops a running synchronization job. You can't stop a scheduled
4097
- # synchronization job.
4121
+ # Stops a synchronization job that is currently running. You can't stop
4122
+ # a scheduled synchronization job.
4098
4123
  #
4099
4124
  # @option params [required, String] :id
4100
4125
  # The identifier of the data source for which to stop the
@@ -4132,8 +4157,7 @@ module Aws::Kendra
4132
4157
  #
4133
4158
  # @option params [required, String] :query_id
4134
4159
  # 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.
4160
+ # feedback. The query ID is returned in the response to the `Query` API.
4137
4161
  #
4138
4162
  # @option params [Array<Types::ClickFeedback>] :click_feedback_items
4139
4163
  # Tells Amazon Kendra that a particular search result link was chosen by
@@ -4604,6 +4628,24 @@ module Aws::Kendra
4604
4628
  # },
4605
4629
  # ],
4606
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
+ # },
4607
4649
  # },
4608
4650
  # description: "Description",
4609
4651
  # schedule: "ScanSchedule",
@@ -4696,10 +4738,9 @@ module Aws::Kendra
4696
4738
  #
4697
4739
  # @option params [String] :role_arn
4698
4740
  # The Amazon Resource Name (ARN) of a role with permission to access
4699
- # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback`
4700
- # operations, and Amazon Web Services SSO that stores your user and
4701
- # group information. For more information, see [IAM roles for Amazon
4702
- # 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].
4703
4744
  #
4704
4745
  #
4705
4746
  #
@@ -5076,7 +5117,7 @@ module Aws::Kendra
5076
5117
  params: params,
5077
5118
  config: config)
5078
5119
  context[:gem_name] = 'aws-sdk-kendra'
5079
- context[:gem_version] = '1.43.0'
5120
+ context[:gem_version] = '1.44.0'
5080
5121
  Seahorse::Client::Request.new(handlers, context)
5081
5122
  end
5082
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')
@@ -780,6 +783,7 @@ module Aws::Kendra
780
783
  DataSourceConfiguration.add_member(:google_drive_configuration, Shapes::ShapeRef.new(shape: GoogleDriveConfiguration, location_name: "GoogleDriveConfiguration"))
781
784
  DataSourceConfiguration.add_member(:web_crawler_configuration, Shapes::ShapeRef.new(shape: WebCrawlerConfiguration, location_name: "WebCrawlerConfiguration"))
782
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"))
783
787
  DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
784
788
 
785
789
  DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId"))
@@ -1188,6 +1192,15 @@ module Aws::Kendra
1188
1192
 
1189
1193
  FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
1190
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
+
1191
1204
  GetQuerySuggestionsRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
1192
1205
  GetQuerySuggestionsRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: SuggestionQueryText, required: true, location_name: "QueryText"))
1193
1206
  GetQuerySuggestionsRequest.add_member(:max_suggestions_count, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxSuggestionsCount"))
@@ -62,7 +62,7 @@ module Aws::Kendra
62
62
  # A list of groups, separated by semi-colons, that filters a query
63
63
  # response based on user context. The document is only returned to
64
64
  # users that are in one of the groups specified in the `UserContext`
65
- # field of the `Query` operation.
65
+ # field of the `Query` API.
66
66
  # @return [String]
67
67
  #
68
68
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
@@ -736,7 +736,7 @@ module Aws::Kendra
736
736
  end
737
737
 
738
738
  # Provides information about documents that could not be removed from an
739
- # index by the `BatchDeleteDocument` operation.
739
+ # index by the `BatchDeleteDocument` API.
740
740
  #
741
741
  # @!attribute [rw] id
742
742
  # The identifier of the document that couldn't be removed from the
@@ -788,7 +788,7 @@ module Aws::Kendra
788
788
  #
789
789
  # @!attribute [rw] index_id
790
790
  # The identifier of the index to add documents to. The index ID is
791
- # returned by the [ CreateIndex ][1] operation.
791
+ # returned by the [CreateIndex ][1] API.
792
792
  #
793
793
  #
794
794
  #
@@ -969,13 +969,13 @@ module Aws::Kendra
969
969
  #
970
970
  # @!attribute [rw] index_id
971
971
  # The identifier of the index to add the documents to. You need to
972
- # create the index first using the `CreateIndex` operation.
972
+ # create the index first using the `CreateIndex` API.
973
973
  # @return [String]
974
974
  #
975
975
  # @!attribute [rw] role_arn
976
976
  # The Amazon Resource Name (ARN) of a role that is allowed to run the
977
- # `BatchPutDocument` operation. For more information, see [IAM Roles
978
- # for Amazon Kendra][1].
977
+ # `BatchPutDocument` API. For more information, see [IAM Roles for
978
+ # Amazon Kendra][1].
979
979
  #
980
980
  #
981
981
  #
@@ -985,13 +985,6 @@ module Aws::Kendra
985
985
  # @!attribute [rw] documents
986
986
  # One or more documents to add to the index.
987
987
  #
988
- # Documents can include custom attributes. For example,
989
- # 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
990
- # that provide information on the synchronization of documents running
991
- # on a data source. Note, 'DataSourceSyncJobId' could be an optional
992
- # custom attribute as Amazon Kendra will use the ID of a running sync
993
- # job.
994
- #
995
988
  # Documents have the following file size limits.
996
989
  #
997
990
  # * 5 MB total size for inline documents
@@ -1011,7 +1004,7 @@ module Aws::Kendra
1011
1004
  # @!attribute [rw] custom_document_enrichment_configuration
1012
1005
  # Configuration information for altering your document metadata and
1013
1006
  # content during the document ingestion process when you use the
1014
- # `BatchPutDocument` operation.
1007
+ # `BatchPutDocument` API.
1015
1008
  #
1016
1009
  # For more information on how to create, modify and delete document
1017
1010
  # metadata, or make other content alterations when you ingest
@@ -1151,8 +1144,8 @@ module Aws::Kendra
1151
1144
  end
1152
1145
 
1153
1146
  # Gathers information about when a particular result was clicked by a
1154
- # user. Your application uses the `SubmitFeedback` operation to provide
1155
- # click information.
1147
+ # user. Your application uses the `SubmitFeedback` API to provide click
1148
+ # information.
1156
1149
  #
1157
1150
  # @note When making an API call, you may pass ClickFeedback
1158
1151
  # data as a hash:
@@ -1214,7 +1207,7 @@ module Aws::Kendra
1214
1207
  # @!attribute [rw] field_mappings
1215
1208
  # An array of objects that map database column names to the
1216
1209
  # corresponding fields in an index. You must first create the fields
1217
- # in the index using the `UpdateIndex` operation.
1210
+ # in the index using the `UpdateIndex` API.
1218
1211
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
1219
1212
  #
1220
1213
  # @!attribute [rw] change_detecting_columns
@@ -1272,7 +1265,7 @@ module Aws::Kendra
1272
1265
  # Defines how attachment metadata fields should be mapped to index
1273
1266
  # fields. Before you can map a field, you must first create an index
1274
1267
  # field with a matching type using the console or the `UpdateIndex`
1275
- # operation.
1268
+ # API.
1276
1269
  #
1277
1270
  # If you specify the `AttachentFieldMappings` parameter, you must
1278
1271
  # specify at least one field mapping.
@@ -1290,8 +1283,7 @@ module Aws::Kendra
1290
1283
  # Defines the mapping between a field in the Confluence data source to a
1291
1284
  # Amazon Kendra index field.
1292
1285
  #
1293
- # You must first create the index field using the `UpdateIndex`
1294
- # operation.
1286
+ # You must first create the index field using the `UpdateIndex` API.
1295
1287
  #
1296
1288
  # @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
1297
1289
  # data as a hash:
@@ -1305,8 +1297,7 @@ module Aws::Kendra
1305
1297
  # @!attribute [rw] data_source_field_name
1306
1298
  # The name of the field in the data source.
1307
1299
  #
1308
- # You must first create the index field using the `UpdateIndex`
1309
- # operation.
1300
+ # You must first create the index field using the `UpdateIndex` API.
1310
1301
  # @return [String]
1311
1302
  #
1312
1303
  # @!attribute [rw] date_field_format
@@ -1334,7 +1325,7 @@ module Aws::Kendra
1334
1325
  # Specifies the blog settings for the Confluence data source. Blogs are
1335
1326
  # always indexed unless filtered from the index by the
1336
1327
  # `ExclusionPatterns` or `InclusionPatterns` fields in the
1337
- # `ConfluenceConfiguration` type.
1328
+ # `ConfluenceConfiguration` object.
1338
1329
  #
1339
1330
  # @note When making an API call, you may pass ConfluenceBlogConfiguration
1340
1331
  # data as a hash:
@@ -1352,8 +1343,7 @@ module Aws::Kendra
1352
1343
  # @!attribute [rw] blog_field_mappings
1353
1344
  # Defines how blog metadata fields should be mapped to index fields.
1354
1345
  # Before you can map a field, you must first create an index field
1355
- # with a matching type using the console or the `UpdateIndex`
1356
- # operation.
1346
+ # with a matching type using the console or the `UpdateIndex` API.
1357
1347
  #
1358
1348
  # If you specify the `BlogFieldMappings` parameter, you must specify
1359
1349
  # at least one field mapping.
@@ -1370,8 +1360,7 @@ module Aws::Kendra
1370
1360
  # Defines the mapping between a blog field in the Confluence data source
1371
1361
  # to a Amazon Kendra index field.
1372
1362
  #
1373
- # You must first create the index field using the `UpdateIndex`
1374
- # operation.
1363
+ # You must first create the index field using the `UpdateIndex` API.
1375
1364
  #
1376
1365
  # @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
1377
1366
  # data as a hash:
@@ -1566,8 +1555,7 @@ module Aws::Kendra
1566
1555
  # @!attribute [rw] page_field_mappings
1567
1556
  # Defines how page metadata fields should be mapped to index fields.
1568
1557
  # Before you can map a field, you must first create an index field
1569
- # with a matching type using the console or the `UpdateIndex`
1570
- # operation.
1558
+ # with a matching type using the console or the `UpdateIndex` API.
1571
1559
  #
1572
1560
  # If you specify the `PageFieldMappings` parameter, you must specify
1573
1561
  # at least one field mapping.
@@ -1584,8 +1572,7 @@ module Aws::Kendra
1584
1572
  # Defines the mapping between a field in the Confluence data source to a
1585
1573
  # Amazon Kendra index field.
1586
1574
  #
1587
- # You must first create the index field using the `UpdateIndex`
1588
- # operation.
1575
+ # You must first create the index field using the `UpdateIndex` API.
1589
1576
  #
1590
1577
  # @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
1591
1578
  # data as a hash:
@@ -1676,8 +1663,7 @@ module Aws::Kendra
1676
1663
  # @!attribute [rw] space_field_mappings
1677
1664
  # Defines how space metadata fields should be mapped to index fields.
1678
1665
  # Before you can map a field, you must first create an index field
1679
- # with a matching type using the console or the `UpdateIndex`
1680
- # operation.
1666
+ # with a matching type using the console or the `UpdateIndex` API.
1681
1667
  #
1682
1668
  # If you specify the `SpaceFieldMappings` parameter, you must specify
1683
1669
  # at least one field mapping.
@@ -1695,11 +1681,10 @@ module Aws::Kendra
1695
1681
  include Aws::Structure
1696
1682
  end
1697
1683
 
1698
- # Defines the mapping between a field in the Confluence data source to a
1699
- # Amazon Kendra index field.
1684
+ # Defines the mapping between a field in the Confluence data source to
1685
+ # an Amazon Kendra index field.
1700
1686
  #
1701
- # You must first create the index field using the `UpdateIndex`
1702
- # operation.
1687
+ # You must first create the index field using the `UpdateIndex` API.
1703
1688
  #
1704
1689
  # @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
1705
1690
  # data as a hash:
@@ -1819,7 +1804,7 @@ module Aws::Kendra
1819
1804
  #
1820
1805
  # @!attribute [rw] direct_put_content
1821
1806
  # `TRUE` to use documents you indexed directly using the
1822
- # `BatchPutDocument` operation.
1807
+ # `BatchPutDocument` API.
1823
1808
  # @return [Boolean]
1824
1809
  #
1825
1810
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ContentSourceConfiguration AWS API Documentation
@@ -1838,7 +1823,7 @@ module Aws::Kendra
1838
1823
  # {
1839
1824
  # name: "DataSourceName", # required
1840
1825
  # index_id: "IndexId", # required
1841
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS
1826
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX
1842
1827
  # configuration: {
1843
1828
  # s3_configuration: {
1844
1829
  # bucket_name: "S3BucketName", # required
@@ -2150,6 +2135,24 @@ module Aws::Kendra
2150
2135
  # },
2151
2136
  # ],
2152
2137
  # },
2138
+ # fsx_configuration: {
2139
+ # file_system_id: "FileSystemId", # required
2140
+ # file_system_type: "WINDOWS", # required, accepts WINDOWS
2141
+ # vpc_configuration: { # required
2142
+ # subnet_ids: ["SubnetId"], # required
2143
+ # security_group_ids: ["VpcSecurityGroupId"], # required
2144
+ # },
2145
+ # secret_arn: "SecretArn",
2146
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2147
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2148
+ # field_mappings: [
2149
+ # {
2150
+ # data_source_field_name: "DataSourceFieldName", # required
2151
+ # date_field_format: "DataSourceDateFieldFormat",
2152
+ # index_field_name: "IndexFieldName", # required
2153
+ # },
2154
+ # ],
2155
+ # },
2153
2156
  # },
2154
2157
  # description: "Description",
2155
2158
  # schedule: "ScanSchedule",
@@ -2251,10 +2254,10 @@ module Aws::Kendra
2251
2254
  # @return [String]
2252
2255
  #
2253
2256
  # @!attribute [rw] schedule
2254
- # Sets the frequency that Amazon Kendra will check the documents in
2255
- # your repository and update the index. If you don't set a schedule
2256
- # Amazon Kendra will not periodically update the index. You can call
2257
- # the `StartDataSourceSyncJob` operation to update the index.
2257
+ # Sets the frequency for Amazon Kendra to check the documents in your
2258
+ # repository and update the index. If you don't set a schedule Amazon
2259
+ # Kendra will not periodically update the index. You can call the
2260
+ # `StartDataSourceSyncJob` API to update the index.
2258
2261
  #
2259
2262
  # You can't specify the `Schedule` parameter when the `Type`
2260
2263
  # parameter is set to `CUSTOM`. If you do, you receive a
@@ -2285,8 +2288,8 @@ module Aws::Kendra
2285
2288
  #
2286
2289
  # @!attribute [rw] client_token
2287
2290
  # A token that you provide to identify the request to create a data
2288
- # source. Multiple calls to the `CreateDataSource` operation with the
2289
- # same client token will create only one data source.
2291
+ # source. Multiple calls to the `CreateDataSource` API with the same
2292
+ # client token will create only one data source.
2290
2293
  #
2291
2294
  # **A suitable default value is auto-generated.** You should normally
2292
2295
  # not need to pass this option.
@@ -2379,10 +2382,9 @@ module Aws::Kendra
2379
2382
  #
2380
2383
  # @!attribute [rw] role_arn
2381
2384
  # The Amazon Resource Name (ARN) of a role with permission to access
2382
- # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback`
2383
- # operations, and Amazon Web Services SSO that stores your user and
2384
- # group information. For more information, see [IAM roles for Amazon
2385
- # Kendra][1].
2385
+ # `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
2386
+ # Amazon Web Services SSO that stores your user and group information.
2387
+ # For more information, see [IAM roles for Amazon Kendra][1].
2386
2388
  #
2387
2389
  #
2388
2390
  #
@@ -2404,7 +2406,7 @@ module Aws::Kendra
2404
2406
  # @!attribute [rw] client_token
2405
2407
  # A token that you provide to identify the request to create your
2406
2408
  # Amazon Kendra experience. Multiple calls to the `CreateExperience`
2407
- # operation with the same client token creates only one Amazon Kendra
2409
+ # API with the same client token creates only one Amazon Kendra
2408
2410
  # experience.
2409
2411
  #
2410
2412
  # **A suitable default value is auto-generated.** You should normally
@@ -2508,8 +2510,8 @@ module Aws::Kendra
2508
2510
  #
2509
2511
  # @!attribute [rw] client_token
2510
2512
  # A token that you provide to identify the request to create a FAQ.
2511
- # Multiple calls to the `CreateFaqRequest` operation with the same
2512
- # client token will create only one FAQ.
2513
+ # Multiple calls to the `CreateFaqRequest` API with the same client
2514
+ # token will create only one FAQ.
2513
2515
  #
2514
2516
  # **A suitable default value is auto-generated.** You should normally
2515
2517
  # not need to pass this option.
@@ -2620,8 +2622,8 @@ module Aws::Kendra
2620
2622
  # @!attribute [rw] role_arn
2621
2623
  # An Identity and Access Management(IAM) role that gives Amazon Kendra
2622
2624
  # permissions to access your Amazon CloudWatch logs and metrics. This
2623
- # is also the role used when you use the `BatchPutDocument` operation
2624
- # to index documents from an Amazon S3 bucket.
2625
+ # is also the role used when you use the `BatchPutDocument` API to
2626
+ # index documents from an Amazon S3 bucket.
2625
2627
  # @return [String]
2626
2628
  #
2627
2629
  # @!attribute [rw] server_side_encryption_configuration
@@ -2636,8 +2638,8 @@ module Aws::Kendra
2636
2638
  #
2637
2639
  # @!attribute [rw] client_token
2638
2640
  # A token that you provide to identify the request to create an index.
2639
- # Multiple calls to the `CreateIndex` operation with the same client
2640
- # token will create only one index.
2641
+ # Multiple calls to the `CreateIndex` API with the same client token
2642
+ # will create only one index.
2641
2643
  #
2642
2644
  # **A suitable default value is auto-generated.** You should normally
2643
2645
  # not need to pass this option.
@@ -2778,10 +2780,10 @@ module Aws::Kendra
2778
2780
  # The IAM (Identity and Access Management) role used by Amazon Kendra
2779
2781
  # to access the block list text file in your S3 bucket.
2780
2782
  #
2781
- # You need permissions to the role ARN (Amazon Resource Name). The
2782
- # role needs S3 read permissions to your file in S3 and needs to give
2783
- # STS (Security Token Service) assume role permissions to Amazon
2784
- # Kendra.
2783
+ # You need permissions to the role ARN (Amazon Web Services Resource
2784
+ # Name). The role needs S3 read permissions to your file in S3 and
2785
+ # needs to give STS (Security Token Service) assume role permissions
2786
+ # to Amazon Kendra.
2785
2787
  # @return [String]
2786
2788
  #
2787
2789
  # @!attribute [rw] tags
@@ -2865,8 +2867,8 @@ module Aws::Kendra
2865
2867
  #
2866
2868
  # @!attribute [rw] client_token
2867
2869
  # A token that you provide to identify the request to create a
2868
- # thesaurus. Multiple calls to the `CreateThesaurus` operation with
2869
- # the same client token will create only one thesaurus.
2870
+ # thesaurus. Multiple calls to the `CreateThesaurus` API with the same
2871
+ # client token will create only one thesaurus.
2870
2872
  #
2871
2873
  # **A suitable default value is auto-generated.** You should normally
2872
2874
  # not need to pass this option.
@@ -3336,6 +3338,24 @@ module Aws::Kendra
3336
3338
  # },
3337
3339
  # ],
3338
3340
  # },
3341
+ # fsx_configuration: {
3342
+ # file_system_id: "FileSystemId", # required
3343
+ # file_system_type: "WINDOWS", # required, accepts WINDOWS
3344
+ # vpc_configuration: { # required
3345
+ # subnet_ids: ["SubnetId"], # required
3346
+ # security_group_ids: ["VpcSecurityGroupId"], # required
3347
+ # },
3348
+ # secret_arn: "SecretArn",
3349
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3350
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3351
+ # field_mappings: [
3352
+ # {
3353
+ # data_source_field_name: "DataSourceFieldName", # required
3354
+ # date_field_format: "DataSourceDateFieldFormat",
3355
+ # index_field_name: "IndexFieldName", # required
3356
+ # },
3357
+ # ],
3358
+ # },
3339
3359
  # }
3340
3360
  #
3341
3361
  # @!attribute [rw] s3_configuration
@@ -3384,10 +3404,15 @@ module Aws::Kendra
3384
3404
  # @return [Types::WebCrawlerConfiguration]
3385
3405
  #
3386
3406
  # @!attribute [rw] work_docs_configuration
3387
- # Provides the configuration information to connect to WorkDocs as
3388
- # your data source.
3407
+ # Provides the configuration information to connect to Amazon WorkDocs
3408
+ # as your data source.
3389
3409
  # @return [Types::WorkDocsConfiguration]
3390
3410
  #
3411
+ # @!attribute [rw] fsx_configuration
3412
+ # Provides the configuration information to connect to Amazon FSx as
3413
+ # your data source.
3414
+ # @return [Types::FsxConfiguration]
3415
+ #
3391
3416
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
3392
3417
  #
3393
3418
  class DataSourceConfiguration < Struct.new(
@@ -3400,7 +3425,8 @@ module Aws::Kendra
3400
3425
  :confluence_configuration,
3401
3426
  :google_drive_configuration,
3402
3427
  :web_crawler_configuration,
3403
- :work_docs_configuration)
3428
+ :work_docs_configuration,
3429
+ :fsx_configuration)
3404
3430
  SENSITIVE = []
3405
3431
  include Aws::Structure
3406
3432
  end
@@ -3436,8 +3462,8 @@ module Aws::Kendra
3436
3462
  include Aws::Structure
3437
3463
  end
3438
3464
 
3439
- # Summary information for a Amazon Kendra data source. Returned in a
3440
- # call to the `DescribeDataSource` operation.
3465
+ # Summary information for an Amazon Kendra data source. Returned in a
3466
+ # call to the `DescribeDataSource` API.
3441
3467
  #
3442
3468
  # @!attribute [rw] name
3443
3469
  # The name of the data source.
@@ -3489,18 +3515,18 @@ module Aws::Kendra
3489
3515
  include Aws::Structure
3490
3516
  end
3491
3517
 
3492
- # Provides information about a synchronization job.
3518
+ # Provides information about a data source synchronization job.
3493
3519
  #
3494
3520
  # @!attribute [rw] execution_id
3495
3521
  # A unique identifier for the synchronization job.
3496
3522
  # @return [String]
3497
3523
  #
3498
3524
  # @!attribute [rw] start_time
3499
- # The UNIX datetime that the synchronization job was started.
3525
+ # The UNIX datetime that the synchronization job started.
3500
3526
  # @return [Time]
3501
3527
  #
3502
3528
  # @!attribute [rw] end_time
3503
- # The UNIX datetime that the synchronization job was completed.
3529
+ # The UNIX datetime that the synchronization job completed.
3504
3530
  # @return [Time]
3505
3531
  #
3506
3532
  # @!attribute [rw] status
@@ -3518,7 +3544,7 @@ module Aws::Kendra
3518
3544
  #
3519
3545
  # @!attribute [rw] error_code
3520
3546
  # If the `Status` field is set to `FAILED`, the `ErrorCode` field
3521
- # contains a the reason that the synchronization failed.
3547
+ # indicates the reason the synchronization failed.
3522
3548
  # @return [String]
3523
3549
  #
3524
3550
  # @!attribute [rw] data_source_error_code
@@ -3626,8 +3652,7 @@ module Aws::Kendra
3626
3652
  end
3627
3653
 
3628
3654
  # Maps a column or attribute in the data source to an index field. You
3629
- # must first create the fields in the index using the `UpdateIndex`
3630
- # operation.
3655
+ # must first create the fields in the index using the `UpdateIndex` API.
3631
3656
  #
3632
3657
  # @note When making an API call, you may pass DataSourceToIndexFieldMapping
3633
3658
  # data as a hash:
@@ -4048,7 +4073,7 @@ module Aws::Kendra
4048
4073
  # @return [String]
4049
4074
  #
4050
4075
  # @!attribute [rw] schedule
4051
- # The schedule that Amazon Kendra will update the data source.
4076
+ # The schedule for Amazon Kendra to update the index.
4052
4077
  # @return [String]
4053
4078
  #
4054
4079
  # @!attribute [rw] role_arn
@@ -4182,9 +4207,9 @@ module Aws::Kendra
4182
4207
  #
4183
4208
  # @!attribute [rw] role_arn
4184
4209
  # Shows the Amazon Resource Name (ARN) of a role with permission to
4185
- # access `Query` operations, `QuerySuggestions` operations,
4186
- # `SubmitFeedback` operations, and Amazon Web Services SSO that stores
4187
- # your user and group information.
4210
+ # access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API,
4211
+ # and Amazon Web Services SSO that stores your user and group
4212
+ # information.
4188
4213
  # @return [String]
4189
4214
  #
4190
4215
  # @!attribute [rw] error_message
@@ -4649,7 +4674,7 @@ module Aws::Kendra
4649
4674
  #
4650
4675
  # By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
4651
4676
  # turns off query suggestions for your users. You can change the mode
4652
- # using the [UpdateQuerySuggestionsConfig][1] operation.
4677
+ # using the [UpdateQuerySuggestionsConfig][1] API.
4653
4678
  #
4654
4679
  #
4655
4680
  #
@@ -4987,9 +5012,9 @@ module Aws::Kendra
4987
5012
  #
4988
5013
  # Documents passed to the `Blob` parameter must be base64 encoded.
4989
5014
  # Your code might not need to encode the document file bytes if
4990
- # you're using an Amazon Web Services SDK to call Amazon Kendra
4991
- # operations. If you are calling the Amazon Kendra endpoint directly
4992
- # using REST, you must base64 encode the contents before sending.
5015
+ # you're using an Amazon Web Services SDK to call Amazon Kendra APIs.
5016
+ # If you are calling the Amazon Kendra endpoint directly using REST,
5017
+ # you must base64 encode the contents before sending.
4993
5018
  # @return [String]
4994
5019
  #
4995
5020
  # @!attribute [rw] s3_path
@@ -5001,6 +5026,12 @@ module Aws::Kendra
5001
5026
  # attributes to provide additional information for searching, to
5002
5027
  # provide facets for refining searches, and to provide additional
5003
5028
  # information in the query response.
5029
+ #
5030
+ # For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom
5031
+ # attributes that provide information on the synchronization of
5032
+ # documents running on a data source. Note, 'DataSourceSyncJobId'
5033
+ # could be an optional custom attribute as Amazon Kendra will use the
5034
+ # ID of a running sync job.
5004
5035
  # @return [Array<Types::DocumentAttribute>]
5005
5036
  #
5006
5037
  # @!attribute [rw] access_control_list
@@ -5577,8 +5608,8 @@ module Aws::Kendra
5577
5608
  # @!attribute [rw] content_source_configuration
5578
5609
  # The identifiers of your data sources and FAQs. Or, you can specify
5579
5610
  # that you want to use documents indexed via the `BatchPutDocument`
5580
- # operation. This is the content you want to use for your Amazon
5581
- # Kendra experience.
5611
+ # API. This is the content you want to use for your Amazon Kendra
5612
+ # experience.
5582
5613
  # @return [Types::ContentSourceConfiguration]
5583
5614
  #
5584
5615
  # @!attribute [rw] user_identity_configuration
@@ -5837,6 +5868,117 @@ module Aws::Kendra
5837
5868
  include Aws::Structure
5838
5869
  end
5839
5870
 
5871
+ # Provides the configuration information to connect to Amazon FSx as
5872
+ # your data source.
5873
+ #
5874
+ # @note When making an API call, you may pass FsxConfiguration
5875
+ # data as a hash:
5876
+ #
5877
+ # {
5878
+ # file_system_id: "FileSystemId", # required
5879
+ # file_system_type: "WINDOWS", # required, accepts WINDOWS
5880
+ # vpc_configuration: { # required
5881
+ # subnet_ids: ["SubnetId"], # required
5882
+ # security_group_ids: ["VpcSecurityGroupId"], # required
5883
+ # },
5884
+ # secret_arn: "SecretArn",
5885
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
5886
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
5887
+ # field_mappings: [
5888
+ # {
5889
+ # data_source_field_name: "DataSourceFieldName", # required
5890
+ # date_field_format: "DataSourceDateFieldFormat",
5891
+ # index_field_name: "IndexFieldName", # required
5892
+ # },
5893
+ # ],
5894
+ # }
5895
+ #
5896
+ # @!attribute [rw] file_system_id
5897
+ # The identifier of the Amazon FSx file system.
5898
+ #
5899
+ # You can find your file system ID on the file system dashboard in the
5900
+ # Amazon FSx console. For information on how to create a file system
5901
+ # in Amazon FSx console, using Windows File Server as an example, see
5902
+ # [Amazon FSx Getting started guide][1].
5903
+ #
5904
+ #
5905
+ #
5906
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html
5907
+ # @return [String]
5908
+ #
5909
+ # @!attribute [rw] file_system_type
5910
+ # The Amazon FSx file system type. Windows is currently the only
5911
+ # supported type.
5912
+ # @return [String]
5913
+ #
5914
+ # @!attribute [rw] vpc_configuration
5915
+ # Provides the configuration information for connecting to an Amazon
5916
+ # Virtual Private Cloud for your Amazon FSx. Your Amazon FSx instance
5917
+ # must reside inside your VPC.
5918
+ # @return [Types::DataSourceVpcConfiguration]
5919
+ #
5920
+ # @!attribute [rw] secret_arn
5921
+ # The Amazon Resource Name (ARN) of an Secrets Manager secret that
5922
+ # contains the key-value pairs required to connect to your Amazon FSx
5923
+ # file system. Windows is currently the only supported type. The
5924
+ # secret must contain a JSON structure with the following keys:
5925
+ #
5926
+ # * username—The Active Directory user name, along with the Domain
5927
+ # Name System (DNS) domain name. For example,
5928
+ # *user@corp.example.com*. The Active Directory user account must
5929
+ # have read and mounting access to the Amazon FSx file system for
5930
+ # Windows.
5931
+ #
5932
+ # * password—The password of the active directory user with read and
5933
+ # mounting access Amazon FSx Windows file system.
5934
+ # @return [String]
5935
+ #
5936
+ # @!attribute [rw] inclusion_patterns
5937
+ # A list of regular expression patterns to include certain files in
5938
+ # your Amazon FSx file system. Files that match the patterns are
5939
+ # included in the index. Files that don't match the patterns are
5940
+ # excluded from the index. If a file matches both an inclusion pattern
5941
+ # and an exclusion pattern, the exclusion pattern takes precedence and
5942
+ # the file isn't included in the index.
5943
+ # @return [Array<String>]
5944
+ #
5945
+ # @!attribute [rw] exclusion_patterns
5946
+ # A list of regular expression patterns to exclude certain files in
5947
+ # your Amazon FSx file system. Files that match the patterns are
5948
+ # excluded from the index. Files that don’t match the patterns are
5949
+ # included in the index. If a file matches both an inclusion pattern
5950
+ # and an exclusion pattern, the exclusion pattern takes precedence and
5951
+ # the file isn't included in the index.
5952
+ # @return [Array<String>]
5953
+ #
5954
+ # @!attribute [rw] field_mappings
5955
+ # A list of `DataSourceToIndexFieldMapping` objects that map Amazon
5956
+ # FSx data source attributes or field names to Amazon Kendra index
5957
+ # field names in Amazon Kendra. To create custom fields, use the
5958
+ # `UpdateIndex` API before you map to Amazon FSx fields. For more
5959
+ # information, see [Mapping data source fields][1]. The Amazon FSx
5960
+ # data source field names must exist in your Amazon FSx custom
5961
+ # metadata.
5962
+ #
5963
+ #
5964
+ #
5965
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
5966
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
5967
+ #
5968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FsxConfiguration AWS API Documentation
5969
+ #
5970
+ class FsxConfiguration < Struct.new(
5971
+ :file_system_id,
5972
+ :file_system_type,
5973
+ :vpc_configuration,
5974
+ :secret_arn,
5975
+ :inclusion_patterns,
5976
+ :exclusion_patterns,
5977
+ :field_mappings)
5978
+ SENSITIVE = []
5979
+ include Aws::Structure
5980
+ end
5981
+
5840
5982
  # @note When making an API call, you may pass GetQuerySuggestionsRequest
5841
5983
  # data as a hash:
5842
5984
  #
@@ -6056,7 +6198,7 @@ module Aws::Kendra
6056
6198
  #
6057
6199
  # If you are using the console, you can define index fields when
6058
6200
  # creating the mapping. If you are using the API, you must first
6059
- # create the field using the `UpdateIndex` operation.
6201
+ # create the field using the `UpdateIndex` API.
6060
6202
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
6061
6203
  #
6062
6204
  # @!attribute [rw] exclude_mime_types
@@ -6372,7 +6514,7 @@ module Aws::Kendra
6372
6514
  #
6373
6515
  # @!attribute [rw] id
6374
6516
  # A unique identifier for the index. Use this to identify the index
6375
- # when you are using operations such as `Query`, `DescribeIndex`,
6517
+ # when you are using APIs such as `Query`, `DescribeIndex`,
6376
6518
  # `UpdateIndex`, and `DeleteIndex`.
6377
6519
  # @return [String]
6378
6520
  #
@@ -6387,7 +6529,7 @@ module Aws::Kendra
6387
6529
  #
6388
6530
  # @!attribute [rw] updated_at
6389
6531
  # The Unix timestamp when the index was last updated by the
6390
- # `UpdateIndex` operation.
6532
+ # `UpdateIndex` API.
6391
6533
  # @return [Time]
6392
6534
  #
6393
6535
  # @!attribute [rw] status
@@ -7777,7 +7919,7 @@ module Aws::Kendra
7777
7919
  #
7778
7920
  # @!attribute [rw] index_id
7779
7921
  # The unique identifier of the index to search. The identifier is
7780
- # returned in the response from the `CreateIndex` operation.
7922
+ # returned in the response from the `CreateIndex` API.
7781
7923
  # @return [String]
7782
7924
  #
7783
7925
  # @!attribute [rw] query_text
@@ -8148,7 +8290,7 @@ module Aws::Kendra
8148
8290
  end
8149
8291
 
8150
8292
  # Provides feedback on how relevant a document is to a search. Your
8151
- # application uses the `SubmitFeedback` operation to provide relevance
8293
+ # application uses the `SubmitFeedback` API to provide relevance
8152
8294
  # information.
8153
8295
  #
8154
8296
  # @note When making an API call, you may pass RelevanceFeedback
@@ -9321,9 +9463,9 @@ module Aws::Kendra
9321
9463
  # @!attribute [rw] field_mappings
9322
9464
  # A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
9323
9465
  # SharePoint attributes to custom fields in the Amazon Kendra index.
9324
- # You must first create the index fields using the `UpdateIndex`
9325
- # operation before you map SharePoint attributes. For more
9326
- # information, see [Mapping Data Source Fields][1].
9466
+ # You must first create the index fields using the `UpdateIndex` API
9467
+ # before you map SharePoint attributes. For more information, see
9468
+ # [Mapping Data Source Fields][1].
9327
9469
  #
9328
9470
  #
9329
9471
  #
@@ -9614,7 +9756,7 @@ module Aws::Kendra
9614
9756
  # @!attribute [rw] query_id
9615
9757
  # The identifier of the specific query for which you are submitting
9616
9758
  # feedback. The query ID is returned in the response to the `Query`
9617
- # operation.
9759
+ # API.
9618
9760
  # @return [String]
9619
9761
  #
9620
9762
  # @!attribute [rw] click_feedback_items
@@ -10245,6 +10387,24 @@ module Aws::Kendra
10245
10387
  # },
10246
10388
  # ],
10247
10389
  # },
10390
+ # fsx_configuration: {
10391
+ # file_system_id: "FileSystemId", # required
10392
+ # file_system_type: "WINDOWS", # required, accepts WINDOWS
10393
+ # vpc_configuration: { # required
10394
+ # subnet_ids: ["SubnetId"], # required
10395
+ # security_group_ids: ["VpcSecurityGroupId"], # required
10396
+ # },
10397
+ # secret_arn: "SecretArn",
10398
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
10399
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
10400
+ # field_mappings: [
10401
+ # {
10402
+ # data_source_field_name: "DataSourceFieldName", # required
10403
+ # date_field_format: "DataSourceDateFieldFormat",
10404
+ # index_field_name: "IndexFieldName", # required
10405
+ # },
10406
+ # ],
10407
+ # },
10248
10408
  # },
10249
10409
  # description: "Description",
10250
10410
  # schedule: "ScanSchedule",
@@ -10417,10 +10577,9 @@ module Aws::Kendra
10417
10577
  #
10418
10578
  # @!attribute [rw] role_arn
10419
10579
  # The Amazon Resource Name (ARN) of a role with permission to access
10420
- # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback`
10421
- # operations, and Amazon Web Services SSO that stores your user and
10422
- # group information. For more information, see [IAM roles for Amazon
10423
- # Kendra][1].
10580
+ # `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
10581
+ # Amazon Web Services SSO that stores your user and group information.
10582
+ # For more information, see [IAM roles for Amazon Kendra][1].
10424
10583
  #
10425
10584
  #
10426
10585
  #
@@ -10899,7 +11058,7 @@ module Aws::Kendra
10899
11058
  # Amazon Kendra filters search results for different users based on
10900
11059
  # their group's access to documents. You can also map your users to
10901
11060
  # their groups for user context filtering using the [PutPrincipalMapping
10902
- # operation][1].
11061
+ # API][1].
10903
11062
  #
10904
11063
  # To set up an Amazon Web Services SSO identity source in the console to
10905
11064
  # use with Amazon Kendra, see [Getting started with an Amazon Web
@@ -10910,7 +11069,7 @@ module Aws::Kendra
10910
11069
  # Amazon Kendra currently does not support using
10911
11070
  # `UserGroupResolutionConfiguration` with an Amazon Web Services
10912
11071
  # organization member account for your Amazon Web Services SSO identify
10913
- # source. You must create your index in the parent account for the
11072
+ # source. You must create your index in the management account for the
10914
11073
  # organization in order to use `UserGroupResolutionConfiguration`.
10915
11074
  #
10916
11075
  #
@@ -11292,9 +11451,9 @@ module Aws::Kendra
11292
11451
  # A list of `DataSourceToIndexFieldMapping` objects that map Amazon
11293
11452
  # WorkDocs field names to custom index field names in Amazon Kendra.
11294
11453
  # You must first create the custom index fields using the
11295
- # `UpdateIndex` operation before you map to Amazon WorkDocs fields.
11296
- # For more information, see [Mapping Data Source Fields][1]. The
11297
- # Amazon WorkDocs data source field names need to exist in your Amazon
11454
+ # `UpdateIndex` API before you map to Amazon WorkDocs fields. For more
11455
+ # information, see [Mapping Data Source Fields][1]. The Amazon
11456
+ # WorkDocs data source field names need to exist in your Amazon
11298
11457
  # WorkDocs custom metadata.
11299
11458
  #
11300
11459
  #
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
48
48
  # @!group service
49
49
  module Aws::Kendra
50
50
 
51
- GEM_VERSION = '1.43.0'
51
+ GEM_VERSION = '1.44.0'
52
52
 
53
53
  end
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.43.0
4
+ version: 1.44.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: 2022-02-03 00:00:00.000000000 Z
11
+ date: 2022-02-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core