@aws-sdk/client-qapps 3.699.0 → 3.702.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 (55) hide show
  1. package/README.md +56 -0
  2. package/dist-cjs/QApps.js +14 -0
  3. package/dist-cjs/commands/CreatePresignedUrlCommand.js +26 -0
  4. package/dist-cjs/commands/DescribeQAppPermissionsCommand.js +26 -0
  5. package/dist-cjs/commands/ExportQAppSessionDataCommand.js +26 -0
  6. package/dist-cjs/commands/GetQAppSessionMetadataCommand.js +26 -0
  7. package/dist-cjs/commands/ListQAppSessionDataCommand.js +26 -0
  8. package/dist-cjs/commands/UpdateQAppPermissionsCommand.js +26 -0
  9. package/dist-cjs/commands/UpdateQAppSessionMetadataCommand.js +26 -0
  10. package/dist-cjs/commands/index.js +7 -0
  11. package/dist-cjs/models/models_0.js +24 -1
  12. package/dist-cjs/protocols/Aws_restJson1.js +352 -3
  13. package/dist-es/QApps.js +14 -0
  14. package/dist-es/commands/CreatePresignedUrlCommand.js +22 -0
  15. package/dist-es/commands/DescribeQAppPermissionsCommand.js +22 -0
  16. package/dist-es/commands/ExportQAppSessionDataCommand.js +22 -0
  17. package/dist-es/commands/GetQAppSessionMetadataCommand.js +22 -0
  18. package/dist-es/commands/ListQAppSessionDataCommand.js +22 -0
  19. package/dist-es/commands/UpdateQAppPermissionsCommand.js +22 -0
  20. package/dist-es/commands/UpdateQAppSessionMetadataCommand.js +22 -0
  21. package/dist-es/commands/index.js +7 -0
  22. package/dist-es/models/models_0.js +23 -0
  23. package/dist-es/protocols/Aws_restJson1.js +336 -1
  24. package/dist-types/QApps.d.ts +49 -0
  25. package/dist-types/QAppsClient.d.ts +9 -2
  26. package/dist-types/commands/CreatePresignedUrlCommand.d.ts +161 -0
  27. package/dist-types/commands/CreateQAppCommand.d.ts +13 -4
  28. package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +136 -0
  29. package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +101 -0
  30. package/dist-types/commands/GetQAppCommand.d.ts +20 -4
  31. package/dist-types/commands/GetQAppSessionCommand.d.ts +13 -2
  32. package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +128 -0
  33. package/dist-types/commands/ListQAppSessionDataCommand.d.ts +108 -0
  34. package/dist-types/commands/PredictQAppCommand.d.ts +13 -4
  35. package/dist-types/commands/StartQAppSessionCommand.d.ts +5 -0
  36. package/dist-types/commands/UpdateQAppCommand.d.ts +13 -4
  37. package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +187 -0
  38. package/dist-types/commands/UpdateQAppSessionCommand.d.ts +4 -0
  39. package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +138 -0
  40. package/dist-types/commands/index.d.ts +7 -0
  41. package/dist-types/models/models_0.d.ts +704 -11
  42. package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
  43. package/dist-types/ts3.4/QApps.d.ts +119 -0
  44. package/dist-types/ts3.4/QAppsClient.d.ts +44 -2
  45. package/dist-types/ts3.4/commands/CreatePresignedUrlCommand.d.ts +51 -0
  46. package/dist-types/ts3.4/commands/DescribeQAppPermissionsCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/ExportQAppSessionDataCommand.d.ts +51 -0
  48. package/dist-types/ts3.4/commands/GetQAppSessionMetadataCommand.d.ts +51 -0
  49. package/dist-types/ts3.4/commands/ListQAppSessionDataCommand.d.ts +51 -0
  50. package/dist-types/ts3.4/commands/UpdateQAppPermissionsCommand.d.ts +51 -0
  51. package/dist-types/ts3.4/commands/UpdateQAppSessionMetadataCommand.d.ts +51 -0
  52. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  53. package/dist-types/ts3.4/models/models_0.d.ts +202 -5
  54. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
  55. package/package.json +1 -1
