@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,82 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DisassociateLibraryItemReviewInput } 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 DisassociateLibraryItemReviewCommand}.
14
+ */
15
+ export interface DisassociateLibraryItemReviewCommandInput extends DisassociateLibraryItemReviewInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DisassociateLibraryItemReviewCommand}.
21
+ */
22
+ export interface DisassociateLibraryItemReviewCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const DisassociateLibraryItemReviewCommand_base: {
25
+ new (input: DisassociateLibraryItemReviewCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateLibraryItemReviewCommandInput, DisassociateLibraryItemReviewCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DisassociateLibraryItemReviewCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateLibraryItemReviewCommandInput, DisassociateLibraryItemReviewCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Removes a rating or review previously submitted by the user for a library item.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, DisassociateLibraryItemReviewCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, DisassociateLibraryItemReviewCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // DisassociateLibraryItemReviewInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * libraryItemId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DisassociateLibraryItemReviewCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DisassociateLibraryItemReviewCommandInput - {@link DisassociateLibraryItemReviewCommandInput}
48
+ * @returns {@link DisassociateLibraryItemReviewCommandOutput}
49
+ * @see {@link DisassociateLibraryItemReviewCommandInput} for command's `input` shape.
50
+ * @see {@link DisassociateLibraryItemReviewCommandOutput} for command's `response` shape.
51
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
52
+ *
53
+ * @throws {@link AccessDeniedException} (client fault)
54
+ * <p>The client is not authorized to perform the requested operation.</p>
55
+ *
56
+ * @throws {@link InternalServerException} (server fault)
57
+ * <p>An internal service error occurred while processing the request.</p>
58
+ *
59
+ * @throws {@link ResourceNotFoundException} (client fault)
60
+ * <p>The requested resource could not be found.</p>
61
+ *
62
+ * @throws {@link ServiceQuotaExceededException} (client fault)
63
+ * <p>The requested operation could not be completed because
64
+ * it would exceed the service's quota or limit.</p>
65
+ *
66
+ * @throws {@link ThrottlingException} (client fault)
67
+ * <p>The requested operation could not be completed because too many
68
+ * requests were sent at once. Wait a bit and try again later.</p>
69
+ *
70
+ * @throws {@link UnauthorizedException} (client fault)
71
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
72
+ *
73
+ * @throws {@link ValidationException} (client fault)
74
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
75
+ *
76
+ * @throws {@link QAppsServiceException}
77
+ * <p>Base exception class for all service exceptions from QApps service.</p>
78
+ *
79
+ * @public
80
+ */
81
+ export declare class DisassociateLibraryItemReviewCommand extends DisassociateLibraryItemReviewCommand_base {
82
+ }
@@ -0,0 +1,79 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DisassociateQAppFromUserInput } 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 DisassociateQAppFromUserCommand}.
14
+ */
15
+ export interface DisassociateQAppFromUserCommandInput extends DisassociateQAppFromUserInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DisassociateQAppFromUserCommand}.
21
+ */
22
+ export interface DisassociateQAppFromUserCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const DisassociateQAppFromUserCommand_base: {
25
+ new (input: DisassociateQAppFromUserCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateQAppFromUserCommandInput, DisassociateQAppFromUserCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DisassociateQAppFromUserCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateQAppFromUserCommandInput, DisassociateQAppFromUserCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Disassociates a Q App from a user removing the user's access to run the
31
+ * Q App.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { QAppsClient, DisassociateQAppFromUserCommand } from "@aws-sdk/client-qapps"; // ES Modules import
36
+ * // const { QAppsClient, DisassociateQAppFromUserCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
37
+ * const client = new QAppsClient(config);
38
+ * const input = { // DisassociateQAppFromUserInput
39
+ * instanceId: "STRING_VALUE", // required
40
+ * appId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new DisassociateQAppFromUserCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param DisassociateQAppFromUserCommandInput - {@link DisassociateQAppFromUserCommandInput}
49
+ * @returns {@link DisassociateQAppFromUserCommandOutput}
50
+ * @see {@link DisassociateQAppFromUserCommandInput} for command's `input` shape.
51
+ * @see {@link DisassociateQAppFromUserCommandOutput} for command's `response` shape.
52
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p>The client is not authorized to perform the requested operation.</p>
56
+ *
57
+ * @throws {@link InternalServerException} (server fault)
58
+ * <p>An internal service error occurred while processing the request.</p>
59
+ *
60
+ * @throws {@link ResourceNotFoundException} (client fault)
61
+ * <p>The requested resource could not be found.</p>
62
+ *
63
+ * @throws {@link ThrottlingException} (client fault)
64
+ * <p>The requested operation could not be completed because too many
65
+ * requests were sent at once. Wait a bit and try again later.</p>
66
+ *
67
+ * @throws {@link UnauthorizedException} (client fault)
68
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
69
+ *
70
+ * @throws {@link ValidationException} (client fault)
71
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
72
+ *
73
+ * @throws {@link QAppsServiceException}
74
+ * <p>Base exception class for all service exceptions from QApps service.</p>
75
+ *
76
+ * @public
77
+ */
78
+ export declare class DisassociateQAppFromUserCommand extends DisassociateQAppFromUserCommand_base {
79
+ }
@@ -0,0 +1,98 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetLibraryItemInput, GetLibraryItemOutput } 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 GetLibraryItemCommand}.
14
+ */
15
+ export interface GetLibraryItemCommandInput extends GetLibraryItemInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetLibraryItemCommand}.
21
+ */
22
+ export interface GetLibraryItemCommandOutput extends GetLibraryItemOutput, __MetadataBearer {
23
+ }
24
+ declare const GetLibraryItemCommand_base: {
25
+ new (input: GetLibraryItemCommandInput): import("@smithy/smithy-client").CommandImpl<GetLibraryItemCommandInput, GetLibraryItemCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetLibraryItemCommandInput): import("@smithy/smithy-client").CommandImpl<GetLibraryItemCommandInput, GetLibraryItemCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves details about a library item for an Amazon Q App, including its metadata,
31
+ * categories, ratings, and usage statistics.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { QAppsClient, GetLibraryItemCommand } from "@aws-sdk/client-qapps"; // ES Modules import
36
+ * // const { QAppsClient, GetLibraryItemCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
37
+ * const client = new QAppsClient(config);
38
+ * const input = { // GetLibraryItemInput
39
+ * instanceId: "STRING_VALUE", // required
40
+ * libraryItemId: "STRING_VALUE", // required
41
+ * appId: "STRING_VALUE",
42
+ * };
43
+ * const command = new GetLibraryItemCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // GetLibraryItemOutput
46
+ * // libraryItemId: "STRING_VALUE", // required
47
+ * // appId: "STRING_VALUE", // required
48
+ * // appVersion: Number("int"), // required
49
+ * // categories: [ // CategoryList // required
50
+ * // { // Category
51
+ * // id: "STRING_VALUE", // required
52
+ * // title: "STRING_VALUE", // required
53
+ * // },
54
+ * // ],
55
+ * // status: "STRING_VALUE", // required
56
+ * // createdAt: new Date("TIMESTAMP"), // required
57
+ * // createdBy: "STRING_VALUE", // required
58
+ * // updatedAt: new Date("TIMESTAMP"),
59
+ * // updatedBy: "STRING_VALUE",
60
+ * // ratingCount: Number("int"), // required
61
+ * // isRatedByUser: true || false,
62
+ * // userCount: Number("int"),
63
+ * // };
64
+ *
65
+ * ```
66
+ *
67
+ * @param GetLibraryItemCommandInput - {@link GetLibraryItemCommandInput}
68
+ * @returns {@link GetLibraryItemCommandOutput}
69
+ * @see {@link GetLibraryItemCommandInput} for command's `input` shape.
70
+ * @see {@link GetLibraryItemCommandOutput} for command's `response` shape.
71
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
72
+ *
73
+ * @throws {@link AccessDeniedException} (client fault)
74
+ * <p>The client is not authorized to perform the requested operation.</p>
75
+ *
76
+ * @throws {@link InternalServerException} (server fault)
77
+ * <p>An internal service error occurred while processing the request.</p>
78
+ *
79
+ * @throws {@link ResourceNotFoundException} (client fault)
80
+ * <p>The requested resource could not be found.</p>
81
+ *
82
+ * @throws {@link ThrottlingException} (client fault)
83
+ * <p>The requested operation could not be completed because too many
84
+ * requests were sent at once. Wait a bit and try again later.</p>
85
+ *
86
+ * @throws {@link UnauthorizedException} (client fault)
87
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
88
+ *
89
+ * @throws {@link ValidationException} (client fault)
90
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
91
+ *
92
+ * @throws {@link QAppsServiceException}
93
+ * <p>Base exception class for all service exceptions from QApps service.</p>
94
+ *
95
+ * @public
96
+ */
97
+ export declare class GetLibraryItemCommand extends GetLibraryItemCommand_base {
98
+ }
@@ -0,0 +1,224 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetQAppInput, GetQAppOutput } 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 GetQAppCommand}.
14
+ */
15
+ export interface GetQAppCommandInput extends GetQAppInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetQAppCommand}.
21
+ */
22
+ export interface GetQAppCommandOutput extends GetQAppOutput, __MetadataBearer {
23
+ }
24
+ declare const GetQAppCommand_base: {
25
+ new (input: GetQAppCommandInput): import("@smithy/smithy-client").CommandImpl<GetQAppCommandInput, GetQAppCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetQAppCommandInput): import("@smithy/smithy-client").CommandImpl<GetQAppCommandInput, GetQAppCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves the full details of an Q App, including its definition specifying the cards and flow.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, GetQAppCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, GetQAppCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // GetQAppInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * appId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetQAppCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetQAppOutput
44
+ * // appId: "STRING_VALUE", // required
45
+ * // appArn: "STRING_VALUE", // required
46
+ * // title: "STRING_VALUE", // required
47
+ * // description: "STRING_VALUE",
48
+ * // initialPrompt: "STRING_VALUE",
49
+ * // appVersion: Number("int"), // required
50
+ * // status: "PUBLISHED" || "DRAFT" || "DELETED", // required
51
+ * // createdAt: new Date("TIMESTAMP"), // required
52
+ * // createdBy: "STRING_VALUE", // required
53
+ * // updatedAt: new Date("TIMESTAMP"), // required
54
+ * // updatedBy: "STRING_VALUE", // required
55
+ * // requiredCapabilities: [ // AppRequiredCapabilities
56
+ * // "FileUpload" || "CreatorMode" || "RetrievalMode" || "PluginMode",
57
+ * // ],
58
+ * // appDefinition: { // AppDefinition
59
+ * // appDefinitionVersion: "STRING_VALUE", // required
60
+ * // cards: [ // CardModelList // required
61
+ * // { // Card Union: only one key present
62
+ * // textInput: { // TextInputCard
63
+ * // id: "STRING_VALUE", // required
64
+ * // title: "STRING_VALUE", // required
65
+ * // dependencies: [ // DependencyList // required
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
69
+ * // placeholder: "STRING_VALUE",
70
+ * // defaultValue: "STRING_VALUE",
71
+ * // },
72
+ * // qQuery: { // QQueryCard
73
+ * // id: "STRING_VALUE", // required
74
+ * // title: "STRING_VALUE", // required
75
+ * // dependencies: [ // required
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
79
+ * // prompt: "STRING_VALUE", // required
80
+ * // outputSource: "approved-sources" || "llm", // required
81
+ * // attributeFilter: { // AttributeFilter
82
+ * // andAllFilters: [ // AttributeFilters
83
+ * // {
84
+ * // andAllFilters: [
85
+ * // "<AttributeFilter>",
86
+ * // ],
87
+ * // orAllFilters: [
88
+ * // "<AttributeFilter>",
89
+ * // ],
90
+ * // notFilter: "<AttributeFilter>",
91
+ * // equalsTo: { // DocumentAttribute
92
+ * // name: "STRING_VALUE", // required
93
+ * // value: { // DocumentAttributeValue Union: only one key present
94
+ * // stringValue: "STRING_VALUE",
95
+ * // stringListValue: [ // DocumentAttributeStringListValue
96
+ * // "STRING_VALUE",
97
+ * // ],
98
+ * // longValue: Number("long"),
99
+ * // dateValue: new Date("TIMESTAMP"),
100
+ * // },
101
+ * // },
102
+ * // containsAll: {
103
+ * // name: "STRING_VALUE", // required
104
+ * // value: {// Union: only one key present
105
+ * // stringValue: "STRING_VALUE",
106
+ * // stringListValue: [
107
+ * // "STRING_VALUE",
108
+ * // ],
109
+ * // longValue: Number("long"),
110
+ * // dateValue: new Date("TIMESTAMP"),
111
+ * // },
112
+ * // },
113
+ * // containsAny: {
114
+ * // name: "STRING_VALUE", // required
115
+ * // value: {// Union: only one key present
116
+ * // stringValue: "STRING_VALUE",
117
+ * // stringListValue: [
118
+ * // "STRING_VALUE",
119
+ * // ],
120
+ * // longValue: Number("long"),
121
+ * // dateValue: new Date("TIMESTAMP"),
122
+ * // },
123
+ * // },
124
+ * // greaterThan: {
125
+ * // name: "STRING_VALUE", // required
126
+ * // value: {// Union: only one key present
127
+ * // stringValue: "STRING_VALUE",
128
+ * // stringListValue: [
129
+ * // "STRING_VALUE",
130
+ * // ],
131
+ * // longValue: Number("long"),
132
+ * // dateValue: new Date("TIMESTAMP"),
133
+ * // },
134
+ * // },
135
+ * // greaterThanOrEquals: {
136
+ * // name: "STRING_VALUE", // required
137
+ * // value: {// Union: only one key present
138
+ * // stringValue: "STRING_VALUE",
139
+ * // stringListValue: [
140
+ * // "STRING_VALUE",
141
+ * // ],
142
+ * // longValue: Number("long"),
143
+ * // dateValue: new Date("TIMESTAMP"),
144
+ * // },
145
+ * // },
146
+ * // lessThan: "<DocumentAttribute>",
147
+ * // lessThanOrEquals: "<DocumentAttribute>",
148
+ * // },
149
+ * // ],
150
+ * // orAllFilters: [
151
+ * // "<AttributeFilter>",
152
+ * // ],
153
+ * // notFilter: "<AttributeFilter>",
154
+ * // equalsTo: "<DocumentAttribute>",
155
+ * // containsAll: "<DocumentAttribute>",
156
+ * // containsAny: "<DocumentAttribute>",
157
+ * // greaterThan: "<DocumentAttribute>",
158
+ * // greaterThanOrEquals: "<DocumentAttribute>",
159
+ * // lessThan: "<DocumentAttribute>",
160
+ * // lessThanOrEquals: "<DocumentAttribute>",
161
+ * // },
162
+ * // },
163
+ * // qPlugin: { // QPluginCard
164
+ * // id: "STRING_VALUE", // required
165
+ * // title: "STRING_VALUE", // required
166
+ * // dependencies: [ // required
167
+ * // "STRING_VALUE",
168
+ * // ],
169
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
170
+ * // prompt: "STRING_VALUE", // required
171
+ * // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM", // required
172
+ * // pluginId: "STRING_VALUE", // required
173
+ * // },
174
+ * // fileUpload: { // FileUploadCard
175
+ * // id: "STRING_VALUE", // required
176
+ * // title: "STRING_VALUE", // required
177
+ * // dependencies: [ // required
178
+ * // "STRING_VALUE",
179
+ * // ],
180
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
181
+ * // filename: "STRING_VALUE",
182
+ * // fileId: "STRING_VALUE",
183
+ * // allowOverride: true || false,
184
+ * // },
185
+ * // },
186
+ * // ],
187
+ * // canEdit: true || false,
188
+ * // },
189
+ * // };
190
+ *
191
+ * ```
192
+ *
193
+ * @param GetQAppCommandInput - {@link GetQAppCommandInput}
194
+ * @returns {@link GetQAppCommandOutput}
195
+ * @see {@link GetQAppCommandInput} for command's `input` shape.
196
+ * @see {@link GetQAppCommandOutput} for command's `response` shape.
197
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
198
+ *
199
+ * @throws {@link AccessDeniedException} (client fault)
200
+ * <p>The client is not authorized to perform the requested operation.</p>
201
+ *
202
+ * @throws {@link InternalServerException} (server fault)
203
+ * <p>An internal service error occurred while processing the request.</p>
204
+ *
205
+ * @throws {@link ResourceNotFoundException} (client fault)
206
+ * <p>The requested resource could not be found.</p>
207
+ *
208
+ * @throws {@link ThrottlingException} (client fault)
209
+ * <p>The requested operation could not be completed because too many
210
+ * requests were sent at once. Wait a bit and try again later.</p>
211
+ *
212
+ * @throws {@link UnauthorizedException} (client fault)
213
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
214
+ *
215
+ * @throws {@link ValidationException} (client fault)
216
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
217
+ *
218
+ * @throws {@link QAppsServiceException}
219
+ * <p>Base exception class for all service exceptions from QApps service.</p>
220
+ *
221
+ * @public
222
+ */
223
+ export declare class GetQAppCommand extends GetQAppCommand_base {
224
+ }
@@ -0,0 +1,92 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetQAppSessionInput, GetQAppSessionOutput } 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 GetQAppSessionCommand}.
14
+ */
15
+ export interface GetQAppSessionCommandInput extends GetQAppSessionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetQAppSessionCommand}.
21
+ */
22
+ export interface GetQAppSessionCommandOutput extends GetQAppSessionOutput, __MetadataBearer {
23
+ }
24
+ declare const GetQAppSessionCommand_base: {
25
+ new (input: GetQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetQAppSessionCommandInput, GetQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetQAppSessionCommandInput, GetQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves the current state and results for an active session of 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, GetQAppSessionCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, GetQAppSessionCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // GetQAppSessionInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * sessionId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetQAppSessionCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetQAppSessionOutput
44
+ * // sessionId: "STRING_VALUE", // required
45
+ * // sessionArn: "STRING_VALUE", // required
46
+ * // status: "IN_PROGRESS" || "WAITING" || "COMPLETED", // required
47
+ * // cardStatus: { // CardStatusMap // required
48
+ * // "<keys>": { // CardStatus
49
+ * // currentState: "IN_PROGRESS" || "WAITING" || "COMPLETED", // required
50
+ * // currentValue: "STRING_VALUE", // required
51
+ * // },
52
+ * // },
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param GetQAppSessionCommandInput - {@link GetQAppSessionCommandInput}
58
+ * @returns {@link GetQAppSessionCommandOutput}
59
+ * @see {@link GetQAppSessionCommandInput} for command's `input` shape.
60
+ * @see {@link GetQAppSessionCommandOutput} for command's `response` shape.
61
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
62
+ *
63
+ * @throws {@link AccessDeniedException} (client fault)
64
+ * <p>The client is not authorized to perform the requested operation.</p>
65
+ *
66
+ * @throws {@link InternalServerException} (server fault)
67
+ * <p>An internal service error occurred while processing the request.</p>
68
+ *
69
+ * @throws {@link ResourceNotFoundException} (client fault)
70
+ * <p>The requested resource could not be found.</p>
71
+ *
72
+ * @throws {@link ServiceQuotaExceededException} (client fault)
73
+ * <p>The requested operation could not be completed because
74
+ * it would exceed the service's quota or limit.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>The requested operation could not be completed because too many
78
+ * requests were sent at once. Wait a bit and try again later.</p>
79
+ *
80
+ * @throws {@link UnauthorizedException} (client fault)
81
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
82
+ *
83
+ * @throws {@link ValidationException} (client fault)
84
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
85
+ *
86
+ * @throws {@link QAppsServiceException}
87
+ * <p>Base exception class for all service exceptions from QApps service.</p>
88
+ *
89
+ * @public
90
+ */
91
+ export declare class GetQAppSessionCommand extends GetQAppSessionCommand_base {
92
+ }