@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,100 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { StartQAppSessionInput, StartQAppSessionOutput } from "../models/models_0";
4
+ import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartQAppSessionCommand}.
14
+ */
15
+ export interface StartQAppSessionCommandInput extends StartQAppSessionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartQAppSessionCommand}.
21
+ */
22
+ export interface StartQAppSessionCommandOutput extends StartQAppSessionOutput, __MetadataBearer {
23
+ }
24
+ declare const StartQAppSessionCommand_base: {
25
+ new (input: StartQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<StartQAppSessionCommandInput, StartQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: StartQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<StartQAppSessionCommandInput, StartQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Starts a new session for an Amazon Q App, allowing inputs to be provided
31
+ * and the app to be run.</p>
32
+ * <note>
33
+ * <p>Each Q App session will be condensed into a single conversation
34
+ * in the web experience.</p>
35
+ * </note>
36
+ * @example
37
+ * Use a bare-bones client and the command you need to make an API call.
38
+ * ```javascript
39
+ * import { QAppsClient, StartQAppSessionCommand } from "@aws-sdk/client-qapps"; // ES Modules import
40
+ * // const { QAppsClient, StartQAppSessionCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
41
+ * const client = new QAppsClient(config);
42
+ * const input = { // StartQAppSessionInput
43
+ * instanceId: "STRING_VALUE", // required
44
+ * appId: "STRING_VALUE", // required
45
+ * appVersion: Number("int"), // required
46
+ * initialValues: [ // CardValueList
47
+ * { // CardValue
48
+ * cardId: "STRING_VALUE", // required
49
+ * value: "STRING_VALUE", // required
50
+ * },
51
+ * ],
52
+ * tags: { // TagMap
53
+ * "<keys>": "STRING_VALUE",
54
+ * },
55
+ * };
56
+ * const command = new StartQAppSessionCommand(input);
57
+ * const response = await client.send(command);
58
+ * // { // StartQAppSessionOutput
59
+ * // sessionId: "STRING_VALUE", // required
60
+ * // sessionArn: "STRING_VALUE", // required
61
+ * // };
62
+ *
63
+ * ```
64
+ *
65
+ * @param StartQAppSessionCommandInput - {@link StartQAppSessionCommandInput}
66
+ * @returns {@link StartQAppSessionCommandOutput}
67
+ * @see {@link StartQAppSessionCommandInput} for command's `input` shape.
68
+ * @see {@link StartQAppSessionCommandOutput} for command's `response` shape.
69
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
70
+ *
71
+ * @throws {@link AccessDeniedException} (client fault)
72
+ * <p>The client is not authorized to perform the requested operation.</p>
73
+ *
74
+ * @throws {@link InternalServerException} (server fault)
75
+ * <p>An internal service error occurred while processing the request.</p>
76
+ *
77
+ * @throws {@link ResourceNotFoundException} (client fault)
78
+ * <p>The requested resource could not be found.</p>
79
+ *
80
+ * @throws {@link ServiceQuotaExceededException} (client fault)
81
+ * <p>The requested operation could not be completed because
82
+ * it would exceed the service's quota or limit.</p>
83
+ *
84
+ * @throws {@link ThrottlingException} (client fault)
85
+ * <p>The requested operation could not be completed because too many
86
+ * requests were sent at once. Wait a bit and try again later.</p>
87
+ *
88
+ * @throws {@link UnauthorizedException} (client fault)
89
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
90
+ *
91
+ * @throws {@link ValidationException} (client fault)
92
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
93
+ *
94
+ * @throws {@link QAppsServiceException}
95
+ * <p>Base exception class for all service exceptions from QApps service.</p>
96
+ *
97
+ * @public
98
+ */
99
+ export declare class StartQAppSessionCommand extends StartQAppSessionCommand_base {
100
+ }
@@ -0,0 +1,84 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { StopQAppSessionInput } from "../models/models_0";
4
+ import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StopQAppSessionCommand}.
14
+ */
15
+ export interface StopQAppSessionCommandInput extends StopQAppSessionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StopQAppSessionCommand}.
21
+ */
22
+ export interface StopQAppSessionCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const StopQAppSessionCommand_base: {
25
+ new (input: StopQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<StopQAppSessionCommandInput, StopQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: StopQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<StopQAppSessionCommandInput, StopQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Stops an active session for an Amazon Q App.This deletes all data
31
+ * related to the session and makes it invalid for future uses. The
32
+ * results of the session will be persisted as part of the conversation.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { QAppsClient, StopQAppSessionCommand } from "@aws-sdk/client-qapps"; // ES Modules import
37
+ * // const { QAppsClient, StopQAppSessionCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
38
+ * const client = new QAppsClient(config);
39
+ * const input = { // StopQAppSessionInput
40
+ * instanceId: "STRING_VALUE", // required
41
+ * sessionId: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new StopQAppSessionCommand(input);
44
+ * const response = await client.send(command);
45
+ * // {};
46
+ *
47
+ * ```
48
+ *
49
+ * @param StopQAppSessionCommandInput - {@link StopQAppSessionCommandInput}
50
+ * @returns {@link StopQAppSessionCommandOutput}
51
+ * @see {@link StopQAppSessionCommandInput} for command's `input` shape.
52
+ * @see {@link StopQAppSessionCommandOutput} for command's `response` shape.
53
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
54
+ *
55
+ * @throws {@link AccessDeniedException} (client fault)
56
+ * <p>The client is not authorized to perform the requested operation.</p>
57
+ *
58
+ * @throws {@link InternalServerException} (server fault)
59
+ * <p>An internal service error occurred while processing the request.</p>
60
+ *
61
+ * @throws {@link ResourceNotFoundException} (client fault)
62
+ * <p>The requested resource could not be found.</p>
63
+ *
64
+ * @throws {@link ServiceQuotaExceededException} (client fault)
65
+ * <p>The requested operation could not be completed because
66
+ * it would exceed the service's quota or limit.</p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>The requested operation could not be completed because too many
70
+ * requests were sent at once. Wait a bit and try again later.</p>
71
+ *
72
+ * @throws {@link UnauthorizedException} (client fault)
73
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
77
+ *
78
+ * @throws {@link QAppsServiceException}
79
+ * <p>Base exception class for all service exceptions from QApps service.</p>
80
+ *
81
+ * @public
82
+ */
83
+ export declare class StopQAppSessionCommand extends StopQAppSessionCommand_base {
84
+ }
@@ -0,0 +1,81 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
4
+ import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link TagResourceCommand}.
14
+ */
15
+ export interface TagResourceCommandInput extends TagResourceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link TagResourceCommand}.
21
+ */
22
+ export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
23
+ }
24
+ declare const TagResourceCommand_base: {
25
+ new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Associates tags with an Amazon Q Apps resource.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, TagResourceCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, TagResourceCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // TagResourceRequest
38
+ * resourceARN: "STRING_VALUE", // required
39
+ * tags: { // Tags // required
40
+ * "<keys>": "STRING_VALUE",
41
+ * },
42
+ * };
43
+ * const command = new TagResourceCommand(input);
44
+ * const response = await client.send(command);
45
+ * // {};
46
+ *
47
+ * ```
48
+ *
49
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
50
+ * @returns {@link TagResourceCommandOutput}
51
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
52
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
53
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
54
+ *
55
+ * @throws {@link AccessDeniedException} (client fault)
56
+ * <p>The client is not authorized to perform the requested operation.</p>
57
+ *
58
+ * @throws {@link ConflictException} (client fault)
59
+ * <p>The requested operation could not be completed due to a
60
+ * conflict with the current state of the resource.</p>
61
+ *
62
+ * @throws {@link InternalServerException} (server fault)
63
+ * <p>An internal service error occurred while processing the request.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>The requested resource could not be found.</p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>The requested operation could not be completed because too many
70
+ * requests were sent at once. Wait a bit and try again later.</p>
71
+ *
72
+ * @throws {@link ValidationException} (client fault)
73
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
74
+ *
75
+ * @throws {@link QAppsServiceException}
76
+ * <p>Base exception class for all service exceptions from QApps service.</p>
77
+ *
78
+ * @public
79
+ */
80
+ export declare class TagResourceCommand extends TagResourceCommand_base {
81
+ }
@@ -0,0 +1,77 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
4
+ import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UntagResourceCommand}.
14
+ */
15
+ export interface UntagResourceCommandInput extends UntagResourceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UntagResourceCommand}.
21
+ */
22
+ export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
23
+ }
24
+ declare const UntagResourceCommand_base: {
25
+ new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Disassociates tags from an Amazon Q Apps resource.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, UntagResourceCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, UntagResourceCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // UntagResourceRequest
38
+ * resourceARN: "STRING_VALUE", // required
39
+ * tagKeys: [ // TagKeys // required
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * };
43
+ * const command = new UntagResourceCommand(input);
44
+ * const response = await client.send(command);
45
+ * // {};
46
+ *
47
+ * ```
48
+ *
49
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
50
+ * @returns {@link UntagResourceCommandOutput}
51
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
52
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
53
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
54
+ *
55
+ * @throws {@link AccessDeniedException} (client fault)
56
+ * <p>The client is not authorized to perform the requested operation.</p>
57
+ *
58
+ * @throws {@link InternalServerException} (server fault)
59
+ * <p>An internal service error occurred while processing the request.</p>
60
+ *
61
+ * @throws {@link ResourceNotFoundException} (client fault)
62
+ * <p>The requested resource could not be found.</p>
63
+ *
64
+ * @throws {@link ThrottlingException} (client fault)
65
+ * <p>The requested operation could not be completed because too many
66
+ * requests were sent at once. Wait a bit and try again later.</p>
67
+ *
68
+ * @throws {@link ValidationException} (client fault)
69
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
70
+ *
71
+ * @throws {@link QAppsServiceException}
72
+ * <p>Base exception class for all service exceptions from QApps service.</p>
73
+ *
74
+ * @public
75
+ */
76
+ export declare class UntagResourceCommand extends UntagResourceCommand_base {
77
+ }
@@ -0,0 +1,100 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UpdateLibraryItemInput, UpdateLibraryItemOutput } from "../models/models_0";
4
+ import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateLibraryItemCommand}.
14
+ */
15
+ export interface UpdateLibraryItemCommandInput extends UpdateLibraryItemInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateLibraryItemCommand}.
21
+ */
22
+ export interface UpdateLibraryItemCommandOutput extends UpdateLibraryItemOutput, __MetadataBearer {
23
+ }
24
+ declare const UpdateLibraryItemCommand_base: {
25
+ new (input: UpdateLibraryItemCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateLibraryItemCommandInput, UpdateLibraryItemCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateLibraryItemCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateLibraryItemCommandInput, UpdateLibraryItemCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates the metadata and status of a library item for an Amazon Q App.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, UpdateLibraryItemCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, UpdateLibraryItemCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // UpdateLibraryItemInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * libraryItemId: "STRING_VALUE", // required
40
+ * status: "PUBLISHED" || "DISABLED",
41
+ * categories: [ // CategoryIdList
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * };
45
+ * const command = new UpdateLibraryItemCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // UpdateLibraryItemOutput
48
+ * // libraryItemId: "STRING_VALUE", // required
49
+ * // appId: "STRING_VALUE", // required
50
+ * // appVersion: Number("int"), // required
51
+ * // categories: [ // CategoryList // required
52
+ * // { // Category
53
+ * // id: "STRING_VALUE", // required
54
+ * // title: "STRING_VALUE", // required
55
+ * // },
56
+ * // ],
57
+ * // status: "STRING_VALUE", // required
58
+ * // createdAt: new Date("TIMESTAMP"), // required
59
+ * // createdBy: "STRING_VALUE", // required
60
+ * // updatedAt: new Date("TIMESTAMP"),
61
+ * // updatedBy: "STRING_VALUE",
62
+ * // ratingCount: Number("int"), // required
63
+ * // isRatedByUser: true || false,
64
+ * // userCount: Number("int"),
65
+ * // };
66
+ *
67
+ * ```
68
+ *
69
+ * @param UpdateLibraryItemCommandInput - {@link UpdateLibraryItemCommandInput}
70
+ * @returns {@link UpdateLibraryItemCommandOutput}
71
+ * @see {@link UpdateLibraryItemCommandInput} for command's `input` shape.
72
+ * @see {@link UpdateLibraryItemCommandOutput} for command's `response` shape.
73
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
74
+ *
75
+ * @throws {@link AccessDeniedException} (client fault)
76
+ * <p>The client is not authorized to perform the requested operation.</p>
77
+ *
78
+ * @throws {@link InternalServerException} (server fault)
79
+ * <p>An internal service error occurred while processing the request.</p>
80
+ *
81
+ * @throws {@link ResourceNotFoundException} (client fault)
82
+ * <p>The requested resource could not be found.</p>
83
+ *
84
+ * @throws {@link ThrottlingException} (client fault)
85
+ * <p>The requested operation could not be completed because too many
86
+ * requests were sent at once. Wait a bit and try again later.</p>
87
+ *
88
+ * @throws {@link UnauthorizedException} (client fault)
89
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
90
+ *
91
+ * @throws {@link ValidationException} (client fault)
92
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
93
+ *
94
+ * @throws {@link QAppsServiceException}
95
+ * <p>Base exception class for all service exceptions from QApps service.</p>
96
+ *
97
+ * @public
98
+ */
99
+ export declare class UpdateLibraryItemCommand extends UpdateLibraryItemCommand_base {
100
+ }
@@ -0,0 +1,216 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UpdateQAppInput, UpdateQAppOutput } from "../models/models_0";
4
+ import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateQAppCommand}.
14
+ */
15
+ export interface UpdateQAppCommandInput extends UpdateQAppInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateQAppCommand}.
21
+ */
22
+ export interface UpdateQAppCommandOutput extends UpdateQAppOutput, __MetadataBearer {
23
+ }
24
+ declare const UpdateQAppCommand_base: {
25
+ new (input: UpdateQAppCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppCommandInput, UpdateQAppCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateQAppCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppCommandInput, UpdateQAppCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, UpdateQAppCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, UpdateQAppCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // UpdateQAppInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * appId: "STRING_VALUE", // required
40
+ * title: "STRING_VALUE",
41
+ * description: "STRING_VALUE",
42
+ * appDefinition: { // AppDefinitionInput
43
+ * cards: [ // CardList // required
44
+ * { // CardInput Union: only one key present
45
+ * textInput: { // TextInputCardInput
46
+ * title: "STRING_VALUE", // required
47
+ * id: "STRING_VALUE", // required
48
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
49
+ * placeholder: "STRING_VALUE",
50
+ * defaultValue: "STRING_VALUE",
51
+ * },
52
+ * qQuery: { // QQueryCardInput
53
+ * title: "STRING_VALUE", // required
54
+ * id: "STRING_VALUE", // required
55
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
56
+ * prompt: "STRING_VALUE", // required
57
+ * outputSource: "approved-sources" || "llm",
58
+ * attributeFilter: { // AttributeFilter
59
+ * andAllFilters: [ // AttributeFilters
60
+ * {
61
+ * andAllFilters: [
62
+ * "<AttributeFilter>",
63
+ * ],
64
+ * orAllFilters: [
65
+ * "<AttributeFilter>",
66
+ * ],
67
+ * notFilter: "<AttributeFilter>",
68
+ * equalsTo: { // DocumentAttribute
69
+ * name: "STRING_VALUE", // required
70
+ * value: { // DocumentAttributeValue Union: only one key present
71
+ * stringValue: "STRING_VALUE",
72
+ * stringListValue: [ // DocumentAttributeStringListValue
73
+ * "STRING_VALUE",
74
+ * ],
75
+ * longValue: Number("long"),
76
+ * dateValue: new Date("TIMESTAMP"),
77
+ * },
78
+ * },
79
+ * containsAll: {
80
+ * name: "STRING_VALUE", // required
81
+ * value: {// Union: only one key present
82
+ * stringValue: "STRING_VALUE",
83
+ * stringListValue: [
84
+ * "STRING_VALUE",
85
+ * ],
86
+ * longValue: Number("long"),
87
+ * dateValue: new Date("TIMESTAMP"),
88
+ * },
89
+ * },
90
+ * containsAny: {
91
+ * name: "STRING_VALUE", // required
92
+ * value: {// Union: only one key present
93
+ * stringValue: "STRING_VALUE",
94
+ * stringListValue: [
95
+ * "STRING_VALUE",
96
+ * ],
97
+ * longValue: Number("long"),
98
+ * dateValue: new Date("TIMESTAMP"),
99
+ * },
100
+ * },
101
+ * greaterThan: {
102
+ * name: "STRING_VALUE", // required
103
+ * value: {// Union: only one key present
104
+ * stringValue: "STRING_VALUE",
105
+ * stringListValue: [
106
+ * "STRING_VALUE",
107
+ * ],
108
+ * longValue: Number("long"),
109
+ * dateValue: new Date("TIMESTAMP"),
110
+ * },
111
+ * },
112
+ * greaterThanOrEquals: {
113
+ * name: "STRING_VALUE", // required
114
+ * value: {// Union: only one key present
115
+ * stringValue: "STRING_VALUE",
116
+ * stringListValue: [
117
+ * "STRING_VALUE",
118
+ * ],
119
+ * longValue: Number("long"),
120
+ * dateValue: new Date("TIMESTAMP"),
121
+ * },
122
+ * },
123
+ * lessThan: "<DocumentAttribute>",
124
+ * lessThanOrEquals: "<DocumentAttribute>",
125
+ * },
126
+ * ],
127
+ * orAllFilters: [
128
+ * "<AttributeFilter>",
129
+ * ],
130
+ * notFilter: "<AttributeFilter>",
131
+ * equalsTo: "<DocumentAttribute>",
132
+ * containsAll: "<DocumentAttribute>",
133
+ * containsAny: "<DocumentAttribute>",
134
+ * greaterThan: "<DocumentAttribute>",
135
+ * greaterThanOrEquals: "<DocumentAttribute>",
136
+ * lessThan: "<DocumentAttribute>",
137
+ * lessThanOrEquals: "<DocumentAttribute>",
138
+ * },
139
+ * },
140
+ * qPlugin: { // QPluginCardInput
141
+ * title: "STRING_VALUE", // required
142
+ * id: "STRING_VALUE", // required
143
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
144
+ * prompt: "STRING_VALUE", // required
145
+ * pluginId: "STRING_VALUE", // required
146
+ * },
147
+ * fileUpload: { // FileUploadCardInput
148
+ * title: "STRING_VALUE", // required
149
+ * id: "STRING_VALUE", // required
150
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
151
+ * filename: "STRING_VALUE",
152
+ * fileId: "STRING_VALUE",
153
+ * allowOverride: true || false,
154
+ * },
155
+ * },
156
+ * ],
157
+ * initialPrompt: "STRING_VALUE",
158
+ * },
159
+ * };
160
+ * const command = new UpdateQAppCommand(input);
161
+ * const response = await client.send(command);
162
+ * // { // UpdateQAppOutput
163
+ * // appId: "STRING_VALUE", // required
164
+ * // appArn: "STRING_VALUE", // required
165
+ * // title: "STRING_VALUE", // required
166
+ * // description: "STRING_VALUE",
167
+ * // initialPrompt: "STRING_VALUE",
168
+ * // appVersion: Number("int"), // required
169
+ * // status: "PUBLISHED" || "DRAFT" || "DELETED", // required
170
+ * // createdAt: new Date("TIMESTAMP"), // required
171
+ * // createdBy: "STRING_VALUE", // required
172
+ * // updatedAt: new Date("TIMESTAMP"), // required
173
+ * // updatedBy: "STRING_VALUE", // required
174
+ * // requiredCapabilities: [ // AppRequiredCapabilities
175
+ * // "FileUpload" || "CreatorMode" || "RetrievalMode" || "PluginMode",
176
+ * // ],
177
+ * // };
178
+ *
179
+ * ```
180
+ *
181
+ * @param UpdateQAppCommandInput - {@link UpdateQAppCommandInput}
182
+ * @returns {@link UpdateQAppCommandOutput}
183
+ * @see {@link UpdateQAppCommandInput} for command's `input` shape.
184
+ * @see {@link UpdateQAppCommandOutput} for command's `response` shape.
185
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
186
+ *
187
+ * @throws {@link AccessDeniedException} (client fault)
188
+ * <p>The client is not authorized to perform the requested operation.</p>
189
+ *
190
+ * @throws {@link ContentTooLargeException} (client fault)
191
+ * <p>The requested operation could not be completed because
192
+ * the content exceeds the maximum allowed size.</p>
193
+ *
194
+ * @throws {@link InternalServerException} (server fault)
195
+ * <p>An internal service error occurred while processing the request.</p>
196
+ *
197
+ * @throws {@link ResourceNotFoundException} (client fault)
198
+ * <p>The requested resource could not be found.</p>
199
+ *
200
+ * @throws {@link ThrottlingException} (client fault)
201
+ * <p>The requested operation could not be completed because too many
202
+ * requests were sent at once. Wait a bit and try again later.</p>
203
+ *
204
+ * @throws {@link UnauthorizedException} (client fault)
205
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
206
+ *
207
+ * @throws {@link ValidationException} (client fault)
208
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
209
+ *
210
+ * @throws {@link QAppsServiceException}
211
+ * <p>Base exception class for all service exceptions from QApps service.</p>
212
+ *
213
+ * @public
214
+ */
215
+ export declare class UpdateQAppCommand extends UpdateQAppCommand_base {
216
+ }