@@ -13,18 +13,23 @@ import { BatchCreateCategoryCommandInput, BatchCreateCategoryCommandOutput } fro
13
13
  import { BatchDeleteCategoryCommandInput, BatchDeleteCategoryCommandOutput } from "./commands/BatchDeleteCategoryCommand";
14
14
  import { BatchUpdateCategoryCommandInput, BatchUpdateCategoryCommandOutput } from "./commands/BatchUpdateCategoryCommand";
15
15
  import { CreateLibraryItemCommandInput, CreateLibraryItemCommandOutput } from "./commands/CreateLibraryItemCommand";
16
+ import { CreatePresignedUrlCommandInput, CreatePresignedUrlCommandOutput } from "./commands/CreatePresignedUrlCommand";
16
17
  import { CreateQAppCommandInput, CreateQAppCommandOutput } from "./commands/CreateQAppCommand";
17
18
  import { DeleteLibraryItemCommandInput, DeleteLibraryItemCommandOutput } from "./commands/DeleteLibraryItemCommand";
18
19
  import { DeleteQAppCommandInput, DeleteQAppCommandOutput } from "./commands/DeleteQAppCommand";
20
+ import { DescribeQAppPermissionsCommandInput, DescribeQAppPermissionsCommandOutput } from "./commands/DescribeQAppPermissionsCommand";
19
21
  import { DisassociateLibraryItemReviewCommandInput, DisassociateLibraryItemReviewCommandOutput } from "./commands/DisassociateLibraryItemReviewCommand";
20
22
  import { DisassociateQAppFromUserCommandInput, DisassociateQAppFromUserCommandOutput } from "./commands/DisassociateQAppFromUserCommand";
23
+ import { ExportQAppSessionDataCommandInput, ExportQAppSessionDataCommandOutput } from "./commands/ExportQAppSessionDataCommand";
21
24
  import { GetLibraryItemCommandInput, GetLibraryItemCommandOutput } from "./commands/GetLibraryItemCommand";
22
25
  import { GetQAppCommandInput, GetQAppCommandOutput } from "./commands/GetQAppCommand";
23
26
  import { GetQAppSessionCommandInput, GetQAppSessionCommandOutput } from "./commands/GetQAppSessionCommand";
27
+ import { GetQAppSessionMetadataCommandInput, GetQAppSessionMetadataCommandOutput } from "./commands/GetQAppSessionMetadataCommand";
24
28
  import { ImportDocumentCommandInput, ImportDocumentCommandOutput } from "./commands/ImportDocumentCommand";
25
29
  import { ListCategoriesCommandInput, ListCategoriesCommandOutput } from "./commands/ListCategoriesCommand";
26
30
  import { ListLibraryItemsCommandInput, ListLibraryItemsCommandOutput } from "./commands/ListLibraryItemsCommand";
27
31
  import { ListQAppsCommandInput, ListQAppsCommandOutput } from "./commands/ListQAppsCommand";
32
+ import { ListQAppSessionDataCommandInput, ListQAppSessionDataCommandOutput } from "./commands/ListQAppSessionDataCommand";
28
33
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
29
34
  import { PredictQAppCommandInput, PredictQAppCommandOutput } from "./commands/PredictQAppCommand";
30
35
  import { StartQAppSessionCommandInput, StartQAppSessionCommandOutput } from "./commands/StartQAppSessionCommand";
@@ -34,18 +39,20 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
34
39
  import { UpdateLibraryItemCommandInput, UpdateLibraryItemCommandOutput } from "./commands/UpdateLibraryItemCommand";
35
40
  import { UpdateLibraryItemMetadataCommandInput, UpdateLibraryItemMetadataCommandOutput } from "./commands/UpdateLibraryItemMetadataCommand";
36
41
  import { UpdateQAppCommandInput, UpdateQAppCommandOutput } from "./commands/UpdateQAppCommand";
42
+ import { UpdateQAppPermissionsCommandInput, UpdateQAppPermissionsCommandOutput } from "./commands/UpdateQAppPermissionsCommand";
37
43
  import { UpdateQAppSessionCommandInput, UpdateQAppSessionCommandOutput } from "./commands/UpdateQAppSessionCommand";
