@aws-sdk/client-qapps 3.775.0 → 3.782.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 (36) hide show
  1. package/dist-types/commands/AssociateLibraryItemReviewCommand.d.ts +8 -5
  2. package/dist-types/commands/AssociateQAppWithUserCommand.d.ts +8 -5
  3. package/dist-types/commands/BatchCreateCategoryCommand.d.ts +12 -9
  4. package/dist-types/commands/BatchDeleteCategoryCommand.d.ts +8 -5
  5. package/dist-types/commands/BatchUpdateCategoryCommand.d.ts +12 -9
  6. package/dist-types/commands/CreateLibraryItemCommand.d.ts +15 -15
  7. package/dist-types/commands/CreatePresignedUrlCommand.d.ts +33 -34
  8. package/dist-types/commands/CreateQAppCommand.d.ts +28 -28
  9. package/dist-types/commands/DeleteLibraryItemCommand.d.ts +8 -5
  10. package/dist-types/commands/DeleteQAppCommand.d.ts +8 -5
  11. package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +16 -16
  12. package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts +8 -5
  13. package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts +8 -5
  14. package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +1 -0
  15. package/dist-types/commands/GetLibraryItemCommand.d.ts +24 -24
  16. package/dist-types/commands/GetQAppCommand.d.ts +29 -29
  17. package/dist-types/commands/GetQAppSessionCommand.d.ts +22 -22
  18. package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +13 -13
  19. package/dist-types/commands/ImportDocumentCommand.d.ts +19 -20
  20. package/dist-types/commands/ListCategoriesCommand.d.ts +13 -13
  21. package/dist-types/commands/ListLibraryItemsCommand.d.ts +54 -54
  22. package/dist-types/commands/ListQAppSessionDataCommand.d.ts +1 -0
  23. package/dist-types/commands/ListQAppsCommand.d.ts +55 -56
  24. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
  25. package/dist-types/commands/PredictQAppCommand.d.ts +1 -0
  26. package/dist-types/commands/StartQAppSessionCommand.d.ts +11 -11
  27. package/dist-types/commands/StopQAppSessionCommand.d.ts +1 -0
  28. package/dist-types/commands/TagResourceCommand.d.ts +9 -6
  29. package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
  30. package/dist-types/commands/UpdateLibraryItemCommand.d.ts +23 -23
  31. package/dist-types/commands/UpdateLibraryItemMetadataCommand.d.ts +9 -6
  32. package/dist-types/commands/UpdateQAppCommand.d.ts +36 -37
  33. package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +32 -33
  34. package/dist-types/commands/UpdateQAppSessionCommand.d.ts +1 -0
  35. package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +17 -17
  36. package/package.json +5 -5
