aws-sdk-qbusiness 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/sig/client.rbs ADDED
@@ -0,0 +1,1404 @@
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
+ boosting_override: Hash[::String, {
498
+ date_configuration: {
499
+ boosting_duration_in_seconds: ::Integer?,
500
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")
501
+ }?,
502
+ number_configuration: {
503
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH"),
504
+ boosting_type: ("PRIORITIZE_LARGER_VALUES" | "PRIORITIZE_SMALLER_VALUES")?
505
+ }?,
506
+ string_configuration: {
507
+ attribute_value_boosting: Hash[::String, ("LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")]?,
508
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")
509
+ }?,
510
+ string_list_configuration: {
511
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")
512
+ }?
513
+ }]?,
514
+ index_id: ::String
515
+ }?
516
+ },
517
+ display_name: ::String,
518
+ ?role_arn: ::String,
519
+ ?tags: Array[
520
+ {
521
+ key: ::String,
522
+ value: ::String
523
+ },
524
+ ],
525
+ type: ("NATIVE_INDEX" | "KENDRA_INDEX")
526
+ ) -> _CreateRetrieverResponseSuccess
527
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRetrieverResponseSuccess
528
+
529
+ interface _CreateUserResponseSuccess
530
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserResponse]
531
+ end
532
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_user-instance_method
533
+ def create_user: (
534
+ application_id: ::String,
535
+ ?client_token: ::String,
536
+ ?user_aliases: Array[
537
+ {
538
+ data_source_id: ::String?,
539
+ index_id: ::String?,
540
+ user_id: ::String
541
+ },
542
+ ],
543
+ user_id: ::String
544
+ ) -> _CreateUserResponseSuccess
545
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserResponseSuccess
546
+
547
+ interface _CreateWebExperienceResponseSuccess
548
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateWebExperienceResponse]
549
+ def web_experience_arn: () -> ::String
550
+ def web_experience_id: () -> ::String
551
+ end
552
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_web_experience-instance_method
553
+ def create_web_experience: (
554
+ application_id: ::String,
555
+ ?client_token: ::String,
556
+ ?sample_prompts_control_mode: ("ENABLED" | "DISABLED"),
557
+ ?subtitle: ::String,
558
+ ?tags: Array[
559
+ {
560
+ key: ::String,
561
+ value: ::String
562
+ },
563
+ ],
564
+ ?title: ::String,
565
+ ?welcome_message: ::String
566
+ ) -> _CreateWebExperienceResponseSuccess
567
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateWebExperienceResponseSuccess
568
+
569
+ interface _DeleteApplicationResponseSuccess
570
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteApplicationResponse]
571
+ end
572
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_application-instance_method
573
+ def delete_application: (
574
+ application_id: ::String
575
+ ) -> _DeleteApplicationResponseSuccess
576
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteApplicationResponseSuccess
577
+
578
+ interface _DeleteChatControlsConfigurationResponseSuccess
579
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteChatControlsConfigurationResponse]
580
+ end
581
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_chat_controls_configuration-instance_method
582
+ def delete_chat_controls_configuration: (
583
+ application_id: ::String
584
+ ) -> _DeleteChatControlsConfigurationResponseSuccess
585
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteChatControlsConfigurationResponseSuccess
586
+
587
+ interface _DeleteConversationResponseSuccess
588
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteConversationResponse]
589
+ end
590
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_conversation-instance_method
591
+ def delete_conversation: (
592
+ application_id: ::String,
593
+ conversation_id: ::String,
594
+ user_id: ::String
595
+ ) -> _DeleteConversationResponseSuccess
596
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteConversationResponseSuccess
597
+
598
+ interface _DeleteDataSourceResponseSuccess
599
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDataSourceResponse]
600
+ end
601
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_data_source-instance_method
602
+ def delete_data_source: (
603
+ application_id: ::String,
604
+ data_source_id: ::String,
605
+ index_id: ::String
606
+ ) -> _DeleteDataSourceResponseSuccess
607
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDataSourceResponseSuccess
608
+
609
+ interface _DeleteGroupResponseSuccess
610
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteGroupResponse]
611
+ end
612
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_group-instance_method
613
+ def delete_group: (
614
+ application_id: ::String,
615
+ ?data_source_id: ::String,
616
+ group_name: ::String,
617
+ index_id: ::String
618
+ ) -> _DeleteGroupResponseSuccess
619
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteGroupResponseSuccess
620
+
621
+ interface _DeleteIndexResponseSuccess
622
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteIndexResponse]
623
+ end
624
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_index-instance_method
625
+ def delete_index: (
626
+ application_id: ::String,
627
+ index_id: ::String
628
+ ) -> _DeleteIndexResponseSuccess
629
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteIndexResponseSuccess
630
+
631
+ interface _DeletePluginResponseSuccess
632
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeletePluginResponse]
633
+ end
634
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_plugin-instance_method
635
+ def delete_plugin: (
636
+ application_id: ::String,
637
+ plugin_id: ::String
638
+ ) -> _DeletePluginResponseSuccess
639
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeletePluginResponseSuccess
640
+
641
+ interface _DeleteRetrieverResponseSuccess
642
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRetrieverResponse]
643
+ end
644
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_retriever-instance_method
645
+ def delete_retriever: (
646
+ application_id: ::String,
647
+ retriever_id: ::String
648
+ ) -> _DeleteRetrieverResponseSuccess
649
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRetrieverResponseSuccess
650
+
651
+ interface _DeleteUserResponseSuccess
652
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteUserResponse]
653
+ end
654
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_user-instance_method
655
+ def delete_user: (
656
+ application_id: ::String,
657
+ user_id: ::String
658
+ ) -> _DeleteUserResponseSuccess
659
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteUserResponseSuccess
660
+
661
+ interface _DeleteWebExperienceResponseSuccess
662
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteWebExperienceResponse]
663
+ end
664
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#delete_web_experience-instance_method
665
+ def delete_web_experience: (
666
+ application_id: ::String,
667
+ web_experience_id: ::String
668
+ ) -> _DeleteWebExperienceResponseSuccess
669
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteWebExperienceResponseSuccess
670
+
671
+ interface _GetApplicationResponseSuccess
672
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetApplicationResponse]
673
+ def application_arn: () -> ::String
674
+ def application_id: () -> ::String
675
+ def attachments_configuration: () -> Types::AppliedAttachmentsConfiguration
676
+ def created_at: () -> ::Time
677
+ def description: () -> ::String
678
+ def display_name: () -> ::String
679
+ def encryption_configuration: () -> Types::EncryptionConfiguration
680
+ def role_arn: () -> ::String
681
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
682
+ def updated_at: () -> ::Time
683
+ end
684
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_application-instance_method
685
+ def get_application: (
686
+ application_id: ::String
687
+ ) -> _GetApplicationResponseSuccess
688
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetApplicationResponseSuccess
689
+
690
+ interface _GetChatControlsConfigurationResponseSuccess
691
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetChatControlsConfigurationResponse]
692
+ def blocked_phrases: () -> Types::BlockedPhrasesConfiguration
693
+ def next_token: () -> ::String
694
+ def response_scope: () -> ("ENTERPRISE_CONTENT_ONLY" | "EXTENDED_KNOWLEDGE_ENABLED")
695
+ def topic_configurations: () -> ::Array[Types::TopicConfiguration]
696
+ end
697
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_chat_controls_configuration-instance_method
698
+ def get_chat_controls_configuration: (
699
+ application_id: ::String,
700
+ ?max_results: ::Integer,
701
+ ?next_token: ::String
702
+ ) -> _GetChatControlsConfigurationResponseSuccess
703
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetChatControlsConfigurationResponseSuccess
704
+
705
+ interface _GetDataSourceResponseSuccess
706
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDataSourceResponse]
707
+ def application_id: () -> ::String
708
+ def configuration: () -> untyped
709
+ def created_at: () -> ::Time
710
+ def data_source_arn: () -> ::String
711
+ def data_source_id: () -> ::String
712
+ def description: () -> ::String
713
+ def display_name: () -> ::String
714
+ def document_enrichment_configuration: () -> Types::DocumentEnrichmentConfiguration
715
+ def index_id: () -> ::String
716
+ def role_arn: () -> ::String
717
+ def status: () -> ("PENDING_CREATION" | "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
718
+ def sync_schedule: () -> ::String
719
+ def type: () -> ::String
720
+ def updated_at: () -> ::Time
721
+ def vpc_configuration: () -> Types::DataSourceVpcConfiguration
722
+ end
723
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_data_source-instance_method
724
+ def get_data_source: (
725
+ application_id: ::String,
726
+ data_source_id: ::String,
727
+ index_id: ::String
728
+ ) -> _GetDataSourceResponseSuccess
729
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDataSourceResponseSuccess
730
+
731
+ interface _GetGroupResponseSuccess
732
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetGroupResponse]
733
+ def status: () -> Types::GroupStatusDetail
734
+ def status_history: () -> ::Array[Types::GroupStatusDetail]
735
+ end
736
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_group-instance_method
737
+ def get_group: (
738
+ application_id: ::String,
739
+ ?data_source_id: ::String,
740
+ group_name: ::String,
741
+ index_id: ::String
742
+ ) -> _GetGroupResponseSuccess
743
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetGroupResponseSuccess
744
+
745
+ interface _GetIndexResponseSuccess
746
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetIndexResponse]
747
+ def application_id: () -> ::String
748
+ def capacity_configuration: () -> Types::IndexCapacityConfiguration
749
+ def created_at: () -> ::Time
750
+ def description: () -> ::String
751
+ def display_name: () -> ::String
752
+ def document_attribute_configurations: () -> ::Array[Types::DocumentAttributeConfiguration]
753
+ def index_arn: () -> ::String
754
+ def index_id: () -> ::String
755
+ def index_statistics: () -> Types::IndexStatistics
756
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING")
757
+ def updated_at: () -> ::Time
758
+ end
759
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_index-instance_method
760
+ def get_index: (
761
+ application_id: ::String,
762
+ index_id: ::String
763
+ ) -> _GetIndexResponseSuccess
764
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetIndexResponseSuccess
765
+
766
+ interface _GetPluginResponseSuccess
767
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetPluginResponse]
768
+ def application_id: () -> ::String
769
+ def auth_configuration: () -> Types::PluginAuthConfiguration
770
+ def created_at: () -> ::Time
771
+ def display_name: () -> ::String
772
+ def plugin_arn: () -> ::String
773
+ def plugin_id: () -> ::String
774
+ def server_url: () -> ::String
775
+ def state: () -> ("ENABLED" | "DISABLED")
776
+ def type: () -> ("SERVICE_NOW" | "SALESFORCE" | "JIRA" | "ZENDESK")
777
+ def updated_at: () -> ::Time
778
+ end
779
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_plugin-instance_method
780
+ def get_plugin: (
781
+ application_id: ::String,
782
+ plugin_id: ::String
783
+ ) -> _GetPluginResponseSuccess
784
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPluginResponseSuccess
785
+
786
+ interface _GetRetrieverResponseSuccess
787
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetRetrieverResponse]
788
+ def application_id: () -> ::String
789
+ def configuration: () -> Types::RetrieverConfiguration
790
+ def created_at: () -> ::Time
791
+ def display_name: () -> ::String
792
+ def retriever_arn: () -> ::String
793
+ def retriever_id: () -> ::String
794
+ def role_arn: () -> ::String
795
+ def status: () -> ("CREATING" | "ACTIVE" | "FAILED")
796
+ def type: () -> ("NATIVE_INDEX" | "KENDRA_INDEX")
797
+ def updated_at: () -> ::Time
798
+ end
799
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_retriever-instance_method
800
+ def get_retriever: (
801
+ application_id: ::String,
802
+ retriever_id: ::String
803
+ ) -> _GetRetrieverResponseSuccess
804
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRetrieverResponseSuccess
805
+
806
+ interface _GetUserResponseSuccess
807
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetUserResponse]
808
+ def user_aliases: () -> ::Array[Types::UserAlias]
809
+ end
810
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_user-instance_method
811
+ def get_user: (
812
+ application_id: ::String,
813
+ user_id: ::String
814
+ ) -> _GetUserResponseSuccess
815
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUserResponseSuccess
816
+
817
+ interface _GetWebExperienceResponseSuccess
818
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetWebExperienceResponse]
819
+ def application_id: () -> ::String
820
+ def authentication_configuration: () -> Types::WebExperienceAuthConfiguration
821
+ def created_at: () -> ::Time
822
+ def default_endpoint: () -> ::String
823
+ def sample_prompts_control_mode: () -> ("ENABLED" | "DISABLED")
824
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "PENDING_AUTH_CONFIG")
825
+ def subtitle: () -> ::String
826
+ def title: () -> ::String
827
+ def updated_at: () -> ::Time
828
+ def web_experience_arn: () -> ::String
829
+ def web_experience_id: () -> ::String
830
+ def welcome_message: () -> ::String
831
+ end
832
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_web_experience-instance_method
833
+ def get_web_experience: (
834
+ application_id: ::String,
835
+ web_experience_id: ::String
836
+ ) -> _GetWebExperienceResponseSuccess
837
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetWebExperienceResponseSuccess
838
+
839
+ interface _ListApplicationsResponseSuccess
840
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListApplicationsResponse]
841
+ def applications: () -> ::Array[Types::Application]
842
+ def next_token: () -> ::String
843
+ end
844
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_applications-instance_method
845
+ def list_applications: (
846
+ ?max_results: ::Integer,
847
+ ?next_token: ::String
848
+ ) -> _ListApplicationsResponseSuccess
849
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListApplicationsResponseSuccess
850
+
851
+ interface _ListConversationsResponseSuccess
852
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListConversationsResponse]
853
+ def conversations: () -> ::Array[Types::Conversation]
854
+ def next_token: () -> ::String
855
+ end
856
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_conversations-instance_method
857
+ def list_conversations: (
858
+ application_id: ::String,
859
+ ?max_results: ::Integer,
860
+ ?next_token: ::String,
861
+ user_id: ::String
862
+ ) -> _ListConversationsResponseSuccess
863
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListConversationsResponseSuccess
864
+
865
+ interface _ListDataSourceSyncJobsResponseSuccess
866
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDataSourceSyncJobsResponse]
867
+ def history: () -> ::Array[Types::DataSourceSyncJob]
868
+ def next_token: () -> ::String
869
+ end
870
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_data_source_sync_jobs-instance_method
871
+ def list_data_source_sync_jobs: (
872
+ application_id: ::String,
873
+ data_source_id: ::String,
874
+ ?end_time: ::Time,
875
+ index_id: ::String,
876
+ ?max_results: ::Integer,
877
+ ?next_token: ::String,
878
+ ?start_time: ::Time,
879
+ ?status_filter: ("FAILED" | "SUCCEEDED" | "SYNCING" | "INCOMPLETE" | "STOPPING" | "ABORTED" | "SYNCING_INDEXING")
880
+ ) -> _ListDataSourceSyncJobsResponseSuccess
881
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourceSyncJobsResponseSuccess
882
+
883
+ interface _ListDataSourcesResponseSuccess
884
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDataSourcesResponse]
885
+ def data_sources: () -> ::Array[Types::DataSource]
886
+ def next_token: () -> ::String
887
+ end
888
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_data_sources-instance_method
889
+ def list_data_sources: (
890
+ application_id: ::String,
891
+ index_id: ::String,
892
+ ?max_results: ::Integer,
893
+ ?next_token: ::String
894
+ ) -> _ListDataSourcesResponseSuccess
895
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourcesResponseSuccess
896
+
897
+ interface _ListDocumentsResponseSuccess
898
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDocumentsResponse]
899
+ def document_detail_list: () -> ::Array[Types::DocumentDetails]
900
+ def next_token: () -> ::String
901
+ end
902
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_documents-instance_method
903
+ def list_documents: (
904
+ application_id: ::String,
905
+ ?data_source_ids: Array[::String],
906
+ index_id: ::String,
907
+ ?max_results: ::Integer,
908
+ ?next_token: ::String
909
+ ) -> _ListDocumentsResponseSuccess
910
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDocumentsResponseSuccess
911
+
912
+ interface _ListGroupsResponseSuccess
913
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListGroupsResponse]
914
+ def items: () -> ::Array[Types::GroupSummary]
915
+ def next_token: () -> ::String
916
+ end
917
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_groups-instance_method
918
+ def list_groups: (
919
+ application_id: ::String,
920
+ ?data_source_id: ::String,
921
+ index_id: ::String,
922
+ ?max_results: ::Integer,
923
+ ?next_token: ::String,
924
+ updated_earlier_than: ::Time
925
+ ) -> _ListGroupsResponseSuccess
926
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListGroupsResponseSuccess
927
+
928
+ interface _ListIndicesResponseSuccess
929
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListIndicesResponse]
930
+ def indices: () -> ::Array[Types::Index]
931
+ def next_token: () -> ::String
932
+ end
933
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_indices-instance_method
934
+ def list_indices: (
935
+ application_id: ::String,
936
+ ?max_results: ::Integer,
937
+ ?next_token: ::String
938
+ ) -> _ListIndicesResponseSuccess
939
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListIndicesResponseSuccess
940
+
941
+ interface _ListMessagesResponseSuccess
942
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListMessagesResponse]
943
+ def messages: () -> ::Array[Types::Message]
944
+ def next_token: () -> ::String
945
+ end
946
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_messages-instance_method
947
+ def list_messages: (
948
+ application_id: ::String,
949
+ conversation_id: ::String,
950
+ ?max_results: ::Integer,
951
+ ?next_token: ::String,
952
+ user_id: ::String
953
+ ) -> _ListMessagesResponseSuccess
954
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessagesResponseSuccess
955
+
956
+ interface _ListPluginsResponseSuccess
957
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListPluginsResponse]
958
+ def next_token: () -> ::String
959
+ def plugins: () -> ::Array[Types::Plugin]
960
+ end
961
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_plugins-instance_method
962
+ def list_plugins: (
963
+ application_id: ::String,
964
+ ?max_results: ::Integer,
965
+ ?next_token: ::String
966
+ ) -> _ListPluginsResponseSuccess
967
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPluginsResponseSuccess
968
+
969
+ interface _ListRetrieversResponseSuccess
970
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListRetrieversResponse]
971
+ def next_token: () -> ::String
972
+ def retrievers: () -> ::Array[Types::Retriever]
973
+ end
974
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_retrievers-instance_method
975
+ def list_retrievers: (
976
+ application_id: ::String,
977
+ ?max_results: ::Integer,
978
+ ?next_token: ::String
979
+ ) -> _ListRetrieversResponseSuccess
980
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetrieversResponseSuccess
981
+
982
+ interface _ListTagsForResourceResponseSuccess
983
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
984
+ def tags: () -> ::Array[Types::Tag]
985
+ end
986
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_tags_for_resource-instance_method
987
+ def list_tags_for_resource: (
988
+ resource_arn: ::String
989
+ ) -> _ListTagsForResourceResponseSuccess
990
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
991
+
992
+ interface _ListWebExperiencesResponseSuccess
993
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListWebExperiencesResponse]
994
+ def next_token: () -> ::String
995
+ def web_experiences: () -> ::Array[Types::WebExperience]
996
+ end
997
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_web_experiences-instance_method
998
+ def list_web_experiences: (
999
+ application_id: ::String,
1000
+ ?max_results: ::Integer,
1001
+ ?next_token: ::String
1002
+ ) -> _ListWebExperiencesResponseSuccess
1003
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListWebExperiencesResponseSuccess
1004
+
1005
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#put_feedback-instance_method
1006
+ def put_feedback: (
1007
+ application_id: ::String,
1008
+ conversation_id: ::String,
1009
+ ?message_copied_at: ::Time,
1010
+ message_id: ::String,
1011
+ ?message_usefulness: {
1012
+ comment: ::String?,
1013
+ reason: ("NOT_FACTUALLY_CORRECT" | "HARMFUL_OR_UNSAFE" | "INCORRECT_OR_MISSING_SOURCES" | "NOT_HELPFUL" | "FACTUALLY_CORRECT" | "COMPLETE" | "RELEVANT_SOURCES" | "HELPFUL" | "NOT_BASED_ON_DOCUMENTS" | "NOT_COMPLETE" | "NOT_CONCISE" | "OTHER")?,
1014
+ submitted_at: ::Time,
1015
+ usefulness: ("USEFUL" | "NOT_USEFUL")
1016
+ },
1017
+ user_id: ::String
1018
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1019
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
1020
+
1021
+ interface _PutGroupResponseSuccess
1022
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutGroupResponse]
1023
+ end
1024
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#put_group-instance_method
1025
+ def put_group: (
1026
+ application_id: ::String,
1027
+ ?data_source_id: ::String,
1028
+ group_members: {
1029
+ member_groups: Array[
1030
+ {
1031
+ group_name: ::String,
1032
+ type: ("INDEX" | "DATASOURCE")?
1033
+ },
1034
+ ]?,
1035
+ member_users: Array[
1036
+ {
1037
+ type: ("INDEX" | "DATASOURCE")?,
1038
+ user_id: ::String
1039
+ },
1040
+ ]?
1041
+ },
1042
+ group_name: ::String,
1043
+ index_id: ::String,
1044
+ type: ("INDEX" | "DATASOURCE")
1045
+ ) -> _PutGroupResponseSuccess
1046
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutGroupResponseSuccess
1047
+
1048
+ interface _StartDataSourceSyncJobResponseSuccess
1049
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartDataSourceSyncJobResponse]
1050
+ def execution_id: () -> ::String
1051
+ end
1052
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#start_data_source_sync_job-instance_method
1053
+ def start_data_source_sync_job: (
1054
+ application_id: ::String,
1055
+ data_source_id: ::String,
1056
+ index_id: ::String
1057
+ ) -> _StartDataSourceSyncJobResponseSuccess
1058
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartDataSourceSyncJobResponseSuccess
1059
+
1060
+ interface _StopDataSourceSyncJobResponseSuccess
1061
+ include ::Seahorse::Client::_ResponseSuccess[Types::StopDataSourceSyncJobResponse]
1062
+ end
1063
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#stop_data_source_sync_job-instance_method
1064
+ def stop_data_source_sync_job: (
1065
+ application_id: ::String,
1066
+ data_source_id: ::String,
1067
+ index_id: ::String
1068
+ ) -> _StopDataSourceSyncJobResponseSuccess
1069
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopDataSourceSyncJobResponseSuccess
1070
+
1071
+ interface _TagResourceResponseSuccess
1072
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
1073
+ end
1074
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#tag_resource-instance_method
1075
+ def tag_resource: (
1076
+ resource_arn: ::String,
1077
+ tags: Array[
1078
+ {
1079
+ key: ::String,
1080
+ value: ::String
1081
+ },
1082
+ ]
1083
+ ) -> _TagResourceResponseSuccess
1084
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
1085
+
1086
+ interface _UntagResourceResponseSuccess
1087
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
1088
+ end
1089
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#untag_resource-instance_method
1090
+ def untag_resource: (
1091
+ resource_arn: ::String,
1092
+ tag_keys: Array[::String]
1093
+ ) -> _UntagResourceResponseSuccess
1094
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
1095
+
1096
+ interface _UpdateApplicationResponseSuccess
1097
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateApplicationResponse]
1098
+ end
1099
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_application-instance_method
1100
+ def update_application: (
1101
+ application_id: ::String,
1102
+ ?attachments_configuration: {
1103
+ attachments_control_mode: ("ENABLED" | "DISABLED")
1104
+ },
1105
+ ?description: ::String,
1106
+ ?display_name: ::String,
1107
+ ?role_arn: ::String
1108
+ ) -> _UpdateApplicationResponseSuccess
1109
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateApplicationResponseSuccess
1110
+
1111
+ interface _UpdateChatControlsConfigurationResponseSuccess
1112
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateChatControlsConfigurationResponse]
1113
+ end
1114
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_chat_controls_configuration-instance_method
1115
+ def update_chat_controls_configuration: (
1116
+ application_id: ::String,
1117
+ ?blocked_phrases_configuration_update: {
1118
+ blocked_phrases_to_create_or_update: Array[::String]?,
1119
+ blocked_phrases_to_delete: Array[::String]?,
1120
+ system_message_override: ::String?
1121
+ },
1122
+ ?client_token: ::String,
1123
+ ?response_scope: ("ENTERPRISE_CONTENT_ONLY" | "EXTENDED_KNOWLEDGE_ENABLED"),
1124
+ ?topic_configurations_to_create_or_update: Array[
1125
+ {
1126
+ description: ::String?,
1127
+ example_chat_messages: Array[::String]?,
1128
+ name: ::String,
1129
+ rules: Array[
1130
+ {
1131
+ excluded_users_and_groups: {
1132
+ user_groups: Array[::String]?,
1133
+ user_ids: Array[::String]?
1134
+ }?,
1135
+ included_users_and_groups: {
1136
+ user_groups: Array[::String]?,
1137
+ user_ids: Array[::String]?
1138
+ }?,
1139
+ rule_configuration: {
1140
+ content_blocker_rule: {
1141
+ system_message_override: ::String?
1142
+ }?,
1143
+ content_retrieval_rule: {
1144
+ eligible_data_sources: Array[
1145
+ {
1146
+ data_source_id: ::String?,
1147
+ index_id: ::String?
1148
+ },
1149
+ ]?
1150
+ }?
1151
+ }?,
1152
+ rule_type: ("CONTENT_BLOCKER_RULE" | "CONTENT_RETRIEVAL_RULE")
1153
+ },
1154
+ ]
1155
+ },
1156
+ ],
1157
+ ?topic_configurations_to_delete: Array[
1158
+ {
1159
+ description: ::String?,
1160
+ example_chat_messages: Array[::String]?,
1161
+ name: ::String,
1162
+ rules: Array[
1163
+ {
1164
+ excluded_users_and_groups: {
1165
+ user_groups: Array[::String]?,
1166
+ user_ids: Array[::String]?
1167
+ }?,
1168
+ included_users_and_groups: {
1169
+ user_groups: Array[::String]?,
1170
+ user_ids: Array[::String]?
1171
+ }?,
1172
+ rule_configuration: {
1173
+ content_blocker_rule: {
1174
+ system_message_override: ::String?
1175
+ }?,
1176
+ content_retrieval_rule: {
1177
+ eligible_data_sources: Array[
1178
+ {
1179
+ data_source_id: ::String?,
1180
+ index_id: ::String?
1181
+ },
1182
+ ]?
1183
+ }?
1184
+ }?,
1185
+ rule_type: ("CONTENT_BLOCKER_RULE" | "CONTENT_RETRIEVAL_RULE")
1186
+ },
1187
+ ]
1188
+ },
1189
+ ]
1190
+ ) -> _UpdateChatControlsConfigurationResponseSuccess
1191
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateChatControlsConfigurationResponseSuccess
1192
+
1193
+ interface _UpdateDataSourceResponseSuccess
1194
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateDataSourceResponse]
1195
+ end
1196
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_data_source-instance_method
1197
+ def update_data_source: (
1198
+ application_id: ::String,
1199
+ ?configuration: {
1200
+ },
1201
+ data_source_id: ::String,
1202
+ ?description: ::String,
1203
+ ?display_name: ::String,
1204
+ ?document_enrichment_configuration: {
1205
+ inline_configurations: Array[
1206
+ {
1207
+ condition: {
1208
+ key: ::String,
1209
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
1210
+ value: {
1211
+ date_value: ::Time?,
1212
+ long_value: ::Integer?,
1213
+ string_list_value: Array[::String]?,
1214
+ string_value: ::String?
1215
+ }?
1216
+ }?,
1217
+ document_content_operator: ("DELETE")?,
1218
+ target: {
1219
+ attribute_value_operator: ("DELETE")?,
1220
+ key: ::String,
1221
+ value: {
1222
+ date_value: ::Time?,
1223
+ long_value: ::Integer?,
1224
+ string_list_value: Array[::String]?,
1225
+ string_value: ::String?
1226
+ }?
1227
+ }?
1228
+ },
1229
+ ]?,
1230
+ post_extraction_hook_configuration: {
1231
+ invocation_condition: {
1232
+ key: ::String,
1233
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
1234
+ value: {
1235
+ date_value: ::Time?,
1236
+ long_value: ::Integer?,
1237
+ string_list_value: Array[::String]?,
1238
+ string_value: ::String?
1239
+ }?
1240
+ }?,
1241
+ lambda_arn: ::String?,
1242
+ role_arn: ::String?,
1243
+ s3_bucket_name: ::String?
1244
+ }?,
1245
+ pre_extraction_hook_configuration: {
1246
+ invocation_condition: {
1247
+ key: ::String,
1248
+ operator: ("GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"),
1249
+ value: {
1250
+ date_value: ::Time?,
1251
+ long_value: ::Integer?,
1252
+ string_list_value: Array[::String]?,
1253
+ string_value: ::String?
1254
+ }?
1255
+ }?,
1256
+ lambda_arn: ::String?,
1257
+ role_arn: ::String?,
1258
+ s3_bucket_name: ::String?
1259
+ }?
1260
+ },
1261
+ index_id: ::String,
1262
+ ?role_arn: ::String,
1263
+ ?sync_schedule: ::String,
1264
+ ?vpc_configuration: {
1265
+ security_group_ids: Array[::String],
1266
+ subnet_ids: Array[::String]
1267
+ }
1268
+ ) -> _UpdateDataSourceResponseSuccess
1269
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDataSourceResponseSuccess
1270
+
1271
+ interface _UpdateIndexResponseSuccess
1272
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateIndexResponse]
1273
+ end
1274
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_index-instance_method
1275
+ def update_index: (
1276
+ application_id: ::String,
1277
+ ?capacity_configuration: {
1278
+ units: ::Integer?
1279
+ },
1280
+ ?description: ::String,
1281
+ ?display_name: ::String,
1282
+ ?document_attribute_configurations: Array[
1283
+ {
1284
+ name: ::String?,
1285
+ search: ("ENABLED" | "DISABLED")?,
1286
+ type: ("STRING" | "STRING_LIST" | "NUMBER" | "DATE")?
1287
+ },
1288
+ ],
1289
+ index_id: ::String
1290
+ ) -> _UpdateIndexResponseSuccess
1291
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateIndexResponseSuccess
1292
+
1293
+ interface _UpdatePluginResponseSuccess
1294
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdatePluginResponse]
1295
+ end
1296
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_plugin-instance_method
1297
+ def update_plugin: (
1298
+ application_id: ::String,
1299
+ ?auth_configuration: {
1300
+ basic_auth_configuration: {
1301
+ role_arn: ::String,
1302
+ secret_arn: ::String
1303
+ }?,
1304
+ o_auth_2_client_credential_configuration: {
1305
+ role_arn: ::String,
1306
+ secret_arn: ::String
1307
+ }?
1308
+ },
1309
+ ?display_name: ::String,
1310
+ plugin_id: ::String,
1311
+ ?server_url: ::String,
1312
+ ?state: ("ENABLED" | "DISABLED")
1313
+ ) -> _UpdatePluginResponseSuccess
1314
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdatePluginResponseSuccess
1315
+
1316
+ interface _UpdateRetrieverResponseSuccess
1317
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateRetrieverResponse]
1318
+ end
1319
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_retriever-instance_method
1320
+ def update_retriever: (
1321
+ application_id: ::String,
1322
+ ?configuration: {
1323
+ kendra_index_configuration: {
1324
+ index_id: ::String
1325
+ }?,
1326
+ native_index_configuration: {
1327
+ boosting_override: Hash[::String, {
1328
+ date_configuration: {
1329
+ boosting_duration_in_seconds: ::Integer?,
1330
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")
1331
+ }?,
1332
+ number_configuration: {
1333
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH"),
1334
+ boosting_type: ("PRIORITIZE_LARGER_VALUES" | "PRIORITIZE_SMALLER_VALUES")?
1335
+ }?,
1336
+ string_configuration: {
1337
+ attribute_value_boosting: Hash[::String, ("LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")]?,
1338
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")
1339
+ }?,
1340
+ string_list_configuration: {
1341
+ boosting_level: ("NONE" | "LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH")
1342
+ }?
1343
+ }]?,
1344
+ index_id: ::String
1345
+ }?
1346
+ },
1347
+ ?display_name: ::String,
1348
+ retriever_id: ::String,
1349
+ ?role_arn: ::String
1350
+ ) -> _UpdateRetrieverResponseSuccess
1351
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRetrieverResponseSuccess
1352
+
1353
+ interface _UpdateUserResponseSuccess
1354
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserResponse]
1355
+ def user_aliases_added: () -> ::Array[Types::UserAlias]
1356
+ def user_aliases_deleted: () -> ::Array[Types::UserAlias]
1357
+ def user_aliases_updated: () -> ::Array[Types::UserAlias]
1358
+ end
1359
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_user-instance_method
1360
+ def update_user: (
1361
+ application_id: ::String,
1362
+ ?user_aliases_to_delete: Array[
1363
+ {
1364
+ data_source_id: ::String?,
1365
+ index_id: ::String?,
1366
+ user_id: ::String
1367
+ },
1368
+ ],
1369
+ ?user_aliases_to_update: Array[
1370
+ {
1371
+ data_source_id: ::String?,
1372
+ index_id: ::String?,
1373
+ user_id: ::String
1374
+ },
1375
+ ],
1376
+ user_id: ::String
1377
+ ) -> _UpdateUserResponseSuccess
1378
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserResponseSuccess
1379
+
1380
+ interface _UpdateWebExperienceResponseSuccess
1381
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateWebExperienceResponse]
1382
+ end
1383
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_web_experience-instance_method
1384
+ def update_web_experience: (
1385
+ application_id: ::String,
1386
+ ?authentication_configuration: {
1387
+ saml_configuration: {
1388
+ metadata_xml: ::String,
1389
+ role_arn: ::String,
1390
+ user_group_attribute: ::String?,
1391
+ user_id_attribute: ::String
1392
+ }?
1393
+ },
1394
+ ?sample_prompts_control_mode: ("ENABLED" | "DISABLED"),
1395
+ ?subtitle: ::String,
1396
+ ?title: ::String,
1397
+ web_experience_id: ::String,
1398
+ ?welcome_message: ::String
1399
+ ) -> _UpdateWebExperienceResponseSuccess
1400
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateWebExperienceResponseSuccess
1401
+ end
1402
+ end
1403
+ end
1404
+