aws-sdk-kendra 1.53.0 → 1.56.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.
@@ -713,6 +713,7 @@ module Aws::Kendra
713
713
  # },
714
714
  # ],
715
715
  # content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
716
+ # access_control_configuration_id: "AccessControlConfigurationId",
716
717
  # },
717
718
  # ],
718
719
  # custom_document_enrichment_configuration: {
@@ -820,6 +821,117 @@ module Aws::Kendra
820
821
  req.send_request(options)
821
822
  end
822
823
 
824
+ # Creates an access configuration for your documents. This includes user
825
+ # and group access information for your documents. This is useful for
826
+ # user context filtering, where search results are filtered based on the
827
+ # user or their group access to documents.
828
+ #
829
+ # You can use this to re-configure your existing document level access
830
+ # control without indexing all of your documents again. For example,
831
+ # your index contains top-secret company documents that only certain
832
+ # employees or users should access. One of these users leaves the
833
+ # company or switches to a team that should be blocked from accessing
834
+ # top-secret documents. The user still has access to top-secret
835
+ # documents because the user had access when your documents were
836
+ # previously indexed. You can create a specific access control
837
+ # configuration for the user with deny access. You can later update the
838
+ # access control configuration to allow access if the user returns to
839
+ # the company and re-joins the 'top-secret' team. You can re-configure
840
+ # access control for your documents as circumstances change.
841
+ #
842
+ # To apply your access control configuration to certain documents, you
843
+ # call the [BatchPutDocument][1] API with the
844
+ # `AccessControlConfigurationId` included in the [Document][2] object.
845
+ # If you use an S3 bucket as a data source, you update the
846
+ # `.metadata.json` with the `AccessControlConfigurationId` and
847
+ # synchronize your data source. Amazon Kendra currently only supports
848
+ # access control configuration for S3 data sources and documents indexed
849
+ # using the `BatchPutDocument` API.
850
+ #
851
+ #
852
+ #
853
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
854
+ # [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html
855
+ #
856
+ # @option params [required, String] :index_id
857
+ # The identifier of the index to create an access control configuration
858
+ # for your documents.
859
+ #
860
+ # @option params [required, String] :name
861
+ # A name for the access control configuration.
862
+ #
863
+ # @option params [String] :description
864
+ # A description for the access control configuration.
865
+ #
866
+ # @option params [Array<Types::Principal>] :access_control_list
867
+ # Information on principals (users and/or groups) and which documents
868
+ # they should have access to. This is useful for user context filtering,
869
+ # where search results are filtered based on the user or their group
870
+ # access to documents.
871
+ #
872
+ # @option params [Array<Types::HierarchicalPrincipal>] :hierarchical_access_control_list
873
+ # The list of [principal][1] lists that define the hierarchy for which
874
+ # documents users should have access to.
875
+ #
876
+ #
877
+ #
878
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
879
+ #
880
+ # @option params [String] :client_token
881
+ # A token that you provide to identify the request to create an access
882
+ # control configuration. Multiple calls to the
883
+ # `CreateAccessControlConfiguration` API with the same client token will
884
+ # create only one access control configuration.
885
+ #
886
+ # **A suitable default value is auto-generated.** You should normally
887
+ # not need to pass this option.**
888
+ #
889
+ # @return [Types::CreateAccessControlConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
890
+ #
891
+ # * {Types::CreateAccessControlConfigurationResponse#id #id} => String
892
+ #
893
+ # @example Request syntax with placeholder values
894
+ #
895
+ # resp = client.create_access_control_configuration({
896
+ # index_id: "IndexId", # required
897
+ # name: "AccessControlConfigurationName", # required
898
+ # description: "Description",
899
+ # access_control_list: [
900
+ # {
901
+ # name: "PrincipalName", # required
902
+ # type: "USER", # required, accepts USER, GROUP
903
+ # access: "ALLOW", # required, accepts ALLOW, DENY
904
+ # data_source_id: "DataSourceId",
905
+ # },
906
+ # ],
907
+ # hierarchical_access_control_list: [
908
+ # {
909
+ # principal_list: [ # required
910
+ # {
911
+ # name: "PrincipalName", # required
912
+ # type: "USER", # required, accepts USER, GROUP
913
+ # access: "ALLOW", # required, accepts ALLOW, DENY
914
+ # data_source_id: "DataSourceId",
915
+ # },
916
+ # ],
917
+ # },
918
+ # ],
919
+ # client_token: "ClientTokenName",
920
+ # })
921
+ #
922
+ # @example Response structure
923
+ #
924
+ # resp.id #=> String
925
+ #
926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfiguration AWS API Documentation
927
+ #
928
+ # @overload create_access_control_configuration(params = {})
929
+ # @param [Hash] params ({})
930
+ def create_access_control_configuration(params = {}, options = {})
931
+ req = build_request(:create_access_control_configuration, params)
932
+ req.send_request(options)
933
+ end
934
+
823
935
  # Creates a data source that you want to use with an Amazon Kendra
824
936
  # index.
825
937
  #
@@ -846,19 +958,17 @@ module Aws::Kendra
846
958
  # [3]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
847
959
  #
848
960
  # @option params [required, String] :name
849
- # A unique name for the data source. A data source name can't be
850
- # changed without deleting and recreating the data source.
961
+ # A name for the data source connector.
851
962
  #
852
963
  # @option params [required, String] :index_id
853
- # The identifier of the index that should be associated with this data
854
- # source.
964
+ # The identifier of the index you want to use with the data source
965
+ # connector.
855
966
  #
856
967
  # @option params [required, String] :type
857
- # The type of repository that contains the data source.
968
+ # The type of data source repository. For example, `SHAREPOINT`.
858
969
  #
859
970
  # @option params [Types::DataSourceConfiguration] :configuration
860
- # Configuration information that is required to access the data source
861
- # repository.
971
+ # Configuration information to connect to your data source repository.
862
972
  #
863
973
  # You can't specify the `Configuration` parameter when the `Type`
864
974
  # parameter is set to `CUSTOM`. If you do, you receive a
@@ -866,14 +976,23 @@ module Aws::Kendra
866
976
  #
867
977
  # The `Configuration` parameter is required for all other data sources.
868
978
  #
979
+ # @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
980
+ # Configuration information for an Amazon Virtual Private Cloud to
981
+ # connect to your data source. For more information, see [Configuring a
982
+ # VPC][1].
983
+ #
984
+ #
985
+ #
986
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
987
+ #
869
988
  # @option params [String] :description
870
- # A description for the data source.
989
+ # A description for the data source connector.
871
990
  #
