@aws-sdk/client-qapps 3.612.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.
Files changed (187) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +397 -0
  3. package/dist-cjs/QApps.js +57 -0
  4. package/dist-cjs/QAppsClient.js +56 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/AssociateLibraryItemReviewCommand.js +28 -0
  8. package/dist-cjs/commands/AssociateQAppWithUserCommand.js +28 -0
  9. package/dist-cjs/commands/CreateLibraryItemCommand.js +28 -0
  10. package/dist-cjs/commands/CreateQAppCommand.js +28 -0
  11. package/dist-cjs/commands/DeleteLibraryItemCommand.js +28 -0
  12. package/dist-cjs/commands/DeleteQAppCommand.js +28 -0
  13. package/dist-cjs/commands/DisassociateLibraryItemReviewCommand.js +28 -0
  14. package/dist-cjs/commands/DisassociateQAppFromUserCommand.js +28 -0
  15. package/dist-cjs/commands/GetLibraryItemCommand.js +28 -0
  16. package/dist-cjs/commands/GetQAppCommand.js +28 -0
  17. package/dist-cjs/commands/GetQAppSessionCommand.js +28 -0
  18. package/dist-cjs/commands/ImportDocumentCommand.js +28 -0
  19. package/dist-cjs/commands/ListLibraryItemsCommand.js +28 -0
  20. package/dist-cjs/commands/ListQAppsCommand.js +28 -0
  21. package/dist-cjs/commands/ListTagsForResourceCommand.js +28 -0
  22. package/dist-cjs/commands/PredictQAppCommand.js +28 -0
  23. package/dist-cjs/commands/StartQAppSessionCommand.js +28 -0
  24. package/dist-cjs/commands/StopQAppSessionCommand.js +28 -0
  25. package/dist-cjs/commands/TagResourceCommand.js +28 -0
  26. package/dist-cjs/commands/UntagResourceCommand.js +28 -0
  27. package/dist-cjs/commands/UpdateLibraryItemCommand.js +28 -0
  28. package/dist-cjs/commands/UpdateQAppCommand.js +28 -0
  29. package/dist-cjs/commands/UpdateQAppSessionCommand.js +28 -0
  30. package/dist-cjs/commands/index.js +26 -0
  31. package/dist-cjs/endpoint/EndpointParameters.js +18 -0
  32. package/dist-cjs/endpoint/endpointResolver.js +14 -0
  33. package/dist-cjs/endpoint/ruleset.js +7 -0
  34. package/dist-cjs/extensionConfiguration.js +2 -0
  35. package/dist-cjs/index.js +11 -0
  36. package/dist-cjs/models/QAppsServiceException.js +12 -0
  37. package/dist-cjs/models/index.js +4 -0
  38. package/dist-cjs/models/models_0.js +236 -0
  39. package/dist-cjs/pagination/Interfaces.js +2 -0
  40. package/dist-cjs/pagination/ListLibraryItemsPaginator.js +7 -0
  41. package/dist-cjs/pagination/ListQAppsPaginator.js +7 -0
  42. package/dist-cjs/pagination/index.js +6 -0
  43. package/dist-cjs/protocols/Aws_restJson1.js +1207 -0
  44. package/dist-cjs/runtimeConfig.browser.js +39 -0
  45. package/dist-cjs/runtimeConfig.js +49 -0
  46. package/dist-cjs/runtimeConfig.native.js +15 -0
  47. package/dist-cjs/runtimeConfig.shared.js +34 -0
  48. package/dist-cjs/runtimeExtensions.js +25 -0
  49. package/dist-es/QApps.js +53 -0
  50. package/dist-es/QAppsClient.js +52 -0
  51. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  52. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  53. package/dist-es/commands/AssociateLibraryItemReviewCommand.js +24 -0
  54. package/dist-es/commands/AssociateQAppWithUserCommand.js +24 -0
  55. package/dist-es/commands/CreateLibraryItemCommand.js +24 -0
  56. package/dist-es/commands/CreateQAppCommand.js +24 -0
  57. package/dist-es/commands/DeleteLibraryItemCommand.js +24 -0
  58. package/dist-es/commands/DeleteQAppCommand.js +24 -0
  59. package/dist-es/commands/DisassociateLibraryItemReviewCommand.js +24 -0
  60. package/dist-es/commands/DisassociateQAppFromUserCommand.js +24 -0
  61. package/dist-es/commands/GetLibraryItemCommand.js +24 -0
  62. package/dist-es/commands/GetQAppCommand.js +24 -0
  63. package/dist-es/commands/GetQAppSessionCommand.js +24 -0
  64. package/dist-es/commands/ImportDocumentCommand.js +24 -0
  65. package/dist-es/commands/ListLibraryItemsCommand.js +24 -0
  66. package/dist-es/commands/ListQAppsCommand.js +24 -0
  67. package/dist-es/commands/ListTagsForResourceCommand.js +24 -0
  68. package/dist-es/commands/PredictQAppCommand.js +24 -0
  69. package/dist-es/commands/StartQAppSessionCommand.js +24 -0
  70. package/dist-es/commands/StopQAppSessionCommand.js +24 -0
  71. package/dist-es/commands/TagResourceCommand.js +24 -0
  72. package/dist-es/commands/UntagResourceCommand.js +24 -0
  73. package/dist-es/commands/UpdateLibraryItemCommand.js +24 -0
  74. package/dist-es/commands/UpdateQAppCommand.js +24 -0
  75. package/dist-es/commands/UpdateQAppSessionCommand.js +24 -0
  76. package/dist-es/commands/index.js +23 -0
  77. package/dist-es/endpoint/EndpointParameters.js +14 -0
  78. package/dist-es/endpoint/endpointResolver.js +10 -0
  79. package/dist-es/endpoint/ruleset.js +4 -0
  80. package/dist-es/extensionConfiguration.js +1 -0
  81. package/dist-es/index.js +6 -0
  82. package/dist-es/models/QAppsServiceException.js +8 -0
  83. package/dist-es/models/index.js +1 -0
  84. package/dist-es/models/models_0.js +224 -0
  85. package/dist-es/pagination/Interfaces.js +1 -0
  86. package/dist-es/pagination/ListLibraryItemsPaginator.js +4 -0
  87. package/dist-es/pagination/ListQAppsPaginator.js +4 -0
  88. package/dist-es/pagination/index.js +3 -0
  89. package/dist-es/protocols/Aws_restJson1.js +1158 -0
  90. package/dist-es/runtimeConfig.browser.js +34 -0
  91. package/dist-es/runtimeConfig.js +44 -0
  92. package/dist-es/runtimeConfig.native.js +11 -0
  93. package/dist-es/runtimeConfig.shared.js +30 -0
  94. package/dist-es/runtimeExtensions.js +21 -0
  95. package/dist-types/QApps.d.ts +179 -0
  96. package/dist-types/QAppsClient.d.ts +202 -0
  97. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  98. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  99. package/dist-types/commands/AssociateLibraryItemReviewCommand.d.ts +83 -0
  100. package/dist-types/commands/AssociateQAppWithUserCommand.d.ts +85 -0
  101. package/dist-types/commands/CreateLibraryItemCommand.d.ts +95 -0
  102. package/dist-types/commands/CreateQAppCommand.d.ts +225 -0
  103. package/dist-types/commands/DeleteLibraryItemCommand.d.ts +83 -0
  104. package/dist-types/commands/DeleteQAppCommand.d.ts +78 -0
  105. package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts +82 -0
  106. package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts +79 -0
  107. package/dist-types/commands/GetLibraryItemCommand.d.ts +98 -0
  108. package/dist-types/commands/GetQAppCommand.d.ts +224 -0
  109. package/dist-types/commands/GetQAppSessionCommand.d.ts +92 -0
  110. package/dist-types/commands/ImportDocumentCommand.d.ts +97 -0
  111. package/dist-types/commands/ListLibraryItemsCommand.d.ts +103 -0
  112. package/dist-types/commands/ListQAppsCommand.d.ts +91 -0
  113. package/dist-types/commands/ListTagsForResourceCommand.d.ts +78 -0
  114. package/dist-types/commands/PredictQAppCommand.d.ts +209 -0
  115. package/dist-types/commands/StartQAppSessionCommand.d.ts +100 -0
  116. package/dist-types/commands/StopQAppSessionCommand.d.ts +84 -0
  117. package/dist-types/commands/TagResourceCommand.d.ts +81 -0
  118. package/dist-types/commands/UntagResourceCommand.d.ts +77 -0
  119. package/dist-types/commands/UpdateLibraryItemCommand.d.ts +100 -0
  120. package/dist-types/commands/UpdateQAppCommand.d.ts +216 -0
  121. package/dist-types/commands/UpdateQAppSessionCommand.d.ts +95 -0
  122. package/dist-types/commands/index.d.ts +23 -0
  123. package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
  124. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  125. package/dist-types/endpoint/ruleset.d.ts +2 -0
  126. package/dist-types/extensionConfiguration.d.ts +9 -0
  127. package/dist-types/index.d.ts +22 -0
  128. package/dist-types/models/QAppsServiceException.d.ts +14 -0
  129. package/dist-types/models/index.d.ts +1 -0
  130. package/dist-types/models/models_0.d.ts +2138 -0
  131. package/dist-types/pagination/Interfaces.d.ts +8 -0
  132. package/dist-types/pagination/ListLibraryItemsPaginator.d.ts +7 -0
  133. package/dist-types/pagination/ListQAppsPaginator.d.ts +7 -0
  134. package/dist-types/pagination/index.d.ts +3 -0
  135. package/dist-types/protocols/Aws_restJson1.d.ts +209 -0
  136. package/dist-types/runtimeConfig.browser.d.ts +45 -0
  137. package/dist-types/runtimeConfig.d.ts +45 -0
  138. package/dist-types/runtimeConfig.native.d.ts +44 -0
  139. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  140. package/dist-types/runtimeExtensions.d.ts +17 -0
  141. package/dist-types/ts3.4/QApps.d.ts +396 -0
  142. package/dist-types/ts3.4/QAppsClient.d.ts +258 -0
  143. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  144. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  145. package/dist-types/ts3.4/commands/AssociateLibraryItemReviewCommand.d.ts +36 -0
  146. package/dist-types/ts3.4/commands/AssociateQAppWithUserCommand.d.ts +35 -0
  147. package/dist-types/ts3.4/commands/CreateLibraryItemCommand.d.ts +39 -0
  148. package/dist-types/ts3.4/commands/CreateQAppCommand.d.ts +36 -0
  149. package/dist-types/ts3.4/commands/DeleteLibraryItemCommand.d.ts +34 -0
  150. package/dist-types/ts3.4/commands/DeleteQAppCommand.d.ts +34 -0
  151. package/dist-types/ts3.4/commands/DisassociateLibraryItemReviewCommand.d.ts +36 -0
  152. package/dist-types/ts3.4/commands/DisassociateQAppFromUserCommand.d.ts +36 -0
  153. package/dist-types/ts3.4/commands/GetLibraryItemCommand.d.ts +36 -0
  154. package/dist-types/ts3.4/commands/GetQAppCommand.d.ts +30 -0
  155. package/dist-types/ts3.4/commands/GetQAppSessionCommand.d.ts +36 -0
  156. package/dist-types/ts3.4/commands/ImportDocumentCommand.d.ts +36 -0
  157. package/dist-types/ts3.4/commands/ListLibraryItemsCommand.d.ts +39 -0
  158. package/dist-types/ts3.4/commands/ListQAppsCommand.d.ts +36 -0
  159. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +40 -0
  160. package/dist-types/ts3.4/commands/PredictQAppCommand.d.ts +36 -0
  161. package/dist-types/ts3.4/commands/StartQAppSessionCommand.d.ts +39 -0
  162. package/dist-types/ts3.4/commands/StopQAppSessionCommand.d.ts +34 -0
  163. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +36 -0
  164. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +39 -0
  165. package/dist-types/ts3.4/commands/UpdateLibraryItemCommand.d.ts +39 -0
  166. package/dist-types/ts3.4/commands/UpdateQAppCommand.d.ts +36 -0
  167. package/dist-types/ts3.4/commands/UpdateQAppSessionCommand.d.ts +39 -0
  168. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  169. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  170. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  171. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  172. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  173. package/dist-types/ts3.4/index.d.ts +9 -0
  174. package/dist-types/ts3.4/models/QAppsServiceException.d.ts +9 -0
  175. package/dist-types/ts3.4/models/index.d.ts +1 -0
  176. package/dist-types/ts3.4/models/models_0.d.ts +681 -0
  177. package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
  178. package/dist-types/ts3.4/pagination/ListLibraryItemsPaginator.d.ts +11 -0
  179. package/dist-types/ts3.4/pagination/ListQAppsPaginator.d.ts +11 -0
  180. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  181. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +281 -0
  182. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +85 -0
  183. package/dist-types/ts3.4/runtimeConfig.d.ts +89 -0
  184. package/dist-types/ts3.4/runtimeConfig.native.d.ts +79 -0
  185. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
  186. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  187. package/package.json +101 -0
