aws-sdk-kendra 1.17.0 → 1.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +123 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-kendra.rb +2 -2
- data/lib/aws-sdk-kendra/client.rb +393 -8
- data/lib/aws-sdk-kendra/client_api.rb +217 -1
- data/lib/aws-sdk-kendra/errors.rb +1 -1
- data/lib/aws-sdk-kendra/resource.rb +1 -1
- data/lib/aws-sdk-kendra/types.rb +811 -22
- metadata +8 -5
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -3,14 +3,19 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
10
|
module Aws::Kendra
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Access Control List files for the documents in a data source.
|
13
|
+
# Access Control List files for the documents in a data source. For the
|
14
|
+
# format of the file, see [Access control for S3 data sources][1].
|
15
|
+
#
|
16
|
+
#
|
17
|
+
#
|
18
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html
|
14
19
|
#
|
15
20
|
# @note When making an API call, you may pass AccessControlListConfiguration
|
16
21
|
# data as a hash:
|
@@ -986,7 +991,7 @@ module Aws::Kendra
|
|
986
991
|
# {
|
987
992
|
# server_url: "Url", # required
|
988
993
|
# secret_arn: "SecretArn", # required
|
989
|
-
# version: "
|
994
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
990
995
|
# space_configuration: {
|
991
996
|
# crawl_personal_spaces: false,
|
992
997
|
# crawl_archived_spaces: false,
|
@@ -1048,8 +1053,8 @@ module Aws::Kendra
|
|
1048
1053
|
# server. The secret must contain a JSON structure with the following
|
1049
1054
|
# keys:
|
1050
1055
|
#
|
1051
|
-
# * username - The user name of a user with
|
1052
|
-
# for the Confluence server.
|
1056
|
+
# * username - The user name or email address of a user with
|
1057
|
+
# administrative privileges for the Confluence server.
|
1053
1058
|
#
|
1054
1059
|
# * password - The password associated with the user logging in to the
|
1055
1060
|
# Confluence server.
|
@@ -1364,7 +1369,7 @@ module Aws::Kendra
|
|
1364
1369
|
# {
|
1365
1370
|
# name: "DataSourceName", # required
|
1366
1371
|
# index_id: "IndexId", # required
|
1367
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE
|
1372
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
|
1368
1373
|
# configuration: {
|
1369
1374
|
# s3_configuration: {
|
1370
1375
|
# bucket_name: "S3BucketName", # required
|
@@ -1398,6 +1403,7 @@ module Aws::Kendra
|
|
1398
1403
|
# },
|
1399
1404
|
# ],
|
1400
1405
|
# document_title_field_name: "DataSourceFieldName",
|
1406
|
+
# disable_local_groups: false,
|
1401
1407
|
# },
|
1402
1408
|
# database_configuration: {
|
1403
1409
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -1522,6 +1528,7 @@ module Aws::Kendra
|
|
1522
1528
|
# index_field_name: "IndexFieldName", # required
|
1523
1529
|
# },
|
1524
1530
|
# ],
|
1531
|
+
# disable_local_groups: false,
|
1525
1532
|
# },
|
1526
1533
|
# service_now_configuration: {
|
1527
1534
|
# host_url: "ServiceNowHostUrl", # required
|
@@ -1559,7 +1566,7 @@ module Aws::Kendra
|
|
1559
1566
|
# confluence_configuration: {
|
1560
1567
|
# server_url: "Url", # required
|
1561
1568
|
# secret_arn: "SecretArn", # required
|
1562
|
-
# version: "
|
1569
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
1563
1570
|
# space_configuration: {
|
1564
1571
|
# crawl_personal_spaces: false,
|
1565
1572
|
# crawl_archived_spaces: false,
|
@@ -1608,6 +1615,21 @@ module Aws::Kendra
|
|
1608
1615
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1609
1616
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1610
1617
|
# },
|
1618
|
+
# google_drive_configuration: {
|
1619
|
+
# secret_arn: "SecretArn", # required
|
1620
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1621
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1622
|
+
# field_mappings: [
|
1623
|
+
# {
|
1624
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1625
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1626
|
+
# index_field_name: "IndexFieldName", # required
|
1627
|
+
# },
|
1628
|
+
# ],
|
1629
|
+
# exclude_mime_types: ["MimeType"],
|
1630
|
+
# exclude_user_accounts: ["UserAccount"],
|
1631
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
1632
|
+
# },
|
1611
1633
|
# },
|
1612
1634
|
# description: "Description",
|
1613
1635
|
# schedule: "ScanSchedule",
|
@@ -1844,6 +1866,24 @@ module Aws::Kendra
|
|
1844
1866
|
# value: "TagValue", # required
|
1845
1867
|
# },
|
1846
1868
|
# ],
|
1869
|
+
# user_token_configurations: [
|
1870
|
+
# {
|
1871
|
+
# jwt_token_type_configuration: {
|
1872
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
1873
|
+
# url: "Url",
|
1874
|
+
# secret_manager_arn: "RoleArn",
|
1875
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
1876
|
+
# group_attribute_field: "GroupAttributeField",
|
1877
|
+
# issuer: "Issuer",
|
1878
|
+
# claim_regex: "ClaimRegex",
|
1879
|
+
# },
|
1880
|
+
# json_token_type_configuration: {
|
1881
|
+
# user_name_attribute_field: "String", # required
|
1882
|
+
# group_attribute_field: "String", # required
|
1883
|
+
# },
|
1884
|
+
# },
|
1885
|
+
# ],
|
1886
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
1847
1887
|
# }
|
1848
1888
|
#
|
1849
1889
|
# @!attribute [rw] name
|
@@ -1894,6 +1934,26 @@ module Aws::Kendra
|
|
1894
1934
|
# to resources.
|
1895
1935
|
# @return [Array<Types::Tag>]
|
1896
1936
|
#
|
1937
|
+
# @!attribute [rw] user_token_configurations
|
1938
|
+
# The user token configuration.
|
1939
|
+
# @return [Array<Types::UserTokenConfiguration>]
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] user_context_policy
|
1942
|
+
# The user context policy.
|
1943
|
+
#
|
1944
|
+
# ATTRIBUTE\_FILTER
|
1945
|
+
#
|
1946
|
+
# : All indexed content is searchable and displayable for all users.
|
1947
|
+
# If there is an access control list, it is ignored. You can filter
|
1948
|
+
# on user and group attributes.
|
1949
|
+
#
|
1950
|
+
# USER\_TOKEN
|
1951
|
+
#
|
1952
|
+
# : Enables SSO and token-based user access control. All documents
|
1953
|
+
# with no access control and all documents accessible to the user
|
1954
|
+
# will be searchable and displayable.
|
1955
|
+
# @return [String]
|
1956
|
+
#
|
1897
1957
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
|
1898
1958
|
#
|
1899
1959
|
class CreateIndexRequest < Struct.new(
|
@@ -1903,7 +1963,9 @@ module Aws::Kendra
|
|
1903
1963
|
:server_side_encryption_configuration,
|
1904
1964
|
:description,
|
1905
1965
|
:client_token,
|
1906
|
-
:tags
|
1966
|
+
:tags,
|
1967
|
+
:user_token_configurations,
|
1968
|
+
:user_context_policy)
|
1907
1969
|
SENSITIVE = []
|
1908
1970
|
include Aws::Structure
|
1909
1971
|
end
|
@@ -1921,6 +1983,90 @@ module Aws::Kendra
|
|
1921
1983
|
include Aws::Structure
|
1922
1984
|
end
|
1923
1985
|
|
1986
|
+
# @note When making an API call, you may pass CreateThesaurusRequest
|
1987
|
+
# data as a hash:
|
1988
|
+
#
|
1989
|
+
# {
|
1990
|
+
# index_id: "IndexId", # required
|
1991
|
+
# name: "ThesaurusName", # required
|
1992
|
+
# description: "Description",
|
1993
|
+
# role_arn: "RoleArn", # required
|
1994
|
+
# tags: [
|
1995
|
+
# {
|
1996
|
+
# key: "TagKey", # required
|
1997
|
+
# value: "TagValue", # required
|
1998
|
+
# },
|
1999
|
+
# ],
|
2000
|
+
# source_s3_path: { # required
|
2001
|
+
# bucket: "S3BucketName", # required
|
2002
|
+
# key: "S3ObjectKey", # required
|
2003
|
+
# },
|
2004
|
+
# client_token: "ClientTokenName",
|
2005
|
+
# }
|
2006
|
+
#
|
2007
|
+
# @!attribute [rw] index_id
|
2008
|
+
# The unique identifier of the index for the new thesaurus.
|
2009
|
+
# @return [String]
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] name
|
2012
|
+
# The name for the new thesaurus.
|
2013
|
+
# @return [String]
|
2014
|
+
#
|
2015
|
+
# @!attribute [rw] description
|
2016
|
+
# The description for the new thesaurus.
|
2017
|
+
# @return [String]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] role_arn
|
2020
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
2021
|
+
# Kendra permissions to access thesaurus file specified in
|
2022
|
+
# `SourceS3Path`.
|
2023
|
+
# @return [String]
|
2024
|
+
#
|
2025
|
+
# @!attribute [rw] tags
|
2026
|
+
# A list of key-value pairs that identify the thesaurus. You can use
|
2027
|
+
# the tags to identify and organize your resources and to control
|
2028
|
+
# access to resources.
|
2029
|
+
# @return [Array<Types::Tag>]
|
2030
|
+
#
|
2031
|
+
# @!attribute [rw] source_s3_path
|
2032
|
+
# The thesaurus file Amazon S3 source path.
|
2033
|
+
# @return [Types::S3Path]
|
2034
|
+
#
|
2035
|
+
# @!attribute [rw] client_token
|
2036
|
+
# A token that you provide to identify the request to create a
|
2037
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` operation with
|
2038
|
+
# the same client token will create only one index.
|
2039
|
+
#
|
2040
|
+
# **A suitable default value is auto-generated.** You should normally
|
2041
|
+
# not need to pass this option.
|
2042
|
+
# @return [String]
|
2043
|
+
#
|
2044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurusRequest AWS API Documentation
|
2045
|
+
#
|
2046
|
+
class CreateThesaurusRequest < Struct.new(
|
2047
|
+
:index_id,
|
2048
|
+
:name,
|
2049
|
+
:description,
|
2050
|
+
:role_arn,
|
2051
|
+
:tags,
|
2052
|
+
:source_s3_path,
|
2053
|
+
:client_token)
|
2054
|
+
SENSITIVE = []
|
2055
|
+
include Aws::Structure
|
2056
|
+
end
|
2057
|
+
|
2058
|
+
# @!attribute [rw] id
|
2059
|
+
# The unique identifier of the thesaurus.
|
2060
|
+
# @return [String]
|
2061
|
+
#
|
2062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurusResponse AWS API Documentation
|
2063
|
+
#
|
2064
|
+
class CreateThesaurusResponse < Struct.new(
|
2065
|
+
:id)
|
2066
|
+
SENSITIVE = []
|
2067
|
+
include Aws::Structure
|
2068
|
+
end
|
2069
|
+
|
1924
2070
|
# Configuration information for a Amazon Kendra data source.
|
1925
2071
|
#
|
1926
2072
|
# @note When making an API call, you may pass DataSourceConfiguration
|
@@ -1959,6 +2105,7 @@ module Aws::Kendra
|
|
1959
2105
|
# },
|
1960
2106
|
# ],
|
1961
2107
|
# document_title_field_name: "DataSourceFieldName",
|
2108
|
+
# disable_local_groups: false,
|
1962
2109
|
# },
|
1963
2110
|
# database_configuration: {
|
1964
2111
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -2083,6 +2230,7 @@ module Aws::Kendra
|
|
2083
2230
|
# index_field_name: "IndexFieldName", # required
|
2084
2231
|
# },
|
2085
2232
|
# ],
|
2233
|
+
# disable_local_groups: false,
|
2086
2234
|
# },
|
2087
2235
|
# service_now_configuration: {
|
2088
2236
|
# host_url: "ServiceNowHostUrl", # required
|
@@ -2120,7 +2268,7 @@ module Aws::Kendra
|
|
2120
2268
|
# confluence_configuration: {
|
2121
2269
|
# server_url: "Url", # required
|
2122
2270
|
# secret_arn: "SecretArn", # required
|
2123
|
-
# version: "
|
2271
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
2124
2272
|
# space_configuration: {
|
2125
2273
|
# crawl_personal_spaces: false,
|
2126
2274
|
# crawl_archived_spaces: false,
|
@@ -2169,6 +2317,21 @@ module Aws::Kendra
|
|
2169
2317
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2170
2318
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2171
2319
|
# },
|
2320
|
+
# google_drive_configuration: {
|
2321
|
+
# secret_arn: "SecretArn", # required
|
2322
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2323
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2324
|
+
# field_mappings: [
|
2325
|
+
# {
|
2326
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2327
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2328
|
+
# index_field_name: "IndexFieldName", # required
|
2329
|
+
# },
|
2330
|
+
# ],
|
2331
|
+
# exclude_mime_types: ["MimeType"],
|
2332
|
+
# exclude_user_accounts: ["UserAccount"],
|
2333
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
2334
|
+
# },
|
2172
2335
|
# }
|
2173
2336
|
#
|
2174
2337
|
# @!attribute [rw] s3_configuration
|
@@ -2192,7 +2355,7 @@ module Aws::Kendra
|
|
2192
2355
|
# @return [Types::SalesforceConfiguration]
|
2193
2356
|
#
|
2194
2357
|
# @!attribute [rw] one_drive_configuration
|
2195
|
-
#
|
2358
|
+
# Provides configuration for data sources that connect to Microsoft
|
2196
2359
|
# OneDrive.
|
2197
2360
|
# @return [Types::OneDriveConfiguration]
|
2198
2361
|
#
|
@@ -2206,6 +2369,11 @@ module Aws::Kendra
|
|
2206
2369
|
# data source.
|
2207
2370
|
# @return [Types::ConfluenceConfiguration]
|
2208
2371
|
#
|
2372
|
+
# @!attribute [rw] google_drive_configuration
|
2373
|
+
# Provides configuration for data sources that connect to Google
|
2374
|
+
# Drive.
|
2375
|
+
# @return [Types::GoogleDriveConfiguration]
|
2376
|
+
#
|
2209
2377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
2210
2378
|
#
|
2211
2379
|
class DataSourceConfiguration < Struct.new(
|
@@ -2215,7 +2383,8 @@ module Aws::Kendra
|
|
2215
2383
|
:salesforce_configuration,
|
2216
2384
|
:one_drive_configuration,
|
2217
2385
|
:service_now_configuration,
|
2218
|
-
:confluence_configuration
|
2386
|
+
:confluence_configuration,
|
2387
|
+
:google_drive_configuration)
|
2219
2388
|
SENSITIVE = []
|
2220
2389
|
include Aws::Structure
|
2221
2390
|
end
|
@@ -2602,6 +2771,31 @@ module Aws::Kendra
|
|
2602
2771
|
include Aws::Structure
|
2603
2772
|
end
|
2604
2773
|
|
2774
|
+
# @note When making an API call, you may pass DeleteThesaurusRequest
|
2775
|
+
# data as a hash:
|
2776
|
+
#
|
2777
|
+
# {
|
2778
|
+
# id: "ThesaurusId", # required
|
2779
|
+
# index_id: "IndexId", # required
|
2780
|
+
# }
|
2781
|
+
#
|
2782
|
+
# @!attribute [rw] id
|
2783
|
+
# The identifier of the thesaurus to delete.
|
2784
|
+
# @return [String]
|
2785
|
+
#
|
2786
|
+
# @!attribute [rw] index_id
|
2787
|
+
# The identifier of the index associated with the thesaurus to delete.
|
2788
|
+
# @return [String]
|
2789
|
+
#
|
2790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurusRequest AWS API Documentation
|
2791
|
+
#
|
2792
|
+
class DeleteThesaurusRequest < Struct.new(
|
2793
|
+
:id,
|
2794
|
+
:index_id)
|
2795
|
+
SENSITIVE = []
|
2796
|
+
include Aws::Structure
|
2797
|
+
end
|
2798
|
+
|
2605
2799
|
# @note When making an API call, you may pass DescribeDataSourceRequest
|
2606
2800
|
# data as a hash:
|
2607
2801
|
#
|
@@ -2816,7 +3010,7 @@ module Aws::Kendra
|
|
2816
3010
|
# @return [String]
|
2817
3011
|
#
|
2818
3012
|
# @!attribute [rw] id
|
2819
|
-
#
|
3013
|
+
# The name of the index.
|
2820
3014
|
# @return [String]
|
2821
3015
|
#
|
2822
3016
|
# @!attribute [rw] edition
|
@@ -2875,6 +3069,14 @@ module Aws::Kendra
|
|
2875
3069
|
# capacity for the index.
|
2876
3070
|
# @return [Types::CapacityUnitsConfiguration]
|
2877
3071
|
#
|
3072
|
+
# @!attribute [rw] user_token_configurations
|
3073
|
+
# The user token configuration for the Amazon Kendra index.
|
3074
|
+
# @return [Array<Types::UserTokenConfiguration>]
|
3075
|
+
#
|
3076
|
+
# @!attribute [rw] user_context_policy
|
3077
|
+
# The user context policy for the Amazon Kendra index.
|
3078
|
+
# @return [String]
|
3079
|
+
#
|
2878
3080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
|
2879
3081
|
#
|
2880
3082
|
class DescribeIndexResponse < Struct.new(
|
@@ -2890,7 +3092,118 @@ module Aws::Kendra
|
|
2890
3092
|
:document_metadata_configurations,
|
2891
3093
|
:index_statistics,
|
2892
3094
|
:error_message,
|
2893
|
-
:capacity_units
|
3095
|
+
:capacity_units,
|
3096
|
+
:user_token_configurations,
|
3097
|
+
:user_context_policy)
|
3098
|
+
SENSITIVE = []
|
3099
|
+
include Aws::Structure
|
3100
|
+
end
|
3101
|
+
|
3102
|
+
# @note When making an API call, you may pass DescribeThesaurusRequest
|
3103
|
+
# data as a hash:
|
3104
|
+
#
|
3105
|
+
# {
|
3106
|
+
# id: "ThesaurusId", # required
|
3107
|
+
# index_id: "IndexId", # required
|
3108
|
+
# }
|
3109
|
+
#
|
3110
|
+
# @!attribute [rw] id
|
3111
|
+
# The identifier of the thesaurus to describe.
|
3112
|
+
# @return [String]
|
3113
|
+
#
|
3114
|
+
# @!attribute [rw] index_id
|
3115
|
+
# The identifier of the index associated with the thesaurus to
|
3116
|
+
# describe.
|
3117
|
+
# @return [String]
|
3118
|
+
#
|
3119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
|
3120
|
+
#
|
3121
|
+
class DescribeThesaurusRequest < Struct.new(
|
3122
|
+
:id,
|
3123
|
+
:index_id)
|
3124
|
+
SENSITIVE = []
|
3125
|
+
include Aws::Structure
|
3126
|
+
end
|
3127
|
+
|
3128
|
+
# @!attribute [rw] id
|
3129
|
+
# The identifier of the thesaurus.
|
3130
|
+
# @return [String]
|
3131
|
+
#
|
3132
|
+
# @!attribute [rw] index_id
|
3133
|
+
# The identifier of the index associated with the thesaurus to
|
3134
|
+
# describe.
|
3135
|
+
# @return [String]
|
3136
|
+
#
|
3137
|
+
# @!attribute [rw] name
|
3138
|
+
# The thesaurus name.
|
3139
|
+
# @return [String]
|
3140
|
+
#
|
3141
|
+
# @!attribute [rw] description
|
3142
|
+
# The thesaurus description.
|
3143
|
+
# @return [String]
|
3144
|
+
#
|
3145
|
+
# @!attribute [rw] status
|
3146
|
+
# The current status of the thesaurus. When the value is `ACTIVE`,
|
3147
|
+
# queries are able to use the thesaurus. If the `Status` field value
|
3148
|
+
# is `FAILED`, the `ErrorMessage` field provides more information.
|
3149
|
+
#
|
3150
|
+
# If the status is `ACTIVE_BUT_UPDATE_FAILED`, it means that Amazon
|
3151
|
+
# Kendra could not ingest the new thesaurus file. The old thesaurus
|
3152
|
+
# file is still active.
|
3153
|
+
# @return [String]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] error_message
|
3156
|
+
# When the `Status` field value is `FAILED`, the `ErrorMessage` field
|
3157
|
+
# provides more information.
|
3158
|
+
# @return [String]
|
3159
|
+
#
|
3160
|
+
# @!attribute [rw] created_at
|
3161
|
+
# The Unix datetime that the thesaurus was created.
|
3162
|
+
# @return [Time]
|
3163
|
+
#
|
3164
|
+
# @!attribute [rw] updated_at
|
3165
|
+
# The Unix datetime that the thesaurus was last updated.
|
3166
|
+
# @return [Time]
|
3167
|
+
#
|
3168
|
+
# @!attribute [rw] role_arn
|
3169
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
3170
|
+
# Kendra permissions to access thesaurus file specified in
|
3171
|
+
# `SourceS3Path`.
|
3172
|
+
# @return [String]
|
3173
|
+
#
|
3174
|
+
# @!attribute [rw] source_s3_path
|
3175
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
3176
|
+
# @return [Types::S3Path]
|
3177
|
+
#
|
3178
|
+
# @!attribute [rw] file_size_bytes
|
3179
|
+
# The size of the thesaurus file in bytes.
|
3180
|
+
# @return [Integer]
|
3181
|
+
#
|
3182
|
+
# @!attribute [rw] term_count
|
3183
|
+
# The number of unique terms in the thesaurus file. For example, the
|
3184
|
+
# synonyms `a,b,c` and `a=>d`, the term count would be 4.
|
3185
|
+
# @return [Integer]
|
3186
|
+
#
|
3187
|
+
# @!attribute [rw] synonym_rule_count
|
3188
|
+
# The number of synonym rules in the thesaurus file.
|
3189
|
+
# @return [Integer]
|
3190
|
+
#
|
3191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusResponse AWS API Documentation
|
3192
|
+
#
|
3193
|
+
class DescribeThesaurusResponse < Struct.new(
|
3194
|
+
:id,
|
3195
|
+
:index_id,
|
3196
|
+
:name,
|
3197
|
+
:description,
|
3198
|
+
:status,
|
3199
|
+
:error_message,
|
3200
|
+
:created_at,
|
3201
|
+
:updated_at,
|
3202
|
+
:role_arn,
|
3203
|
+
:source_s3_path,
|
3204
|
+
:file_size_bytes,
|
3205
|
+
:term_count,
|
3206
|
+
:synonym_rule_count)
|
2894
3207
|
SENSITIVE = []
|
2895
3208
|
include Aws::Structure
|
2896
3209
|
end
|
@@ -3259,6 +3572,103 @@ module Aws::Kendra
|
|
3259
3572
|
include Aws::Structure
|
3260
3573
|
end
|
3261
3574
|
|
3575
|
+
# Provides configuration information for data sources that connect to
|
3576
|
+
# Google Drive.
|
3577
|
+
#
|
3578
|
+
# @note When making an API call, you may pass GoogleDriveConfiguration
|
3579
|
+
# data as a hash:
|
3580
|
+
#
|
3581
|
+
# {
|
3582
|
+
# secret_arn: "SecretArn", # required
|
3583
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3584
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3585
|
+
# field_mappings: [
|
3586
|
+
# {
|
3587
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3588
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3589
|
+
# index_field_name: "IndexFieldName", # required
|
3590
|
+
# },
|
3591
|
+
# ],
|
3592
|
+
# exclude_mime_types: ["MimeType"],
|
3593
|
+
# exclude_user_accounts: ["UserAccount"],
|
3594
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
3595
|
+
# }
|
3596
|
+
#
|
3597
|
+
# @!attribute [rw] secret_arn
|
3598
|
+
# The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that
|
3599
|
+
# contains the credentials required to connect to Google Drive. For
|
3600
|
+
# more information, see [Using a Google Workspace Drive data
|
3601
|
+
# source][1].
|
3602
|
+
#
|
3603
|
+
#
|
3604
|
+
#
|
3605
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html
|
3606
|
+
# @return [String]
|
3607
|
+
#
|
3608
|
+
# @!attribute [rw] inclusion_patterns
|
3609
|
+
# A list of regular expression patterns that apply to path on Google
|
3610
|
+
# Drive. Items that match the pattern are included in the index from
|
3611
|
+
# both shared drives and users' My Drives. Items that don't match
|
3612
|
+
# the pattern are excluded from the index. If an item matches both an
|
3613
|
+
# inclusion pattern and an exclusion pattern, it is excluded from the
|
3614
|
+
# index.
|
3615
|
+
# @return [Array<String>]
|
3616
|
+
#
|
3617
|
+
# @!attribute [rw] exclusion_patterns
|
3618
|
+
# A list of regular expression patterns that apply to the path on
|
3619
|
+
# Google Drive. Items that match the pattern are excluded from the
|
3620
|
+
# index from both shared drives and users' My Drives. Items that
|
3621
|
+
# don't match the pattern are included in the index. If an item
|
3622
|
+
# matches both an exclusion pattern and an inclusion pattern, it is
|
3623
|
+
# excluded from the index.
|
3624
|
+
# @return [Array<String>]
|
3625
|
+
#
|
3626
|
+
# @!attribute [rw] field_mappings
|
3627
|
+
# Defines mapping between a field in the Google Drive and a Amazon
|
3628
|
+
# Kendra index field.
|
3629
|
+
#
|
3630
|
+
# If you are using the console, you can define index fields when
|
3631
|
+
# creating the mapping. If you are using the API, you must first
|
3632
|
+
# create the field using the UpdateIndex operation.
|
3633
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3634
|
+
#
|
3635
|
+
# @!attribute [rw] exclude_mime_types
|
3636
|
+
# A list of MIME types to exclude from the index. All documents
|
3637
|
+
# matching the specified MIME type are excluded.
|
3638
|
+
#
|
3639
|
+
# For a list of MIME types, see [Using a Google Workspace Drive data
|
3640
|
+
# source][1].
|
3641
|
+
#
|
3642
|
+
#
|
3643
|
+
#
|
3644
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html
|
3645
|
+
# @return [Array<String>]
|
3646
|
+
#
|
3647
|
+
# @!attribute [rw] exclude_user_accounts
|
3648
|
+
# A list of email addresses of the users. Documents owned by these
|
3649
|
+
# users are excluded from the index. Documents shared with excluded
|
3650
|
+
# users are indexed unless they are excluded in another way.
|
3651
|
+
# @return [Array<String>]
|
3652
|
+
#
|
3653
|
+
# @!attribute [rw] exclude_shared_drives
|
3654
|
+
# A list of identifiers or shared drives to exclude from the index.
|
3655
|
+
# All files and folders stored on the shared drive are excluded.
|
3656
|
+
# @return [Array<String>]
|
3657
|
+
#
|
3658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GoogleDriveConfiguration AWS API Documentation
|
3659
|
+
#
|
3660
|
+
class GoogleDriveConfiguration < Struct.new(
|
3661
|
+
:secret_arn,
|
3662
|
+
:inclusion_patterns,
|
3663
|
+
:exclusion_patterns,
|
3664
|
+
:field_mappings,
|
3665
|
+
:exclude_mime_types,
|
3666
|
+
:exclude_user_accounts,
|
3667
|
+
:exclude_shared_drives)
|
3668
|
+
SENSITIVE = []
|
3669
|
+
include Aws::Structure
|
3670
|
+
end
|
3671
|
+
|
3262
3672
|
# Provides information that you can use to highlight a search result so
|
3263
3673
|
# that your users can quickly identify terms in the response.
|
3264
3674
|
#
|
@@ -3277,12 +3687,17 @@ module Aws::Kendra
|
|
3277
3687
|
# the best response; otherwise, false.
|
3278
3688
|
# @return [Boolean]
|
3279
3689
|
#
|
3690
|
+
# @!attribute [rw] type
|
3691
|
+
# The highlight type.
|
3692
|
+
# @return [String]
|
3693
|
+
#
|
3280
3694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Highlight AWS API Documentation
|
3281
3695
|
#
|
3282
3696
|
class Highlight < Struct.new(
|
3283
3697
|
:begin_offset,
|
3284
3698
|
:end_offset,
|
3285
|
-
:top_answer
|
3699
|
+
:top_answer,
|
3700
|
+
:type)
|
3286
3701
|
SENSITIVE = []
|
3287
3702
|
include Aws::Structure
|
3288
3703
|
end
|
@@ -3362,6 +3777,90 @@ module Aws::Kendra
|
|
3362
3777
|
include Aws::Structure
|
3363
3778
|
end
|
3364
3779
|
|
3780
|
+
# Configuration information for the JSON token type.
|
3781
|
+
#
|
3782
|
+
# @note When making an API call, you may pass JsonTokenTypeConfiguration
|
3783
|
+
# data as a hash:
|
3784
|
+
#
|
3785
|
+
# {
|
3786
|
+
# user_name_attribute_field: "String", # required
|
3787
|
+
# group_attribute_field: "String", # required
|
3788
|
+
# }
|
3789
|
+
#
|
3790
|
+
# @!attribute [rw] user_name_attribute_field
|
3791
|
+
# The user name attribute field.
|
3792
|
+
# @return [String]
|
3793
|
+
#
|
3794
|
+
# @!attribute [rw] group_attribute_field
|
3795
|
+
# The group attribute field.
|
3796
|
+
# @return [String]
|
3797
|
+
#
|
3798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/JsonTokenTypeConfiguration AWS API Documentation
|
3799
|
+
#
|
3800
|
+
class JsonTokenTypeConfiguration < Struct.new(
|
3801
|
+
:user_name_attribute_field,
|
3802
|
+
:group_attribute_field)
|
3803
|
+
SENSITIVE = []
|
3804
|
+
include Aws::Structure
|
3805
|
+
end
|
3806
|
+
|
3807
|
+
# Configuration information for the JWT token type.
|
3808
|
+
#
|
3809
|
+
# @note When making an API call, you may pass JwtTokenTypeConfiguration
|
3810
|
+
# data as a hash:
|
3811
|
+
#
|
3812
|
+
# {
|
3813
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
3814
|
+
# url: "Url",
|
3815
|
+
# secret_manager_arn: "RoleArn",
|
3816
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
3817
|
+
# group_attribute_field: "GroupAttributeField",
|
3818
|
+
# issuer: "Issuer",
|
3819
|
+
# claim_regex: "ClaimRegex",
|
3820
|
+
# }
|
3821
|
+
#
|
3822
|
+
# @!attribute [rw] key_location
|
3823
|
+
# The location of the key.
|
3824
|
+
# @return [String]
|
3825
|
+
#
|
3826
|
+
# @!attribute [rw] url
|
3827
|
+
# The signing key URL.
|
3828
|
+
# @return [String]
|
3829
|
+
#
|
3830
|
+
# @!attribute [rw] secret_manager_arn
|
3831
|
+
# The Amazon Resource Name (arn) of the secret.
|
3832
|
+
# @return [String]
|
3833
|
+
#
|
3834
|
+
# @!attribute [rw] user_name_attribute_field
|
3835
|
+
# The user name attribute field.
|
3836
|
+
# @return [String]
|
3837
|
+
#
|
3838
|
+
# @!attribute [rw] group_attribute_field
|
3839
|
+
# The group attribute field.
|
3840
|
+
# @return [String]
|
3841
|
+
#
|
3842
|
+
# @!attribute [rw] issuer
|
3843
|
+
# The issuer of the token.
|
3844
|
+
# @return [String]
|
3845
|
+
#
|
3846
|
+
# @!attribute [rw] claim_regex
|
3847
|
+
# The regular expression that identifies the claim.
|
3848
|
+
# @return [String]
|
3849
|
+
#
|
3850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/JwtTokenTypeConfiguration AWS API Documentation
|
3851
|
+
#
|
3852
|
+
class JwtTokenTypeConfiguration < Struct.new(
|
3853
|
+
:key_location,
|
3854
|
+
:url,
|
3855
|
+
:secret_manager_arn,
|
3856
|
+
:user_name_attribute_field,
|
3857
|
+
:group_attribute_field,
|
3858
|
+
:issuer,
|
3859
|
+
:claim_regex)
|
3860
|
+
SENSITIVE = []
|
3861
|
+
include Aws::Structure
|
3862
|
+
end
|
3863
|
+
|
3365
3864
|
# @note When making an API call, you may pass ListDataSourceSyncJobsRequest
|
3366
3865
|
# data as a hash:
|
3367
3866
|
#
|
@@ -3629,6 +4128,59 @@ module Aws::Kendra
|
|
3629
4128
|
include Aws::Structure
|
3630
4129
|
end
|
3631
4130
|
|
4131
|
+
# @note When making an API call, you may pass ListThesauriRequest
|
4132
|
+
# data as a hash:
|
4133
|
+
#
|
4134
|
+
# {
|
4135
|
+
# index_id: "IndexId", # required
|
4136
|
+
# next_token: "NextToken",
|
4137
|
+
# max_results: 1,
|
4138
|
+
# }
|
4139
|
+
#
|
4140
|
+
# @!attribute [rw] index_id
|
4141
|
+
# The identifier of the index associated with the thesaurus to list.
|
4142
|
+
# @return [String]
|
4143
|
+
#
|
4144
|
+
# @!attribute [rw] next_token
|
4145
|
+
# If the previous response was incomplete (because there is more data
|
4146
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
4147
|
+
# response. You can use this pagination token to retrieve the next set
|
4148
|
+
# of thesauri (`ThesaurusSummaryItems`).
|
4149
|
+
# @return [String]
|
4150
|
+
#
|
4151
|
+
# @!attribute [rw] max_results
|
4152
|
+
# The maximum number of thesauri to return.
|
4153
|
+
# @return [Integer]
|
4154
|
+
#
|
4155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriRequest AWS API Documentation
|
4156
|
+
#
|
4157
|
+
class ListThesauriRequest < Struct.new(
|
4158
|
+
:index_id,
|
4159
|
+
:next_token,
|
4160
|
+
:max_results)
|
4161
|
+
SENSITIVE = []
|
4162
|
+
include Aws::Structure
|
4163
|
+
end
|
4164
|
+
|
4165
|
+
# @!attribute [rw] next_token
|
4166
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
4167
|
+
# you can use in the subsequent request to retrieve the next set of
|
4168
|
+
# thesauri.
|
4169
|
+
# @return [String]
|
4170
|
+
#
|
4171
|
+
# @!attribute [rw] thesaurus_summary_items
|
4172
|
+
# An array of summary information for one or more thesauruses.
|
4173
|
+
# @return [Array<Types::ThesaurusSummary>]
|
4174
|
+
#
|
4175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriResponse AWS API Documentation
|
4176
|
+
#
|
4177
|
+
class ListThesauriResponse < Struct.new(
|
4178
|
+
:next_token,
|
4179
|
+
:thesaurus_summary_items)
|
4180
|
+
SENSITIVE = []
|
4181
|
+
include Aws::Structure
|
4182
|
+
end
|
4183
|
+
|
3632
4184
|
# Provides configuration information for data sources that connect to
|
3633
4185
|
# OneDrive.
|
3634
4186
|
#
|
@@ -3654,10 +4206,11 @@ module Aws::Kendra
|
|
3654
4206
|
# index_field_name: "IndexFieldName", # required
|
3655
4207
|
# },
|
3656
4208
|
# ],
|
4209
|
+
# disable_local_groups: false,
|
3657
4210
|
# }
|
3658
4211
|
#
|
3659
4212
|
# @!attribute [rw] tenant_domain
|
3660
|
-
#
|
4213
|
+
# The Azure Active Directory domain of the organization.
|
3661
4214
|
# @return [String]
|
3662
4215
|
#
|
3663
4216
|
# @!attribute [rw] secret_arn
|
@@ -3696,6 +4249,11 @@ module Aws::Kendra
|
|
3696
4249
|
# must first create the index fields before you map OneDrive fields.
|
3697
4250
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3698
4251
|
#
|
4252
|
+
# @!attribute [rw] disable_local_groups
|
4253
|
+
# A Boolean value that specifies whether local groups are disabled
|
4254
|
+
# (`True`) or enabled (`False`).
|
4255
|
+
# @return [Boolean]
|
4256
|
+
#
|
3699
4257
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveConfiguration AWS API Documentation
|
3700
4258
|
#
|
3701
4259
|
class OneDriveConfiguration < Struct.new(
|
@@ -3704,7 +4262,8 @@ module Aws::Kendra
|
|
3704
4262
|
:one_drive_users,
|
3705
4263
|
:inclusion_patterns,
|
3706
4264
|
:exclusion_patterns,
|
3707
|
-
:field_mappings
|
4265
|
+
:field_mappings,
|
4266
|
+
:disable_local_groups)
|
3708
4267
|
SENSITIVE = []
|
3709
4268
|
include Aws::Structure
|
3710
4269
|
end
|
@@ -3874,6 +4433,10 @@ module Aws::Kendra
|
|
3874
4433
|
# document_attribute_key: "DocumentAttributeKey", # required
|
3875
4434
|
# sort_order: "DESC", # required, accepts DESC, ASC
|
3876
4435
|
# },
|
4436
|
+
# user_context: {
|
4437
|
+
# token: "Token",
|
4438
|
+
# },
|
4439
|
+
# visitor_id: "VisitorId",
|
3877
4440
|
# }
|
3878
4441
|
#
|
3879
4442
|
# @!attribute [rw] index_id
|
@@ -3937,6 +4500,17 @@ module Aws::Kendra
|
|
3937
4500
|
# by the relevance that Amazon Kendra determines for the result.
|
3938
4501
|
# @return [Types::SortingConfiguration]
|
3939
4502
|
#
|
4503
|
+
# @!attribute [rw] user_context
|
4504
|
+
# The user context token.
|
4505
|
+
# @return [Types::UserContext]
|
4506
|
+
#
|
4507
|
+
# @!attribute [rw] visitor_id
|
4508
|
+
# Provides an identifier for a specific user. The `VisitorId` should
|
4509
|
+
# be a unique identifier, such as a GUID. Don't use personally
|
4510
|
+
# identifiable information, such as the user's email address, as the
|
4511
|
+
# `VisitorId`.
|
4512
|
+
# @return [String]
|
4513
|
+
#
|
3940
4514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
3941
4515
|
#
|
3942
4516
|
class QueryRequest < Struct.new(
|
@@ -3948,7 +4522,9 @@ module Aws::Kendra
|
|
3948
4522
|
:query_result_type_filter,
|
3949
4523
|
:page_number,
|
3950
4524
|
:page_size,
|
3951
|
-
:sorting_configuration
|
4525
|
+
:sorting_configuration,
|
4526
|
+
:user_context,
|
4527
|
+
:visitor_id)
|
3952
4528
|
SENSITIVE = []
|
3953
4529
|
include Aws::Structure
|
3954
4530
|
end
|
@@ -4040,6 +4616,16 @@ module Aws::Kendra
|
|
4040
4616
|
# matches the query.
|
4041
4617
|
# @return [Types::ScoreAttributes]
|
4042
4618
|
#
|
4619
|
+
# @!attribute [rw] feedback_token
|
4620
|
+
# A token that identifies a particular result from a particular query.
|
4621
|
+
# Use this token to provide click-through feedback for the result. For
|
4622
|
+
# more information, see [ Submitting feedback ][1].
|
4623
|
+
#
|
4624
|
+
#
|
4625
|
+
#
|
4626
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html
|
4627
|
+
# @return [String]
|
4628
|
+
#
|
4043
4629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
|
4044
4630
|
#
|
4045
4631
|
class QueryResultItem < Struct.new(
|
@@ -4051,7 +4637,8 @@ module Aws::Kendra
|
|
4051
4637
|
:document_excerpt,
|
4052
4638
|
:document_uri,
|
4053
4639
|
:document_attributes,
|
4054
|
-
:score_attributes
|
4640
|
+
:score_attributes,
|
4641
|
+
:feedback_token)
|
4055
4642
|
SENSITIVE = []
|
4056
4643
|
include Aws::Structure
|
4057
4644
|
end
|
@@ -4276,7 +4863,12 @@ module Aws::Kendra
|
|
4276
4863
|
#
|
4277
4864
|
# @!attribute [rw] access_control_list_configuration
|
4278
4865
|
# Provides the path to the S3 bucket that contains the user context
|
4279
|
-
# filtering files for the data source.
|
4866
|
+
# filtering files for the data source. For the format of the file, see
|
4867
|
+
# [Access control for S3 data sources][1].
|
4868
|
+
#
|
4869
|
+
#
|
4870
|
+
#
|
4871
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html
|
4280
4872
|
# @return [Types::AccessControlListConfiguration]
|
4281
4873
|
#
|
4282
4874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3DataSourceConfiguration AWS API Documentation
|
@@ -5116,6 +5708,7 @@ module Aws::Kendra
|
|
5116
5708
|
# },
|
5117
5709
|
# ],
|
5118
5710
|
# document_title_field_name: "DataSourceFieldName",
|
5711
|
+
# disable_local_groups: false,
|
5119
5712
|
# }
|
5120
5713
|
#
|
5121
5714
|
# @!attribute [rw] share_point_version
|
@@ -5196,6 +5789,11 @@ module Aws::Kendra
|
|
5196
5789
|
# the document.
|
5197
5790
|
# @return [String]
|
5198
5791
|
#
|
5792
|
+
# @!attribute [rw] disable_local_groups
|
5793
|
+
# A Boolean value that specifies whether local groups are disabled
|
5794
|
+
# (`True`) or enabled (`False`).
|
5795
|
+
# @return [Boolean]
|
5796
|
+
#
|
5199
5797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
|
5200
5798
|
#
|
5201
5799
|
class SharePointConfiguration < Struct.new(
|
@@ -5208,7 +5806,8 @@ module Aws::Kendra
|
|
5208
5806
|
:exclusion_patterns,
|
5209
5807
|
:vpc_configuration,
|
5210
5808
|
:field_mappings,
|
5211
|
-
:document_title_field_name
|
5809
|
+
:document_title_field_name,
|
5810
|
+
:disable_local_groups)
|
5212
5811
|
SENSITIVE = []
|
5213
5812
|
include Aws::Structure
|
5214
5813
|
end
|
@@ -5526,6 +6125,40 @@ module Aws::Kendra
|
|
5526
6125
|
include Aws::Structure
|
5527
6126
|
end
|
5528
6127
|
|
6128
|
+
# An array of summary information for one or more thesauruses.
|
6129
|
+
#
|
6130
|
+
# @!attribute [rw] id
|
6131
|
+
# The identifier of the thesaurus.
|
6132
|
+
# @return [String]
|
6133
|
+
#
|
6134
|
+
# @!attribute [rw] name
|
6135
|
+
# The name of the thesaurus.
|
6136
|
+
# @return [String]
|
6137
|
+
#
|
6138
|
+
# @!attribute [rw] status
|
6139
|
+
# The status of the thesaurus.
|
6140
|
+
# @return [String]
|
6141
|
+
#
|
6142
|
+
# @!attribute [rw] created_at
|
6143
|
+
# The Unix datetime that the thesaurus was created.
|
6144
|
+
# @return [Time]
|
6145
|
+
#
|
6146
|
+
# @!attribute [rw] updated_at
|
6147
|
+
# The Unix datetime that the thesaurus was last updated.
|
6148
|
+
# @return [Time]
|
6149
|
+
#
|
6150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ThesaurusSummary AWS API Documentation
|
6151
|
+
#
|
6152
|
+
class ThesaurusSummary < Struct.new(
|
6153
|
+
:id,
|
6154
|
+
:name,
|
6155
|
+
:status,
|
6156
|
+
:created_at,
|
6157
|
+
:updated_at)
|
6158
|
+
SENSITIVE = []
|
6159
|
+
include Aws::Structure
|
6160
|
+
end
|
6161
|
+
|
5529
6162
|
# @!attribute [rw] message
|
5530
6163
|
# @return [String]
|
5531
6164
|
#
|
@@ -5635,6 +6268,7 @@ module Aws::Kendra
|
|
5635
6268
|
# },
|
5636
6269
|
# ],
|
5637
6270
|
# document_title_field_name: "DataSourceFieldName",
|
6271
|
+
# disable_local_groups: false,
|
5638
6272
|
# },
|
5639
6273
|
# database_configuration: {
|
5640
6274
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -5759,6 +6393,7 @@ module Aws::Kendra
|
|
5759
6393
|
# index_field_name: "IndexFieldName", # required
|
5760
6394
|
# },
|
5761
6395
|
# ],
|
6396
|
+
# disable_local_groups: false,
|
5762
6397
|
# },
|
5763
6398
|
# service_now_configuration: {
|
5764
6399
|
# host_url: "ServiceNowHostUrl", # required
|
@@ -5796,7 +6431,7 @@ module Aws::Kendra
|
|
5796
6431
|
# confluence_configuration: {
|
5797
6432
|
# server_url: "Url", # required
|
5798
6433
|
# secret_arn: "SecretArn", # required
|
5799
|
-
# version: "
|
6434
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
5800
6435
|
# space_configuration: {
|
5801
6436
|
# crawl_personal_spaces: false,
|
5802
6437
|
# crawl_archived_spaces: false,
|
@@ -5845,6 +6480,21 @@ module Aws::Kendra
|
|
5845
6480
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5846
6481
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5847
6482
|
# },
|
6483
|
+
# google_drive_configuration: {
|
6484
|
+
# secret_arn: "SecretArn", # required
|
6485
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
6486
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
6487
|
+
# field_mappings: [
|
6488
|
+
# {
|
6489
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
6490
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
6491
|
+
# index_field_name: "IndexFieldName", # required
|
6492
|
+
# },
|
6493
|
+
# ],
|
6494
|
+
# exclude_mime_types: ["MimeType"],
|
6495
|
+
# exclude_user_accounts: ["UserAccount"],
|
6496
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
6497
|
+
# },
|
5848
6498
|
# },
|
5849
6499
|
# description: "Description",
|
5850
6500
|
# schedule: "ScanSchedule",
|
@@ -5929,6 +6579,24 @@ module Aws::Kendra
|
|
5929
6579
|
# storage_capacity_units: 1, # required
|
5930
6580
|
# query_capacity_units: 1, # required
|
5931
6581
|
# },
|
6582
|
+
# user_token_configurations: [
|
6583
|
+
# {
|
6584
|
+
# jwt_token_type_configuration: {
|
6585
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
6586
|
+
# url: "Url",
|
6587
|
+
# secret_manager_arn: "RoleArn",
|
6588
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
6589
|
+
# group_attribute_field: "GroupAttributeField",
|
6590
|
+
# issuer: "Issuer",
|
6591
|
+
# claim_regex: "ClaimRegex",
|
6592
|
+
# },
|
6593
|
+
# json_token_type_configuration: {
|
6594
|
+
# user_name_attribute_field: "String", # required
|
6595
|
+
# group_attribute_field: "String", # required
|
6596
|
+
# },
|
6597
|
+
# },
|
6598
|
+
# ],
|
6599
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
5932
6600
|
# }
|
5933
6601
|
#
|
5934
6602
|
# @!attribute [rw] id
|
@@ -5962,6 +6630,14 @@ module Aws::Kendra
|
|
5962
6630
|
# index.
|
5963
6631
|
# @return [Types::CapacityUnitsConfiguration]
|
5964
6632
|
#
|
6633
|
+
# @!attribute [rw] user_token_configurations
|
6634
|
+
# The user token configuration.
|
6635
|
+
# @return [Array<Types::UserTokenConfiguration>]
|
6636
|
+
#
|
6637
|
+
# @!attribute [rw] user_context_policy
|
6638
|
+
# The user user token context policy.
|
6639
|
+
# @return [String]
|
6640
|
+
#
|
5965
6641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndexRequest AWS API Documentation
|
5966
6642
|
#
|
5967
6643
|
class UpdateIndexRequest < Struct.new(
|
@@ -5970,7 +6646,120 @@ module Aws::Kendra
|
|
5970
6646
|
:role_arn,
|
5971
6647
|
:description,
|
5972
6648
|
:document_metadata_configuration_updates,
|
5973
|
-
:capacity_units
|
6649
|
+
:capacity_units,
|
6650
|
+
:user_token_configurations,
|
6651
|
+
:user_context_policy)
|
6652
|
+
SENSITIVE = []
|
6653
|
+
include Aws::Structure
|
6654
|
+
end
|
6655
|
+
|
6656
|
+
# @note When making an API call, you may pass UpdateThesaurusRequest
|
6657
|
+
# data as a hash:
|
6658
|
+
#
|
6659
|
+
# {
|
6660
|
+
# id: "ThesaurusId", # required
|
6661
|
+
# name: "ThesaurusName",
|
6662
|
+
# index_id: "IndexId", # required
|
6663
|
+
# description: "Description",
|
6664
|
+
# role_arn: "RoleArn",
|
6665
|
+
# source_s3_path: {
|
6666
|
+
# bucket: "S3BucketName", # required
|
6667
|
+
# key: "S3ObjectKey", # required
|
6668
|
+
# },
|
6669
|
+
# }
|
6670
|
+
#
|
6671
|
+
# @!attribute [rw] id
|
6672
|
+
# The identifier of the thesaurus to update.
|
6673
|
+
# @return [String]
|
6674
|
+
#
|
6675
|
+
# @!attribute [rw] name
|
6676
|
+
# The updated name of the thesaurus.
|
6677
|
+
# @return [String]
|
6678
|
+
#
|
6679
|
+
# @!attribute [rw] index_id
|
6680
|
+
# The identifier of the index associated with the thesaurus to update.
|
6681
|
+
# @return [String]
|
6682
|
+
#
|
6683
|
+
# @!attribute [rw] description
|
6684
|
+
# The updated description of the thesaurus.
|
6685
|
+
# @return [String]
|
6686
|
+
#
|
6687
|
+
# @!attribute [rw] role_arn
|
6688
|
+
# The updated role ARN of the thesaurus.
|
6689
|
+
# @return [String]
|
6690
|
+
#
|
6691
|
+
# @!attribute [rw] source_s3_path
|
6692
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
6693
|
+
# @return [Types::S3Path]
|
6694
|
+
#
|
6695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurusRequest AWS API Documentation
|
6696
|
+
#
|
6697
|
+
class UpdateThesaurusRequest < Struct.new(
|
6698
|
+
:id,
|
6699
|
+
:name,
|
6700
|
+
:index_id,
|
6701
|
+
:description,
|
6702
|
+
:role_arn,
|
6703
|
+
:source_s3_path)
|
6704
|
+
SENSITIVE = []
|
6705
|
+
include Aws::Structure
|
6706
|
+
end
|
6707
|
+
|
6708
|
+
# Provides information about the user context for a Amazon Kendra index.
|
6709
|
+
#
|
6710
|
+
# @note When making an API call, you may pass UserContext
|
6711
|
+
# data as a hash:
|
6712
|
+
#
|
6713
|
+
# {
|
6714
|
+
# token: "Token",
|
6715
|
+
# }
|
6716
|
+
#
|
6717
|
+
# @!attribute [rw] token
|
6718
|
+
# The user context token. It must be a JWT or a JSON token.
|
6719
|
+
# @return [String]
|
6720
|
+
#
|
6721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserContext AWS API Documentation
|
6722
|
+
#
|
6723
|
+
class UserContext < Struct.new(
|
6724
|
+
:token)
|
6725
|
+
SENSITIVE = []
|
6726
|
+
include Aws::Structure
|
6727
|
+
end
|
6728
|
+
|
6729
|
+
# Provides configuration information for a token configuration.
|
6730
|
+
#
|
6731
|
+
# @note When making an API call, you may pass UserTokenConfiguration
|
6732
|
+
# data as a hash:
|
6733
|
+
#
|
6734
|
+
# {
|
6735
|
+
# jwt_token_type_configuration: {
|
6736
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
6737
|
+
# url: "Url",
|
6738
|
+
# secret_manager_arn: "RoleArn",
|
6739
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
6740
|
+
# group_attribute_field: "GroupAttributeField",
|
6741
|
+
# issuer: "Issuer",
|
6742
|
+
# claim_regex: "ClaimRegex",
|
6743
|
+
# },
|
6744
|
+
# json_token_type_configuration: {
|
6745
|
+
# user_name_attribute_field: "String", # required
|
6746
|
+
# group_attribute_field: "String", # required
|
6747
|
+
# },
|
6748
|
+
# }
|
6749
|
+
#
|
6750
|
+
# @!attribute [rw] jwt_token_type_configuration
|
6751
|
+
# Information about the JWT token type configuration.
|
6752
|
+
# @return [Types::JwtTokenTypeConfiguration]
|
6753
|
+
#
|
6754
|
+
# @!attribute [rw] json_token_type_configuration
|
6755
|
+
# Information about the JSON token type configuration.
|
6756
|
+
# @return [Types::JsonTokenTypeConfiguration]
|
6757
|
+
#
|
6758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserTokenConfiguration AWS API Documentation
|
6759
|
+
#
|
6760
|
+
class UserTokenConfiguration < Struct.new(
|
6761
|
+
:jwt_token_type_configuration,
|
6762
|
+
:json_token_type_configuration)
|
5974
6763
|
SENSITIVE = []
|
5975
6764
|
include Aws::Structure
|
5976
6765
|
end
|