872
991
  # @option params [String] :schedule
873
992
  # Sets the frequency for Amazon Kendra to check the documents in your
874
- # repository and update the index. If you don't set a schedule Amazon
875
- # Kendra will not periodically update the index. You can call the
876
- # `StartDataSourceSyncJob` API to update the index.
993
+ # data source repository and update the index. If you don't set a
994
+ # schedule Amazon Kendra will not periodically update the index. You can
995
+ # call the `StartDataSourceSyncJob` API to update the index.
877
996
  #
878
997
  # You can't specify the `Schedule` parameter when the `Type` parameter
879
998
  # is set to `CUSTOM`. If you do, you receive a `ValidationException`
@@ -881,7 +1000,7 @@ module Aws::Kendra
881
1000
  #
882
1001
  # @option params [String] :role_arn
883
1002
  # The Amazon Resource Name (ARN) of a role with permission to access the
884
- # data source. For more information, see [IAM Roles for Amazon
1003
+ # data source connector. For more information, see [IAM Roles for Amazon
885
1004
  # Kendra][1].
886
1005
  #
887
1006
  # You can't specify the `RoleArn` parameter when the `Type` parameter
@@ -895,23 +1014,24 @@ module Aws::Kendra
895
1014
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
896
1015
  #
897
1016
  # @option params [Array<Types::Tag>] :tags
898
- # A list of key-value pairs that identify the data source. You can use
899
- # the tags to identify and organize your resources and to control access
900
- # to resources.
1017
+ # A list of key-value pairs that identify the data source connector. You
1018
+ # can use the tags to identify and organize your resources and to
1019
+ # control access to resources.
901
1020
  #
902
1021
  # @option params [String] :client_token
903
1022
  # A token that you provide to identify the request to create a data
904
- # source. Multiple calls to the `CreateDataSource` API with the same
905
- # client token will create only one data source.
1023
+ # source connector. Multiple calls to the `CreateDataSource` API with
1024
+ # the same client token will create only one data source connector.
906
1025
  #
907
1026
  # **A suitable default value is auto-generated.** You should normally
908
1027
  # not need to pass this option.**
909
1028
  #
910
1029
  # @option params [String] :language_code
911
1030
  # The code for a language. This allows you to support a language for all
912
- # documents when creating the data source. English is supported by
913
- # default. For more information on supported languages, including their
914
- # codes, see [Adding documents in languages other than English][1].
1031
+ # documents when creating the data source connector. English is
1032
+ # supported by default. For more information on supported languages,
1033
+ # including their codes, see [Adding documents in languages other than
1034
+ # English][1].
915
1035
  #
916
1036
  #
917
1037
  #
@@ -919,7 +1039,7 @@ module Aws::Kendra
919
1039
  #
920
1040
  # @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
921
1041
  # Configuration information for altering document metadata and content
922
- # during the document ingestion process when you create a data source.
1042
+ # during the document ingestion process.
923
1043
  #
924
1044
  # For more information on how to create, modify and delete document
925
1045
  # metadata, or make other content alterations when you ingest documents
@@ -939,7 +1059,7 @@ module Aws::Kendra
939
1059
  # resp = client.create_data_source({
940
1060
  # name: "DataSourceName", # required
941
1061
  # index_id: "IndexId", # required
942
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO
1062
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO, TEMPLATE
943
1063
  # configuration: {
944
1064
  # s3_configuration: {
945
1065
  # bucket_name: "S3BucketName", # required
@@ -978,6 +1098,12 @@ module Aws::Kendra
978
1098
  # bucket: "S3BucketName", # required
979
1099
  # key: "S3ObjectKey", # required
980
1100
  # },
1101
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
1102
+ # proxy_configuration: {
1103
+ # host: "Host", # required
1104
+ # port: 1, # required
1105
+ # credentials: "SecretArn",
1106
+ # },
981
1107
  # },
982
1108
  # database_configuration: {
983
1109
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -1190,6 +1316,11 @@ module Aws::Kendra
1190
1316
  # },
1191
1317
  # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1192
1318
  # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1319
+ # proxy_configuration: {
1320
+ # host: "Host", # required
1321
+ # port: 1, # required
1322
+ # credentials: "SecretArn",
1323
+ # },
1193
1324
  # },
1194
1325
  # google_drive_configuration: {
1195
1326
  # secret_arn: "SecretArn", # required
@@ -1553,6 +1684,14 @@ module Aws::Kendra
1553
1684
  # security_group_ids: ["VpcSecurityGroupId"], # required
1554
1685
  # },
1555
1686
  # },
1687
+ # template_configuration: {
1688
+ # template: {
1689
+ # },
1690
+ # },
1691
+ # },
1692
+ # vpc_configuration: {
1693
+ # subnet_ids: ["SubnetId"], # required
1694
+ # security_group_ids: ["VpcSecurityGroupId"], # required
1556
1695
  # },
1557
1696
  # description: "Description",
1558
1697
  # schedule: "ScanSchedule",
@@ -1722,23 +1861,23 @@ module Aws::Kendra
1722
1861
  # Adding FAQs to an index is an asynchronous operation.
1723
1862
  #
1724
1863
  # For an example of adding an FAQ to an index using Python and Java
1725
- # SDKs, see [Using you FAQ file][1].
1864
+ # SDKs, see [Using your FAQ file][1].
1726
1865
  #
1727
1866
  #
1728
1867
  #
1729
1868
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file
1730
1869
  #
1731
1870
  # @option params [required, String] :index_id
1732
- # The identifier of the index that contains the FAQ.
1871
+ # The identifier of the index for the FAQ.
1733
1872
  #
1734
1873
  # @option params [required, String] :name
1735
- # The name that should be associated with the FAQ.
1874
+ # A name for the FAQ.
1736
1875
  #
1737
1876
  # @option params [String] :description
1738
- # A description of the FAQ.
1877
+ # A description for the FAQ.
1739
1878
  #
1740
1879
  # @option params [required, Types::S3Path] :s3_path
1741
- # The S3 location of the FAQ input data.
1880
+ # The path to the FAQ file in S3.
1742
1881
  #
1743
1882
  # @option params [required, String] :role_arn
1744
1883
  # The Amazon Resource Name (ARN) of a role with permission to access the
@@ -1755,7 +1894,7 @@ module Aws::Kendra
1755
1894
  # resources.
1756
1895
  #
1757
1896
  # @option params [String] :file_format
1758
- # The format of the input file. You can choose between a basic CSV
1897
+ # The format of the FAQ input file. You can choose between a basic CSV
1759
1898
  # format, a CSV format that includes customs attributes in a header, and