@@ -0,0 +1,2138 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { QAppsServiceException as __BaseException } from "./QAppsServiceException";
3
+ /**
4
+ * <p>The client is not authorized to perform the requested operation.</p>
5
+ * @public
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
+ }
15
+ /**
16
+ * @public
17
+ * @enum
18
+ */
19
+ export declare const CardType: {
20
+ readonly FILE_UPLOAD: "file-upload";
21
+ readonly Q_PLUGIN: "q-plugin";
22
+ readonly Q_QUERY: "q-query";
23
+ readonly TEXT_INPUT: "text-input";
24
+ };
25
+ /**
26
+ * @public
27
+ */
28
+ export type CardType = (typeof CardType)[keyof typeof CardType];
29
+ /**
30
+ * <p>A card in an Amazon Q App that allows the user to upload a file.</p>
31
+ * @public
32
+ */
33
+ export interface FileUploadCard {
34
+ /**
35
+ * <p>The unique identifier of the file upload card.</p>
36
+ * @public
37
+ */
38
+ id: string | undefined;
39
+ /**
40
+ * <p>The title of the file upload card.</p>
41
+ * @public
42
+ */
43
+ title: string | undefined;
44
+ /**
45
+ * <p>Any dependencies or requirements for the file upload card.</p>
46
+ * @public
47
+ */
48
+ dependencies: string[] | undefined;
49
+ /**
50
+ * <p>The type of the card.</p>
51
+ * @public
52
+ */
53
+ type: CardType | undefined;
54
+ /**
55
+ * <p>The name of the file being uploaded.</p>
56
+ * @public
57
+ */
58
+ filename?: string;
59
+ /**
60
+ * <p>The unique identifier of the file associated with the card.</p>
61
+ * @public
62
+ */
63
+ fileId?: string;
64
+ /**
65
+ * <p>A flag indicating if the user can override the default file for the upload card.</p>
66
+ * @public
67
+ */
68
+ allowOverride?: boolean;
69
+ }
70
+ /**
71
+ * @public
72
+ * @enum
73
+ */
74
+ export declare const PluginType: {
75
+ readonly CUSTOM: "CUSTOM";
76
+ readonly JIRA: "JIRA";
77
+ readonly SALESFORCE: "SALESFORCE";
78
+ readonly SERVICE_NOW: "SERVICE_NOW";
79
+ readonly ZENDESK: "ZENDESK";
80
+ };
81
+ /**
82
+ * @public
83
+ */
84
+ export type PluginType = (typeof PluginType)[keyof typeof PluginType];
85
+ /**
86
+ * <p>A card in an Q App that integrates with a third-party plugin or service.</p>
87
+ * @public
88
+ */
89
+ export interface QPluginCard {
90
+ /**
91
+ * <p>The unique identifier of the plugin card.</p>
92
+ * @public
93
+ */
94
+ id: string | undefined;
95
+ /**
96
+ * <p>The title or label of the plugin card.</p>
97
+ * @public
98
+ */
99
+ title: string | undefined;
100
+ /**
101
+ * <p>Any dependencies or requirements for the plugin card.</p>
102
+ * @public
103
+ */
104
+ dependencies: string[] | undefined;
105
+ /**
106
+ * <p>The type of the card.</p>
107
+ * @public
108
+ */
109
+ type: CardType | undefined;
110
+ /**
111
+ * <p>The prompt or instructions displayed for the plugin card.</p>
112
+ * @public
113
+ */
114
+ prompt: string | undefined;
115
+ /**
116
+ * <p>The type or category of the plugin used by the card.</p>
117
+ * @public
118
+ */
119
+ pluginType: PluginType | undefined;
120
+ /**
121
+ * <p>The unique identifier of the plugin used by the card.</p>
122
+ * @public
123
+ */
124
+ pluginId: string | undefined;
125
+ }
126
+ /**
127
+ * <p>The value of a document attribute. You can only provide one value for a document
128
+ * attribute.</p>
129
+ * @public
130
+ */
131
+ export type DocumentAttributeValue = DocumentAttributeValue.DateValueMember | DocumentAttributeValue.LongValueMember | DocumentAttributeValue.StringListValueMember | DocumentAttributeValue.StringValueMember | DocumentAttributeValue.$UnknownMember;
132
+ /**
133
+ * @public
134
+ */
135
+ export declare namespace DocumentAttributeValue {
136
+ /**
137
+ * <p>A string.</p>
138
+ * @public
139
+ */
140
+ interface StringValueMember {
141
+ stringValue: string;
142
+ stringListValue?: never;
143
+ longValue?: never;
144
+ dateValue?: never;
145
+ $unknown?: never;
146
+ }
147
+ /**
148
+ * <p>A list of strings.</p>
149
+ * @public
150
+ */
151
+ interface StringListValueMember {
152
+ stringValue?: never;
153
+ stringListValue: string[];
154
+ longValue?: never;
155
+ dateValue?: never;
156
+ $unknown?: never;
157
+ }
158
+ /**
159
+ * <p>A long integer value. </p>
160
+ * @public
161
+ */
162
+ interface LongValueMember {
163
+ stringValue?: never;
164
+ stringListValue?: never;
165
+ longValue: number;
166
+ dateValue?: never;
167
+ $unknown?: never;
168
+ }
169
+ /**
170
+ * <p>A date expressed as an ISO 8601 string.</p>
171
+ * <p>It's important for the time zone to be included in the <i>ISO 8601 date-time</i> format. For
172
+ * example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012
173
+ * at 12:30PM (plus 10 seconds) in Central European Time. </p>
174
+ * @public
175
+ */
176
+ interface DateValueMember {
177
+ stringValue?: never;
178
+ stringListValue?: never;
179
+ longValue?: never;
180
+ dateValue: Date;
181
+ $unknown?: never;
182
+ }
183
+ /**
184
+ * @public
185
+ */
186
+ interface $UnknownMember {
187
+ stringValue?: never;
188
+ stringListValue?: never;
189
+ longValue?: never;
190
+ dateValue?: never;
191
+ $unknown: [string, any];
192
+ }
193
+ interface Visitor<T> {
194
+ stringValue: (value: string) => T;
195
+ stringListValue: (value: string[]) => T;
196
+ longValue: (value: number) => T;
197
+ dateValue: (value: Date) => T;
198
+ _: (name: string, value: any) => T;
199
+ }
200
+ const visit: <T>(value: DocumentAttributeValue, visitor: Visitor<T>) => T;
201
+ }
202
+ /**
203
+ * <p>A document attribute or metadata field.</p>
204
+ * @public
205
+ */
206
+ export interface DocumentAttribute {
207
+ /**
208
+ * <p>The identifier for the attribute.</p>
209
+ * @public
210
+ */
211
+ name: string | undefined;
212
+ /**
213
+ * <p>The value of the attribute. </p>
214
+ * @public
215
+ */
216
+ value: DocumentAttributeValue | undefined;
217
+ }
218
+ /**
219
+ * @public
220
+ * @enum
221
+ */
222
+ export declare const CardOutputSource: {
223
+ readonly APPROVED_SOURCES: "approved-sources";
224
+ readonly LLM: "llm";
225
+ };
226
+ /**
227
+ * @public
228
+ */
229
+ export type CardOutputSource = (typeof CardOutputSource)[keyof typeof CardOutputSource];
230
+ /**
231
+ * <p>A card in an Amazon Q App that allows the user to input text.</p>
232
+ * @public
233
+ */
234
+ export interface TextInputCard {
235
+ /**
236
+ * <p>The unique identifier of the text input card.</p>
237
+ * @public
238
+ */
239
+ id: string | undefined;
240
+ /**
241
+ * <p>The title or label of the text input card.</p>
242
+ * @public
243
+ */
244
+ title: string | undefined;
245
+ /**
246
+ * <p>Any dependencies or requirements for the text input card.</p>
247
+ * @public
248
+ */
249
+ dependencies: string[] | undefined;
250
+ /**
251
+ * <p>The type of the card.</p>
252
+ * @public
253
+ */
254
+ type: CardType | undefined;
255
+ /**
256
+ * <p>The placeholder text to display in the text input field.</p>
257
+ * @public
258
+ */
259
+ placeholder?: string;
260
+ /**
261
+ * <p>The default value to pre-populate in the text input field.</p>
262
+ * @public
263
+ */
264
+ defaultValue?: string;
265
+ }
266
+ /**
267
+ * <p>Represents a file upload card. It can optionally
268
+ * receive a <code>filename</code> and <code>fileId</code> to set a
269
+ * default file. If not received, the user must provide the file
270
+ * when the Q App runs.</p>
271
+ * @public
272
+ */
273
+ export interface FileUploadCardInput {
274
+ /**
275
+ * <p>The title or label of the file upload card.</p>
276
+ * @public
277
+ */
278
+ title: string | undefined;
279
+ /**
280
+ * <p>The unique identifier of the file upload card.</p>
281
+ * @public
282
+ */
283
+ id: string | undefined;
284
+ /**
285
+ * <p>The type of the card.</p>
286
+ * @public
287
+ */
288
+ type: CardType | undefined;
289
+ /**
290
+ * <p>The default filename to use for the file upload card.</p>
291
+ * @public
292
+ */
293
+ filename?: string;
294
+ /**
295
+ * <p>The identifier of a pre-uploaded file associated with the card.</p>
296
+ * @public
297
+ */
298
+ fileId?: string;
299
+ /**
300
+ * <p>A flag indicating if the user can override the default file for the upload card.</p>
301
+ * @public
302
+ */
303
+ allowOverride?: boolean;
304
+ }
305
+ /**
306
+ * <p>The input shape for defining a plugin card in an Amazon Q App.</p>
307
+ * @public
308
+ */
309
+ export interface QPluginCardInput {
310
+ /**
311
+ * <p>The title or label of the plugin card.</p>
312
+ * @public
313
+ */
314
+ title: string | undefined;
315
+ /**
316
+ * <p>The unique identifier of the plugin card.</p>
317
+ * @public
318
+ */
319
+ id: string | undefined;
320
+ /**
321
+ * <p>The type of the card.</p>
322
+ * @public
323
+ */
324
+ type: CardType | undefined;
325
+ /**
326
+ * <p>The prompt or instructions displayed for the plugin card.</p>
327
+ * @public
328
+ */
329
+ prompt: string | undefined;
330
+ /**
331
+ * <p>The unique identifier of the plugin used by the card.</p>
332
+ * @public
333
+ */
334
+ pluginId: string | undefined;
335
+ }
336
+ /**
337
+ * <p>The input shape for defining a text input card in an Amazon Q App.</p>
338
+ * @public
339
+ */
340
+ export interface TextInputCardInput {
341
+ /**
342
+ * <p>The title or label of the text input card.</p>
343
+ * @public
344
+ */
345
+ title: string | undefined;
346
+ /**
347
+ * <p>The unique identifier of the text input card.</p>
348
+ * @public
349
+ */
350
+ id: string | undefined;
351
+ /**
352
+ * <p>The type of the card.</p>
353
+ * @public
354
+ */
355
+ type: CardType | undefined;
356
+ /**
357
+ * <p>The placeholder text to display in the text input field.</p>
358
+ * @public
359
+ */
360
+ placeholder?: string;
361
+ /**
362
+ * <p>The default value to pre-populate in the text input field.</p>
363
+ * @public
364
+ */
365
+ defaultValue?: string;
366
+ }
367
+ /**
368
+ * @public
369
+ * @enum
370
+ */
371
+ export declare const AppRequiredCapability: {
372
+ readonly CREATOR_MODE: "CreatorMode";
373
+ readonly FILE_UPLOAD: "FileUpload";
374
+ readonly PLUGIN_MODE: "PluginMode";
375
+ readonly RETRIEVAL_MODE: "RetrievalMode";
376
+ };
377
+ /**
378
+ * @public
379
+ */
380
+ export type AppRequiredCapability = (typeof AppRequiredCapability)[keyof typeof AppRequiredCapability];
381
+ /**
382
+ * @public
383
+ * @enum
384
+ */
385
+ export declare const AppStatus: {
386
+ readonly DELETED: "DELETED";
387
+ readonly DRAFT: "DRAFT";
388
+ readonly PUBLISHED: "PUBLISHED";
389
+ };
390
+ /**
391
+ * @public
392
+ */
393
+ export type AppStatus = (typeof AppStatus)[keyof typeof AppStatus];
394
+ /**
395
+ * @public
396
+ */
397
+ export interface AssociateLibraryItemReviewInput {
398
+ /**
399
+ * <p>The unique identifier for the Amazon Q Business application environment instance.</p>
400
+ * @public
401
+ */
402
+ instanceId: string | undefined;
403
+ /**
404
+ * <p>The unique identifier of the library item to associate the review with.</p>
405
+ * @public
406
+ */
407
+ libraryItemId: string | undefined;
408
+ }
409
+ /**
410
+ * <p>An internal service error occurred while processing the request.</p>
411
+ * @public
412
+ */
413
+ export declare class InternalServerException extends __BaseException {
414
+ readonly name: "InternalServerException";
415
+ readonly $fault: "server";
416
+ $retryable: {};
417
+ /**
418
+ * <p>The number of seconds to wait before retrying the operation</p>
419
+ * @public
420
+ */
421
+ retryAfterSeconds?: number;
422
+ /**
423
+ * @internal
424
+ */
425
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
426
+ }
427
+ /**
428
+ * <p>The requested resource could not be found.</p>
429
+ * @public
430
+ */
431
+ export declare class ResourceNotFoundException extends __BaseException {
432
+ readonly name: "ResourceNotFoundException";
433
+ readonly $fault: "client";
434
+ /**
435
+ * <p>The unique identifier of the resource</p>
436
+ * @public
437
+ */
438
+ resourceId: string | undefined;
439
+ /**
440
+ * <p>The type of the resource</p>
441
+ * @public
442
+ */
443
+ resourceType: string | undefined;
444
+ /**
445
+ * @internal
446
+ */
447
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
448
+ }
449
+ /**
450
+ * <p>The requested operation could not be completed because
451
+ * it would exceed the service's quota or limit.</p>
452
+ * @public
453
+ */
454
+ export declare class ServiceQuotaExceededException extends __BaseException {
455
+ readonly name: "ServiceQuotaExceededException";
456
+ readonly $fault: "client";
457
+ /**
458
+ * <p>The unique identifier of the resource</p>
459
+ * @public
460
+ */
461
+ resourceId: string | undefined;
462
+ /**
463
+ * <p>The type of the resource</p>
464
+ * @public
465
+ */
466
+ resourceType: string | undefined;
467
+ /**
468
+ * <p>The code for the service where the quota was exceeded</p>
469
+ * @public
470
+ */
471
+ serviceCode: string | undefined;
472
+ /**
473
+ * <p>The code of the quota that was exceeded</p>
474
+ * @public
475
+ */
476
+ quotaCode: string | undefined;
477
+ /**
478
+ * @internal
479
+ */
480
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
481
+ }
482
+ /**
483
+ * <p>The requested operation could not be completed because too many
484
+ * requests were sent at once. Wait a bit and try again later.</p>
485
+ * @public
486
+ */
487
+ export declare class ThrottlingException extends __BaseException {
488
+ readonly name: "ThrottlingException";
489
+ readonly $fault: "client";
490
+ $retryable: {
491
+ throttling: boolean;
492
+ };
493
+ /**
494
+ * <p>The code for the service where the quota was exceeded</p>
495
+ * @public
496
+ */
497
+ serviceCode: string | undefined;
498
+ /**
499
+ * <p>The code of the quota that was exceeded</p>
500
+ * @public
501
+ */
502
+ quotaCode: string | undefined;
503
+ /**
504
+ * <p>The number of seconds to wait before retrying the operation</p>
505
+ * @public
506
+ */
507
+ retryAfterSeconds?: number;
508
+ /**
509
+ * @internal
510
+ */
511
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
512
+ }
513
+ /**
514
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
515
+ * @public
516
+ */
517
+ export declare class UnauthorizedException extends __BaseException {
518
+ readonly name: "UnauthorizedException";
519
+ readonly $fault: "client";
520
+ /**
521
+ * @internal
522
+ */
523
+ constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
524
+ }
525
+ /**
526
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
527
+ * @public
528
+ */
529
+ export declare class ValidationException extends __BaseException {
530
+ readonly name: "ValidationException";
531
+ readonly $fault: "client";
532
+ /**
533
+ * @internal
534
+ */
535
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
536
+ }
537
+ /**
538
+ * @public
539
+ */
540
+ export interface AssociateQAppWithUserInput {
541
+ /**
542
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
543
+ * @public
544
+ */
545
+ instanceId: string | undefined;
546
+ /**
547
+ * <p>The ID of the Amazon Q App to associate with the user.</p>
548
+ * @public
549
+ */
550
+ appId: string | undefined;
551
+ }
552
+ /**
553
+ * @public
554
+ * @enum
555
+ */
556
+ export declare const ExecutionStatus: {
557
+ readonly COMPLETED: "COMPLETED";
558
+ readonly IN_PROGRESS: "IN_PROGRESS";
559
+ readonly WAITING: "WAITING";
560
+ };
561
+ /**
562
+ * @public
563
+ */
564
+ export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus];
565
+ /**
566
+ * <p>The current status and value of a card in an active Amazon Q App session.</p>
567
+ * @public
568
+ */
569
+ export interface CardStatus {
570
+ /**
571
+ * <p>The current state of the card.</p>
572
+ * @public
573
+ */
574
+ currentState: ExecutionStatus | undefined;
575
+ /**
576
+ * <p>The current value or result associated with the card.</p>
577
+ * @public
578
+ */
579
+ currentValue: string | undefined;
580
+ }
581
+ /**
582
+ * <p>The value or result associated with a card in a Amazon Q App session.</p>
583
+ * @public
584
+ */
585
+ export interface CardValue {
586
+ /**
587
+ * <p>The unique identifier of the card.</p>
588
+ * @public
589
+ */
590
+ cardId: string | undefined;
591
+ /**
592
+ * <p>The value or result associated with the card.</p>
593
+ * @public
594
+ */
595
+ value: string | undefined;
596
+ }
597
+ /**
598
+ * <p>A category used to classify and filter library items for Amazon Q Apps.</p>
599
+ * @public
600
+ */
601
+ export interface Category {
602
+ /**
603
+ * <p>The unique identifier of the category.</p>
604
+ * @public
605
+ */
606
+ id: string | undefined;
607
+ /**
608
+ * <p>The title or name of the category.</p>
609
+ * @public
610
+ */
611
+ title: string | undefined;
612
+ }
613
+ /**
614
+ * <p>The requested operation could not be completed due to a
615
+ * conflict with the current state of the resource.</p>
616
+ * @public
617
+ */
618
+ export declare class ConflictException extends __BaseException {
619
+ readonly name: "ConflictException";
620
+ readonly $fault: "client";
621
+ /**
622
+ * <p>The unique identifier of the resource</p>
623
+ * @public
624
+ */
625
+ resourceId: string | undefined;
626
+ /**
627
+ * <p>The type of the resource</p>
628
+ * @public
629
+ */
630
+ resourceType: string | undefined;
631
+ /**
632
+ * @internal
633
+ */
634
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
635
+ }
636
+ /**
637
+ * <p>The requested operation could not be completed because
638
+ * the content exceeds the maximum allowed size.</p>
639
+ * @public
640
+ */
641
+ export declare class ContentTooLargeException extends __BaseException {
642
+ readonly name: "ContentTooLargeException";
643
+ readonly $fault: "client";
644
+ /**
645
+ * <p>The unique identifier of the resource</p>
646
+ * @public
647
+ */
648
+ resourceId: string | undefined;
649
+ /**
650
+ * <p>The type of the resource</p>
651
+ * @public
652
+ */
653
+ resourceType: string | undefined;
654
+ /**
655
+ * @internal
656
+ */
657
+ constructor(opts: __ExceptionOptionType<ContentTooLargeException, __BaseException>);
658
+ }
659
+ /**
660
+ * @public
661
+ * @enum
662
+ */
663
+ export declare const Sender: {
664
+ readonly SYSTEM: "SYSTEM";
665
+ readonly USER: "USER";
666
+ };
667
+ /**
668
+ * @public
669
+ */
670
+ export type Sender = (typeof Sender)[keyof typeof Sender];
671
+ /**
672
+ * <p>A message in a conversation, used as input for generating an Amazon Q App definition.</p>
673
+ * @public
674
+ */
675
+ export interface ConversationMessage {
676
+ /**
677
+ * <p>The text content of the conversation message.</p>
678
+ * @public
679
+ */
680
+ body: string | undefined;
681
+ /**
682
+ * <p>The type of the conversation message.</p>
683
+ * @public
684
+ */
685
+ type: Sender | undefined;
686
+ }
687
+ /**
688
+ * @public
689
+ */
690
+ export interface CreateLibraryItemInput {
691
+ /**
692
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
693
+ * @public
694
+ */
695
+ instanceId: string | undefined;
696
+ /**
697
+ * <p>The unique identifier of the Amazon Q App to publish to the library.</p>
698
+ * @public
699
+ */
700
+ appId: string | undefined;
701
+ /**
702
+ * <p>The version of the Amazon Q App to publish to the library.</p>
703
+ * @public
704
+ */
705
+ appVersion: number | undefined;
706
+ /**
707
+ * <p>The categories to associate with the library item for easier discovery.</p>
708
+ * @public
709
+ */
710
+ categories: string[] | undefined;
711
+ }
712
+ /**
713
+ * @public
714
+ */
715
+ export interface CreateLibraryItemOutput {
716
+ /**
717
+ * <p>The unique identifier of the new library item.</p>
718
+ * @public
719
+ */
720
+ libraryItemId: string | undefined;
721
+ /**
722
+ * <p>The status of the new library item, such as "Published".</p>
723
+ * @public
724
+ */
725
+ status: string | undefined;
726
+ /**
727
+ * <p>The date and time the library item was created.</p>
728
+ * @public
729
+ */
730
+ createdAt: Date | undefined;
731
+ /**
732
+ * <p>The user who created the library item.</p>
733
+ * @public
734
+ */
735
+ createdBy: string | undefined;
736
+ /**
737
+ * <p>The date and time the library item was last updated.</p>
738
+ * @public
739
+ */
740
+ updatedAt?: Date;
741
+ /**
742
+ * <p>The user who last updated the library item.</p>
743
+ * @public
744
+ */
745
+ updatedBy?: string;
746
+ /**
747
+ * <p>The number of ratings the library item has received from users.</p>
748
+ * @public
749
+ */
750
+ ratingCount: number | undefined;
751
+ }
752
+ /**
753
+ * @public
754
+ */
755
+ export interface CreateQAppOutput {
756
+ /**
757
+ * <p>The unique identifier of the new Q App.</p>
758
+ * @public
759
+ */
760
+ appId: string | undefined;
761
+ /**
762
+ * <p>The Amazon Resource Name (ARN) of the new Q App.</p>
763
+ * @public
764
+ */
765
+ appArn: string | undefined;
766
+ /**
767
+ * <p>The title of the new Q App.</p>
768
+ * @public
769
+ */
770
+ title: string | undefined;
771
+ /**
772
+ * <p>The description of the new Q App.</p>
773
+ * @public
774
+ */
775
+ description?: string;
776
+ /**
777
+ * <p>The initial prompt displayed when the Q App is started.</p>
778
+ * @public
779
+ */
780
+ initialPrompt?: string;
781
+ /**
782
+ * <p>The version of the new Q App.</p>
783
+ * @public
784
+ */
785
+ appVersion: number | undefined;
786
+ /**
787
+ * <p>The status of the new Q App, such as "Created".</p>
788
+ * @public
789
+ */
790
+ status: AppStatus | undefined;
791
+ /**
792
+ * <p>The date and time the Q App was created.</p>
793
+ * @public
794
+ */
795
+ createdAt: Date | undefined;
796
+ /**
797
+ * <p>The user who created the Q App.</p>
798
+ * @public
799
+ */
800
+ createdBy: string | undefined;
801
+ /**
802
+ * <p>The date and time the Q App was last updated.</p>
803
+ * @public
804
+ */
805
+ updatedAt: Date | undefined;
806
+ /**
807
+ * <p>The user who last updated the Q App.</p>
808
+ * @public
809
+ */
810
+ updatedBy: string | undefined;
811
+ /**
812
+ * <p>The capabilities required to run the Q App, such as file upload or third-party integrations.</p>
813
+ * @public
814
+ */
815
+ requiredCapabilities?: AppRequiredCapability[];
816
+ }
817
+ /**
818
+ * @public
819
+ */
820
+ export interface DeleteLibraryItemInput {
821
+ /**
822
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
823
+ * @public
824
+ */
825
+ instanceId: string | undefined;
826
+ /**
827
+ * <p>The unique identifier of the library item to delete.</p>
828
+ * @public
829
+ */
830
+ libraryItemId: string | undefined;
831
+ }
832
+ /**
833
+ * @public
834
+ */
835
+ export interface DeleteQAppInput {
836
+ /**
837
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
838
+ * @public
839
+ */
840
+ instanceId: string | undefined;
841
+ /**
842
+ * <p>The unique identifier of the Q App to delete.</p>
843
+ * @public
844
+ */
845
+ appId: string | undefined;
846
+ }
847
+ /**
848
+ * @public
849
+ */
850
+ export interface DisassociateLibraryItemReviewInput {
851
+ /**
852
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
853
+ * @public
854
+ */
855
+ instanceId: string | undefined;
856
+ /**
857
+ * <p>The unique identifier of the library item to remove the review from.</p>
858
+ * @public
859
+ */
860
+ libraryItemId: string | undefined;
861
+ }
862
+ /**
863
+ * @public
864
+ */
865
+ export interface DisassociateQAppFromUserInput {
866
+ /**
867
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
868
+ * @public
869
+ */
870
+ instanceId: string | undefined;
871
+ /**
872
+ * <p>The unique identifier of the Q App to disassociate from the user.</p>
873
+ * @public
874
+ */
875
+ appId: string | undefined;
876
+ }
877
+ /**
878
+ * @public
879
+ * @enum
880
+ */
881
+ export declare const DocumentScope: {
882
+ readonly APPLICATION: "APPLICATION";
883
+ readonly SESSION: "SESSION";
884
+ };
885
+ /**
886
+ * @public
887
+ */
888
+ export type DocumentScope = (typeof DocumentScope)[keyof typeof DocumentScope];
889
+ /**
890
+ * @public
891
+ */
892
+ export interface GetLibraryItemInput {
893
+ /**
894
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
895
+ * @public
896
+ */
897
+ instanceId: string | undefined;
898
+ /**
899
+ * <p>The unique identifier of the library item to retrieve.</p>
900
+ * @public
901
+ */
902
+ libraryItemId: string | undefined;
903
+ /**
904
+ * <p>The unique identifier of the Amazon Q App associated with the library item.</p>
905
+ * @public
906
+ */
907
+ appId?: string;
908
+ }
909
+ /**
910
+ * @public
911
+ */
912
+ export interface GetLibraryItemOutput {
913
+ /**
914
+ * <p>The unique identifier of the library item.</p>
915
+ * @public
916
+ */
917
+ libraryItemId: string | undefined;
918
+ /**
919
+ * <p>The unique identifier of the Q App associated with the library item.</p>
920
+ * @public
921
+ */
922
+ appId: string | undefined;
923
+ /**
924
+ * <p>The version of the Q App associated with the library item.</p>
925
+ * @public
926
+ */
927
+ appVersion: number | undefined;
928
+ /**
929
+ * <p>The categories associated with the library item for discovery.</p>
930
+ * @public
931
+ */
932
+ categories: Category[] | undefined;
933
+ /**
934
+ * <p>The status of the library item, such as "Published".</p>
935
+ * @public
936
+ */
937
+ status: string | undefined;
938
+ /**
939
+ * <p>The date and time the library item was created.</p>
940
+ * @public
941
+ */
942
+ createdAt: Date | undefined;
943
+ /**
944
+ * <p>The user who created the library item.</p>
945
+ * @public
946
+ */
947
+ createdBy: string | undefined;
948
+ /**
949
+ * <p>The date and time the library item was last updated.</p>
950
+ * @public
951
+ */
952
+ updatedAt?: Date;
953
+ /**
954
+ * <p>The user who last updated the library item.</p>
955
+ * @public
956
+ */
957
+ updatedBy?: string;
958
+ /**
959
+ * <p>The number of ratings the library item has received from users.</p>
960
+ * @public
961
+ */
962
+ ratingCount: number | undefined;
963
+ /**
964
+ * <p>Whether the current user has rated the library item.</p>
965
+ * @public
966
+ */
967
+ isRatedByUser?: boolean;
968
+ /**
969
+ * <p>The number of users who have associated the Q App with their account.</p>
970
+ * @public
971
+ */
972
+ userCount?: number;
973
+ }
974
+ /**
975
+ * @public
976
+ */
977
+ export interface GetQAppInput {
978
+ /**
979
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
980
+ * @public
981
+ */
982
+ instanceId: string | undefined;
983
+ /**
984
+ * <p>The unique identifier of the Q App to retrieve.</p>
985
+ * @public
986
+ */
987
+ appId: string | undefined;
988
+ }
989
+ /**
990
+ * @public
991
+ */
992
+ export interface GetQAppSessionInput {
993
+ /**
994
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
995
+ * @public
996
+ */
997
+ instanceId: string | undefined;
998
+ /**
999
+ * <p>The unique identifier of the Q App session to retrieve.</p>
1000
+ * @public
1001
+ */
1002
+ sessionId: string | undefined;
1003
+ }
1004
+ /**
1005
+ * @public
1006
+ */
1007
+ export interface GetQAppSessionOutput {
1008
+ /**
1009
+ * <p>The unique identifier of the Q App session.</p>
1010
+ * @public
1011
+ */
1012
+ sessionId: string | undefined;
1013
+ /**
1014
+ * <p>The Amazon Resource Name (ARN) of the Q App session.</p>
1015
+ * @public
1016
+ */
1017
+ sessionArn: string | undefined;
1018
+ /**
1019
+ * <p>The current status of the Q App session.</p>
1020
+ * @public
1021
+ */
1022
+ status: ExecutionStatus | undefined;
1023
+ /**
1024
+ * <p>The current status for each card in the Q App session.</p>
1025
+ * @public
1026
+ */
1027
+ cardStatus: Record<string, CardStatus> | undefined;
1028
+ }
1029
+ /**
1030
+ * @public
1031
+ */
1032
+ export interface ImportDocumentInput {
1033
+ /**
1034
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1035
+ * @public
1036
+ */
1037
+ instanceId: string | undefined;
1038
+ /**
1039
+ * <p>The unique identifier of the card the file is associated with, if applicable.</p>
1040
+ * @public
1041
+ */
1042
+ cardId: string | undefined;
1043
+ /**
1044
+ * <p>The unique identifier of the Q App the file is associated with.</p>
1045
+ * @public
1046
+ */
1047
+ appId: string | undefined;
1048
+ /**
1049
+ * <p>The base64-encoded contents of the file to upload.</p>
1050
+ * @public
1051
+ */
1052
+ fileContentsBase64: string | undefined;
1053
+ /**
1054
+ * <p>The name of the file being uploaded.</p>
1055
+ * @public
1056
+ */
1057
+ fileName: string | undefined;
1058
+ /**
1059
+ * <p>Whether the file is associated with an Q App definition or a specific Q App session.</p>
1060
+ * @public
1061
+ */
1062
+ scope: DocumentScope | undefined;
1063
+ /**
1064
+ * <p>The unique identifier of the Q App session the file is associated with, if applicable.</p>
1065
+ * @public
1066
+ */
1067
+ sessionId?: string;
1068
+ }
1069
+ /**
1070
+ * @public
1071
+ */
1072
+ export interface ImportDocumentOutput {
1073
+ /**
1074
+ * <p>The unique identifier assigned to the uploaded file.</p>
1075
+ * @public
1076
+ */
1077
+ fileId?: string;
1078
+ }
1079
+ /**
1080
+ * <p>A library item is a snapshot of an Amazon Q App
1081
+ * that can be published so the users in their Amazon Q Apps library
1082
+ * can discover it, clone it, and run it.</p>
1083
+ * @public
1084
+ */
1085
+ export interface LibraryItemMember {
1086
+ /**
1087
+ * <p>The unique identifier of the library item.</p>
1088
+ * @public
1089
+ */
1090
+ libraryItemId: string | undefined;
1091
+ /**
1092
+ * <p>The unique identifier of the Q App associated with the library item.</p>
1093
+ * @public
1094
+ */
1095
+ appId: string | undefined;
1096
+ /**
1097
+ * <p>The version of the Q App associated with the library item.</p>
1098
+ * @public
1099
+ */
1100
+ appVersion: number | undefined;
1101
+ /**
1102
+ * <p>The categories associated with the library item.</p>
1103
+ * @public
1104
+ */
1105
+ categories: Category[] | undefined;
1106
+ /**
1107
+ * <p>The status of the library item.</p>
1108
+ * @public
1109
+ */
1110
+ status: string | undefined;
1111
+ /**
1112
+ * <p>The date and time the library item was created.</p>
1113
+ * @public
1114
+ */
1115
+ createdAt: Date | undefined;
1116
+ /**
1117
+ * <p>The user who created the library item.</p>
1118
+ * @public
1119
+ */
1120
+ createdBy: string | undefined;
1121
+ /**
1122
+ * <p>The date and time the library item was last updated.</p>
1123
+ * @public
1124
+ */
1125
+ updatedAt?: Date;
1126
+ /**
1127
+ * <p>The user who last updated the library item.</p>
1128
+ * @public
1129
+ */
1130
+ updatedBy?: string;
1131
+ /**
1132
+ * <p>The number of ratings the library item has received.</p>
1133
+ * @public
1134
+ */
1135
+ ratingCount: number | undefined;
1136
+ /**
1137
+ * <p>Whether the current user has rated the library item.</p>
1138
+ * @public
1139
+ */
1140
+ isRatedByUser?: boolean;
1141
+ /**
1142
+ * <p>The number of users who have the associated Q App.</p>
1143
+ * @public
1144
+ */
1145
+ userCount?: number;
1146
+ }
1147
+ /**
1148
+ * @public
1149
+ * @enum
1150
+ */
1151
+ export declare const LibraryItemStatus: {
1152
+ readonly DISABLED: "DISABLED";
1153
+ readonly PUBLISHED: "PUBLISHED";
1154
+ };
1155
+ /**
1156
+ * @public
1157
+ */
1158
+ export type LibraryItemStatus = (typeof LibraryItemStatus)[keyof typeof LibraryItemStatus];
1159
+ /**
1160
+ * @public
1161
+ */
1162
+ export interface ListLibraryItemsInput {
1163
+ /**
1164
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1165
+ * @public
1166
+ */
1167
+ instanceId: string | undefined;
1168
+ /**
1169
+ * <p>The maximum number of library items to return in the response.</p>
1170
+ * @public
1171
+ */
1172
+ limit?: number;
1173
+ /**
1174
+ * <p>The token to request the next page of results.</p>
1175
+ * @public
1176
+ */
1177
+ nextToken?: string;
1178
+ /**
1179
+ * <p>Optional category to filter the library items by.</p>
1180
+ * @public
1181
+ */
1182
+ categoryId?: string;
1183
+ }
1184
+ /**
1185
+ * @public
1186
+ */
1187
+ export interface ListLibraryItemsOutput {
1188
+ /**
1189
+ * <p>The list of library items meeting the request criteria.</p>
1190
+ * @public
1191
+ */
1192
+ libraryItems?: LibraryItemMember[];
1193
+ /**
1194
+ * <p>The token to use to request the next page of results.</p>
1195
+ * @public
1196
+ */
1197
+ nextToken?: string;
1198
+ }
1199
+ /**
1200
+ * @public
1201
+ */
1202
+ export interface ListQAppsInput {
1203
+ /**
1204
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1205
+ * @public
1206
+ */
1207
+ instanceId: string | undefined;
1208
+ /**
1209
+ * <p>The maximum number of Q Apps to return in the response.</p>
1210
+ * @public
1211
+ */
1212
+ limit?: number;
1213
+ /**
1214
+ * <p>The token to request the next page of results.</p>
1215
+ * @public
1216
+ */
1217
+ nextToken?: string;
1218
+ }
1219
+ /**
1220
+ * <p>An Amazon Q App associated with a user, either owned by the user or favorited.</p>
1221
+ * @public
1222
+ */
1223
+ export interface UserAppItem {
1224
+ /**
1225
+ * <p>The unique identifier of the Q App.</p>
1226
+ * @public
1227
+ */
1228
+ appId: string | undefined;
1229
+ /**
1230
+ * <p>The Amazon Resource Name (ARN) of the Q App.</p>
1231
+ * @public
1232
+ */
1233
+ appArn: string | undefined;
1234
+ /**
1235
+ * <p>The title of the Q App.</p>
1236
+ * @public
1237
+ */
1238
+ title: string | undefined;
1239
+ /**
1240
+ * <p>The description of the Q App.</p>
1241
+ * @public
1242
+ */
1243
+ description?: string;
1244
+ /**
1245
+ * <p>The date and time the user's association with the Q App was created.</p>
1246
+ * @public
1247
+ */
1248
+ createdAt: Date | undefined;
1249
+ /**
1250
+ * <p>A flag indicating whether the user can edit the Q App.</p>
1251
+ * @public
1252
+ */
1253
+ canEdit?: boolean;
1254
+ /**
1255
+ * <p>The status of the user's association with the Q App.</p>
1256
+ * @public
1257
+ */
1258
+ status?: string;
1259
+ }
1260
+ /**
1261
+ * @public
1262
+ */
1263
+ export interface ListQAppsOutput {
1264
+ /**
1265
+ * <p>The list of Amazon Q Apps meeting the request criteria.</p>
1266
+ * @public
1267
+ */
1268
+ apps: UserAppItem[] | undefined;
1269
+ /**
1270
+ * <p>The token to use to request the next page of results.</p>
1271
+ * @public
1272
+ */
1273
+ nextToken?: string;
1274
+ }
1275
+ /**
1276
+ * @public
1277
+ */
1278
+ export interface ListTagsForResourceRequest {
1279
+ /**
1280
+ * <p>The Amazon Resource Name (ARN) of the resource whose tags should be listed.</p>
1281
+ * @public
1282
+ */
1283
+ resourceARN: string | undefined;
1284
+ }
1285
+ /**
1286
+ * @public
1287
+ */
1288
+ export interface ListTagsForResourceResponse {
1289
+ /**
1290
+ * <p>The list of tags that are assigned to the resource.</p>
1291
+ * @public
1292
+ */
1293
+ tags?: Record<string, string>;
1294
+ }
1295
+ /**
1296
+ * <p>The input options for generating an Q App definition.</p>
1297
+ * @public
1298
+ */
1299
+ export type PredictQAppInputOptions = PredictQAppInputOptions.ConversationMember | PredictQAppInputOptions.ProblemStatementMember | PredictQAppInputOptions.$UnknownMember;
1300
+ /**
1301
+ * @public
1302
+ */
1303
+ export declare namespace PredictQAppInputOptions {
1304
+ /**
1305
+ * <p>A conversation to use as input for generating the Q App definition.</p>
1306
+ * @public
1307
+ */
1308
+ interface ConversationMember {
1309
+ conversation: ConversationMessage[];
1310
+ problemStatement?: never;
1311
+ $unknown?: never;
1312
+ }
1313
+ /**
1314
+ * <p>A problem statement to use as input for generating the Q App definition.</p>
1315
+ * @public
1316
+ */
1317
+ interface ProblemStatementMember {
1318
+ conversation?: never;
1319
+ problemStatement: string;
1320
+ $unknown?: never;
1321
+ }
1322
+ /**
1323
+ * @public
1324
+ */
1325
+ interface $UnknownMember {
1326
+ conversation?: never;
1327
+ problemStatement?: never;
1328
+ $unknown: [string, any];
1329
+ }
1330
+ interface Visitor<T> {
1331
+ conversation: (value: ConversationMessage[]) => T;
1332
+ problemStatement: (value: string) => T;
1333
+ _: (name: string, value: any) => T;
1334
+ }
1335
+ const visit: <T>(value: PredictQAppInputOptions, visitor: Visitor<T>) => T;
1336
+ }
1337
+ /**
1338
+ * @public
1339
+ */
1340
+ export interface PredictQAppInput {
1341
+ /**
1342
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1343
+ * @public
1344
+ */
1345
+ instanceId: string | undefined;
1346
+ /**
1347
+ * <p>The input to generate the Q App definition from, either a conversation or problem statement.</p>
1348
+ * @public
1349
+ */
1350
+ options?: PredictQAppInputOptions;
1351
+ }
1352
+ /**
1353
+ * @public
1354
+ */
1355
+ export interface StartQAppSessionInput {
1356
+ /**
1357
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1358
+ * @public
1359
+ */
1360
+ instanceId: string | undefined;
1361
+ /**
1362
+ * <p>The unique identifier of the Q App to start a session for.</p>
1363
+ * @public
1364
+ */
1365
+ appId: string | undefined;
1366
+ /**
1367
+ * <p>The version of the Q App to use for the session.</p>
1368
+ * @public
1369
+ */
1370
+ appVersion: number | undefined;
1371
+ /**
1372
+ * <p>Optional initial input values to provide for the Q App session.</p>
1373
+ * @public
1374
+ */
1375
+ initialValues?: CardValue[];
1376
+ /**
1377
+ * <p>Optional tags to associate with the new Q App session.</p>
1378
+ * @public
1379
+ */
1380
+ tags?: Record<string, string>;
1381
+ }
1382
+ /**
1383
+ * @public
1384
+ */
1385
+ export interface StartQAppSessionOutput {
1386
+ /**
1387
+ * <p>The unique identifier of the new Q App session.</p>
1388
+ * @public
1389
+ */
1390
+ sessionId: string | undefined;
1391
+ /**
1392
+ * <p>The Amazon Resource Name (ARN) of the new Q App session.</p>
1393
+ * @public
1394
+ */
1395
+ sessionArn: string | undefined;
1396
+ }
1397
+ /**
1398
+ * @public
1399
+ */
1400
+ export interface StopQAppSessionInput {
1401
+ /**
1402
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1403
+ * @public
1404
+ */
1405
+ instanceId: string | undefined;
1406
+ /**
1407
+ * <p>The unique identifier of the Q App session to stop.</p>
1408
+ * @public
1409
+ */
1410
+ sessionId: string | undefined;
1411
+ }
1412
+ /**
1413
+ * @public
1414
+ */
1415
+ export interface TagResourceRequest {
1416
+ /**
1417
+ * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
1418
+ * @public
1419
+ */
1420
+ resourceARN: string | undefined;
1421
+ /**
1422
+ * <p>The tags to associate with the resource.</p>
1423
+ * @public
1424
+ */
1425
+ tags: Record<string, string> | undefined;
1426
+ }
1427
+ /**
1428
+ * @public
1429
+ */
1430
+ export interface TagResourceResponse {
1431
+ }
1432
+ /**
1433
+ * @public
1434
+ */
1435
+ export interface UntagResourceRequest {
1436
+ /**
1437
+ * <p>The Amazon Resource Name (ARN) of the resource to disassociate the tag from.</p>
1438
+ * @public
1439
+ */
1440
+ resourceARN: string | undefined;
1441
+ /**
1442
+ * <p>The keys of the tags to disassociate from the resource.</p>
1443
+ * @public
1444
+ */
1445
+ tagKeys: string[] | undefined;
1446
+ }
1447
+ /**
1448
+ * @public
1449
+ */
1450
+ export interface UntagResourceResponse {
1451
+ }
1452
+ /**
1453
+ * @public
1454
+ */
1455
+ export interface UpdateLibraryItemInput {
1456
+ /**
1457
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1458
+ * @public
1459
+ */
1460
+ instanceId: string | undefined;
1461
+ /**
1462
+ * <p>The unique identifier of the library item to update.</p>
1463
+ * @public
1464
+ */
1465
+ libraryItemId: string | undefined;
1466
+ /**
1467
+ * <p>The new status to set for the library item, such as "Published" or "Hidden".</p>
1468
+ * @public
1469
+ */
1470
+ status?: LibraryItemStatus;
1471
+ /**
1472
+ * <p>The new categories to associate with the library item.</p>
1473
+ * @public
1474
+ */
1475
+ categories?: string[];
1476
+ }
1477
+ /**
1478
+ * @public
1479
+ */
1480
+ export interface UpdateLibraryItemOutput {
1481
+ /**
1482
+ * <p>The unique identifier of the updated library item.</p>
1483
+ * @public
1484
+ */
1485
+ libraryItemId: string | undefined;
1486
+ /**
1487
+ * <p>The unique identifier of the Q App associated with the library item.</p>
1488
+ * @public
1489
+ */
1490
+ appId: string | undefined;
1491
+ /**
1492
+ * <p>The version of the Q App associated with the library item.</p>
1493
+ * @public
1494
+ */
1495
+ appVersion: number | undefined;
1496
+ /**
1497
+ * <p>The categories associated with the updated library item.</p>
1498
+ * @public
1499
+ */
1500
+ categories: Category[] | undefined;
1501
+ /**
1502
+ * <p>The new status of the updated library item.</p>
1503
+ * @public
1504
+ */
1505
+ status: string | undefined;
1506
+ /**
1507
+ * <p>The date and time the library item was originally created.</p>
1508
+ * @public
1509
+ */
1510
+ createdAt: Date | undefined;
1511
+ /**
1512
+ * <p>The user who originally created the library item.</p>
1513
+ * @public
1514
+ */
1515
+ createdBy: string | undefined;
1516
+ /**
1517
+ * <p>The date and time the library item was last updated.</p>
1518
+ * @public
1519
+ */
1520
+ updatedAt?: Date;
1521
+ /**
1522
+ * <p>The user who last updated the library item.</p>
1523
+ * @public
1524
+ */
1525
+ updatedBy?: string;
1526
+ /**
1527
+ * <p>The number of ratings the library item has received.</p>
1528
+ * @public
1529
+ */
1530
+ ratingCount: number | undefined;
1531
+ /**
1532
+ * <p>Whether the current user has rated the library item.</p>
1533
+ * @public
1534
+ */
1535
+ isRatedByUser?: boolean;
1536
+ /**
1537
+ * <p>The number of users who have the associated Q App.</p>
1538
+ * @public
1539
+ */
1540
+ userCount?: number;
1541
+ }
1542
+ /**
1543
+ * @public
1544
+ */
1545
+ export interface UpdateQAppOutput {
1546
+ /**
1547
+ * <p>The unique identifier of the updated Q App.</p>
1548
+ * @public
1549
+ */
1550
+ appId: string | undefined;
1551
+ /**
1552
+ * <p>The Amazon Resource Name (ARN) of the updated Q App.</p>
1553
+ * @public
1554
+ */
1555
+ appArn: string | undefined;
1556
+ /**
1557
+ * <p>The new title of the updated Q App.</p>
1558
+ * @public
1559
+ */
1560
+ title: string | undefined;
1561
+ /**
1562
+ * <p>The new description of the updated Q App.</p>
1563
+ * @public
1564
+ */
1565
+ description?: string;
1566
+ /**
1567
+ * <p>The initial prompt for the updated Q App.</p>
1568
+ * @public
1569
+ */
1570
+ initialPrompt?: string;
1571
+ /**
1572
+ * <p>The new version of the updated Q App.</p>
1573
+ * @public
1574
+ */
1575
+ appVersion: number | undefined;
1576
+ /**
1577
+ * <p>The status of the updated Q App.</p>
1578
+ * @public
1579
+ */
1580
+ status: AppStatus | undefined;
1581
+ /**
1582
+ * <p>The date and time the Q App was originally created.</p>
1583
+ * @public
1584
+ */
1585
+ createdAt: Date | undefined;
1586
+ /**
1587
+ * <p>The user who originally created the Q App.</p>
1588
+ * @public
1589
+ */
1590
+ createdBy: string | undefined;
1591
+ /**
1592
+ * <p>The date and time the Q App was last updated.</p>
1593
+ * @public
1594
+ */
1595
+ updatedAt: Date | undefined;
1596
+ /**
1597
+ * <p>The user who last updated the Q App.</p>
1598
+ * @public
1599
+ */
1600
+ updatedBy: string | undefined;
1601
+ /**
1602
+ * <p>The capabilities required for the updated Q App.</p>
1603
+ * @public
1604
+ */
1605
+ requiredCapabilities?: AppRequiredCapability[];
1606
+ }
1607
+ /**
1608
+ * @public
1609
+ */
1610
+ export interface UpdateQAppSessionInput {
1611
+ /**
1612
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1613
+ * @public
1614
+ */
1615
+ instanceId: string | undefined;
1616
+ /**
1617
+ * <p>The unique identifier of the Q App session to provide input for.</p>
1618
+ * @public
1619
+ */
1620
+ sessionId: string | undefined;
1621
+ /**
1622
+ * <p>The input values to provide for the current state of the Q App session.</p>
1623
+ * @public
1624
+ */
1625
+ values?: CardValue[];
1626
+ }
1627
+ /**
1628
+ * @public
1629
+ */
1630
+ export interface UpdateQAppSessionOutput {
1631
+ /**
1632
+ * <p>The unique identifier of the updated Q App session.</p>
1633
+ * @public
1634
+ */
1635
+ sessionId: string | undefined;
1636
+ /**
1637
+ * <p>The Amazon Resource Name (ARN) of the updated Q App session.</p>
1638
+ * @public
1639
+ */
1640
+ sessionArn: string | undefined;
1641
+ }
1642
+ /**
1643
+ * <p>The filter criteria used on responses based on document attributes or metadata fields.</p>
1644
+ * @public
1645
+ */
1646
+ export interface AttributeFilter {
1647
+ /**
1648
+ * <p>Performs a logical <code>AND</code> operation on all supplied filters.</p>
1649
+ * @public
1650
+ */
1651
+ andAllFilters?: AttributeFilter[];
1652
+ /**
1653
+ * <p> Performs a logical <code>OR</code> operation on all supplied filters. </p>
1654
+ * @public
1655
+ */
1656
+ orAllFilters?: AttributeFilter[];
1657
+ /**
1658
+ * <p>Performs a logical <code>NOT</code> operation on all supplied filters. </p>
1659
+ * @public
1660
+ */
1661
+ notFilter?: AttributeFilter;
1662
+ /**
1663
+ * <p>Performs an <i>equals</i> operation on two document attributes or metadata fields. Supported
1664
+ * for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
1665
+ * <code>longValue</code>, <code>stringListValue</code> and
1666
+ * <code>stringValue</code>.</p>
1667
+ * @public
1668
+ */
1669
+ equalsTo?: DocumentAttribute;
1670
+ /**
1671
+ * <p>Returns <code>true</code> when a document contains all the specified document
1672
+ * attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
1673
+ * <code>stringListValue</code>.</p>
1674
+ * @public
1675
+ */
1676
+ containsAll?: DocumentAttribute;
1677
+ /**
1678
+ * <p>Returns <code>true</code> when a document contains any of the specified document
1679
+ * attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
1680
+ * <code>stringListValue</code>.</p>
1681
+ * @public
1682
+ */
1683
+ containsAny?: DocumentAttribute;
1684
+ /**
1685
+ * <p>Performs a <i>greater than</i> operation on two document attributes or metadata fields.
1686
+ * Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
1687
+ * and <code>longValue</code>.</p>
1688
+ * @public
1689
+ */
1690
+ greaterThan?: DocumentAttribute;
1691
+ /**
1692
+ * <p>Performs a <i>greater than or equals</i> operation on two document attributes or metadata
1693
+ * fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
1694
+ * and <code>longValue</code>. </p>
1695
+ * @public
1696
+ */
1697
+ greaterThanOrEquals?: DocumentAttribute;
1698
+ /**
1699
+ * <p>Performs a <i>less than</i> operation on two document attributes or metadata fields.
1700
+ * Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
1701
+ * and <code>longValue</code>.</p>
1702
+ * @public
1703
+ */
1704
+ lessThan?: DocumentAttribute;
1705
+ /**
1706
+ * <p>Performs a <i>less than or equals</i> operation on two document attributes or metadata
1707
+ * fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code>
1708
+ * and <code>longValue</code>. </p>
1709
+ * @public
1710
+ */
1711
+ lessThanOrEquals?: DocumentAttribute;
1712
+ }
1713
+ /**
1714
+ * <p>A card in a Amazon Q App that generates a response
1715
+ * based on the Amazon Q Business service.</p>
1716
+ * @public
1717
+ */
1718
+ export interface QQueryCard {
1719
+ /**
1720
+ * <p>The unique identifier of the query card. </p>
1721
+ * @public
1722
+ */
1723
+ id: string | undefined;
1724
+ /**
1725
+ * <p>The title or label of the query card.</p>
1726
+ * @public
1727
+ */
1728
+ title: string | undefined;
1729
+ /**
1730
+ * <p>Any dependencies or requirements for the query card.</p>
1731
+ * @public
1732
+ */
1733
+ dependencies: string[] | undefined;
1734
+ /**
1735
+ * <p>The type of the card.</p>
1736
+ * @public
1737
+ */
1738
+ type: CardType | undefined;
1739
+ /**
1740
+ * <p>The prompt or instructions displayed for the query card.</p>
1741
+ * @public
1742
+ */
1743
+ prompt: string | undefined;
1744
+ /**
1745
+ * <p>The source or type of output generated by the query card.</p>
1746
+ * @public
1747
+ */
1748
+ outputSource: CardOutputSource | undefined;
1749
+ /**
1750
+ * <p>The Amazon Q Business filters applied in this query card when resolving data sources</p>
1751
+ * @public
1752
+ */
1753
+ attributeFilter?: AttributeFilter;
1754
+ }
1755
+ /**
1756
+ * <p>The input shape for defining a query card in an Amazon Q App.</p>
1757
+ * @public
1758
+ */
1759
+ export interface QQueryCardInput {
1760
+ /**
1761
+ * <p>The title or label of the query card.</p>
1762
+ * @public
1763
+ */
1764
+ title: string | undefined;
1765
+ /**
1766
+ * <p>The unique identifier of the query card.</p>
1767
+ * @public
1768
+ */
1769
+ id: string | undefined;
1770
+ /**
1771
+ * <p>The type of the card.</p>
1772
+ * @public
1773
+ */
1774
+ type: CardType | undefined;
1775
+ /**
1776
+ * <p>The prompt or instructions displayed for the query card.</p>
1777
+ * @public
1778
+ */
1779
+ prompt: string | undefined;
1780
+ /**
1781
+ * <p>The source or type of output to generate for the query card.</p>
1782
+ * @public
1783
+ */
1784
+ outputSource?: CardOutputSource;
1785
+ /**
1786
+ * <p>Turns on filtering of responses based on document attributes or metadata fields.</p>
1787
+ * @public
1788
+ */
1789
+ attributeFilter?: AttributeFilter;
1790
+ }
1791
+ /**
1792
+ * <p>A card representing a component or step in an Amazon Q App's flow.</p>
1793
+ * @public
1794
+ */
1795
+ export type Card = Card.FileUploadMember | Card.QPluginMember | Card.QQueryMember | Card.TextInputMember | Card.$UnknownMember;
1796
+ /**
1797
+ * @public
1798
+ */
1799
+ export declare namespace Card {
1800
+ /**
1801
+ * <p>A container for the properties of the text input card.</p>
1802
+ * @public
1803
+ */
1804
+ interface TextInputMember {
1805
+ textInput: TextInputCard;
1806
+ qQuery?: never;
1807
+ qPlugin?: never;
1808
+ fileUpload?: never;
1809
+ $unknown?: never;
1810
+ }
1811
+ /**
1812
+ * <p>A container for the properties of the query card.</p>
1813
+ * @public
1814
+ */
1815
+ interface QQueryMember {
1816
+ textInput?: never;
1817
+ qQuery: QQueryCard;
1818
+ qPlugin?: never;
1819
+ fileUpload?: never;
1820
+ $unknown?: never;
1821
+ }
1822
+ /**
1823
+ * <p>A container for the properties of the plugin card.</p>
1824
+ * @public
1825
+ */
1826
+ interface QPluginMember {
1827
+ textInput?: never;
1828
+ qQuery?: never;
1829
+ qPlugin: QPluginCard;
1830
+ fileUpload?: never;
1831
+ $unknown?: never;
1832
+ }
1833
+ /**
1834
+ * <p>A container for the properties of the file upload card.</p>
1835
+ * @public
1836
+ */
1837
+ interface FileUploadMember {
1838
+ textInput?: never;
1839
+ qQuery?: never;
1840
+ qPlugin?: never;
1841
+ fileUpload: FileUploadCard;
1842
+ $unknown?: never;
1843
+ }
1844
+ /**
1845
+ * @public
1846
+ */
1847
+ interface $UnknownMember {
1848
+ textInput?: never;
1849
+ qQuery?: never;
1850
+ qPlugin?: never;
1851
+ fileUpload?: never;
1852
+ $unknown: [string, any];
1853
+ }
1854
+ interface Visitor<T> {
1855
+ textInput: (value: TextInputCard) => T;
1856
+ qQuery: (value: QQueryCard) => T;
1857
+ qPlugin: (value: QPluginCard) => T;
1858
+ fileUpload: (value: FileUploadCard) => T;
1859
+ _: (name: string, value: any) => T;
1860
+ }
1861
+ const visit: <T>(value: Card, visitor: Visitor<T>) => T;
1862
+ }
1863
+ /**
1864
+ * <p>The properties defining an input card in an Amazon Q App.</p>
1865
+ * @public
1866
+ */
1867
+ export type CardInput = CardInput.FileUploadMember | CardInput.QPluginMember | CardInput.QQueryMember | CardInput.TextInputMember | CardInput.$UnknownMember;
1868
+ /**
1869
+ * @public
1870
+ */
1871
+ export declare namespace CardInput {
1872
+ /**
1873
+ * <p>A container for the properties of the text input card.</p>
1874
+ * @public
1875
+ */
1876
+ interface TextInputMember {
1877
+ textInput: TextInputCardInput;
1878
+ qQuery?: never;
1879
+ qPlugin?: never;
1880
+ fileUpload?: never;
1881
+ $unknown?: never;
1882
+ }
1883
+ /**
1884
+ * <p>A container for the properties of the query input card.</p>
1885
+ * @public
1886
+ */
1887
+ interface QQueryMember {
1888
+ textInput?: never;
1889
+ qQuery: QQueryCardInput;
1890
+ qPlugin?: never;
1891
+ fileUpload?: never;
1892
+ $unknown?: never;
1893
+ }
1894
+ /**
1895
+ * <p>A container for the properties of the plugin input card.</p>
1896
+ * @public
1897
+ */
1898
+ interface QPluginMember {
1899
+ textInput?: never;
1900
+ qQuery?: never;
1901
+ qPlugin: QPluginCardInput;
1902
+ fileUpload?: never;
1903
+ $unknown?: never;
1904
+ }
1905
+ /**
1906
+ * <p>A container for the properties of the file upload input card.</p>
1907
+ * @public
1908
+ */
1909
+ interface FileUploadMember {
1910
+ textInput?: never;
1911
+ qQuery?: never;
1912
+ qPlugin?: never;
1913
+ fileUpload: FileUploadCardInput;
1914
+ $unknown?: never;
1915
+ }
1916
+ /**
1917
+ * @public
1918
+ */
1919
+ interface $UnknownMember {
1920
+ textInput?: never;
1921
+ qQuery?: never;
1922
+ qPlugin?: never;
1923
+ fileUpload?: never;
1924
+ $unknown: [string, any];
1925
+ }
1926
+ interface Visitor<T> {
1927
+ textInput: (value: TextInputCardInput) => T;
1928
+ qQuery: (value: QQueryCardInput) => T;
1929
+ qPlugin: (value: QPluginCardInput) => T;
1930
+ fileUpload: (value: FileUploadCardInput) => T;
1931
+ _: (name: string, value: any) => T;
1932
+ }
1933
+ const visit: <T>(value: CardInput, visitor: Visitor<T>) => T;
1934
+ }
1935
+ /**
1936
+ * <p>The definition of the Q App, specifying the cards and flow.</p>
1937
+ * @public
1938
+ */
1939
+ export interface AppDefinition {
1940
+ /**
1941
+ * <p>The version of the app definition schema or specification.</p>
1942
+ * @public
1943
+ */
1944
+ appDefinitionVersion: string | undefined;
1945
+ /**
1946
+ * <p>The cards that make up the Q App, such as text input, file upload, or query cards.</p>
1947
+ * @public
1948
+ */
1949
+ cards: Card[] | undefined;
1950
+ /**
1951
+ * <p>A flag indicating whether the Q App's definition can be edited by the user.</p>
1952
+ * @public
1953
+ */
1954
+ canEdit?: boolean;
1955
+ }
1956
+ /**
1957
+ * <p>The input for defining an Q App.</p>
1958
+ * @public
1959
+ */
1960
+ export interface AppDefinitionInput {
1961
+ /**
1962
+ * <p>The cards that make up the Q App definition.</p>
1963
+ * @public
1964
+ */
1965
+ cards: CardInput[] | undefined;
1966
+ /**
1967
+ * <p>The initial prompt displayed when the Q App is started.</p>
1968
+ * @public
1969
+ */
1970
+ initialPrompt?: string;
1971
+ }
1972
+ /**
1973
+ * @public
1974
+ */
1975
+ export interface CreateQAppInput {
1976
+ /**
1977
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1978
+ * @public
1979
+ */
1980
+ instanceId: string | undefined;
1981
+ /**
1982
+ * <p>The title of the new Q App.</p>
1983
+ * @public
1984
+ */
1985
+ title: string | undefined;
1986
+ /**
1987
+ * <p>The description of the new Q App.</p>
1988
+ * @public
1989
+ */
1990
+ description?: string;
1991
+ /**
1992
+ * <p>The definition of the new Q App, specifying the cards and flow.</p>
1993
+ * @public
1994
+ */
1995
+ appDefinition: AppDefinitionInput | undefined;
1996
+ /**
1997
+ * <p>Optional tags to associate with the new Q App.</p>
1998
+ * @public
1999
+ */
2000
+ tags?: Record<string, string>;
2001
+ }
2002
+ /**
2003
+ * @public
2004
+ */
2005
+ export interface GetQAppOutput {
2006
+ /**
2007
+ * <p>The unique identifier of the Q App.</p>
2008
+ * @public
2009
+ */
2010
+ appId: string | undefined;
2011
+ /**
2012
+ * <p>The Amazon Resource Name (ARN) of the Q App.</p>
2013
+ * @public
2014
+ */
2015
+ appArn: string | undefined;
2016
+ /**
2017
+ * <p>The title of the Q App.</p>
2018
+ * @public
2019
+ */
2020
+ title: string | undefined;
2021
+ /**
2022
+ * <p>The description of the Q App.</p>
2023
+ * @public
2024
+ */
2025
+ description?: string;
2026
+ /**
2027
+ * <p>The initial prompt displayed when the Q App is started.</p>
2028
+ * @public
2029
+ */
2030
+ initialPrompt?: string;
2031
+ /**
2032
+ * <p>The version of the Q App.</p>
2033
+ * @public
2034
+ */
2035
+ appVersion: number | undefined;
2036
+ /**
2037
+ * <p>The status of the Q App.</p>
2038
+ * @public
2039
+ */
2040
+ status: AppStatus | undefined;
2041
+ /**
2042
+ * <p>The date and time the Q App was created.</p>
2043
+ * @public
2044
+ */
2045
+ createdAt: Date | undefined;
2046
+ /**
2047
+ * <p>The user who created the Q App.</p>
2048
+ * @public
2049
+ */
2050
+ createdBy: string | undefined;
2051
+ /**
2052
+ * <p>The date and time the Q App was last updated.</p>
2053
+ * @public
2054
+ */
2055
+ updatedAt: Date | undefined;
2056
+ /**
2057
+ * <p>The user who last updated the Q App.</p>
2058
+ * @public
2059
+ */
2060
+ updatedBy: string | undefined;
2061
+ /**
2062
+ * <p>The capabilities required to run the Q App, such as file upload or third-party integrations.</p>
2063
+ * @public
2064
+ */
2065
+ requiredCapabilities?: AppRequiredCapability[];
2066
+ /**
2067
+ * <p>The full definition of the Q App, specifying the cards and flow.</p>
2068
+ * @public
2069
+ */
2070
+ appDefinition: AppDefinition | undefined;
2071
+ }
2072
+ /**
2073
+ * <p>The definition of an Amazon Q App generated based on input such as a conversation
2074
+ * or problem statement.</p>
2075
+ * @public
2076
+ */
2077
+ export interface PredictAppDefinition {
2078
+ /**
2079
+ * <p>The title of the generated Q App definition.</p>
2080
+ * @public
2081
+ */
2082
+ title: string | undefined;
2083
+ /**
2084
+ * <p>The description of the generated Q App definition.</p>
2085
+ * @public
2086
+ */
2087
+ description?: string;
2088
+ /**
2089
+ * <p>The definition specifying the cards and flow of the generated Q App.</p>
2090
+ * @public
2091
+ */
2092
+ appDefinition: AppDefinitionInput | undefined;
2093
+ }
2094
+ /**
2095
+ * @public
2096
+ */
2097
+ export interface UpdateQAppInput {
2098
+ /**
2099
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
2100
+ * @public
2101
+ */
2102
+ instanceId: string | undefined;
2103
+ /**
2104
+ * <p>The unique identifier of the Q App to update.</p>
2105
+ * @public
2106
+ */
2107
+ appId: string | undefined;
2108
+ /**
2109
+ * <p>The new title for the Q App.</p>
2110
+ * @public
2111
+ */
2112
+ title?: string;
2113
+ /**
2114
+ * <p>The new description for the Q App.</p>
2115
+ * @public
2116
+ */
2117
+ description?: string;
2118
+ /**
2119
+ * <p>The new definition specifying the cards and flow for the Q App.</p>
2120
+ * @public
2121
+ */
2122
+ appDefinition?: AppDefinitionInput;
2123
+ }
2124
+ /**
2125
+ * @public
2126
+ */
2127
+ export interface PredictQAppOutput {
2128
+ /**
2129
+ * <p>The generated Q App definition.</p>
2130
+ * @public
2131
+ */
2132
+ app: PredictAppDefinition | undefined;
2133
+ /**
2134
+ * <p>The problem statement extracted from the input conversation, if provided.</p>
2135
+ * @public
2136
+ */
2137
+ problemStatement: string | undefined;
2138
+ }