aws-sdk-kendra 1.19.0 → 1.20.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/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +248 -1
- data/lib/aws-sdk-kendra/client_api.rb +146 -0
- data/lib/aws-sdk-kendra/types.rb +364 -2
- 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: 79f5cd534e7f42898247529121cbbf6405d2fbeed157733c2bd46bebaa47037e
|
4
|
+
data.tar.gz: 7844dc337245b7eb71dcdccb10651a6ed66af0276a8006240a22e27190402980
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2acf956bf5d708e4e1f681057049fa0b74a67de236fb08a25e858c4456f66125efb086cb9bcb669aedcd36e42b812f6a154a66abbe2a0acf80b8b9b83bcfef00
|
7
|
+
data.tar.gz: 90146acdc630dee44a92654af8d2068f2ea12e7ea15102666989e9895f7b059a49ff15cf7dea2f1fd0840703f24c3c85692c592ce4a80d569c86f91c330cef0e
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -1062,6 +1062,76 @@ module Aws::Kendra
|
|
1062
1062
|
req.send_request(options)
|
1063
1063
|
end
|
1064
1064
|
|
1065
|
+
# Creates a thesaurus for an index. The thesaurus contains a list of
|
1066
|
+
# synonyms in Solr format.
|
1067
|
+
#
|
1068
|
+
# @option params [required, String] :index_id
|
1069
|
+
# The unique identifier of the index for the new thesaurus.
|
1070
|
+
#
|
1071
|
+
# @option params [required, String] :name
|
1072
|
+
# The name for the new thesaurus.
|
1073
|
+
#
|
1074
|
+
# @option params [String] :description
|
1075
|
+
# The description for the new thesaurus.
|
1076
|
+
#
|
1077
|
+
# @option params [required, String] :role_arn
|
1078
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
1079
|
+
# Kendra permissions to access thesaurus file specified in
|
1080
|
+
# `SourceS3Path`.
|
1081
|
+
#
|
1082
|
+
# @option params [Array<Types::Tag>] :tags
|
1083
|
+
# A list of key-value pairs that identify the thesaurus. You can use the
|
1084
|
+
# tags to identify and organize your resources and to control access to
|
1085
|
+
# resources.
|
1086
|
+
#
|
1087
|
+
# @option params [required, Types::S3Path] :source_s3_path
|
1088
|
+
# The thesaurus file Amazon S3 source path.
|
1089
|
+
#
|
1090
|
+
# @option params [String] :client_token
|
1091
|
+
# A token that you provide to identify the request to create a
|
1092
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` operation with the
|
1093
|
+
# same client token will create only one index.
|
1094
|
+
#
|
1095
|
+
# **A suitable default value is auto-generated.** You should normally
|
1096
|
+
# not need to pass this option.**
|
1097
|
+
#
|
1098
|
+
# @return [Types::CreateThesaurusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1099
|
+
#
|
1100
|
+
# * {Types::CreateThesaurusResponse#id #id} => String
|
1101
|
+
#
|
1102
|
+
# @example Request syntax with placeholder values
|
1103
|
+
#
|
1104
|
+
# resp = client.create_thesaurus({
|
1105
|
+
# index_id: "IndexId", # required
|
1106
|
+
# name: "ThesaurusName", # required
|
1107
|
+
# description: "Description",
|
1108
|
+
# role_arn: "RoleArn", # required
|
1109
|
+
# tags: [
|
1110
|
+
# {
|
1111
|
+
# key: "TagKey", # required
|
1112
|
+
# value: "TagValue", # required
|
1113
|
+
# },
|
1114
|
+
# ],
|
1115
|
+
# source_s3_path: { # required
|
1116
|
+
# bucket: "S3BucketName", # required
|
1117
|
+
# key: "S3ObjectKey", # required
|
1118
|
+
# },
|
1119
|
+
# client_token: "ClientTokenName",
|
1120
|
+
# })
|
1121
|
+
#
|
1122
|
+
# @example Response structure
|
1123
|
+
#
|
1124
|
+
# resp.id #=> String
|
1125
|
+
#
|
1126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus AWS API Documentation
|
1127
|
+
#
|
1128
|
+
# @overload create_thesaurus(params = {})
|
1129
|
+
# @param [Hash] params ({})
|
1130
|
+
def create_thesaurus(params = {}, options = {})
|
1131
|
+
req = build_request(:create_thesaurus, params)
|
1132
|
+
req.send_request(options)
|
1133
|
+
end
|
1134
|
+
|
1065
1135
|
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
1066
1136
|
# the data source is already being deleted. While the data source is
|
1067
1137
|
# being deleted, the `Status` field returned by a call to the operation
|
@@ -1147,6 +1217,32 @@ module Aws::Kendra
|
|
1147
1217
|
req.send_request(options)
|
1148
1218
|
end
|
1149
1219
|
|
1220
|
+
# Deletes an existing Amazon Kendra thesaurus.
|
1221
|
+
#
|
1222
|
+
# @option params [required, String] :id
|
1223
|
+
# The identifier of the thesaurus to delete.
|
1224
|
+
#
|
1225
|
+
# @option params [required, String] :index_id
|
1226
|
+
# The identifier of the index associated with the thesaurus to delete.
|
1227
|
+
#
|
1228
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1229
|
+
#
|
1230
|
+
# @example Request syntax with placeholder values
|
1231
|
+
#
|
1232
|
+
# resp = client.delete_thesaurus({
|
1233
|
+
# id: "ThesaurusId", # required
|
1234
|
+
# index_id: "IndexId", # required
|
1235
|
+
# })
|
1236
|
+
#
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus AWS API Documentation
|
1238
|
+
#
|
1239
|
+
# @overload delete_thesaurus(params = {})
|
1240
|
+
# @param [Hash] params ({})
|
1241
|
+
def delete_thesaurus(params = {}, options = {})
|
1242
|
+
req = build_request(:delete_thesaurus, params)
|
1243
|
+
req.send_request(options)
|
1244
|
+
end
|
1245
|
+
|
1150
1246
|
# Gets information about a Amazon Kendra data source.
|
1151
1247
|
#
|
1152
1248
|
# @option params [required, String] :id
|
@@ -1516,6 +1612,63 @@ module Aws::Kendra
|
|
1516
1612
|
req.send_request(options)
|
1517
1613
|
end
|
1518
1614
|
|
1615
|
+
# Describes an existing Amazon Kendra thesaurus.
|
1616
|
+
#
|
1617
|
+
# @option params [required, String] :id
|
1618
|
+
# The identifier of the thesaurus to describe.
|
1619
|
+
#
|
1620
|
+
# @option params [required, String] :index_id
|
1621
|
+
# The identifier of the index associated with the thesaurus to describe.
|
1622
|
+
#
|
1623
|
+
# @return [Types::DescribeThesaurusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1624
|
+
#
|
1625
|
+
# * {Types::DescribeThesaurusResponse#id #id} => String
|
1626
|
+
# * {Types::DescribeThesaurusResponse#index_id #index_id} => String
|
1627
|
+
# * {Types::DescribeThesaurusResponse#name #name} => String
|
1628
|
+
# * {Types::DescribeThesaurusResponse#description #description} => String
|
1629
|
+
# * {Types::DescribeThesaurusResponse#status #status} => String
|
1630
|
+
# * {Types::DescribeThesaurusResponse#error_message #error_message} => String
|
1631
|
+
# * {Types::DescribeThesaurusResponse#created_at #created_at} => Time
|
1632
|
+
# * {Types::DescribeThesaurusResponse#updated_at #updated_at} => Time
|
1633
|
+
# * {Types::DescribeThesaurusResponse#role_arn #role_arn} => String
|
1634
|
+
# * {Types::DescribeThesaurusResponse#source_s3_path #source_s3_path} => Types::S3Path
|
1635
|
+
# * {Types::DescribeThesaurusResponse#file_size_bytes #file_size_bytes} => Integer
|
1636
|
+
# * {Types::DescribeThesaurusResponse#term_count #term_count} => Integer
|
1637
|
+
# * {Types::DescribeThesaurusResponse#synonym_rule_count #synonym_rule_count} => Integer
|
1638
|
+
#
|
1639
|
+
# @example Request syntax with placeholder values
|
1640
|
+
#
|
1641
|
+
# resp = client.describe_thesaurus({
|
1642
|
+
# id: "ThesaurusId", # required
|
1643
|
+
# index_id: "IndexId", # required
|
1644
|
+
# })
|
1645
|
+
#
|
1646
|
+
# @example Response structure
|
1647
|
+
#
|
1648
|
+
# resp.id #=> String
|
1649
|
+
# resp.index_id #=> String
|
1650
|
+
# resp.name #=> String
|
1651
|
+
# resp.description #=> String
|
1652
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
1653
|
+
# resp.error_message #=> String
|
1654
|
+
# resp.created_at #=> Time
|
1655
|
+
# resp.updated_at #=> Time
|
1656
|
+
# resp.role_arn #=> String
|
1657
|
+
# resp.source_s3_path.bucket #=> String
|
1658
|
+
# resp.source_s3_path.key #=> String
|
1659
|
+
# resp.file_size_bytes #=> Integer
|
1660
|
+
# resp.term_count #=> Integer
|
1661
|
+
# resp.synonym_rule_count #=> Integer
|
1662
|
+
#
|
1663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus AWS API Documentation
|
1664
|
+
#
|
1665
|
+
# @overload describe_thesaurus(params = {})
|
1666
|
+
# @param [Hash] params ({})
|
1667
|
+
def describe_thesaurus(params = {}, options = {})
|
1668
|
+
req = build_request(:describe_thesaurus, params)
|
1669
|
+
req.send_request(options)
|
1670
|
+
end
|
1671
|
+
|
1519
1672
|
# Gets statistics about synchronizing Amazon Kendra with a data source.
|
1520
1673
|
#
|
1521
1674
|
# @option params [required, String] :id
|
@@ -1761,6 +1914,52 @@ module Aws::Kendra
|
|
1761
1914
|
req.send_request(options)
|
1762
1915
|
end
|
1763
1916
|
|
1917
|
+
# Lists the Amazon Kendra thesauri associated with an index.
|
1918
|
+
#
|
1919
|
+
# @option params [required, String] :index_id
|
1920
|
+
# The identifier of the index associated with the thesaurus to list.
|
1921
|
+
#
|
1922
|
+
# @option params [String] :next_token
|
1923
|
+
# If the previous response was incomplete (because there is more data to
|
1924
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
1925
|
+
# You can use this pagination token to retrieve the next set of thesauri
|
1926
|
+
# (`ThesaurusSummaryItems`).
|
1927
|
+
#
|
1928
|
+
# @option params [Integer] :max_results
|
1929
|
+
# The maximum number of thesauri to return.
|
1930
|
+
#
|
1931
|
+
# @return [Types::ListThesauriResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1932
|
+
#
|
1933
|
+
# * {Types::ListThesauriResponse#next_token #next_token} => String
|
1934
|
+
# * {Types::ListThesauriResponse#thesaurus_summary_items #thesaurus_summary_items} => Array<Types::ThesaurusSummary>
|
1935
|
+
#
|
1936
|
+
# @example Request syntax with placeholder values
|
1937
|
+
#
|
1938
|
+
# resp = client.list_thesauri({
|
1939
|
+
# index_id: "IndexId", # required
|
1940
|
+
# next_token: "NextToken",
|
1941
|
+
# max_results: 1,
|
1942
|
+
# })
|
1943
|
+
#
|
1944
|
+
# @example Response structure
|
1945
|
+
#
|
1946
|
+
# resp.next_token #=> String
|
1947
|
+
# resp.thesaurus_summary_items #=> Array
|
1948
|
+
# resp.thesaurus_summary_items[0].id #=> String
|
1949
|
+
# resp.thesaurus_summary_items[0].name #=> String
|
1950
|
+
# resp.thesaurus_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
1951
|
+
# resp.thesaurus_summary_items[0].created_at #=> Time
|
1952
|
+
# resp.thesaurus_summary_items[0].updated_at #=> Time
|
1953
|
+
#
|
1954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri AWS API Documentation
|
1955
|
+
#
|
1956
|
+
# @overload list_thesauri(params = {})
|
1957
|
+
# @param [Hash] params ({})
|
1958
|
+
def list_thesauri(params = {}, options = {})
|
1959
|
+
req = build_request(:list_thesauri, params)
|
1960
|
+
req.send_request(options)
|
1961
|
+
end
|
1962
|
+
|
1764
1963
|
# Searches an active index. Use this API to search your documents using
|
1765
1964
|
# query. The `Query` operation enables to do faceted search and to
|
1766
1965
|
# filter results based on document attributes.
|
@@ -1966,17 +2165,20 @@ module Aws::Kendra
|
|
1966
2165
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].begin_offset #=> Integer
|
1967
2166
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].end_offset #=> Integer
|
1968
2167
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].top_answer #=> Boolean
|
2168
|
+
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
1969
2169
|
# resp.result_items[0].document_id #=> String
|
1970
2170
|
# resp.result_items[0].document_title.text #=> String
|
1971
2171
|
# resp.result_items[0].document_title.highlights #=> Array
|
1972
2172
|
# resp.result_items[0].document_title.highlights[0].begin_offset #=> Integer
|
1973
2173
|
# resp.result_items[0].document_title.highlights[0].end_offset #=> Integer
|
1974
2174
|
# resp.result_items[0].document_title.highlights[0].top_answer #=> Boolean
|
2175
|
+
# resp.result_items[0].document_title.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
1975
2176
|
# resp.result_items[0].document_excerpt.text #=> String
|
1976
2177
|
# resp.result_items[0].document_excerpt.highlights #=> Array
|
1977
2178
|
# resp.result_items[0].document_excerpt.highlights[0].begin_offset #=> Integer
|
1978
2179
|
# resp.result_items[0].document_excerpt.highlights[0].end_offset #=> Integer
|
1979
2180
|
# resp.result_items[0].document_excerpt.highlights[0].top_answer #=> Boolean
|
2181
|
+
# resp.result_items[0].document_excerpt.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
1980
2182
|
# resp.result_items[0].document_uri #=> String
|
1981
2183
|
# resp.result_items[0].document_attributes #=> Array
|
1982
2184
|
# resp.result_items[0].document_attributes[0].key #=> String
|
@@ -2585,6 +2787,51 @@ module Aws::Kendra
|
|
2585
2787
|
req.send_request(options)
|
2586
2788
|
end
|
2587
2789
|
|
2790
|
+
# Updates a thesaurus file associated with an index.
|
2791
|
+
#
|
2792
|
+
# @option params [required, String] :id
|
2793
|
+
# The identifier of the thesaurus to update.
|
2794
|
+
#
|
2795
|
+
# @option params [String] :name
|
2796
|
+
# The updated name of the thesaurus.
|
2797
|
+
#
|
2798
|
+
# @option params [required, String] :index_id
|
2799
|
+
# The identifier of the index associated with the thesaurus to update.
|
2800
|
+
#
|
2801
|
+
# @option params [String] :description
|
2802
|
+
# The updated description of the thesaurus.
|
2803
|
+
#
|
2804
|
+
# @option params [String] :role_arn
|
2805
|
+
# The updated role ARN of the thesaurus.
|
2806
|
+
#
|
2807
|
+
# @option params [Types::S3Path] :source_s3_path
|
2808
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
2809
|
+
#
|
2810
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2811
|
+
#
|
2812
|
+
# @example Request syntax with placeholder values
|
2813
|
+
#
|
2814
|
+
# resp = client.update_thesaurus({
|
2815
|
+
# id: "ThesaurusId", # required
|
2816
|
+
# name: "ThesaurusName",
|
2817
|
+
# index_id: "IndexId", # required
|
2818
|
+
# description: "Description",
|
2819
|
+
# role_arn: "RoleArn",
|
2820
|
+
# source_s3_path: {
|
2821
|
+
# bucket: "S3BucketName", # required
|
2822
|
+
# key: "S3ObjectKey", # required
|
2823
|
+
# },
|
2824
|
+
# })
|
2825
|
+
#
|
2826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus AWS API Documentation
|
2827
|
+
#
|
2828
|
+
# @overload update_thesaurus(params = {})
|
2829
|
+
# @param [Hash] params ({})
|
2830
|
+
def update_thesaurus(params = {}, options = {})
|
2831
|
+
req = build_request(:update_thesaurus, params)
|
2832
|
+
req.send_request(options)
|
2833
|
+
end
|
2834
|
+
|
2588
2835
|
# @!endgroup
|
2589
2836
|
|
2590
2837
|
# @param params ({})
|
@@ -2598,7 +2845,7 @@ module Aws::Kendra
|
|
2598
2845
|
params: params,
|
2599
2846
|
config: config)
|
2600
2847
|
context[:gem_name] = 'aws-sdk-kendra'
|
2601
|
-
context[:gem_version] = '1.
|
2848
|
+
context[:gem_version] = '1.20.0'
|
2602
2849
|
Seahorse::Client::Request.new(handlers, context)
|
2603
2850
|
end
|
2604
2851
|
|
@@ -70,6 +70,8 @@ module Aws::Kendra
|
|
70
70
|
CreateFaqResponse = Shapes::StructureShape.new(name: 'CreateFaqResponse')
|
71
71
|
CreateIndexRequest = Shapes::StructureShape.new(name: 'CreateIndexRequest')
|
72
72
|
CreateIndexResponse = Shapes::StructureShape.new(name: 'CreateIndexResponse')
|
73
|
+
CreateThesaurusRequest = Shapes::StructureShape.new(name: 'CreateThesaurusRequest')
|
74
|
+
CreateThesaurusResponse = Shapes::StructureShape.new(name: 'CreateThesaurusResponse')
|
73
75
|
DataSourceConfiguration = Shapes::StructureShape.new(name: 'DataSourceConfiguration')
|
74
76
|
DataSourceDateFieldFormat = Shapes::StringShape.new(name: 'DataSourceDateFieldFormat')
|
75
77
|
DataSourceFieldName = Shapes::StringShape.new(name: 'DataSourceFieldName')
|
@@ -98,12 +100,15 @@ module Aws::Kendra
|
|
98
100
|
DeleteDataSourceRequest = Shapes::StructureShape.new(name: 'DeleteDataSourceRequest')
|
99
101
|
DeleteFaqRequest = Shapes::StructureShape.new(name: 'DeleteFaqRequest')
|
100
102
|
DeleteIndexRequest = Shapes::StructureShape.new(name: 'DeleteIndexRequest')
|
103
|
+
DeleteThesaurusRequest = Shapes::StructureShape.new(name: 'DeleteThesaurusRequest')
|
101
104
|
DescribeDataSourceRequest = Shapes::StructureShape.new(name: 'DescribeDataSourceRequest')
|
102
105
|
DescribeDataSourceResponse = Shapes::StructureShape.new(name: 'DescribeDataSourceResponse')
|
103
106
|
DescribeFaqRequest = Shapes::StructureShape.new(name: 'DescribeFaqRequest')
|
104
107
|
DescribeFaqResponse = Shapes::StructureShape.new(name: 'DescribeFaqResponse')
|
105
108
|
DescribeIndexRequest = Shapes::StructureShape.new(name: 'DescribeIndexRequest')
|
106
109
|
DescribeIndexResponse = Shapes::StructureShape.new(name: 'DescribeIndexResponse')
|
110
|
+
DescribeThesaurusRequest = Shapes::StructureShape.new(name: 'DescribeThesaurusRequest')
|
111
|
+
DescribeThesaurusResponse = Shapes::StructureShape.new(name: 'DescribeThesaurusResponse')
|
107
112
|
Description = Shapes::StringShape.new(name: 'Description')
|
108
113
|
Document = Shapes::StructureShape.new(name: 'Document')
|
109
114
|
DocumentAttribute = Shapes::StructureShape.new(name: 'DocumentAttribute')
|
@@ -146,6 +151,7 @@ module Aws::Kendra
|
|
146
151
|
GroupAttributeField = Shapes::StringShape.new(name: 'GroupAttributeField')
|
147
152
|
Highlight = Shapes::StructureShape.new(name: 'Highlight')
|
148
153
|
HighlightList = Shapes::ListShape.new(name: 'HighlightList')
|
154
|
+
HighlightType = Shapes::StringShape.new(name: 'HighlightType')
|
149
155
|
Importance = Shapes::IntegerShape.new(name: 'Importance')
|
150
156
|
IndexConfigurationSummary = Shapes::StructureShape.new(name: 'IndexConfigurationSummary')
|
151
157
|
IndexConfigurationSummaryList = Shapes::ListShape.new(name: 'IndexConfigurationSummaryList')
|
@@ -175,11 +181,14 @@ module Aws::Kendra
|
|
175
181
|
ListIndicesResponse = Shapes::StructureShape.new(name: 'ListIndicesResponse')
|
176
182
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
177
183
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
184
|
+
ListThesauriRequest = Shapes::StructureShape.new(name: 'ListThesauriRequest')
|
185
|
+
ListThesauriResponse = Shapes::StructureShape.new(name: 'ListThesauriResponse')
|
178
186
|
Long = Shapes::IntegerShape.new(name: 'Long')
|
179
187
|
MaxResultsIntegerForListDataSourceSyncJobsRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListDataSourceSyncJobsRequest')
|
180
188
|
MaxResultsIntegerForListDataSourcesRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListDataSourcesRequest')
|
181
189
|
MaxResultsIntegerForListFaqsRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListFaqsRequest')
|
182
190
|
MaxResultsIntegerForListIndicesRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListIndicesRequest')
|
191
|
+
MaxResultsIntegerForListThesauriRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListThesauriRequest')
|
183
192
|
MetricValue = Shapes::StringShape.new(name: 'MetricValue')
|
184
193
|
MimeType = Shapes::StringShape.new(name: 'MimeType')
|
185
194
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
@@ -270,6 +279,11 @@ module Aws::Kendra
|
|
270
279
|
TenantDomain = Shapes::StringShape.new(name: 'TenantDomain')
|
271
280
|
TextDocumentStatistics = Shapes::StructureShape.new(name: 'TextDocumentStatistics')
|
272
281
|
TextWithHighlights = Shapes::StructureShape.new(name: 'TextWithHighlights')
|
282
|
+
ThesaurusId = Shapes::StringShape.new(name: 'ThesaurusId')
|
283
|
+
ThesaurusName = Shapes::StringShape.new(name: 'ThesaurusName')
|
284
|
+
ThesaurusStatus = Shapes::StringShape.new(name: 'ThesaurusStatus')
|
285
|
+
ThesaurusSummary = Shapes::StructureShape.new(name: 'ThesaurusSummary')
|
286
|
+
ThesaurusSummaryItems = Shapes::ListShape.new(name: 'ThesaurusSummaryItems')
|
273
287
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
274
288
|
TimeRange = Shapes::StructureShape.new(name: 'TimeRange')
|
275
289
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
@@ -279,6 +293,7 @@ module Aws::Kendra
|
|
279
293
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
280
294
|
UpdateDataSourceRequest = Shapes::StructureShape.new(name: 'UpdateDataSourceRequest')
|
281
295
|
UpdateIndexRequest = Shapes::StructureShape.new(name: 'UpdateIndexRequest')
|
296
|
+
UpdateThesaurusRequest = Shapes::StructureShape.new(name: 'UpdateThesaurusRequest')
|
282
297
|
Url = Shapes::StringShape.new(name: 'Url')
|
283
298
|
UserAccount = Shapes::StringShape.new(name: 'UserAccount')
|
284
299
|
UserContext = Shapes::StructureShape.new(name: 'UserContext')
|
@@ -484,6 +499,18 @@ module Aws::Kendra
|
|
484
499
|
CreateIndexResponse.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, location_name: "Id"))
|
485
500
|
CreateIndexResponse.struct_class = Types::CreateIndexResponse
|
486
501
|
|
502
|
+
CreateThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
503
|
+
CreateThesaurusRequest.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, required: true, location_name: "Name"))
|
504
|
+
CreateThesaurusRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
505
|
+
CreateThesaurusRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
506
|
+
CreateThesaurusRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
507
|
+
CreateThesaurusRequest.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "SourceS3Path"))
|
508
|
+
CreateThesaurusRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
509
|
+
CreateThesaurusRequest.struct_class = Types::CreateThesaurusRequest
|
510
|
+
|
511
|
+
CreateThesaurusResponse.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
512
|
+
CreateThesaurusResponse.struct_class = Types::CreateThesaurusResponse
|
513
|
+
|
487
514
|
DataSourceConfiguration.add_member(:s3_configuration, Shapes::ShapeRef.new(shape: S3DataSourceConfiguration, location_name: "S3Configuration"))
|
488
515
|
DataSourceConfiguration.add_member(:share_point_configuration, Shapes::ShapeRef.new(shape: SharePointConfiguration, location_name: "SharePointConfiguration"))
|
489
516
|
DataSourceConfiguration.add_member(:database_configuration, Shapes::ShapeRef.new(shape: DatabaseConfiguration, location_name: "DatabaseConfiguration"))
|
@@ -559,6 +586,10 @@ module Aws::Kendra
|
|
559
586
|
DeleteIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
560
587
|
DeleteIndexRequest.struct_class = Types::DeleteIndexRequest
|
561
588
|
|
589
|
+
DeleteThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
590
|
+
DeleteThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
591
|
+
DeleteThesaurusRequest.struct_class = Types::DeleteThesaurusRequest
|
592
|
+
|
562
593
|
DescribeDataSourceRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
563
594
|
DescribeDataSourceRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
564
595
|
DescribeDataSourceRequest.struct_class = Types::DescribeDataSourceRequest
|
@@ -614,6 +645,25 @@ module Aws::Kendra
|
|
614
645
|
DescribeIndexResponse.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
615
646
|
DescribeIndexResponse.struct_class = Types::DescribeIndexResponse
|
616
647
|
|
648
|
+
DescribeThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
649
|
+
DescribeThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
650
|
+
DescribeThesaurusRequest.struct_class = Types::DescribeThesaurusRequest
|
651
|
+
|
652
|
+
DescribeThesaurusResponse.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
653
|
+
DescribeThesaurusResponse.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, location_name: "IndexId"))
|
654
|
+
DescribeThesaurusResponse.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
655
|
+
DescribeThesaurusResponse.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
656
|
+
DescribeThesaurusResponse.add_member(:status, Shapes::ShapeRef.new(shape: ThesaurusStatus, location_name: "Status"))
|
657
|
+
DescribeThesaurusResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
658
|
+
DescribeThesaurusResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
659
|
+
DescribeThesaurusResponse.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
660
|
+
DescribeThesaurusResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
661
|
+
DescribeThesaurusResponse.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, location_name: "SourceS3Path"))
|
662
|
+
DescribeThesaurusResponse.add_member(:file_size_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "FileSizeBytes"))
|
663
|
+
DescribeThesaurusResponse.add_member(:term_count, Shapes::ShapeRef.new(shape: Long, location_name: "TermCount"))
|
664
|
+
DescribeThesaurusResponse.add_member(:synonym_rule_count, Shapes::ShapeRef.new(shape: Long, location_name: "SynonymRuleCount"))
|
665
|
+
DescribeThesaurusResponse.struct_class = Types::DescribeThesaurusResponse
|
666
|
+
|
617
667
|
Document.add_member(:id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location_name: "Id"))
|
618
668
|
Document.add_member(:title, Shapes::ShapeRef.new(shape: Title, location_name: "Title"))
|
619
669
|
Document.add_member(:blob, Shapes::ShapeRef.new(shape: Blob, location_name: "Blob"))
|
@@ -703,6 +753,7 @@ module Aws::Kendra
|
|
703
753
|
Highlight.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "BeginOffset"))
|
704
754
|
Highlight.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "EndOffset"))
|
705
755
|
Highlight.add_member(:top_answer, Shapes::ShapeRef.new(shape: Boolean, location_name: "TopAnswer"))
|
756
|
+
Highlight.add_member(:type, Shapes::ShapeRef.new(shape: HighlightType, location_name: "Type"))
|
706
757
|
Highlight.struct_class = Types::Highlight
|
707
758
|
|
708
759
|
HighlightList.member = Shapes::ShapeRef.new(shape: Highlight)
|
@@ -781,6 +832,15 @@ module Aws::Kendra
|
|
781
832
|
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
782
833
|
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
783
834
|
|
835
|
+
ListThesauriRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
836
|
+
ListThesauriRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
837
|
+
ListThesauriRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsIntegerForListThesauriRequest, location_name: "MaxResults"))
|
838
|
+
ListThesauriRequest.struct_class = Types::ListThesauriRequest
|
839
|
+
|
840
|
+
ListThesauriResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
841
|
+
ListThesauriResponse.add_member(:thesaurus_summary_items, Shapes::ShapeRef.new(shape: ThesaurusSummaryItems, location_name: "ThesaurusSummaryItems"))
|
842
|
+
ListThesauriResponse.struct_class = Types::ListThesauriResponse
|
843
|
+
|
784
844
|
OneDriveConfiguration.add_member(:tenant_domain, Shapes::ShapeRef.new(shape: TenantDomain, required: true, location_name: "TenantDomain"))
|
785
845
|
OneDriveConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
|
786
846
|
OneDriveConfiguration.add_member(:one_drive_users, Shapes::ShapeRef.new(shape: OneDriveUsers, required: true, location_name: "OneDriveUsers"))
|
@@ -1027,6 +1087,15 @@ module Aws::Kendra
|
|
1027
1087
|
TextWithHighlights.add_member(:highlights, Shapes::ShapeRef.new(shape: HighlightList, location_name: "Highlights"))
|
1028
1088
|
TextWithHighlights.struct_class = Types::TextWithHighlights
|
1029
1089
|
|
1090
|
+
ThesaurusSummary.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
1091
|
+
ThesaurusSummary.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
1092
|
+
ThesaurusSummary.add_member(:status, Shapes::ShapeRef.new(shape: ThesaurusStatus, location_name: "Status"))
|
1093
|
+
ThesaurusSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
1094
|
+
ThesaurusSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
1095
|
+
ThesaurusSummary.struct_class = Types::ThesaurusSummary
|
1096
|
+
|
1097
|
+
ThesaurusSummaryItems.member = Shapes::ShapeRef.new(shape: ThesaurusSummary)
|
1098
|
+
|
1030
1099
|
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
1031
1100
|
ThrottlingException.struct_class = Types::ThrottlingException
|
1032
1101
|
|
@@ -1059,6 +1128,14 @@ module Aws::Kendra
|
|
1059
1128
|
UpdateIndexRequest.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
1060
1129
|
UpdateIndexRequest.struct_class = Types::UpdateIndexRequest
|
1061
1130
|
|
1131
|
+
UpdateThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
1132
|
+
UpdateThesaurusRequest.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
1133
|
+
UpdateThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
1134
|
+
UpdateThesaurusRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
1135
|
+
UpdateThesaurusRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
1136
|
+
UpdateThesaurusRequest.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, location_name: "SourceS3Path"))
|
1137
|
+
UpdateThesaurusRequest.struct_class = Types::UpdateThesaurusRequest
|
1138
|
+
|
1062
1139
|
UserContext.add_member(:token, Shapes::ShapeRef.new(shape: Token, location_name: "Token"))
|
1063
1140
|
UserContext.struct_class = Types::UserContext
|
1064
1141
|
|
@@ -1169,6 +1246,21 @@ module Aws::Kendra
|
|
1169
1246
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1170
1247
|
end)
|
1171
1248
|
|
1249
|
+
api.add_operation(:create_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1250
|
+
o.name = "CreateThesaurus"
|
1251
|
+
o.http_method = "POST"
|
1252
|
+
o.http_request_uri = "/"
|
1253
|
+
o.input = Shapes::ShapeRef.new(shape: CreateThesaurusRequest)
|
1254
|
+
o.output = Shapes::ShapeRef.new(shape: CreateThesaurusResponse)
|
1255
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1256
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1257
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1258
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1259
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1260
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1261
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1262
|
+
end)
|
1263
|
+
|
1172
1264
|
api.add_operation(:delete_data_source, Seahorse::Model::Operation.new.tap do |o|
|
1173
1265
|
o.name = "DeleteDataSource"
|
1174
1266
|
o.http_method = "POST"
|
@@ -1211,6 +1303,20 @@ module Aws::Kendra
|
|
1211
1303
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1212
1304
|
end)
|
1213
1305
|
|
1306
|
+
api.add_operation(:delete_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1307
|
+
o.name = "DeleteThesaurus"
|
1308
|
+
o.http_method = "POST"
|
1309
|
+
o.http_request_uri = "/"
|
1310
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteThesaurusRequest)
|
1311
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1312
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1313
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1314
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1315
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1316
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1317
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1318
|
+
end)
|
1319
|
+
|
1214
1320
|
api.add_operation(:describe_data_source, Seahorse::Model::Operation.new.tap do |o|
|
1215
1321
|
o.name = "DescribeDataSource"
|
1216
1322
|
o.http_method = "POST"
|
@@ -1250,6 +1356,19 @@ module Aws::Kendra
|
|
1250
1356
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1251
1357
|
end)
|
1252
1358
|
|
1359
|
+
api.add_operation(:describe_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1360
|
+
o.name = "DescribeThesaurus"
|
1361
|
+
o.http_method = "POST"
|
1362
|
+
o.http_request_uri = "/"
|
1363
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeThesaurusRequest)
|
1364
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeThesaurusResponse)
|
1365
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1366
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1367
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1368
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1369
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1370
|
+
end)
|
1371
|
+
|
1253
1372
|
api.add_operation(:list_data_source_sync_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1254
1373
|
o.name = "ListDataSourceSyncJobs"
|
1255
1374
|
o.http_method = "POST"
|
@@ -1333,6 +1452,19 @@ module Aws::Kendra
|
|
1333
1452
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1334
1453
|
end)
|
1335
1454
|
|
1455
|
+
api.add_operation(:list_thesauri, Seahorse::Model::Operation.new.tap do |o|
|
1456
|
+
o.name = "ListThesauri"
|
1457
|
+
o.http_method = "POST"
|
1458
|
+
o.http_request_uri = "/"
|
1459
|
+
o.input = Shapes::ShapeRef.new(shape: ListThesauriRequest)
|
1460
|
+
o.output = Shapes::ShapeRef.new(shape: ListThesauriResponse)
|
1461
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1462
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1463
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1464
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1465
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1466
|
+
end)
|
1467
|
+
|
1336
1468
|
api.add_operation(:query, Seahorse::Model::Operation.new.tap do |o|
|
1337
1469
|
o.name = "Query"
|
1338
1470
|
o.http_method = "POST"
|
@@ -1444,6 +1576,20 @@ module Aws::Kendra
|
|
1444
1576
|
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1445
1577
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1446
1578
|
end)
|
1579
|
+
|
1580
|
+
api.add_operation(:update_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1581
|
+
o.name = "UpdateThesaurus"
|
1582
|
+
o.http_method = "POST"
|
1583
|
+
o.http_request_uri = "/"
|
1584
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateThesaurusRequest)
|
1585
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1586
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1587
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1588
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1589
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1590
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1591
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1592
|
+
end)
|
1447
1593
|
end
|
1448
1594
|
|
1449
1595
|
end
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -1983,6 +1983,90 @@ module Aws::Kendra
|
|
1983
1983
|
include Aws::Structure
|
1984
1984
|
end
|
1985
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
|
+
|
1986
2070
|
# Configuration information for a Amazon Kendra data source.
|
1987
2071
|
#
|
1988
2072
|
# @note When making an API call, you may pass DataSourceConfiguration
|
@@ -2687,6 +2771,31 @@ module Aws::Kendra
|
|
2687
2771
|
include Aws::Structure
|
2688
2772
|
end
|
2689
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
|
+
|
2690
2799
|
# @note When making an API call, you may pass DescribeDataSourceRequest
|
2691
2800
|
# data as a hash:
|
2692
2801
|
#
|
@@ -2901,7 +3010,7 @@ module Aws::Kendra
|
|
2901
3010
|
# @return [String]
|
2902
3011
|
#
|
2903
3012
|
# @!attribute [rw] id
|
2904
|
-
#
|
3013
|
+
# The name of the index.
|
2905
3014
|
# @return [String]
|
2906
3015
|
#
|
2907
3016
|
# @!attribute [rw] edition
|
@@ -2990,6 +3099,115 @@ module Aws::Kendra
|
|
2990
3099
|
include Aws::Structure
|
2991
3100
|
end
|
2992
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)
|
3207
|
+
SENSITIVE = []
|
3208
|
+
include Aws::Structure
|
3209
|
+
end
|
3210
|
+
|
2993
3211
|
# A document in an index.
|
2994
3212
|
#
|
2995
3213
|
# @note When making an API call, you may pass Document
|
@@ -3469,12 +3687,17 @@ module Aws::Kendra
|
|
3469
3687
|
# the best response; otherwise, false.
|
3470
3688
|
# @return [Boolean]
|
3471
3689
|
#
|
3690
|
+
# @!attribute [rw] type
|
3691
|
+
# The highlight type.
|
3692
|
+
# @return [String]
|
3693
|
+
#
|
3472
3694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Highlight AWS API Documentation
|
3473
3695
|
#
|
3474
3696
|
class Highlight < Struct.new(
|
3475
3697
|
:begin_offset,
|
3476
3698
|
:end_offset,
|
3477
|
-
:top_answer
|
3699
|
+
:top_answer,
|
3700
|
+
:type)
|
3478
3701
|
SENSITIVE = []
|
3479
3702
|
include Aws::Structure
|
3480
3703
|
end
|
@@ -3905,6 +4128,59 @@ module Aws::Kendra
|
|
3905
4128
|
include Aws::Structure
|
3906
4129
|
end
|
3907
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
|
+
|
3908
4184
|
# Provides configuration information for data sources that connect to
|
3909
4185
|
# OneDrive.
|
3910
4186
|
#
|
@@ -5849,6 +6125,40 @@ module Aws::Kendra
|
|
5849
6125
|
include Aws::Structure
|
5850
6126
|
end
|
5851
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
|
+
|
5852
6162
|
# @!attribute [rw] message
|
5853
6163
|
# @return [String]
|
5854
6164
|
#
|
@@ -6343,6 +6653,58 @@ module Aws::Kendra
|
|
6343
6653
|
include Aws::Structure
|
6344
6654
|
end
|
6345
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
|
+
|
6346
6708
|
# Provides information about the user context for a Amazon Kendra index.
|
6347
6709
|
#
|
6348
6710
|
# @note When making an API call, you may pass UserContext
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kendra
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.20.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-12-
|
11
|
+
date: 2020-12-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|