1760
1899
  # a JSON format that includes custom attributes.
1761
1900
  #
@@ -1825,10 +1964,10 @@ module Aws::Kendra
1825
1964
  req.send_request(options)
1826
1965
  end
1827
1966
 
1828
- # Creates a new Amazon Kendra index. Index creation is an asynchronous
1829
- # API. To determine if index creation has completed, check the `Status`
1830
- # field returned from a call to `DescribeIndex`. The `Status` field is
1831
- # set to `ACTIVE` when the index is ready to use.
1967
+ # Creates an Amazon Kendra index. Index creation is an asynchronous API.
1968
+ # To determine if index creation has completed, check the `Status` field
1969
+ # returned from a call to `DescribeIndex`. The `Status` field is set to
1970
+ # `ACTIVE` when the index is ready to use.
1832
1971
  #
1833
1972
  # Once the index is active you can index your documents using the
1834
1973
  # `BatchPutDocument` API or using one of the supported data sources.
@@ -1844,7 +1983,7 @@ module Aws::Kendra
1844
1983
  # [2]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
1845
1984
  #
1846
1985
  # @option params [required, String] :name
1847
- # The name for the new index.
1986
+ # A name for the index.
1848
1987
  #
1849
1988
  # @option params [String] :edition
1850
1989
  # The Amazon Kendra edition to use for the index. Choose
@@ -2095,13 +2234,13 @@ module Aws::Kendra
2095
2234
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html
2096
2235
  #
2097
2236
  # @option params [required, String] :index_id
2098
- # The unique identifier of the index for the new thesaurus.
2237
+ # The identifier of the index for the thesaurus.
2099
2238
  #
2100
2239
  # @option params [required, String] :name
2101
- # The name for the new thesaurus.
2240
+ # A name for the thesaurus.
2102
2241
  #
2103
2242
  # @option params [String] :description
2104
- # The description for the new thesaurus.
2243
+ # A description for the thesaurus.
2105
2244
  #
2106
2245
  # @option params [required, String] :role_arn
2107
2246
  # An IAM role that gives Amazon Kendra permissions to access thesaurus
@@ -2113,7 +2252,7 @@ module Aws::Kendra
2113
2252
  # resources.
2114
2253
  #
2115
2254
  # @option params [required, Types::S3Path] :source_s3_path
2116
- # The thesaurus file Amazon S3 source path.
2255
+ # The path to the thesaurus file in S3.
2117
2256
  #
2118
2257
  # @option params [String] :client_token
2119
2258
  # A token that you provide to identify the request to create a
@@ -2160,6 +2299,36 @@ module Aws::Kendra
2160
2299
  req.send_request(options)
2161
2300
  end
2162
2301
 
2302
+ # Deletes an access control configuration that you created for your
2303
+ # documents in an index. This includes user and group access information
2304
+ # for your documents. This is useful for user context filtering, where
2305
+ # search results are filtered based on the user or their group access to
2306
+ # documents.
2307
+ #
2308
+ # @option params [required, String] :index_id
2309
+ # The identifier of the index for an access control configuration.
2310
+ #
2311
+ # @option params [required, String] :id
2312
+ # The identifier of the access control configuration you want to delete.
2313
+ #
2314
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2315
+ #
2316
+ # @example Request syntax with placeholder values
2317
+ #
2318
+ # resp = client.delete_access_control_configuration({
2319
+ # index_id: "IndexId", # required
2320
+ # id: "AccessControlConfigurationId", # required
2321
+ # })
2322
+ #
2323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfiguration AWS API Documentation
2324
+ #
2325
+ # @overload delete_access_control_configuration(params = {})
2326
+ # @param [Hash] params ({})
2327
+ def delete_access_control_configuration(params = {}, options = {})
2328
+ req = build_request(:delete_access_control_configuration, params)
2329
+ req.send_request(options)
2330
+ end
2331
+
2163
2332
  # Deletes an Amazon Kendra data source. An exception is not thrown if
2164
2333
  # the data source is already being deleted. While the data source is
2165
2334
  # being deleted, the `Status` field returned by a call to the
@@ -2171,10 +2340,10 @@ module Aws::Kendra
2171
2340
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
2172
2341
  #
2173
2342
  # @option params [required, String] :id
2174
- # The unique identifier of the data source to delete.
2343
+ # The identifier of the data source you want to delete.
2175
2344
  #
2176
2345
  # @option params [required, String] :index_id
2177
- # The unique identifier of the index associated with the data source.
2346
+ # The identifier of the index used with the data source.
2178
2347
  #
2179
2348
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2180
2349
  #
@@ -2206,8 +2375,7 @@ module Aws::Kendra
2206
2375
  # The identifier of your Amazon Kendra experience you want to delete.
2207
2376
  #
2208
2377
  # @option params [required, String] :index_id
2209
- # The identifier of the index for your Amazon Kendra experience you want
2210
- # to delete.
2378
+ # The identifier of the index for your Amazon Kendra experience.
2211
2379
  #
2212
2380
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2213
2381
  #
@@ -2230,10 +2398,10 @@ module Aws::Kendra
2230
2398
  # Removes an FAQ from an index.
2231
2399
  #
2232
2400
  # @option params [required, String] :id
2233
- # The identifier of the FAQ to remove.
2401
+ # The identifier of the FAQ you want to remove.
2234
2402
  #
2235
2403
  # @option params [required, String] :index_id
2236
- # The index to remove the FAQ from.
2404
+ # The identifier of the index for the FAQ.
2237
2405
  #
2238
2406
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2239
2407
  #
@@ -2259,7 +2427,7 @@ module Aws::Kendra
2259
2427
  # set to `DELETING`.
2260
2428
  #
2261
2429
  # @option params [required, String] :id
2262
- # The identifier of the index to delete.
2430
+ # The identifier of the index you want to delete.
2263
2431
  #
2264
2432
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2265
2433
  #
@@ -2302,15 +2470,14 @@ module Aws::Kendra
2302
2470
  # @option params [String] :data_source_id
2303
2471
  # The identifier of the data source you want to delete a group from.
2304
2472
  #