44
+ import { UpdateQAppSessionMetadataCommandInput, UpdateQAppSessionMetadataCommandOutput } from "./commands/UpdateQAppSessionMetadataCommand";
38
45
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
39
46
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
40
47
  export { __Client };
41
48
  /**
42
49
  * @public
43
50
  */
44
- export type ServiceInputTypes = AssociateLibraryItemReviewCommandInput | AssociateQAppWithUserCommandInput | BatchCreateCategoryCommandInput | BatchDeleteCategoryCommandInput | BatchUpdateCategoryCommandInput | CreateLibraryItemCommandInput | CreateQAppCommandInput | DeleteLibraryItemCommandInput | DeleteQAppCommandInput | DisassociateLibraryItemReviewCommandInput | DisassociateQAppFromUserCommandInput | GetLibraryItemCommandInput | GetQAppCommandInput | GetQAppSessionCommandInput | ImportDocumentCommandInput | ListCategoriesCommandInput | ListLibraryItemsCommandInput | ListQAppsCommandInput | ListTagsForResourceCommandInput | PredictQAppCommandInput | StartQAppSessionCommandInput | StopQAppSessionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateLibraryItemCommandInput | UpdateLibraryItemMetadataCommandInput | UpdateQAppCommandInput | UpdateQAppSessionCommandInput;
51
+ export type ServiceInputTypes = AssociateLibraryItemReviewCommandInput | AssociateQAppWithUserCommandInput | BatchCreateCategoryCommandInput | BatchDeleteCategoryCommandInput | BatchUpdateCategoryCommandInput | CreateLibraryItemCommandInput | CreatePresignedUrlCommandInput | CreateQAppCommandInput | DeleteLibraryItemCommandInput | DeleteQAppCommandInput | DescribeQAppPermissionsCommandInput | DisassociateLibraryItemReviewCommandInput | DisassociateQAppFromUserCommandInput | ExportQAppSessionDataCommandInput | GetLibraryItemCommandInput | GetQAppCommandInput | GetQAppSessionCommandInput | GetQAppSessionMetadataCommandInput | ImportDocumentCommandInput | ListCategoriesCommandInput | ListLibraryItemsCommandInput | ListQAppSessionDataCommandInput | ListQAppsCommandInput | ListTagsForResourceCommandInput | PredictQAppCommandInput | StartQAppSessionCommandInput | StopQAppSessionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateLibraryItemCommandInput | UpdateLibraryItemMetadataCommandInput | UpdateQAppCommandInput | UpdateQAppPermissionsCommandInput | UpdateQAppSessionCommandInput | UpdateQAppSessionMetadataCommandInput;
45
52
  /**
46
53
  * @public
47
54
  */
48
- export type ServiceOutputTypes = AssociateLibraryItemReviewCommandOutput | AssociateQAppWithUserCommandOutput | BatchCreateCategoryCommandOutput | BatchDeleteCategoryCommandOutput | BatchUpdateCategoryCommandOutput | CreateLibraryItemCommandOutput | CreateQAppCommandOutput | DeleteLibraryItemCommandOutput | DeleteQAppCommandOutput | DisassociateLibraryItemReviewCommandOutput | DisassociateQAppFromUserCommandOutput | GetLibraryItemCommandOutput | GetQAppCommandOutput | GetQAppSessionCommandOutput | ImportDocumentCommandOutput | ListCategoriesCommandOutput | ListLibraryItemsCommandOutput | ListQAppsCommandOutput | ListTagsForResourceCommandOutput | PredictQAppCommandOutput | StartQAppSessionCommandOutput | StopQAppSessionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateLibraryItemCommandOutput | UpdateLibraryItemMetadataCommandOutput | UpdateQAppCommandOutput | UpdateQAppSessionCommandOutput;
55
+ export type ServiceOutputTypes = AssociateLibraryItemReviewCommandOutput | AssociateQAppWithUserCommandOutput | BatchCreateCategoryCommandOutput | BatchDeleteCategoryCommandOutput | BatchUpdateCategoryCommandOutput | CreateLibraryItemCommandOutput | CreatePresignedUrlCommandOutput | CreateQAppCommandOutput | DeleteLibraryItemCommandOutput | DeleteQAppCommandOutput | DescribeQAppPermissionsCommandOutput | DisassociateLibraryItemReviewCommandOutput | DisassociateQAppFromUserCommandOutput | ExportQAppSessionDataCommandOutput | GetLibraryItemCommandOutput | GetQAppCommandOutput | GetQAppSessionCommandOutput | GetQAppSessionMetadataCommandOutput | ImportDocumentCommandOutput | ListCategoriesCommandOutput | ListLibraryItemsCommandOutput | ListQAppSessionDataCommandOutput | ListQAppsCommandOutput | ListTagsForResourceCommandOutput | PredictQAppCommandOutput | StartQAppSessionCommandOutput | StopQAppSessionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateLibraryItemCommandOutput | UpdateLibraryItemMetadataCommandOutput | UpdateQAppCommandOutput | UpdateQAppPermissionsCommandOutput | UpdateQAppSessionCommandOutput | UpdateQAppSessionMetadataCommandOutput;
49
56
  /**
50
57
  * @public
51
58
  */
