aws-sdk-qapps 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-qapps/client.rb +2443 -0
- data/lib/aws-sdk-qapps/client_api.rb +991 -0
- data/lib/aws-sdk-qapps/customizations.rb +0 -0
- data/lib/aws-sdk-qapps/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-qapps/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-qapps/endpoints.rb +338 -0
- data/lib/aws-sdk-qapps/errors.rb +264 -0
- data/lib/aws-sdk-qapps/plugins/endpoints.rb +116 -0
- data/lib/aws-sdk-qapps/resource.rb +26 -0
- data/lib/aws-sdk-qapps/types.rb +2136 -0
- data/lib/aws-sdk-qapps/waiters.rb +15 -0
- data/lib/aws-sdk-qapps.rb +58 -0
- data/sig/client.rbs +625 -0
- data/sig/errors.rbs +57 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +622 -0
- data/sig/waiters.rbs +13 -0
- metadata +100 -0
data/sig/client.rbs
ADDED
@@ -0,0 +1,625 @@
|
|
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 QApps
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/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
|
+
?sigv4a_signing_region_set: Array[String],
|
52
|
+
?stub_responses: untyped,
|
53
|
+
?token_provider: untyped,
|
54
|
+
?use_dualstack_endpoint: bool,
|
55
|
+
?use_fips_endpoint: bool,
|
56
|
+
?validate_params: bool,
|
57
|
+
?endpoint_provider: untyped,
|
58
|
+
?http_proxy: String,
|
59
|
+
?http_open_timeout: (Float | Integer),
|
60
|
+
?http_read_timeout: (Float | Integer),
|
61
|
+
?http_idle_timeout: (Float | Integer),
|
62
|
+
?http_continue_timeout: (Float | Integer),
|
63
|
+
?ssl_timeout: (Float | Integer | nil),
|
64
|
+
?http_wire_trace: bool,
|
65
|
+
?ssl_verify_peer: bool,
|
66
|
+
?ssl_ca_bundle: String,
|
67
|
+
?ssl_ca_directory: String,
|
68
|
+
?ssl_ca_store: String,
|
69
|
+
?on_chunk_received: Proc,
|
70
|
+
?on_chunk_sent: Proc,
|
71
|
+
?raise_response_errors: bool
|
72
|
+
) -> instance
|
73
|
+
| (?Hash[Symbol, untyped]) -> instance
|
74
|
+
|
75
|
+
|
76
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#associate_library_item_review-instance_method
|
77
|
+
def associate_library_item_review: (
|
78
|
+
instance_id: ::String,
|
79
|
+
library_item_id: ::String
|
80
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
81
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
82
|
+
|
83
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#associate_q_app_with_user-instance_method
|
84
|
+
def associate_q_app_with_user: (
|
85
|
+
instance_id: ::String,
|
86
|
+
app_id: ::String
|
87
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
88
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
89
|
+
|
90
|
+
interface _CreateLibraryItemResponseSuccess
|
91
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateLibraryItemOutput]
|
92
|
+
def library_item_id: () -> ::String
|
93
|
+
def status: () -> ::String
|
94
|
+
def created_at: () -> ::Time
|
95
|
+
def created_by: () -> ::String
|
96
|
+
def updated_at: () -> ::Time
|
97
|
+
def updated_by: () -> ::String
|
98
|
+
def rating_count: () -> ::Integer
|
99
|
+
end
|
100
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#create_library_item-instance_method
|
101
|
+
def create_library_item: (
|
102
|
+
instance_id: ::String,
|
103
|
+
app_id: ::String,
|
104
|
+
app_version: ::Integer,
|
105
|
+
categories: Array[::String]
|
106
|
+
) -> _CreateLibraryItemResponseSuccess
|
107
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateLibraryItemResponseSuccess
|
108
|
+
|
109
|
+
interface _CreateQAppResponseSuccess
|
110
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateQAppOutput]
|
111
|
+
def app_id: () -> ::String
|
112
|
+
def app_arn: () -> ::String
|
113
|
+
def title: () -> ::String
|
114
|
+
def description: () -> ::String
|
115
|
+
def initial_prompt: () -> ::String
|
116
|
+
def app_version: () -> ::Integer
|
117
|
+
def status: () -> ("PUBLISHED" | "DRAFT" | "DELETED")
|
118
|
+
def created_at: () -> ::Time
|
119
|
+
def created_by: () -> ::String
|
120
|
+
def updated_at: () -> ::Time
|
121
|
+
def updated_by: () -> ::String
|
122
|
+
def required_capabilities: () -> ::Array[("FileUpload" | "CreatorMode" | "RetrievalMode" | "PluginMode")]
|
123
|
+
end
|
124
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#create_q_app-instance_method
|
125
|
+
def create_q_app: (
|
126
|
+
instance_id: ::String,
|
127
|
+
title: ::String,
|
128
|
+
?description: ::String,
|
129
|
+
app_definition: {
|
130
|
+
cards: Array[
|
131
|
+
{
|
132
|
+
text_input: {
|
133
|
+
title: ::String,
|
134
|
+
id: ::String,
|
135
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
136
|
+
placeholder: ::String?,
|
137
|
+
default_value: ::String?
|
138
|
+
}?,
|
139
|
+
q_query: {
|
140
|
+
title: ::String,
|
141
|
+
id: ::String,
|
142
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
143
|
+
prompt: ::String,
|
144
|
+
output_source: ("approved-sources" | "llm")?,
|
145
|
+
attribute_filter: {
|
146
|
+
and_all_filters: Array[
|
147
|
+
untyped,
|
148
|
+
]?,
|
149
|
+
or_all_filters: Array[
|
150
|
+
untyped,
|
151
|
+
]?,
|
152
|
+
not_filter: untyped?,
|
153
|
+
equals_to: {
|
154
|
+
name: ::String,
|
155
|
+
value: {
|
156
|
+
string_value: ::String?,
|
157
|
+
string_list_value: Array[::String]?,
|
158
|
+
long_value: ::Integer?,
|
159
|
+
date_value: ::Time?
|
160
|
+
}
|
161
|
+
}?,
|
162
|
+
contains_all: {
|
163
|
+
name: ::String,
|
164
|
+
value: {
|
165
|
+
string_value: ::String?,
|
166
|
+
string_list_value: Array[::String]?,
|
167
|
+
long_value: ::Integer?,
|
168
|
+
date_value: ::Time?
|
169
|
+
}
|
170
|
+
}?,
|
171
|
+
contains_any: {
|
172
|
+
name: ::String,
|
173
|
+
value: {
|
174
|
+
string_value: ::String?,
|
175
|
+
string_list_value: Array[::String]?,
|
176
|
+
long_value: ::Integer?,
|
177
|
+
date_value: ::Time?
|
178
|
+
}
|
179
|
+
}?,
|
180
|
+
greater_than: {
|
181
|
+
name: ::String,
|
182
|
+
value: {
|
183
|
+
string_value: ::String?,
|
184
|
+
string_list_value: Array[::String]?,
|
185
|
+
long_value: ::Integer?,
|
186
|
+
date_value: ::Time?
|
187
|
+
}
|
188
|
+
}?,
|
189
|
+
greater_than_or_equals: {
|
190
|
+
name: ::String,
|
191
|
+
value: {
|
192
|
+
string_value: ::String?,
|
193
|
+
string_list_value: Array[::String]?,
|
194
|
+
long_value: ::Integer?,
|
195
|
+
date_value: ::Time?
|
196
|
+
}
|
197
|
+
}?,
|
198
|
+
less_than: {
|
199
|
+
name: ::String,
|
200
|
+
value: {
|
201
|
+
string_value: ::String?,
|
202
|
+
string_list_value: Array[::String]?,
|
203
|
+
long_value: ::Integer?,
|
204
|
+
date_value: ::Time?
|
205
|
+
}
|
206
|
+
}?,
|
207
|
+
less_than_or_equals: {
|
208
|
+
name: ::String,
|
209
|
+
value: {
|
210
|
+
string_value: ::String?,
|
211
|
+
string_list_value: Array[::String]?,
|
212
|
+
long_value: ::Integer?,
|
213
|
+
date_value: ::Time?
|
214
|
+
}
|
215
|
+
}?
|
216
|
+
}?
|
217
|
+
}?,
|
218
|
+
q_plugin: {
|
219
|
+
title: ::String,
|
220
|
+
id: ::String,
|
221
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
222
|
+
prompt: ::String,
|
223
|
+
plugin_id: ::String
|
224
|
+
}?,
|
225
|
+
file_upload: {
|
226
|
+
title: ::String,
|
227
|
+
id: ::String,
|
228
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
229
|
+
filename: ::String?,
|
230
|
+
file_id: ::String?,
|
231
|
+
allow_override: bool?
|
232
|
+
}?
|
233
|
+
},
|
234
|
+
],
|
235
|
+
initial_prompt: ::String?
|
236
|
+
},
|
237
|
+
?tags: Hash[::String, ::String]
|
238
|
+
) -> _CreateQAppResponseSuccess
|
239
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateQAppResponseSuccess
|
240
|
+
|
241
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#delete_library_item-instance_method
|
242
|
+
def delete_library_item: (
|
243
|
+
instance_id: ::String,
|
244
|
+
library_item_id: ::String
|
245
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
246
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
247
|
+
|
248
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#delete_q_app-instance_method
|
249
|
+
def delete_q_app: (
|
250
|
+
instance_id: ::String,
|
251
|
+
app_id: ::String
|
252
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
253
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
254
|
+
|
255
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#disassociate_library_item_review-instance_method
|
256
|
+
def disassociate_library_item_review: (
|
257
|
+
instance_id: ::String,
|
258
|
+
library_item_id: ::String
|
259
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
260
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
261
|
+
|
262
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#disassociate_q_app_from_user-instance_method
|
263
|
+
def disassociate_q_app_from_user: (
|
264
|
+
instance_id: ::String,
|
265
|
+
app_id: ::String
|
266
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
267
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
268
|
+
|
269
|
+
interface _GetLibraryItemResponseSuccess
|
270
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetLibraryItemOutput]
|
271
|
+
def library_item_id: () -> ::String
|
272
|
+
def app_id: () -> ::String
|
273
|
+
def app_version: () -> ::Integer
|
274
|
+
def categories: () -> ::Array[Types::Category]
|
275
|
+
def status: () -> ::String
|
276
|
+
def created_at: () -> ::Time
|
277
|
+
def created_by: () -> ::String
|
278
|
+
def updated_at: () -> ::Time
|
279
|
+
def updated_by: () -> ::String
|
280
|
+
def rating_count: () -> ::Integer
|
281
|
+
def is_rated_by_user: () -> bool
|
282
|
+
def user_count: () -> ::Integer
|
283
|
+
end
|
284
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#get_library_item-instance_method
|
285
|
+
def get_library_item: (
|
286
|
+
instance_id: ::String,
|
287
|
+
library_item_id: ::String,
|
288
|
+
?app_id: ::String
|
289
|
+
) -> _GetLibraryItemResponseSuccess
|
290
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetLibraryItemResponseSuccess
|
291
|
+
|
292
|
+
interface _GetQAppResponseSuccess
|
293
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetQAppOutput]
|
294
|
+
def app_id: () -> ::String
|
295
|
+
def app_arn: () -> ::String
|
296
|
+
def title: () -> ::String
|
297
|
+
def description: () -> ::String
|
298
|
+
def initial_prompt: () -> ::String
|
299
|
+
def app_version: () -> ::Integer
|
300
|
+
def status: () -> ("PUBLISHED" | "DRAFT" | "DELETED")
|
301
|
+
def created_at: () -> ::Time
|
302
|
+
def created_by: () -> ::String
|
303
|
+
def updated_at: () -> ::Time
|
304
|
+
def updated_by: () -> ::String
|
305
|
+
def required_capabilities: () -> ::Array[("FileUpload" | "CreatorMode" | "RetrievalMode" | "PluginMode")]
|
306
|
+
def app_definition: () -> Types::AppDefinition
|
307
|
+
end
|
308
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#get_q_app-instance_method
|
309
|
+
def get_q_app: (
|
310
|
+
instance_id: ::String,
|
311
|
+
app_id: ::String
|
312
|
+
) -> _GetQAppResponseSuccess
|
313
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetQAppResponseSuccess
|
314
|
+
|
315
|
+
interface _GetQAppSessionResponseSuccess
|
316
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetQAppSessionOutput]
|
317
|
+
def session_id: () -> ::String
|
318
|
+
def session_arn: () -> ::String
|
319
|
+
def status: () -> ("IN_PROGRESS" | "WAITING" | "COMPLETED")
|
320
|
+
def card_status: () -> ::Hash[::String, Types::CardStatus]
|
321
|
+
end
|
322
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#get_q_app_session-instance_method
|
323
|
+
def get_q_app_session: (
|
324
|
+
instance_id: ::String,
|
325
|
+
session_id: ::String
|
326
|
+
) -> _GetQAppSessionResponseSuccess
|
327
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetQAppSessionResponseSuccess
|
328
|
+
|
329
|
+
interface _ImportDocumentResponseSuccess
|
330
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ImportDocumentOutput]
|
331
|
+
def file_id: () -> ::String
|
332
|
+
end
|
333
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#import_document-instance_method
|
334
|
+
def import_document: (
|
335
|
+
instance_id: ::String,
|
336
|
+
card_id: ::String,
|
337
|
+
app_id: ::String,
|
338
|
+
file_contents_base_64: ::String,
|
339
|
+
file_name: ::String,
|
340
|
+
scope: ("APPLICATION" | "SESSION"),
|
341
|
+
?session_id: ::String
|
342
|
+
) -> _ImportDocumentResponseSuccess
|
343
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportDocumentResponseSuccess
|
344
|
+
|
345
|
+
interface _ListLibraryItemsResponseSuccess
|
346
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListLibraryItemsOutput]
|
347
|
+
def library_items: () -> ::Array[Types::LibraryItemMember]
|
348
|
+
def next_token: () -> ::String
|
349
|
+
end
|
350
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#list_library_items-instance_method
|
351
|
+
def list_library_items: (
|
352
|
+
instance_id: ::String,
|
353
|
+
?limit: ::Integer,
|
354
|
+
?next_token: ::String,
|
355
|
+
?category_id: ::String
|
356
|
+
) -> _ListLibraryItemsResponseSuccess
|
357
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListLibraryItemsResponseSuccess
|
358
|
+
|
359
|
+
interface _ListQAppsResponseSuccess
|
360
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListQAppsOutput]
|
361
|
+
def apps: () -> ::Array[Types::UserAppItem]
|
362
|
+
def next_token: () -> ::String
|
363
|
+
end
|
364
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#list_q_apps-instance_method
|
365
|
+
def list_q_apps: (
|
366
|
+
instance_id: ::String,
|
367
|
+
?limit: ::Integer,
|
368
|
+
?next_token: ::String
|
369
|
+
) -> _ListQAppsResponseSuccess
|
370
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListQAppsResponseSuccess
|
371
|
+
|
372
|
+
interface _ListTagsForResourceResponseSuccess
|
373
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
374
|
+
def tags: () -> ::Hash[::String, ::String]
|
375
|
+
end
|
376
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#list_tags_for_resource-instance_method
|
377
|
+
def list_tags_for_resource: (
|
378
|
+
resource_arn: ::String
|
379
|
+
) -> _ListTagsForResourceResponseSuccess
|
380
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
381
|
+
|
382
|
+
interface _PredictQAppResponseSuccess
|
383
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PredictQAppOutput]
|
384
|
+
def app: () -> Types::PredictAppDefinition
|
385
|
+
def problem_statement: () -> ::String
|
386
|
+
end
|
387
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#predict_q_app-instance_method
|
388
|
+
def predict_q_app: (
|
389
|
+
instance_id: ::String,
|
390
|
+
?options: {
|
391
|
+
conversation: Array[
|
392
|
+
{
|
393
|
+
body: ::String,
|
394
|
+
type: ("USER" | "SYSTEM")
|
395
|
+
},
|
396
|
+
]?,
|
397
|
+
problem_statement: ::String?
|
398
|
+
}
|
399
|
+
) -> _PredictQAppResponseSuccess
|
400
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PredictQAppResponseSuccess
|
401
|
+
|
402
|
+
interface _StartQAppSessionResponseSuccess
|
403
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartQAppSessionOutput]
|
404
|
+
def session_id: () -> ::String
|
405
|
+
def session_arn: () -> ::String
|
406
|
+
end
|
407
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#start_q_app_session-instance_method
|
408
|
+
def start_q_app_session: (
|
409
|
+
instance_id: ::String,
|
410
|
+
app_id: ::String,
|
411
|
+
app_version: ::Integer,
|
412
|
+
?initial_values: Array[
|
413
|
+
{
|
414
|
+
card_id: ::String,
|
415
|
+
value: ::String
|
416
|
+
},
|
417
|
+
],
|
418
|
+
?tags: Hash[::String, ::String]
|
419
|
+
) -> _StartQAppSessionResponseSuccess
|
420
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartQAppSessionResponseSuccess
|
421
|
+
|
422
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#stop_q_app_session-instance_method
|
423
|
+
def stop_q_app_session: (
|
424
|
+
instance_id: ::String,
|
425
|
+
session_id: ::String
|
426
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
427
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
428
|
+
|
429
|
+
interface _TagResourceResponseSuccess
|
430
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
431
|
+
end
|
432
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#tag_resource-instance_method
|
433
|
+
def tag_resource: (
|
434
|
+
resource_arn: ::String,
|
435
|
+
tags: Hash[::String, ::String]
|
436
|
+
) -> _TagResourceResponseSuccess
|
437
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
438
|
+
|
439
|
+
interface _UntagResourceResponseSuccess
|
440
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
441
|
+
end
|
442
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#untag_resource-instance_method
|
443
|
+
def untag_resource: (
|
444
|
+
resource_arn: ::String,
|
445
|
+
tag_keys: Array[::String]
|
446
|
+
) -> _UntagResourceResponseSuccess
|
447
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
448
|
+
|
449
|
+
interface _UpdateLibraryItemResponseSuccess
|
450
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateLibraryItemOutput]
|
451
|
+
def library_item_id: () -> ::String
|
452
|
+
def app_id: () -> ::String
|
453
|
+
def app_version: () -> ::Integer
|
454
|
+
def categories: () -> ::Array[Types::Category]
|
455
|
+
def status: () -> ::String
|
456
|
+
def created_at: () -> ::Time
|
457
|
+
def created_by: () -> ::String
|
458
|
+
def updated_at: () -> ::Time
|
459
|
+
def updated_by: () -> ::String
|
460
|
+
def rating_count: () -> ::Integer
|
461
|
+
def is_rated_by_user: () -> bool
|
462
|
+
def user_count: () -> ::Integer
|
463
|
+
end
|
464
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#update_library_item-instance_method
|
465
|
+
def update_library_item: (
|
466
|
+
instance_id: ::String,
|
467
|
+
library_item_id: ::String,
|
468
|
+
?status: ("PUBLISHED" | "DISABLED"),
|
469
|
+
?categories: Array[::String]
|
470
|
+
) -> _UpdateLibraryItemResponseSuccess
|
471
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateLibraryItemResponseSuccess
|
472
|
+
|
473
|
+
interface _UpdateQAppResponseSuccess
|
474
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateQAppOutput]
|
475
|
+
def app_id: () -> ::String
|
476
|
+
def app_arn: () -> ::String
|
477
|
+
def title: () -> ::String
|
478
|
+
def description: () -> ::String
|
479
|
+
def initial_prompt: () -> ::String
|
480
|
+
def app_version: () -> ::Integer
|
481
|
+
def status: () -> ("PUBLISHED" | "DRAFT" | "DELETED")
|
482
|
+
def created_at: () -> ::Time
|
483
|
+
def created_by: () -> ::String
|
484
|
+
def updated_at: () -> ::Time
|
485
|
+
def updated_by: () -> ::String
|
486
|
+
def required_capabilities: () -> ::Array[("FileUpload" | "CreatorMode" | "RetrievalMode" | "PluginMode")]
|
487
|
+
end
|
488
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#update_q_app-instance_method
|
489
|
+
def update_q_app: (
|
490
|
+
instance_id: ::String,
|
491
|
+
app_id: ::String,
|
492
|
+
?title: ::String,
|
493
|
+
?description: ::String,
|
494
|
+
?app_definition: {
|
495
|
+
cards: Array[
|
496
|
+
{
|
497
|
+
text_input: {
|
498
|
+
title: ::String,
|
499
|
+
id: ::String,
|
500
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
501
|
+
placeholder: ::String?,
|
502
|
+
default_value: ::String?
|
503
|
+
}?,
|
504
|
+
q_query: {
|
505
|
+
title: ::String,
|
506
|
+
id: ::String,
|
507
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
508
|
+
prompt: ::String,
|
509
|
+
output_source: ("approved-sources" | "llm")?,
|
510
|
+
attribute_filter: {
|
511
|
+
and_all_filters: Array[
|
512
|
+
untyped,
|
513
|
+
]?,
|
514
|
+
or_all_filters: Array[
|
515
|
+
untyped,
|
516
|
+
]?,
|
517
|
+
not_filter: untyped?,
|
518
|
+
equals_to: {
|
519
|
+
name: ::String,
|
520
|
+
value: {
|
521
|
+
string_value: ::String?,
|
522
|
+
string_list_value: Array[::String]?,
|
523
|
+
long_value: ::Integer?,
|
524
|
+
date_value: ::Time?
|
525
|
+
}
|
526
|
+
}?,
|
527
|
+
contains_all: {
|
528
|
+
name: ::String,
|
529
|
+
value: {
|
530
|
+
string_value: ::String?,
|
531
|
+
string_list_value: Array[::String]?,
|
532
|
+
long_value: ::Integer?,
|
533
|
+
date_value: ::Time?
|
534
|
+
}
|
535
|
+
}?,
|
536
|
+
contains_any: {
|
537
|
+
name: ::String,
|
538
|
+
value: {
|
539
|
+
string_value: ::String?,
|
540
|
+
string_list_value: Array[::String]?,
|
541
|
+
long_value: ::Integer?,
|
542
|
+
date_value: ::Time?
|
543
|
+
}
|
544
|
+
}?,
|
545
|
+
greater_than: {
|
546
|
+
name: ::String,
|
547
|
+
value: {
|
548
|
+
string_value: ::String?,
|
549
|
+
string_list_value: Array[::String]?,
|
550
|
+
long_value: ::Integer?,
|
551
|
+
date_value: ::Time?
|
552
|
+
}
|
553
|
+
}?,
|
554
|
+
greater_than_or_equals: {
|
555
|
+
name: ::String,
|
556
|
+
value: {
|
557
|
+
string_value: ::String?,
|
558
|
+
string_list_value: Array[::String]?,
|
559
|
+
long_value: ::Integer?,
|
560
|
+
date_value: ::Time?
|
561
|
+
}
|
562
|
+
}?,
|
563
|
+
less_than: {
|
564
|
+
name: ::String,
|
565
|
+
value: {
|
566
|
+
string_value: ::String?,
|
567
|
+
string_list_value: Array[::String]?,
|
568
|
+
long_value: ::Integer?,
|
569
|
+
date_value: ::Time?
|
570
|
+
}
|
571
|
+
}?,
|
572
|
+
less_than_or_equals: {
|
573
|
+
name: ::String,
|
574
|
+
value: {
|
575
|
+
string_value: ::String?,
|
576
|
+
string_list_value: Array[::String]?,
|
577
|
+
long_value: ::Integer?,
|
578
|
+
date_value: ::Time?
|
579
|
+
}
|
580
|
+
}?
|
581
|
+
}?
|
582
|
+
}?,
|
583
|
+
q_plugin: {
|
584
|
+
title: ::String,
|
585
|
+
id: ::String,
|
586
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
587
|
+
prompt: ::String,
|
588
|
+
plugin_id: ::String
|
589
|
+
}?,
|
590
|
+
file_upload: {
|
591
|
+
title: ::String,
|
592
|
+
id: ::String,
|
593
|
+
type: ("text-input" | "q-query" | "file-upload" | "q-plugin"),
|
594
|
+
filename: ::String?,
|
595
|
+
file_id: ::String?,
|
596
|
+
allow_override: bool?
|
597
|
+
}?
|
598
|
+
},
|
599
|
+
],
|
600
|
+
initial_prompt: ::String?
|
601
|
+
}
|
602
|
+
) -> _UpdateQAppResponseSuccess
|
603
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateQAppResponseSuccess
|
604
|
+
|
605
|
+
interface _UpdateQAppSessionResponseSuccess
|
606
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateQAppSessionOutput]
|
607
|
+
def session_id: () -> ::String
|
608
|
+
def session_arn: () -> ::String
|
609
|
+
end
|
610
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#update_q_app_session-instance_method
|
611
|
+
def update_q_app_session: (
|
612
|
+
instance_id: ::String,
|
613
|
+
session_id: ::String,
|
614
|
+
?values: Array[
|
615
|
+
{
|
616
|
+
card_id: ::String,
|
617
|
+
value: ::String
|
618
|
+
},
|
619
|
+
]
|
620
|
+
) -> _UpdateQAppSessionResponseSuccess
|
621
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateQAppSessionResponseSuccess
|
622
|
+
end
|
623
|
+
end
|
624
|
+
end
|
625
|
+
|