2305
- # This is useful if a group is tied to multiple data sources and you
2306
- # want to delete a group from accessing documents in a certain data
2307
- # source. For example, the groups "Research", "Engineering", and
2308
- # "Sales and Marketing" are all tied to the company's documents
2309
- # stored in the data sources Confluence and Salesforce. You want to
2310
- # delete "Research" and "Engineering" groups from Salesforce, so
2311
- # that these groups cannot access customer-related documents stored in
2312
- # Salesforce. Only "Sales and Marketing" should access documents in
2313
- # the Salesforce data source.
2473
+ # A group can be tied to multiple data sources. You can delete a group
2474
+ # from accessing documents in a certain data source. For example, the
2475
+ # groups "Research", "Engineering", and "Sales and Marketing" are
2476
+ # all tied to the company's documents stored in the data sources
2477
+ # Confluence and Salesforce. You want to delete "Research" and
2478
+ # "Engineering" groups from Salesforce, so that these groups cannot
2479
+ # access customer-related documents stored in Salesforce. Only "Sales
2480
+ # and Marketing" should access documents in the Salesforce data source.
2314
2481
  #
2315
2482
  # @option params [required, String] :group_id
2316
2483
  # The identifier of the group you want to delete.
@@ -2363,10 +2530,10 @@ module Aws::Kendra
2363
2530
  # Amazon Web Services GovCloud (US-West) region.
2364
2531
  #
2365
2532
  # @option params [required, String] :index_id
2366
- # The identifier of the you want to delete a block list from.
2533
+ # The identifier of the index for the block list.
2367
2534
  #
2368
2535
  # @option params [required, String] :id
2369
- # The unique identifier of the block list that needs to be deleted.
2536
+ # The identifier of the block list you want to delete.
2370
2537
  #
2371
2538
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2372
2539
  #
@@ -2389,10 +2556,10 @@ module Aws::Kendra
2389
2556
  # Deletes an existing Amazon Kendra thesaurus.
2390
2557
  #
2391
2558
  # @option params [required, String] :id
2392
- # The identifier of the thesaurus to delete.
2559
+ # The identifier of the thesaurus you want to delete.
2393
2560
  #
2394
2561
  # @option params [required, String] :index_id
2395
- # The identifier of the index associated with the thesaurus to delete.
2562
+ # The identifier of the index for the thesaurus.
2396
2563
  #
2397
2564
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2398
2565
  #
@@ -2412,13 +2579,67 @@ module Aws::Kendra
2412
2579
  req.send_request(options)
2413
2580
  end
2414
2581
 
2582
+ # Gets information about an access control configuration that you
2583
+ # created for your documents in an index. This includes user and group
2584
+ # access information for your documents. This is useful for user context
2585
+ # filtering, where search results are filtered based on the user or
2586
+ # their group access to documents.
2587
+ #
2588
+ # @option params [required, String] :index_id
2589
+ # The identifier of the index for an access control configuration.
2590
+ #
2591
+ # @option params [required, String] :id
2592
+ # The identifier of the access control configuration you want to get
2593
+ # information on.
2594
+ #
2595
+ # @return [Types::DescribeAccessControlConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2596
+ #
2597
+ # * {Types::DescribeAccessControlConfigurationResponse#name #name} => String
2598
+ # * {Types::DescribeAccessControlConfigurationResponse#description #description} => String
2599
+ # * {Types::DescribeAccessControlConfigurationResponse#error_message #error_message} => String
2600
+ # * {Types::DescribeAccessControlConfigurationResponse#access_control_list #access_control_list} => Array&lt;Types::Principal&gt;
2601
+ # * {Types::DescribeAccessControlConfigurationResponse#hierarchical_access_control_list #hierarchical_access_control_list} => Array&lt;Types::HierarchicalPrincipal&gt;
2602
+ #
2603
+ # @example Request syntax with placeholder values
2604
+ #
2605
+ # resp = client.describe_access_control_configuration({
2606
+ # index_id: "IndexId", # required
2607
+ # id: "AccessControlConfigurationId", # required
2608
+ # })
2609
+ #
2610
+ # @example Response structure
2611
+ #
2612
+ # resp.name #=> String
2613
+ # resp.description #=> String
2614
+ # resp.error_message #=> String
2615
+ # resp.access_control_list #=> Array
2616
+ # resp.access_control_list[0].name #=> String
2617
+ # resp.access_control_list[0].type #=> String, one of "USER", "GROUP"
2618
+ # resp.access_control_list[0].access #=> String, one of "ALLOW", "DENY"
2619
+ # resp.access_control_list[0].data_source_id #=> String
2620
+ # resp.hierarchical_access_control_list #=> Array
2621
+ # resp.hierarchical_access_control_list[0].principal_list #=> Array
2622
+ # resp.hierarchical_access_control_list[0].principal_list[0].name #=> String
2623
+ # resp.hierarchical_access_control_list[0].principal_list[0].type #=> String, one of "USER", "GROUP"
2624
+ # resp.hierarchical_access_control_list[0].principal_list[0].access #=> String, one of "ALLOW", "DENY"
2625
+ # resp.hierarchical_access_control_list[0].principal_list[0].data_source_id #=> String
2626
+ #
2627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfiguration AWS API Documentation
2628
+ #
2629
+ # @overload describe_access_control_configuration(params = {})
2630
+ # @param [Hash] params ({})
2631
+ def describe_access_control_configuration(params = {}, options = {})
2632
+ req = build_request(:describe_access_control_configuration, params)
2633
+ req.send_request(options)
2634
+ end
2635
+
2415
2636
  # Gets information about an Amazon Kendra data source.
2416
2637
  #
2417
2638
  # @option params [required, String] :id
2418
- # The unique identifier of the data source to describe.
2639
+ # The identifier of the data source.
2419
2640
  #
2420
2641
  # @option params [required, String] :index_id
2421
- # The identifier of the index that contains the data source.
2642
+ # The identifier of the index used with the data source.
2422
2643
  #
2423
2644
  # @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2424
2645
  #
@@ -2427,6 +2648,7 @@ module Aws::Kendra
2427
2648
  # * {Types::DescribeDataSourceResponse#name #name} => String
2428
2649
  # * {Types::DescribeDataSourceResponse#type #type} => String
2429
2650
  # * {Types::DescribeDataSourceResponse#configuration #configuration} => Types::DataSourceConfiguration
2651
+ # * {Types::DescribeDataSourceResponse#vpc_configuration #vpc_configuration} => Types::DataSourceVpcConfiguration
2430
2652
  # * {Types::DescribeDataSourceResponse#created_at #created_at} => Time
2431
2653
  # * {Types::DescribeDataSourceResponse#updated_at #updated_at} => Time
2432
2654
  # * {Types::DescribeDataSourceResponse#description #description} => String
@@ -2449,7 +2671,7 @@ module Aws::Kendra
2449
2671
  # resp.id #=> String
2450
2672
  # resp.index_id #=> String
2451
2673
  # resp.name #=> String
