aws-sdk-kendra 1.27.0 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +394 -18
- data/lib/aws-sdk-kendra/client_api.rb +179 -0
- data/lib/aws-sdk-kendra/types.rb +884 -56
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7038aaa06fb793e9d6e31cc0c4703220832b7a9c2cdd6e7fae73df18c3dc3fc8
|
4
|
+
data.tar.gz: 1a109408574701029f28633b7c9332130103c3ceee3a197ca37ed1b3790d81d4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6c422c77076d0b647630c3daf4972454c8980cf62af30974ae3328b28aff8dba8168b73aadad3873dfe11ea97c23f8e1daa99da0acdc4800124fffbe83236413
|
7
|
+
data.tar.gz: 7798a38719c6685f28e746c99faf0d95996928d5c6ba63e67635fdd78b1370115279f8183eee9a6a95c77ba3ccdff3465ae0948cfe16081a8f35645a455a5b42
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.31.0 (2021-07-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Kendra now provides a data source connector for Amazon WorkDocs. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-workdocs.html
|
8
|
+
|
9
|
+
1.30.0 (2021-07-12)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Kendra now supports Principal Store
|
13
|
+
|
14
|
+
1.29.0 (2021-06-30)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon Kendra Enterprise Edition now offered in smaller more granular units to enable customers with smaller workloads. Virtual Storage Capacity units now offer scaling in increments of 100,000 documents (up to 30GB) per unit and Virtual Query Units offer scaling increments of 8,000 queries per day.
|
18
|
+
|
19
|
+
1.28.0 (2021-06-24)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Amazon Kendra now supports SharePoint 2013 and SharePoint 2016 when using a SharePoint data source.
|
23
|
+
|
4
24
|
1.27.0 (2021-06-17)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.31.0
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -341,8 +341,9 @@ module Aws::Kendra
|
|
341
341
|
# been added with the `BatchPutDocument` operation.
|
342
342
|
#
|
343
343
|
# The documents are deleted asynchronously. You can see the progress of
|
344
|
-
# the deletion by using
|
345
|
-
# the processing of the batch are sent to you
|
344
|
+
# the deletion by using Amazon Web Services CloudWatch. Any error
|
345
|
+
# messages related to the processing of the batch are sent to you
|
346
|
+
# CloudWatch log.
|
346
347
|
#
|
347
348
|
# @option params [required, String] :index_id
|
348
349
|
# The identifier of the index that contains the documents to delete.
|
@@ -472,8 +473,9 @@ module Aws::Kendra
|
|
472
473
|
# control list to the documents added to the index.
|
473
474
|
#
|
474
475
|
# The documents are indexed asynchronously. You can see the progress of
|
475
|
-
# the batch using
|
476
|
-
# processing the batch are sent to your
|
476
|
+
# the batch using Amazon Web Services CloudWatch. Any error messages
|
477
|
+
# related to processing the batch are sent to your Amazon Web Services
|
478
|
+
# CloudWatch log.
|
477
479
|
#
|
478
480
|
# @option params [required, String] :index_id
|
479
481
|
# The identifier of the index to add the documents to. You need to
|
@@ -546,6 +548,19 @@ module Aws::Kendra
|
|
546
548
|
# name: "PrincipalName", # required
|
547
549
|
# type: "USER", # required, accepts USER, GROUP
|
548
550
|
# access: "ALLOW", # required, accepts ALLOW, DENY
|
551
|
+
# data_source_id: "DataSourceId",
|
552
|
+
# },
|
553
|
+
# ],
|
554
|
+
# hierarchical_access_control_list: [
|
555
|
+
# {
|
556
|
+
# principal_list: [ # required
|
557
|
+
# {
|
558
|
+
# name: "PrincipalName", # required
|
559
|
+
# type: "USER", # required, accepts USER, GROUP
|
560
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
561
|
+
# data_source_id: "DataSourceId",
|
562
|
+
# },
|
563
|
+
# ],
|
549
564
|
# },
|
550
565
|
# ],
|
551
566
|
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
@@ -679,7 +694,7 @@ module Aws::Kendra
|
|
679
694
|
# resp = client.create_data_source({
|
680
695
|
# name: "DataSourceName", # required
|
681
696
|
# index_id: "IndexId", # required
|
682
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER
|
697
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS
|
683
698
|
# configuration: {
|
684
699
|
# s3_configuration: {
|
685
700
|
# bucket_name: "S3BucketName", # required
|
@@ -694,7 +709,7 @@ module Aws::Kendra
|
|
694
709
|
# },
|
695
710
|
# },
|
696
711
|
# share_point_configuration: {
|
697
|
-
# share_point_version: "
|
712
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
698
713
|
# urls: ["Url"], # required
|
699
714
|
# secret_arn: "SecretArn", # required
|
700
715
|
# crawl_attachments: false,
|
@@ -714,6 +729,10 @@ module Aws::Kendra
|
|
714
729
|
# ],
|
715
730
|
# document_title_field_name: "DataSourceFieldName",
|
716
731
|
# disable_local_groups: false,
|
732
|
+
# ssl_certificate_s3_path: {
|
733
|
+
# bucket: "S3BucketName", # required
|
734
|
+
# key: "S3ObjectKey", # required
|
735
|
+
# },
|
717
736
|
# },
|
718
737
|
# database_configuration: {
|
719
738
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -973,6 +992,20 @@ module Aws::Kendra
|
|
973
992
|
# ],
|
974
993
|
# },
|
975
994
|
# },
|
995
|
+
# work_docs_configuration: {
|
996
|
+
# organization_id: "OrganizationId", # required
|
997
|
+
# crawl_comments: false,
|
998
|
+
# use_change_log: false,
|
999
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1000
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1001
|
+
# field_mappings: [
|
1002
|
+
# {
|
1003
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1004
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1005
|
+
# index_field_name: "IndexFieldName", # required
|
1006
|
+
# },
|
1007
|
+
# ],
|
1008
|
+
# },
|
976
1009
|
# },
|
977
1010
|
# description: "Description",
|
978
1011
|
# schedule: "ScanSchedule",
|
@@ -1110,15 +1143,22 @@ module Aws::Kendra
|
|
1110
1143
|
# The `Edition` parameter is optional. If you don't supply a value, the
|
1111
1144
|
# default is `ENTERPRISE_EDITION`.
|
1112
1145
|
#
|
1146
|
+
# For more information on quota limits for enterprise and developer
|
1147
|
+
# editions, see [Quotas][1].
|
1148
|
+
#
|
1149
|
+
#
|
1150
|
+
#
|
1151
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
1152
|
+
#
|
1113
1153
|
# @option params [required, String] :role_arn
|
1114
|
-
# An
|
1115
|
-
#
|
1116
|
-
#
|
1117
|
-
#
|
1154
|
+
# An Identity and Access Management(IAM) role that gives Amazon Kendra
|
1155
|
+
# permissions to access your Amazon CloudWatch logs and metrics. This is
|
1156
|
+
# also the role used when you use the `BatchPutDocument` operation to
|
1157
|
+
# index documents from an Amazon S3 bucket.
|
1118
1158
|
#
|
1119
1159
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
1120
|
-
# The identifier of the
|
1121
|
-
#
|
1160
|
+
# The identifier of the KMScustomer managed key (CMK) to use to encrypt
|
1161
|
+
# data indexed by Amazon Kendra. Amazon Kendra doesn't support
|
1122
1162
|
# asymmetric CMKs.
|
1123
1163
|
#
|
1124
1164
|
# @option params [String] :description
|
@@ -1465,6 +1505,78 @@ module Aws::Kendra
|
|
1465
1505
|
req.send_request(options)
|
1466
1506
|
end
|
1467
1507
|
|
1508
|
+
# Deletes a group so that all users and sub groups that belong to the
|
1509
|
+
# group can no longer access documents only available to that group.
|
1510
|
+
#
|
1511
|
+
# For example, after deleting the group "Summer Interns", all interns
|
1512
|
+
# who belonged to that group no longer see intern-only documents in
|
1513
|
+
# their search results.
|
1514
|
+
#
|
1515
|
+
# If you want to delete or replace users or sub groups of a group, you
|
1516
|
+
# need to use the `PutPrincipalMapping` operation. For example, if a
|
1517
|
+
# user in the group "Engineering" leaves the engineering team and
|
1518
|
+
# another user takes their place, you provide an updated list of users
|
1519
|
+
# or sub groups that belong to the "Engineering" group when calling
|
1520
|
+
# `PutPrincipalMapping`. You can update your internal list of users or
|
1521
|
+
# sub groups and input this list when calling `PutPrincipalMapping`.
|
1522
|
+
#
|
1523
|
+
# @option params [required, String] :index_id
|
1524
|
+
# The identifier of the index you want to delete a group from.
|
1525
|
+
#
|
1526
|
+
# @option params [String] :data_source_id
|
1527
|
+
# The identifier of the data source you want to delete a group from.
|
1528
|
+
#
|
1529
|
+
# This is useful if a group is tied to multiple data sources and you
|
1530
|
+
# want to delete a group from accessing documents in a certain data
|
1531
|
+
# source. For example, the groups "Research", "Engineering", and
|
1532
|
+
# "Sales and Marketing" are all tied to the company's documents
|
1533
|
+
# stored in the data sources Confluence and Salesforce. You want to
|
1534
|
+
# delete "Research" and "Engineering" groups from Salesforce, so
|
1535
|
+
# that these groups cannot access customer-related documents stored in
|
1536
|
+
# Salesforce. Only "Sales and Marketing" should access documents in
|
1537
|
+
# the Salesforce data source.
|
1538
|
+
#
|
1539
|
+
# @option params [required, String] :group_id
|
1540
|
+
# The identifier of the group you want to delete.
|
1541
|
+
#
|
1542
|
+
# @option params [Integer] :ordering_id
|
1543
|
+
# The timestamp identifier you specify to ensure Amazon Kendra does not
|
1544
|
+
# override the latest `DELETE` action with previous actions. The highest
|
1545
|
+
# number ID, which is the ordering ID, is the latest action you want to
|
1546
|
+
# process and apply on top of other actions with lower number IDs. This
|
1547
|
+
# prevents previous actions with lower number IDs from possibly
|
1548
|
+
# overriding the latest action.
|
1549
|
+
#
|
1550
|
+
# The ordering ID can be the UNIX time of the last update you made to a
|
1551
|
+
# group members list. You would then provide this list when calling
|
1552
|
+
# `PutPrincipalMapping`. This ensures your `DELETE` action for that
|
1553
|
+
# updated group with the latest members list doesn't get overwritten by
|
1554
|
+
# earlier `DELETE` actions for the same group which are yet to be
|
1555
|
+
# processed.
|
1556
|
+
#
|
1557
|
+
# The default ordering ID is the current UNIX time in milliseconds that
|
1558
|
+
# the action was received by Amazon Kendra.
|
1559
|
+
#
|
1560
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1561
|
+
#
|
1562
|
+
# @example Request syntax with placeholder values
|
1563
|
+
#
|
1564
|
+
# resp = client.delete_principal_mapping({
|
1565
|
+
# index_id: "IndexId", # required
|
1566
|
+
# data_source_id: "DataSourceId",
|
1567
|
+
# group_id: "GroupId", # required
|
1568
|
+
# ordering_id: 1,
|
1569
|
+
# })
|
1570
|
+
#
|
1571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMapping AWS API Documentation
|
1572
|
+
#
|
1573
|
+
# @overload delete_principal_mapping(params = {})
|
1574
|
+
# @param [Hash] params ({})
|
1575
|
+
def delete_principal_mapping(params = {}, options = {})
|
1576
|
+
req = build_request(:delete_principal_mapping, params)
|
1577
|
+
req.send_request(options)
|
1578
|
+
end
|
1579
|
+
|
1468
1580
|
# Deletes a block list used for query suggestions for an index.
|
1469
1581
|
#
|
1470
1582
|
# A deleted block list might not take effect right away. Amazon Kendra
|
@@ -1556,7 +1668,7 @@ module Aws::Kendra
|
|
1556
1668
|
# resp.id #=> String
|
1557
1669
|
# resp.index_id #=> String
|
1558
1670
|
# resp.name #=> String
|
1559
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
|
1671
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
|
1560
1672
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
1561
1673
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
1562
1674
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -1566,7 +1678,7 @@ module Aws::Kendra
|
|
1566
1678
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
1567
1679
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
1568
1680
|
# resp.configuration.s3_configuration.access_control_list_configuration.key_path #=> String
|
1569
|
-
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_ONLINE"
|
1681
|
+
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_2013", "SHAREPOINT_2016", "SHAREPOINT_ONLINE"
|
1570
1682
|
# resp.configuration.share_point_configuration.urls #=> Array
|
1571
1683
|
# resp.configuration.share_point_configuration.urls[0] #=> String
|
1572
1684
|
# resp.configuration.share_point_configuration.secret_arn #=> String
|
@@ -1586,6 +1698,8 @@ module Aws::Kendra
|
|
1586
1698
|
# resp.configuration.share_point_configuration.field_mappings[0].index_field_name #=> String
|
1587
1699
|
# resp.configuration.share_point_configuration.document_title_field_name #=> String
|
1588
1700
|
# resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
|
1701
|
+
# resp.configuration.share_point_configuration.ssl_certificate_s3_path.bucket #=> String
|
1702
|
+
# resp.configuration.share_point_configuration.ssl_certificate_s3_path.key #=> String
|
1589
1703
|
# resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
|
1590
1704
|
# resp.configuration.database_configuration.connection_configuration.database_host #=> String
|
1591
1705
|
# resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
|
@@ -1762,6 +1876,17 @@ module Aws::Kendra
|
|
1762
1876
|
# resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].host #=> String
|
1763
1877
|
# resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].port #=> Integer
|
1764
1878
|
# resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].credentials #=> String
|
1879
|
+
# resp.configuration.work_docs_configuration.organization_id #=> String
|
1880
|
+
# resp.configuration.work_docs_configuration.crawl_comments #=> Boolean
|
1881
|
+
# resp.configuration.work_docs_configuration.use_change_log #=> Boolean
|
1882
|
+
# resp.configuration.work_docs_configuration.inclusion_patterns #=> Array
|
1883
|
+
# resp.configuration.work_docs_configuration.inclusion_patterns[0] #=> String
|
1884
|
+
# resp.configuration.work_docs_configuration.exclusion_patterns #=> Array
|
1885
|
+
# resp.configuration.work_docs_configuration.exclusion_patterns[0] #=> String
|
1886
|
+
# resp.configuration.work_docs_configuration.field_mappings #=> Array
|
1887
|
+
# resp.configuration.work_docs_configuration.field_mappings[0].data_source_field_name #=> String
|
1888
|
+
# resp.configuration.work_docs_configuration.field_mappings[0].date_field_format #=> String
|
1889
|
+
# resp.configuration.work_docs_configuration.field_mappings[0].index_field_name #=> String
|
1765
1890
|
# resp.created_at #=> Time
|
1766
1891
|
# resp.updated_at #=> Time
|
1767
1892
|
# resp.description #=> String
|
@@ -1912,6 +2037,61 @@ module Aws::Kendra
|
|
1912
2037
|
req.send_request(options)
|
1913
2038
|
end
|
1914
2039
|
|
2040
|
+
# Describes the processing of `PUT` and `DELETE` actions for mapping
|
2041
|
+
# users to their groups. This includes information on the status of
|
2042
|
+
# actions currently processing or yet to be processed, when actions were
|
2043
|
+
# last updated, when actions were received by Amazon Kendra, the latest
|
2044
|
+
# action that should process and apply after other actions, and useful
|
2045
|
+
# error messages if an action could not be processed.
|
2046
|
+
#
|
2047
|
+
# @option params [required, String] :index_id
|
2048
|
+
# The identifier of the index required to check the processing of `PUT`
|
2049
|
+
# and `DELETE` actions for mapping users to their groups.
|
2050
|
+
#
|
2051
|
+
# @option params [String] :data_source_id
|
2052
|
+
# The identifier of the data source to check the processing of `PUT` and
|
2053
|
+
# `DELETE` actions for mapping users to their groups.
|
2054
|
+
#
|
2055
|
+
# @option params [required, String] :group_id
|
2056
|
+
# The identifier of the group required to check the processing of `PUT`
|
2057
|
+
# and `DELETE` actions for mapping users to their groups.
|
2058
|
+
#
|
2059
|
+
# @return [Types::DescribePrincipalMappingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2060
|
+
#
|
2061
|
+
# * {Types::DescribePrincipalMappingResponse#index_id #index_id} => String
|
2062
|
+
# * {Types::DescribePrincipalMappingResponse#data_source_id #data_source_id} => String
|
2063
|
+
# * {Types::DescribePrincipalMappingResponse#group_id #group_id} => String
|
2064
|
+
# * {Types::DescribePrincipalMappingResponse#group_ordering_id_summaries #group_ordering_id_summaries} => Array<Types::GroupOrderingIdSummary>
|
2065
|
+
#
|
2066
|
+
# @example Request syntax with placeholder values
|
2067
|
+
#
|
2068
|
+
# resp = client.describe_principal_mapping({
|
2069
|
+
# index_id: "IndexId", # required
|
2070
|
+
# data_source_id: "DataSourceId",
|
2071
|
+
# group_id: "GroupId", # required
|
2072
|
+
# })
|
2073
|
+
#
|
2074
|
+
# @example Response structure
|
2075
|
+
#
|
2076
|
+
# resp.index_id #=> String
|
2077
|
+
# resp.data_source_id #=> String
|
2078
|
+
# resp.group_id #=> String
|
2079
|
+
# resp.group_ordering_id_summaries #=> Array
|
2080
|
+
# resp.group_ordering_id_summaries[0].status #=> String, one of "FAILED", "SUCCEEDED", "PROCESSING", "DELETING", "DELETED"
|
2081
|
+
# resp.group_ordering_id_summaries[0].last_updated_at #=> Time
|
2082
|
+
# resp.group_ordering_id_summaries[0].received_at #=> Time
|
2083
|
+
# resp.group_ordering_id_summaries[0].ordering_id #=> Integer
|
2084
|
+
# resp.group_ordering_id_summaries[0].failure_reason #=> String
|
2085
|
+
#
|
2086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMapping AWS API Documentation
|
2087
|
+
#
|
2088
|
+
# @overload describe_principal_mapping(params = {})
|
2089
|
+
# @param [Hash] params ({})
|
2090
|
+
def describe_principal_mapping(params = {}, options = {})
|
2091
|
+
req = build_request(:describe_principal_mapping, params)
|
2092
|
+
req.send_request(options)
|
2093
|
+
end
|
2094
|
+
|
1915
2095
|
# Describes a block list used for query suggestions for an index.
|
1916
2096
|
#
|
1917
2097
|
# This is used to check the current settings that are applied to a block
|
@@ -2233,7 +2413,7 @@ module Aws::Kendra
|
|
2233
2413
|
# resp.summary_items #=> Array
|
2234
2414
|
# resp.summary_items[0].name #=> String
|
2235
2415
|
# resp.summary_items[0].id #=> String
|
2236
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
|
2416
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
|
2237
2417
|
# resp.summary_items[0].created_at #=> Time
|
2238
2418
|
# resp.summary_items[0].updated_at #=> Time
|
2239
2419
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -2295,6 +2475,59 @@ module Aws::Kendra
|
|
2295
2475
|
req.send_request(options)
|
2296
2476
|
end
|
2297
2477
|
|
2478
|
+
# Provides a list of groups that are mapped to users before a given
|
2479
|
+
# ordering or timestamp identifier.
|
2480
|
+
#
|
2481
|
+
# @option params [required, String] :index_id
|
2482
|
+
# The identifier of the index for getting a list of groups mapped to
|
2483
|
+
# users before a given ordering or timestamp identifier.
|
2484
|
+
#
|
2485
|
+
# @option params [String] :data_source_id
|
2486
|
+
# The identifier of the data source for getting a list of groups mapped
|
2487
|
+
# to users before a given ordering timestamp identifier.
|
2488
|
+
#
|
2489
|
+
# @option params [required, Integer] :ordering_id
|
2490
|
+
# The timestamp identifier used for the latest `PUT` or `DELETE` action
|
2491
|
+
# for mapping users to their groups.
|
2492
|
+
#
|
2493
|
+
# @option params [String] :next_token
|
2494
|
+
# The next items in the list of groups that go beyond the maximum.
|
2495
|
+
#
|
2496
|
+
# @option params [Integer] :max_results
|
2497
|
+
# The maximum results shown for a list of groups that are mapped to
|
2498
|
+
# users before a given ordering or timestamp identifier.
|
2499
|
+
#
|
2500
|
+
# @return [Types::ListGroupsOlderThanOrderingIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2501
|
+
#
|
2502
|
+
# * {Types::ListGroupsOlderThanOrderingIdResponse#groups_summaries #groups_summaries} => Array<Types::GroupSummary>
|
2503
|
+
# * {Types::ListGroupsOlderThanOrderingIdResponse#next_token #next_token} => String
|
2504
|
+
#
|
2505
|
+
# @example Request syntax with placeholder values
|
2506
|
+
#
|
2507
|
+
# resp = client.list_groups_older_than_ordering_id({
|
2508
|
+
# index_id: "IndexId", # required
|
2509
|
+
# data_source_id: "DataSourceId",
|
2510
|
+
# ordering_id: 1, # required
|
2511
|
+
# next_token: "NextToken",
|
2512
|
+
# max_results: 1,
|
2513
|
+
# })
|
2514
|
+
#
|
2515
|
+
# @example Response structure
|
2516
|
+
#
|
2517
|
+
# resp.groups_summaries #=> Array
|
2518
|
+
# resp.groups_summaries[0].group_id #=> String
|
2519
|
+
# resp.groups_summaries[0].ordering_id #=> Integer
|
2520
|
+
# resp.next_token #=> String
|
2521
|
+
#
|
2522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId AWS API Documentation
|
2523
|
+
#
|
2524
|
+
# @overload list_groups_older_than_ordering_id(params = {})
|
2525
|
+
# @param [Hash] params ({})
|
2526
|
+
def list_groups_older_than_ordering_id(params = {}, options = {})
|
2527
|
+
req = build_request(:list_groups_older_than_ordering_id, params)
|
2528
|
+
req.send_request(options)
|
2529
|
+
end
|
2530
|
+
|
2298
2531
|
# Lists the Amazon Kendra indexes that you have created.
|
2299
2532
|
#
|
2300
2533
|
# @option params [String] :next_token
|
@@ -2480,6 +2713,123 @@ module Aws::Kendra
|
|
2480
2713
|
req.send_request(options)
|
2481
2714
|
end
|
2482
2715
|
|
2716
|
+
# Maps users to their groups. You can also map sub groups to groups. For
|
2717
|
+
# example, the group "Company Intellectual Property Teams" includes
|
2718
|
+
# sub groups "Research" and "Engineering". These sub groups include
|
2719
|
+
# their own list of users or people who work in these teams. Only users
|
2720
|
+
# who work in research and engineering, and therefore belong in the
|
2721
|
+
# intellectual property group, can see top-secret company documents in
|
2722
|
+
# their search results.
|
2723
|
+
#
|
2724
|
+
# You map users to their groups when you want to filter search results
|
2725
|
+
# for different users based on their group’s access to documents. For
|
2726
|
+
# more information on filtering search results for different users, see
|
2727
|
+
# [Filtering on user context][1].
|
2728
|
+
#
|
2729
|
+
# If more than five `PUT` actions for a group are currently processing,
|
2730
|
+
# a validation exception is thrown.
|
2731
|
+
#
|
2732
|
+
#
|
2733
|
+
#
|
2734
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
|
2735
|
+
#
|
2736
|
+
# @option params [required, String] :index_id
|
2737
|
+
# The identifier of the index you want to map users to their groups.
|
2738
|
+
#
|
2739
|
+
# @option params [String] :data_source_id
|
2740
|
+
# The identifier of the data source you want to map users to their
|
2741
|
+
# groups.
|
2742
|
+
#
|
2743
|
+
# This is useful if a group is tied to multiple data sources, but you
|
2744
|
+
# only want the group to access documents of a certain data source. For
|
2745
|
+
# example, the groups "Research", "Engineering", and "Sales and
|
2746
|
+
# Marketing" are all tied to the company's documents stored in the
|
2747
|
+
# data sources Confluence and Salesforce. However, "Sales and
|
2748
|
+
# Marketing" team only needs access to customer-related documents
|
2749
|
+
# stored in Salesforce.
|
2750
|
+
#
|
2751
|
+
# @option params [required, String] :group_id
|
2752
|
+
# The identifier of the group you want to map its users to.
|
2753
|
+
#
|
2754
|
+
# @option params [required, Types::GroupMembers] :group_members
|
2755
|
+
# The list that contains your users or sub groups that belong the same
|
2756
|
+
# group.
|
2757
|
+
#
|
2758
|
+
# For example, the group "Company" includes the user "CEO" and the
|
2759
|
+
# sub groups "Research", "Engineering", and "Sales and Marketing".
|
2760
|
+
#
|
2761
|
+
# If you have more than 1000 users and/or sub groups for a single group,
|
2762
|
+
# you need to provide the path to the S3 file that lists your users and
|
2763
|
+
# sub groups for a group. Your sub groups can contain more than 1000
|
2764
|
+
# users, but the list of sub groups that belong to a group (and/or
|
2765
|
+
# users) must be no more than 1000.
|
2766
|
+
#
|
2767
|
+
# @option params [Integer] :ordering_id
|
2768
|
+
# The timestamp identifier you specify to ensure Amazon Kendra does not
|
2769
|
+
# override the latest `PUT` action with previous actions. The highest
|
2770
|
+
# number ID, which is the ordering ID, is the latest action you want to
|
2771
|
+
# process and apply on top of other actions with lower number IDs. This
|
2772
|
+
# prevents previous actions with lower number IDs from possibly
|
2773
|
+
# overriding the latest action.
|
2774
|
+
#
|
2775
|
+
# The ordering ID can be the UNIX time of the last update you made to a
|
2776
|
+
# group members list. You would then provide this list when calling
|
2777
|
+
# `PutPrincipalMapping`. This ensures your `PUT` action for that updated
|
2778
|
+
# group with the latest members list doesn't get overwritten by earlier
|
2779
|
+
# `PUT` actions for the same group which are yet to be processed.
|
2780
|
+
#
|
2781
|
+
# The default ordering ID is the current UNIX time in milliseconds that
|
2782
|
+
# the action was received by Amazon Kendra.
|
2783
|
+
#
|
2784
|
+
# @option params [String] :role_arn
|
2785
|
+
# The Amazon Resource Name (ARN) of a role that has access to the S3
|
2786
|
+
# file that contains your list of users or sub groups that belong to a
|
2787
|
+
# group.
|
2788
|
+
#
|
2789
|
+
# For more information, see [IAM roles for Amazon Kendra][1].
|
2790
|
+
#
|
2791
|
+
#
|
2792
|
+
#
|
2793
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds
|
2794
|
+
#
|
2795
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2796
|
+
#
|
2797
|
+
# @example Request syntax with placeholder values
|
2798
|
+
#
|
2799
|
+
# resp = client.put_principal_mapping({
|
2800
|
+
# index_id: "IndexId", # required
|
2801
|
+
# data_source_id: "DataSourceId",
|
2802
|
+
# group_id: "GroupId", # required
|
2803
|
+
# group_members: { # required
|
2804
|
+
# member_groups: [
|
2805
|
+
# {
|
2806
|
+
# group_id: "GroupId", # required
|
2807
|
+
# data_source_id: "DataSourceId",
|
2808
|
+
# },
|
2809
|
+
# ],
|
2810
|
+
# member_users: [
|
2811
|
+
# {
|
2812
|
+
# user_id: "UserId", # required
|
2813
|
+
# },
|
2814
|
+
# ],
|
2815
|
+
# s3_pathfor_group_members: {
|
2816
|
+
# bucket: "S3BucketName", # required
|
2817
|
+
# key: "S3ObjectKey", # required
|
2818
|
+
# },
|
2819
|
+
# },
|
2820
|
+
# ordering_id: 1,
|
2821
|
+
# role_arn: "RoleArn",
|
2822
|
+
# })
|
2823
|
+
#
|
2824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping AWS API Documentation
|
2825
|
+
#
|
2826
|
+
# @overload put_principal_mapping(params = {})
|
2827
|
+
# @param [Hash] params ({})
|
2828
|
+
def put_principal_mapping(params = {}, options = {})
|
2829
|
+
req = build_request(:put_principal_mapping, params)
|
2830
|
+
req.send_request(options)
|
2831
|
+
end
|
2832
|
+
|
2483
2833
|
# Searches an active index. Use this API to search your documents using
|
2484
2834
|
# query. The `Query` operation enables to do faceted search and to
|
2485
2835
|
# filter results based on document attributes.
|
@@ -2698,6 +3048,14 @@ module Aws::Kendra
|
|
2698
3048
|
# },
|
2699
3049
|
# user_context: {
|
2700
3050
|
# token: "Token",
|
3051
|
+
# user_id: "PrincipalName",
|
3052
|
+
# groups: ["PrincipalName"],
|
3053
|
+
# data_source_groups: [
|
3054
|
+
# {
|
3055
|
+
# group_id: "PrincipalName", # required
|
3056
|
+
# data_source_id: "DataSourceId", # required
|
3057
|
+
# },
|
3058
|
+
# ],
|
2701
3059
|
# },
|
2702
3060
|
# visitor_id: "VisitorId",
|
2703
3061
|
# })
|
@@ -2824,7 +3182,7 @@ module Aws::Kendra
|
|
2824
3182
|
end
|
2825
3183
|
|
2826
3184
|
# Enables you to provide feedback to Amazon Kendra to improve the
|
2827
|
-
# performance of
|
3185
|
+
# performance of your index.
|
2828
3186
|
#
|
2829
3187
|
# @option params [required, String] :index_id
|
2830
3188
|
# The identifier of the index that was queried.
|
@@ -2983,7 +3341,7 @@ module Aws::Kendra
|
|
2983
3341
|
# },
|
2984
3342
|
# },
|
2985
3343
|
# share_point_configuration: {
|
2986
|
-
# share_point_version: "
|
3344
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
2987
3345
|
# urls: ["Url"], # required
|
2988
3346
|
# secret_arn: "SecretArn", # required
|
2989
3347
|
# crawl_attachments: false,
|
@@ -3003,6 +3361,10 @@ module Aws::Kendra
|
|
3003
3361
|
# ],
|
3004
3362
|
# document_title_field_name: "DataSourceFieldName",
|
3005
3363
|
# disable_local_groups: false,
|
3364
|
+
# ssl_certificate_s3_path: {
|
3365
|
+
# bucket: "S3BucketName", # required
|
3366
|
+
# key: "S3ObjectKey", # required
|
3367
|
+
# },
|
3006
3368
|
# },
|
3007
3369
|
# database_configuration: {
|
3008
3370
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -3262,6 +3624,20 @@ module Aws::Kendra
|
|
3262
3624
|
# ],
|
3263
3625
|
# },
|
3264
3626
|
# },
|
3627
|
+
# work_docs_configuration: {
|
3628
|
+
# organization_id: "OrganizationId", # required
|
3629
|
+
# crawl_comments: false,
|
3630
|
+
# use_change_log: false,
|
3631
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3632
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3633
|
+
# field_mappings: [
|
3634
|
+
# {
|
3635
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3636
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3637
|
+
# index_field_name: "IndexFieldName", # required
|
3638
|
+
# },
|
3639
|
+
# ],
|
3640
|
+
# },
|
3265
3641
|
# },
|
3266
3642
|
# description: "Description",
|
3267
3643
|
# schedule: "ScanSchedule",
|
@@ -3591,7 +3967,7 @@ module Aws::Kendra
|
|
3591
3967
|
params: params,
|
3592
3968
|
config: config)
|
3593
3969
|
context[:gem_name] = 'aws-sdk-kendra'
|
3594
|
-
context[:gem_version] = '1.
|
3970
|
+
context[:gem_version] = '1.31.0'
|
3595
3971
|
Seahorse::Client::Request.new(handlers, context)
|
3596
3972
|
end
|
3597
3973
|
|