aws-sdk-kendra 1.19.0 → 1.24.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 +133 -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 +301 -15
- data/lib/aws-sdk-kendra/client_api.rb +160 -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 +532 -36
- metadata +11 -8
@@ -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
|
|
@@ -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')
|
@@ -123,6 +128,8 @@ module Aws::Kendra
|
|
123
128
|
DocumentMetadataConfiguration = Shapes::StructureShape.new(name: 'DocumentMetadataConfiguration')
|
124
129
|
DocumentMetadataConfigurationList = Shapes::ListShape.new(name: 'DocumentMetadataConfigurationList')
|
125
130
|
DocumentMetadataConfigurationName = Shapes::StringShape.new(name: 'DocumentMetadataConfigurationName')
|
131
|
+
DocumentRelevanceConfiguration = Shapes::StructureShape.new(name: 'DocumentRelevanceConfiguration')
|
132
|
+
DocumentRelevanceOverrideConfigurationList = Shapes::ListShape.new(name: 'DocumentRelevanceOverrideConfigurationList')
|
126
133
|
DocumentsMetadataConfiguration = Shapes::StructureShape.new(name: 'DocumentsMetadataConfiguration')
|
127
134
|
Duration = Shapes::StringShape.new(name: 'Duration')
|
128
135
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
@@ -146,6 +153,7 @@ module Aws::Kendra
|
|
146
153
|
GroupAttributeField = Shapes::StringShape.new(name: 'GroupAttributeField')
|
147
154
|
Highlight = Shapes::StructureShape.new(name: 'Highlight')
|
148
155
|
HighlightList = Shapes::ListShape.new(name: 'HighlightList')
|
156
|
+
HighlightType = Shapes::StringShape.new(name: 'HighlightType')
|
149
157
|
Importance = Shapes::IntegerShape.new(name: 'Importance')
|
150
158
|
IndexConfigurationSummary = Shapes::StructureShape.new(name: 'IndexConfigurationSummary')
|
151
159
|
IndexConfigurationSummaryList = Shapes::ListShape.new(name: 'IndexConfigurationSummaryList')
|
@@ -175,11 +183,14 @@ module Aws::Kendra
|
|
175
183
|
ListIndicesResponse = Shapes::StructureShape.new(name: 'ListIndicesResponse')
|
176
184
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
177
185
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
186
|
+
ListThesauriRequest = Shapes::StructureShape.new(name: 'ListThesauriRequest')
|
187
|
+
ListThesauriResponse = Shapes::StructureShape.new(name: 'ListThesauriResponse')
|
178
188
|
Long = Shapes::IntegerShape.new(name: 'Long')
|
179
189
|
MaxResultsIntegerForListDataSourceSyncJobsRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListDataSourceSyncJobsRequest')
|
180
190
|
MaxResultsIntegerForListDataSourcesRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListDataSourcesRequest')
|
181
191
|
MaxResultsIntegerForListFaqsRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListFaqsRequest')
|
182
192
|
MaxResultsIntegerForListIndicesRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListIndicesRequest')
|
193
|
+
MaxResultsIntegerForListThesauriRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListThesauriRequest')
|
183
194
|
MetricValue = Shapes::StringShape.new(name: 'MetricValue')
|
184
195
|
MimeType = Shapes::StringShape.new(name: 'MimeType')
|
185
196
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
@@ -238,10 +249,12 @@ module Aws::Kendra
|
|
238
249
|
SecretArn = Shapes::StringShape.new(name: 'SecretArn')
|
239
250
|
SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
|
240
251
|
ServerSideEncryptionConfiguration = Shapes::StructureShape.new(name: 'ServerSideEncryptionConfiguration')
|
252
|
+
ServiceNowAuthenticationType = Shapes::StringShape.new(name: 'ServiceNowAuthenticationType')
|
241
253
|
ServiceNowBuildVersionType = Shapes::StringShape.new(name: 'ServiceNowBuildVersionType')
|
242
254
|
ServiceNowConfiguration = Shapes::StructureShape.new(name: 'ServiceNowConfiguration')
|
243
255
|
ServiceNowHostUrl = Shapes::StringShape.new(name: 'ServiceNowHostUrl')
|
244
256
|
ServiceNowKnowledgeArticleConfiguration = Shapes::StructureShape.new(name: 'ServiceNowKnowledgeArticleConfiguration')
|
257
|
+
ServiceNowKnowledgeArticleFilterQuery = Shapes::StringShape.new(name: 'ServiceNowKnowledgeArticleFilterQuery')
|
245
258
|
ServiceNowServiceCatalogConfiguration = Shapes::StructureShape.new(name: 'ServiceNowServiceCatalogConfiguration')
|
246
259
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
247
260
|
SharePointConfiguration = Shapes::StructureShape.new(name: 'SharePointConfiguration')
|
@@ -270,6 +283,11 @@ module Aws::Kendra
|
|
270
283
|
TenantDomain = Shapes::StringShape.new(name: 'TenantDomain')
|
271
284
|
TextDocumentStatistics = Shapes::StructureShape.new(name: 'TextDocumentStatistics')
|
272
285
|
TextWithHighlights = Shapes::StructureShape.new(name: 'TextWithHighlights')
|
286
|
+
ThesaurusId = Shapes::StringShape.new(name: 'ThesaurusId')
|
287
|
+
ThesaurusName = Shapes::StringShape.new(name: 'ThesaurusName')
|
288
|
+
ThesaurusStatus = Shapes::StringShape.new(name: 'ThesaurusStatus')
|
289
|
+
ThesaurusSummary = Shapes::StructureShape.new(name: 'ThesaurusSummary')
|
290
|
+
ThesaurusSummaryItems = Shapes::ListShape.new(name: 'ThesaurusSummaryItems')
|
273
291
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
274
292
|
TimeRange = Shapes::StructureShape.new(name: 'TimeRange')
|
275
293
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
@@ -279,6 +297,7 @@ module Aws::Kendra
|
|
279
297
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
280
298
|
UpdateDataSourceRequest = Shapes::StructureShape.new(name: 'UpdateDataSourceRequest')
|
281
299
|
UpdateIndexRequest = Shapes::StructureShape.new(name: 'UpdateIndexRequest')
|
300
|
+
UpdateThesaurusRequest = Shapes::StructureShape.new(name: 'UpdateThesaurusRequest')
|
282
301
|
Url = Shapes::StringShape.new(name: 'Url')
|
283
302
|
UserAccount = Shapes::StringShape.new(name: 'UserAccount')
|
284
303
|
UserContext = Shapes::StructureShape.new(name: 'UserContext')
|
@@ -484,6 +503,18 @@ module Aws::Kendra
|
|
484
503
|
CreateIndexResponse.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, location_name: "Id"))
|
485
504
|
CreateIndexResponse.struct_class = Types::CreateIndexResponse
|
486
505
|
|
506
|
+
CreateThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
507
|
+
CreateThesaurusRequest.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, required: true, location_name: "Name"))
|
508
|
+
CreateThesaurusRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
509
|
+
CreateThesaurusRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
510
|
+
CreateThesaurusRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
511
|
+
CreateThesaurusRequest.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "SourceS3Path"))
|
512
|
+
CreateThesaurusRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
513
|
+
CreateThesaurusRequest.struct_class = Types::CreateThesaurusRequest
|
514
|
+
|
515
|
+
CreateThesaurusResponse.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
516
|
+
CreateThesaurusResponse.struct_class = Types::CreateThesaurusResponse
|
517
|
+
|
487
518
|
DataSourceConfiguration.add_member(:s3_configuration, Shapes::ShapeRef.new(shape: S3DataSourceConfiguration, location_name: "S3Configuration"))
|
488
519
|
DataSourceConfiguration.add_member(:share_point_configuration, Shapes::ShapeRef.new(shape: SharePointConfiguration, location_name: "SharePointConfiguration"))
|
489
520
|
DataSourceConfiguration.add_member(:database_configuration, Shapes::ShapeRef.new(shape: DatabaseConfiguration, location_name: "DatabaseConfiguration"))
|
@@ -559,6 +590,10 @@ module Aws::Kendra
|
|
559
590
|
DeleteIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
560
591
|
DeleteIndexRequest.struct_class = Types::DeleteIndexRequest
|
561
592
|
|
593
|
+
DeleteThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
594
|
+
DeleteThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
595
|
+
DeleteThesaurusRequest.struct_class = Types::DeleteThesaurusRequest
|
596
|
+
|
562
597
|
DescribeDataSourceRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
563
598
|
DescribeDataSourceRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
564
599
|
DescribeDataSourceRequest.struct_class = Types::DescribeDataSourceRequest
|
@@ -614,6 +649,25 @@ module Aws::Kendra
|
|
614
649
|
DescribeIndexResponse.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
615
650
|
DescribeIndexResponse.struct_class = Types::DescribeIndexResponse
|
616
651
|
|
652
|
+
DescribeThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
653
|
+
DescribeThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
654
|
+
DescribeThesaurusRequest.struct_class = Types::DescribeThesaurusRequest
|
655
|
+
|
656
|
+
DescribeThesaurusResponse.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
657
|
+
DescribeThesaurusResponse.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, location_name: "IndexId"))
|
658
|
+
DescribeThesaurusResponse.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
659
|
+
DescribeThesaurusResponse.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
660
|
+
DescribeThesaurusResponse.add_member(:status, Shapes::ShapeRef.new(shape: ThesaurusStatus, location_name: "Status"))
|
661
|
+
DescribeThesaurusResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
662
|
+
DescribeThesaurusResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
663
|
+
DescribeThesaurusResponse.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
664
|
+
DescribeThesaurusResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
665
|
+
DescribeThesaurusResponse.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, location_name: "SourceS3Path"))
|
666
|
+
DescribeThesaurusResponse.add_member(:file_size_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "FileSizeBytes"))
|
667
|
+
DescribeThesaurusResponse.add_member(:term_count, Shapes::ShapeRef.new(shape: Long, location_name: "TermCount"))
|
668
|
+
DescribeThesaurusResponse.add_member(:synonym_rule_count, Shapes::ShapeRef.new(shape: Long, location_name: "SynonymRuleCount"))
|
669
|
+
DescribeThesaurusResponse.struct_class = Types::DescribeThesaurusResponse
|
670
|
+
|
617
671
|
Document.add_member(:id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location_name: "Id"))
|
618
672
|
Document.add_member(:title, Shapes::ShapeRef.new(shape: Title, location_name: "Title"))
|
619
673
|
Document.add_member(:blob, Shapes::ShapeRef.new(shape: Blob, location_name: "Blob"))
|
@@ -657,6 +711,12 @@ module Aws::Kendra
|
|
657
711
|
|
658
712
|
DocumentMetadataConfigurationList.member = Shapes::ShapeRef.new(shape: DocumentMetadataConfiguration)
|
659
713
|
|
714
|
+
DocumentRelevanceConfiguration.add_member(:name, Shapes::ShapeRef.new(shape: DocumentMetadataConfigurationName, required: true, location_name: "Name"))
|
715
|
+
DocumentRelevanceConfiguration.add_member(:relevance, Shapes::ShapeRef.new(shape: Relevance, required: true, location_name: "Relevance"))
|
716
|
+
DocumentRelevanceConfiguration.struct_class = Types::DocumentRelevanceConfiguration
|
717
|
+
|
718
|
+
DocumentRelevanceOverrideConfigurationList.member = Shapes::ShapeRef.new(shape: DocumentRelevanceConfiguration)
|
719
|
+
|
660
720
|
DocumentsMetadataConfiguration.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "S3Prefix"))
|
661
721
|
DocumentsMetadataConfiguration.struct_class = Types::DocumentsMetadataConfiguration
|
662
722
|
|
@@ -703,6 +763,7 @@ module Aws::Kendra
|
|
703
763
|
Highlight.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "BeginOffset"))
|
704
764
|
Highlight.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "EndOffset"))
|
705
765
|
Highlight.add_member(:top_answer, Shapes::ShapeRef.new(shape: Boolean, location_name: "TopAnswer"))
|
766
|
+
Highlight.add_member(:type, Shapes::ShapeRef.new(shape: HighlightType, location_name: "Type"))
|
706
767
|
Highlight.struct_class = Types::Highlight
|
707
768
|
|
708
769
|
HighlightList.member = Shapes::ShapeRef.new(shape: Highlight)
|
@@ -781,6 +842,15 @@ module Aws::Kendra
|
|
781
842
|
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
782
843
|
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
783
844
|
|
845
|
+
ListThesauriRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
846
|
+
ListThesauriRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
847
|
+
ListThesauriRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsIntegerForListThesauriRequest, location_name: "MaxResults"))
|
848
|
+
ListThesauriRequest.struct_class = Types::ListThesauriRequest
|
849
|
+
|
850
|
+
ListThesauriResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
851
|
+
ListThesauriResponse.add_member(:thesaurus_summary_items, Shapes::ShapeRef.new(shape: ThesaurusSummaryItems, location_name: "ThesaurusSummaryItems"))
|
852
|
+
ListThesauriResponse.struct_class = Types::ListThesauriResponse
|
853
|
+
|
784
854
|
OneDriveConfiguration.add_member(:tenant_domain, Shapes::ShapeRef.new(shape: TenantDomain, required: true, location_name: "TenantDomain"))
|
785
855
|
OneDriveConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
|
786
856
|
OneDriveConfiguration.add_member(:one_drive_users, Shapes::ShapeRef.new(shape: OneDriveUsers, required: true, location_name: "OneDriveUsers"))
|
@@ -809,6 +879,7 @@ module Aws::Kendra
|
|
809
879
|
QueryRequest.add_member(:facets, Shapes::ShapeRef.new(shape: FacetList, location_name: "Facets"))
|
810
880
|
QueryRequest.add_member(:requested_document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "RequestedDocumentAttributes"))
|
811
881
|
QueryRequest.add_member(:query_result_type_filter, Shapes::ShapeRef.new(shape: QueryResultType, location_name: "QueryResultTypeFilter"))
|
882
|
+
QueryRequest.add_member(:document_relevance_override_configurations, Shapes::ShapeRef.new(shape: DocumentRelevanceOverrideConfigurationList, location_name: "DocumentRelevanceOverrideConfigurations"))
|
812
883
|
QueryRequest.add_member(:page_number, Shapes::ShapeRef.new(shape: Integer, location_name: "PageNumber"))
|
813
884
|
QueryRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
|
814
885
|
QueryRequest.add_member(:sorting_configuration, Shapes::ShapeRef.new(shape: SortingConfiguration, location_name: "SortingConfiguration"))
|
@@ -943,6 +1014,7 @@ module Aws::Kendra
|
|
943
1014
|
ServiceNowConfiguration.add_member(:service_now_build_version, Shapes::ShapeRef.new(shape: ServiceNowBuildVersionType, required: true, location_name: "ServiceNowBuildVersion"))
|
944
1015
|
ServiceNowConfiguration.add_member(:knowledge_article_configuration, Shapes::ShapeRef.new(shape: ServiceNowKnowledgeArticleConfiguration, location_name: "KnowledgeArticleConfiguration"))
|
945
1016
|
ServiceNowConfiguration.add_member(:service_catalog_configuration, Shapes::ShapeRef.new(shape: ServiceNowServiceCatalogConfiguration, location_name: "ServiceCatalogConfiguration"))
|
1017
|
+
ServiceNowConfiguration.add_member(:authentication_type, Shapes::ShapeRef.new(shape: ServiceNowAuthenticationType, location_name: "AuthenticationType"))
|
946
1018
|
ServiceNowConfiguration.struct_class = Types::ServiceNowConfiguration
|
947
1019
|
|
948
1020
|
ServiceNowKnowledgeArticleConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
|
@@ -951,6 +1023,7 @@ module Aws::Kendra
|
|
951
1023
|
ServiceNowKnowledgeArticleConfiguration.add_member(:document_data_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, required: true, location_name: "DocumentDataFieldName"))
|
952
1024
|
ServiceNowKnowledgeArticleConfiguration.add_member(:document_title_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, location_name: "DocumentTitleFieldName"))
|
953
1025
|
ServiceNowKnowledgeArticleConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings"))
|
1026
|
+
ServiceNowKnowledgeArticleConfiguration.add_member(:filter_query, Shapes::ShapeRef.new(shape: ServiceNowKnowledgeArticleFilterQuery, location_name: "FilterQuery"))
|
954
1027
|
ServiceNowKnowledgeArticleConfiguration.struct_class = Types::ServiceNowKnowledgeArticleConfiguration
|
955
1028
|
|
956
1029
|
ServiceNowServiceCatalogConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
|
@@ -1027,6 +1100,15 @@ module Aws::Kendra
|
|
1027
1100
|
TextWithHighlights.add_member(:highlights, Shapes::ShapeRef.new(shape: HighlightList, location_name: "Highlights"))
|
1028
1101
|
TextWithHighlights.struct_class = Types::TextWithHighlights
|
1029
1102
|
|
1103
|
+
ThesaurusSummary.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
1104
|
+
ThesaurusSummary.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
1105
|
+
ThesaurusSummary.add_member(:status, Shapes::ShapeRef.new(shape: ThesaurusStatus, location_name: "Status"))
|
1106
|
+
ThesaurusSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
1107
|
+
ThesaurusSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
1108
|
+
ThesaurusSummary.struct_class = Types::ThesaurusSummary
|
1109
|
+
|
1110
|
+
ThesaurusSummaryItems.member = Shapes::ShapeRef.new(shape: ThesaurusSummary)
|
1111
|
+
|
1030
1112
|
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
1031
1113
|
ThrottlingException.struct_class = Types::ThrottlingException
|
1032
1114
|
|
@@ -1059,6 +1141,14 @@ module Aws::Kendra
|
|
1059
1141
|
UpdateIndexRequest.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
1060
1142
|
UpdateIndexRequest.struct_class = Types::UpdateIndexRequest
|
1061
1143
|
|
1144
|
+
UpdateThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
1145
|
+
UpdateThesaurusRequest.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
1146
|
+
UpdateThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
1147
|
+
UpdateThesaurusRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
1148
|
+
UpdateThesaurusRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
1149
|
+
UpdateThesaurusRequest.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, location_name: "SourceS3Path"))
|
1150
|
+
UpdateThesaurusRequest.struct_class = Types::UpdateThesaurusRequest
|
1151
|
+
|
1062
1152
|
UserContext.add_member(:token, Shapes::ShapeRef.new(shape: Token, location_name: "Token"))
|
1063
1153
|
UserContext.struct_class = Types::UserContext
|
1064
1154
|
|
@@ -1169,6 +1259,21 @@ module Aws::Kendra
|
|
1169
1259
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1170
1260
|
end)
|
1171
1261
|
|
1262
|
+
api.add_operation(:create_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1263
|
+
o.name = "CreateThesaurus"
|
1264
|
+
o.http_method = "POST"
|
1265
|
+
o.http_request_uri = "/"
|
1266
|
+
o.input = Shapes::ShapeRef.new(shape: CreateThesaurusRequest)
|
1267
|
+
o.output = Shapes::ShapeRef.new(shape: CreateThesaurusResponse)
|
1268
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1269
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1270
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1271
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1272
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1273
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1274
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1275
|
+
end)
|
1276
|
+
|
1172
1277
|
api.add_operation(:delete_data_source, Seahorse::Model::Operation.new.tap do |o|
|
1173
1278
|
o.name = "DeleteDataSource"
|
1174
1279
|
o.http_method = "POST"
|
@@ -1211,6 +1316,20 @@ module Aws::Kendra
|
|
1211
1316
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1212
1317
|
end)
|
1213
1318
|
|
1319
|
+
api.add_operation(:delete_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1320
|
+
o.name = "DeleteThesaurus"
|
1321
|
+
o.http_method = "POST"
|
1322
|
+
o.http_request_uri = "/"
|
1323
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteThesaurusRequest)
|
1324
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1325
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1326
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1327
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1328
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1329
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1330
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1331
|
+
end)
|
1332
|
+
|
1214
1333
|
api.add_operation(:describe_data_source, Seahorse::Model::Operation.new.tap do |o|
|
1215
1334
|
o.name = "DescribeDataSource"
|
1216
1335
|
o.http_method = "POST"
|
@@ -1250,6 +1369,19 @@ module Aws::Kendra
|
|
1250
1369
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1251
1370
|
end)
|
1252
1371
|
|
1372
|
+
api.add_operation(:describe_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1373
|
+
o.name = "DescribeThesaurus"
|
1374
|
+
o.http_method = "POST"
|
1375
|
+
o.http_request_uri = "/"
|
1376
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeThesaurusRequest)
|
1377
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeThesaurusResponse)
|
1378
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1379
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1380
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1381
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1382
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1383
|
+
end)
|
1384
|
+
|
1253
1385
|
api.add_operation(:list_data_source_sync_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1254
1386
|
o.name = "ListDataSourceSyncJobs"
|
1255
1387
|
o.http_method = "POST"
|
@@ -1333,6 +1465,19 @@ module Aws::Kendra
|
|
1333
1465
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1334
1466
|
end)
|
1335
1467
|
|
1468
|
+
api.add_operation(:list_thesauri, Seahorse::Model::Operation.new.tap do |o|
|
1469
|
+
o.name = "ListThesauri"
|
1470
|
+
o.http_method = "POST"
|
1471
|
+
o.http_request_uri = "/"
|
1472
|
+
o.input = Shapes::ShapeRef.new(shape: ListThesauriRequest)
|
1473
|
+
o.output = Shapes::ShapeRef.new(shape: ListThesauriResponse)
|
1474
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1475
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1476
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1477
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1478
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1479
|
+
end)
|
1480
|
+
|
1336
1481
|
api.add_operation(:query, Seahorse::Model::Operation.new.tap do |o|
|
1337
1482
|
o.name = "Query"
|
1338
1483
|
o.http_method = "POST"
|
@@ -1444,6 +1589,20 @@ module Aws::Kendra
|
|
1444
1589
|
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1445
1590
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1446
1591
|
end)
|
1592
|
+
|
1593
|
+
api.add_operation(:update_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1594
|
+
o.name = "UpdateThesaurus"
|
1595
|
+
o.http_method = "POST"
|
1596
|
+
o.http_request_uri = "/"
|
1597
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateThesaurusRequest)
|
1598
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1599
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1600
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1601
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1602
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1603
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1604
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1605
|
+
end)
|
1447
1606
|
end
|
1448
1607
|
|
1449
1608
|
end
|
@@ -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
|
|
@@ -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,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
|
|
@@ -61,7 +61,7 @@ module Aws::Kendra
|
|
61
61
|
# A list of groups, separated by semi-colons, that filters a query
|
62
62
|
# response based on user context. The document is only returned to
|
63
63
|
# users that are in one of the groups specified in the `UserContext`
|
64
|
-
# field of the Query operation.
|
64
|
+
# field of the `Query` operation.
|
65
65
|
# @return [String]
|
66
66
|
#
|
67
67
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
|
@@ -541,7 +541,7 @@ module Aws::Kendra
|
|
541
541
|
end
|
542
542
|
|
543
543
|
# Provides information about documents that could not be removed from an
|
544
|
-
# index by the BatchDeleteDocument operation.
|
544
|
+
# index by the `BatchDeleteDocument` operation.
|
545
545
|
#
|
546
546
|
# @!attribute [rw] id
|
547
547
|
# The identifier of the document that couldn't be removed from the
|
@@ -608,7 +608,7 @@ module Aws::Kendra
|
|
608
608
|
#
|
609
609
|
# @!attribute [rw] index_id
|
610
610
|
# The identifier of the index to add the documents to. You need to
|
611
|
-
# create the index first using the CreateIndex operation.
|
611
|
+
# create the index first using the `CreateIndex` operation.
|
612
612
|
# @return [String]
|
613
613
|
#
|
614
614
|
# @!attribute [rw] role_arn
|
@@ -729,7 +729,7 @@ module Aws::Kendra
|
|
729
729
|
end
|
730
730
|
|
731
731
|
# Gathers information about when a particular result was clicked by a
|
732
|
-
# user. Your application uses the SubmitFeedback operation to provide
|
732
|
+
# user. Your application uses the `SubmitFeedback` operation to provide
|
733
733
|
# click information.
|
734
734
|
#
|
735
735
|
# @note When making an API call, you may pass ClickFeedback
|
@@ -792,7 +792,7 @@ module Aws::Kendra
|
|
792
792
|
# @!attribute [rw] field_mappings
|
793
793
|
# An array of objects that map database column names to the
|
794
794
|
# corresponding fields in an index. You must first create the fields
|
795
|
-
# in the index using the UpdateIndex operation.
|
795
|
+
# in the index using the `UpdateIndex` operation.
|
796
796
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
797
797
|
#
|
798
798
|
# @!attribute [rw] change_detecting_columns
|
@@ -868,7 +868,8 @@ module Aws::Kendra
|
|
868
868
|
# Defines the mapping between a field in the Confluence data source to a
|
869
869
|
# Amazon Kendra index field.
|
870
870
|
#
|
871
|
-
# You must first create the index field using the
|
871
|
+
# You must first create the index field using the `UpdateIndex`
|
872
|
+
# operation.
|
872
873
|
#
|
873
874
|
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
874
875
|
# data as a hash:
|
@@ -882,7 +883,8 @@ module Aws::Kendra
|
|
882
883
|
# @!attribute [rw] data_source_field_name
|
883
884
|
# The name of the field in the data source.
|
884
885
|
#
|
885
|
-
# You must first create the index field using the
|
886
|
+
# You must first create the index field using the `UpdateIndex`
|
887
|
+
# operation.
|
886
888
|
# @return [String]
|
887
889
|
#
|
888
890
|
# @!attribute [rw] date_field_format
|
@@ -909,7 +911,8 @@ module Aws::Kendra
|
|
909
911
|
|
910
912
|
# Specifies the blog settings for the Confluence data source. Blogs are
|
911
913
|
# always indexed unless filtered from the index by the
|
912
|
-
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
914
|
+
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
915
|
+
# `ConfluenceConfiguration` type.
|
913
916
|
#
|
914
917
|
# @note When making an API call, you may pass ConfluenceBlogConfiguration
|
915
918
|
# data as a hash:
|
@@ -945,7 +948,8 @@ module Aws::Kendra
|
|
945
948
|
# Defines the mapping between a blog field in the Confluence data source
|
946
949
|
# to a Amazon Kendra index field.
|
947
950
|
#
|
948
|
-
# You must first create the index field using the
|
951
|
+
# You must first create the index field using the `UpdateIndex`
|
952
|
+
# operation.
|
949
953
|
#
|
950
954
|
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
951
955
|
# data as a hash:
|
@@ -1158,7 +1162,8 @@ module Aws::Kendra
|
|
1158
1162
|
# Defines the mapping between a field in the Confluence data source to a
|
1159
1163
|
# Amazon Kendra index field.
|
1160
1164
|
#
|
1161
|
-
# You must first create the index field using the
|
1165
|
+
# You must first create the index field using the `UpdateIndex`
|
1166
|
+
# operation.
|
1162
1167
|
#
|
1163
1168
|
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
1164
1169
|
# data as a hash:
|
@@ -1271,7 +1276,8 @@ module Aws::Kendra
|
|
1271
1276
|
# Defines the mapping between a field in the Confluence data source to a
|
1272
1277
|
# Amazon Kendra index field.
|
1273
1278
|
#
|
1274
|
-
# You must first create the index field using the
|
1279
|
+
# You must first create the index field using the `UpdateIndex`
|
1280
|
+
# operation.
|
1275
1281
|
#
|
1276
1282
|
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
1277
1283
|
# data as a hash:
|
@@ -1547,6 +1553,7 @@ module Aws::Kendra
|
|
1547
1553
|
# index_field_name: "IndexFieldName", # required
|
1548
1554
|
# },
|
1549
1555
|
# ],
|
1556
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
1550
1557
|
# },
|
1551
1558
|
# service_catalog_configuration: {
|
1552
1559
|
# crawl_attachments: false,
|
@@ -1562,6 +1569,7 @@ module Aws::Kendra
|
|
1562
1569
|
# },
|
1563
1570
|
# ],
|
1564
1571
|
# },
|
1572
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
1565
1573
|
# },
|
1566
1574
|
# confluence_configuration: {
|
1567
1575
|
# server_url: "Url", # required
|
@@ -1983,6 +1991,90 @@ module Aws::Kendra
|
|
1983
1991
|
include Aws::Structure
|
1984
1992
|
end
|
1985
1993
|
|
1994
|
+
# @note When making an API call, you may pass CreateThesaurusRequest
|
1995
|
+
# data as a hash:
|
1996
|
+
#
|
1997
|
+
# {
|
1998
|
+
# index_id: "IndexId", # required
|
1999
|
+
# name: "ThesaurusName", # required
|
2000
|
+
# description: "Description",
|
2001
|
+
# role_arn: "RoleArn", # required
|
2002
|
+
# tags: [
|
2003
|
+
# {
|
2004
|
+
# key: "TagKey", # required
|
2005
|
+
# value: "TagValue", # required
|
2006
|
+
# },
|
2007
|
+
# ],
|
2008
|
+
# source_s3_path: { # required
|
2009
|
+
# bucket: "S3BucketName", # required
|
2010
|
+
# key: "S3ObjectKey", # required
|
2011
|
+
# },
|
2012
|
+
# client_token: "ClientTokenName",
|
2013
|
+
# }
|
2014
|
+
#
|
2015
|
+
# @!attribute [rw] index_id
|
2016
|
+
# The unique identifier of the index for the new thesaurus.
|
2017
|
+
# @return [String]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] name
|
2020
|
+
# The name for the new thesaurus.
|
2021
|
+
# @return [String]
|
2022
|
+
#
|
2023
|
+
# @!attribute [rw] description
|
2024
|
+
# The description for the new thesaurus.
|
2025
|
+
# @return [String]
|
2026
|
+
#
|
2027
|
+
# @!attribute [rw] role_arn
|
2028
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
2029
|
+
# Kendra permissions to access thesaurus file specified in
|
2030
|
+
# `SourceS3Path`.
|
2031
|
+
# @return [String]
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] tags
|
2034
|
+
# A list of key-value pairs that identify the thesaurus. You can use
|
2035
|
+
# the tags to identify and organize your resources and to control
|
2036
|
+
# access to resources.
|
2037
|
+
# @return [Array<Types::Tag>]
|
2038
|
+
#
|
2039
|
+
# @!attribute [rw] source_s3_path
|
2040
|
+
# The thesaurus file Amazon S3 source path.
|
2041
|
+
# @return [Types::S3Path]
|
2042
|
+
#
|
2043
|
+
# @!attribute [rw] client_token
|
2044
|
+
# A token that you provide to identify the request to create a
|
2045
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` operation with
|
2046
|
+
# the same client token will create only one index.
|
2047
|
+
#
|
2048
|
+
# **A suitable default value is auto-generated.** You should normally
|
2049
|
+
# not need to pass this option.
|
2050
|
+
# @return [String]
|
2051
|
+
#
|
2052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurusRequest AWS API Documentation
|
2053
|
+
#
|
2054
|
+
class CreateThesaurusRequest < Struct.new(
|
2055
|
+
:index_id,
|
2056
|
+
:name,
|
2057
|
+
:description,
|
2058
|
+
:role_arn,
|
2059
|
+
:tags,
|
2060
|
+
:source_s3_path,
|
2061
|
+
:client_token)
|
2062
|
+
SENSITIVE = []
|
2063
|
+
include Aws::Structure
|
2064
|
+
end
|
2065
|
+
|
2066
|
+
# @!attribute [rw] id
|
2067
|
+
# The unique identifier of the thesaurus.
|
2068
|
+
# @return [String]
|
2069
|
+
#
|
2070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurusResponse AWS API Documentation
|
2071
|
+
#
|
2072
|
+
class CreateThesaurusResponse < Struct.new(
|
2073
|
+
:id)
|
2074
|
+
SENSITIVE = []
|
2075
|
+
include Aws::Structure
|
2076
|
+
end
|
2077
|
+
|
1986
2078
|
# Configuration information for a Amazon Kendra data source.
|
1987
2079
|
#
|
1988
2080
|
# @note When making an API call, you may pass DataSourceConfiguration
|
@@ -2165,6 +2257,7 @@ module Aws::Kendra
|
|
2165
2257
|
# index_field_name: "IndexFieldName", # required
|
2166
2258
|
# },
|
2167
2259
|
# ],
|
2260
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
2168
2261
|
# },
|
2169
2262
|
# service_catalog_configuration: {
|
2170
2263
|
# crawl_attachments: false,
|
@@ -2180,6 +2273,7 @@ module Aws::Kendra
|
|
2180
2273
|
# },
|
2181
2274
|
# ],
|
2182
2275
|
# },
|
2276
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
2183
2277
|
# },
|
2184
2278
|
# confluence_configuration: {
|
2185
2279
|
# server_url: "Url", # required
|
@@ -2306,7 +2400,7 @@ module Aws::Kendra
|
|
2306
2400
|
end
|
2307
2401
|
|
2308
2402
|
# Summary information for a Amazon Kendra data source. Returned in a
|
2309
|
-
# call to .
|
2403
|
+
# call to the `DescribeDataSource` operation.
|
2310
2404
|
#
|
2311
2405
|
# @!attribute [rw] name
|
2312
2406
|
# The name of the data source.
|
@@ -2329,7 +2423,7 @@ module Aws::Kendra
|
|
2329
2423
|
# @return [Time]
|
2330
2424
|
#
|
2331
2425
|
# @!attribute [rw] status
|
2332
|
-
# The status of the data source. When the status is `
|
2426
|
+
# The status of the data source. When the status is `ACTIVE` the data
|
2333
2427
|
# source is ready to use.
|
2334
2428
|
# @return [String]
|
2335
2429
|
#
|
@@ -2474,7 +2568,7 @@ module Aws::Kendra
|
|
2474
2568
|
end
|
2475
2569
|
|
2476
2570
|
# Maps a column or attribute in the data source to an index field. You
|
2477
|
-
# must first create the fields in the index using the UpdateIndex
|
2571
|
+
# must first create the fields in the index using the `UpdateIndex`
|
2478
2572
|
# operation.
|
2479
2573
|
#
|
2480
2574
|
# @note When making an API call, you may pass DataSourceToIndexFieldMapping
|
@@ -2687,6 +2781,31 @@ module Aws::Kendra
|
|
2687
2781
|
include Aws::Structure
|
2688
2782
|
end
|
2689
2783
|
|
2784
|
+
# @note When making an API call, you may pass DeleteThesaurusRequest
|
2785
|
+
# data as a hash:
|
2786
|
+
#
|
2787
|
+
# {
|
2788
|
+
# id: "ThesaurusId", # required
|
2789
|
+
# index_id: "IndexId", # required
|
2790
|
+
# }
|
2791
|
+
#
|
2792
|
+
# @!attribute [rw] id
|
2793
|
+
# The identifier of the thesaurus to delete.
|
2794
|
+
# @return [String]
|
2795
|
+
#
|
2796
|
+
# @!attribute [rw] index_id
|
2797
|
+
# The identifier of the index associated with the thesaurus to delete.
|
2798
|
+
# @return [String]
|
2799
|
+
#
|
2800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurusRequest AWS API Documentation
|
2801
|
+
#
|
2802
|
+
class DeleteThesaurusRequest < Struct.new(
|
2803
|
+
:id,
|
2804
|
+
:index_id)
|
2805
|
+
SENSITIVE = []
|
2806
|
+
include Aws::Structure
|
2807
|
+
end
|
2808
|
+
|
2690
2809
|
# @note When making an API call, you may pass DescribeDataSourceRequest
|
2691
2810
|
# data as a hash:
|
2692
2811
|
#
|
@@ -2901,7 +3020,7 @@ module Aws::Kendra
|
|
2901
3020
|
# @return [String]
|
2902
3021
|
#
|
2903
3022
|
# @!attribute [rw] id
|
2904
|
-
#
|
3023
|
+
# The name of the index.
|
2905
3024
|
# @return [String]
|
2906
3025
|
#
|
2907
3026
|
# @!attribute [rw] edition
|
@@ -2953,7 +3072,7 @@ module Aws::Kendra
|
|
2953
3072
|
# @return [String]
|
2954
3073
|
#
|
2955
3074
|
# @!attribute [rw] capacity_units
|
2956
|
-
# For
|
3075
|
+
# For Enterprise edition indexes, you can choose to use additional
|
2957
3076
|
# capacity to meet the needs of your application. This contains the
|
2958
3077
|
# capacity units used for the index. A 0 for the query capacity or the
|
2959
3078
|
# storage capacity indicates that the index is using the default
|
@@ -2990,6 +3109,115 @@ module Aws::Kendra
|
|
2990
3109
|
include Aws::Structure
|
2991
3110
|
end
|
2992
3111
|
|
3112
|
+
# @note When making an API call, you may pass DescribeThesaurusRequest
|
3113
|
+
# data as a hash:
|
3114
|
+
#
|
3115
|
+
# {
|
3116
|
+
# id: "ThesaurusId", # required
|
3117
|
+
# index_id: "IndexId", # required
|
3118
|
+
# }
|
3119
|
+
#
|
3120
|
+
# @!attribute [rw] id
|
3121
|
+
# The identifier of the thesaurus to describe.
|
3122
|
+
# @return [String]
|
3123
|
+
#
|
3124
|
+
# @!attribute [rw] index_id
|
3125
|
+
# The identifier of the index associated with the thesaurus to
|
3126
|
+
# describe.
|
3127
|
+
# @return [String]
|
3128
|
+
#
|
3129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
|
3130
|
+
#
|
3131
|
+
class DescribeThesaurusRequest < Struct.new(
|
3132
|
+
:id,
|
3133
|
+
:index_id)
|
3134
|
+
SENSITIVE = []
|
3135
|
+
include Aws::Structure
|
3136
|
+
end
|
3137
|
+
|
3138
|
+
# @!attribute [rw] id
|
3139
|
+
# The identifier of the thesaurus.
|
3140
|
+
# @return [String]
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] index_id
|
3143
|
+
# The identifier of the index associated with the thesaurus to
|
3144
|
+
# describe.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] name
|
3148
|
+
# The thesaurus name.
|
3149
|
+
# @return [String]
|
3150
|
+
#
|
3151
|
+
# @!attribute [rw] description
|
3152
|
+
# The thesaurus description.
|
3153
|
+
# @return [String]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] status
|
3156
|
+
# The current status of the thesaurus. When the value is `ACTIVE`,
|
3157
|
+
# queries are able to use the thesaurus. If the `Status` field value
|
3158
|
+
# is `FAILED`, the `ErrorMessage` field provides more information.
|
3159
|
+
#
|
3160
|
+
# If the status is `ACTIVE_BUT_UPDATE_FAILED`, it means that Amazon
|
3161
|
+
# Kendra could not ingest the new thesaurus file. The old thesaurus
|
3162
|
+
# file is still active.
|
3163
|
+
# @return [String]
|
3164
|
+
#
|
3165
|
+
# @!attribute [rw] error_message
|
3166
|
+
# When the `Status` field value is `FAILED`, the `ErrorMessage` field
|
3167
|
+
# provides more information.
|
3168
|
+
# @return [String]
|
3169
|
+
#
|
3170
|
+
# @!attribute [rw] created_at
|
3171
|
+
# The Unix datetime that the thesaurus was created.
|
3172
|
+
# @return [Time]
|
3173
|
+
#
|
3174
|
+
# @!attribute [rw] updated_at
|
3175
|
+
# The Unix datetime that the thesaurus was last updated.
|
3176
|
+
# @return [Time]
|
3177
|
+
#
|
3178
|
+
# @!attribute [rw] role_arn
|
3179
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
3180
|
+
# Kendra permissions to access thesaurus file specified in
|
3181
|
+
# `SourceS3Path`.
|
3182
|
+
# @return [String]
|
3183
|
+
#
|
3184
|
+
# @!attribute [rw] source_s3_path
|
3185
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
3186
|
+
# @return [Types::S3Path]
|
3187
|
+
#
|
3188
|
+
# @!attribute [rw] file_size_bytes
|
3189
|
+
# The size of the thesaurus file in bytes.
|
3190
|
+
# @return [Integer]
|
3191
|
+
#
|
3192
|
+
# @!attribute [rw] term_count
|
3193
|
+
# The number of unique terms in the thesaurus file. For example, the
|
3194
|
+
# synonyms `a,b,c` and `a=>d`, the term count would be 4.
|
3195
|
+
# @return [Integer]
|
3196
|
+
#
|
3197
|
+
# @!attribute [rw] synonym_rule_count
|
3198
|
+
# The number of synonym rules in the thesaurus file.
|
3199
|
+
# @return [Integer]
|
3200
|
+
#
|
3201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusResponse AWS API Documentation
|
3202
|
+
#
|
3203
|
+
class DescribeThesaurusResponse < Struct.new(
|
3204
|
+
:id,
|
3205
|
+
:index_id,
|
3206
|
+
:name,
|
3207
|
+
:description,
|
3208
|
+
:status,
|
3209
|
+
:error_message,
|
3210
|
+
:created_at,
|
3211
|
+
:updated_at,
|
3212
|
+
:role_arn,
|
3213
|
+
:source_s3_path,
|
3214
|
+
:file_size_bytes,
|
3215
|
+
:term_count,
|
3216
|
+
:synonym_rule_count)
|
3217
|
+
SENSITIVE = []
|
3218
|
+
include Aws::Structure
|
3219
|
+
end
|
3220
|
+
|
2993
3221
|
# A document in an index.
|
2994
3222
|
#
|
2995
3223
|
# @note When making an API call, you may pass Document
|
@@ -3221,6 +3449,45 @@ module Aws::Kendra
|
|
3221
3449
|
include Aws::Structure
|
3222
3450
|
end
|
3223
3451
|
|
3452
|
+
# Overrides the document relevance properties of a custom index field.
|
3453
|
+
#
|
3454
|
+
# @note When making an API call, you may pass DocumentRelevanceConfiguration
|
3455
|
+
# data as a hash:
|
3456
|
+
#
|
3457
|
+
# {
|
3458
|
+
# name: "DocumentMetadataConfigurationName", # required
|
3459
|
+
# relevance: { # required
|
3460
|
+
# freshness: false,
|
3461
|
+
# importance: 1,
|
3462
|
+
# duration: "Duration",
|
3463
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
3464
|
+
# value_importance_map: {
|
3465
|
+
# "ValueImportanceMapKey" => 1,
|
3466
|
+
# },
|
3467
|
+
# },
|
3468
|
+
# }
|
3469
|
+
#
|
3470
|
+
# @!attribute [rw] name
|
3471
|
+
# The name of the tuning configuration to override document relevance
|
3472
|
+
# at the index level.
|
3473
|
+
# @return [String]
|
3474
|
+
#
|
3475
|
+
# @!attribute [rw] relevance
|
3476
|
+
# Provides information for manually tuning the relevance of a field in
|
3477
|
+
# a search. When a query includes terms that match the field, the
|
3478
|
+
# results are given a boost in the response based on these tuning
|
3479
|
+
# parameters.
|
3480
|
+
# @return [Types::Relevance]
|
3481
|
+
#
|
3482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentRelevanceConfiguration AWS API Documentation
|
3483
|
+
#
|
3484
|
+
class DocumentRelevanceConfiguration < Struct.new(
|
3485
|
+
:name,
|
3486
|
+
:relevance)
|
3487
|
+
SENSITIVE = []
|
3488
|
+
include Aws::Structure
|
3489
|
+
end
|
3490
|
+
|
3224
3491
|
# Document metadata files that contain information such as the document
|
3225
3492
|
# access control information, source URI, document author, and custom
|
3226
3493
|
# attributes. Each metadata file contains metadata about a single
|
@@ -3411,7 +3678,7 @@ module Aws::Kendra
|
|
3411
3678
|
#
|
3412
3679
|
# If you are using the console, you can define index fields when
|
3413
3680
|
# creating the mapping. If you are using the API, you must first
|
3414
|
-
# create the field using the UpdateIndex operation.
|
3681
|
+
# create the field using the `UpdateIndex` operation.
|
3415
3682
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3416
3683
|
#
|
3417
3684
|
# @!attribute [rw] exclude_mime_types
|
@@ -3469,12 +3736,17 @@ module Aws::Kendra
|
|
3469
3736
|
# the best response; otherwise, false.
|
3470
3737
|
# @return [Boolean]
|
3471
3738
|
#
|
3739
|
+
# @!attribute [rw] type
|
3740
|
+
# The highlight type.
|
3741
|
+
# @return [String]
|
3742
|
+
#
|
3472
3743
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Highlight AWS API Documentation
|
3473
3744
|
#
|
3474
3745
|
class Highlight < Struct.new(
|
3475
3746
|
:begin_offset,
|
3476
3747
|
:end_offset,
|
3477
|
-
:top_answer
|
3748
|
+
:top_answer,
|
3749
|
+
:type)
|
3478
3750
|
SENSITIVE = []
|
3479
3751
|
include Aws::Structure
|
3480
3752
|
end
|
@@ -3905,6 +4177,59 @@ module Aws::Kendra
|
|
3905
4177
|
include Aws::Structure
|
3906
4178
|
end
|
3907
4179
|
|
4180
|
+
# @note When making an API call, you may pass ListThesauriRequest
|
4181
|
+
# data as a hash:
|
4182
|
+
#
|
4183
|
+
# {
|
4184
|
+
# index_id: "IndexId", # required
|
4185
|
+
# next_token: "NextToken",
|
4186
|
+
# max_results: 1,
|
4187
|
+
# }
|
4188
|
+
#
|
4189
|
+
# @!attribute [rw] index_id
|
4190
|
+
# The identifier of the index associated with the thesaurus to list.
|
4191
|
+
# @return [String]
|
4192
|
+
#
|
4193
|
+
# @!attribute [rw] next_token
|
4194
|
+
# If the previous response was incomplete (because there is more data
|
4195
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
4196
|
+
# response. You can use this pagination token to retrieve the next set
|
4197
|
+
# of thesauri (`ThesaurusSummaryItems`).
|
4198
|
+
# @return [String]
|
4199
|
+
#
|
4200
|
+
# @!attribute [rw] max_results
|
4201
|
+
# The maximum number of thesauri to return.
|
4202
|
+
# @return [Integer]
|
4203
|
+
#
|
4204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriRequest AWS API Documentation
|
4205
|
+
#
|
4206
|
+
class ListThesauriRequest < Struct.new(
|
4207
|
+
:index_id,
|
4208
|
+
:next_token,
|
4209
|
+
:max_results)
|
4210
|
+
SENSITIVE = []
|
4211
|
+
include Aws::Structure
|
4212
|
+
end
|
4213
|
+
|
4214
|
+
# @!attribute [rw] next_token
|
4215
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
4216
|
+
# you can use in the subsequent request to retrieve the next set of
|
4217
|
+
# thesauri.
|
4218
|
+
# @return [String]
|
4219
|
+
#
|
4220
|
+
# @!attribute [rw] thesaurus_summary_items
|
4221
|
+
# An array of summary information for one or more thesauruses.
|
4222
|
+
# @return [Array<Types::ThesaurusSummary>]
|
4223
|
+
#
|
4224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriResponse AWS API Documentation
|
4225
|
+
#
|
4226
|
+
class ListThesauriResponse < Struct.new(
|
4227
|
+
:next_token,
|
4228
|
+
:thesaurus_summary_items)
|
4229
|
+
SENSITIVE = []
|
4230
|
+
include Aws::Structure
|
4231
|
+
end
|
4232
|
+
|
3908
4233
|
# Provides configuration information for data sources that connect to
|
3909
4234
|
# OneDrive.
|
3910
4235
|
#
|
@@ -4151,6 +4476,20 @@ module Aws::Kendra
|
|
4151
4476
|
# ],
|
4152
4477
|
# requested_document_attributes: ["DocumentAttributeKey"],
|
4153
4478
|
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
4479
|
+
# document_relevance_override_configurations: [
|
4480
|
+
# {
|
4481
|
+
# name: "DocumentMetadataConfigurationName", # required
|
4482
|
+
# relevance: { # required
|
4483
|
+
# freshness: false,
|
4484
|
+
# importance: 1,
|
4485
|
+
# duration: "Duration",
|
4486
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4487
|
+
# value_importance_map: {
|
4488
|
+
# "ValueImportanceMapKey" => 1,
|
4489
|
+
# },
|
4490
|
+
# },
|
4491
|
+
# },
|
4492
|
+
# ],
|
4154
4493
|
# page_number: 1,
|
4155
4494
|
# page_size: 1,
|
4156
4495
|
# sorting_configuration: {
|
@@ -4165,7 +4504,7 @@ module Aws::Kendra
|
|
4165
4504
|
#
|
4166
4505
|
# @!attribute [rw] index_id
|
4167
4506
|
# The unique identifier of the index to search. The identifier is
|
4168
|
-
# returned in the response from the operation.
|
4507
|
+
# returned in the response from the `CreateIndex` operation.
|
4169
4508
|
# @return [String]
|
4170
4509
|
#
|
4171
4510
|
# @!attribute [rw] query_text
|
@@ -4200,6 +4539,25 @@ module Aws::Kendra
|
|
4200
4539
|
# are returned.
|
4201
4540
|
# @return [String]
|
4202
4541
|
#
|
4542
|
+
# @!attribute [rw] document_relevance_override_configurations
|
4543
|
+
# Overrides relevance tuning configurations of fields or attributes
|
4544
|
+
# set at the index level.
|
4545
|
+
#
|
4546
|
+
# If you use this API to override the relevance tuning configured at
|
4547
|
+
# the index level, but there is no relevance tuning configured at the
|
4548
|
+
# index level, then Amazon Kendra does not apply any relevance tuning.
|
4549
|
+
#
|
4550
|
+
# If there is relevance tuning configured at the index level, but you
|
4551
|
+
# do not use this API to override any relevance tuning in the index,
|
4552
|
+
# then Amazon Kendra uses the relevance tuning that is configured at
|
4553
|
+
# the index level.
|
4554
|
+
#
|
4555
|
+
# If there is relevance tuning configured for fields at the index
|
4556
|
+
# level, but you use this API to override only some of these fields,
|
4557
|
+
# then for the fields you did not override, the importance is set to
|
4558
|
+
# 1.
|
4559
|
+
# @return [Array<Types::DocumentRelevanceConfiguration>]
|
4560
|
+
#
|
4203
4561
|
# @!attribute [rw] page_number
|
4204
4562
|
# Query results are returned in pages the size of the `PageSize`
|
4205
4563
|
# parameter. By default, Amazon Kendra returns the first page of
|
@@ -4244,6 +4602,7 @@ module Aws::Kendra
|
|
4244
4602
|
:facets,
|
4245
4603
|
:requested_document_attributes,
|
4246
4604
|
:query_result_type_filter,
|
4605
|
+
:document_relevance_override_configurations,
|
4247
4606
|
:page_number,
|
4248
4607
|
:page_size,
|
4249
4608
|
:sorting_configuration,
|
@@ -4451,7 +4810,7 @@ module Aws::Kendra
|
|
4451
4810
|
end
|
4452
4811
|
|
4453
4812
|
# Provides feedback on how relevant a document is to a search. Your
|
4454
|
-
# application uses the SubmitFeedback operation to provide relevance
|
4813
|
+
# application uses the `SubmitFeedback` operation to provide relevance
|
4455
4814
|
# information.
|
4456
4815
|
#
|
4457
4816
|
# @note When making an API call, you may pass RelevanceFeedback
|
@@ -4802,7 +5161,7 @@ module Aws::Kendra
|
|
4802
5161
|
# @return [Array<Types::SalesforceStandardObjectConfiguration>]
|
4803
5162
|
#
|
4804
5163
|
# @!attribute [rw] knowledge_article_configuration
|
4805
|
-
# Specifies configuration information for the
|
5164
|
+
# Specifies configuration information for the knowledge article types
|
4806
5165
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
4807
5166
|
# articles and the standard fields of knowledge articles, or the
|
4808
5167
|
# custom fields of custom knowledge articles, but not both.
|
@@ -4907,7 +5266,7 @@ module Aws::Kendra
|
|
4907
5266
|
include Aws::Structure
|
4908
5267
|
end
|
4909
5268
|
|
4910
|
-
# Specifies configuration information for the
|
5269
|
+
# Specifies configuration information for the knowledge article types
|
4911
5270
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
4912
5271
|
# articles and the standard fields of knowledge articles, or the custom
|
4913
5272
|
# fields of custom knowledge articles, but not both
|
@@ -5047,7 +5406,7 @@ module Aws::Kendra
|
|
5047
5406
|
include Aws::Structure
|
5048
5407
|
end
|
5049
5408
|
|
5050
|
-
# Specifies
|
5409
|
+
# Specifies configuration information for indexing a single standard
|
5051
5410
|
# object.
|
5052
5411
|
#
|
5053
5412
|
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
@@ -5077,7 +5436,7 @@ module Aws::Kendra
|
|
5077
5436
|
#
|
5078
5437
|
# @!attribute [rw] document_title_field_name
|
5079
5438
|
# The name of the field in the standard object table that contains the
|
5080
|
-
# document
|
5439
|
+
# document title.
|
5081
5440
|
# @return [String]
|
5082
5441
|
#
|
5083
5442
|
# @!attribute [rw] field_mappings
|
@@ -5209,6 +5568,7 @@ module Aws::Kendra
|
|
5209
5568
|
# index_field_name: "IndexFieldName", # required
|
5210
5569
|
# },
|
5211
5570
|
# ],
|
5571
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5212
5572
|
# },
|
5213
5573
|
# service_catalog_configuration: {
|
5214
5574
|
# crawl_attachments: false,
|
@@ -5224,6 +5584,7 @@ module Aws::Kendra
|
|
5224
5584
|
# },
|
5225
5585
|
# ],
|
5226
5586
|
# },
|
5587
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
5227
5588
|
# }
|
5228
5589
|
#
|
5229
5590
|
# @!attribute [rw] host_url
|
@@ -5253,6 +5614,25 @@ module Aws::Kendra
|
|
5253
5614
|
# the ServiceNow site.
|
5254
5615
|
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
5255
5616
|
#
|
5617
|
+
# @!attribute [rw] authentication_type
|
5618
|
+
# Determines the type of authentication used to connect to the
|
5619
|
+
# ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is
|
5620
|
+
# authenticated using the user name and password provided in the AWS
|
5621
|
+
# Secrets Manager secret in the `SecretArn` field. When you choose
|
5622
|
+
# `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and
|
5623
|
+
# secret provided in the Secrets Manager secret, and the user name and
|
5624
|
+
# password are used to determine which information Amazon Kendra has
|
5625
|
+
# access to.
|
5626
|
+
#
|
5627
|
+
# When you use `OAUTH2` authentication, you must generate a token and
|
5628
|
+
# a client secret using the ServiceNow console. For more information,
|
5629
|
+
# see [Using a ServiceNow data source][1].
|
5630
|
+
#
|
5631
|
+
#
|
5632
|
+
#
|
5633
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
|
5634
|
+
# @return [String]
|
5635
|
+
#
|
5256
5636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
|
5257
5637
|
#
|
5258
5638
|
class ServiceNowConfiguration < Struct.new(
|
@@ -5260,7 +5640,8 @@ module Aws::Kendra
|
|
5260
5640
|
:secret_arn,
|
5261
5641
|
:service_now_build_version,
|
5262
5642
|
:knowledge_article_configuration,
|
5263
|
-
:service_catalog_configuration
|
5643
|
+
:service_catalog_configuration,
|
5644
|
+
:authentication_type)
|
5264
5645
|
SENSITIVE = []
|
5265
5646
|
include Aws::Structure
|
5266
5647
|
end
|
@@ -5284,6 +5665,7 @@ module Aws::Kendra
|
|
5284
5665
|
# index_field_name: "IndexFieldName", # required
|
5285
5666
|
# },
|
5286
5667
|
# ],
|
5668
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5287
5669
|
# }
|
5288
5670
|
#
|
5289
5671
|
# @!attribute [rw] crawl_attachments
|
@@ -5318,6 +5700,20 @@ module Aws::Kendra
|
|
5318
5700
|
# You must create the index field before you map the field.
|
5319
5701
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
5320
5702
|
#
|
5703
|
+
# @!attribute [rw] filter_query
|
5704
|
+
# A query that selects the knowledge articles to index. The query can
|
5705
|
+
# return articles from multiple knowledge bases, and the knowledge
|
5706
|
+
# bases can be public or private.
|
5707
|
+
#
|
5708
|
+
# The query string must be one generated by the ServiceNow console.
|
5709
|
+
# For more information, see [Specifying documents to index with a
|
5710
|
+
# query][1].
|
5711
|
+
#
|
5712
|
+
#
|
5713
|
+
#
|
5714
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
|
5715
|
+
# @return [String]
|
5716
|
+
#
|
5321
5717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
|
5322
5718
|
#
|
5323
5719
|
class ServiceNowKnowledgeArticleConfiguration < Struct.new(
|
@@ -5326,7 +5722,8 @@ module Aws::Kendra
|
|
5326
5722
|
:exclude_attachment_file_patterns,
|
5327
5723
|
:document_data_field_name,
|
5328
5724
|
:document_title_field_name,
|
5329
|
-
:field_mappings
|
5725
|
+
:field_mappings,
|
5726
|
+
:filter_query)
|
5330
5727
|
SENSITIVE = []
|
5331
5728
|
include Aws::Structure
|
5332
5729
|
end
|
@@ -5358,13 +5755,23 @@ module Aws::Kendra
|
|
5358
5755
|
# @return [Boolean]
|
5359
5756
|
#
|
5360
5757
|
# @!attribute [rw] include_attachment_file_patterns
|
5361
|
-
#
|
5362
|
-
# index.
|
5758
|
+
# A list of regular expression patterns. Documents that match the
|
5759
|
+
# patterns are included in the index. Documents that don't match the
|
5760
|
+
# patterns are excluded from the index. If a document matches both an
|
5761
|
+
# exclusion pattern and an inclusion pattern, the document is not
|
5762
|
+
# included in the index.
|
5763
|
+
#
|
5764
|
+
# The regex is applied to the file name of the attachment.
|
5363
5765
|
# @return [Array<String>]
|
5364
5766
|
#
|
5365
5767
|
# @!attribute [rw] exclude_attachment_file_patterns
|
5366
|
-
#
|
5367
|
-
# index.
|
5768
|
+
# A list of regular expression patterns. Documents that match the
|
5769
|
+
# patterns are excluded from the index. Documents that don't match
|
5770
|
+
# the patterns are included in the index. If a document matches both
|
5771
|
+
# an exclusion pattern and an inclusion pattern, the document is not
|
5772
|
+
# included in the index.
|
5773
|
+
#
|
5774
|
+
# The regex is applied to the file name of the attachment.
|
5368
5775
|
# @return [Array<String>]
|
5369
5776
|
#
|
5370
5777
|
# @!attribute [rw] document_data_field_name
|
@@ -5499,9 +5906,9 @@ module Aws::Kendra
|
|
5499
5906
|
# @!attribute [rw] field_mappings
|
5500
5907
|
# A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
|
5501
5908
|
# SharePoint attributes to custom fields in the Amazon Kendra index.
|
5502
|
-
# You must first create the index fields using the
|
5503
|
-
# you map SharePoint attributes. For more
|
5504
|
-
# Data Source Fields][1].
|
5909
|
+
# You must first create the index fields using the `UpdateIndex`
|
5910
|
+
# operation before you map SharePoint attributes. For more
|
5911
|
+
# information, see [Mapping Data Source Fields][1].
|
5505
5912
|
#
|
5506
5913
|
#
|
5507
5914
|
#
|
@@ -5719,7 +6126,8 @@ module Aws::Kendra
|
|
5719
6126
|
#
|
5720
6127
|
# @!attribute [rw] query_id
|
5721
6128
|
# The identifier of the specific query for which you are submitting
|
5722
|
-
# feedback. The query ID is returned in the response to the
|
6129
|
+
# feedback. The query ID is returned in the response to the `Query`
|
6130
|
+
# operation.
|
5723
6131
|
# @return [String]
|
5724
6132
|
#
|
5725
6133
|
# @!attribute [rw] click_feedback_items
|
@@ -5849,6 +6257,40 @@ module Aws::Kendra
|
|
5849
6257
|
include Aws::Structure
|
5850
6258
|
end
|
5851
6259
|
|
6260
|
+
# An array of summary information for one or more thesauruses.
|
6261
|
+
#
|
6262
|
+
# @!attribute [rw] id
|
6263
|
+
# The identifier of the thesaurus.
|
6264
|
+
# @return [String]
|
6265
|
+
#
|
6266
|
+
# @!attribute [rw] name
|
6267
|
+
# The name of the thesaurus.
|
6268
|
+
# @return [String]
|
6269
|
+
#
|
6270
|
+
# @!attribute [rw] status
|
6271
|
+
# The status of the thesaurus.
|
6272
|
+
# @return [String]
|
6273
|
+
#
|
6274
|
+
# @!attribute [rw] created_at
|
6275
|
+
# The Unix datetime that the thesaurus was created.
|
6276
|
+
# @return [Time]
|
6277
|
+
#
|
6278
|
+
# @!attribute [rw] updated_at
|
6279
|
+
# The Unix datetime that the thesaurus was last updated.
|
6280
|
+
# @return [Time]
|
6281
|
+
#
|
6282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ThesaurusSummary AWS API Documentation
|
6283
|
+
#
|
6284
|
+
class ThesaurusSummary < Struct.new(
|
6285
|
+
:id,
|
6286
|
+
:name,
|
6287
|
+
:status,
|
6288
|
+
:created_at,
|
6289
|
+
:updated_at)
|
6290
|
+
SENSITIVE = []
|
6291
|
+
include Aws::Structure
|
6292
|
+
end
|
6293
|
+
|
5852
6294
|
# @!attribute [rw] message
|
5853
6295
|
# @return [String]
|
5854
6296
|
#
|
@@ -6102,6 +6544,7 @@ module Aws::Kendra
|
|
6102
6544
|
# index_field_name: "IndexFieldName", # required
|
6103
6545
|
# },
|
6104
6546
|
# ],
|
6547
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
6105
6548
|
# },
|
6106
6549
|
# service_catalog_configuration: {
|
6107
6550
|
# crawl_attachments: false,
|
@@ -6117,6 +6560,7 @@ module Aws::Kendra
|
|
6117
6560
|
# },
|
6118
6561
|
# ],
|
6119
6562
|
# },
|
6563
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
6120
6564
|
# },
|
6121
6565
|
# confluence_configuration: {
|
6122
6566
|
# server_url: "Url", # required
|
@@ -6311,7 +6755,7 @@ module Aws::Kendra
|
|
6311
6755
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
6312
6756
|
#
|
6313
6757
|
# @!attribute [rw] capacity_units
|
6314
|
-
# Sets the number of
|
6758
|
+
# Sets the number of additional storage and query capacity units that
|
6315
6759
|
# should be used by the index. You can change the capacity of the
|
6316
6760
|
# index up to 5 times per day.
|
6317
6761
|
#
|
@@ -6343,6 +6787,58 @@ module Aws::Kendra
|
|
6343
6787
|
include Aws::Structure
|
6344
6788
|
end
|
6345
6789
|
|
6790
|
+
# @note When making an API call, you may pass UpdateThesaurusRequest
|
6791
|
+
# data as a hash:
|
6792
|
+
#
|
6793
|
+
# {
|
6794
|
+
# id: "ThesaurusId", # required
|
6795
|
+
# name: "ThesaurusName",
|
6796
|
+
# index_id: "IndexId", # required
|
6797
|
+
# description: "Description",
|
6798
|
+
# role_arn: "RoleArn",
|
6799
|
+
# source_s3_path: {
|
6800
|
+
# bucket: "S3BucketName", # required
|
6801
|
+
# key: "S3ObjectKey", # required
|
6802
|
+
# },
|
6803
|
+
# }
|
6804
|
+
#
|
6805
|
+
# @!attribute [rw] id
|
6806
|
+
# The identifier of the thesaurus to update.
|
6807
|
+
# @return [String]
|
6808
|
+
#
|
6809
|
+
# @!attribute [rw] name
|
6810
|
+
# The updated name of the thesaurus.
|
6811
|
+
# @return [String]
|
6812
|
+
#
|
6813
|
+
# @!attribute [rw] index_id
|
6814
|
+
# The identifier of the index associated with the thesaurus to update.
|
6815
|
+
# @return [String]
|
6816
|
+
#
|
6817
|
+
# @!attribute [rw] description
|
6818
|
+
# The updated description of the thesaurus.
|
6819
|
+
# @return [String]
|
6820
|
+
#
|
6821
|
+
# @!attribute [rw] role_arn
|
6822
|
+
# The updated role ARN of the thesaurus.
|
6823
|
+
# @return [String]
|
6824
|
+
#
|
6825
|
+
# @!attribute [rw] source_s3_path
|
6826
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
6827
|
+
# @return [Types::S3Path]
|
6828
|
+
#
|
6829
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurusRequest AWS API Documentation
|
6830
|
+
#
|
6831
|
+
class UpdateThesaurusRequest < Struct.new(
|
6832
|
+
:id,
|
6833
|
+
:name,
|
6834
|
+
:index_id,
|
6835
|
+
:description,
|
6836
|
+
:role_arn,
|
6837
|
+
:source_s3_path)
|
6838
|
+
SENSITIVE = []
|
6839
|
+
include Aws::Structure
|
6840
|
+
end
|
6841
|
+
|
6346
6842
|
# Provides information about the user context for a Amazon Kendra index.
|
6347
6843
|
#
|
6348
6844
|
# @note When making an API call, you may pass UserContext
|