2452
- # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO"
2674
+ # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO", "TEMPLATE"
2453
2675
  # resp.configuration.s3_configuration.bucket_name #=> String
2454
2676
  # resp.configuration.s3_configuration.inclusion_prefixes #=> Array
2455
2677
  # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
@@ -2481,6 +2703,10 @@ module Aws::Kendra
2481
2703
  # resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
2482
2704
  # resp.configuration.share_point_configuration.ssl_certificate_s3_path.bucket #=> String
2483
2705
  # resp.configuration.share_point_configuration.ssl_certificate_s3_path.key #=> String
2706
+ # resp.configuration.share_point_configuration.authentication_type #=> String, one of "HTTP_BASIC", "OAUTH2"
2707
+ # resp.configuration.share_point_configuration.proxy_configuration.host #=> String
2708
+ # resp.configuration.share_point_configuration.proxy_configuration.port #=> Integer
2709
+ # resp.configuration.share_point_configuration.proxy_configuration.credentials #=> String
2484
2710
  # resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
2485
2711
  # resp.configuration.database_configuration.connection_configuration.database_host #=> String
2486
2712
  # resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
@@ -2622,6 +2848,9 @@ module Aws::Kendra
2622
2848
  # resp.configuration.confluence_configuration.inclusion_patterns[0] #=> String
2623
2849
  # resp.configuration.confluence_configuration.exclusion_patterns #=> Array
2624
2850
  # resp.configuration.confluence_configuration.exclusion_patterns[0] #=> String
2851
+ # resp.configuration.confluence_configuration.proxy_configuration.host #=> String
2852
+ # resp.configuration.confluence_configuration.proxy_configuration.port #=> Integer
2853
+ # resp.configuration.confluence_configuration.proxy_configuration.credentials #=> String
2625
2854
  # resp.configuration.google_drive_configuration.secret_arn #=> String
2626
2855
  # resp.configuration.google_drive_configuration.inclusion_patterns #=> Array
2627
2856
  # resp.configuration.google_drive_configuration.inclusion_patterns[0] #=> String
@@ -2899,6 +3128,10 @@ module Aws::Kendra
2899
3128
  # resp.configuration.alfresco_configuration.vpc_configuration.subnet_ids[0] #=> String
2900
3129
  # resp.configuration.alfresco_configuration.vpc_configuration.security_group_ids #=> Array
2901
3130
  # resp.configuration.alfresco_configuration.vpc_configuration.security_group_ids[0] #=> String
3131
+ # resp.vpc_configuration.subnet_ids #=> Array
3132
+ # resp.vpc_configuration.subnet_ids[0] #=> String
3133
+ # resp.vpc_configuration.security_group_ids #=> Array
3134
+ # resp.vpc_configuration.security_group_ids[0] #=> String
2902
3135
  # resp.created_at #=> Time
2903
3136
  # resp.updated_at #=> Time
2904
3137
  # resp.description #=> String
@@ -2965,8 +3198,7 @@ module Aws::Kendra
2965
3198
  # information on.
2966
3199
  #
2967
3200
  # @option params [required, String] :index_id
2968
- # The identifier of the index for your Amazon Kendra experience you want
2969
- # to get information on.
3201
+ # The identifier of the index for your Amazon Kendra experience.
2970
3202
  #
2971
3203
  # @return [Types::DescribeExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2972
3204
  #
@@ -3022,10 +3254,10 @@ module Aws::Kendra
3022
3254
  # Gets information about an FAQ list.
3023
3255
  #
3024
3256
  # @option params [required, String] :id
3025
- # The unique identifier of the FAQ.
3257
+ # The identifier of the FAQ you want to get information on.
3026
3258
  #
3027
3259
  # @option params [required, String] :index_id
3028
- # The identifier of the index that contains the FAQ.
3260
+ # The identifier of the index for the FAQ.
3029
3261
  #
3030
3262
  # @return [Types::DescribeFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3031
3263
  #
@@ -3074,10 +3306,10 @@ module Aws::Kendra
3074
3306
  req.send_request(options)
3075
3307
  end
3076
3308
 
3077
- # Describes an existing Amazon Kendra index.
3309
+ # Gets information about an existing Amazon Kendra index.
3078
3310
  #
3079
3311
  # @option params [required, String] :id
3080
- # The identifier of the index to describe.
3312
+ # The identifier of the index you want to get information on.
3081
3313
  #
3082
3314
  # @return [Types::DescribeIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3083
3315
  #
@@ -3214,7 +3446,8 @@ module Aws::Kendra
3214
3446
  req.send_request(options)
3215
3447
  end
3216
3448
 
3217
- # Describes a block list used for query suggestions for an index.
3449
+ # Gets information about a block list used for query suggestions for an
3450
+ # index.
3218
3451
  #
3219
3452
  # This is used to check the current settings that are applied to a block
3220
3453
  # list.
@@ -3226,7 +3459,7 @@ module Aws::Kendra
3226
3459
  # The identifier of the index for the block list.
3227
3460
  #
3228
3461
  # @option params [required, String] :id
3229
- # The unique identifier of the block list.
3462
+ # The identifier of the block list you want to get information on.
3230
3463
  #
3231
3464
  # @return [Types::DescribeQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3232
3465
  #
@@ -3275,7 +3508,7 @@ module Aws::Kendra
3275
3508
  req.send_request(options)
3276
3509
  end
3277
3510
 
3278
- # Describes the settings of query suggestions for an index.
3511
+ # Gets information on the settings of query suggestions for an index.
3279
3512
  #
3280
3513
  # This is used to check the current settings applied to query
3281
3514
  # suggestions.
@@ -3284,8 +3517,8 @@ module Aws::Kendra
3284
3517
  # Amazon Web Services GovCloud (US-West) region.
3285
3518
  #
3286
3519
  # @option params [required, String] :index_id
3287
- # The identifier of the index you want to describe query suggestions
3288
- # settings for.
3520
+ # The identifier of the index with query suggestions that you want to
3521
+ # get information on.
3289
3522
  #
3290
3523
  # @return [Types::DescribeQuerySuggestionsConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3291
3524
  #
@@ -3326,13 +3559,13 @@ module Aws::Kendra
3326
3559
  req.send_request(options)
3327
3560
  end
3328
3561
 
3329
- # Describes an existing Amazon Kendra thesaurus.
3562
+ # Gets information about an existing Amazon Kendra thesaurus.
3330
3563
  #
3331
3564
  # @option params [required, String] :id
3332
- # The identifier of the thesaurus to describe.
3565
+ # The identifier of the thesaurus you want to get information on.
3333
3566
  #
3334
3567
  # @option params [required, String] :index_id
