aws-sdk-kendra 1.18.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +128 -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 +326 -18
- data/lib/aws-sdk-kendra/client_api.rb +178 -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 +644 -43
- metadata +10 -7
@@ -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')
|
@@ -127,6 +132,9 @@ module Aws::Kendra
|
|
127
132
|
Duration = Shapes::StringShape.new(name: 'Duration')
|
128
133
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
129
134
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
135
|
+
ExcludeMimeTypesList = Shapes::ListShape.new(name: 'ExcludeMimeTypesList')
|
136
|
+
ExcludeSharedDrivesList = Shapes::ListShape.new(name: 'ExcludeSharedDrivesList')
|
137
|
+
ExcludeUserAccountsList = Shapes::ListShape.new(name: 'ExcludeUserAccountsList')
|
130
138
|
Facet = Shapes::StructureShape.new(name: 'Facet')
|
131
139
|
FacetList = Shapes::ListShape.new(name: 'FacetList')
|
132
140
|
FacetResult = Shapes::StructureShape.new(name: 'FacetResult')
|
@@ -138,9 +146,12 @@ module Aws::Kendra
|
|
138
146
|
FaqStatus = Shapes::StringShape.new(name: 'FaqStatus')
|
139
147
|
FaqSummary = Shapes::StructureShape.new(name: 'FaqSummary')
|
140
148
|
FaqSummaryItems = Shapes::ListShape.new(name: 'FaqSummaryItems')
|
149
|
+
FeedbackToken = Shapes::StringShape.new(name: 'FeedbackToken')
|
150
|
+
GoogleDriveConfiguration = Shapes::StructureShape.new(name: 'GoogleDriveConfiguration')
|
141
151
|
GroupAttributeField = Shapes::StringShape.new(name: 'GroupAttributeField')
|
142
152
|
Highlight = Shapes::StructureShape.new(name: 'Highlight')
|
143
153
|
HighlightList = Shapes::ListShape.new(name: 'HighlightList')
|
154
|
+
HighlightType = Shapes::StringShape.new(name: 'HighlightType')
|
144
155
|
Importance = Shapes::IntegerShape.new(name: 'Importance')
|
145
156
|
IndexConfigurationSummary = Shapes::StructureShape.new(name: 'IndexConfigurationSummary')
|
146
157
|
IndexConfigurationSummaryList = Shapes::ListShape.new(name: 'IndexConfigurationSummaryList')
|
@@ -170,12 +181,16 @@ module Aws::Kendra
|
|
170
181
|
ListIndicesResponse = Shapes::StructureShape.new(name: 'ListIndicesResponse')
|
171
182
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
172
183
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
184
|
+
ListThesauriRequest = Shapes::StructureShape.new(name: 'ListThesauriRequest')
|
185
|
+
ListThesauriResponse = Shapes::StructureShape.new(name: 'ListThesauriResponse')
|
173
186
|
Long = Shapes::IntegerShape.new(name: 'Long')
|
174
187
|
MaxResultsIntegerForListDataSourceSyncJobsRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListDataSourceSyncJobsRequest')
|
175
188
|
MaxResultsIntegerForListDataSourcesRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListDataSourcesRequest')
|
176
189
|
MaxResultsIntegerForListFaqsRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListFaqsRequest')
|
177
190
|
MaxResultsIntegerForListIndicesRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListIndicesRequest')
|
191
|
+
MaxResultsIntegerForListThesauriRequest = Shapes::IntegerShape.new(name: 'MaxResultsIntegerForListThesauriRequest')
|
178
192
|
MetricValue = Shapes::StringShape.new(name: 'MetricValue')
|
193
|
+
MimeType = Shapes::StringShape.new(name: 'MimeType')
|
179
194
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
180
195
|
OneDriveConfiguration = Shapes::StructureShape.new(name: 'OneDriveConfiguration')
|
181
196
|
OneDriveUser = Shapes::StringShape.new(name: 'OneDriveUser')
|
@@ -232,15 +247,18 @@ module Aws::Kendra
|
|
232
247
|
SecretArn = Shapes::StringShape.new(name: 'SecretArn')
|
233
248
|
SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
|
234
249
|
ServerSideEncryptionConfiguration = Shapes::StructureShape.new(name: 'ServerSideEncryptionConfiguration')
|
250
|
+
ServiceNowAuthenticationType = Shapes::StringShape.new(name: 'ServiceNowAuthenticationType')
|
235
251
|
ServiceNowBuildVersionType = Shapes::StringShape.new(name: 'ServiceNowBuildVersionType')
|
236
252
|
ServiceNowConfiguration = Shapes::StructureShape.new(name: 'ServiceNowConfiguration')
|
237
253
|
ServiceNowHostUrl = Shapes::StringShape.new(name: 'ServiceNowHostUrl')
|
238
254
|
ServiceNowKnowledgeArticleConfiguration = Shapes::StructureShape.new(name: 'ServiceNowKnowledgeArticleConfiguration')
|
255
|
+
ServiceNowKnowledgeArticleFilterQuery = Shapes::StringShape.new(name: 'ServiceNowKnowledgeArticleFilterQuery')
|
239
256
|
ServiceNowServiceCatalogConfiguration = Shapes::StructureShape.new(name: 'ServiceNowServiceCatalogConfiguration')
|
240
257
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
241
258
|
SharePointConfiguration = Shapes::StructureShape.new(name: 'SharePointConfiguration')
|
242
259
|
SharePointUrlList = Shapes::ListShape.new(name: 'SharePointUrlList')
|
243
260
|
SharePointVersion = Shapes::StringShape.new(name: 'SharePointVersion')
|
261
|
+
SharedDriveId = Shapes::StringShape.new(name: 'SharedDriveId')
|
244
262
|
SortOrder = Shapes::StringShape.new(name: 'SortOrder')
|
245
263
|
SortingConfiguration = Shapes::StructureShape.new(name: 'SortingConfiguration')
|
246
264
|
SqlConfiguration = Shapes::StructureShape.new(name: 'SqlConfiguration')
|
@@ -263,6 +281,11 @@ module Aws::Kendra
|
|
263
281
|
TenantDomain = Shapes::StringShape.new(name: 'TenantDomain')
|
264
282
|
TextDocumentStatistics = Shapes::StructureShape.new(name: 'TextDocumentStatistics')
|
265
283
|
TextWithHighlights = Shapes::StructureShape.new(name: 'TextWithHighlights')
|
284
|
+
ThesaurusId = Shapes::StringShape.new(name: 'ThesaurusId')
|
285
|
+
ThesaurusName = Shapes::StringShape.new(name: 'ThesaurusName')
|
286
|
+
ThesaurusStatus = Shapes::StringShape.new(name: 'ThesaurusStatus')
|
287
|
+
ThesaurusSummary = Shapes::StructureShape.new(name: 'ThesaurusSummary')
|
288
|
+
ThesaurusSummaryItems = Shapes::ListShape.new(name: 'ThesaurusSummaryItems')
|
266
289
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
267
290
|
TimeRange = Shapes::StructureShape.new(name: 'TimeRange')
|
268
291
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
@@ -272,7 +295,9 @@ module Aws::Kendra
|
|
272
295
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
273
296
|
UpdateDataSourceRequest = Shapes::StructureShape.new(name: 'UpdateDataSourceRequest')
|
274
297
|
UpdateIndexRequest = Shapes::StructureShape.new(name: 'UpdateIndexRequest')
|
298
|
+
UpdateThesaurusRequest = Shapes::StructureShape.new(name: 'UpdateThesaurusRequest')
|
275
299
|
Url = Shapes::StringShape.new(name: 'Url')
|
300
|
+
UserAccount = Shapes::StringShape.new(name: 'UserAccount')
|
276
301
|
UserContext = Shapes::StructureShape.new(name: 'UserContext')
|
277
302
|
UserContextPolicy = Shapes::StringShape.new(name: 'UserContextPolicy')
|
278
303
|
UserNameAttributeField = Shapes::StringShape.new(name: 'UserNameAttributeField')
|
@@ -281,6 +306,7 @@ module Aws::Kendra
|
|
281
306
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
282
307
|
ValueImportanceMap = Shapes::MapShape.new(name: 'ValueImportanceMap')
|
283
308
|
ValueImportanceMapKey = Shapes::StringShape.new(name: 'ValueImportanceMapKey')
|
309
|
+
VisitorId = Shapes::StringShape.new(name: 'VisitorId')
|
284
310
|
VpcSecurityGroupId = Shapes::StringShape.new(name: 'VpcSecurityGroupId')
|
285
311
|
|
286
312
|
AccessControlListConfiguration.add_member(:key_path, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "KeyPath"))
|
@@ -475,6 +501,18 @@ module Aws::Kendra
|
|
475
501
|
CreateIndexResponse.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, location_name: "Id"))
|
476
502
|
CreateIndexResponse.struct_class = Types::CreateIndexResponse
|
477
503
|
|
504
|
+
CreateThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
505
|
+
CreateThesaurusRequest.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, required: true, location_name: "Name"))
|
506
|
+
CreateThesaurusRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
507
|
+
CreateThesaurusRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
508
|
+
CreateThesaurusRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
509
|
+
CreateThesaurusRequest.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "SourceS3Path"))
|
510
|
+
CreateThesaurusRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
511
|
+
CreateThesaurusRequest.struct_class = Types::CreateThesaurusRequest
|
512
|
+
|
513
|
+
CreateThesaurusResponse.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
514
|
+
CreateThesaurusResponse.struct_class = Types::CreateThesaurusResponse
|
515
|
+
|
478
516
|
DataSourceConfiguration.add_member(:s3_configuration, Shapes::ShapeRef.new(shape: S3DataSourceConfiguration, location_name: "S3Configuration"))
|
479
517
|
DataSourceConfiguration.add_member(:share_point_configuration, Shapes::ShapeRef.new(shape: SharePointConfiguration, location_name: "SharePointConfiguration"))
|
480
518
|
DataSourceConfiguration.add_member(:database_configuration, Shapes::ShapeRef.new(shape: DatabaseConfiguration, location_name: "DatabaseConfiguration"))
|
@@ -482,6 +520,7 @@ module Aws::Kendra
|
|
482
520
|
DataSourceConfiguration.add_member(:one_drive_configuration, Shapes::ShapeRef.new(shape: OneDriveConfiguration, location_name: "OneDriveConfiguration"))
|
483
521
|
DataSourceConfiguration.add_member(:service_now_configuration, Shapes::ShapeRef.new(shape: ServiceNowConfiguration, location_name: "ServiceNowConfiguration"))
|
484
522
|
DataSourceConfiguration.add_member(:confluence_configuration, Shapes::ShapeRef.new(shape: ConfluenceConfiguration, location_name: "ConfluenceConfiguration"))
|
523
|
+
DataSourceConfiguration.add_member(:google_drive_configuration, Shapes::ShapeRef.new(shape: GoogleDriveConfiguration, location_name: "GoogleDriveConfiguration"))
|
485
524
|
DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
|
486
525
|
|
487
526
|
DataSourceInclusionsExclusionsStrings.member = Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStringsMember)
|
@@ -549,6 +588,10 @@ module Aws::Kendra
|
|
549
588
|
DeleteIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
550
589
|
DeleteIndexRequest.struct_class = Types::DeleteIndexRequest
|
551
590
|
|
591
|
+
DeleteThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
592
|
+
DeleteThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
593
|
+
DeleteThesaurusRequest.struct_class = Types::DeleteThesaurusRequest
|
594
|
+
|
552
595
|
DescribeDataSourceRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
553
596
|
DescribeDataSourceRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
554
597
|
DescribeDataSourceRequest.struct_class = Types::DescribeDataSourceRequest
|
@@ -604,6 +647,25 @@ module Aws::Kendra
|
|
604
647
|
DescribeIndexResponse.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
605
648
|
DescribeIndexResponse.struct_class = Types::DescribeIndexResponse
|
606
649
|
|
650
|
+
DescribeThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
651
|
+
DescribeThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
652
|
+
DescribeThesaurusRequest.struct_class = Types::DescribeThesaurusRequest
|
653
|
+
|
654
|
+
DescribeThesaurusResponse.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
655
|
+
DescribeThesaurusResponse.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, location_name: "IndexId"))
|
656
|
+
DescribeThesaurusResponse.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
657
|
+
DescribeThesaurusResponse.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
658
|
+
DescribeThesaurusResponse.add_member(:status, Shapes::ShapeRef.new(shape: ThesaurusStatus, location_name: "Status"))
|
659
|
+
DescribeThesaurusResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
660
|
+
DescribeThesaurusResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
661
|
+
DescribeThesaurusResponse.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
662
|
+
DescribeThesaurusResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
663
|
+
DescribeThesaurusResponse.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, location_name: "SourceS3Path"))
|
664
|
+
DescribeThesaurusResponse.add_member(:file_size_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "FileSizeBytes"))
|
665
|
+
DescribeThesaurusResponse.add_member(:term_count, Shapes::ShapeRef.new(shape: Long, location_name: "TermCount"))
|
666
|
+
DescribeThesaurusResponse.add_member(:synonym_rule_count, Shapes::ShapeRef.new(shape: Long, location_name: "SynonymRuleCount"))
|
667
|
+
DescribeThesaurusResponse.struct_class = Types::DescribeThesaurusResponse
|
668
|
+
|
607
669
|
Document.add_member(:id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location_name: "Id"))
|
608
670
|
Document.add_member(:title, Shapes::ShapeRef.new(shape: Title, location_name: "Title"))
|
609
671
|
Document.add_member(:blob, Shapes::ShapeRef.new(shape: Blob, location_name: "Blob"))
|
@@ -650,6 +712,12 @@ module Aws::Kendra
|
|
650
712
|
DocumentsMetadataConfiguration.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "S3Prefix"))
|
651
713
|
DocumentsMetadataConfiguration.struct_class = Types::DocumentsMetadataConfiguration
|
652
714
|
|
715
|
+
ExcludeMimeTypesList.member = Shapes::ShapeRef.new(shape: MimeType)
|
716
|
+
|
717
|
+
ExcludeSharedDrivesList.member = Shapes::ShapeRef.new(shape: SharedDriveId)
|
718
|
+
|
719
|
+
ExcludeUserAccountsList.member = Shapes::ShapeRef.new(shape: UserAccount)
|
720
|
+
|
653
721
|
Facet.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, location_name: "DocumentAttributeKey"))
|
654
722
|
Facet.struct_class = Types::Facet
|
655
723
|
|
@@ -675,9 +743,19 @@ module Aws::Kendra
|
|
675
743
|
|
676
744
|
FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
|
677
745
|
|
746
|
+
GoogleDriveConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
|
747
|
+
GoogleDriveConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
748
|
+
GoogleDriveConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
749
|
+
GoogleDriveConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings"))
|
750
|
+
GoogleDriveConfiguration.add_member(:exclude_mime_types, Shapes::ShapeRef.new(shape: ExcludeMimeTypesList, location_name: "ExcludeMimeTypes"))
|
751
|
+
GoogleDriveConfiguration.add_member(:exclude_user_accounts, Shapes::ShapeRef.new(shape: ExcludeUserAccountsList, location_name: "ExcludeUserAccounts"))
|
752
|
+
GoogleDriveConfiguration.add_member(:exclude_shared_drives, Shapes::ShapeRef.new(shape: ExcludeSharedDrivesList, location_name: "ExcludeSharedDrives"))
|
753
|
+
GoogleDriveConfiguration.struct_class = Types::GoogleDriveConfiguration
|
754
|
+
|
678
755
|
Highlight.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "BeginOffset"))
|
679
756
|
Highlight.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "EndOffset"))
|
680
757
|
Highlight.add_member(:top_answer, Shapes::ShapeRef.new(shape: Boolean, location_name: "TopAnswer"))
|
758
|
+
Highlight.add_member(:type, Shapes::ShapeRef.new(shape: HighlightType, location_name: "Type"))
|
681
759
|
Highlight.struct_class = Types::Highlight
|
682
760
|
|
683
761
|
HighlightList.member = Shapes::ShapeRef.new(shape: Highlight)
|
@@ -756,6 +834,15 @@ module Aws::Kendra
|
|
756
834
|
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
757
835
|
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
758
836
|
|
837
|
+
ListThesauriRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
838
|
+
ListThesauriRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
839
|
+
ListThesauriRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsIntegerForListThesauriRequest, location_name: "MaxResults"))
|
840
|
+
ListThesauriRequest.struct_class = Types::ListThesauriRequest
|
841
|
+
|
842
|
+
ListThesauriResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
843
|
+
ListThesauriResponse.add_member(:thesaurus_summary_items, Shapes::ShapeRef.new(shape: ThesaurusSummaryItems, location_name: "ThesaurusSummaryItems"))
|
844
|
+
ListThesauriResponse.struct_class = Types::ListThesauriResponse
|
845
|
+
|
759
846
|
OneDriveConfiguration.add_member(:tenant_domain, Shapes::ShapeRef.new(shape: TenantDomain, required: true, location_name: "TenantDomain"))
|
760
847
|
OneDriveConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
|
761
848
|
OneDriveConfiguration.add_member(:one_drive_users, Shapes::ShapeRef.new(shape: OneDriveUsers, required: true, location_name: "OneDriveUsers"))
|
@@ -788,6 +875,7 @@ module Aws::Kendra
|
|
788
875
|
QueryRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
|
789
876
|
QueryRequest.add_member(:sorting_configuration, Shapes::ShapeRef.new(shape: SortingConfiguration, location_name: "SortingConfiguration"))
|
790
877
|
QueryRequest.add_member(:user_context, Shapes::ShapeRef.new(shape: UserContext, location_name: "UserContext"))
|
878
|
+
QueryRequest.add_member(:visitor_id, Shapes::ShapeRef.new(shape: VisitorId, location_name: "VisitorId"))
|
791
879
|
QueryRequest.struct_class = Types::QueryRequest
|
792
880
|
|
793
881
|
QueryResult.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, location_name: "QueryId"))
|
@@ -805,6 +893,7 @@ module Aws::Kendra
|
|
805
893
|
QueryResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
|
806
894
|
QueryResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
|
807
895
|
QueryResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
|
896
|
+
QueryResultItem.add_member(:feedback_token, Shapes::ShapeRef.new(shape: FeedbackToken, location_name: "FeedbackToken"))
|
808
897
|
QueryResultItem.struct_class = Types::QueryResultItem
|
809
898
|
|
810
899
|
QueryResultItemList.member = Shapes::ShapeRef.new(shape: QueryResultItem)
|
@@ -916,6 +1005,7 @@ module Aws::Kendra
|
|
916
1005
|
ServiceNowConfiguration.add_member(:service_now_build_version, Shapes::ShapeRef.new(shape: ServiceNowBuildVersionType, required: true, location_name: "ServiceNowBuildVersion"))
|
917
1006
|
ServiceNowConfiguration.add_member(:knowledge_article_configuration, Shapes::ShapeRef.new(shape: ServiceNowKnowledgeArticleConfiguration, location_name: "KnowledgeArticleConfiguration"))
|
918
1007
|
ServiceNowConfiguration.add_member(:service_catalog_configuration, Shapes::ShapeRef.new(shape: ServiceNowServiceCatalogConfiguration, location_name: "ServiceCatalogConfiguration"))
|
1008
|
+
ServiceNowConfiguration.add_member(:authentication_type, Shapes::ShapeRef.new(shape: ServiceNowAuthenticationType, location_name: "AuthenticationType"))
|
919
1009
|
ServiceNowConfiguration.struct_class = Types::ServiceNowConfiguration
|
920
1010
|
|
921
1011
|
ServiceNowKnowledgeArticleConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
|
@@ -924,6 +1014,7 @@ module Aws::Kendra
|
|
924
1014
|
ServiceNowKnowledgeArticleConfiguration.add_member(:document_data_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, required: true, location_name: "DocumentDataFieldName"))
|
925
1015
|
ServiceNowKnowledgeArticleConfiguration.add_member(:document_title_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, location_name: "DocumentTitleFieldName"))
|
926
1016
|
ServiceNowKnowledgeArticleConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings"))
|
1017
|
+
ServiceNowKnowledgeArticleConfiguration.add_member(:filter_query, Shapes::ShapeRef.new(shape: ServiceNowKnowledgeArticleFilterQuery, location_name: "FilterQuery"))
|
927
1018
|
ServiceNowKnowledgeArticleConfiguration.struct_class = Types::ServiceNowKnowledgeArticleConfiguration
|
928
1019
|
|
929
1020
|
ServiceNowServiceCatalogConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
|
@@ -1000,6 +1091,15 @@ module Aws::Kendra
|
|
1000
1091
|
TextWithHighlights.add_member(:highlights, Shapes::ShapeRef.new(shape: HighlightList, location_name: "Highlights"))
|
1001
1092
|
TextWithHighlights.struct_class = Types::TextWithHighlights
|
1002
1093
|
|
1094
|
+
ThesaurusSummary.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, location_name: "Id"))
|
1095
|
+
ThesaurusSummary.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
1096
|
+
ThesaurusSummary.add_member(:status, Shapes::ShapeRef.new(shape: ThesaurusStatus, location_name: "Status"))
|
1097
|
+
ThesaurusSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
1098
|
+
ThesaurusSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
1099
|
+
ThesaurusSummary.struct_class = Types::ThesaurusSummary
|
1100
|
+
|
1101
|
+
ThesaurusSummaryItems.member = Shapes::ShapeRef.new(shape: ThesaurusSummary)
|
1102
|
+
|
1003
1103
|
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
1004
1104
|
ThrottlingException.struct_class = Types::ThrottlingException
|
1005
1105
|
|
@@ -1032,6 +1132,14 @@ module Aws::Kendra
|
|
1032
1132
|
UpdateIndexRequest.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
1033
1133
|
UpdateIndexRequest.struct_class = Types::UpdateIndexRequest
|
1034
1134
|
|
1135
|
+
UpdateThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
|
1136
|
+
UpdateThesaurusRequest.add_member(:name, Shapes::ShapeRef.new(shape: ThesaurusName, location_name: "Name"))
|
1137
|
+
UpdateThesaurusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
1138
|
+
UpdateThesaurusRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
1139
|
+
UpdateThesaurusRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
1140
|
+
UpdateThesaurusRequest.add_member(:source_s3_path, Shapes::ShapeRef.new(shape: S3Path, location_name: "SourceS3Path"))
|
1141
|
+
UpdateThesaurusRequest.struct_class = Types::UpdateThesaurusRequest
|
1142
|
+
|
1035
1143
|
UserContext.add_member(:token, Shapes::ShapeRef.new(shape: Token, location_name: "Token"))
|
1036
1144
|
UserContext.struct_class = Types::UserContext
|
1037
1145
|
|
@@ -1142,6 +1250,21 @@ module Aws::Kendra
|
|
1142
1250
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1143
1251
|
end)
|
1144
1252
|
|
1253
|
+
api.add_operation(:create_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1254
|
+
o.name = "CreateThesaurus"
|
1255
|
+
o.http_method = "POST"
|
1256
|
+
o.http_request_uri = "/"
|
1257
|
+
o.input = Shapes::ShapeRef.new(shape: CreateThesaurusRequest)
|
1258
|
+
o.output = Shapes::ShapeRef.new(shape: CreateThesaurusResponse)
|
1259
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1260
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1261
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1262
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1263
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1264
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1265
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1266
|
+
end)
|
1267
|
+
|
1145
1268
|
api.add_operation(:delete_data_source, Seahorse::Model::Operation.new.tap do |o|
|
1146
1269
|
o.name = "DeleteDataSource"
|
1147
1270
|
o.http_method = "POST"
|
@@ -1184,6 +1307,20 @@ module Aws::Kendra
|
|
1184
1307
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1185
1308
|
end)
|
1186
1309
|
|
1310
|
+
api.add_operation(:delete_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1311
|
+
o.name = "DeleteThesaurus"
|
1312
|
+
o.http_method = "POST"
|
1313
|
+
o.http_request_uri = "/"
|
1314
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteThesaurusRequest)
|
1315
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1316
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1317
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1318
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1319
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1320
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1321
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1322
|
+
end)
|
1323
|
+
|
1187
1324
|
api.add_operation(:describe_data_source, Seahorse::Model::Operation.new.tap do |o|
|
1188
1325
|
o.name = "DescribeDataSource"
|
1189
1326
|
o.http_method = "POST"
|
@@ -1223,6 +1360,19 @@ module Aws::Kendra
|
|
1223
1360
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1224
1361
|
end)
|
1225
1362
|
|
1363
|
+
api.add_operation(:describe_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1364
|
+
o.name = "DescribeThesaurus"
|
1365
|
+
o.http_method = "POST"
|
1366
|
+
o.http_request_uri = "/"
|
1367
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeThesaurusRequest)
|
1368
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeThesaurusResponse)
|
1369
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1370
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1371
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1372
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1373
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1374
|
+
end)
|
1375
|
+
|
1226
1376
|
api.add_operation(:list_data_source_sync_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1227
1377
|
o.name = "ListDataSourceSyncJobs"
|
1228
1378
|
o.http_method = "POST"
|
@@ -1306,6 +1456,19 @@ module Aws::Kendra
|
|
1306
1456
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1307
1457
|
end)
|
1308
1458
|
|
1459
|
+
api.add_operation(:list_thesauri, Seahorse::Model::Operation.new.tap do |o|
|
1460
|
+
o.name = "ListThesauri"
|
1461
|
+
o.http_method = "POST"
|
1462
|
+
o.http_request_uri = "/"
|
1463
|
+
o.input = Shapes::ShapeRef.new(shape: ListThesauriRequest)
|
1464
|
+
o.output = Shapes::ShapeRef.new(shape: ListThesauriResponse)
|
1465
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1466
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1467
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1468
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1469
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1470
|
+
end)
|
1471
|
+
|
1309
1472
|
api.add_operation(:query, Seahorse::Model::Operation.new.tap do |o|
|
1310
1473
|
o.name = "Query"
|
1311
1474
|
o.http_method = "POST"
|
@@ -1417,6 +1580,20 @@ module Aws::Kendra
|
|
1417
1580
|
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
1418
1581
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1419
1582
|
end)
|
1583
|
+
|
1584
|
+
api.add_operation(:update_thesaurus, Seahorse::Model::Operation.new.tap do |o|
|
1585
|
+
o.name = "UpdateThesaurus"
|
1586
|
+
o.http_method = "POST"
|
1587
|
+
o.http_request_uri = "/"
|
1588
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateThesaurusRequest)
|
1589
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1590
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1591
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1592
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1593
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1594
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1595
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1596
|
+
end)
|
1420
1597
|
end
|
1421
1598
|
|
1422
1599
|
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,14 +3,19 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
10
|
module Aws::Kendra
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Access Control List files for the documents in a data source.
|
13
|
+
# Access Control List files for the documents in a data source. For the
|
14
|
+
# format of the file, see [Access control for S3 data sources][1].
|
15
|
+
#
|
16
|
+
#
|
17
|
+
#
|
18
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html
|
14
19
|
#
|
15
20
|
# @note When making an API call, you may pass AccessControlListConfiguration
|
16
21
|
# data as a hash:
|
@@ -56,7 +61,7 @@ module Aws::Kendra
|
|
56
61
|
# A list of groups, separated by semi-colons, that filters a query
|
57
62
|
# response based on user context. The document is only returned to
|
58
63
|
# users that are in one of the groups specified in the `UserContext`
|
59
|
-
# field of the Query operation.
|
64
|
+
# field of the `Query` operation.
|
60
65
|
# @return [String]
|
61
66
|
#
|
62
67
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
|
@@ -536,7 +541,7 @@ module Aws::Kendra
|
|
536
541
|
end
|
537
542
|
|
538
543
|
# Provides information about documents that could not be removed from an
|
539
|
-
# index by the BatchDeleteDocument operation.
|
544
|
+
# index by the `BatchDeleteDocument` operation.
|
540
545
|
#
|
541
546
|
# @!attribute [rw] id
|
542
547
|
# The identifier of the document that couldn't be removed from the
|
@@ -603,7 +608,7 @@ module Aws::Kendra
|
|
603
608
|
#
|
604
609
|
# @!attribute [rw] index_id
|
605
610
|
# The identifier of the index to add the documents to. You need to
|
606
|
-
# create the index first using the CreateIndex operation.
|
611
|
+
# create the index first using the `CreateIndex` operation.
|
607
612
|
# @return [String]
|
608
613
|
#
|
609
614
|
# @!attribute [rw] role_arn
|
@@ -724,7 +729,7 @@ module Aws::Kendra
|
|
724
729
|
end
|
725
730
|
|
726
731
|
# Gathers information about when a particular result was clicked by a
|
727
|
-
# user. Your application uses the SubmitFeedback operation to provide
|
732
|
+
# user. Your application uses the `SubmitFeedback` operation to provide
|
728
733
|
# click information.
|
729
734
|
#
|
730
735
|
# @note When making an API call, you may pass ClickFeedback
|
@@ -787,7 +792,7 @@ module Aws::Kendra
|
|
787
792
|
# @!attribute [rw] field_mappings
|
788
793
|
# An array of objects that map database column names to the
|
789
794
|
# corresponding fields in an index. You must first create the fields
|
790
|
-
# in the index using the UpdateIndex operation.
|
795
|
+
# in the index using the `UpdateIndex` operation.
|
791
796
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
792
797
|
#
|
793
798
|
# @!attribute [rw] change_detecting_columns
|
@@ -863,7 +868,8 @@ module Aws::Kendra
|
|
863
868
|
# Defines the mapping between a field in the Confluence data source to a
|
864
869
|
# Amazon Kendra index field.
|
865
870
|
#
|
866
|
-
# You must first create the index field using the
|
871
|
+
# You must first create the index field using the `UpdateIndex`
|
872
|
+
# operation.
|
867
873
|
#
|
868
874
|
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
869
875
|
# data as a hash:
|
@@ -877,7 +883,8 @@ module Aws::Kendra
|
|
877
883
|
# @!attribute [rw] data_source_field_name
|
878
884
|
# The name of the field in the data source.
|
879
885
|
#
|
880
|
-
# You must first create the index field using the
|
886
|
+
# You must first create the index field using the `UpdateIndex`
|
887
|
+
# operation.
|
881
888
|
# @return [String]
|
882
889
|
#
|
883
890
|
# @!attribute [rw] date_field_format
|
@@ -904,7 +911,8 @@ module Aws::Kendra
|
|
904
911
|
|
905
912
|
# Specifies the blog settings for the Confluence data source. Blogs are
|
906
913
|
# always indexed unless filtered from the index by the
|
907
|
-
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
914
|
+
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
915
|
+
# `ConfluenceConfiguration` type.
|
908
916
|
#
|
909
917
|
# @note When making an API call, you may pass ConfluenceBlogConfiguration
|
910
918
|
# data as a hash:
|
@@ -940,7 +948,8 @@ module Aws::Kendra
|
|
940
948
|
# Defines the mapping between a blog field in the Confluence data source
|
941
949
|
# to a Amazon Kendra index field.
|
942
950
|
#
|
943
|
-
# You must first create the index field using the
|
951
|
+
# You must first create the index field using the `UpdateIndex`
|
952
|
+
# operation.
|
944
953
|
#
|
945
954
|
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
946
955
|
# data as a hash:
|
@@ -1153,7 +1162,8 @@ module Aws::Kendra
|
|
1153
1162
|
# Defines the mapping between a field in the Confluence data source to a
|
1154
1163
|
# Amazon Kendra index field.
|
1155
1164
|
#
|
1156
|
-
# You must first create the index field using the
|
1165
|
+
# You must first create the index field using the `UpdateIndex`
|
1166
|
+
# operation.
|
1157
1167
|
#
|
1158
1168
|
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
1159
1169
|
# data as a hash:
|
@@ -1266,7 +1276,8 @@ module Aws::Kendra
|
|
1266
1276
|
# Defines the mapping between a field in the Confluence data source to a
|
1267
1277
|
# Amazon Kendra index field.
|
1268
1278
|
#
|
1269
|
-
# You must first create the index field using the
|
1279
|
+
# You must first create the index field using the `UpdateIndex`
|
1280
|
+
# operation.
|
1270
1281
|
#
|
1271
1282
|
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
1272
1283
|
# data as a hash:
|
@@ -1364,7 +1375,7 @@ module Aws::Kendra
|
|
1364
1375
|
# {
|
1365
1376
|
# name: "DataSourceName", # required
|
1366
1377
|
# index_id: "IndexId", # required
|
1367
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE
|
1378
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
|
1368
1379
|
# configuration: {
|
1369
1380
|
# s3_configuration: {
|
1370
1381
|
# bucket_name: "S3BucketName", # required
|
@@ -1542,6 +1553,7 @@ module Aws::Kendra
|
|
1542
1553
|
# index_field_name: "IndexFieldName", # required
|
1543
1554
|
# },
|
1544
1555
|
# ],
|
1556
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
1545
1557
|
# },
|
1546
1558
|
# service_catalog_configuration: {
|
1547
1559
|
# crawl_attachments: false,
|
@@ -1557,6 +1569,7 @@ module Aws::Kendra
|
|
1557
1569
|
# },
|
1558
1570
|
# ],
|
1559
1571
|
# },
|
1572
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
1560
1573
|
# },
|
1561
1574
|
# confluence_configuration: {
|
1562
1575
|
# server_url: "Url", # required
|
@@ -1610,6 +1623,21 @@ module Aws::Kendra
|
|
1610
1623
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1611
1624
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1612
1625
|
# },
|
1626
|
+
# google_drive_configuration: {
|
1627
|
+
# secret_arn: "SecretArn", # required
|
1628
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1629
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1630
|
+
# field_mappings: [
|
1631
|
+
# {
|
1632
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1633
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1634
|
+
# index_field_name: "IndexFieldName", # required
|
1635
|
+
# },
|
1636
|
+
# ],
|
1637
|
+
# exclude_mime_types: ["MimeType"],
|
1638
|
+
# exclude_user_accounts: ["UserAccount"],
|
1639
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
1640
|
+
# },
|
1613
1641
|
# },
|
1614
1642
|
# description: "Description",
|
1615
1643
|
# schedule: "ScanSchedule",
|
@@ -1963,6 +1991,90 @@ module Aws::Kendra
|
|
1963
1991
|
include Aws::Structure
|
1964
1992
|
end
|
1965
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
|
+
|
1966
2078
|
# Configuration information for a Amazon Kendra data source.
|
1967
2079
|
#
|
1968
2080
|
# @note When making an API call, you may pass DataSourceConfiguration
|
@@ -2145,6 +2257,7 @@ module Aws::Kendra
|
|
2145
2257
|
# index_field_name: "IndexFieldName", # required
|
2146
2258
|
# },
|
2147
2259
|
# ],
|
2260
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
2148
2261
|
# },
|
2149
2262
|
# service_catalog_configuration: {
|
2150
2263
|
# crawl_attachments: false,
|
@@ -2160,6 +2273,7 @@ module Aws::Kendra
|
|
2160
2273
|
# },
|
2161
2274
|
# ],
|
2162
2275
|
# },
|
2276
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
2163
2277
|
# },
|
2164
2278
|
# confluence_configuration: {
|
2165
2279
|
# server_url: "Url", # required
|
@@ -2213,6 +2327,21 @@ module Aws::Kendra
|
|
2213
2327
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2214
2328
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2215
2329
|
# },
|
2330
|
+
# google_drive_configuration: {
|
2331
|
+
# secret_arn: "SecretArn", # required
|
2332
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2333
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2334
|
+
# field_mappings: [
|
2335
|
+
# {
|
2336
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2337
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2338
|
+
# index_field_name: "IndexFieldName", # required
|
2339
|
+
# },
|
2340
|
+
# ],
|
2341
|
+
# exclude_mime_types: ["MimeType"],
|
2342
|
+
# exclude_user_accounts: ["UserAccount"],
|
2343
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
2344
|
+
# },
|
2216
2345
|
# }
|
2217
2346
|
#
|
2218
2347
|
# @!attribute [rw] s3_configuration
|
@@ -2236,7 +2365,7 @@ module Aws::Kendra
|
|
2236
2365
|
# @return [Types::SalesforceConfiguration]
|
2237
2366
|
#
|
2238
2367
|
# @!attribute [rw] one_drive_configuration
|
2239
|
-
#
|
2368
|
+
# Provides configuration for data sources that connect to Microsoft
|
2240
2369
|
# OneDrive.
|
2241
2370
|
# @return [Types::OneDriveConfiguration]
|
2242
2371
|
#
|
@@ -2250,6 +2379,11 @@ module Aws::Kendra
|
|
2250
2379
|
# data source.
|
2251
2380
|
# @return [Types::ConfluenceConfiguration]
|
2252
2381
|
#
|
2382
|
+
# @!attribute [rw] google_drive_configuration
|
2383
|
+
# Provides configuration for data sources that connect to Google
|
2384
|
+
# Drive.
|
2385
|
+
# @return [Types::GoogleDriveConfiguration]
|
2386
|
+
#
|
2253
2387
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
2254
2388
|
#
|
2255
2389
|
class DataSourceConfiguration < Struct.new(
|
@@ -2259,13 +2393,14 @@ module Aws::Kendra
|
|
2259
2393
|
:salesforce_configuration,
|
2260
2394
|
:one_drive_configuration,
|
2261
2395
|
:service_now_configuration,
|
2262
|
-
:confluence_configuration
|
2396
|
+
:confluence_configuration,
|
2397
|
+
:google_drive_configuration)
|
2263
2398
|
SENSITIVE = []
|
2264
2399
|
include Aws::Structure
|
2265
2400
|
end
|
2266
2401
|
|
2267
2402
|
# Summary information for a Amazon Kendra data source. Returned in a
|
2268
|
-
# call to .
|
2403
|
+
# call to the `DescribeDataSource` operation.
|
2269
2404
|
#
|
2270
2405
|
# @!attribute [rw] name
|
2271
2406
|
# The name of the data source.
|
@@ -2288,7 +2423,7 @@ module Aws::Kendra
|
|
2288
2423
|
# @return [Time]
|
2289
2424
|
#
|
2290
2425
|
# @!attribute [rw] status
|
2291
|
-
# The status of the data source. When the status is `
|
2426
|
+
# The status of the data source. When the status is `ACTIVE` the data
|
2292
2427
|
# source is ready to use.
|
2293
2428
|
# @return [String]
|
2294
2429
|
#
|
@@ -2433,7 +2568,7 @@ module Aws::Kendra
|
|
2433
2568
|
end
|
2434
2569
|
|
2435
2570
|
# Maps a column or attribute in the data source to an index field. You
|
2436
|
-
# must first create the fields in the index using the UpdateIndex
|
2571
|
+
# must first create the fields in the index using the `UpdateIndex`
|
2437
2572
|
# operation.
|
2438
2573
|
#
|
2439
2574
|
# @note When making an API call, you may pass DataSourceToIndexFieldMapping
|
@@ -2646,6 +2781,31 @@ module Aws::Kendra
|
|
2646
2781
|
include Aws::Structure
|
2647
2782
|
end
|
2648
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
|
+
|
2649
2809
|
# @note When making an API call, you may pass DescribeDataSourceRequest
|
2650
2810
|
# data as a hash:
|
2651
2811
|
#
|
@@ -2860,7 +3020,7 @@ module Aws::Kendra
|
|
2860
3020
|
# @return [String]
|
2861
3021
|
#
|
2862
3022
|
# @!attribute [rw] id
|
2863
|
-
#
|
3023
|
+
# The name of the index.
|
2864
3024
|
# @return [String]
|
2865
3025
|
#
|
2866
3026
|
# @!attribute [rw] edition
|
@@ -2912,7 +3072,7 @@ module Aws::Kendra
|
|
2912
3072
|
# @return [String]
|
2913
3073
|
#
|
2914
3074
|
# @!attribute [rw] capacity_units
|
2915
|
-
# For
|
3075
|
+
# For Enterprise edition indexes, you can choose to use additional
|
2916
3076
|
# capacity to meet the needs of your application. This contains the
|
2917
3077
|
# capacity units used for the index. A 0 for the query capacity or the
|
2918
3078
|
# storage capacity indicates that the index is using the default
|
@@ -2949,6 +3109,115 @@ module Aws::Kendra
|
|
2949
3109
|
include Aws::Structure
|
2950
3110
|
end
|
2951
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
|
+
|
2952
3221
|
# A document in an index.
|
2953
3222
|
#
|
2954
3223
|
# @note When making an API call, you may pass Document
|
@@ -3313,6 +3582,103 @@ module Aws::Kendra
|
|
3313
3582
|
include Aws::Structure
|
3314
3583
|
end
|
3315
3584
|
|
3585
|
+
# Provides configuration information for data sources that connect to
|
3586
|
+
# Google Drive.
|
3587
|
+
#
|
3588
|
+
# @note When making an API call, you may pass GoogleDriveConfiguration
|
3589
|
+
# data as a hash:
|
3590
|
+
#
|
3591
|
+
# {
|
3592
|
+
# secret_arn: "SecretArn", # required
|
3593
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3594
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3595
|
+
# field_mappings: [
|
3596
|
+
# {
|
3597
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3598
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3599
|
+
# index_field_name: "IndexFieldName", # required
|
3600
|
+
# },
|
3601
|
+
# ],
|
3602
|
+
# exclude_mime_types: ["MimeType"],
|
3603
|
+
# exclude_user_accounts: ["UserAccount"],
|
3604
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
3605
|
+
# }
|
3606
|
+
#
|
3607
|
+
# @!attribute [rw] secret_arn
|
3608
|
+
# The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that
|
3609
|
+
# contains the credentials required to connect to Google Drive. For
|
3610
|
+
# more information, see [Using a Google Workspace Drive data
|
3611
|
+
# source][1].
|
3612
|
+
#
|
3613
|
+
#
|
3614
|
+
#
|
3615
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html
|
3616
|
+
# @return [String]
|
3617
|
+
#
|
3618
|
+
# @!attribute [rw] inclusion_patterns
|
3619
|
+
# A list of regular expression patterns that apply to path on Google
|
3620
|
+
# Drive. Items that match the pattern are included in the index from
|
3621
|
+
# both shared drives and users' My Drives. Items that don't match
|
3622
|
+
# the pattern are excluded from the index. If an item matches both an
|
3623
|
+
# inclusion pattern and an exclusion pattern, it is excluded from the
|
3624
|
+
# index.
|
3625
|
+
# @return [Array<String>]
|
3626
|
+
#
|
3627
|
+
# @!attribute [rw] exclusion_patterns
|
3628
|
+
# A list of regular expression patterns that apply to the path on
|
3629
|
+
# Google Drive. Items that match the pattern are excluded from the
|
3630
|
+
# index from both shared drives and users' My Drives. Items that
|
3631
|
+
# don't match the pattern are included in the index. If an item
|
3632
|
+
# matches both an exclusion pattern and an inclusion pattern, it is
|
3633
|
+
# excluded from the index.
|
3634
|
+
# @return [Array<String>]
|
3635
|
+
#
|
3636
|
+
# @!attribute [rw] field_mappings
|
3637
|
+
# Defines mapping between a field in the Google Drive and a Amazon
|
3638
|
+
# Kendra index field.
|
3639
|
+
#
|
3640
|
+
# If you are using the console, you can define index fields when
|
3641
|
+
# creating the mapping. If you are using the API, you must first
|
3642
|
+
# create the field using the `UpdateIndex` operation.
|
3643
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3644
|
+
#
|
3645
|
+
# @!attribute [rw] exclude_mime_types
|
3646
|
+
# A list of MIME types to exclude from the index. All documents
|
3647
|
+
# matching the specified MIME type are excluded.
|
3648
|
+
#
|
3649
|
+
# For a list of MIME types, see [Using a Google Workspace Drive data
|
3650
|
+
# source][1].
|
3651
|
+
#
|
3652
|
+
#
|
3653
|
+
#
|
3654
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html
|
3655
|
+
# @return [Array<String>]
|
3656
|
+
#
|
3657
|
+
# @!attribute [rw] exclude_user_accounts
|
3658
|
+
# A list of email addresses of the users. Documents owned by these
|
3659
|
+
# users are excluded from the index. Documents shared with excluded
|
3660
|
+
# users are indexed unless they are excluded in another way.
|
3661
|
+
# @return [Array<String>]
|
3662
|
+
#
|
3663
|
+
# @!attribute [rw] exclude_shared_drives
|
3664
|
+
# A list of identifiers or shared drives to exclude from the index.
|
3665
|
+
# All files and folders stored on the shared drive are excluded.
|
3666
|
+
# @return [Array<String>]
|
3667
|
+
#
|
3668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GoogleDriveConfiguration AWS API Documentation
|
3669
|
+
#
|
3670
|
+
class GoogleDriveConfiguration < Struct.new(
|
3671
|
+
:secret_arn,
|
3672
|
+
:inclusion_patterns,
|
3673
|
+
:exclusion_patterns,
|
3674
|
+
:field_mappings,
|
3675
|
+
:exclude_mime_types,
|
3676
|
+
:exclude_user_accounts,
|
3677
|
+
:exclude_shared_drives)
|
3678
|
+
SENSITIVE = []
|
3679
|
+
include Aws::Structure
|
3680
|
+
end
|
3681
|
+
|
3316
3682
|
# Provides information that you can use to highlight a search result so
|
3317
3683
|
# that your users can quickly identify terms in the response.
|
3318
3684
|
#
|
@@ -3331,12 +3697,17 @@ module Aws::Kendra
|
|
3331
3697
|
# the best response; otherwise, false.
|
3332
3698
|
# @return [Boolean]
|
3333
3699
|
#
|
3700
|
+
# @!attribute [rw] type
|
3701
|
+
# The highlight type.
|
3702
|
+
# @return [String]
|
3703
|
+
#
|
3334
3704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Highlight AWS API Documentation
|
3335
3705
|
#
|
3336
3706
|
class Highlight < Struct.new(
|
3337
3707
|
:begin_offset,
|
3338
3708
|
:end_offset,
|
3339
|
-
:top_answer
|
3709
|
+
:top_answer,
|
3710
|
+
:type)
|
3340
3711
|
SENSITIVE = []
|
3341
3712
|
include Aws::Structure
|
3342
3713
|
end
|
@@ -3767,6 +4138,59 @@ module Aws::Kendra
|
|
3767
4138
|
include Aws::Structure
|
3768
4139
|
end
|
3769
4140
|
|
4141
|
+
# @note When making an API call, you may pass ListThesauriRequest
|
4142
|
+
# data as a hash:
|
4143
|
+
#
|
4144
|
+
# {
|
4145
|
+
# index_id: "IndexId", # required
|
4146
|
+
# next_token: "NextToken",
|
4147
|
+
# max_results: 1,
|
4148
|
+
# }
|
4149
|
+
#
|
4150
|
+
# @!attribute [rw] index_id
|
4151
|
+
# The identifier of the index associated with the thesaurus to list.
|
4152
|
+
# @return [String]
|
4153
|
+
#
|
4154
|
+
# @!attribute [rw] next_token
|
4155
|
+
# If the previous response was incomplete (because there is more data
|
4156
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
4157
|
+
# response. You can use this pagination token to retrieve the next set
|
4158
|
+
# of thesauri (`ThesaurusSummaryItems`).
|
4159
|
+
# @return [String]
|
4160
|
+
#
|
4161
|
+
# @!attribute [rw] max_results
|
4162
|
+
# The maximum number of thesauri to return.
|
4163
|
+
# @return [Integer]
|
4164
|
+
#
|
4165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriRequest AWS API Documentation
|
4166
|
+
#
|
4167
|
+
class ListThesauriRequest < Struct.new(
|
4168
|
+
:index_id,
|
4169
|
+
:next_token,
|
4170
|
+
:max_results)
|
4171
|
+
SENSITIVE = []
|
4172
|
+
include Aws::Structure
|
4173
|
+
end
|
4174
|
+
|
4175
|
+
# @!attribute [rw] next_token
|
4176
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
4177
|
+
# you can use in the subsequent request to retrieve the next set of
|
4178
|
+
# thesauri.
|
4179
|
+
# @return [String]
|
4180
|
+
#
|
4181
|
+
# @!attribute [rw] thesaurus_summary_items
|
4182
|
+
# An array of summary information for one or more thesauruses.
|
4183
|
+
# @return [Array<Types::ThesaurusSummary>]
|
4184
|
+
#
|
4185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriResponse AWS API Documentation
|
4186
|
+
#
|
4187
|
+
class ListThesauriResponse < Struct.new(
|
4188
|
+
:next_token,
|
4189
|
+
:thesaurus_summary_items)
|
4190
|
+
SENSITIVE = []
|
4191
|
+
include Aws::Structure
|
4192
|
+
end
|
4193
|
+
|
3770
4194
|
# Provides configuration information for data sources that connect to
|
3771
4195
|
# OneDrive.
|
3772
4196
|
#
|
@@ -3796,7 +4220,7 @@ module Aws::Kendra
|
|
3796
4220
|
# }
|
3797
4221
|
#
|
3798
4222
|
# @!attribute [rw] tenant_domain
|
3799
|
-
#
|
4223
|
+
# The Azure Active Directory domain of the organization.
|
3800
4224
|
# @return [String]
|
3801
4225
|
#
|
3802
4226
|
# @!attribute [rw] secret_arn
|
@@ -4022,11 +4446,12 @@ module Aws::Kendra
|
|
4022
4446
|
# user_context: {
|
4023
4447
|
# token: "Token",
|
4024
4448
|
# },
|
4449
|
+
# visitor_id: "VisitorId",
|
4025
4450
|
# }
|
4026
4451
|
#
|
4027
4452
|
# @!attribute [rw] index_id
|
4028
4453
|
# The unique identifier of the index to search. The identifier is
|
4029
|
-
# returned in the response from the operation.
|
4454
|
+
# returned in the response from the `CreateIndex` operation.
|
4030
4455
|
# @return [String]
|
4031
4456
|
#
|
4032
4457
|
# @!attribute [rw] query_text
|
@@ -4089,6 +4514,13 @@ module Aws::Kendra
|
|
4089
4514
|
# The user context token.
|
4090
4515
|
# @return [Types::UserContext]
|
4091
4516
|
#
|
4517
|
+
# @!attribute [rw] visitor_id
|
4518
|
+
# Provides an identifier for a specific user. The `VisitorId` should
|
4519
|
+
# be a unique identifier, such as a GUID. Don't use personally
|
4520
|
+
# identifiable information, such as the user's email address, as the
|
4521
|
+
# `VisitorId`.
|
4522
|
+
# @return [String]
|
4523
|
+
#
|
4092
4524
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
4093
4525
|
#
|
4094
4526
|
class QueryRequest < Struct.new(
|
@@ -4101,7 +4533,8 @@ module Aws::Kendra
|
|
4101
4533
|
:page_number,
|
4102
4534
|
:page_size,
|
4103
4535
|
:sorting_configuration,
|
4104
|
-
:user_context
|
4536
|
+
:user_context,
|
4537
|
+
:visitor_id)
|
4105
4538
|
SENSITIVE = []
|
4106
4539
|
include Aws::Structure
|
4107
4540
|
end
|
@@ -4193,6 +4626,16 @@ module Aws::Kendra
|
|
4193
4626
|
# matches the query.
|
4194
4627
|
# @return [Types::ScoreAttributes]
|
4195
4628
|
#
|
4629
|
+
# @!attribute [rw] feedback_token
|
4630
|
+
# A token that identifies a particular result from a particular query.
|
4631
|
+
# Use this token to provide click-through feedback for the result. For
|
4632
|
+
# more information, see [ Submitting feedback ][1].
|
4633
|
+
#
|
4634
|
+
#
|
4635
|
+
#
|
4636
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html
|
4637
|
+
# @return [String]
|
4638
|
+
#
|
4196
4639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
|
4197
4640
|
#
|
4198
4641
|
class QueryResultItem < Struct.new(
|
@@ -4204,7 +4647,8 @@ module Aws::Kendra
|
|
4204
4647
|
:document_excerpt,
|
4205
4648
|
:document_uri,
|
4206
4649
|
:document_attributes,
|
4207
|
-
:score_attributes
|
4650
|
+
:score_attributes,
|
4651
|
+
:feedback_token)
|
4208
4652
|
SENSITIVE = []
|
4209
4653
|
include Aws::Structure
|
4210
4654
|
end
|
@@ -4293,7 +4737,7 @@ module Aws::Kendra
|
|
4293
4737
|
end
|
4294
4738
|
|
4295
4739
|
# Provides feedback on how relevant a document is to a search. Your
|
4296
|
-
# application uses the SubmitFeedback operation to provide relevance
|
4740
|
+
# application uses the `SubmitFeedback` operation to provide relevance
|
4297
4741
|
# information.
|
4298
4742
|
#
|
4299
4743
|
# @note When making an API call, you may pass RelevanceFeedback
|
@@ -4429,7 +4873,12 @@ module Aws::Kendra
|
|
4429
4873
|
#
|
4430
4874
|
# @!attribute [rw] access_control_list_configuration
|
4431
4875
|
# Provides the path to the S3 bucket that contains the user context
|
4432
|
-
# filtering files for the data source.
|
4876
|
+
# filtering files for the data source. For the format of the file, see
|
4877
|
+
# [Access control for S3 data sources][1].
|
4878
|
+
#
|
4879
|
+
#
|
4880
|
+
#
|
4881
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html
|
4433
4882
|
# @return [Types::AccessControlListConfiguration]
|
4434
4883
|
#
|
4435
4884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3DataSourceConfiguration AWS API Documentation
|
@@ -4639,7 +5088,7 @@ module Aws::Kendra
|
|
4639
5088
|
# @return [Array<Types::SalesforceStandardObjectConfiguration>]
|
4640
5089
|
#
|
4641
5090
|
# @!attribute [rw] knowledge_article_configuration
|
4642
|
-
# Specifies configuration information for the
|
5091
|
+
# Specifies configuration information for the knowledge article types
|
4643
5092
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
4644
5093
|
# articles and the standard fields of knowledge articles, or the
|
4645
5094
|
# custom fields of custom knowledge articles, but not both.
|
@@ -4744,7 +5193,7 @@ module Aws::Kendra
|
|
4744
5193
|
include Aws::Structure
|
4745
5194
|
end
|
4746
5195
|
|
4747
|
-
# Specifies configuration information for the
|
5196
|
+
# Specifies configuration information for the knowledge article types
|
4748
5197
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
4749
5198
|
# articles and the standard fields of knowledge articles, or the custom
|
4750
5199
|
# fields of custom knowledge articles, but not both
|
@@ -4884,7 +5333,7 @@ module Aws::Kendra
|
|
4884
5333
|
include Aws::Structure
|
4885
5334
|
end
|
4886
5335
|
|
4887
|
-
# Specifies
|
5336
|
+
# Specifies configuration information for indexing a single standard
|
4888
5337
|
# object.
|
4889
5338
|
#
|
4890
5339
|
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
@@ -4914,7 +5363,7 @@ module Aws::Kendra
|
|
4914
5363
|
#
|
4915
5364
|
# @!attribute [rw] document_title_field_name
|
4916
5365
|
# The name of the field in the standard object table that contains the
|
4917
|
-
# document
|
5366
|
+
# document title.
|
4918
5367
|
# @return [String]
|
4919
5368
|
#
|
4920
5369
|
# @!attribute [rw] field_mappings
|
@@ -5046,6 +5495,7 @@ module Aws::Kendra
|
|
5046
5495
|
# index_field_name: "IndexFieldName", # required
|
5047
5496
|
# },
|
5048
5497
|
# ],
|
5498
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5049
5499
|
# },
|
5050
5500
|
# service_catalog_configuration: {
|
5051
5501
|
# crawl_attachments: false,
|
@@ -5061,6 +5511,7 @@ module Aws::Kendra
|
|
5061
5511
|
# },
|
5062
5512
|
# ],
|
5063
5513
|
# },
|
5514
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
5064
5515
|
# }
|
5065
5516
|
#
|
5066
5517
|
# @!attribute [rw] host_url
|
@@ -5090,6 +5541,25 @@ module Aws::Kendra
|
|
5090
5541
|
# the ServiceNow site.
|
5091
5542
|
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
5092
5543
|
#
|
5544
|
+
# @!attribute [rw] authentication_type
|
5545
|
+
# Determines the type of authentication used to connect to the
|
5546
|
+
# ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is
|
5547
|
+
# authenticated using the user name and password provided in the AWS
|
5548
|
+
# Secrets Manager secret in the `SecretArn` field. When you choose
|
5549
|
+
# `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and
|
5550
|
+
# secret provided in the Secrets Manager secret, and the user name and
|
5551
|
+
# password are used to determine which information Amazon Kendra has
|
5552
|
+
# access to.
|
5553
|
+
#
|
5554
|
+
# When you use `OAUTH2` authentication, you must generate a token and
|
5555
|
+
# a client secret using the ServiceNow console. For more information,
|
5556
|
+
# see [Using a ServiceNow data source][1].
|
5557
|
+
#
|
5558
|
+
#
|
5559
|
+
#
|
5560
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
|
5561
|
+
# @return [String]
|
5562
|
+
#
|
5093
5563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
|
5094
5564
|
#
|
5095
5565
|
class ServiceNowConfiguration < Struct.new(
|
@@ -5097,7 +5567,8 @@ module Aws::Kendra
|
|
5097
5567
|
:secret_arn,
|
5098
5568
|
:service_now_build_version,
|
5099
5569
|
:knowledge_article_configuration,
|
5100
|
-
:service_catalog_configuration
|
5570
|
+
:service_catalog_configuration,
|
5571
|
+
:authentication_type)
|
5101
5572
|
SENSITIVE = []
|
5102
5573
|
include Aws::Structure
|
5103
5574
|
end
|
@@ -5121,6 +5592,7 @@ module Aws::Kendra
|
|
5121
5592
|
# index_field_name: "IndexFieldName", # required
|
5122
5593
|
# },
|
5123
5594
|
# ],
|
5595
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5124
5596
|
# }
|
5125
5597
|
#
|
5126
5598
|
# @!attribute [rw] crawl_attachments
|
@@ -5155,6 +5627,20 @@ module Aws::Kendra
|
|
5155
5627
|
# You must create the index field before you map the field.
|
5156
5628
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
5157
5629
|
#
|
5630
|
+
# @!attribute [rw] filter_query
|
5631
|
+
# A query that selects the knowledge articles to index. The query can
|
5632
|
+
# return articles from multiple knowledge bases, and the knowledge
|
5633
|
+
# bases can be public or private.
|
5634
|
+
#
|
5635
|
+
# The query string must be one generated by the ServiceNow console.
|
5636
|
+
# For more information, see [Specifying documents to index with a
|
5637
|
+
# query][1].
|
5638
|
+
#
|
5639
|
+
#
|
5640
|
+
#
|
5641
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
|
5642
|
+
# @return [String]
|
5643
|
+
#
|
5158
5644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
|
5159
5645
|
#
|
5160
5646
|
class ServiceNowKnowledgeArticleConfiguration < Struct.new(
|
@@ -5163,7 +5649,8 @@ module Aws::Kendra
|
|
5163
5649
|
:exclude_attachment_file_patterns,
|
5164
5650
|
:document_data_field_name,
|
5165
5651
|
:document_title_field_name,
|
5166
|
-
:field_mappings
|
5652
|
+
:field_mappings,
|
5653
|
+
:filter_query)
|
5167
5654
|
SENSITIVE = []
|
5168
5655
|
include Aws::Structure
|
5169
5656
|
end
|
@@ -5195,13 +5682,23 @@ module Aws::Kendra
|
|
5195
5682
|
# @return [Boolean]
|
5196
5683
|
#
|
5197
5684
|
# @!attribute [rw] include_attachment_file_patterns
|
5198
|
-
#
|
5199
|
-
# index.
|
5685
|
+
# A list of regular expression patterns. Documents that match the
|
5686
|
+
# patterns are included in the index. Documents that don't match the
|
5687
|
+
# patterns are excluded from the index. If a document matches both an
|
5688
|
+
# exclusion pattern and an inclusion pattern, the document is not
|
5689
|
+
# included in the index.
|
5690
|
+
#
|
5691
|
+
# The regex is applied to the file name of the attachment.
|
5200
5692
|
# @return [Array<String>]
|
5201
5693
|
#
|
5202
5694
|
# @!attribute [rw] exclude_attachment_file_patterns
|
5203
|
-
#
|
5204
|
-
# index.
|
5695
|
+
# A list of regular expression patterns. Documents that match the
|
5696
|
+
# patterns are excluded from the index. Documents that don't match
|
5697
|
+
# the patterns are included in the index. If a document matches both
|
5698
|
+
# an exclusion pattern and an inclusion pattern, the document is not
|
5699
|
+
# included in the index.
|
5700
|
+
#
|
5701
|
+
# The regex is applied to the file name of the attachment.
|
5205
5702
|
# @return [Array<String>]
|
5206
5703
|
#
|
5207
5704
|
# @!attribute [rw] document_data_field_name
|
@@ -5336,9 +5833,9 @@ module Aws::Kendra
|
|
5336
5833
|
# @!attribute [rw] field_mappings
|
5337
5834
|
# A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
|
5338
5835
|
# SharePoint attributes to custom fields in the Amazon Kendra index.
|
5339
|
-
# You must first create the index fields using the
|
5340
|
-
# you map SharePoint attributes. For more
|
5341
|
-
# Data Source Fields][1].
|
5836
|
+
# You must first create the index fields using the `UpdateIndex`
|
5837
|
+
# operation before you map SharePoint attributes. For more
|
5838
|
+
# information, see [Mapping Data Source Fields][1].
|
5342
5839
|
#
|
5343
5840
|
#
|
5344
5841
|
#
|
@@ -5556,7 +6053,8 @@ module Aws::Kendra
|
|
5556
6053
|
#
|
5557
6054
|
# @!attribute [rw] query_id
|
5558
6055
|
# The identifier of the specific query for which you are submitting
|
5559
|
-
# feedback. The query ID is returned in the response to the
|
6056
|
+
# feedback. The query ID is returned in the response to the `Query`
|
6057
|
+
# operation.
|
5560
6058
|
# @return [String]
|
5561
6059
|
#
|
5562
6060
|
# @!attribute [rw] click_feedback_items
|
@@ -5686,6 +6184,40 @@ module Aws::Kendra
|
|
5686
6184
|
include Aws::Structure
|
5687
6185
|
end
|
5688
6186
|
|
6187
|
+
# An array of summary information for one or more thesauruses.
|
6188
|
+
#
|
6189
|
+
# @!attribute [rw] id
|
6190
|
+
# The identifier of the thesaurus.
|
6191
|
+
# @return [String]
|
6192
|
+
#
|
6193
|
+
# @!attribute [rw] name
|
6194
|
+
# The name of the thesaurus.
|
6195
|
+
# @return [String]
|
6196
|
+
#
|
6197
|
+
# @!attribute [rw] status
|
6198
|
+
# The status of the thesaurus.
|
6199
|
+
# @return [String]
|
6200
|
+
#
|
6201
|
+
# @!attribute [rw] created_at
|
6202
|
+
# The Unix datetime that the thesaurus was created.
|
6203
|
+
# @return [Time]
|
6204
|
+
#
|
6205
|
+
# @!attribute [rw] updated_at
|
6206
|
+
# The Unix datetime that the thesaurus was last updated.
|
6207
|
+
# @return [Time]
|
6208
|
+
#
|
6209
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ThesaurusSummary AWS API Documentation
|
6210
|
+
#
|
6211
|
+
class ThesaurusSummary < Struct.new(
|
6212
|
+
:id,
|
6213
|
+
:name,
|
6214
|
+
:status,
|
6215
|
+
:created_at,
|
6216
|
+
:updated_at)
|
6217
|
+
SENSITIVE = []
|
6218
|
+
include Aws::Structure
|
6219
|
+
end
|
6220
|
+
|
5689
6221
|
# @!attribute [rw] message
|
5690
6222
|
# @return [String]
|
5691
6223
|
#
|
@@ -5939,6 +6471,7 @@ module Aws::Kendra
|
|
5939
6471
|
# index_field_name: "IndexFieldName", # required
|
5940
6472
|
# },
|
5941
6473
|
# ],
|
6474
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5942
6475
|
# },
|
5943
6476
|
# service_catalog_configuration: {
|
5944
6477
|
# crawl_attachments: false,
|
@@ -5954,6 +6487,7 @@ module Aws::Kendra
|
|
5954
6487
|
# },
|
5955
6488
|
# ],
|
5956
6489
|
# },
|
6490
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
5957
6491
|
# },
|
5958
6492
|
# confluence_configuration: {
|
5959
6493
|
# server_url: "Url", # required
|
@@ -6007,6 +6541,21 @@ module Aws::Kendra
|
|
6007
6541
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
6008
6542
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
6009
6543
|
# },
|
6544
|
+
# google_drive_configuration: {
|
6545
|
+
# secret_arn: "SecretArn", # required
|
6546
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
6547
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
6548
|
+
# field_mappings: [
|
6549
|
+
# {
|
6550
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
6551
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
6552
|
+
# index_field_name: "IndexFieldName", # required
|
6553
|
+
# },
|
6554
|
+
# ],
|
6555
|
+
# exclude_mime_types: ["MimeType"],
|
6556
|
+
# exclude_user_accounts: ["UserAccount"],
|
6557
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
6558
|
+
# },
|
6010
6559
|
# },
|
6011
6560
|
# description: "Description",
|
6012
6561
|
# schedule: "ScanSchedule",
|
@@ -6133,7 +6682,7 @@ module Aws::Kendra
|
|
6133
6682
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
6134
6683
|
#
|
6135
6684
|
# @!attribute [rw] capacity_units
|
6136
|
-
# Sets the number of
|
6685
|
+
# Sets the number of additional storage and query capacity units that
|
6137
6686
|
# should be used by the index. You can change the capacity of the
|
6138
6687
|
# index up to 5 times per day.
|
6139
6688
|
#
|
@@ -6165,6 +6714,58 @@ module Aws::Kendra
|
|
6165
6714
|
include Aws::Structure
|
6166
6715
|
end
|
6167
6716
|
|
6717
|
+
# @note When making an API call, you may pass UpdateThesaurusRequest
|
6718
|
+
# data as a hash:
|
6719
|
+
#
|
6720
|
+
# {
|
6721
|
+
# id: "ThesaurusId", # required
|
6722
|
+
# name: "ThesaurusName",
|
6723
|
+
# index_id: "IndexId", # required
|
6724
|
+
# description: "Description",
|
6725
|
+
# role_arn: "RoleArn",
|
6726
|
+
# source_s3_path: {
|
6727
|
+
# bucket: "S3BucketName", # required
|
6728
|
+
# key: "S3ObjectKey", # required
|
6729
|
+
# },
|
6730
|
+
# }
|
6731
|
+
#
|
6732
|
+
# @!attribute [rw] id
|
6733
|
+
# The identifier of the thesaurus to update.
|
6734
|
+
# @return [String]
|
6735
|
+
#
|
6736
|
+
# @!attribute [rw] name
|
6737
|
+
# The updated name of the thesaurus.
|
6738
|
+
# @return [String]
|
6739
|
+
#
|
6740
|
+
# @!attribute [rw] index_id
|
6741
|
+
# The identifier of the index associated with the thesaurus to update.
|
6742
|
+
# @return [String]
|
6743
|
+
#
|
6744
|
+
# @!attribute [rw] description
|
6745
|
+
# The updated description of the thesaurus.
|
6746
|
+
# @return [String]
|
6747
|
+
#
|
6748
|
+
# @!attribute [rw] role_arn
|
6749
|
+
# The updated role ARN of the thesaurus.
|
6750
|
+
# @return [String]
|
6751
|
+
#
|
6752
|
+
# @!attribute [rw] source_s3_path
|
6753
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
6754
|
+
# @return [Types::S3Path]
|
6755
|
+
#
|
6756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurusRequest AWS API Documentation
|
6757
|
+
#
|
6758
|
+
class UpdateThesaurusRequest < Struct.new(
|
6759
|
+
:id,
|
6760
|
+
:name,
|
6761
|
+
:index_id,
|
6762
|
+
:description,
|
6763
|
+
:role_arn,
|
6764
|
+
:source_s3_path)
|
6765
|
+
SENSITIVE = []
|
6766
|
+
include Aws::Structure
|
6767
|
+
end
|
6768
|
+
|
6168
6769
|
# Provides information about the user context for a Amazon Kendra index.
|
6169
6770
|
#
|
6170
6771
|
# @note When making an API call, you may pass UserContext
|