aws-sdk-qbusiness 1.0.0 → 1.1.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,1370 @@
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 QBusiness
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/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
+ ?stub_responses: untyped,
52
+ ?token_provider: untyped,
53
+ ?use_dualstack_endpoint: bool,
54
+ ?use_fips_endpoint: bool,
55
+ ?validate_params: bool,
56
+ ?endpoint_provider: untyped,
57
+ ?http_proxy: String,
58
+ ?http_open_timeout: (Float | Integer),
59
+ ?http_read_timeout: (Float | Integer),
60
+ ?http_idle_timeout: (Float | Integer),
61
+ ?http_continue_timeout: (Float | Integer),
62
+ ?ssl_timeout: (Float | Integer | nil),
63
+ ?http_wire_trace: bool,
64
+ ?ssl_verify_peer: bool,
65
+ ?ssl_ca_bundle: String,
66
+ ?ssl_ca_directory: String,
67
+ ?ssl_ca_store: String,
68
+ ?on_chunk_received: Proc,
69
+ ?on_chunk_sent: Proc,
70
+ ?raise_response_errors: bool
71
+ ) -> instance
72
+ | (?Hash[Symbol, untyped]) -> instance
73
+
74
+
75
+ interface _BatchDeleteDocumentResponseSuccess
76
+ include ::Seahorse::Client::_ResponseSuccess[Types::BatchDeleteDocumentResponse]
77
+ def failed_documents: () -> ::Array[Types::FailedDocument]
78
+ end
79
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#batch_delete_document-instance_method
80
+ def batch_delete_document: (
81
+ application_id: ::String,
82
+ ?data_source_sync_id: ::String,
83
+ documents: Array[
84
+ {
85
+ document_id: ::String
86
+ },
87
+ ],
88
+ index_id: ::String
89
+ ) -> _BatchDeleteDocumentResponseSuccess
90
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchDeleteDocumentResponseSuccess
91
+
92
+ interface _BatchPutDocumentResponseSuccess
93
+ include ::Seahorse::Client::_ResponseSuccess[Types::BatchPutDocumentResponse]
94
+ def failed_documents: () -> ::Array[Types::FailedDocument]
95
+ end
96
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#batch_put_document-instance_method
97
+ def batch_put_document: (
98
+ application_id: ::String,
99
+ ?data_source_sync_id: ::String,
100
+ documents: Array[
101
+ {
102
+ access_configuration: {
103
+ access_controls: Array[
104
+ {
105
+ member_relation: ("AND" | "OR")?,
106
+ principals: Array[
107
+ {
108
+ group: {
109
+ access: ("ALLOW" | "DENY"),
110
+ membership_type: ("INDEX" | "DATASOURCE")?,
111
+ name: ::String?
112
+ }?,
113
+ user: {
114
+ access: ("ALLOW" | "DENY"),
115
+ id: ::String?,
116
+ membership_type: ("INDEX" | "DATASOURCE")?
117
+ }?
118
+ },
119
+ ]
120
+ },
121
+ ],
122
+ member_relation: ("AND" | "OR")?
123
+ }?,
124
+ attributes: Array[
125
+ {
126
+ name: ::String,
127
+ value: {
128
+ date_value: ::Time?,
129
+ long_value: ::Integer?,
130
+ string_list_value: Array[::String]?,
131
+ string_value: ::String?
132
+ }
133
+ },
134
+ ]?,
135
+ content: {
136
+ blob: ::String?,
137
+ s3: {
138
+ bucket: ::String,
139
+ key: ::String
140
+ }?
141
+ }?,
142
+ content_type: ("PDF" | "HTML" | "MS_WORD" | "PLAIN_TEXT" | "PPT" | "RTF" | "XML" | "XSLT" | "MS_EXCEL" | "CSV" | "JSON" | "MD")?,
143
+ document_enrichment_configuration: {
144
+ inline_configurations: Array[
145
+ {
146
+ condition: {
147
+ key: ::String,
148
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
149
+ value: {
150
+ date_value: ::Time?,
151
+ long_value: ::Integer?,
152
+ string_list_value: Array[::String]?,
153
+ string_value: ::String?
154
+ }?
155
+ }?,
156
+ document_content_operator: ("DELETE")?,
157
+ target: {
158
+ attribute_value_operator: ("DELETE")?,
159
+ key: ::String,
160
+ value: {
161
+ date_value: ::Time?,
162
+ long_value: ::Integer?,
163
+ string_list_value: Array[::String]?,
164
+ string_value: ::String?
165
+ }?
166
+ }?
167
+ },
168
+ ]?,
169
+ post_extraction_hook_configuration: {
170
+ invocation_condition: {
171
+ key: ::String,
172
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
173
+ value: {
174
+ date_value: ::Time?,
175
+ long_value: ::Integer?,
176
+ string_list_value: Array[::String]?,
177
+ string_value: ::String?
178
+ }?
179
+ }?,
180
+ lambda_arn: ::String?,
181
+ role_arn: ::String?,
182
+ s3_bucket_name: ::String?
183
+ }?,
184
+ pre_extraction_hook_configuration: {
185
+ invocation_condition: {
186
+ key: ::String,
187
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
188
+ value: {
189
+ date_value: ::Time?,
190
+ long_value: ::Integer?,
191
+ string_list_value: Array[::String]?,
192
+ string_value: ::String?
193
+ }?
194
+ }?,
195
+ lambda_arn: ::String?,
196
+ role_arn: ::String?,
197
+ s3_bucket_name: ::String?
198
+ }?
199
+ }?,
200
+ id: ::String,
201
+ title: ::String?
202
+ },
203
+ ],
204
+ index_id: ::String,
205
+ ?role_arn: ::String
206
+ ) -> _BatchPutDocumentResponseSuccess
207
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchPutDocumentResponseSuccess
208
+
209
+ interface _ChatSyncResponseSuccess
210
+ include ::Seahorse::Client::_ResponseSuccess[Types::ChatSyncOutput]
211
+ def action_review: () -> Types::ActionReview
212
+ def conversation_id: () -> ::String
213
+ def failed_attachments: () -> ::Array[Types::AttachmentOutput]
214
+ def source_attributions: () -> ::Array[Types::SourceAttribution]
215
+ def system_message: () -> ::String
216
+ def system_message_id: () -> ::String
217
+ def user_message_id: () -> ::String
218
+ end
219
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#chat_sync-instance_method
220
+ def chat_sync: (
221
+ ?action_execution: {
222
+ payload: Hash[::String, {
223
+ value: {
224
+ }
225
+ }],
226
+ payload_field_name_separator: ::String,
227
+ plugin_id: ::String
228
+ },
229
+ application_id: ::String,
230
+ ?attachments: Array[
231
+ {
232
+ data: ::String,
233
+ name: ::String
234
+ },
235
+ ],
236
+ ?attribute_filter: {
237
+ and_all_filters: Array[
238
+ untyped,
239
+ ]?,
240
+ contains_all: {
241
+ name: ::String,
242
+ value: {
243
+ date_value: ::Time?,
244
+ long_value: ::Integer?,
245
+ string_list_value: Array[::String]?,
246
+ string_value: ::String?
247
+ }
248
+ }?,
249
+ contains_any: {
250
+ name: ::String,
251
+ value: {
252
+ date_value: ::Time?,
253
+ long_value: ::Integer?,
254
+ string_list_value: Array[::String]?,
255
+ string_value: ::String?
256
+ }
257
+ }?,
258
+ equals_to: {
259
+ name: ::String,
260
+ value: {
261
+ date_value: ::Time?,
262
+ long_value: ::Integer?,
263
+ string_list_value: Array[::String]?,
264
+ string_value: ::String?
265
+ }
266
+ }?,
267
+ greater_than: {
268
+ name: ::String,
269
+ value: {
270
+ date_value: ::Time?,
271
+ long_value: ::Integer?,
272
+ string_list_value: Array[::String]?,
273
+ string_value: ::String?
274
+ }
275
+ }?,
276
+ greater_than_or_equals: {
277
+ name: ::String,
278
+ value: {
279
+ date_value: ::Time?,
280
+ long_value: ::Integer?,
281
+ string_list_value: Array[::String]?,
282
+ string_value: ::String?
283
+ }
284
+ }?,
285
+ less_than: {
286
+ name: ::String,
287
+ value: {
288
+ date_value: ::Time?,
289
+ long_value: ::Integer?,
290
+ string_list_value: Array[::String]?,
291
+ string_value: ::String?
292
+ }
293
+ }?,
294
+ less_than_or_equals: {
295
+ name: ::String,
296
+ value: {
297
+ date_value: ::Time?,
298
+ long_value: ::Integer?,
299
+ string_list_value: Array[::String]?,
300
+ string_value: ::String?
301
+ }
302
+ }?,
303
+ not_filter: untyped?,
304
+ or_all_filters: Array[
305
+ untyped,
306
+ ]?
307
+ },
308
+ ?client_token: ::String,
309
+ ?conversation_id: ::String,
310
+ ?parent_message_id: ::String,
311
+ ?user_groups: Array[::String],
312
+ user_id: ::String,
313
+ ?user_message: ::String
314
+ ) -> _ChatSyncResponseSuccess
315
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ChatSyncResponseSuccess
316
+
317
+ interface _CreateApplicationResponseSuccess
318
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateApplicationResponse]
319
+ def application_arn: () -> ::String
320
+ def application_id: () -> ::String
321
+ end
322
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_application-instance_method
323
+ def create_application: (
324
+ ?attachments_configuration: {
325
+ attachments_control_mode: ("ENABLED" | "DISABLED")
326
+ },
327
+ ?client_token: ::String,
328
+ ?description: ::String,
329
+ display_name: ::String,
330
+ ?encryption_configuration: {
331
+ kms_key_id: ::String?
332
+ },
333
+ role_arn: ::String,
334
+ ?tags: Array[
335
+ {
336
+ key: ::String,
337
+ value: ::String
338
+ },
339
+ ]
340
+ ) -> _CreateApplicationResponseSuccess
341
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateApplicationResponseSuccess
342
+
343
+ interface _CreateDataSourceResponseSuccess
344
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateDataSourceResponse]
345
+ def data_source_arn: () -> ::String
346
+ def data_source_id: () -> ::String
347
+ end
348
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_data_source-instance_method
349
+ def create_data_source: (
350
+ application_id: ::String,
351
+ ?client_token: ::String,
352
+ configuration: {
353
+ },
354
+ ?description: ::String,
355
+ display_name: ::String,
356
+ ?document_enrichment_configuration: {
357
+ inline_configurations: Array[
358
+ {
359
+ condition: {
360
+ key: ::String,
361
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
362
+ value: {
363
+ date_value: ::Time?,
364
+ long_value: ::Integer?,
365
+ string_list_value: Array[::String]?,
366
+ string_value: ::String?
367
+ }?
368
+ }?,
369
+ document_content_operator: ("DELETE")?,
370
+ target: {
371
+ attribute_value_operator: ("DELETE")?,
372
+ key: ::String,
373
+ value: {
374
+ date_value: ::Time?,
375
+ long_value: ::Integer?,
376
+ string_list_value: Array[::String]?,
377
+ string_value: ::String?
378
+ }?
379
+ }?
380
+ },
381
+ ]?,
382
+ post_extraction_hook_configuration: {
383
+ invocation_condition: {
384
+ key: ::String,
385
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
386
+ value: {
387
+ date_value: ::Time?,
388
+ long_value: ::Integer?,
389
+ string_list_value: Array[::String]?,
390
+ string_value: ::String?
391
+ }?
392
+ }?,
393
+ lambda_arn: ::String?,
394
+ role_arn: ::String?,
395
+ s3_bucket_name: ::String?
396
+ }?,
397
+ pre_extraction_hook_configuration: {
398
+ invocation_condition: {
399
+ key: ::String,
400
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
401
+ value: {
402
+ date_value: ::Time?,
403
+ long_value: ::Integer?,
404
+ string_list_value: Array[::String]?,
405
+ string_value: ::String?
406
+ }?
407
+ }?,
408
+ lambda_arn: ::String?,
409
+ role_arn: ::String?,
410
+ s3_bucket_name: ::String?
411
+ }?
412
+ },
413
+ index_id: ::String,
414
+ ?role_arn: ::String,
415
+ ?sync_schedule: ::String,
416
+ ?tags: Array[
417
+ {
418
+ key: ::String,
419
+ value: ::String
420
+ },
421
+ ],
422
+ ?vpc_configuration: {
423
+ security_group_ids: Array[::String],
424
+ subnet_ids: Array[::String]
425
+ }
426
+ ) -> _CreateDataSourceResponseSuccess
427
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDataSourceResponseSuccess
428
+
429
+ interface _CreateIndexResponseSuccess
430
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateIndexResponse]
431
+ def index_arn: () -> ::String
432
+ def index_id: () -> ::String
433
+ end
434
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_index-instance_method
435
+ def create_index: (
436
+ application_id: ::String,
437
+ ?capacity_configuration: {
438
+ units: ::Integer?
439
+ },
440
+ ?client_token: ::String,
441
+ ?description: ::String,
442
+ display_name: ::String,
443
+ ?tags: Array[
444
+ {
445
+ key: ::String,
446
+ value: ::String
447
+ },
448
+ ]
449
+ ) -> _CreateIndexResponseSuccess
450
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateIndexResponseSuccess
451
+
452
+ interface _CreatePluginResponseSuccess
453
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreatePluginResponse]
454
+ def plugin_arn: () -> ::String
455
+ def plugin_id: () -> ::String
456
+ end
457
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_plugin-instance_method
458
+ def create_plugin: (
459
+ application_id: ::String,
460
+ auth_configuration: {
461
+ basic_auth_configuration: {
462
+ role_arn: ::String,
463
+ secret_arn: ::String
464
+ }?,
465
+ o_auth_2_client_credential_configuration: {
466
+ role_arn: ::String,
467
+ secret_arn: ::String
468
+ }?
469
+ },
470
+ ?client_token: ::String,
471
+ display_name: ::String,
472
+ server_url: ::String,
473
+ ?tags: Array[
474
+ {
475
+ key: ::String,
476
+ value: ::String
477
+ },
478
+ ],
479
+ type: ("SERVICE_NOW" | "SALESFORCE" | "JIRA" | "ZENDESK")
480
+ ) -> _CreatePluginResponseSuccess
481
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePluginResponseSuccess
482
+
483
+ interface _CreateRetrieverResponseSuccess
484
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateRetrieverResponse]
485
+ def retriever_arn: () -> ::String
486
+ def retriever_id: () -> ::String
487
+ end
488
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_retriever-instance_method
489
+ def create_retriever: (
490
+ application_id: ::String,
491
+ ?client_token: ::String,
492
+ configuration: {
493
+ kendra_index_configuration: {
494
+ index_id: ::String
495
+ }?,
496
+ native_index_configuration: {
497
+ index_id: ::String
498
+ }?
499
+ },
500
+ display_name: ::String,
501
+ ?role_arn: ::String,
502
+ ?tags: Array[
503
+ {
504
+ key: ::String,
505
+ value: ::String
506
+ },
507
+ ],
508
+ type: ("NATIVE_INDEX" | "KENDRA_INDEX")
509
+ ) -> _CreateRetrieverResponseSuccess
510
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRetrieverResponseSuccess
511
+
512
+ interface _CreateUserResponseSuccess
513
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserResponse]
514
+ end
515
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_user-instance_method
516
+ def create_user: (
517
+ application_id: ::String,
518
+ ?client_token: ::String,
519
+ ?user_aliases: Array[
520
+ {
521
+ data_source_id: ::String?,
522
+ index_id: ::String?,
523
+ user_id: ::String
524
+ },
525
+ ],
526
+ user_id: ::String
527
+ ) -> _CreateUserResponseSuccess
528
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserResponseSuccess
529
+
530
+ interface _CreateWebExperienceResponseSuccess
531
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateWebExperienceResponse]
532
+ def web_experience_arn: () -> ::String
533
+ def web_experience_id: () -> ::String
534
+ end
535
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_web_experience-instance_method
536
+ def create_web_experience: (
537
+ application_id: ::String,
538
+ ?client_token: ::String,
539
+ ?sample_prompts_control_mode: ("ENABLED" | "DISABLED"),
540
+ ?subtitle: ::String,
541
+ ?tags: Array[
542
+ {
543
+ key: ::String,
544
+ value: ::String
545
+ },
546
+ ],
547
+ ?title: ::String,
548
+ ?welcome_message: ::String
549
+ ) -> _CreateWebExperienceResponseSuccess
550
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateWebExperienceResponseSuccess
551
+
552
+ interface _DeleteApplicationResponseSuccess
553
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteApplicationResponse]
554
+ end
555
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_application-instance_method
556
+ def delete_application: (
557
+ application_id: ::String
558
+ ) -> _DeleteApplicationResponseSuccess
559
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteApplicationResponseSuccess
560
+
561
+ interface _DeleteChatControlsConfigurationResponseSuccess
562
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteChatControlsConfigurationResponse]
563
+ end
564
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_chat_controls_configuration-instance_method
565
+ def delete_chat_controls_configuration: (
566
+ application_id: ::String
567
+ ) -> _DeleteChatControlsConfigurationResponseSuccess
568
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteChatControlsConfigurationResponseSuccess
569
+
570
+ interface _DeleteConversationResponseSuccess
571
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteConversationResponse]
572
+ end
573
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_conversation-instance_method
574
+ def delete_conversation: (
575
+ application_id: ::String,
576
+ conversation_id: ::String,
577
+ user_id: ::String
578
+ ) -> _DeleteConversationResponseSuccess
579
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteConversationResponseSuccess
580
+
581
+ interface _DeleteDataSourceResponseSuccess
582
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDataSourceResponse]
583
+ end
584
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_data_source-instance_method
585
+ def delete_data_source: (
586
+ application_id: ::String,
587
+ data_source_id: ::String,
588
+ index_id: ::String
589
+ ) -> _DeleteDataSourceResponseSuccess
590
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDataSourceResponseSuccess
591
+
592
+ interface _DeleteGroupResponseSuccess
593
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteGroupResponse]
594
+ end
595
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_group-instance_method
596
+ def delete_group: (
597
+ application_id: ::String,
598
+ ?data_source_id: ::String,
599
+ group_name: ::String,
600
+ index_id: ::String
601
+ ) -> _DeleteGroupResponseSuccess
602
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteGroupResponseSuccess
603
+
604
+ interface _DeleteIndexResponseSuccess
605
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteIndexResponse]
606
+ end
607
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_index-instance_method
608
+ def delete_index: (
609
+ application_id: ::String,
610
+ index_id: ::String
611
+ ) -> _DeleteIndexResponseSuccess
612
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteIndexResponseSuccess
613
+
614
+ interface _DeletePluginResponseSuccess
615
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeletePluginResponse]
616
+ end
617
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_plugin-instance_method
618
+ def delete_plugin: (
619
+ application_id: ::String,
620
+ plugin_id: ::String
621
+ ) -> _DeletePluginResponseSuccess
622
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeletePluginResponseSuccess
623
+
624
+ interface _DeleteRetrieverResponseSuccess
625
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRetrieverResponse]
626
+ end
627
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_retriever-instance_method
628
+ def delete_retriever: (
629
+ application_id: ::String,
630
+ retriever_id: ::String
631
+ ) -> _DeleteRetrieverResponseSuccess
632
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRetrieverResponseSuccess
633
+
634
+ interface _DeleteUserResponseSuccess
635
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteUserResponse]
636
+ end
637
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_user-instance_method
638
+ def delete_user: (
639
+ application_id: ::String,
640
+ user_id: ::String
641
+ ) -> _DeleteUserResponseSuccess
642
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteUserResponseSuccess
643
+
644
+ interface _DeleteWebExperienceResponseSuccess
645
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteWebExperienceResponse]
646
+ end
647
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_web_experience-instance_method
648
+ def delete_web_experience: (
649
+ application_id: ::String,
650
+ web_experience_id: ::String
651
+ ) -> _DeleteWebExperienceResponseSuccess
652
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteWebExperienceResponseSuccess
653
+
654
+ interface _GetApplicationResponseSuccess
655
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetApplicationResponse]
656
+ def application_arn: () -> ::String
657
+ def application_id: () -> ::String
658
+ def attachments_configuration: () -> Types::AppliedAttachmentsConfiguration
659
+ def created_at: () -> ::Time
660
+ def description: () -> ::String
661
+ def display_name: () -> ::String
662
+ def encryption_configuration: () -> Types::EncryptionConfiguration
663
+ def role_arn: () -> ::String
664
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
665
+ def updated_at: () -> ::Time
666
+ end
667
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_application-instance_method
668
+ def get_application: (
669
+ application_id: ::String
670
+ ) -> _GetApplicationResponseSuccess
671
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetApplicationResponseSuccess
672
+
673
+ interface _GetChatControlsConfigurationResponseSuccess
674
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetChatControlsConfigurationResponse]
675
+ def blocked_phrases: () -> Types::BlockedPhrasesConfiguration
676
+ def next_token: () -> ::String
677
+ def response_scope: () -> ("ENTERPRISE_CONTENT_ONLY" | "EXTENDED_KNOWLEDGE_ENABLED")
678
+ def topic_configurations: () -> ::Array[Types::TopicConfiguration]
679
+ end
680
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_chat_controls_configuration-instance_method
681
+ def get_chat_controls_configuration: (
682
+ application_id: ::String,
683
+ ?max_results: ::Integer,
684
+ ?next_token: ::String
685
+ ) -> _GetChatControlsConfigurationResponseSuccess
686
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetChatControlsConfigurationResponseSuccess
687
+
688
+ interface _GetDataSourceResponseSuccess
689
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDataSourceResponse]
690
+ def application_id: () -> ::String
691
+ def configuration: () -> untyped
692
+ def created_at: () -> ::Time
693
+ def data_source_arn: () -> ::String
694
+ def data_source_id: () -> ::String
695
+ def description: () -> ::String
696
+ def display_name: () -> ::String
697
+ def document_enrichment_configuration: () -> Types::DocumentEnrichmentConfiguration
698
+ def index_id: () -> ::String
699
+ def role_arn: () -> ::String
700
+ def status: () -> ("PENDING_CREATION" | "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
701
+ def sync_schedule: () -> ::String
702
+ def type: () -> ::String
703
+ def updated_at: () -> ::Time
704
+ def vpc_configuration: () -> Types::DataSourceVpcConfiguration
705
+ end
706
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_data_source-instance_method
707
+ def get_data_source: (
708
+ application_id: ::String,
709
+ data_source_id: ::String,
710
+ index_id: ::String
711
+ ) -> _GetDataSourceResponseSuccess
712
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDataSourceResponseSuccess
713
+
714
+ interface _GetGroupResponseSuccess
715
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetGroupResponse]
716
+ def status: () -> Types::GroupStatusDetail
717
+ def status_history: () -> ::Array[Types::GroupStatusDetail]
718
+ end
719
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_group-instance_method
720
+ def get_group: (
721
+ application_id: ::String,
722
+ ?data_source_id: ::String,
723
+ group_name: ::String,
724
+ index_id: ::String
725
+ ) -> _GetGroupResponseSuccess
726
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetGroupResponseSuccess
727
+
728
+ interface _GetIndexResponseSuccess
729
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetIndexResponse]
730
+ def application_id: () -> ::String
731
+ def capacity_configuration: () -> Types::IndexCapacityConfiguration
732
+ def created_at: () -> ::Time
733
+ def description: () -> ::String
734
+ def display_name: () -> ::String
735
+ def document_attribute_configurations: () -> ::Array[Types::DocumentAttributeConfiguration]
736
+ def index_arn: () -> ::String
737
+ def index_id: () -> ::String
738
+ def index_statistics: () -> Types::IndexStatistics
739
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
740
+ def updated_at: () -> ::Time
741
+ end
742
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_index-instance_method
743
+ def get_index: (
744
+ application_id: ::String,
745
+ index_id: ::String
746
+ ) -> _GetIndexResponseSuccess
747
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetIndexResponseSuccess
748
+
749
+ interface _GetPluginResponseSuccess
750
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetPluginResponse]
751
+ def application_id: () -> ::String
752
+ def auth_configuration: () -> Types::PluginAuthConfiguration
753
+ def created_at: () -> ::Time
754
+ def display_name: () -> ::String
755
+ def plugin_arn: () -> ::String
756
+ def plugin_id: () -> ::String
757
+ def server_url: () -> ::String
758
+ def state: () -> ("ENABLED" | "DISABLED")
759
+ def type: () -> ("SERVICE_NOW" | "SALESFORCE" | "JIRA" | "ZENDESK")
760
+ def updated_at: () -> ::Time
761
+ end
762
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_plugin-instance_method
763
+ def get_plugin: (
764
+ application_id: ::String,
765
+ plugin_id: ::String
766
+ ) -> _GetPluginResponseSuccess
767
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPluginResponseSuccess
768
+
769
+ interface _GetRetrieverResponseSuccess
770
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetRetrieverResponse]
771
+ def application_id: () -> ::String
772
+ def configuration: () -> Types::RetrieverConfiguration
773
+ def created_at: () -> ::Time
774
+ def display_name: () -> ::String
775
+ def retriever_arn: () -> ::String
776
+ def retriever_id: () -> ::String
777
+ def role_arn: () -> ::String
778
+ def status: () -> ("CREATING" | "ACTIVE" | "FAILED")
779
+ def type: () -> ("NATIVE_INDEX" | "KENDRA_INDEX")
780
+ def updated_at: () -> ::Time
781
+ end
782
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_retriever-instance_method
783
+ def get_retriever: (
784
+ application_id: ::String,
785
+ retriever_id: ::String
786
+ ) -> _GetRetrieverResponseSuccess
787
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRetrieverResponseSuccess
788
+
789
+ interface _GetUserResponseSuccess
790
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetUserResponse]
791
+ def user_aliases: () -> ::Array[Types::UserAlias]
792
+ end
793
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_user-instance_method
794
+ def get_user: (
795
+ application_id: ::String,
796
+ user_id: ::String
797
+ ) -> _GetUserResponseSuccess
798
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUserResponseSuccess
799
+
800
+ interface _GetWebExperienceResponseSuccess
801
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetWebExperienceResponse]
802
+ def application_id: () -> ::String
803
+ def authentication_configuration: () -> Types::WebExperienceAuthConfiguration
804
+ def created_at: () -> ::Time
805
+ def default_endpoint: () -> ::String
806
+ def sample_prompts_control_mode: () -> ("ENABLED" | "DISABLED")
807
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "PENDING_AUTH_CONFIG")
808
+ def subtitle: () -> ::String
809
+ def title: () -> ::String
810
+ def updated_at: () -> ::Time
811
+ def web_experience_arn: () -> ::String
812
+ def web_experience_id: () -> ::String
813
+ def welcome_message: () -> ::String
814
+ end
815
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_web_experience-instance_method
816
+ def get_web_experience: (
817
+ application_id: ::String,
818
+ web_experience_id: ::String
819
+ ) -> _GetWebExperienceResponseSuccess
820
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetWebExperienceResponseSuccess
821
+
822
+ interface _ListApplicationsResponseSuccess
823
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListApplicationsResponse]
824
+ def applications: () -> ::Array[Types::Application]
825
+ def next_token: () -> ::String
826
+ end
827
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_applications-instance_method
828
+ def list_applications: (
829
+ ?max_results: ::Integer,
830
+ ?next_token: ::String
831
+ ) -> _ListApplicationsResponseSuccess
832
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListApplicationsResponseSuccess
833
+
834
+ interface _ListConversationsResponseSuccess
835
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListConversationsResponse]
836
+ def conversations: () -> ::Array[Types::Conversation]
837
+ def next_token: () -> ::String
838
+ end
839
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_conversations-instance_method
840
+ def list_conversations: (
841
+ application_id: ::String,
842
+ ?max_results: ::Integer,
843
+ ?next_token: ::String,
844
+ user_id: ::String
845
+ ) -> _ListConversationsResponseSuccess
846
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListConversationsResponseSuccess
847
+
848
+ interface _ListDataSourceSyncJobsResponseSuccess
849
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDataSourceSyncJobsResponse]
850
+ def history: () -> ::Array[Types::DataSourceSyncJob]
851
+ def next_token: () -> ::String
852
+ end
853
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_data_source_sync_jobs-instance_method
854
+ def list_data_source_sync_jobs: (
855
+ application_id: ::String,
856
+ data_source_id: ::String,
857
+ ?end_time: ::Time,
858
+ index_id: ::String,
859
+ ?max_results: ::Integer,
860
+ ?next_token: ::String,
861
+ ?start_time: ::Time,
862
+ ?status_filter: ("FAILED" | "SUCCEEDED" | "SYNCING" | "INCOMPLETE" | "STOPPING" | "ABORTED" | "SYNCING_INDEXING")
863
+ ) -> _ListDataSourceSyncJobsResponseSuccess
864
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourceSyncJobsResponseSuccess
865
+
866
+ interface _ListDataSourcesResponseSuccess
867
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDataSourcesResponse]
868
+ def data_sources: () -> ::Array[Types::DataSource]
869
+ def next_token: () -> ::String
870
+ end
871
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_data_sources-instance_method
872
+ def list_data_sources: (
873
+ application_id: ::String,
874
+ index_id: ::String,
875
+ ?max_results: ::Integer,
876
+ ?next_token: ::String
877
+ ) -> _ListDataSourcesResponseSuccess
878
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourcesResponseSuccess
879
+
880
+ interface _ListDocumentsResponseSuccess
881
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDocumentsResponse]
882
+ def document_detail_list: () -> ::Array[Types::DocumentDetails]
883
+ def next_token: () -> ::String
884
+ end
885
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_documents-instance_method
886
+ def list_documents: (
887
+ application_id: ::String,
888
+ ?data_source_ids: Array[::String],
889
+ index_id: ::String,
890
+ ?max_results: ::Integer,
891
+ ?next_token: ::String
892
+ ) -> _ListDocumentsResponseSuccess
893
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDocumentsResponseSuccess
894
+
895
+ interface _ListGroupsResponseSuccess
896
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListGroupsResponse]
897
+ def items: () -> ::Array[Types::GroupSummary]
898
+ def next_token: () -> ::String
899
+ end
900
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_groups-instance_method
901
+ def list_groups: (
902
+ application_id: ::String,
903
+ ?data_source_id: ::String,
904
+ index_id: ::String,
905
+ ?max_results: ::Integer,
906
+ ?next_token: ::String,
907
+ updated_earlier_than: ::Time
908
+ ) -> _ListGroupsResponseSuccess
909
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListGroupsResponseSuccess
910
+
911
+ interface _ListIndicesResponseSuccess
912
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListIndicesResponse]
913
+ def indices: () -> ::Array[Types::Index]
914
+ def next_token: () -> ::String
915
+ end
916
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_indices-instance_method
917
+ def list_indices: (
918
+ application_id: ::String,
919
+ ?max_results: ::Integer,
920
+ ?next_token: ::String
921
+ ) -> _ListIndicesResponseSuccess
922
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListIndicesResponseSuccess
923
+
924
+ interface _ListMessagesResponseSuccess
925
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListMessagesResponse]
926
+ def messages: () -> ::Array[Types::Message]
927
+ def next_token: () -> ::String
928
+ end
929
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_messages-instance_method
930
+ def list_messages: (
931
+ application_id: ::String,
932
+ conversation_id: ::String,
933
+ ?max_results: ::Integer,
934
+ ?next_token: ::String,
935
+ user_id: ::String
936
+ ) -> _ListMessagesResponseSuccess
937
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessagesResponseSuccess
938
+
939
+ interface _ListPluginsResponseSuccess
940
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListPluginsResponse]
941
+ def next_token: () -> ::String
942
+ def plugins: () -> ::Array[Types::Plugin]
943
+ end
944
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_plugins-instance_method
945
+ def list_plugins: (
946
+ application_id: ::String,
947
+ ?max_results: ::Integer,
948
+ ?next_token: ::String
949
+ ) -> _ListPluginsResponseSuccess
950
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPluginsResponseSuccess
951
+
952
+ interface _ListRetrieversResponseSuccess
953
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListRetrieversResponse]
954
+ def next_token: () -> ::String
955
+ def retrievers: () -> ::Array[Types::Retriever]
956
+ end
957
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_retrievers-instance_method
958
+ def list_retrievers: (
959
+ application_id: ::String,
960
+ ?max_results: ::Integer,
961
+ ?next_token: ::String
962
+ ) -> _ListRetrieversResponseSuccess
963
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetrieversResponseSuccess
964
+
965
+ interface _ListTagsForResourceResponseSuccess
966
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
967
+ def tags: () -> ::Array[Types::Tag]
968
+ end
969
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_tags_for_resource-instance_method
970
+ def list_tags_for_resource: (
971
+ resource_arn: ::String
972
+ ) -> _ListTagsForResourceResponseSuccess
973
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
974
+
975
+ interface _ListWebExperiencesResponseSuccess
976
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListWebExperiencesResponse]
977
+ def next_token: () -> ::String
978
+ def web_experiences: () -> ::Array[Types::WebExperience]
979
+ end
980
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_web_experiences-instance_method
981
+ def list_web_experiences: (
982
+ application_id: ::String,
983
+ ?max_results: ::Integer,
984
+ ?next_token: ::String
985
+ ) -> _ListWebExperiencesResponseSuccess
986
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListWebExperiencesResponseSuccess
987
+
988
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#put_feedback-instance_method
989
+ def put_feedback: (
990
+ application_id: ::String,
991
+ conversation_id: ::String,
992
+ ?message_copied_at: ::Time,
993
+ message_id: ::String,
994
+ ?message_usefulness: {
995
+ comment: ::String?,
996
+ reason: ("NOT_FACTUALLY_CORRECT" | "HARMFUL_OR_UNSAFE" | "INCORRECT_OR_MISSING_SOURCES" | "NOT_HELPFUL" | "FACTUALLY_CORRECT" | "COMPLETE" | "RELEVANT_SOURCES" | "HELPFUL")?,
997
+ submitted_at: ::Time,
998
+ usefulness: ("USEFUL" | "NOT_USEFUL")
999
+ },
1000
+ user_id: ::String
1001
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1002
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1003
+
1004
+ interface _PutGroupResponseSuccess
1005
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutGroupResponse]
1006
+ end
1007
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#put_group-instance_method
1008
+ def put_group: (
1009
+ application_id: ::String,
1010
+ ?data_source_id: ::String,
1011
+ group_members: {
1012
+ member_groups: Array[
1013
+ {
1014
+ group_name: ::String,
1015
+ type: ("INDEX" | "DATASOURCE")?
1016
+ },
1017
+ ]?,
1018
+ member_users: Array[
1019
+ {
1020
+ type: ("INDEX" | "DATASOURCE")?,
1021
+ user_id: ::String
1022
+ },
1023
+ ]?
1024
+ },
1025
+ group_name: ::String,
1026
+ index_id: ::String,
1027
+ type: ("INDEX" | "DATASOURCE")
1028
+ ) -> _PutGroupResponseSuccess
1029
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutGroupResponseSuccess
1030
+
1031
+ interface _StartDataSourceSyncJobResponseSuccess
1032
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartDataSourceSyncJobResponse]
1033
+ def execution_id: () -> ::String
1034
+ end
1035
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#start_data_source_sync_job-instance_method
1036
+ def start_data_source_sync_job: (
1037
+ application_id: ::String,
1038
+ data_source_id: ::String,
1039
+ index_id: ::String
1040
+ ) -> _StartDataSourceSyncJobResponseSuccess
1041
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartDataSourceSyncJobResponseSuccess
1042
+
1043
+ interface _StopDataSourceSyncJobResponseSuccess
1044
+ include ::Seahorse::Client::_ResponseSuccess[Types::StopDataSourceSyncJobResponse]
1045
+ end
1046
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#stop_data_source_sync_job-instance_method
1047
+ def stop_data_source_sync_job: (
1048
+ application_id: ::String,
1049
+ data_source_id: ::String,
1050
+ index_id: ::String
1051
+ ) -> _StopDataSourceSyncJobResponseSuccess
1052
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopDataSourceSyncJobResponseSuccess
1053
+
1054
+ interface _TagResourceResponseSuccess
1055
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
1056
+ end
1057
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#tag_resource-instance_method
1058
+ def tag_resource: (
1059
+ resource_arn: ::String,
1060
+ tags: Array[
1061
+ {
1062
+ key: ::String,
1063
+ value: ::String
1064
+ },
1065
+ ]
1066
+ ) -> _TagResourceResponseSuccess
1067
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
1068
+
1069
+ interface _UntagResourceResponseSuccess
1070
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
1071
+ end
1072
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#untag_resource-instance_method
1073
+ def untag_resource: (
1074
+ resource_arn: ::String,
1075
+ tag_keys: Array[::String]
1076
+ ) -> _UntagResourceResponseSuccess
1077
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
1078
+
1079
+ interface _UpdateApplicationResponseSuccess
1080
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateApplicationResponse]
1081
+ end
1082
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_application-instance_method
1083
+ def update_application: (
1084
+ application_id: ::String,
1085
+ ?attachments_configuration: {
1086
+ attachments_control_mode: ("ENABLED" | "DISABLED")
1087
+ },
1088
+ ?description: ::String,
1089
+ ?display_name: ::String,
1090
+ ?role_arn: ::String
1091
+ ) -> _UpdateApplicationResponseSuccess
1092
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateApplicationResponseSuccess
1093
+
1094
+ interface _UpdateChatControlsConfigurationResponseSuccess
1095
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateChatControlsConfigurationResponse]
1096
+ end
1097
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_chat_controls_configuration-instance_method
1098
+ def update_chat_controls_configuration: (
1099
+ application_id: ::String,
1100
+ ?blocked_phrases_configuration_update: {
1101
+ blocked_phrases_to_create_or_update: Array[::String]?,
1102
+ blocked_phrases_to_delete: Array[::String]?,
1103
+ system_message_override: ::String?
1104
+ },
1105
+ ?client_token: ::String,
1106
+ ?response_scope: ("ENTERPRISE_CONTENT_ONLY" | "EXTENDED_KNOWLEDGE_ENABLED"),
1107
+ ?topic_configurations_to_create_or_update: Array[
1108
+ {
1109
+ description: ::String?,
1110
+ example_chat_messages: Array[::String]?,
1111
+ name: ::String,
1112
+ rules: Array[
1113
+ {
1114
+ excluded_users_and_groups: {
1115
+ user_groups: Array[::String]?,
1116
+ user_ids: Array[::String]?
1117
+ }?,
1118
+ included_users_and_groups: {
1119
+ user_groups: Array[::String]?,
1120
+ user_ids: Array[::String]?
1121
+ }?,
1122
+ rule_configuration: {
1123
+ content_blocker_rule: {
1124
+ system_message_override: ::String?
1125
+ }?,
1126
+ content_retrieval_rule: {
1127
+ eligible_data_sources: Array[
1128
+ {
1129
+ data_source_id: ::String?,
1130
+ index_id: ::String?
1131
+ },
1132
+ ]?
1133
+ }?
1134
+ }?,
1135
+ rule_type: ("CONTENT_BLOCKER_RULE" | "CONTENT_RETRIEVAL_RULE")
1136
+ },
1137
+ ]
1138
+ },
1139
+ ],
1140
+ ?topic_configurations_to_delete: Array[
1141
+ {
1142
+ description: ::String?,
1143
+ example_chat_messages: Array[::String]?,
1144
+ name: ::String,
1145
+ rules: Array[
1146
+ {
1147
+ excluded_users_and_groups: {
1148
+ user_groups: Array[::String]?,
1149
+ user_ids: Array[::String]?
1150
+ }?,
1151
+ included_users_and_groups: {
1152
+ user_groups: Array[::String]?,
1153
+ user_ids: Array[::String]?
1154
+ }?,
1155
+ rule_configuration: {
1156
+ content_blocker_rule: {
1157
+ system_message_override: ::String?
1158
+ }?,
1159
+ content_retrieval_rule: {
1160
+ eligible_data_sources: Array[
1161
+ {
1162
+ data_source_id: ::String?,
1163
+ index_id: ::String?
1164
+ },
1165
+ ]?
1166
+ }?
1167
+ }?,
1168
+ rule_type: ("CONTENT_BLOCKER_RULE" | "CONTENT_RETRIEVAL_RULE")
1169
+ },
1170
+ ]
1171
+ },
1172
+ ]
1173
+ ) -> _UpdateChatControlsConfigurationResponseSuccess
1174
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateChatControlsConfigurationResponseSuccess
1175
+
1176
+ interface _UpdateDataSourceResponseSuccess
1177
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateDataSourceResponse]
1178
+ end
1179
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_data_source-instance_method
1180
+ def update_data_source: (
1181
+ application_id: ::String,
1182
+ ?configuration: {
1183
+ },
1184
+ data_source_id: ::String,
1185
+ ?description: ::String,
1186
+ ?display_name: ::String,
1187
+ ?document_enrichment_configuration: {
1188
+ inline_configurations: Array[
1189
+ {
1190
+ condition: {
1191
+ key: ::String,
1192
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
1193
+ value: {
1194
+ date_value: ::Time?,
1195
+ long_value: ::Integer?,
1196
+ string_list_value: Array[::String]?,
1197
+ string_value: ::String?
1198
+ }?
1199
+ }?,
1200
+ document_content_operator: ("DELETE")?,
1201
+ target: {
1202
+ attribute_value_operator: ("DELETE")?,
1203
+ key: ::String,
1204
+ value: {
1205
+ date_value: ::Time?,
1206
+ long_value: ::Integer?,
1207
+ string_list_value: Array[::String]?,
1208
+ string_value: ::String?
1209
+ }?
1210
+ }?
1211
+ },
1212
+ ]?,
1213
+ post_extraction_hook_configuration: {
1214
+ invocation_condition: {
1215
+ key: ::String,
1216
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
1217
+ value: {
1218
+ date_value: ::Time?,
1219
+ long_value: ::Integer?,
1220
+ string_list_value: Array[::String]?,
1221
+ string_value: ::String?
1222
+ }?
1223
+ }?,
1224
+ lambda_arn: ::String?,
1225
+ role_arn: ::String?,
1226
+ s3_bucket_name: ::String?
1227
+ }?,
1228
+ pre_extraction_hook_configuration: {
1229
+ invocation_condition: {
1230
+ key: ::String,
1231
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
1232
+ value: {
1233
+ date_value: ::Time?,
1234
+ long_value: ::Integer?,
1235
+ string_list_value: Array[::String]?,
1236
+ string_value: ::String?
1237
+ }?
1238
+ }?,
1239
+ lambda_arn: ::String?,
1240
+ role_arn: ::String?,
1241
+ s3_bucket_name: ::String?
1242
+ }?
1243
+ },
1244
+ index_id: ::String,
1245
+ ?role_arn: ::String,
1246
+ ?sync_schedule: ::String,
1247
+ ?vpc_configuration: {
1248
+ security_group_ids: Array[::String],
1249
+ subnet_ids: Array[::String]
1250
+ }
1251
+ ) -> _UpdateDataSourceResponseSuccess
1252
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDataSourceResponseSuccess
1253
+
1254
+ interface _UpdateIndexResponseSuccess
1255
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateIndexResponse]
1256
+ end
1257
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_index-instance_method
1258
+ def update_index: (
1259
+ application_id: ::String,
1260
+ ?capacity_configuration: {
1261
+ units: ::Integer?
1262
+ },
1263
+ ?description: ::String,
1264
+ ?display_name: ::String,
1265
+ ?document_attribute_configurations: Array[
1266
+ {
1267
+ name: ::String?,
1268
+ search: ("ENABLED" | "DISABLED")?,
1269
+ type: ("STRING" | "STRING_LIST" | "NUMBER" | "DATE")?
1270
+ },
1271
+ ],
1272
+ index_id: ::String
1273
+ ) -> _UpdateIndexResponseSuccess
1274
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateIndexResponseSuccess
1275
+
1276
+ interface _UpdatePluginResponseSuccess
1277
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdatePluginResponse]
1278
+ end
1279
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_plugin-instance_method
1280
+ def update_plugin: (
1281
+ application_id: ::String,
1282
+ ?auth_configuration: {
1283
+ basic_auth_configuration: {
1284
+ role_arn: ::String,
1285
+ secret_arn: ::String
1286
+ }?,
1287
+ o_auth_2_client_credential_configuration: {
1288
+ role_arn: ::String,
1289
+ secret_arn: ::String
1290
+ }?
1291
+ },
1292
+ ?display_name: ::String,
1293
+ plugin_id: ::String,
1294
+ ?server_url: ::String,
1295
+ ?state: ("ENABLED" | "DISABLED")
1296
+ ) -> _UpdatePluginResponseSuccess
1297
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdatePluginResponseSuccess
1298
+
1299
+ interface _UpdateRetrieverResponseSuccess
1300
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateRetrieverResponse]
1301
+ end
1302
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_retriever-instance_method
1303
+ def update_retriever: (
1304
+ application_id: ::String,
1305
+ ?configuration: {
1306
+ kendra_index_configuration: {
1307
+ index_id: ::String
1308
+ }?,
1309
+ native_index_configuration: {
1310
+ index_id: ::String
1311
+ }?
1312
+ },
1313
+ ?display_name: ::String,
1314
+ retriever_id: ::String,
1315
+ ?role_arn: ::String
1316
+ ) -> _UpdateRetrieverResponseSuccess
1317
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRetrieverResponseSuccess
1318
+
1319
+ interface _UpdateUserResponseSuccess
1320
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserResponse]
1321
+ def user_aliases_added: () -> ::Array[Types::UserAlias]
1322
+ def user_aliases_deleted: () -> ::Array[Types::UserAlias]
1323
+ def user_aliases_updated: () -> ::Array[Types::UserAlias]
1324
+ end
1325
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_user-instance_method
1326
+ def update_user: (
1327
+ application_id: ::String,
1328
+ ?user_aliases_to_delete: Array[
1329
+ {
1330
+ data_source_id: ::String?,
1331
+ index_id: ::String?,
1332
+ user_id: ::String
1333
+ },
1334
+ ],
1335
+ ?user_aliases_to_update: Array[
1336
+ {
1337
+ data_source_id: ::String?,
1338
+ index_id: ::String?,
1339
+ user_id: ::String
1340
+ },
1341
+ ],
1342
+ user_id: ::String
1343
+ ) -> _UpdateUserResponseSuccess
1344
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserResponseSuccess
1345
+
1346
+ interface _UpdateWebExperienceResponseSuccess
1347
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateWebExperienceResponse]
1348
+ end
1349
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_web_experience-instance_method
1350
+ def update_web_experience: (
1351
+ application_id: ::String,
1352
+ ?authentication_configuration: {
1353
+ saml_configuration: {
1354
+ metadata_xml: ::String,
1355
+ role_arn: ::String,
1356
+ user_group_attribute: ::String?,
1357
+ user_id_attribute: ::String
1358
+ }?
1359
+ },
1360
+ ?sample_prompts_control_mode: ("ENABLED" | "DISABLED"),
1361
+ ?subtitle: ::String,
1362
+ ?title: ::String,
1363
+ web_experience_id: ::String,
1364
+ ?welcome_message: ::String
1365
+ ) -> _UpdateWebExperienceResponseSuccess
1366
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateWebExperienceResponseSuccess
1367
+ end
1368
+ end
1369
+ end
1370
+