3335
- # The identifier of the index associated with the thesaurus to describe.
3568
+ # The identifier of the index for the thesaurus.
3336
3569
  #
3337
3570
  # @return [Types::DescribeThesaurusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3338
3571
  #
@@ -3626,13 +3859,60 @@ module Aws::Kendra
3626
3859
  req.send_request(options)
3627
3860
  end
3628
3861
 
3862
+ # Lists one or more access control configurations for an index. This
3863
+ # includes user and group access information for your documents. This is
3864
+ # useful for user context filtering, where search results are filtered
3865
+ # based on the user or their group access to documents.
3866
+ #
3867
+ # @option params [required, String] :index_id
3868
+ # The identifier of the index for the access control configuration.
3869
+ #
3870
+ # @option params [String] :next_token
3871
+ # If the previous response was incomplete (because there's more data to
3872
+ # retrieve), Amazon Kendra returns a pagination token in the response.
3873
+ # You can use this pagination token to retrieve the next set of access
3874
+ # control configurations.
3875
+ #
3876
+ # @option params [Integer] :max_results
3877
+ # The maximum number of access control configurations to return.
3878
+ #
3879
+ # @return [Types::ListAccessControlConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3880
+ #
3881
+ # * {Types::ListAccessControlConfigurationsResponse#next_token #next_token} => String
3882
+ # * {Types::ListAccessControlConfigurationsResponse#access_control_configurations #access_control_configurations} => Array&lt;Types::AccessControlConfigurationSummary&gt;
3883
+ #
3884
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3885
+ #
3886
+ # @example Request syntax with placeholder values
3887
+ #
3888
+ # resp = client.list_access_control_configurations({
3889
+ # index_id: "IndexId", # required
3890
+ # next_token: "String",
3891
+ # max_results: 1,
3892
+ # })
3893
+ #
3894
+ # @example Response structure
3895
+ #
3896
+ # resp.next_token #=> String
3897
+ # resp.access_control_configurations #=> Array
3898
+ # resp.access_control_configurations[0].id #=> String
3899
+ #
3900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurations AWS API Documentation
3901
+ #
3902
+ # @overload list_access_control_configurations(params = {})
3903
+ # @param [Hash] params ({})
3904
+ def list_access_control_configurations(params = {}, options = {})
3905
+ req = build_request(:list_access_control_configurations, params)
3906
+ req.send_request(options)
3907
+ end
3908
+
3629
3909
  # Gets statistics about synchronizing Amazon Kendra with a data source.
3630
3910
  #
3631
3911
  # @option params [required, String] :id
3632
3912
  # The identifier of the data source.
3633
3913
  #
3634
3914
  # @option params [required, String] :index_id
3635
- # The identifier of the index that contains the data source.
3915
+ # The identifier of the index used with the data source.
3636
3916
  #
3637
3917
  # @option params [String] :next_token
3638
3918
  # If the previous response was incomplete (because there is more data to
@@ -3702,7 +3982,7 @@ module Aws::Kendra
3702
3982
  # Lists the data sources that you have created.
3703
3983
  #
3704
3984
  # @option params [required, String] :index_id
3705
- # The identifier of the index that contains the data source.
3985
+ # The identifier of the index used with one or more data sources.
3706
3986
  #
3707
3987
  # @option params [String] :next_token
3708
3988
  # If the previous response was incomplete (because there is more data to
@@ -3733,7 +4013,7 @@ module Aws::Kendra
3733
4013
  # resp.summary_items #=> Array
3734
4014
  # resp.summary_items[0].name #=> String
3735
4015
  # resp.summary_items[0].id #=> String
3736
- # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO"
4016
+ # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO", "TEMPLATE"
3737
4017
  # resp.summary_items[0].created_at #=> Time
3738
4018
  # resp.summary_items[0].updated_at #=> Time
3739
4019
  # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
@@ -4173,10 +4453,10 @@ module Aws::Kendra
4173
4453
  req.send_request(options)
4174
4454
  end
4175
4455
 
4176
- # Lists the Amazon Kendra thesauri associated with an index.
4456
+ # Lists the thesauri for an index.
4177
4457
  #
4178
4458
  # @option params [required, String] :index_id
4179
- # The identifier of the index associated with the thesaurus to list.
4459
+ # The identifier of the index with one or more thesauri.
4180
4460
  #
4181
4461
  # @option params [String] :next_token
4182
4462
  # If the previous response was incomplete (because there is more data to
@@ -4232,10 +4512,9 @@ module Aws::Kendra
4232
4512
  # property group, can see top-secret company documents in their search
4233
4513
  # results.
4234
4514
  #
4235
- # You map users to their groups when you want to filter search results
4236
- # for different users based on their group’s access to documents. For
4237
- # more information on filtering search results for different users, see
4238
- # [Filtering on user context][1].
4515
+ # This is useful for user context filtering, where search results are
4516
+ # filtered based on the user or their group access to documents. For
4517
+ # more information, see [Filtering on user context][1].
4239
4518
  #
4240
4519
  # If more than five `PUT` actions for a group are currently processing,
4241
4520
  # a validation exception is thrown.
@@ -4832,46 +5111,155 @@ module Aws::Kendra
4832
5111
  req.send_request(options)
4833
5112
  end
4834
5113
 
