aws-sdk-kendra 1.75.0 → 1.77.0

Sign up to get free protection for your applications and to get access to all the features.
data/sig/client.rbs ADDED
@@ -0,0 +1,3012 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module Kendra
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#initialize-instance_method
14
+ def self.new: (
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?active_endpoint_cache: bool,
19
+ ?adaptive_retry_wait_to_fill: bool,
20
+ ?client_side_monitoring: bool,
21
+ ?client_side_monitoring_client_id: String,
22
+ ?client_side_monitoring_host: String,
23
+ ?client_side_monitoring_port: Integer,
24
+ ?client_side_monitoring_publisher: untyped,
25
+ ?convert_params: bool,
26
+ ?correct_clock_skew: bool,
27
+ ?defaults_mode: String,
28
+ ?disable_host_prefix_injection: bool,
29
+ ?disable_request_compression: bool,
30
+ ?endpoint: String,
31
+ ?endpoint_cache_max_entries: Integer,
32
+ ?endpoint_cache_max_threads: Integer,
33
+ ?endpoint_cache_poll_interval: Integer,
34
+ ?endpoint_discovery: bool,
35
+ ?ignore_configured_endpoint_urls: bool,
36
+ ?log_formatter: untyped,
37
+ ?log_level: Symbol,
38
+ ?logger: untyped,
39
+ ?max_attempts: Integer,
40
+ ?profile: String,
41
+ ?request_min_compression_size_bytes: Integer,
42
+ ?retry_backoff: Proc,
43
+ ?retry_base_delay: Float,
44
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
45
+ ?retry_limit: Integer,
46
+ ?retry_max_delay: Integer,
47
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
48
+ ?sdk_ua_app_id: String,
49
+ ?secret_access_key: String,
50
+ ?session_token: String,
51
+ ?simple_json: bool,
52
+ ?stub_responses: untyped,
53
+ ?token_provider: untyped,
54
+ ?use_dualstack_endpoint: bool,
55
+ ?use_fips_endpoint: bool,
56
+ ?validate_params: bool,
57
+ ?endpoint_provider: untyped,
58
+ ?http_proxy: String,
59
+ ?http_open_timeout: (Float | Integer),
60
+ ?http_read_timeout: (Float | Integer),
61
+ ?http_idle_timeout: (Float | Integer),
62
+ ?http_continue_timeout: (Float | Integer),
63
+ ?ssl_timeout: (Float | Integer | nil),
64
+ ?http_wire_trace: bool,
65
+ ?ssl_verify_peer: bool,
66
+ ?ssl_ca_bundle: String,
67
+ ?ssl_ca_directory: String,
68
+ ?ssl_ca_store: String,
69
+ ?on_chunk_received: Proc,
70
+ ?on_chunk_sent: Proc,
71
+ ?raise_response_errors: bool
72
+ ) -> instance
73
+ | (?Hash[Symbol, untyped]) -> instance
74
+
75
+
76
+ interface _AssociateEntitiesToExperienceResponseSuccess
77
+ include ::Seahorse::Client::_ResponseSuccess[Types::AssociateEntitiesToExperienceResponse]
78
+ def failed_entity_list: () -> ::Array[Types::FailedEntity]
79
+ end
80
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#associate_entities_to_experience-instance_method
81
+ def associate_entities_to_experience: (
82
+ id: ::String,
83
+ index_id: ::String,
84
+ entity_list: Array[
85
+ {
86
+ entity_id: ::String,
87
+ entity_type: ("USER" | "GROUP")
88
+ },
89
+ ]
90
+ ) -> _AssociateEntitiesToExperienceResponseSuccess
91
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateEntitiesToExperienceResponseSuccess
92
+
93
+ interface _AssociatePersonasToEntitiesResponseSuccess
94
+ include ::Seahorse::Client::_ResponseSuccess[Types::AssociatePersonasToEntitiesResponse]
95
+ def failed_entity_list: () -> ::Array[Types::FailedEntity]
96
+ end
97
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#associate_personas_to_entities-instance_method
98
+ def associate_personas_to_entities: (
99
+ id: ::String,
100
+ index_id: ::String,
101
+ personas: Array[
102
+ {
103
+ entity_id: ::String,
104
+ persona: ("OWNER" | "VIEWER")
105
+ },
106
+ ]
107
+ ) -> _AssociatePersonasToEntitiesResponseSuccess
108
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociatePersonasToEntitiesResponseSuccess
109
+
110
+ interface _BatchDeleteDocumentResponseSuccess
111
+ include ::Seahorse::Client::_ResponseSuccess[Types::BatchDeleteDocumentResponse]
112
+ def failed_documents: () -> ::Array[Types::BatchDeleteDocumentResponseFailedDocument]
113
+ end
114
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#batch_delete_document-instance_method
115
+ def batch_delete_document: (
116
+ index_id: ::String,
117
+ document_id_list: Array[::String],
118
+ ?data_source_sync_job_metric_target: {
119
+ data_source_id: ::String,
120
+ data_source_sync_job_id: ::String?
121
+ }
122
+ ) -> _BatchDeleteDocumentResponseSuccess
123
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchDeleteDocumentResponseSuccess
124
+
125
+ interface _BatchDeleteFeaturedResultsSetResponseSuccess
126
+ include ::Seahorse::Client::_ResponseSuccess[Types::BatchDeleteFeaturedResultsSetResponse]
127
+ def errors: () -> ::Array[Types::BatchDeleteFeaturedResultsSetError]
128
+ end
129
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#batch_delete_featured_results_set-instance_method
130
+ def batch_delete_featured_results_set: (
131
+ index_id: ::String,
132
+ featured_results_set_ids: Array[::String]
133
+ ) -> _BatchDeleteFeaturedResultsSetResponseSuccess
134
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchDeleteFeaturedResultsSetResponseSuccess
135
+
136
+ interface _BatchGetDocumentStatusResponseSuccess
137
+ include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetDocumentStatusResponse]
138
+ def errors: () -> ::Array[Types::BatchGetDocumentStatusResponseError]
139
+ def document_status_list: () -> ::Array[Types::Status]
140
+ end
141
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#batch_get_document_status-instance_method
142
+ def batch_get_document_status: (
143
+ index_id: ::String,
144
+ document_info_list: Array[
145
+ {
146
+ document_id: ::String,
147
+ attributes: Array[
148
+ {
149
+ key: ::String,
150
+ value: {
151
+ string_value: ::String?,
152
+ string_list_value: Array[::String]?,
153
+ long_value: ::Integer?,
154
+ date_value: ::Time?
155
+ }
156
+ },
157
+ ]?
158
+ },
159
+ ]
160
+ ) -> _BatchGetDocumentStatusResponseSuccess
161
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchGetDocumentStatusResponseSuccess
162
+
163
+ interface _BatchPutDocumentResponseSuccess
164
+ include ::Seahorse::Client::_ResponseSuccess[Types::BatchPutDocumentResponse]
165
+ def failed_documents: () -> ::Array[Types::BatchPutDocumentResponseFailedDocument]
166
+ end
167
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#batch_put_document-instance_method
168
+ def batch_put_document: (
169
+ index_id: ::String,
170
+ ?role_arn: ::String,
171
+ documents: Array[
172
+ {
173
+ id: ::String,
174
+ title: ::String?,
175
+ blob: ::String?,
176
+ s3_path: {
177
+ bucket: ::String,
178
+ key: ::String
179
+ }?,
180
+ attributes: Array[
181
+ {
182
+ key: ::String,
183
+ value: {
184
+ string_value: ::String?,
185
+ string_list_value: Array[::String]?,
186
+ long_value: ::Integer?,
187
+ date_value: ::Time?
188
+ }
189
+ },
190
+ ]?,
191
+ access_control_list: Array[
192
+ {
193
+ name: ::String,
194
+ type: ("USER" | "GROUP"),
195
+ access: ("ALLOW" | "DENY"),
196
+ data_source_id: ::String?
197
+ },
198
+ ]?,
199
+ hierarchical_access_control_list: Array[
200
+ {
201
+ principal_list: Array[
202
+ {
203
+ name: ::String,
204
+ type: ("USER" | "GROUP"),
205
+ access: ("ALLOW" | "DENY"),
206
+ data_source_id: ::String?
207
+ },
208
+ ]
209
+ },
210
+ ]?,
211
+ content_type: ("PDF" | "HTML" | "MS_WORD" | "PLAIN_TEXT" | "PPT" | "RTF" | "XML" | "XSLT" | "MS_EXCEL" | "CSV" | "JSON" | "MD")?,
212
+ access_control_configuration_id: ::String?
213
+ },
214
+ ],
215
+ ?custom_document_enrichment_configuration: {
216
+ inline_configurations: Array[
217
+ {
218
+ condition: {
219
+ condition_document_attribute_key: ::String,
220
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
221
+ condition_on_value: {
222
+ string_value: ::String?,
223
+ string_list_value: Array[::String]?,
224
+ long_value: ::Integer?,
225
+ date_value: ::Time?
226
+ }?
227
+ }?,
228
+ target: {
229
+ target_document_attribute_key: ::String?,
230
+ target_document_attribute_value_deletion: bool?,
231
+ target_document_attribute_value: {
232
+ string_value: ::String?,
233
+ string_list_value: Array[::String]?,
234
+ long_value: ::Integer?,
235
+ date_value: ::Time?
236
+ }?
237
+ }?,
238
+ document_content_deletion: bool?
239
+ },
240
+ ]?,
241
+ pre_extraction_hook_configuration: {
242
+ invocation_condition: {
243
+ condition_document_attribute_key: ::String,
244
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
245
+ condition_on_value: {
246
+ string_value: ::String?,
247
+ string_list_value: Array[::String]?,
248
+ long_value: ::Integer?,
249
+ date_value: ::Time?
250
+ }?
251
+ }?,
252
+ lambda_arn: ::String,
253
+ s3_bucket: ::String
254
+ }?,
255
+ post_extraction_hook_configuration: {
256
+ invocation_condition: {
257
+ condition_document_attribute_key: ::String,
258
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
259
+ condition_on_value: {
260
+ string_value: ::String?,
261
+ string_list_value: Array[::String]?,
262
+ long_value: ::Integer?,
263
+ date_value: ::Time?
264
+ }?
265
+ }?,
266
+ lambda_arn: ::String,
267
+ s3_bucket: ::String
268
+ }?,
269
+ role_arn: ::String?
270
+ }
271
+ ) -> _BatchPutDocumentResponseSuccess
272
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchPutDocumentResponseSuccess
273
+
274
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#clear_query_suggestions-instance_method
275
+ def clear_query_suggestions: (
276
+ index_id: ::String
277
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
278
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
279
+
280
+ interface _CreateAccessControlConfigurationResponseSuccess
281
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateAccessControlConfigurationResponse]
282
+ def id: () -> ::String
283
+ end
284
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_access_control_configuration-instance_method
285
+ def create_access_control_configuration: (
286
+ index_id: ::String,
287
+ name: ::String,
288
+ ?description: ::String,
289
+ ?access_control_list: Array[
290
+ {
291
+ name: ::String,
292
+ type: ("USER" | "GROUP"),
293
+ access: ("ALLOW" | "DENY"),
294
+ data_source_id: ::String?
295
+ },
296
+ ],
297
+ ?hierarchical_access_control_list: Array[
298
+ {
299
+ principal_list: Array[
300
+ {
301
+ name: ::String,
302
+ type: ("USER" | "GROUP"),
303
+ access: ("ALLOW" | "DENY"),
304
+ data_source_id: ::String?
305
+ },
306
+ ]
307
+ },
308
+ ],
309
+ ?client_token: ::String
310
+ ) -> _CreateAccessControlConfigurationResponseSuccess
311
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAccessControlConfigurationResponseSuccess
312
+
313
+ interface _CreateDataSourceResponseSuccess
314
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateDataSourceResponse]
315
+ def id: () -> ::String
316
+ end
317
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_data_source-instance_method
318
+ def create_data_source: (
319
+ name: ::String,
320
+ index_id: ::String,
321
+ type: ("S3" | "SHAREPOINT" | "DATABASE" | "SALESFORCE" | "ONEDRIVE" | "SERVICENOW" | "CUSTOM" | "CONFLUENCE" | "GOOGLEDRIVE" | "WEBCRAWLER" | "WORKDOCS" | "FSX" | "SLACK" | "BOX" | "QUIP" | "JIRA" | "GITHUB" | "ALFRESCO" | "TEMPLATE"),
322
+ ?configuration: {
323
+ s3_configuration: {
324
+ bucket_name: ::String,
325
+ inclusion_prefixes: Array[::String]?,
326
+ inclusion_patterns: Array[::String]?,
327
+ exclusion_patterns: Array[::String]?,
328
+ documents_metadata_configuration: {
329
+ s3_prefix: ::String?
330
+ }?,
331
+ access_control_list_configuration: {
332
+ key_path: ::String?
333
+ }?
334
+ }?,
335
+ share_point_configuration: {
336
+ share_point_version: ("SHAREPOINT_2013" | "SHAREPOINT_2016" | "SHAREPOINT_ONLINE" | "SHAREPOINT_2019"),
337
+ urls: Array[::String],
338
+ secret_arn: ::String,
339
+ crawl_attachments: bool?,
340
+ use_change_log: bool?,
341
+ inclusion_patterns: Array[::String]?,
342
+ exclusion_patterns: Array[::String]?,
343
+ vpc_configuration: {
344
+ subnet_ids: Array[::String],
345
+ security_group_ids: Array[::String]
346
+ }?,
347
+ field_mappings: Array[
348
+ {
349
+ data_source_field_name: ::String,
350
+ date_field_format: ::String?,
351
+ index_field_name: ::String
352
+ },
353
+ ]?,
354
+ document_title_field_name: ::String?,
355
+ disable_local_groups: bool?,
356
+ ssl_certificate_s3_path: {
357
+ bucket: ::String,
358
+ key: ::String
359
+ }?,
360
+ authentication_type: ("HTTP_BASIC" | "OAUTH2")?,
361
+ proxy_configuration: {
362
+ host: ::String,
363
+ port: ::Integer,
364
+ credentials: ::String?
365
+ }?
366
+ }?,
367
+ database_configuration: {
368
+ database_engine_type: ("RDS_AURORA_MYSQL" | "RDS_AURORA_POSTGRESQL" | "RDS_MYSQL" | "RDS_POSTGRESQL"),
369
+ connection_configuration: {
370
+ database_host: ::String,
371
+ database_port: ::Integer,
372
+ database_name: ::String,
373
+ table_name: ::String,
374
+ secret_arn: ::String
375
+ },
376
+ vpc_configuration: {
377
+ subnet_ids: Array[::String],
378
+ security_group_ids: Array[::String]
379
+ }?,
380
+ column_configuration: {
381
+ document_id_column_name: ::String,
382
+ document_data_column_name: ::String,
383
+ document_title_column_name: ::String?,
384
+ field_mappings: Array[
385
+ {
386
+ data_source_field_name: ::String,
387
+ date_field_format: ::String?,
388
+ index_field_name: ::String
389
+ },
390
+ ]?,
391
+ change_detecting_columns: Array[::String]
392
+ },
393
+ acl_configuration: {
394
+ allowed_groups_column_name: ::String
395
+ }?,
396
+ sql_configuration: {
397
+ query_identifiers_enclosing_option: ("DOUBLE_QUOTES" | "NONE")?
398
+ }?
399
+ }?,
400
+ salesforce_configuration: {
401
+ server_url: ::String,
402
+ secret_arn: ::String,
403
+ standard_object_configurations: Array[
404
+ {
405
+ name: ("ACCOUNT" | "CAMPAIGN" | "CASE" | "CONTACT" | "CONTRACT" | "DOCUMENT" | "GROUP" | "IDEA" | "LEAD" | "OPPORTUNITY" | "PARTNER" | "PRICEBOOK" | "PRODUCT" | "PROFILE" | "SOLUTION" | "TASK" | "USER"),
406
+ document_data_field_name: ::String,
407
+ document_title_field_name: ::String?,
408
+ field_mappings: Array[
409
+ {
410
+ data_source_field_name: ::String,
411
+ date_field_format: ::String?,
412
+ index_field_name: ::String
413
+ },
414
+ ]?
415
+ },
416
+ ]?,
417
+ knowledge_article_configuration: {
418
+ included_states: Array[("DRAFT" | "PUBLISHED" | "ARCHIVED")],
419
+ standard_knowledge_article_type_configuration: {
420
+ document_data_field_name: ::String,
421
+ document_title_field_name: ::String?,
422
+ field_mappings: Array[
423
+ {
424
+ data_source_field_name: ::String,
425
+ date_field_format: ::String?,
426
+ index_field_name: ::String
427
+ },
428
+ ]?
429
+ }?,
430
+ custom_knowledge_article_type_configurations: Array[
431
+ {
432
+ name: ::String,
433
+ document_data_field_name: ::String,
434
+ document_title_field_name: ::String?,
435
+ field_mappings: Array[
436
+ {
437
+ data_source_field_name: ::String,
438
+ date_field_format: ::String?,
439
+ index_field_name: ::String
440
+ },
441
+ ]?
442
+ },
443
+ ]?
444
+ }?,
445
+ chatter_feed_configuration: {
446
+ document_data_field_name: ::String,
447
+ document_title_field_name: ::String?,
448
+ field_mappings: Array[
449
+ {
450
+ data_source_field_name: ::String,
451
+ date_field_format: ::String?,
452
+ index_field_name: ::String
453
+ },
454
+ ]?,
455
+ include_filter_types: Array[("ACTIVE_USER" | "STANDARD_USER")]?
456
+ }?,
457
+ crawl_attachments: bool?,
458
+ standard_object_attachment_configuration: {
459
+ document_title_field_name: ::String?,
460
+ field_mappings: Array[
461
+ {
462
+ data_source_field_name: ::String,
463
+ date_field_format: ::String?,
464
+ index_field_name: ::String
465
+ },
466
+ ]?
467
+ }?,
468
+ include_attachment_file_patterns: Array[::String]?,
469
+ exclude_attachment_file_patterns: Array[::String]?
470
+ }?,
471
+ one_drive_configuration: {
472
+ tenant_domain: ::String,
473
+ secret_arn: ::String,
474
+ one_drive_users: {
475
+ one_drive_user_list: Array[::String]?,
476
+ one_drive_user_s3_path: {
477
+ bucket: ::String,
478
+ key: ::String
479
+ }?
480
+ },
481
+ inclusion_patterns: Array[::String]?,
482
+ exclusion_patterns: Array[::String]?,
483
+ field_mappings: Array[
484
+ {
485
+ data_source_field_name: ::String,
486
+ date_field_format: ::String?,
487
+ index_field_name: ::String
488
+ },
489
+ ]?,
490
+ disable_local_groups: bool?
491
+ }?,
492
+ service_now_configuration: {
493
+ host_url: ::String,
494
+ secret_arn: ::String,
495
+ service_now_build_version: ("LONDON" | "OTHERS"),
496
+ knowledge_article_configuration: {
497
+ crawl_attachments: bool?,
498
+ include_attachment_file_patterns: Array[::String]?,
499
+ exclude_attachment_file_patterns: Array[::String]?,
500
+ document_data_field_name: ::String,
501
+ document_title_field_name: ::String?,
502
+ field_mappings: Array[
503
+ {
504
+ data_source_field_name: ::String,
505
+ date_field_format: ::String?,
506
+ index_field_name: ::String
507
+ },
508
+ ]?,
509
+ filter_query: ::String?
510
+ }?,
511
+ service_catalog_configuration: {
512
+ crawl_attachments: bool?,
513
+ include_attachment_file_patterns: Array[::String]?,
514
+ exclude_attachment_file_patterns: Array[::String]?,
515
+ document_data_field_name: ::String,
516
+ document_title_field_name: ::String?,
517
+ field_mappings: Array[
518
+ {
519
+ data_source_field_name: ::String,
520
+ date_field_format: ::String?,
521
+ index_field_name: ::String
522
+ },
523
+ ]?
524
+ }?,
525
+ authentication_type: ("HTTP_BASIC" | "OAUTH2")?
526
+ }?,
527
+ confluence_configuration: {
528
+ server_url: ::String,
529
+ secret_arn: ::String,
530
+ version: ("CLOUD" | "SERVER"),
531
+ space_configuration: {
532
+ crawl_personal_spaces: bool?,
533
+ crawl_archived_spaces: bool?,
534
+ include_spaces: Array[::String]?,
535
+ exclude_spaces: Array[::String]?,
536
+ space_field_mappings: Array[
537
+ {
538
+ data_source_field_name: ("DISPLAY_URL" | "ITEM_TYPE" | "SPACE_KEY" | "URL")?,
539
+ date_field_format: ::String?,
540
+ index_field_name: ::String?
541
+ },
542
+ ]?
543
+ }?,
544
+ page_configuration: {
545
+ page_field_mappings: Array[
546
+ {
547
+ data_source_field_name: ("AUTHOR" | "CONTENT_STATUS" | "CREATED_DATE" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "MODIFIED_DATE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION")?,
548
+ date_field_format: ::String?,
549
+ index_field_name: ::String?
550
+ },
551
+ ]?
552
+ }?,
553
+ blog_configuration: {
554
+ blog_field_mappings: Array[
555
+ {
556
+ data_source_field_name: ("AUTHOR" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "PUBLISH_DATE" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION")?,
557
+ date_field_format: ::String?,
558
+ index_field_name: ::String?
559
+ },
560
+ ]?
561
+ }?,
562
+ attachment_configuration: {
563
+ crawl_attachments: bool?,
564
+ attachment_field_mappings: Array[
565
+ {
566
+ data_source_field_name: ("AUTHOR" | "CONTENT_TYPE" | "CREATED_DATE" | "DISPLAY_URL" | "FILE_SIZE" | "ITEM_TYPE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION")?,
567
+ date_field_format: ::String?,
568
+ index_field_name: ::String?
569
+ },
570
+ ]?
571
+ }?,
572
+ vpc_configuration: {
573
+ subnet_ids: Array[::String],
574
+ security_group_ids: Array[::String]
575
+ }?,
576
+ inclusion_patterns: Array[::String]?,
577
+ exclusion_patterns: Array[::String]?,
578
+ proxy_configuration: {
579
+ host: ::String,
580
+ port: ::Integer,
581
+ credentials: ::String?
582
+ }?,
583
+ authentication_type: ("HTTP_BASIC" | "PAT")?
584
+ }?,
585
+ google_drive_configuration: {
586
+ secret_arn: ::String,
587
+ inclusion_patterns: Array[::String]?,
588
+ exclusion_patterns: Array[::String]?,
589
+ field_mappings: Array[
590
+ {
591
+ data_source_field_name: ::String,
592
+ date_field_format: ::String?,
593
+ index_field_name: ::String
594
+ },
595
+ ]?,
596
+ exclude_mime_types: Array[::String]?,
597
+ exclude_user_accounts: Array[::String]?,
598
+ exclude_shared_drives: Array[::String]?
599
+ }?,
600
+ web_crawler_configuration: {
601
+ urls: {
602
+ seed_url_configuration: {
603
+ seed_urls: Array[::String],
604
+ web_crawler_mode: ("HOST_ONLY" | "SUBDOMAINS" | "EVERYTHING")?
605
+ }?,
606
+ site_maps_configuration: {
607
+ site_maps: Array[::String]
608
+ }?
609
+ },
610
+ crawl_depth: ::Integer?,
611
+ max_links_per_page: ::Integer?,
612
+ max_content_size_per_page_in_mega_bytes: ::Float?,
613
+ max_urls_per_minute_crawl_rate: ::Integer?,
614
+ url_inclusion_patterns: Array[::String]?,
615
+ url_exclusion_patterns: Array[::String]?,
616
+ proxy_configuration: {
617
+ host: ::String,
618
+ port: ::Integer,
619
+ credentials: ::String?
620
+ }?,
621
+ authentication_configuration: {
622
+ basic_authentication: Array[
623
+ {
624
+ host: ::String,
625
+ port: ::Integer,
626
+ credentials: ::String
627
+ },
628
+ ]?
629
+ }?
630
+ }?,
631
+ work_docs_configuration: {
632
+ organization_id: ::String,
633
+ crawl_comments: bool?,
634
+ use_change_log: bool?,
635
+ inclusion_patterns: Array[::String]?,
636
+ exclusion_patterns: Array[::String]?,
637
+ field_mappings: Array[
638
+ {
639
+ data_source_field_name: ::String,
640
+ date_field_format: ::String?,
641
+ index_field_name: ::String
642
+ },
643
+ ]?
644
+ }?,
645
+ fsx_configuration: {
646
+ file_system_id: ::String,
647
+ file_system_type: ("WINDOWS"),
648
+ vpc_configuration: {
649
+ subnet_ids: Array[::String],
650
+ security_group_ids: Array[::String]
651
+ },
652
+ secret_arn: ::String?,
653
+ inclusion_patterns: Array[::String]?,
654
+ exclusion_patterns: Array[::String]?,
655
+ field_mappings: Array[
656
+ {
657
+ data_source_field_name: ::String,
658
+ date_field_format: ::String?,
659
+ index_field_name: ::String
660
+ },
661
+ ]?
662
+ }?,
663
+ slack_configuration: {
664
+ team_id: ::String,
665
+ secret_arn: ::String,
666
+ vpc_configuration: {
667
+ subnet_ids: Array[::String],
668
+ security_group_ids: Array[::String]
669
+ }?,
670
+ slack_entity_list: Array[("PUBLIC_CHANNEL" | "PRIVATE_CHANNEL" | "GROUP_MESSAGE" | "DIRECT_MESSAGE")],
671
+ use_change_log: bool?,
672
+ crawl_bot_message: bool?,
673
+ exclude_archived: bool?,
674
+ since_crawl_date: ::String,
675
+ look_back_period: ::Integer?,
676
+ private_channel_filter: Array[::String]?,
677
+ public_channel_filter: Array[::String]?,
678
+ inclusion_patterns: Array[::String]?,
679
+ exclusion_patterns: Array[::String]?,
680
+ field_mappings: Array[
681
+ {
682
+ data_source_field_name: ::String,
683
+ date_field_format: ::String?,
684
+ index_field_name: ::String
685
+ },
686
+ ]?
687
+ }?,
688
+ box_configuration: {
689
+ enterprise_id: ::String,
690
+ secret_arn: ::String,
691
+ use_change_log: bool?,
692
+ crawl_comments: bool?,
693
+ crawl_tasks: bool?,
694
+ crawl_web_links: bool?,
695
+ file_field_mappings: Array[
696
+ {
697
+ data_source_field_name: ::String,
698
+ date_field_format: ::String?,
699
+ index_field_name: ::String
700
+ },
701
+ ]?,
702
+ task_field_mappings: Array[
703
+ {
704
+ data_source_field_name: ::String,
705
+ date_field_format: ::String?,
706
+ index_field_name: ::String
707
+ },
708
+ ]?,
709
+ comment_field_mappings: Array[
710
+ {
711
+ data_source_field_name: ::String,
712
+ date_field_format: ::String?,
713
+ index_field_name: ::String
714
+ },
715
+ ]?,
716
+ web_link_field_mappings: Array[
717
+ {
718
+ data_source_field_name: ::String,
719
+ date_field_format: ::String?,
720
+ index_field_name: ::String
721
+ },
722
+ ]?,
723
+ inclusion_patterns: Array[::String]?,
724
+ exclusion_patterns: Array[::String]?,
725
+ vpc_configuration: {
726
+ subnet_ids: Array[::String],
727
+ security_group_ids: Array[::String]
728
+ }?
729
+ }?,
730
+ quip_configuration: {
731
+ domain: ::String,
732
+ secret_arn: ::String,
733
+ crawl_file_comments: bool?,
734
+ crawl_chat_rooms: bool?,
735
+ crawl_attachments: bool?,
736
+ folder_ids: Array[::String]?,
737
+ thread_field_mappings: Array[
738
+ {
739
+ data_source_field_name: ::String,
740
+ date_field_format: ::String?,
741
+ index_field_name: ::String
742
+ },
743
+ ]?,
744
+ message_field_mappings: Array[
745
+ {
746
+ data_source_field_name: ::String,
747
+ date_field_format: ::String?,
748
+ index_field_name: ::String
749
+ },
750
+ ]?,
751
+ attachment_field_mappings: Array[
752
+ {
753
+ data_source_field_name: ::String,
754
+ date_field_format: ::String?,
755
+ index_field_name: ::String
756
+ },
757
+ ]?,
758
+ inclusion_patterns: Array[::String]?,
759
+ exclusion_patterns: Array[::String]?,
760
+ vpc_configuration: {
761
+ subnet_ids: Array[::String],
762
+ security_group_ids: Array[::String]
763
+ }?
764
+ }?,
765
+ jira_configuration: {
766
+ jira_account_url: ::String,
767
+ secret_arn: ::String,
768
+ use_change_log: bool?,
769
+ project: Array[::String]?,
770
+ issue_type: Array[::String]?,
771
+ status: Array[::String]?,
772
+ issue_sub_entity_filter: Array[("COMMENTS" | "ATTACHMENTS" | "WORKLOGS")]?,
773
+ attachment_field_mappings: Array[
774
+ {
775
+ data_source_field_name: ::String,
776
+ date_field_format: ::String?,
777
+ index_field_name: ::String
778
+ },
779
+ ]?,
780
+ comment_field_mappings: Array[
781
+ {
782
+ data_source_field_name: ::String,
783
+ date_field_format: ::String?,
784
+ index_field_name: ::String
785
+ },
786
+ ]?,
787
+ issue_field_mappings: Array[
788
+ {
789
+ data_source_field_name: ::String,
790
+ date_field_format: ::String?,
791
+ index_field_name: ::String
792
+ },
793
+ ]?,
794
+ project_field_mappings: Array[
795
+ {
796
+ data_source_field_name: ::String,
797
+ date_field_format: ::String?,
798
+ index_field_name: ::String
799
+ },
800
+ ]?,
801
+ work_log_field_mappings: Array[
802
+ {
803
+ data_source_field_name: ::String,
804
+ date_field_format: ::String?,
805
+ index_field_name: ::String
806
+ },
807
+ ]?,
808
+ inclusion_patterns: Array[::String]?,
809
+ exclusion_patterns: Array[::String]?,
810
+ vpc_configuration: {
811
+ subnet_ids: Array[::String],
812
+ security_group_ids: Array[::String]
813
+ }?
814
+ }?,
815
+ git_hub_configuration: {
816
+ saa_s_configuration: {
817
+ organization_name: ::String,
818
+ host_url: ::String
819
+ }?,
820
+ on_premise_configuration: {
821
+ host_url: ::String,
822
+ organization_name: ::String,
823
+ ssl_certificate_s3_path: {
824
+ bucket: ::String,
825
+ key: ::String
826
+ }
827
+ }?,
828
+ type: ("SAAS" | "ON_PREMISE")?,
829
+ secret_arn: ::String,
830
+ use_change_log: bool?,
831
+ git_hub_document_crawl_properties: {
832
+ crawl_repository_documents: bool?,
833
+ crawl_issue: bool?,
834
+ crawl_issue_comment: bool?,
835
+ crawl_issue_comment_attachment: bool?,
836
+ crawl_pull_request: bool?,
837
+ crawl_pull_request_comment: bool?,
838
+ crawl_pull_request_comment_attachment: bool?
839
+ }?,
840
+ repository_filter: Array[::String]?,
841
+ inclusion_folder_name_patterns: Array[::String]?,
842
+ inclusion_file_type_patterns: Array[::String]?,
843
+ inclusion_file_name_patterns: Array[::String]?,
844
+ exclusion_folder_name_patterns: Array[::String]?,
845
+ exclusion_file_type_patterns: Array[::String]?,
846
+ exclusion_file_name_patterns: Array[::String]?,
847
+ vpc_configuration: {
848
+ subnet_ids: Array[::String],
849
+ security_group_ids: Array[::String]
850
+ }?,
851
+ git_hub_repository_configuration_field_mappings: Array[
852
+ {
853
+ data_source_field_name: ::String,
854
+ date_field_format: ::String?,
855
+ index_field_name: ::String
856
+ },
857
+ ]?,
858
+ git_hub_commit_configuration_field_mappings: Array[
859
+ {
860
+ data_source_field_name: ::String,
861
+ date_field_format: ::String?,
862
+ index_field_name: ::String
863
+ },
864
+ ]?,
865
+ git_hub_issue_document_configuration_field_mappings: Array[
866
+ {
867
+ data_source_field_name: ::String,
868
+ date_field_format: ::String?,
869
+ index_field_name: ::String
870
+ },
871
+ ]?,
872
+ git_hub_issue_comment_configuration_field_mappings: Array[
873
+ {
874
+ data_source_field_name: ::String,
875
+ date_field_format: ::String?,
876
+ index_field_name: ::String
877
+ },
878
+ ]?,
879
+ git_hub_issue_attachment_configuration_field_mappings: Array[
880
+ {
881
+ data_source_field_name: ::String,
882
+ date_field_format: ::String?,
883
+ index_field_name: ::String
884
+ },
885
+ ]?,
886
+ git_hub_pull_request_comment_configuration_field_mappings: Array[
887
+ {
888
+ data_source_field_name: ::String,
889
+ date_field_format: ::String?,
890
+ index_field_name: ::String
891
+ },
892
+ ]?,
893
+ git_hub_pull_request_document_configuration_field_mappings: Array[
894
+ {
895
+ data_source_field_name: ::String,
896
+ date_field_format: ::String?,
897
+ index_field_name: ::String
898
+ },
899
+ ]?,
900
+ git_hub_pull_request_document_attachment_configuration_field_mappings: Array[
901
+ {
902
+ data_source_field_name: ::String,
903
+ date_field_format: ::String?,
904
+ index_field_name: ::String
905
+ },
906
+ ]?
907
+ }?,
908
+ alfresco_configuration: {
909
+ site_url: ::String,
910
+ site_id: ::String,
911
+ secret_arn: ::String,
912
+ ssl_certificate_s3_path: {
913
+ bucket: ::String,
914
+ key: ::String
915
+ },
916
+ crawl_system_folders: bool?,
917
+ crawl_comments: bool?,
918
+ entity_filter: Array[("wiki" | "blog" | "documentLibrary")]?,
919
+ document_library_field_mappings: Array[
920
+ {
921
+ data_source_field_name: ::String,
922
+ date_field_format: ::String?,
923
+ index_field_name: ::String
924
+ },
925
+ ]?,
926
+ blog_field_mappings: Array[
927
+ {
928
+ data_source_field_name: ::String,
929
+ date_field_format: ::String?,
930
+ index_field_name: ::String
931
+ },
932
+ ]?,
933
+ wiki_field_mappings: Array[
934
+ {
935
+ data_source_field_name: ::String,
936
+ date_field_format: ::String?,
937
+ index_field_name: ::String
938
+ },
939
+ ]?,
940
+ inclusion_patterns: Array[::String]?,
941
+ exclusion_patterns: Array[::String]?,
942
+ vpc_configuration: {
943
+ subnet_ids: Array[::String],
944
+ security_group_ids: Array[::String]
945
+ }?
946
+ }?,
947
+ template_configuration: {
948
+ template: {
949
+ }?
950
+ }?
951
+ },
952
+ ?vpc_configuration: {
953
+ subnet_ids: Array[::String],
954
+ security_group_ids: Array[::String]
955
+ },
956
+ ?description: ::String,
957
+ ?schedule: ::String,
958
+ ?role_arn: ::String,
959
+ ?tags: Array[
960
+ {
961
+ key: ::String,
962
+ value: ::String
963
+ },
964
+ ],
965
+ ?client_token: ::String,
966
+ ?language_code: ::String,
967
+ ?custom_document_enrichment_configuration: {
968
+ inline_configurations: Array[
969
+ {
970
+ condition: {
971
+ condition_document_attribute_key: ::String,
972
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
973
+ condition_on_value: {
974
+ string_value: ::String?,
975
+ string_list_value: Array[::String]?,
976
+ long_value: ::Integer?,
977
+ date_value: ::Time?
978
+ }?
979
+ }?,
980
+ target: {
981
+ target_document_attribute_key: ::String?,
982
+ target_document_attribute_value_deletion: bool?,
983
+ target_document_attribute_value: {
984
+ string_value: ::String?,
985
+ string_list_value: Array[::String]?,
986
+ long_value: ::Integer?,
987
+ date_value: ::Time?
988
+ }?
989
+ }?,
990
+ document_content_deletion: bool?
991
+ },
992
+ ]?,
993
+ pre_extraction_hook_configuration: {
994
+ invocation_condition: {
995
+ condition_document_attribute_key: ::String,
996
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
997
+ condition_on_value: {
998
+ string_value: ::String?,
999
+ string_list_value: Array[::String]?,
1000
+ long_value: ::Integer?,
1001
+ date_value: ::Time?
1002
+ }?
1003
+ }?,
1004
+ lambda_arn: ::String,
1005
+ s3_bucket: ::String
1006
+ }?,
1007
+ post_extraction_hook_configuration: {
1008
+ invocation_condition: {
1009
+ condition_document_attribute_key: ::String,
1010
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
1011
+ condition_on_value: {
1012
+ string_value: ::String?,
1013
+ string_list_value: Array[::String]?,
1014
+ long_value: ::Integer?,
1015
+ date_value: ::Time?
1016
+ }?
1017
+ }?,
1018
+ lambda_arn: ::String,
1019
+ s3_bucket: ::String
1020
+ }?,
1021
+ role_arn: ::String?
1022
+ }
1023
+ ) -> _CreateDataSourceResponseSuccess
1024
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDataSourceResponseSuccess
1025
+
1026
+ interface _CreateExperienceResponseSuccess
1027
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateExperienceResponse]
1028
+ def id: () -> ::String
1029
+ end
1030
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_experience-instance_method
1031
+ def create_experience: (
1032
+ name: ::String,
1033
+ index_id: ::String,
1034
+ ?role_arn: ::String,
1035
+ ?configuration: {
1036
+ content_source_configuration: {
1037
+ data_source_ids: Array[::String]?,
1038
+ faq_ids: Array[::String]?,
1039
+ direct_put_content: bool?
1040
+ }?,
1041
+ user_identity_configuration: {
1042
+ identity_attribute_name: ::String?
1043
+ }?
1044
+ },
1045
+ ?description: ::String,
1046
+ ?client_token: ::String
1047
+ ) -> _CreateExperienceResponseSuccess
1048
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateExperienceResponseSuccess
1049
+
1050
+ interface _CreateFaqResponseSuccess
1051
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateFaqResponse]
1052
+ def id: () -> ::String
1053
+ end
1054
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_faq-instance_method
1055
+ def create_faq: (
1056
+ index_id: ::String,
1057
+ name: ::String,
1058
+ ?description: ::String,
1059
+ s3_path: {
1060
+ bucket: ::String,
1061
+ key: ::String
1062
+ },
1063
+ role_arn: ::String,
1064
+ ?tags: Array[
1065
+ {
1066
+ key: ::String,
1067
+ value: ::String
1068
+ },
1069
+ ],
1070
+ ?file_format: ("CSV" | "CSV_WITH_HEADER" | "JSON"),
1071
+ ?client_token: ::String,
1072
+ ?language_code: ::String
1073
+ ) -> _CreateFaqResponseSuccess
1074
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFaqResponseSuccess
1075
+
1076
+ interface _CreateFeaturedResultsSetResponseSuccess
1077
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateFeaturedResultsSetResponse]
1078
+ def featured_results_set: () -> Types::FeaturedResultsSet
1079
+ end
1080
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_featured_results_set-instance_method
1081
+ def create_featured_results_set: (
1082
+ index_id: ::String,
1083
+ featured_results_set_name: ::String,
1084
+ ?description: ::String,
1085
+ ?client_token: ::String,
1086
+ ?status: ("ACTIVE" | "INACTIVE"),
1087
+ ?query_texts: Array[::String],
1088
+ ?featured_documents: Array[
1089
+ {
1090
+ id: ::String?
1091
+ },
1092
+ ],
1093
+ ?tags: Array[
1094
+ {
1095
+ key: ::String,
1096
+ value: ::String
1097
+ },
1098
+ ]
1099
+ ) -> _CreateFeaturedResultsSetResponseSuccess
1100
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFeaturedResultsSetResponseSuccess
1101
+
1102
+ interface _CreateIndexResponseSuccess
1103
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateIndexResponse]
1104
+ def id: () -> ::String
1105
+ end
1106
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_index-instance_method
1107
+ def create_index: (
1108
+ name: ::String,
1109
+ ?edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION"),
1110
+ role_arn: ::String,
1111
+ ?server_side_encryption_configuration: {
1112
+ kms_key_id: ::String?
1113
+ },
1114
+ ?description: ::String,
1115
+ ?client_token: ::String,
1116
+ ?tags: Array[
1117
+ {
1118
+ key: ::String,
1119
+ value: ::String
1120
+ },
1121
+ ],
1122
+ ?user_token_configurations: Array[
1123
+ {
1124
+ jwt_token_type_configuration: {
1125
+ key_location: ("URL" | "SECRET_MANAGER"),
1126
+ url: ::String?,
1127
+ secret_manager_arn: ::String?,
1128
+ user_name_attribute_field: ::String?,
1129
+ group_attribute_field: ::String?,
1130
+ issuer: ::String?,
1131
+ claim_regex: ::String?
1132
+ }?,
1133
+ json_token_type_configuration: {
1134
+ user_name_attribute_field: ::String,
1135
+ group_attribute_field: ::String
1136
+ }?
1137
+ },
1138
+ ],
1139
+ ?user_context_policy: ("ATTRIBUTE_FILTER" | "USER_TOKEN"),
1140
+ ?user_group_resolution_configuration: {
1141
+ user_group_resolution_mode: ("AWS_SSO" | "NONE")
1142
+ }
1143
+ ) -> _CreateIndexResponseSuccess
1144
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateIndexResponseSuccess
1145
+
1146
+ interface _CreateQuerySuggestionsBlockListResponseSuccess
1147
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateQuerySuggestionsBlockListResponse]
1148
+ def id: () -> ::String
1149
+ end
1150
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_query_suggestions_block_list-instance_method
1151
+ def create_query_suggestions_block_list: (
1152
+ index_id: ::String,
1153
+ name: ::String,
1154
+ ?description: ::String,
1155
+ source_s3_path: {
1156
+ bucket: ::String,
1157
+ key: ::String
1158
+ },
1159
+ ?client_token: ::String,
1160
+ role_arn: ::String,
1161
+ ?tags: Array[
1162
+ {
1163
+ key: ::String,
1164
+ value: ::String
1165
+ },
1166
+ ]
1167
+ ) -> _CreateQuerySuggestionsBlockListResponseSuccess
1168
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateQuerySuggestionsBlockListResponseSuccess
1169
+
1170
+ interface _CreateThesaurusResponseSuccess
1171
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateThesaurusResponse]
1172
+ def id: () -> ::String
1173
+ end
1174
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_thesaurus-instance_method
1175
+ def create_thesaurus: (
1176
+ index_id: ::String,
1177
+ name: ::String,
1178
+ ?description: ::String,
1179
+ role_arn: ::String,
1180
+ ?tags: Array[
1181
+ {
1182
+ key: ::String,
1183
+ value: ::String
1184
+ },
1185
+ ],
1186
+ source_s3_path: {
1187
+ bucket: ::String,
1188
+ key: ::String
1189
+ },
1190
+ ?client_token: ::String
1191
+ ) -> _CreateThesaurusResponseSuccess
1192
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateThesaurusResponseSuccess
1193
+
1194
+ interface _DeleteAccessControlConfigurationResponseSuccess
1195
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAccessControlConfigurationResponse]
1196
+ end
1197
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_access_control_configuration-instance_method
1198
+ def delete_access_control_configuration: (
1199
+ index_id: ::String,
1200
+ id: ::String
1201
+ ) -> _DeleteAccessControlConfigurationResponseSuccess
1202
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAccessControlConfigurationResponseSuccess
1203
+
1204
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_data_source-instance_method
1205
+ def delete_data_source: (
1206
+ id: ::String,
1207
+ index_id: ::String
1208
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1209
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1210
+
1211
+ interface _DeleteExperienceResponseSuccess
1212
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteExperienceResponse]
1213
+ end
1214
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_experience-instance_method
1215
+ def delete_experience: (
1216
+ id: ::String,
1217
+ index_id: ::String
1218
+ ) -> _DeleteExperienceResponseSuccess
1219
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteExperienceResponseSuccess
1220
+
1221
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_faq-instance_method
1222
+ def delete_faq: (
1223
+ id: ::String,
1224
+ index_id: ::String
1225
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1226
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1227
+
1228
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_index-instance_method
1229
+ def delete_index: (
1230
+ id: ::String
1231
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1232
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1233
+
1234
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_principal_mapping-instance_method
1235
+ def delete_principal_mapping: (
1236
+ index_id: ::String,
1237
+ ?data_source_id: ::String,
1238
+ group_id: ::String,
1239
+ ?ordering_id: ::Integer
1240
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1241
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1242
+
1243
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_query_suggestions_block_list-instance_method
1244
+ def delete_query_suggestions_block_list: (
1245
+ index_id: ::String,
1246
+ id: ::String
1247
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1248
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1249
+
1250
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#delete_thesaurus-instance_method
1251
+ def delete_thesaurus: (
1252
+ id: ::String,
1253
+ index_id: ::String
1254
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1255
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1256
+
1257
+ interface _DescribeAccessControlConfigurationResponseSuccess
1258
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeAccessControlConfigurationResponse]
1259
+ def name: () -> ::String
1260
+ def description: () -> ::String
1261
+ def error_message: () -> ::String
1262
+ def access_control_list: () -> ::Array[Types::Principal]
1263
+ def hierarchical_access_control_list: () -> ::Array[Types::HierarchicalPrincipal]
1264
+ end
1265
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_access_control_configuration-instance_method
1266
+ def describe_access_control_configuration: (
1267
+ index_id: ::String,
1268
+ id: ::String
1269
+ ) -> _DescribeAccessControlConfigurationResponseSuccess
1270
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeAccessControlConfigurationResponseSuccess
1271
+
1272
+ interface _DescribeDataSourceResponseSuccess
1273
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeDataSourceResponse]
1274
+ def id: () -> ::String
1275
+ def index_id: () -> ::String
1276
+ def name: () -> ::String
1277
+ def type: () -> ("S3" | "SHAREPOINT" | "DATABASE" | "SALESFORCE" | "ONEDRIVE" | "SERVICENOW" | "CUSTOM" | "CONFLUENCE" | "GOOGLEDRIVE" | "WEBCRAWLER" | "WORKDOCS" | "FSX" | "SLACK" | "BOX" | "QUIP" | "JIRA" | "GITHUB" | "ALFRESCO" | "TEMPLATE")
1278
+ def configuration: () -> Types::DataSourceConfiguration
1279
+ def vpc_configuration: () -> Types::DataSourceVpcConfiguration
1280
+ def created_at: () -> ::Time
1281
+ def updated_at: () -> ::Time
1282
+ def description: () -> ::String
1283
+ def status: () -> ("CREATING" | "DELETING" | "FAILED" | "UPDATING" | "ACTIVE")
1284
+ def schedule: () -> ::String
1285
+ def role_arn: () -> ::String
1286
+ def error_message: () -> ::String
1287
+ def language_code: () -> ::String
1288
+ def custom_document_enrichment_configuration: () -> Types::CustomDocumentEnrichmentConfiguration
1289
+ end
1290
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_data_source-instance_method
1291
+ def describe_data_source: (
1292
+ id: ::String,
1293
+ index_id: ::String
1294
+ ) -> _DescribeDataSourceResponseSuccess
1295
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeDataSourceResponseSuccess
1296
+
1297
+ interface _DescribeExperienceResponseSuccess
1298
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeExperienceResponse]
1299
+ def id: () -> ::String
1300
+ def index_id: () -> ::String
1301
+ def name: () -> ::String
1302
+ def endpoints: () -> ::Array[Types::ExperienceEndpoint]
1303
+ def configuration: () -> Types::ExperienceConfiguration
1304
+ def created_at: () -> ::Time
1305
+ def updated_at: () -> ::Time
1306
+ def description: () -> ::String
1307
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED")
1308
+ def role_arn: () -> ::String
1309
+ def error_message: () -> ::String
1310
+ end
1311
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_experience-instance_method
1312
+ def describe_experience: (
1313
+ id: ::String,
1314
+ index_id: ::String
1315
+ ) -> _DescribeExperienceResponseSuccess
1316
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeExperienceResponseSuccess
1317
+
1318
+ interface _DescribeFaqResponseSuccess
1319
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeFaqResponse]
1320
+ def id: () -> ::String
1321
+ def index_id: () -> ::String
1322
+ def name: () -> ::String
1323
+ def description: () -> ::String
1324
+ def created_at: () -> ::Time
1325
+ def updated_at: () -> ::Time
1326
+ def s3_path: () -> Types::S3Path
1327
+ def status: () -> ("CREATING" | "UPDATING" | "ACTIVE" | "DELETING" | "FAILED")
1328
+ def role_arn: () -> ::String
1329
+ def error_message: () -> ::String
1330
+ def file_format: () -> ("CSV" | "CSV_WITH_HEADER" | "JSON")
1331
+ def language_code: () -> ::String
1332
+ end
1333
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_faq-instance_method
1334
+ def describe_faq: (
1335
+ id: ::String,
1336
+ index_id: ::String
1337
+ ) -> _DescribeFaqResponseSuccess
1338
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeFaqResponseSuccess
1339
+
1340
+ interface _DescribeFeaturedResultsSetResponseSuccess
1341
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeFeaturedResultsSetResponse]
1342
+ def featured_results_set_id: () -> ::String
1343
+ def featured_results_set_name: () -> ::String
1344
+ def description: () -> ::String
1345
+ def status: () -> ("ACTIVE" | "INACTIVE")
1346
+ def query_texts: () -> ::Array[::String]
1347
+ def featured_documents_with_metadata: () -> ::Array[Types::FeaturedDocumentWithMetadata]
1348
+ def featured_documents_missing: () -> ::Array[Types::FeaturedDocumentMissing]
1349
+ def last_updated_timestamp: () -> ::Integer
1350
+ def creation_timestamp: () -> ::Integer
1351
+ end
1352
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_featured_results_set-instance_method
1353
+ def describe_featured_results_set: (
1354
+ index_id: ::String,
1355
+ featured_results_set_id: ::String
1356
+ ) -> _DescribeFeaturedResultsSetResponseSuccess
1357
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeFeaturedResultsSetResponseSuccess
1358
+
1359
+ interface _DescribeIndexResponseSuccess
1360
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeIndexResponse]
1361
+ def name: () -> ::String
1362
+ def id: () -> ::String
1363
+ def edition: () -> ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION")
1364
+ def role_arn: () -> ::String
1365
+ def server_side_encryption_configuration: () -> Types::ServerSideEncryptionConfiguration
1366
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING" | "SYSTEM_UPDATING")
1367
+ def description: () -> ::String
1368
+ def created_at: () -> ::Time
1369
+ def updated_at: () -> ::Time
1370
+ def document_metadata_configurations: () -> ::Array[Types::DocumentMetadataConfiguration]
1371
+ def index_statistics: () -> Types::IndexStatistics
1372
+ def error_message: () -> ::String
1373
+ def capacity_units: () -> Types::CapacityUnitsConfiguration
1374
+ def user_token_configurations: () -> ::Array[Types::UserTokenConfiguration]
1375
+ def user_context_policy: () -> ("ATTRIBUTE_FILTER" | "USER_TOKEN")
1376
+ def user_group_resolution_configuration: () -> Types::UserGroupResolutionConfiguration
1377
+ end
1378
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_index-instance_method
1379
+ def describe_index: (
1380
+ id: ::String
1381
+ ) -> _DescribeIndexResponseSuccess
1382
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeIndexResponseSuccess
1383
+
1384
+ interface _DescribePrincipalMappingResponseSuccess
1385
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribePrincipalMappingResponse]
1386
+ def index_id: () -> ::String
1387
+ def data_source_id: () -> ::String
1388
+ def group_id: () -> ::String
1389
+ def group_ordering_id_summaries: () -> ::Array[Types::GroupOrderingIdSummary]
1390
+ end
1391
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_principal_mapping-instance_method
1392
+ def describe_principal_mapping: (
1393
+ index_id: ::String,
1394
+ ?data_source_id: ::String,
1395
+ group_id: ::String
1396
+ ) -> _DescribePrincipalMappingResponseSuccess
1397
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribePrincipalMappingResponseSuccess
1398
+
1399
+ interface _DescribeQuerySuggestionsBlockListResponseSuccess
1400
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeQuerySuggestionsBlockListResponse]
1401
+ def index_id: () -> ::String
1402
+ def id: () -> ::String
1403
+ def name: () -> ::String
1404
+ def description: () -> ::String
1405
+ def status: () -> ("ACTIVE" | "CREATING" | "DELETING" | "UPDATING" | "ACTIVE_BUT_UPDATE_FAILED" | "FAILED")
1406
+ def error_message: () -> ::String
1407
+ def created_at: () -> ::Time
1408
+ def updated_at: () -> ::Time
1409
+ def source_s3_path: () -> Types::S3Path
1410
+ def item_count: () -> ::Integer
1411
+ def file_size_bytes: () -> ::Integer
1412
+ def role_arn: () -> ::String
1413
+ end
1414
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_query_suggestions_block_list-instance_method
1415
+ def describe_query_suggestions_block_list: (
1416
+ index_id: ::String,
1417
+ id: ::String
1418
+ ) -> _DescribeQuerySuggestionsBlockListResponseSuccess
1419
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeQuerySuggestionsBlockListResponseSuccess
1420
+
1421
+ interface _DescribeQuerySuggestionsConfigResponseSuccess
1422
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeQuerySuggestionsConfigResponse]
1423
+ def mode: () -> ("ENABLED" | "LEARN_ONLY")
1424
+ def status: () -> ("ACTIVE" | "UPDATING")
1425
+ def query_log_look_back_window_in_days: () -> ::Integer
1426
+ def include_queries_without_user_information: () -> bool
1427
+ def minimum_number_of_querying_users: () -> ::Integer
1428
+ def minimum_query_count: () -> ::Integer
1429
+ def last_suggestions_build_time: () -> ::Time
1430
+ def last_clear_time: () -> ::Time
1431
+ def total_suggestions_count: () -> ::Integer
1432
+ def attribute_suggestions_config: () -> Types::AttributeSuggestionsDescribeConfig
1433
+ end
1434
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_query_suggestions_config-instance_method
1435
+ def describe_query_suggestions_config: (
1436
+ index_id: ::String
1437
+ ) -> _DescribeQuerySuggestionsConfigResponseSuccess
1438
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeQuerySuggestionsConfigResponseSuccess
1439
+
1440
+ interface _DescribeThesaurusResponseSuccess
1441
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeThesaurusResponse]
1442
+ def id: () -> ::String
1443
+ def index_id: () -> ::String
1444
+ def name: () -> ::String
1445
+ def description: () -> ::String
1446
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "ACTIVE_BUT_UPDATE_FAILED" | "FAILED")
1447
+ def error_message: () -> ::String
1448
+ def created_at: () -> ::Time
1449
+ def updated_at: () -> ::Time
1450
+ def role_arn: () -> ::String
1451
+ def source_s3_path: () -> Types::S3Path
1452
+ def file_size_bytes: () -> ::Integer
1453
+ def term_count: () -> ::Integer
1454
+ def synonym_rule_count: () -> ::Integer
1455
+ end
1456
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#describe_thesaurus-instance_method
1457
+ def describe_thesaurus: (
1458
+ id: ::String,
1459
+ index_id: ::String
1460
+ ) -> _DescribeThesaurusResponseSuccess
1461
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeThesaurusResponseSuccess
1462
+
1463
+ interface _DisassociateEntitiesFromExperienceResponseSuccess
1464
+ include ::Seahorse::Client::_ResponseSuccess[Types::DisassociateEntitiesFromExperienceResponse]
1465
+ def failed_entity_list: () -> ::Array[Types::FailedEntity]
1466
+ end
1467
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#disassociate_entities_from_experience-instance_method
1468
+ def disassociate_entities_from_experience: (
1469
+ id: ::String,
1470
+ index_id: ::String,
1471
+ entity_list: Array[
1472
+ {
1473
+ entity_id: ::String,
1474
+ entity_type: ("USER" | "GROUP")
1475
+ },
1476
+ ]
1477
+ ) -> _DisassociateEntitiesFromExperienceResponseSuccess
1478
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateEntitiesFromExperienceResponseSuccess
1479
+
1480
+ interface _DisassociatePersonasFromEntitiesResponseSuccess
1481
+ include ::Seahorse::Client::_ResponseSuccess[Types::DisassociatePersonasFromEntitiesResponse]
1482
+ def failed_entity_list: () -> ::Array[Types::FailedEntity]
1483
+ end
1484
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#disassociate_personas_from_entities-instance_method
1485
+ def disassociate_personas_from_entities: (
1486
+ id: ::String,
1487
+ index_id: ::String,
1488
+ entity_ids: Array[::String]
1489
+ ) -> _DisassociatePersonasFromEntitiesResponseSuccess
1490
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociatePersonasFromEntitiesResponseSuccess
1491
+
1492
+ interface _GetQuerySuggestionsResponseSuccess
1493
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetQuerySuggestionsResponse]
1494
+ def query_suggestions_id: () -> ::String
1495
+ def suggestions: () -> ::Array[Types::Suggestion]
1496
+ end
1497
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#get_query_suggestions-instance_method
1498
+ def get_query_suggestions: (
1499
+ index_id: ::String,
1500
+ query_text: ::String,
1501
+ ?max_suggestions_count: ::Integer,
1502
+ ?suggestion_types: Array[("QUERY" | "DOCUMENT_ATTRIBUTES")],
1503
+ ?attribute_suggestions_config: {
1504
+ suggestion_attributes: Array[::String]?,
1505
+ additional_response_attributes: Array[::String]?,
1506
+ attribute_filter: {
1507
+ and_all_filters: Array[
1508
+ untyped,
1509
+ ]?,
1510
+ or_all_filters: Array[
1511
+ untyped,
1512
+ ]?,
1513
+ not_filter: untyped?,
1514
+ equals_to: {
1515
+ key: ::String,
1516
+ value: {
1517
+ string_value: ::String?,
1518
+ string_list_value: Array[::String]?,
1519
+ long_value: ::Integer?,
1520
+ date_value: ::Time?
1521
+ }
1522
+ }?,
1523
+ contains_all: {
1524
+ key: ::String,
1525
+ value: {
1526
+ string_value: ::String?,
1527
+ string_list_value: Array[::String]?,
1528
+ long_value: ::Integer?,
1529
+ date_value: ::Time?
1530
+ }
1531
+ }?,
1532
+ contains_any: {
1533
+ key: ::String,
1534
+ value: {
1535
+ string_value: ::String?,
1536
+ string_list_value: Array[::String]?,
1537
+ long_value: ::Integer?,
1538
+ date_value: ::Time?
1539
+ }
1540
+ }?,
1541
+ greater_than: {
1542
+ key: ::String,
1543
+ value: {
1544
+ string_value: ::String?,
1545
+ string_list_value: Array[::String]?,
1546
+ long_value: ::Integer?,
1547
+ date_value: ::Time?
1548
+ }
1549
+ }?,
1550
+ greater_than_or_equals: {
1551
+ key: ::String,
1552
+ value: {
1553
+ string_value: ::String?,
1554
+ string_list_value: Array[::String]?,
1555
+ long_value: ::Integer?,
1556
+ date_value: ::Time?
1557
+ }
1558
+ }?,
1559
+ less_than: {
1560
+ key: ::String,
1561
+ value: {
1562
+ string_value: ::String?,
1563
+ string_list_value: Array[::String]?,
1564
+ long_value: ::Integer?,
1565
+ date_value: ::Time?
1566
+ }
1567
+ }?,
1568
+ less_than_or_equals: {
1569
+ key: ::String,
1570
+ value: {
1571
+ string_value: ::String?,
1572
+ string_list_value: Array[::String]?,
1573
+ long_value: ::Integer?,
1574
+ date_value: ::Time?
1575
+ }
1576
+ }?
1577
+ }?,
1578
+ user_context: {
1579
+ token: ::String?,
1580
+ user_id: ::String?,
1581
+ groups: Array[::String]?,
1582
+ data_source_groups: Array[
1583
+ {
1584
+ group_id: ::String,
1585
+ data_source_id: ::String
1586
+ },
1587
+ ]?
1588
+ }?
1589
+ }
1590
+ ) -> _GetQuerySuggestionsResponseSuccess
1591
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetQuerySuggestionsResponseSuccess
1592
+
1593
+ interface _GetSnapshotsResponseSuccess
1594
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetSnapshotsResponse]
1595
+ def snap_shot_time_filter: () -> Types::TimeRange
1596
+ def snapshots_data_header: () -> ::Array[::String]
1597
+ def snapshots_data: () -> ::Array[::Array[::String]]
1598
+ def next_token: () -> ::String
1599
+ end
1600
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#get_snapshots-instance_method
1601
+ def get_snapshots: (
1602
+ index_id: ::String,
1603
+ interval: ("THIS_MONTH" | "THIS_WEEK" | "ONE_WEEK_AGO" | "TWO_WEEKS_AGO" | "ONE_MONTH_AGO" | "TWO_MONTHS_AGO"),
1604
+ metric_type: ("QUERIES_BY_COUNT" | "QUERIES_BY_ZERO_CLICK_RATE" | "QUERIES_BY_ZERO_RESULT_RATE" | "DOCS_BY_CLICK_COUNT" | "AGG_QUERY_DOC_METRICS" | "TREND_QUERY_DOC_METRICS"),
1605
+ ?next_token: ::String,
1606
+ ?max_results: ::Integer
1607
+ ) -> _GetSnapshotsResponseSuccess
1608
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSnapshotsResponseSuccess
1609
+
1610
+ interface _ListAccessControlConfigurationsResponseSuccess
1611
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAccessControlConfigurationsResponse]
1612
+ def next_token: () -> ::String
1613
+ def access_control_configurations: () -> ::Array[Types::AccessControlConfigurationSummary]
1614
+ end
1615
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_access_control_configurations-instance_method
1616
+ def list_access_control_configurations: (
1617
+ index_id: ::String,
1618
+ ?next_token: ::String,
1619
+ ?max_results: ::Integer
1620
+ ) -> _ListAccessControlConfigurationsResponseSuccess
1621
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAccessControlConfigurationsResponseSuccess
1622
+
1623
+ interface _ListDataSourceSyncJobsResponseSuccess
1624
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDataSourceSyncJobsResponse]
1625
+ def history: () -> ::Array[Types::DataSourceSyncJob]
1626
+ def next_token: () -> ::String
1627
+ end
1628
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_data_source_sync_jobs-instance_method
1629
+ def list_data_source_sync_jobs: (
1630
+ id: ::String,
1631
+ index_id: ::String,
1632
+ ?next_token: ::String,
1633
+ ?max_results: ::Integer,
1634
+ ?start_time_filter: {
1635
+ start_time: ::Time?,
1636
+ end_time: ::Time?
1637
+ },
1638
+ ?status_filter: ("FAILED" | "SUCCEEDED" | "SYNCING" | "INCOMPLETE" | "STOPPING" | "ABORTED" | "SYNCING_INDEXING")
1639
+ ) -> _ListDataSourceSyncJobsResponseSuccess
1640
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourceSyncJobsResponseSuccess
1641
+
1642
+ interface _ListDataSourcesResponseSuccess
1643
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDataSourcesResponse]
1644
+ def summary_items: () -> ::Array[Types::DataSourceSummary]
1645
+ def next_token: () -> ::String
1646
+ end
1647
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_data_sources-instance_method
1648
+ def list_data_sources: (
1649
+ index_id: ::String,
1650
+ ?next_token: ::String,
1651
+ ?max_results: ::Integer
1652
+ ) -> _ListDataSourcesResponseSuccess
1653
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourcesResponseSuccess
1654
+
1655
+ interface _ListEntityPersonasResponseSuccess
1656
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListEntityPersonasResponse]
1657
+ def summary_items: () -> ::Array[Types::PersonasSummary]
1658
+ def next_token: () -> ::String
1659
+ end
1660
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_entity_personas-instance_method
1661
+ def list_entity_personas: (
1662
+ id: ::String,
1663
+ index_id: ::String,
1664
+ ?next_token: ::String,
1665
+ ?max_results: ::Integer
1666
+ ) -> _ListEntityPersonasResponseSuccess
1667
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEntityPersonasResponseSuccess
1668
+
1669
+ interface _ListExperienceEntitiesResponseSuccess
1670
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListExperienceEntitiesResponse]
1671
+ def summary_items: () -> ::Array[Types::ExperienceEntitiesSummary]
1672
+ def next_token: () -> ::String
1673
+ end
1674
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_experience_entities-instance_method
1675
+ def list_experience_entities: (
1676
+ id: ::String,
1677
+ index_id: ::String,
1678
+ ?next_token: ::String
1679
+ ) -> _ListExperienceEntitiesResponseSuccess
1680
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListExperienceEntitiesResponseSuccess
1681
+
1682
+ interface _ListExperiencesResponseSuccess
1683
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListExperiencesResponse]
1684
+ def summary_items: () -> ::Array[Types::ExperiencesSummary]
1685
+ def next_token: () -> ::String
1686
+ end
1687
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_experiences-instance_method
1688
+ def list_experiences: (
1689
+ index_id: ::String,
1690
+ ?next_token: ::String,
1691
+ ?max_results: ::Integer
1692
+ ) -> _ListExperiencesResponseSuccess
1693
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListExperiencesResponseSuccess
1694
+
1695
+ interface _ListFaqsResponseSuccess
1696
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListFaqsResponse]
1697
+ def next_token: () -> ::String
1698
+ def faq_summary_items: () -> ::Array[Types::FaqSummary]
1699
+ end
1700
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_faqs-instance_method
1701
+ def list_faqs: (
1702
+ index_id: ::String,
1703
+ ?next_token: ::String,
1704
+ ?max_results: ::Integer
1705
+ ) -> _ListFaqsResponseSuccess
1706
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFaqsResponseSuccess
1707
+
1708
+ interface _ListFeaturedResultsSetsResponseSuccess
1709
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListFeaturedResultsSetsResponse]
1710
+ def featured_results_set_summary_items: () -> ::Array[Types::FeaturedResultsSetSummary]
1711
+ def next_token: () -> ::String
1712
+ end
1713
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_featured_results_sets-instance_method
1714
+ def list_featured_results_sets: (
1715
+ index_id: ::String,
1716
+ ?next_token: ::String,
1717
+ ?max_results: ::Integer
1718
+ ) -> _ListFeaturedResultsSetsResponseSuccess
1719
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFeaturedResultsSetsResponseSuccess
1720
+
1721
+ interface _ListGroupsOlderThanOrderingIdResponseSuccess
1722
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListGroupsOlderThanOrderingIdResponse]
1723
+ def groups_summaries: () -> ::Array[Types::GroupSummary]
1724
+ def next_token: () -> ::String
1725
+ end
1726
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_groups_older_than_ordering_id-instance_method
1727
+ def list_groups_older_than_ordering_id: (
1728
+ index_id: ::String,
1729
+ ?data_source_id: ::String,
1730
+ ordering_id: ::Integer,
1731
+ ?next_token: ::String,
1732
+ ?max_results: ::Integer
1733
+ ) -> _ListGroupsOlderThanOrderingIdResponseSuccess
1734
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListGroupsOlderThanOrderingIdResponseSuccess
1735
+
1736
+ interface _ListIndicesResponseSuccess
1737
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListIndicesResponse]
1738
+ def index_configuration_summary_items: () -> ::Array[Types::IndexConfigurationSummary]
1739
+ def next_token: () -> ::String
1740
+ end
1741
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_indices-instance_method
1742
+ def list_indices: (
1743
+ ?next_token: ::String,
1744
+ ?max_results: ::Integer
1745
+ ) -> _ListIndicesResponseSuccess
1746
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListIndicesResponseSuccess
1747
+
1748
+ interface _ListQuerySuggestionsBlockListsResponseSuccess
1749
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListQuerySuggestionsBlockListsResponse]
1750
+ def block_list_summary_items: () -> ::Array[Types::QuerySuggestionsBlockListSummary]
1751
+ def next_token: () -> ::String
1752
+ end
1753
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_query_suggestions_block_lists-instance_method
1754
+ def list_query_suggestions_block_lists: (
1755
+ index_id: ::String,
1756
+ ?next_token: ::String,
1757
+ ?max_results: ::Integer
1758
+ ) -> _ListQuerySuggestionsBlockListsResponseSuccess
1759
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListQuerySuggestionsBlockListsResponseSuccess
1760
+
1761
+ interface _ListTagsForResourceResponseSuccess
1762
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
1763
+ def tags: () -> ::Array[Types::Tag]
1764
+ end
1765
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_tags_for_resource-instance_method
1766
+ def list_tags_for_resource: (
1767
+ resource_arn: ::String
1768
+ ) -> _ListTagsForResourceResponseSuccess
1769
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
1770
+
1771
+ interface _ListThesauriResponseSuccess
1772
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListThesauriResponse]
1773
+ def next_token: () -> ::String
1774
+ def thesaurus_summary_items: () -> ::Array[Types::ThesaurusSummary]
1775
+ end
1776
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#list_thesauri-instance_method
1777
+ def list_thesauri: (
1778
+ index_id: ::String,
1779
+ ?next_token: ::String,
1780
+ ?max_results: ::Integer
1781
+ ) -> _ListThesauriResponseSuccess
1782
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListThesauriResponseSuccess
1783
+
1784
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#put_principal_mapping-instance_method
1785
+ def put_principal_mapping: (
1786
+ index_id: ::String,
1787
+ ?data_source_id: ::String,
1788
+ group_id: ::String,
1789
+ group_members: {
1790
+ member_groups: Array[
1791
+ {
1792
+ group_id: ::String,
1793
+ data_source_id: ::String?
1794
+ },
1795
+ ]?,
1796
+ member_users: Array[
1797
+ {
1798
+ user_id: ::String
1799
+ },
1800
+ ]?,
1801
+ s3_pathfor_group_members: {
1802
+ bucket: ::String,
1803
+ key: ::String
1804
+ }?
1805
+ },
1806
+ ?ordering_id: ::Integer,
1807
+ ?role_arn: ::String
1808
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1809
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1810
+
1811
+ interface _QueryResponseSuccess
1812
+ include ::Seahorse::Client::_ResponseSuccess[Types::QueryResult]
1813
+ def query_id: () -> ::String
1814
+ def result_items: () -> ::Array[Types::QueryResultItem]
1815
+ def facet_results: () -> ::Array[Types::FacetResult]
1816
+ def total_number_of_results: () -> ::Integer
1817
+ def warnings: () -> ::Array[Types::Warning]
1818
+ def spell_corrected_queries: () -> ::Array[Types::SpellCorrectedQuery]
1819
+ def featured_results_items: () -> ::Array[Types::FeaturedResultsItem]
1820
+ end
1821
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#query-instance_method
1822
+ def query: (
1823
+ index_id: ::String,
1824
+ ?query_text: ::String,
1825
+ ?attribute_filter: {
1826
+ and_all_filters: Array[
1827
+ untyped,
1828
+ ]?,
1829
+ or_all_filters: Array[
1830
+ untyped,
1831
+ ]?,
1832
+ not_filter: untyped?,
1833
+ equals_to: {
1834
+ key: ::String,
1835
+ value: {
1836
+ string_value: ::String?,
1837
+ string_list_value: Array[::String]?,
1838
+ long_value: ::Integer?,
1839
+ date_value: ::Time?
1840
+ }
1841
+ }?,
1842
+ contains_all: {
1843
+ key: ::String,
1844
+ value: {
1845
+ string_value: ::String?,
1846
+ string_list_value: Array[::String]?,
1847
+ long_value: ::Integer?,
1848
+ date_value: ::Time?
1849
+ }
1850
+ }?,
1851
+ contains_any: {
1852
+ key: ::String,
1853
+ value: {
1854
+ string_value: ::String?,
1855
+ string_list_value: Array[::String]?,
1856
+ long_value: ::Integer?,
1857
+ date_value: ::Time?
1858
+ }
1859
+ }?,
1860
+ greater_than: {
1861
+ key: ::String,
1862
+ value: {
1863
+ string_value: ::String?,
1864
+ string_list_value: Array[::String]?,
1865
+ long_value: ::Integer?,
1866
+ date_value: ::Time?
1867
+ }
1868
+ }?,
1869
+ greater_than_or_equals: {
1870
+ key: ::String,
1871
+ value: {
1872
+ string_value: ::String?,
1873
+ string_list_value: Array[::String]?,
1874
+ long_value: ::Integer?,
1875
+ date_value: ::Time?
1876
+ }
1877
+ }?,
1878
+ less_than: {
1879
+ key: ::String,
1880
+ value: {
1881
+ string_value: ::String?,
1882
+ string_list_value: Array[::String]?,
1883
+ long_value: ::Integer?,
1884
+ date_value: ::Time?
1885
+ }
1886
+ }?,
1887
+ less_than_or_equals: {
1888
+ key: ::String,
1889
+ value: {
1890
+ string_value: ::String?,
1891
+ string_list_value: Array[::String]?,
1892
+ long_value: ::Integer?,
1893
+ date_value: ::Time?
1894
+ }
1895
+ }?
1896
+ },
1897
+ ?facets: Array[
1898
+ {
1899
+ document_attribute_key: ::String?,
1900
+ facets: untyped?,
1901
+ max_results: ::Integer?
1902
+ },
1903
+ ],
1904
+ ?requested_document_attributes: Array[::String],
1905
+ ?query_result_type_filter: ("DOCUMENT" | "QUESTION_ANSWER" | "ANSWER"),
1906
+ ?document_relevance_override_configurations: Array[
1907
+ {
1908
+ name: ::String,
1909
+ relevance: {
1910
+ freshness: bool?,
1911
+ importance: ::Integer?,
1912
+ duration: ::String?,
1913
+ rank_order: ("ASCENDING" | "DESCENDING")?,
1914
+ value_importance_map: Hash[::String, ::Integer]?
1915
+ }
1916
+ },
1917
+ ],
1918
+ ?page_number: ::Integer,
1919
+ ?page_size: ::Integer,
1920
+ ?sorting_configuration: {
1921
+ document_attribute_key: ::String,
1922
+ sort_order: ("DESC" | "ASC")
1923
+ },
1924
+ ?sorting_configurations: Array[
1925
+ {
1926
+ document_attribute_key: ::String,
1927
+ sort_order: ("DESC" | "ASC")
1928
+ },
1929
+ ],
1930
+ ?user_context: {
1931
+ token: ::String?,
1932
+ user_id: ::String?,
1933
+ groups: Array[::String]?,
1934
+ data_source_groups: Array[
1935
+ {
1936
+ group_id: ::String,
1937
+ data_source_id: ::String
1938
+ },
1939
+ ]?
1940
+ },
1941
+ ?visitor_id: ::String,
1942
+ ?spell_correction_configuration: {
1943
+ include_query_spell_check_suggestions: bool
1944
+ },
1945
+ ?collapse_configuration: {
1946
+ document_attribute_key: ::String,
1947
+ sorting_configurations: Array[
1948
+ {
1949
+ document_attribute_key: ::String,
1950
+ sort_order: ("DESC" | "ASC")
1951
+ },
1952
+ ]?,
1953
+ missing_attribute_key_strategy: ("IGNORE" | "COLLAPSE" | "EXPAND")?,
1954
+ expand: bool?,
1955
+ expand_configuration: {
1956
+ max_result_items_to_expand: ::Integer?,
1957
+ max_expanded_results_per_item: ::Integer?
1958
+ }?
1959
+ }
1960
+ ) -> _QueryResponseSuccess
1961
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _QueryResponseSuccess
1962
+
1963
+ interface _RetrieveResponseSuccess
1964
+ include ::Seahorse::Client::_ResponseSuccess[Types::RetrieveResult]
1965
+ def query_id: () -> ::String
1966
+ def result_items: () -> ::Array[Types::RetrieveResultItem]
1967
+ end
1968
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#retrieve-instance_method
1969
+ def retrieve: (
1970
+ index_id: ::String,
1971
+ query_text: ::String,
1972
+ ?attribute_filter: {
1973
+ and_all_filters: Array[
1974
+ untyped,
1975
+ ]?,
1976
+ or_all_filters: Array[
1977
+ untyped,
1978
+ ]?,
1979
+ not_filter: untyped?,
1980
+ equals_to: {
1981
+ key: ::String,
1982
+ value: {
1983
+ string_value: ::String?,
1984
+ string_list_value: Array[::String]?,
1985
+ long_value: ::Integer?,
1986
+ date_value: ::Time?
1987
+ }
1988
+ }?,
1989
+ contains_all: {
1990
+ key: ::String,
1991
+ value: {
1992
+ string_value: ::String?,
1993
+ string_list_value: Array[::String]?,
1994
+ long_value: ::Integer?,
1995
+ date_value: ::Time?
1996
+ }
1997
+ }?,
1998
+ contains_any: {
1999
+ key: ::String,
2000
+ value: {
2001
+ string_value: ::String?,
2002
+ string_list_value: Array[::String]?,
2003
+ long_value: ::Integer?,
2004
+ date_value: ::Time?
2005
+ }
2006
+ }?,
2007
+ greater_than: {
2008
+ key: ::String,
2009
+ value: {
2010
+ string_value: ::String?,
2011
+ string_list_value: Array[::String]?,
2012
+ long_value: ::Integer?,
2013
+ date_value: ::Time?
2014
+ }
2015
+ }?,
2016
+ greater_than_or_equals: {
2017
+ key: ::String,
2018
+ value: {
2019
+ string_value: ::String?,
2020
+ string_list_value: Array[::String]?,
2021
+ long_value: ::Integer?,
2022
+ date_value: ::Time?
2023
+ }
2024
+ }?,
2025
+ less_than: {
2026
+ key: ::String,
2027
+ value: {
2028
+ string_value: ::String?,
2029
+ string_list_value: Array[::String]?,
2030
+ long_value: ::Integer?,
2031
+ date_value: ::Time?
2032
+ }
2033
+ }?,
2034
+ less_than_or_equals: {
2035
+ key: ::String,
2036
+ value: {
2037
+ string_value: ::String?,
2038
+ string_list_value: Array[::String]?,
2039
+ long_value: ::Integer?,
2040
+ date_value: ::Time?
2041
+ }
2042
+ }?
2043
+ },
2044
+ ?requested_document_attributes: Array[::String],
2045
+ ?document_relevance_override_configurations: Array[
2046
+ {
2047
+ name: ::String,
2048
+ relevance: {
2049
+ freshness: bool?,
2050
+ importance: ::Integer?,
2051
+ duration: ::String?,
2052
+ rank_order: ("ASCENDING" | "DESCENDING")?,
2053
+ value_importance_map: Hash[::String, ::Integer]?
2054
+ }
2055
+ },
2056
+ ],
2057
+ ?page_number: ::Integer,
2058
+ ?page_size: ::Integer,
2059
+ ?user_context: {
2060
+ token: ::String?,
2061
+ user_id: ::String?,
2062
+ groups: Array[::String]?,
2063
+ data_source_groups: Array[
2064
+ {
2065
+ group_id: ::String,
2066
+ data_source_id: ::String
2067
+ },
2068
+ ]?
2069
+ }
2070
+ ) -> _RetrieveResponseSuccess
2071
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RetrieveResponseSuccess
2072
+
2073
+ interface _StartDataSourceSyncJobResponseSuccess
2074
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartDataSourceSyncJobResponse]
2075
+ def execution_id: () -> ::String
2076
+ end
2077
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#start_data_source_sync_job-instance_method
2078
+ def start_data_source_sync_job: (
2079
+ id: ::String,
2080
+ index_id: ::String
2081
+ ) -> _StartDataSourceSyncJobResponseSuccess
2082
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartDataSourceSyncJobResponseSuccess
2083
+
2084
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#stop_data_source_sync_job-instance_method
2085
+ def stop_data_source_sync_job: (
2086
+ id: ::String,
2087
+ index_id: ::String
2088
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2089
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2090
+
2091
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#submit_feedback-instance_method
2092
+ def submit_feedback: (
2093
+ index_id: ::String,
2094
+ query_id: ::String,
2095
+ ?click_feedback_items: Array[
2096
+ {
2097
+ result_id: ::String,
2098
+ click_time: ::Time
2099
+ },
2100
+ ],
2101
+ ?relevance_feedback_items: Array[
2102
+ {
2103
+ result_id: ::String,
2104
+ relevance_value: ("RELEVANT" | "NOT_RELEVANT")
2105
+ },
2106
+ ]
2107
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2108
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2109
+
2110
+ interface _TagResourceResponseSuccess
2111
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
2112
+ end
2113
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#tag_resource-instance_method
2114
+ def tag_resource: (
2115
+ resource_arn: ::String,
2116
+ tags: Array[
2117
+ {
2118
+ key: ::String,
2119
+ value: ::String
2120
+ },
2121
+ ]
2122
+ ) -> _TagResourceResponseSuccess
2123
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
2124
+
2125
+ interface _UntagResourceResponseSuccess
2126
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
2127
+ end
2128
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#untag_resource-instance_method
2129
+ def untag_resource: (
2130
+ resource_arn: ::String,
2131
+ tag_keys: Array[::String]
2132
+ ) -> _UntagResourceResponseSuccess
2133
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
2134
+
2135
+ interface _UpdateAccessControlConfigurationResponseSuccess
2136
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAccessControlConfigurationResponse]
2137
+ end
2138
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_access_control_configuration-instance_method
2139
+ def update_access_control_configuration: (
2140
+ index_id: ::String,
2141
+ id: ::String,
2142
+ ?name: ::String,
2143
+ ?description: ::String,
2144
+ ?access_control_list: Array[
2145
+ {
2146
+ name: ::String,
2147
+ type: ("USER" | "GROUP"),
2148
+ access: ("ALLOW" | "DENY"),
2149
+ data_source_id: ::String?
2150
+ },
2151
+ ],
2152
+ ?hierarchical_access_control_list: Array[
2153
+ {
2154
+ principal_list: Array[
2155
+ {
2156
+ name: ::String,
2157
+ type: ("USER" | "GROUP"),
2158
+ access: ("ALLOW" | "DENY"),
2159
+ data_source_id: ::String?
2160
+ },
2161
+ ]
2162
+ },
2163
+ ]
2164
+ ) -> _UpdateAccessControlConfigurationResponseSuccess
2165
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAccessControlConfigurationResponseSuccess
2166
+
2167
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_data_source-instance_method
2168
+ def update_data_source: (
2169
+ id: ::String,
2170
+ ?name: ::String,
2171
+ index_id: ::String,
2172
+ ?configuration: {
2173
+ s3_configuration: {
2174
+ bucket_name: ::String,
2175
+ inclusion_prefixes: Array[::String]?,
2176
+ inclusion_patterns: Array[::String]?,
2177
+ exclusion_patterns: Array[::String]?,
2178
+ documents_metadata_configuration: {
2179
+ s3_prefix: ::String?
2180
+ }?,
2181
+ access_control_list_configuration: {
2182
+ key_path: ::String?
2183
+ }?
2184
+ }?,
2185
+ share_point_configuration: {
2186
+ share_point_version: ("SHAREPOINT_2013" | "SHAREPOINT_2016" | "SHAREPOINT_ONLINE" | "SHAREPOINT_2019"),
2187
+ urls: Array[::String],
2188
+ secret_arn: ::String,
2189
+ crawl_attachments: bool?,
2190
+ use_change_log: bool?,
2191
+ inclusion_patterns: Array[::String]?,
2192
+ exclusion_patterns: Array[::String]?,
2193
+ vpc_configuration: {
2194
+ subnet_ids: Array[::String],
2195
+ security_group_ids: Array[::String]
2196
+ }?,
2197
+ field_mappings: Array[
2198
+ {
2199
+ data_source_field_name: ::String,
2200
+ date_field_format: ::String?,
2201
+ index_field_name: ::String
2202
+ },
2203
+ ]?,
2204
+ document_title_field_name: ::String?,
2205
+ disable_local_groups: bool?,
2206
+ ssl_certificate_s3_path: {
2207
+ bucket: ::String,
2208
+ key: ::String
2209
+ }?,
2210
+ authentication_type: ("HTTP_BASIC" | "OAUTH2")?,
2211
+ proxy_configuration: {
2212
+ host: ::String,
2213
+ port: ::Integer,
2214
+ credentials: ::String?
2215
+ }?
2216
+ }?,
2217
+ database_configuration: {
2218
+ database_engine_type: ("RDS_AURORA_MYSQL" | "RDS_AURORA_POSTGRESQL" | "RDS_MYSQL" | "RDS_POSTGRESQL"),
2219
+ connection_configuration: {
2220
+ database_host: ::String,
2221
+ database_port: ::Integer,
2222
+ database_name: ::String,
2223
+ table_name: ::String,
2224
+ secret_arn: ::String
2225
+ },
2226
+ vpc_configuration: {
2227
+ subnet_ids: Array[::String],
2228
+ security_group_ids: Array[::String]
2229
+ }?,
2230
+ column_configuration: {
2231
+ document_id_column_name: ::String,
2232
+ document_data_column_name: ::String,
2233
+ document_title_column_name: ::String?,
2234
+ field_mappings: Array[
2235
+ {
2236
+ data_source_field_name: ::String,
2237
+ date_field_format: ::String?,
2238
+ index_field_name: ::String
2239
+ },
2240
+ ]?,
2241
+ change_detecting_columns: Array[::String]
2242
+ },
2243
+ acl_configuration: {
2244
+ allowed_groups_column_name: ::String
2245
+ }?,
2246
+ sql_configuration: {
2247
+ query_identifiers_enclosing_option: ("DOUBLE_QUOTES" | "NONE")?
2248
+ }?
2249
+ }?,
2250
+ salesforce_configuration: {
2251
+ server_url: ::String,
2252
+ secret_arn: ::String,
2253
+ standard_object_configurations: Array[
2254
+ {
2255
+ name: ("ACCOUNT" | "CAMPAIGN" | "CASE" | "CONTACT" | "CONTRACT" | "DOCUMENT" | "GROUP" | "IDEA" | "LEAD" | "OPPORTUNITY" | "PARTNER" | "PRICEBOOK" | "PRODUCT" | "PROFILE" | "SOLUTION" | "TASK" | "USER"),
2256
+ document_data_field_name: ::String,
2257
+ document_title_field_name: ::String?,
2258
+ field_mappings: Array[
2259
+ {
2260
+ data_source_field_name: ::String,
2261
+ date_field_format: ::String?,
2262
+ index_field_name: ::String
2263
+ },
2264
+ ]?
2265
+ },
2266
+ ]?,
2267
+ knowledge_article_configuration: {
2268
+ included_states: Array[("DRAFT" | "PUBLISHED" | "ARCHIVED")],
2269
+ standard_knowledge_article_type_configuration: {
2270
+ document_data_field_name: ::String,
2271
+ document_title_field_name: ::String?,
2272
+ field_mappings: Array[
2273
+ {
2274
+ data_source_field_name: ::String,
2275
+ date_field_format: ::String?,
2276
+ index_field_name: ::String
2277
+ },
2278
+ ]?
2279
+ }?,
2280
+ custom_knowledge_article_type_configurations: Array[
2281
+ {
2282
+ name: ::String,
2283
+ document_data_field_name: ::String,
2284
+ document_title_field_name: ::String?,
2285
+ field_mappings: Array[
2286
+ {
2287
+ data_source_field_name: ::String,
2288
+ date_field_format: ::String?,
2289
+ index_field_name: ::String
2290
+ },
2291
+ ]?
2292
+ },
2293
+ ]?
2294
+ }?,
2295
+ chatter_feed_configuration: {
2296
+ document_data_field_name: ::String,
2297
+ document_title_field_name: ::String?,
2298
+ field_mappings: Array[
2299
+ {
2300
+ data_source_field_name: ::String,
2301
+ date_field_format: ::String?,
2302
+ index_field_name: ::String
2303
+ },
2304
+ ]?,
2305
+ include_filter_types: Array[("ACTIVE_USER" | "STANDARD_USER")]?
2306
+ }?,
2307
+ crawl_attachments: bool?,
2308
+ standard_object_attachment_configuration: {
2309
+ document_title_field_name: ::String?,
2310
+ field_mappings: Array[
2311
+ {
2312
+ data_source_field_name: ::String,
2313
+ date_field_format: ::String?,
2314
+ index_field_name: ::String
2315
+ },
2316
+ ]?
2317
+ }?,
2318
+ include_attachment_file_patterns: Array[::String]?,
2319
+ exclude_attachment_file_patterns: Array[::String]?
2320
+ }?,
2321
+ one_drive_configuration: {
2322
+ tenant_domain: ::String,
2323
+ secret_arn: ::String,
2324
+ one_drive_users: {
2325
+ one_drive_user_list: Array[::String]?,
2326
+ one_drive_user_s3_path: {
2327
+ bucket: ::String,
2328
+ key: ::String
2329
+ }?
2330
+ },
2331
+ inclusion_patterns: Array[::String]?,
2332
+ exclusion_patterns: Array[::String]?,
2333
+ field_mappings: Array[
2334
+ {
2335
+ data_source_field_name: ::String,
2336
+ date_field_format: ::String?,
2337
+ index_field_name: ::String
2338
+ },
2339
+ ]?,
2340
+ disable_local_groups: bool?
2341
+ }?,
2342
+ service_now_configuration: {
2343
+ host_url: ::String,
2344
+ secret_arn: ::String,
2345
+ service_now_build_version: ("LONDON" | "OTHERS"),
2346
+ knowledge_article_configuration: {
2347
+ crawl_attachments: bool?,
2348
+ include_attachment_file_patterns: Array[::String]?,
2349
+ exclude_attachment_file_patterns: Array[::String]?,
2350
+ document_data_field_name: ::String,
2351
+ document_title_field_name: ::String?,
2352
+ field_mappings: Array[
2353
+ {
2354
+ data_source_field_name: ::String,
2355
+ date_field_format: ::String?,
2356
+ index_field_name: ::String
2357
+ },
2358
+ ]?,
2359
+ filter_query: ::String?
2360
+ }?,
2361
+ service_catalog_configuration: {
2362
+ crawl_attachments: bool?,
2363
+ include_attachment_file_patterns: Array[::String]?,
2364
+ exclude_attachment_file_patterns: Array[::String]?,
2365
+ document_data_field_name: ::String,
2366
+ document_title_field_name: ::String?,
2367
+ field_mappings: Array[
2368
+ {
2369
+ data_source_field_name: ::String,
2370
+ date_field_format: ::String?,
2371
+ index_field_name: ::String
2372
+ },
2373
+ ]?
2374
+ }?,
2375
+ authentication_type: ("HTTP_BASIC" | "OAUTH2")?
2376
+ }?,
2377
+ confluence_configuration: {
2378
+ server_url: ::String,
2379
+ secret_arn: ::String,
2380
+ version: ("CLOUD" | "SERVER"),
2381
+ space_configuration: {
2382
+ crawl_personal_spaces: bool?,
2383
+ crawl_archived_spaces: bool?,
2384
+ include_spaces: Array[::String]?,
2385
+ exclude_spaces: Array[::String]?,
2386
+ space_field_mappings: Array[
2387
+ {
2388
+ data_source_field_name: ("DISPLAY_URL" | "ITEM_TYPE" | "SPACE_KEY" | "URL")?,
2389
+ date_field_format: ::String?,
2390
+ index_field_name: ::String?
2391
+ },
2392
+ ]?
2393
+ }?,
2394
+ page_configuration: {
2395
+ page_field_mappings: Array[
2396
+ {
2397
+ data_source_field_name: ("AUTHOR" | "CONTENT_STATUS" | "CREATED_DATE" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "MODIFIED_DATE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION")?,
2398
+ date_field_format: ::String?,
2399
+ index_field_name: ::String?
2400
+ },
2401
+ ]?
2402
+ }?,
2403
+ blog_configuration: {
2404
+ blog_field_mappings: Array[
2405
+ {
2406
+ data_source_field_name: ("AUTHOR" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "PUBLISH_DATE" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION")?,
2407
+ date_field_format: ::String?,
2408
+ index_field_name: ::String?
2409
+ },
2410
+ ]?
2411
+ }?,
2412
+ attachment_configuration: {
2413
+ crawl_attachments: bool?,
2414
+ attachment_field_mappings: Array[
2415
+ {
2416
+ data_source_field_name: ("AUTHOR" | "CONTENT_TYPE" | "CREATED_DATE" | "DISPLAY_URL" | "FILE_SIZE" | "ITEM_TYPE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION")?,
2417
+ date_field_format: ::String?,
2418
+ index_field_name: ::String?
2419
+ },
2420
+ ]?
2421
+ }?,
2422
+ vpc_configuration: {
2423
+ subnet_ids: Array[::String],
2424
+ security_group_ids: Array[::String]
2425
+ }?,
2426
+ inclusion_patterns: Array[::String]?,
2427
+ exclusion_patterns: Array[::String]?,
2428
+ proxy_configuration: {
2429
+ host: ::String,
2430
+ port: ::Integer,
2431
+ credentials: ::String?
2432
+ }?,
2433
+ authentication_type: ("HTTP_BASIC" | "PAT")?
2434
+ }?,
2435
+ google_drive_configuration: {
2436
+ secret_arn: ::String,
2437
+ inclusion_patterns: Array[::String]?,
2438
+ exclusion_patterns: Array[::String]?,
2439
+ field_mappings: Array[
2440
+ {
2441
+ data_source_field_name: ::String,
2442
+ date_field_format: ::String?,
2443
+ index_field_name: ::String
2444
+ },
2445
+ ]?,
2446
+ exclude_mime_types: Array[::String]?,
2447
+ exclude_user_accounts: Array[::String]?,
2448
+ exclude_shared_drives: Array[::String]?
2449
+ }?,
2450
+ web_crawler_configuration: {
2451
+ urls: {
2452
+ seed_url_configuration: {
2453
+ seed_urls: Array[::String],
2454
+ web_crawler_mode: ("HOST_ONLY" | "SUBDOMAINS" | "EVERYTHING")?
2455
+ }?,
2456
+ site_maps_configuration: {
2457
+ site_maps: Array[::String]
2458
+ }?
2459
+ },
2460
+ crawl_depth: ::Integer?,
2461
+ max_links_per_page: ::Integer?,
2462
+ max_content_size_per_page_in_mega_bytes: ::Float?,
2463
+ max_urls_per_minute_crawl_rate: ::Integer?,
2464
+ url_inclusion_patterns: Array[::String]?,
2465
+ url_exclusion_patterns: Array[::String]?,
2466
+ proxy_configuration: {
2467
+ host: ::String,
2468
+ port: ::Integer,
2469
+ credentials: ::String?
2470
+ }?,
2471
+ authentication_configuration: {
2472
+ basic_authentication: Array[
2473
+ {
2474
+ host: ::String,
2475
+ port: ::Integer,
2476
+ credentials: ::String
2477
+ },
2478
+ ]?
2479
+ }?
2480
+ }?,
2481
+ work_docs_configuration: {
2482
+ organization_id: ::String,
2483
+ crawl_comments: bool?,
2484
+ use_change_log: bool?,
2485
+ inclusion_patterns: Array[::String]?,
2486
+ exclusion_patterns: Array[::String]?,
2487
+ field_mappings: Array[
2488
+ {
2489
+ data_source_field_name: ::String,
2490
+ date_field_format: ::String?,
2491
+ index_field_name: ::String
2492
+ },
2493
+ ]?
2494
+ }?,
2495
+ fsx_configuration: {
2496
+ file_system_id: ::String,
2497
+ file_system_type: ("WINDOWS"),
2498
+ vpc_configuration: {
2499
+ subnet_ids: Array[::String],
2500
+ security_group_ids: Array[::String]
2501
+ },
2502
+ secret_arn: ::String?,
2503
+ inclusion_patterns: Array[::String]?,
2504
+ exclusion_patterns: Array[::String]?,
2505
+ field_mappings: Array[
2506
+ {
2507
+ data_source_field_name: ::String,
2508
+ date_field_format: ::String?,
2509
+ index_field_name: ::String
2510
+ },
2511
+ ]?
2512
+ }?,
2513
+ slack_configuration: {
2514
+ team_id: ::String,
2515
+ secret_arn: ::String,
2516
+ vpc_configuration: {
2517
+ subnet_ids: Array[::String],
2518
+ security_group_ids: Array[::String]
2519
+ }?,
2520
+ slack_entity_list: Array[("PUBLIC_CHANNEL" | "PRIVATE_CHANNEL" | "GROUP_MESSAGE" | "DIRECT_MESSAGE")],
2521
+ use_change_log: bool?,
2522
+ crawl_bot_message: bool?,
2523
+ exclude_archived: bool?,
2524
+ since_crawl_date: ::String,
2525
+ look_back_period: ::Integer?,
2526
+ private_channel_filter: Array[::String]?,
2527
+ public_channel_filter: Array[::String]?,
2528
+ inclusion_patterns: Array[::String]?,
2529
+ exclusion_patterns: Array[::String]?,
2530
+ field_mappings: Array[
2531
+ {
2532
+ data_source_field_name: ::String,
2533
+ date_field_format: ::String?,
2534
+ index_field_name: ::String
2535
+ },
2536
+ ]?
2537
+ }?,
2538
+ box_configuration: {
2539
+ enterprise_id: ::String,
2540
+ secret_arn: ::String,
2541
+ use_change_log: bool?,
2542
+ crawl_comments: bool?,
2543
+ crawl_tasks: bool?,
2544
+ crawl_web_links: bool?,
2545
+ file_field_mappings: Array[
2546
+ {
2547
+ data_source_field_name: ::String,
2548
+ date_field_format: ::String?,
2549
+ index_field_name: ::String
2550
+ },
2551
+ ]?,
2552
+ task_field_mappings: Array[
2553
+ {
2554
+ data_source_field_name: ::String,
2555
+ date_field_format: ::String?,
2556
+ index_field_name: ::String
2557
+ },
2558
+ ]?,
2559
+ comment_field_mappings: Array[
2560
+ {
2561
+ data_source_field_name: ::String,
2562
+ date_field_format: ::String?,
2563
+ index_field_name: ::String
2564
+ },
2565
+ ]?,
2566
+ web_link_field_mappings: Array[
2567
+ {
2568
+ data_source_field_name: ::String,
2569
+ date_field_format: ::String?,
2570
+ index_field_name: ::String
2571
+ },
2572
+ ]?,
2573
+ inclusion_patterns: Array[::String]?,
2574
+ exclusion_patterns: Array[::String]?,
2575
+ vpc_configuration: {
2576
+ subnet_ids: Array[::String],
2577
+ security_group_ids: Array[::String]
2578
+ }?
2579
+ }?,
2580
+ quip_configuration: {
2581
+ domain: ::String,
2582
+ secret_arn: ::String,
2583
+ crawl_file_comments: bool?,
2584
+ crawl_chat_rooms: bool?,
2585
+ crawl_attachments: bool?,
2586
+ folder_ids: Array[::String]?,
2587
+ thread_field_mappings: Array[
2588
+ {
2589
+ data_source_field_name: ::String,
2590
+ date_field_format: ::String?,
2591
+ index_field_name: ::String
2592
+ },
2593
+ ]?,
2594
+ message_field_mappings: Array[
2595
+ {
2596
+ data_source_field_name: ::String,
2597
+ date_field_format: ::String?,
2598
+ index_field_name: ::String
2599
+ },
2600
+ ]?,
2601
+ attachment_field_mappings: Array[
2602
+ {
2603
+ data_source_field_name: ::String,
2604
+ date_field_format: ::String?,
2605
+ index_field_name: ::String
2606
+ },
2607
+ ]?,
2608
+ inclusion_patterns: Array[::String]?,
2609
+ exclusion_patterns: Array[::String]?,
2610
+ vpc_configuration: {
2611
+ subnet_ids: Array[::String],
2612
+ security_group_ids: Array[::String]
2613
+ }?
2614
+ }?,
2615
+ jira_configuration: {
2616
+ jira_account_url: ::String,
2617
+ secret_arn: ::String,
2618
+ use_change_log: bool?,
2619
+ project: Array[::String]?,
2620
+ issue_type: Array[::String]?,
2621
+ status: Array[::String]?,
2622
+ issue_sub_entity_filter: Array[("COMMENTS" | "ATTACHMENTS" | "WORKLOGS")]?,
2623
+ attachment_field_mappings: Array[
2624
+ {
2625
+ data_source_field_name: ::String,
2626
+ date_field_format: ::String?,
2627
+ index_field_name: ::String
2628
+ },
2629
+ ]?,
2630
+ comment_field_mappings: Array[
2631
+ {
2632
+ data_source_field_name: ::String,
2633
+ date_field_format: ::String?,
2634
+ index_field_name: ::String
2635
+ },
2636
+ ]?,
2637
+ issue_field_mappings: Array[
2638
+ {
2639
+ data_source_field_name: ::String,
2640
+ date_field_format: ::String?,
2641
+ index_field_name: ::String
2642
+ },
2643
+ ]?,
2644
+ project_field_mappings: Array[
2645
+ {
2646
+ data_source_field_name: ::String,
2647
+ date_field_format: ::String?,
2648
+ index_field_name: ::String
2649
+ },
2650
+ ]?,
2651
+ work_log_field_mappings: Array[
2652
+ {
2653
+ data_source_field_name: ::String,
2654
+ date_field_format: ::String?,
2655
+ index_field_name: ::String
2656
+ },
2657
+ ]?,
2658
+ inclusion_patterns: Array[::String]?,
2659
+ exclusion_patterns: Array[::String]?,
2660
+ vpc_configuration: {
2661
+ subnet_ids: Array[::String],
2662
+ security_group_ids: Array[::String]
2663
+ }?
2664
+ }?,
2665
+ git_hub_configuration: {
2666
+ saa_s_configuration: {
2667
+ organization_name: ::String,
2668
+ host_url: ::String
2669
+ }?,
2670
+ on_premise_configuration: {
2671
+ host_url: ::String,
2672
+ organization_name: ::String,
2673
+ ssl_certificate_s3_path: {
2674
+ bucket: ::String,
2675
+ key: ::String
2676
+ }
2677
+ }?,
2678
+ type: ("SAAS" | "ON_PREMISE")?,
2679
+ secret_arn: ::String,
2680
+ use_change_log: bool?,
2681
+ git_hub_document_crawl_properties: {
2682
+ crawl_repository_documents: bool?,
2683
+ crawl_issue: bool?,
2684
+ crawl_issue_comment: bool?,
2685
+ crawl_issue_comment_attachment: bool?,
2686
+ crawl_pull_request: bool?,
2687
+ crawl_pull_request_comment: bool?,
2688
+ crawl_pull_request_comment_attachment: bool?
2689
+ }?,
2690
+ repository_filter: Array[::String]?,
2691
+ inclusion_folder_name_patterns: Array[::String]?,
2692
+ inclusion_file_type_patterns: Array[::String]?,
2693
+ inclusion_file_name_patterns: Array[::String]?,
2694
+ exclusion_folder_name_patterns: Array[::String]?,
2695
+ exclusion_file_type_patterns: Array[::String]?,
2696
+ exclusion_file_name_patterns: Array[::String]?,
2697
+ vpc_configuration: {
2698
+ subnet_ids: Array[::String],
2699
+ security_group_ids: Array[::String]
2700
+ }?,
2701
+ git_hub_repository_configuration_field_mappings: Array[
2702
+ {
2703
+ data_source_field_name: ::String,
2704
+ date_field_format: ::String?,
2705
+ index_field_name: ::String
2706
+ },
2707
+ ]?,
2708
+ git_hub_commit_configuration_field_mappings: Array[
2709
+ {
2710
+ data_source_field_name: ::String,
2711
+ date_field_format: ::String?,
2712
+ index_field_name: ::String
2713
+ },
2714
+ ]?,
2715
+ git_hub_issue_document_configuration_field_mappings: Array[
2716
+ {
2717
+ data_source_field_name: ::String,
2718
+ date_field_format: ::String?,
2719
+ index_field_name: ::String
2720
+ },
2721
+ ]?,
2722
+ git_hub_issue_comment_configuration_field_mappings: Array[
2723
+ {
2724
+ data_source_field_name: ::String,
2725
+ date_field_format: ::String?,
2726
+ index_field_name: ::String
2727
+ },
2728
+ ]?,
2729
+ git_hub_issue_attachment_configuration_field_mappings: Array[
2730
+ {
2731
+ data_source_field_name: ::String,
2732
+ date_field_format: ::String?,
2733
+ index_field_name: ::String
2734
+ },
2735
+ ]?,
2736
+ git_hub_pull_request_comment_configuration_field_mappings: Array[
2737
+ {
2738
+ data_source_field_name: ::String,
2739
+ date_field_format: ::String?,
2740
+ index_field_name: ::String
2741
+ },
2742
+ ]?,
2743
+ git_hub_pull_request_document_configuration_field_mappings: Array[
2744
+ {
2745
+ data_source_field_name: ::String,
2746
+ date_field_format: ::String?,
2747
+ index_field_name: ::String
2748
+ },
2749
+ ]?,
2750
+ git_hub_pull_request_document_attachment_configuration_field_mappings: Array[
2751
+ {
2752
+ data_source_field_name: ::String,
2753
+ date_field_format: ::String?,
2754
+ index_field_name: ::String
2755
+ },
2756
+ ]?
2757
+ }?,
2758
+ alfresco_configuration: {
2759
+ site_url: ::String,
2760
+ site_id: ::String,
2761
+ secret_arn: ::String,
2762
+ ssl_certificate_s3_path: {
2763
+ bucket: ::String,
2764
+ key: ::String
2765
+ },
2766
+ crawl_system_folders: bool?,
2767
+ crawl_comments: bool?,
2768
+ entity_filter: Array[("wiki" | "blog" | "documentLibrary")]?,
2769
+ document_library_field_mappings: Array[
2770
+ {
2771
+ data_source_field_name: ::String,
2772
+ date_field_format: ::String?,
2773
+ index_field_name: ::String
2774
+ },
2775
+ ]?,
2776
+ blog_field_mappings: Array[
2777
+ {
2778
+ data_source_field_name: ::String,
2779
+ date_field_format: ::String?,
2780
+ index_field_name: ::String
2781
+ },
2782
+ ]?,
2783
+ wiki_field_mappings: Array[
2784
+ {
2785
+ data_source_field_name: ::String,
2786
+ date_field_format: ::String?,
2787
+ index_field_name: ::String
2788
+ },
2789
+ ]?,
2790
+ inclusion_patterns: Array[::String]?,
2791
+ exclusion_patterns: Array[::String]?,
2792
+ vpc_configuration: {
2793
+ subnet_ids: Array[::String],
2794
+ security_group_ids: Array[::String]
2795
+ }?
2796
+ }?,
2797
+ template_configuration: {
2798
+ template: {
2799
+ }?
2800
+ }?
2801
+ },
2802
+ ?vpc_configuration: {
2803
+ subnet_ids: Array[::String],
2804
+ security_group_ids: Array[::String]
2805
+ },
2806
+ ?description: ::String,
2807
+ ?schedule: ::String,
2808
+ ?role_arn: ::String,
2809
+ ?language_code: ::String,
2810
+ ?custom_document_enrichment_configuration: {
2811
+ inline_configurations: Array[
2812
+ {
2813
+ condition: {
2814
+ condition_document_attribute_key: ::String,
2815
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
2816
+ condition_on_value: {
2817
+ string_value: ::String?,
2818
+ string_list_value: Array[::String]?,
2819
+ long_value: ::Integer?,
2820
+ date_value: ::Time?
2821
+ }?
2822
+ }?,
2823
+ target: {
2824
+ target_document_attribute_key: ::String?,
2825
+ target_document_attribute_value_deletion: bool?,
2826
+ target_document_attribute_value: {
2827
+ string_value: ::String?,
2828
+ string_list_value: Array[::String]?,
2829
+ long_value: ::Integer?,
2830
+ date_value: ::Time?
2831
+ }?
2832
+ }?,
2833
+ document_content_deletion: bool?
2834
+ },
2835
+ ]?,
2836
+ pre_extraction_hook_configuration: {
2837
+ invocation_condition: {
2838
+ condition_document_attribute_key: ::String,
2839
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
2840
+ condition_on_value: {
2841
+ string_value: ::String?,
2842
+ string_list_value: Array[::String]?,
2843
+ long_value: ::Integer?,
2844
+ date_value: ::Time?
2845
+ }?
2846
+ }?,
2847
+ lambda_arn: ::String,
2848
+ s3_bucket: ::String
2849
+ }?,
2850
+ post_extraction_hook_configuration: {
2851
+ invocation_condition: {
2852
+ condition_document_attribute_key: ::String,
2853
+ operator: ("GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"),
2854
+ condition_on_value: {
2855
+ string_value: ::String?,
2856
+ string_list_value: Array[::String]?,
2857
+ long_value: ::Integer?,
2858
+ date_value: ::Time?
2859
+ }?
2860
+ }?,
2861
+ lambda_arn: ::String,
2862
+ s3_bucket: ::String
2863
+ }?,
2864
+ role_arn: ::String?
2865
+ }
2866
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2867
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2868
+
2869
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_experience-instance_method
2870
+ def update_experience: (
2871
+ id: ::String,
2872
+ ?name: ::String,
2873
+ index_id: ::String,
2874
+ ?role_arn: ::String,
2875
+ ?configuration: {
2876
+ content_source_configuration: {
2877
+ data_source_ids: Array[::String]?,
2878
+ faq_ids: Array[::String]?,
2879
+ direct_put_content: bool?
2880
+ }?,
2881
+ user_identity_configuration: {
2882
+ identity_attribute_name: ::String?
2883
+ }?
2884
+ },
2885
+ ?description: ::String
2886
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2887
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2888
+
2889
+ interface _UpdateFeaturedResultsSetResponseSuccess
2890
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateFeaturedResultsSetResponse]
2891
+ def featured_results_set: () -> Types::FeaturedResultsSet
2892
+ end
2893
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_featured_results_set-instance_method
2894
+ def update_featured_results_set: (
2895
+ index_id: ::String,
2896
+ featured_results_set_id: ::String,
2897
+ ?featured_results_set_name: ::String,
2898
+ ?description: ::String,
2899
+ ?status: ("ACTIVE" | "INACTIVE"),
2900
+ ?query_texts: Array[::String],
2901
+ ?featured_documents: Array[
2902
+ {
2903
+ id: ::String?
2904
+ },
2905
+ ]
2906
+ ) -> _UpdateFeaturedResultsSetResponseSuccess
2907
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateFeaturedResultsSetResponseSuccess
2908
+
2909
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_index-instance_method
2910
+ def update_index: (
2911
+ id: ::String,
2912
+ ?name: ::String,
2913
+ ?role_arn: ::String,
2914
+ ?description: ::String,
2915
+ ?document_metadata_configuration_updates: Array[
2916
+ {
2917
+ name: ::String,
2918
+ type: ("STRING_VALUE" | "STRING_LIST_VALUE" | "LONG_VALUE" | "DATE_VALUE"),
2919
+ relevance: {
2920
+ freshness: bool?,
2921
+ importance: ::Integer?,
2922
+ duration: ::String?,
2923
+ rank_order: ("ASCENDING" | "DESCENDING")?,
2924
+ value_importance_map: Hash[::String, ::Integer]?
2925
+ }?,
2926
+ search: {
2927
+ facetable: bool?,
2928
+ searchable: bool?,
2929
+ displayable: bool?,
2930
+ sortable: bool?
2931
+ }?
2932
+ },
2933
+ ],
2934
+ ?capacity_units: {
2935
+ storage_capacity_units: ::Integer,
2936
+ query_capacity_units: ::Integer
2937
+ },
2938
+ ?user_token_configurations: Array[
2939
+ {
2940
+ jwt_token_type_configuration: {
2941
+ key_location: ("URL" | "SECRET_MANAGER"),
2942
+ url: ::String?,
2943
+ secret_manager_arn: ::String?,
2944
+ user_name_attribute_field: ::String?,
2945
+ group_attribute_field: ::String?,
2946
+ issuer: ::String?,
2947
+ claim_regex: ::String?
2948
+ }?,
2949
+ json_token_type_configuration: {
2950
+ user_name_attribute_field: ::String,
2951
+ group_attribute_field: ::String
2952
+ }?
2953
+ },
2954
+ ],
2955
+ ?user_context_policy: ("ATTRIBUTE_FILTER" | "USER_TOKEN"),
2956
+ ?user_group_resolution_configuration: {
2957
+ user_group_resolution_mode: ("AWS_SSO" | "NONE")
2958
+ }
2959
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2960
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2961
+
2962
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_query_suggestions_block_list-instance_method
2963
+ def update_query_suggestions_block_list: (
2964
+ index_id: ::String,
2965
+ id: ::String,
2966
+ ?name: ::String,
2967
+ ?description: ::String,
2968
+ ?source_s3_path: {
2969
+ bucket: ::String,
2970
+ key: ::String
2971
+ },
2972
+ ?role_arn: ::String
2973
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2974
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2975
+
2976
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_query_suggestions_config-instance_method
2977
+ def update_query_suggestions_config: (
2978
+ index_id: ::String,
2979
+ ?mode: ("ENABLED" | "LEARN_ONLY"),
2980
+ ?query_log_look_back_window_in_days: ::Integer,
2981
+ ?include_queries_without_user_information: bool,
2982
+ ?minimum_number_of_querying_users: ::Integer,
2983
+ ?minimum_query_count: ::Integer,
2984
+ ?attribute_suggestions_config: {
2985
+ suggestable_config_list: Array[
2986
+ {
2987
+ attribute_name: ::String?,
2988
+ suggestable: bool?
2989
+ },
2990
+ ]?,
2991
+ attribute_suggestions_mode: ("ACTIVE" | "INACTIVE")?
2992
+ }
2993
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2994
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
2995
+
2996
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#update_thesaurus-instance_method
2997
+ def update_thesaurus: (
2998
+ id: ::String,
2999
+ ?name: ::String,
3000
+ index_id: ::String,
3001
+ ?description: ::String,
3002
+ ?role_arn: ::String,
3003
+ ?source_s3_path: {
3004
+ bucket: ::String,
3005
+ key: ::String
3006
+ }
3007
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
3008
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
3009
+ end
3010
+ end
3011
+ end
3012
+