package/dist-types/commands/AssociateLibraryItemReviewCommand.d.ts CHANGED
@@ -81,19 +81,22 @@ declare const AssociateLibraryItemReviewCommand_base: {
81
81
  * @throws {@link QAppsServiceException}
82
82
  * <p>Base exception class for all service exceptions from QApps service.</p>
83
83
  *
84
- * @public
84
+ *
85
85
  * @example Increase the rating counter by 1 for the related app for this user
86
86
  * ```javascript
87
87
  * //
88
88
  * const input = {
89
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
90
- * "libraryItemId": "cb9ecf72-8563-450d-9db9-994f98297316"
89
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
90
+ * libraryItemId: "cb9ecf72-8563-450d-9db9-994f98297316"
91
91
  * };
92
92
  * const command = new AssociateLibraryItemReviewCommand(input);
93
- * await client.send(command);
94
- * // example id: example-1
93
+ * const response = await client.send(command);
94
+ * /* response is
95
+ * { /* metadata only *\/ }
96
+ * *\/
95
97
  * ```
96
98
  *
99
+ * @public
97
100
  */
98
101
  export declare class AssociateLibraryItemReviewCommand extends AssociateLibraryItemReviewCommand_base {
99
102
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/AssociateQAppWithUserCommand.d.ts CHANGED
@@ -79,19 +79,22 @@ declare const AssociateQAppWithUserCommand_base: {
79
79
  * @throws {@link QAppsServiceException}
80
80
  * <p>Base exception class for all service exceptions from QApps service.</p>
81
81
  *
82
- * @public
82
+ *
83
83
  * @example Links an Amazon Q App to the invoker's list of apps
84
84
  * ```javascript
85
85
  * //
86
86
  * const input = {
87
- * "appId": "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
88
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
87
+ * appId: "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
88
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
89
89
  * };
90
90
  * const command = new AssociateQAppWithUserCommand(input);
91
- * await client.send(command);
92
- * // example id: example-1
91
+ * const response = await client.send(command);
92
+ * /* response is
93
+ * { /* metadata only *\/ }
94
+ * *\/
93
95
  * ```
94
96
  *
97
+ * @public
95
98
  */
96
99
  export declare class AssociateQAppWithUserCommand extends AssociateQAppWithUserCommand_base {
97
100
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/BatchCreateCategoryCommand.d.ts CHANGED
@@ -84,28 +84,31 @@ declare const BatchCreateCategoryCommand_base: {
84
84
  * @throws {@link QAppsServiceException}
85
85
  * <p>Base exception class for all service exceptions from QApps service.</p>
86
86
  *
87
- * @public
87
+ *
88
88
  * @example Creates the categories for the library
89
89
  * ```javascript
90
90
  * //
91
91
  * const input = {
92
- * "categories": [
92
+ * categories: [
93
93
  * {
94
- * "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
95
- * "title": "HR"
94
+ * id: "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
95
+ * title: "HR"
96
96
  * },
97
97
  * {
98
- * "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f",
99
- * "title": "Marketing"
98
+ * id: "18cbebaa-196a-4aa5-a840-88d548e07f8f",
99
+ * title: "Marketing"
100
100
  * }
101
101
  * ],
102
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
102
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
103
103
  * };
104
104
  * const command = new BatchCreateCategoryCommand(input);
105
- * await client.send(command);
106
- * // example id: example-1
105
+ * const response = await client.send(command);
106
+ * /* response is
107
+ * { /* metadata only *\/ }
108
+ * *\/
107
109
  * ```
108
110
  *
111
+ * @public
109
112
  */
110
113
  export declare class BatchCreateCategoryCommand extends BatchCreateCategoryCommand_base {
111
114
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/BatchDeleteCategoryCommand.d.ts CHANGED
@@ -80,21 +80,24 @@ declare const BatchDeleteCategoryCommand_base: {
80
80
  * @throws {@link QAppsServiceException}
81
81
  * <p>Base exception class for all service exceptions from QApps service.</p>
82
82
  *
83
- * @public
83
+ *
84
84
  * @example Deletes the categories in the library
85
85
  * ```javascript
86
86
  * //
87
87
  * const input = {
88
- * "categories": [
88
+ * categories: [
89
89
  * "9c871ed4-1c41-4065-aefe-321cd4b61cf8"
90
90
  * ],
91
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
91
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
92
92
  * };
93
93
  * const command = new BatchDeleteCategoryCommand(input);
94
- * await client.send(command);
95
- * // example id: example-1
94
+ * const response = await client.send(command);
95
+ * /* response is
96
+ * { /* metadata only *\/ }
97
+ * *\/
96
98
  * ```
97
99
  *
100
+ * @public
98
101
  */
99
102
  export declare class BatchDeleteCategoryCommand extends BatchDeleteCategoryCommand_base {
100
103
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/BatchUpdateCategoryCommand.d.ts CHANGED
@@ -84,28 +84,31 @@ declare const BatchUpdateCategoryCommand_base: {
84
84
  * @throws {@link QAppsServiceException}
85
85
  * <p>Base exception class for all service exceptions from QApps service.</p>
86
86
  *
87
- * @public
87
+ *
88
88
  * @example Updates the categories in the library
89
89
  * ```javascript
90
90
  * //
91
91
  * const input = {
92
- * "categories": [
92
+ * categories: [
93
93
  * {
94
- * "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
95
- * "title": "HR Management"
94
+ * id: "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
95
+ * title: "HR Management"
96
96
  * },
97
97
  * {
98
- * "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f",
99
- * "title": "Sales"
98
+ * id: "18cbebaa-196a-4aa5-a840-88d548e07f8f",
99
+ * title: "Sales"
100
100
  * }
101
101
  * ],
102
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
102
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
103
103
  * };
104
104
  * const command = new BatchUpdateCategoryCommand(input);
105
- * await client.send(command);
106
- * // example id: example-1
105
+ * const response = await client.send(command);
106
+ * /* response is
107
+ * { /* metadata only *\/ }
108
+ * *\/
107
109
  * ```
108
110
  *
111
+ * @public
109
112
  */
110
113
  export declare class BatchUpdateCategoryCommand extends BatchUpdateCategoryCommand_base {
111
114
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/CreateLibraryItemCommand.d.ts CHANGED
@@ -90,35 +90,35 @@ declare const CreateLibraryItemCommand_base: {
90
90
  * @throws {@link QAppsServiceException}
91
91
  * <p>Base exception class for all service exceptions from QApps service.</p>
92
92
  *
93
- * @public
93
+ *
94
94
  * @example Create a Library Item
95
95
  * ```javascript
96
96
  * //
97
97
  * const input = {
98
- * "appId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
99
- * "appVersion": 6,
100
- * "categories": [
98
+ * appId: "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
99
+ * appVersion: 6,
100
+ * categories: [
101
101
  * "9c871ed4-1c41-4065-aefe-321cd4b61cf8"
102
102
  * ],
103
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
103
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
104
104
  * };
105
105
  * const command = new CreateLibraryItemCommand(input);
106
106
  * const response = await client.send(command);
107
- * /* response ==
107
+ * /* response is
108
108
  * {
109
- * "createdAt": "2024-05-21T23:17:27.350Z",
110
- * "createdBy": "a841e300-40c1-7062-fa34-5b46dadbbaac",
111
- * "isVerified": false,
112
- * "libraryItemId": "cb9ecf72-8563-450d-9db9-994f98297316",
113
- * "ratingCount": 0,
114
- * "status": "PUBLISHED",
115
- * "updatedAt": "2024-05-21T23:17:27.350Z",
116
- * "updatedBy": "a841e300-40c1-7062-fa34-5b46dadbbaac"
109
+ * createdAt: "2024-05-21T23:17:27.350Z",
110
+ * createdBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
111
+ * isVerified: false,
112
+ * libraryItemId: "cb9ecf72-8563-450d-9db9-994f98297316",
113
+ * ratingCount: 0,
114
+ * status: "PUBLISHED",
115
+ * updatedAt: "2024-05-21T23:17:27.350Z",
116
+ * updatedBy: "a841e300-40c1-7062-fa34-5b46dadbbaac"
117
117
  * }
118
118
  * *\/
119
- * // example id: example-1
120
119
  * ```
121
120
  *
121
+ * @public
122
122
  */
123
123
  export declare class CreateLibraryItemCommand extends CreateLibraryItemCommand_base {
124
124
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/CreatePresignedUrlCommand.d.ts CHANGED
@@ -84,66 +84,65 @@ declare const CreatePresignedUrlCommand_base: {
84
84
  * @throws {@link QAppsServiceException}
85
85
  * <p>Base exception class for all service exceptions from QApps service.</p>
86
86
  *
87
- * @public
87
+ *
88
88
  * @example Upload a file to a specific session
89
89
  * ```javascript
90
90
  * //
91
91
  * const input = {
92
- * "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
93
- * "cardId": "82f69028-22a9-4bea-8727-0eabf58e9fed",
94
- * "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
95
- * "fileName": "myFile.txt",
96
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
97
- * "scope": "SESSION",
98
- * "sessionId": "4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc"
92
+ * appId: "4263767c-d889-4cb2-a8f6-8b649bc66af0",
93
+ * cardId: "82f69028-22a9-4bea-8727-0eabf58e9fed",
94
+ * fileContentsSha256: "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
95
+ * fileName: "myFile.txt",
96
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
97
+ * scope: "SESSION",
98
+ * sessionId: "4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc"
99
99
  * };
100
100
  * const command = new CreatePresignedUrlCommand(input);
101
101
  * const response = await client.send(command);
102
- * /* response ==
102
+ * /* response is
103
103
  * {
104
- * "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
105
- * "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/",
106
- * "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
107
- * "presignedUrlFields": {
108
- * "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
109
- * "x-amz-server-side-encryption": "aws:kms",
110
- * "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
111
- * "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9"
104
+ * fileId: "412aa1b4-341c-45af-936d-da52f8a1a3b4",
105
+ * presignedUrl: "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/",
106
+ * presignedUrlExpiration: "2024-09-14T00:11:54.232Z",
107
+ * presignedUrlFields: {
108
+ * x-amz-checksum-sha256: "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
109
+ * x-amz-server-side-encryption: "aws:kms",
110
+ * x-amz-server-side-encryption-aws-kms-key-id: "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
111
+ * x-amz-server-side-encryption-context: "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9"
112
112
  * }
113
113
  * }
114
114
  * *\/
115
- * // example id: example-1
116
115
  * ```
117
116
  *
118
117
  * @example Upload a file into a application
119
118
  * ```javascript
120
119
  * //
121
120
  * const input = {
122
- * "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
123
- * "cardId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
124
- * "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
125
- * "fileName": "anApplicationFile.txt",
126
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
127
- * "scope": "APPLICATION"
121
+ * appId: "4263767c-d889-4cb2-a8f6-8b649bc66af0",
122
+ * cardId: "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
123
+ * fileContentsSha256: "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
124
+ * fileName: "anApplicationFile.txt",
125
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
126
+ * scope: "APPLICATION"
128
127
  * };
129
128
  * const command = new CreatePresignedUrlCommand(input);
130
129
  * const response = await client.send(command);
131
- * /* response ==
130
+ * /* response is
132
131
  * {
133
- * "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
134
- * "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/",
135
- * "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
136
- * "presignedUrlFields": {
137
- * "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
138
- * "x-amz-server-side-encryption": "aws:kms",
139
- * "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
140
- * "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9"
132
+ * fileId: "412aa1b4-341c-45af-936d-da52f8a1a3b4",
133
+ * presignedUrl: "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/",
134
+ * presignedUrlExpiration: "2024-09-14T00:11:54.232Z",
135
+ * presignedUrlFields: {
136
+ * x-amz-checksum-sha256: "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
137
+ * x-amz-server-side-encryption: "aws:kms",
138
+ * x-amz-server-side-encryption-aws-kms-key-id: "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
139
+ * x-amz-server-side-encryption-context: "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9"
141
140
  * }
142
141
  * }
143
142
  * *\/
144
- * // example id: example-2
145
143
  * ```
146
144
  *
145
+ * @public
147
146
  */
148
147
  export declare class CreatePresignedUrlCommand extends CreatePresignedUrlCommand_base {
149
148
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/CreateQAppCommand.d.ts CHANGED
@@ -229,56 +229,56 @@ declare const CreateQAppCommand_base: {
229
229
  * @throws {@link QAppsServiceException}
230
230
  * <p>Base exception class for all service exceptions from QApps service.</p>
231
231
  *
232
- * @public
232
+ *
233
233
  * @example A basic application with 1 text input card and 1 output card
234
234
  * ```javascript
235
235
  * //
236
236
  * const input = {
237
- * "appDefinition": {
238
- * "cards": [
237
+ * appDefinition: {
238
+ * cards: [
239
239
  * {
240
- * "textInput": {
241
- * "type": "text-input",
242
- * "id": "4cf94d96-8819-45c2-98cc-58c56b35c72f",
243
- * "title": "Color Base"
240
+ * textInput: {
241
+ * id: "4cf94d96-8819-45c2-98cc-58c56b35c72f",
242
+ * title: "Color Base",
243
+ * type: "text-input"
244
244
  * }
245
245
  * },
246
246
  * {
247
- * "qQuery": {
248
- * "type": "q-query",
249
- * "id": "18870b94-1e63-40e0-8c12-669c90ac5acc",
250
- * "prompt": "Recommend me a list of colors that go well with @4cf94d96-8819-45c2-98cc-58c56b35c72f",
251
- * "title": "Recommended Palette"
247
+ * qQuery: {
248
+ * id: "18870b94-1e63-40e0-8c12-669c90ac5acc",
249
+ * prompt: "Recommend me a list of colors that go well with @4cf94d96-8819-45c2-98cc-58c56b35c72f",
250
+ * title: "Recommended Palette",
251
+ * type: "q-query"
252
252
  * }
253
253
  * }
254
254
  * ],
255
- * "initialPrompt": "Create an app that recommend a list of colors based on input."
255
+ * initialPrompt: "Create an app that recommend a list of colors based on input."
256
256
  * },
257
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
258
- * "title": "Color Palette Generator"
257
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
258
+ * title: "Color Palette Generator"
259
259
  * };
260
260
  * const command = new CreateQAppCommand(input);
261
261
  * const response = await client.send(command);
262
- * /* response ==
262
+ * /* response is
263
263
  * {
264
- * "appArn": "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
265
- * "appId": "7212ff04-de7b-4831-bd80-45d6975ba1b0",
266
- * "appVersion": 1,
267
- * "createdAt": "2024-05-14T00:11:54.232Z",
268
- * "createdBy": "a841e300-40c1-7062-fa34-5b46dadbbaac",
269
- * "initialPrompt": "Create an app that recommend a list of colors based on input.",
270
- * "requiredCapabilities": [
264
+ * appArn: "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
265
+ * appId: "7212ff04-de7b-4831-bd80-45d6975ba1b0",
266
+ * appVersion: 1,
267
+ * createdAt: "2024-05-14T00:11:54.232Z",
268
+ * createdBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
269
+ * initialPrompt: "Create an app that recommend a list of colors based on input.",
270
+ * requiredCapabilities: [
271
271
  * "CreatorMode"
272
272
  * ],
273
- * "status": "DRAFT",
274
- * "title": "Color Palette Generator",
275
- * "updatedAt": "2024-05-14T00:13:26.168Z",
276
- * "updatedBy": "a841e300-40c1-7062-fa34-5b46dadbbaac"
273
+ * status: "DRAFT",
274
+ * title: "Color Palette Generator",
275
+ * updatedAt: "2024-05-14T00:13:26.168Z",
276
+ * updatedBy: "a841e300-40c1-7062-fa34-5b46dadbbaac"
277
277
  * }
278
278
  * *\/
279
- * // example id: example-1
280
279
  * ```
281
280
  *
281
+ * @public
282
282
  */
283
283
  export declare class CreateQAppCommand extends CreateQAppCommand_base {
284
284
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DeleteLibraryItemCommand.d.ts CHANGED
@@ -77,19 +77,22 @@ declare const DeleteLibraryItemCommand_base: {
77
77
  * @throws {@link QAppsServiceException}
78
78
  * <p>Base exception class for all service exceptions from QApps service.</p>
79
79
  *
80
- * @public
80
+ *
81
81
  * @example Delete a library item
82
82
  * ```javascript
83
83
  * //
84
84
  * const input = {
85
- * "instanceId": "3642ba81-344c-42fd-a480-9119a5a5f26b",
86
- * "libraryItemId": "72088fd4-78b6-43da-bfb8-8621323c3cfb"
85
+ * instanceId: "3642ba81-344c-42fd-a480-9119a5a5f26b",
86
+ * libraryItemId: "72088fd4-78b6-43da-bfb8-8621323c3cfb"
87
87
  * };
88
88
  * const command = new DeleteLibraryItemCommand(input);
89
- * await client.send(command);
90
- * // example id: example-1
89
+ * const response = await client.send(command);
90
+ * /* response is
91
+ * { /* metadata only *\/ }
92
+ * *\/
91
93
  * ```
92
94
  *
95
+ * @public
93
96
  */
94
97
  export declare class DeleteLibraryItemCommand extends DeleteLibraryItemCommand_base {
95
98
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DeleteQAppCommand.d.ts CHANGED
@@ -73,19 +73,22 @@ declare const DeleteQAppCommand_base: {
73
73
  * @throws {@link QAppsServiceException}
74
74
  * <p>Base exception class for all service exceptions from QApps service.</p>
75
75
  *
76
- * @public
76
+ *
77
77
  * @example Delete an Amazon Q App
78
78
  * ```javascript
79
79
  * //
80
80
  * const input = {
81
- * "appId": "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
82
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
81
+ * appId: "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
82
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
83
83
  * };
84
84
  * const command = new DeleteQAppCommand(input);
85
- * await client.send(command);
86
- * // example id: example-1
85
+ * const response = await client.send(command);
86
+ * /* response is
87
+ * { /* metadata only *\/ }
88
+ * *\/
87
89
  * ```
88
90
  *
91
+ * @public
89
92
  */
90
93
  export declare class DeleteQAppCommand extends DeleteQAppCommand_base {
91
94
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts CHANGED
@@ -85,41 +85,41 @@ declare const DescribeQAppPermissionsCommand_base: {
85
85
  * @throws {@link QAppsServiceException}
86
86
  * <p>Base exception class for all service exceptions from QApps service.</p>
87
87
  *
88
- * @public
88
+ *
89
89
  * @example Describe permissions for the app
90
90
  * ```javascript
91
91
  * //
92
92
  * const input = {
93
- * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
94
- * "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
93
+ * appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
94
+ * instanceId: "01793661-ad73-4c7d-8eaa-1c95a10151c2"
95
95
  * };
96
96
  * const command = new DescribeQAppPermissionsCommand(input);
97
97
  * const response = await client.send(command);
98
- * /* response ==
98
+ * /* response is
99
99
  * {
100
- * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
101
- * "permissions": [
100
+ * appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
101
+ * permissions: [
102
102
  * {
103
- * "action": "write",
104
- * "principal": {
105
- * "email": "user1@example.com",
106
- * "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
103
+ * action: "write",
104
+ * principal: {
105
+ * email: "user1@example.com",
106
+ * userId: "f8f15330-b091-708b-d46e-adb0d914b699"
107
107
  * }
108
108
  * },
109
109
  * {
110
- * "action": "read",
111
- * "principal": {
112
- * "email": "user2@example.com",
113
- * "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
110
+ * action: "read",
111
+ * principal: {
112
+ * email: "user2@example.com",
113
+ * userId: "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
114
114
  * }
115
115
  * }
116
116
  * ],
117
- * "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
117
+ * resourceArn: "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
118
118
  * }
119
119
  * *\/
120
- * // example id: example-1
121
120
  * ```
122
121
  *
122
+ * @public
123
123
  */
124
124
  export declare class DescribeQAppPermissionsCommand extends DescribeQAppPermissionsCommand_base {
125
125
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts CHANGED
@@ -80,19 +80,22 @@ declare const DisassociateLibraryItemReviewCommand_base: {
80
80
  * @throws {@link QAppsServiceException}
81
81
  * <p>Base exception class for all service exceptions from QApps service.</p>
82
82
  *
83
- * @public
83
+ *
84
84
  * @example Decrease the rating counter by 1 for the related app for this user
85
85
  * ```javascript
86
86
  * //
87
87
  * const input = {
88
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
89
- * "libraryItemId": "cb9ecf72-8563-450d-9db9-994f98297316"
88
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
89
+ * libraryItemId: "cb9ecf72-8563-450d-9db9-994f98297316"
90
90
  * };
91
91
  * const command = new DisassociateLibraryItemReviewCommand(input);
92
- * await client.send(command);
93
- * // example id: example-1
92
+ * const response = await client.send(command);
93
+ * /* response is
94
+ * { /* metadata only *\/ }
95
+ * *\/
94
96
  * ```
95
97
  *
98
+ * @public
96
99
  */
97
100
  export declare class DisassociateLibraryItemReviewCommand extends DisassociateLibraryItemReviewCommand_base {
98
101
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts CHANGED
@@ -72,19 +72,22 @@ declare const DisassociateQAppFromUserCommand_base: {
72
72
  * @throws {@link QAppsServiceException}
73
73
  * <p>Base exception class for all service exceptions from QApps service.</p>
74
74
  *
75
- * @public
75
+ *
76
76
  * @example Unlinks an Amazon Q App from the invoker's list of apps
77
77
  * ```javascript
78
78
  * //
79
79
  * const input = {
80
- * "appId": "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
81
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
80
+ * appId: "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
81
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
82
82
  * };
83
83
  * const command = new DisassociateQAppFromUserCommand(input);
84
- * await client.send(command);
85
- * // example id: example-1
84
+ * const response = await client.send(command);
85
+ * /* response is
86
+ * { /* metadata only *\/ }
87
+ * *\/
86
88
  * ```
87
89
  *
90
+ * @public
88
91
  */
89
92
  export declare class DisassociateQAppFromUserCommand extends DisassociateQAppFromUserCommand_base {
90
93
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ExportQAppSessionDataCommand.d.ts CHANGED
@@ -84,6 +84,7 @@ declare const ExportQAppSessionDataCommand_base: {
84
84
  * @throws {@link QAppsServiceException}
85
85
  * <p>Base exception class for all service exceptions from QApps service.</p>
86
86
  *
87
+ *
87
88
  * @public
88
89
  */
89
90
  export declare class ExportQAppSessionDataCommand extends ExportQAppSessionDataCommand_base {