5114
+ # Updates an access control configuration for your documents in an
5115
+ # index. This includes user and group access information for your
5116
+ # documents. This is useful for user context filtering, where search
5117
+ # results are filtered based on the user or their group access to
5118
+ # documents.
5119
+ #
5120
+ # You can update an access control configuration you created without
5121
+ # indexing all of your documents again. For example, your index contains
5122
+ # top-secret company documents that only certain employees or users
5123
+ # should access. You created an 'allow' access control configuration
5124
+ # for one user who recently joined the 'top-secret' team, switching
5125
+ # from a team with 'deny' access to top-secret documents. However, the
5126
+ # user suddenly returns to their previous team and should no longer have
5127
+ # access to top secret documents. You can update the access control
5128
+ # configuration to re-configure access control for your documents as
5129
+ # circumstances change.
5130
+ #
5131
+ # You call the [BatchPutDocument][1] API to apply the updated access
5132
+ # control configuration, with the `AccessControlConfigurationId`
5133
+ # included in the [Document][2] object. If you use an S3 bucket as a
5134
+ # data source, you synchronize your data source to apply the
5135
+ # `AccessControlConfigurationId` in the `.metadata.json` file. Amazon
5136
+ # Kendra currently only supports access control configuration for S3
5137
+ # data sources and documents indexed using the `BatchPutDocument` API.
5138
+ #
5139
+ #
5140
+ #
5141
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
5142
+ # [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html
5143
+ #
5144
+ # @option params [required, String] :index_id
5145
+ # The identifier of the index for an access control configuration.
5146
+ #
5147
+ # @option params [required, String] :id
5148
+ # The identifier of the access control configuration you want to update.
5149
+ #
5150
+ # @option params [String] :name
5151
+ # A new name for the access control configuration.
5152
+ #
5153
+ # @option params [String] :description
5154
+ # A new description for the access control configuration.
5155
+ #
5156
+ # @option params [Array<Types::Principal>] :access_control_list
5157
+ # Information you want to update on principals (users and/or groups) and
5158
+ # which documents they should have access to. This is useful for user
5159
+ # context filtering, where search results are filtered based on the user
5160
+ # or their group access to documents.
5161
+ #
5162
+ # @option params [Array<Types::HierarchicalPrincipal>] :hierarchical_access_control_list
5163
+ # The updated list of [principal][1] lists that define the hierarchy for
5164
+ # which documents users should have access to.
5165
+ #
5166
+ #
5167
+ #
5168
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
5169
+ #
5170
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5171
+ #
5172
+ # @example Request syntax with placeholder values
5173
+ #
5174
+ # resp = client.update_access_control_configuration({
5175
+ # index_id: "IndexId", # required
5176
+ # id: "AccessControlConfigurationId", # required
5177
+ # name: "AccessControlConfigurationName",
5178
+ # description: "Description",
5179
+ # access_control_list: [
5180
+ # {
5181
+ # name: "PrincipalName", # required
5182
+ # type: "USER", # required, accepts USER, GROUP
5183
+ # access: "ALLOW", # required, accepts ALLOW, DENY
5184
+ # data_source_id: "DataSourceId",
5185
+ # },
5186
+ # ],
5187
+ # hierarchical_access_control_list: [
5188
+ # {
5189
+ # principal_list: [ # required
5190
+ # {
5191
+ # name: "PrincipalName", # required
5192
+ # type: "USER", # required, accepts USER, GROUP
5193
+ # access: "ALLOW", # required, accepts ALLOW, DENY
5194
+ # data_source_id: "DataSourceId",
5195
+ # },
5196
+ # ],
5197
+ # },
5198
+ # ],
5199
+ # })
5200
+ #
5201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfiguration AWS API Documentation
5202
+ #
5203
+ # @overload update_access_control_configuration(params = {})
5204
+ # @param [Hash] params ({})
5205
+ def update_access_control_configuration(params = {}, options = {})
5206
+ req = build_request(:update_access_control_configuration, params)
5207
+ req.send_request(options)
5208
+ end
5209
+
4835
5210
  # Updates an existing Amazon Kendra data source.
4836
5211
  #
4837
5212
  # @option params [required, String] :id
4838
- # The unique identifier of the data source to update.
5213
+ # The identifier of the data source you want to update.
4839
5214
  #
4840
5215
  # @option params [String] :name
4841
- # The name of the data source to update. The name of the data source
4842
- # can't be updated. To rename a data source you must delete the data
4843
- # source and re-create it.
5216
+ # A new name for the data source connector.
4844
5217
  #
4845
5218
  # @option params [required, String] :index_id
4846
- # The identifier of the index that contains the data source to update.
5219
+ # The identifier of the index used with the data source connector.
4847
5220
  #
4848
5221
  # @option params [Types::DataSourceConfiguration] :configuration
4849
- # Configuration information for an Amazon Kendra data source you want to
4850
- # update.
5222
+ # Configuration information you want to update for the data source
5223
+ # connector.
5224
+ #
5225
+ # @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
5226
+ # Configuration information for an Amazon Virtual Private Cloud to
5227
+ # connect to your data source. For more information, see [Configuring a
5228
+ # VPC][1].
5229
+ #
5230
+ #
5231
+ #
5232
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
4851
5233
  #
4852
5234
  # @option params [String] :description
4853
- # The new description for the data source.
5235
+ # A new description for the data source connector.
4854
5236
  #
4855
5237
  # @option params [String] :schedule
4856
- # The new update schedule for the data source.
5238
+ # The sync schedule you want to update for the data source connector.
4857
5239
  #
4858
5240
  # @option params [String] :role_arn
4859
- # The Amazon Resource Name (ARN) of the new role to use when the data
4860
- # source is accessing resources on your behalf.
5241
+ # The Amazon Resource Name (ARN) of a role with permission to access the
5242
+ # data source. For more information, see [IAM Roles for Amazon
5243
+ # Kendra][1].
5244
+ #
5245
+ #
5246
+ #
5247
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
4861
5248
  #
4862
5249
  # @option params [String] :language_code
4863
- # The code for a language. This allows you to support a language for all
4864
- # documents when updating the data source. English is supported by
4865
- # default. For more information on supported languages, including their
4866
- # codes, see [Adding documents in languages other than English][1].
5250
+ # The code for a language you want to update for the data source
5251
+ # connector. This allows you to support a language for all documents
5252
+ # when updating the data source. English is supported by default. For
5253
+ # more information on supported languages, including their codes, see
5254
+ # [Adding documents in languages other than English][1].
4867
5255
  #
4868
5256
  #
4869
5257
  #
4870
5258
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
4871
5259
  #
4872
5260
  # @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
4873
- # Configuration information for altering document metadata and content
4874
- # during the document ingestion process when you update a data source.
5261
+ # Configuration information you want to update for altering document
5262
+ # metadata and content during the document ingestion process.
4875
5263
  #
4876
5264
  # For more information on how to create, modify and delete document
4877
5265
  # metadata, or make other content alterations when you ingest documents
@@ -4928,6 +5316,12 @@ module Aws::Kendra
4928
5316
  # bucket: "S3BucketName", # required
4929
5317
  # key: "S3ObjectKey", # required
4930
5318
  # },
5319
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
5320
+ # proxy_configuration: {
5321
+ # host: "Host", # required
5322
+ # port: 1, # required
5323
+ # credentials: "SecretArn",
5324
+ # },
4931
5325
  # },
4932
5326
  # database_configuration: {
4933
5327
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -5140,6 +5534,11 @@ module Aws::Kendra
5140
5534
  # },
5141
5535
  # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
5142
5536
  # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
5537
+ # proxy_configuration: {
5538
+ # host: "Host", # required
5539
+ # port: 1, # required
5540
+ # credentials: "SecretArn",
5541
+ # },
5143
5542
  # },
5144
5543
  # google_drive_configuration: {