@@ -0,0 +1,161 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CreatePresignedUrlInput, CreatePresignedUrlOutput } 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 CreatePresignedUrlCommand}.
14
+ */
15
+ export interface CreatePresignedUrlCommandInput extends CreatePresignedUrlInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreatePresignedUrlCommand}.
21
+ */
22
+ export interface CreatePresignedUrlCommandOutput extends CreatePresignedUrlOutput, __MetadataBearer {
23
+ }
24
+ declare const CreatePresignedUrlCommand_base: {
25
+ new (input: CreatePresignedUrlCommandInput): import("@smithy/smithy-client").CommandImpl<CreatePresignedUrlCommandInput, CreatePresignedUrlCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreatePresignedUrlCommandInput): import("@smithy/smithy-client").CommandImpl<CreatePresignedUrlCommandInput, CreatePresignedUrlCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a presigned URL for an S3 POST operation to upload a file.
31
+ * You can use this URL to set a default file for a <code>FileUploadCard</code>
32
+ * in a Q App definition or to provide a file for a single Q App run.
33
+ * The <code>scope</code> parameter determines how the file will be used,
34
+ * either at the app definition level or the app session level.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { QAppsClient, CreatePresignedUrlCommand } from "@aws-sdk/client-qapps"; // ES Modules import
39
+ * // const { QAppsClient, CreatePresignedUrlCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
40
+ * const client = new QAppsClient(config);
41
+ * const input = { // CreatePresignedUrlInput
42
+ * instanceId: "STRING_VALUE", // required
43
+ * cardId: "STRING_VALUE", // required
44
+ * appId: "STRING_VALUE", // required
45
+ * fileContentsSha256: "STRING_VALUE", // required
46
+ * fileName: "STRING_VALUE", // required
47
+ * scope: "APPLICATION" || "SESSION", // required
48
+ * sessionId: "STRING_VALUE",
49
+ * };
50
+ * const command = new CreatePresignedUrlCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // CreatePresignedUrlOutput
53
+ * // fileId: "STRING_VALUE", // required
54
+ * // presignedUrl: "STRING_VALUE", // required
55
+ * // presignedUrlFields: { // PresignedUrlFields // required
56
+ * // "<keys>": "STRING_VALUE",
57
+ * // },
58
+ * // presignedUrlExpiration: new Date("TIMESTAMP"), // required
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param CreatePresignedUrlCommandInput - {@link CreatePresignedUrlCommandInput}
64
+ * @returns {@link CreatePresignedUrlCommandOutput}
65
+ * @see {@link CreatePresignedUrlCommandInput} for command's `input` shape.
66
+ * @see {@link CreatePresignedUrlCommandOutput} for command's `response` shape.
67
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
68
+ *
69
+ * @throws {@link AccessDeniedException} (client fault)
70
+ * <p>The client is not authorized to perform the requested operation.</p>
71
+ *
72
+ * @throws {@link InternalServerException} (server fault)
73
+ * <p>An internal service error occurred while processing the request.</p>
74
+ *
75
+ * @throws {@link ThrottlingException} (client fault)
76
+ * <p>The requested operation could not be completed because too many
77
+ * requests were sent at once. Wait a bit and try again later.</p>
78
+ *
79
+ * @throws {@link UnauthorizedException} (client fault)
80
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
84
+ *
85
+ * @throws {@link QAppsServiceException}
86
+ * <p>Base exception class for all service exceptions from QApps service.</p>
87
+ *
88
+ * @public
89
+ * @example Upload a file to a specific session
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
94
+ * "cardId": "82f69028-22a9-4bea-8727-0eabf58e9fed",
95
+ * "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=",
96
+ * "fileName": "myFile.txt",
97
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
98
+ * "scope": "SESSION",
99
+ * "sessionId": "4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc"
100
+ * };
101
+ * const command = new CreatePresignedUrlCommand(input);
102
+ * const response = await client.send(command);
103
+ * /* response ==
104
+ * {
105
+ * "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
106
+ * "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/",
107
+ * "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
108
+ * "presignedUrlFields": {
109
+ * "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=",
110
+ * "x-amz-server-side-encryption": "aws:kms",
111
+ * "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
112
+ * "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9"
113
+ * }
114
+ * }
115
+ * *\/
116
+ * // example id: example-1
117
+ * ```
118
+ *
119
+ * @example Upload a file into a application
120
+ * ```javascript
121
+ * //
122
+ * const input = {
123
+ * "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
124
+ * "cardId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
125
+ * "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=",
126
+ * "fileName": "anApplicationFile.txt",
127
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
128
+ * "scope": "APPLICATION"
129
+ * };
130
+ * const command = new CreatePresignedUrlCommand(input);
131
+ * const response = await client.send(command);
132
+ * /* response ==
133
+ * {
134
+ * "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
135
+ * "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/",
136
+ * "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
137
+ * "presignedUrlFields": {
138
+ * "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=",
139
+ * "x-amz-server-side-encryption": "aws:kms",
140
+ * "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
141
+ * "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9"
142
+ * }
143
+ * }
144
+ * *\/
145
+ * // example id: example-2
146
+ * ```
147
+ *
148
+ */
149
+ export declare class CreatePresignedUrlCommand extends CreatePresignedUrlCommand_base {
150
+ /** @internal type navigation helper, not in runtime. */
151
+ protected static __types: {
152
+ api: {
153
+ input: CreatePresignedUrlInput;
154
+ output: CreatePresignedUrlOutput;
155
+ };
156
+ sdk: {
157
+ input: CreatePresignedUrlCommandInput;
158
+ output: CreatePresignedUrlCommandOutput;
159
+ };
160
+ };
161
+ }
@@ -46,14 +46,14 @@ declare const CreateQAppCommand_base: {
46
46
  * textInput: { // TextInputCardInput
47
47
  * title: "STRING_VALUE", // required
48
48
  * id: "STRING_VALUE", // required
49
- * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
49
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
50
50
  * placeholder: "STRING_VALUE",
51
51
  * defaultValue: "STRING_VALUE",
52
52
  * },
53
53
  * qQuery: { // QQueryCardInput
54
54
  * title: "STRING_VALUE", // required
55
55
  * id: "STRING_VALUE", // required
56
- * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
56
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
57
57
  * prompt: "STRING_VALUE", // required
58
58
  * outputSource: "approved-sources" || "llm",
59
59
  * attributeFilter: { // AttributeFilter
@@ -141,18 +141,27 @@ declare const CreateQAppCommand_base: {
141
141
  * qPlugin: { // QPluginCardInput
142
142
  * title: "STRING_VALUE", // required
143
143
  * id: "STRING_VALUE", // required
144
- * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
144
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
145
145
  * prompt: "STRING_VALUE", // required
146
146
  * pluginId: "STRING_VALUE", // required
147
147
  * },
148
148
  * fileUpload: { // FileUploadCardInput
149
149
  * title: "STRING_VALUE", // required
150
150
  * id: "STRING_VALUE", // required
151
- * type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
151
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
152
152
  * filename: "STRING_VALUE",
153
153
  * fileId: "STRING_VALUE",
154
154
  * allowOverride: true || false,
155
155
  * },
156
+ * formInput: { // FormInputCardInput
157
+ * title: "STRING_VALUE", // required
158
+ * id: "STRING_VALUE", // required
159
+ * type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
160
+ * metadata: { // FormInputCardMetadata
161
+ * schema: "DOCUMENT_VALUE", // required
162
+ * },
163
+ * computeMode: "append" || "replace",
164
+ * },
156
165
  * },
157
166
  * ],
158
167
  * initialPrompt: "STRING_VALUE",
@@ -0,0 +1,136 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DescribeQAppPermissionsInput, DescribeQAppPermissionsOutput } 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 DescribeQAppPermissionsCommand}.
14
+ */
15
+ export interface DescribeQAppPermissionsCommandInput extends DescribeQAppPermissionsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeQAppPermissionsCommand}.
21
+ */
22
+ export interface DescribeQAppPermissionsCommandOutput extends DescribeQAppPermissionsOutput, __MetadataBearer {
23
+ }
24
+ declare const DescribeQAppPermissionsCommand_base: {
25
+ new (input: DescribeQAppPermissionsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeQAppPermissionsCommandInput, DescribeQAppPermissionsCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DescribeQAppPermissionsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeQAppPermissionsCommandInput, DescribeQAppPermissionsCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, DescribeQAppPermissionsCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, DescribeQAppPermissionsCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // DescribeQAppPermissionsInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * appId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DescribeQAppPermissionsCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // DescribeQAppPermissionsOutput
44
+ * // resourceArn: "STRING_VALUE",
45
+ * // appId: "STRING_VALUE",
46
+ * // permissions: [ // PermissionsOutputList
47
+ * // { // PermissionOutput
48
+ * // action: "read" || "write", // required
49
+ * // principal: { // PrincipalOutput
50
+ * // userId: "STRING_VALUE",
51
+ * // userType: "owner" || "user",
52
+ * // email: "STRING_VALUE",
53
+ * // },
54
+ * // },
55
+ * // ],
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param DescribeQAppPermissionsCommandInput - {@link DescribeQAppPermissionsCommandInput}
61
+ * @returns {@link DescribeQAppPermissionsCommandOutput}
62
+ * @see {@link DescribeQAppPermissionsCommandInput} for command's `input` shape.
63
+ * @see {@link DescribeQAppPermissionsCommandOutput} for command's `response` shape.
64
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>The client is not authorized to perform the requested operation.</p>
68
+ *
69
+ * @throws {@link InternalServerException} (server fault)
70
+ * <p>An internal service error occurred while processing the request.</p>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p>The requested resource could not be found.</p>
74
+ *
75
+ * @throws {@link ThrottlingException} (client fault)
76
+ * <p>The requested operation could not be completed because too many
77
+ * requests were sent at once. Wait a bit and try again later.</p>
78
+ *
79
+ * @throws {@link UnauthorizedException} (client fault)
80
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
84
+ *
85
+ * @throws {@link QAppsServiceException}
86
+ * <p>Base exception class for all service exceptions from QApps service.</p>
87
+ *
88
+ * @public
89
+ * @example Describe permissions for the app
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
94
+ * "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
95
+ * };
96
+ * const command = new DescribeQAppPermissionsCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
101
+ * "permissions": [
102
+ * {
103
+ * "action": "write",
104
+ * "principal": {
105
+ * "email": "user1@example.com",
106
+ * "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
107
+ * }
108
+ * },
109
+ * {
110
+ * "action": "read",
111
+ * "principal": {
112
+ * "email": "user2@example.com",
113
+ * "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
114
+ * }
115
+ * }
116
+ * ],
117
+ * "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
118
+ * }
119
+ * *\/
120
+ * // example id: example-1
121
+ * ```
122
+ *
123
+ */
124
+ export declare class DescribeQAppPermissionsCommand extends DescribeQAppPermissionsCommand_base {
125
+ /** @internal type navigation helper, not in runtime. */
126
+ protected static __types: {
127
+ api: {
128
+ input: DescribeQAppPermissionsInput;
129
+ output: DescribeQAppPermissionsOutput;
130
+ };
131
+ sdk: {
132
+ input: DescribeQAppPermissionsCommandInput;
133
+ output: DescribeQAppPermissionsCommandOutput;
134
+ };
135
+ };
136
+ }
@@ -0,0 +1,101 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ExportQAppSessionDataInput, ExportQAppSessionDataOutput } 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 ExportQAppSessionDataCommand}.
14
+ */
15
+ export interface ExportQAppSessionDataCommandInput extends ExportQAppSessionDataInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ExportQAppSessionDataCommand}.
21
+ */
22
+ export interface ExportQAppSessionDataCommandOutput extends ExportQAppSessionDataOutput, __MetadataBearer {
23
+ }
24
+ declare const ExportQAppSessionDataCommand_base: {
25
+ new (input: ExportQAppSessionDataCommandInput): import("@smithy/smithy-client").CommandImpl<ExportQAppSessionDataCommandInput, ExportQAppSessionDataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ExportQAppSessionDataCommandInput): import("@smithy/smithy-client").CommandImpl<ExportQAppSessionDataCommandInput, ExportQAppSessionDataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Exports the collected data of a Q App data collection session.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, ExportQAppSessionDataCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, ExportQAppSessionDataCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // ExportQAppSessionDataInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * sessionId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new ExportQAppSessionDataCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // ExportQAppSessionDataOutput
44
+ * // csvFileLink: "STRING_VALUE", // required
45
+ * // expiresAt: new Date("TIMESTAMP"), // required
46
+ * // sessionArn: "STRING_VALUE", // required
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param ExportQAppSessionDataCommandInput - {@link ExportQAppSessionDataCommandInput}
52
+ * @returns {@link ExportQAppSessionDataCommandOutput}
53
+ * @see {@link ExportQAppSessionDataCommandInput} for command's `input` shape.
54
+ * @see {@link ExportQAppSessionDataCommandOutput} for command's `response` shape.
55
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
56
+ *
57
+ * @throws {@link AccessDeniedException} (client fault)
58
+ * <p>The client is not authorized to perform the requested operation.</p>
59
+ *
60
+ * @throws {@link ConflictException} (client fault)
61
+ * <p>The requested operation could not be completed due to a
62
+ * conflict with the current state of the resource.</p>
63
+ *
64
+ * @throws {@link InternalServerException} (server fault)
65
+ * <p>An internal service error occurred while processing the request.</p>
66
+ *
67
+ * @throws {@link ResourceNotFoundException} (client fault)
68
+ * <p>The requested resource could not be found.</p>
69
+ *
70
+ * @throws {@link ServiceQuotaExceededException} (client fault)
71
+ * <p>The requested operation could not be completed because
72
+ * it would exceed the service's quota or limit.</p>
73
+ *
74
+ * @throws {@link ThrottlingException} (client fault)
75
+ * <p>The requested operation could not be completed because too many
76
+ * requests were sent at once. Wait a bit and try again later.</p>
77
+ *
78
+ * @throws {@link UnauthorizedException} (client fault)
79
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
80
+ *
81
+ * @throws {@link ValidationException} (client fault)
82
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
83
+ *
84
+ * @throws {@link QAppsServiceException}
85
+ * <p>Base exception class for all service exceptions from QApps service.</p>
86
+ *
87
+ * @public
88
+ */
89
+ export declare class ExportQAppSessionDataCommand extends ExportQAppSessionDataCommand_base {
90
+ /** @internal type navigation helper, not in runtime. */
91
+ protected static __types: {
92
+ api: {
93
+ input: ExportQAppSessionDataInput;
94
+ output: ExportQAppSessionDataOutput;
95
+ };
96
+ sdk: {
97
+ input: ExportQAppSessionDataCommandInput;
98
+ output: ExportQAppSessionDataCommandOutput;
99
+ };
100
+ };
101
+ }
@@ -37,6 +37,7 @@ declare const GetQAppCommand_base: {
37
37
  * const input = { // GetQAppInput
38
38
  * instanceId: "STRING_VALUE", // required
39
39
  * appId: "STRING_VALUE", // required
40
+ * appVersion: Number("int"),
40
41
  * };
41
42
  * const command = new GetQAppCommand(input);
42
43
  * const response = await client.send(command);
@@ -65,7 +66,7 @@ declare const GetQAppCommand_base: {
65
66
  * // dependencies: [ // DependencyList // required
66
67
  * // "STRING_VALUE",
67
68
  * // ],
68
- * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
69
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
69
70
  * // placeholder: "STRING_VALUE",
70
71
  * // defaultValue: "STRING_VALUE",
71
72
  * // },
@@ -75,7 +76,7 @@ declare const GetQAppCommand_base: {
75
76
  * // dependencies: [ // required
76
77
  * // "STRING_VALUE",
77
78
  * // ],
78
- * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
79
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
79
80
  * // prompt: "STRING_VALUE", // required
80
81
  * // outputSource: "approved-sources" || "llm", // required
81
82
  * // attributeFilter: { // AttributeFilter
@@ -159,6 +160,9 @@ declare const GetQAppCommand_base: {
159
160
  * // lessThan: "<DocumentAttribute>",
160
161
  * // lessThanOrEquals: "<DocumentAttribute>",
161
162
  * // },
163
+ * // memoryReferences: [ // MemoryReferenceList
164
+ * // "STRING_VALUE",
165
+ * // ],
162
166
  * // },
163
167
  * // qPlugin: { // QPluginCard
164
168
  * // id: "STRING_VALUE", // required
@@ -166,7 +170,7 @@ declare const GetQAppCommand_base: {
166
170
  * // dependencies: [ // required
167
171
  * // "STRING_VALUE",
168
172
  * // ],
169
- * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
173
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
170
174
  * // prompt: "STRING_VALUE", // required
171
175
  * // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM", // required
172
176
  * // pluginId: "STRING_VALUE", // required
@@ -177,11 +181,23 @@ declare const GetQAppCommand_base: {
177
181
  * // dependencies: [ // required
178
182
  * // "STRING_VALUE",
179
183
  * // ],
180
- * // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
184
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
181
185
  * // filename: "STRING_VALUE",
182
186
  * // fileId: "STRING_VALUE",
183
187
  * // allowOverride: true || false,
184
188
  * // },
189
+ * // formInput: { // FormInputCard
190
+ * // id: "STRING_VALUE", // required
191
+ * // title: "STRING_VALUE", // required
192
+ * // dependencies: [ // required
193
+ * // "STRING_VALUE",
194
+ * // ],
195
+ * // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
196
+ * // metadata: { // FormInputCardMetadata
197
+ * // schema: "DOCUMENT_VALUE", // required
198
+ * // },
199
+ * // computeMode: "append" || "replace",
200
+ * // },
185
201
  * // },
186
202
  * // ],
187
203
  * // canEdit: true || false,
@@ -43,13 +43,24 @@ declare const GetQAppSessionCommand_base: {
43
43
  * // { // GetQAppSessionOutput
44
44
  * // sessionId: "STRING_VALUE", // required
45
45
  * // sessionArn: "STRING_VALUE", // required
46
- * // status: "IN_PROGRESS" || "WAITING" || "COMPLETED", // required
46
+ * // sessionName: "STRING_VALUE",
47
+ * // appVersion: Number("int"),
48
+ * // latestPublishedAppVersion: Number("int"),
49
+ * // status: "IN_PROGRESS" || "WAITING" || "COMPLETED" || "ERROR", // required
47
50
  * // cardStatus: { // CardStatusMap // required
48
51
  * // "<keys>": { // CardStatus
49
- * // currentState: "IN_PROGRESS" || "WAITING" || "COMPLETED", // required
52
+ * // currentState: "IN_PROGRESS" || "WAITING" || "COMPLETED" || "ERROR", // required
50
53
  * // currentValue: "STRING_VALUE", // required
54
+ * // submissions: [ // SubmissionList
55
+ * // { // Submission
56
+ * // value: "DOCUMENT_VALUE",
57
+ * // submissionId: "STRING_VALUE",
58
+ * // timestamp: new Date("TIMESTAMP"),
59
+ * // },
60
+ * // ],
51
61
  * // },
52
62
  * // },
63
+ * // userIsHost: true || false,
53
64
  * // };
54
65
  *
55
66
  * ```