5145
5544
  # secret_arn: "SecretArn", # required
@@ -5503,6 +5902,14 @@ module Aws::Kendra
5503
5902
  # security_group_ids: ["VpcSecurityGroupId"], # required
5504
5903
  # },
5505
5904
  # },
5905
+ # template_configuration: {
5906
+ # template: {
5907
+ # },
5908
+ # },
5909
+ # },
5910
+ # vpc_configuration: {
5911
+ # subnet_ids: ["SubnetId"], # required
5912
+ # security_group_ids: ["VpcSecurityGroupId"], # required
5506
5913
  # },
5507
5914
  # description: "Description",
5508
5915
  # schedule: "ScanSchedule",
@@ -5587,11 +5994,10 @@ module Aws::Kendra
5587
5994
  # The identifier of your Amazon Kendra experience you want to update.
5588
5995
  #
5589
5996
  # @option params [String] :name
5590
- # The name of your Amazon Kendra experience you want to update.
5997
+ # A new name for your Amazon Kendra experience.
5591
5998
  #
5592
5999
  # @option params [required, String] :index_id
5593
- # The identifier of the index for your Amazon Kendra experience you want
5594
- # to update.
6000
+ # The identifier of the index for your Amazon Kendra experience.
5595
6001
  #
5596
6002
  # @option params [String] :role_arn
5597
6003
  # The Amazon Resource Name (ARN) of a role with permission to access
@@ -5604,10 +6010,11 @@ module Aws::Kendra
5604
6010
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
5605
6011
  #
5606
6012
  # @option params [Types::ExperienceConfiguration] :configuration
5607
- # Configuration information for your Amazon Kendra you want to update.
6013
+ # Configuration information you want to update for your Amazon Kendra
6014
+ # experience.
5608
6015
  #
5609
6016
  # @option params [String] :description
5610
- # The description of your Amazon Kendra experience you want to update.
6017
+ # A new description for your Amazon Kendra experience.
5611
6018
  #
5612
6019
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5613
6020
  #
@@ -5643,20 +6050,23 @@ module Aws::Kendra
5643
6050
  # Updates an existing Amazon Kendra index.
5644
6051
  #
5645
6052
  # @option params [required, String] :id
5646
- # The identifier of the index to update.
6053
+ # The identifier of the index you want to update.
5647
6054
  #
5648
6055
  # @option params [String] :name
5649
- # The name of the index to update.
6056
+ # The name of the index you want to update.
5650
6057
  #
5651
6058
  # @option params [String] :role_arn
5652
- # A new IAM role that gives Amazon Kendra permission to access your
5653
- # Amazon CloudWatch logs.
6059
+ # An Identity and Access Management (IAM) role that gives Amazon Kendra
6060
+ # permission to access Amazon CloudWatch logs and metrics.
5654
6061
  #
5655
6062
  # @option params [String] :description
5656
6063
  # A new description for the index.
5657
6064
  #
5658
6065
  # @option params [Array<Types::DocumentMetadataConfiguration>] :document_metadata_configuration_updates
5659
- # The document metadata you want to update.
6066
+ # The document metadata configuration you want to update for the index.
6067
+ # Document metadata are fields or attributes associated with your
6068
+ # documents. For example, the company department name associated with
6069
+ # each document.
5660
6070
  #
5661
6071
  # @option params [Types::CapacityUnitsConfiguration] :capacity_units
5662
6072
  # Sets the number of additional document storage and query capacity
@@ -5765,16 +6175,16 @@ module Aws::Kendra
5765
6175
  # Amazon Web Services GovCloud (US-West) region.
5766
6176
  #
5767
6177
  # @option params [required, String] :index_id
5768
- # The identifier of the index for a block list.
6178
+ # The identifier of the index for the block list.
5769
6179
  #
5770
6180
  # @option params [required, String] :id
5771
- # The unique identifier of a block list.
6181
+ # The identifier of the block list you want to update.
5772
6182
  #
5773
6183
  # @option params [String] :name
5774
- # The name of a block list.
6184
+ # A new name for the block list.
5775
6185
  #
5776
6186
  # @option params [String] :description
5777
- # The description for a block list.
6187
+ # A new description for the block list.
5778
6188
  #
5779
6189
  # @option params [Types::S3Path] :source_s3_path
5780
6190
  # The S3 path where your block list text file sits in S3.
@@ -5836,8 +6246,7 @@ module Aws::Kendra
5836
6246
  # Amazon Web Services GovCloud (US-West) region.
5837
6247
  #
5838
6248
  # @option params [required, String] :index_id
5839
- # The identifier of the index you want to update query suggestions
5840
- # settings for.
6249
+ # The identifier of the index with query suggestions you want to update.
5841
6250
  #
5842
6251
  # @option params [String] :mode
5843
6252
  # Set the mode to `ENABLED` or `LEARN_ONLY`.
@@ -5915,22 +6324,23 @@ module Aws::Kendra
5915
6324
  req.send_request(options)
5916
6325
  end
5917
6326
 
5918
- # Updates a thesaurus file associated with an index.
6327
+ # Updates a thesaurus for an index.
5919
6328
  #
5920
6329
  # @option params [required, String] :id
5921
- # The identifier of the thesaurus to update.
6330
+ # The identifier of the thesaurus you want to update.
5922
6331
  #
5923
6332
  # @option params [String] :name
5924
- # The updated name of the thesaurus.
6333
+ # A new name for the thesaurus.
5925
6334
  #
5926
6335
  # @option params [required, String] :index_id
5927
- # The identifier of the index associated with the thesaurus to update.
6336
+ # The identifier of the index for the thesaurus.
5928
6337
  #
5929
6338
  # @option params [String] :description
5930
- # The updated description of the thesaurus.
6339
+ # A new description for the thesaurus.
5931
6340
  #
5932
6341
  # @option params [String] :role_arn
5933
- # The updated role ARN of the thesaurus.
6342
+ # An IAM role that gives Amazon Kendra permissions to access thesaurus
6343
+ # file specified in `SourceS3Path`.
5934
6344
  #
5935
6345
  # @option params [Types::S3Path] :source_s3_path
5936
6346
  # Information required to find a specific file in an Amazon S3 bucket.
@@ -5973,7 +6383,7 @@ module Aws::Kendra
5973
6383
  params: params,
5974
6384
  config: config)
5975
6385
  context[:gem_name] = 'aws-sdk-kendra'
5976
- context[:gem_version] = '1.53.0'
6386
+ context[:gem_version] = '1.56.0'
5977
6387
  Seahorse::Client::Request.new(handlers, context)
5978
6388
  end
5979
6389