@aws-sdk/client-qapps 3.774.0 → 3.777.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 (44) hide show
  1. package/dist-cjs/QAppsClient.js +2 -1
  2. package/dist-cjs/auth/httpAuthSchemeProvider.js +1 -3
  3. package/dist-cjs/endpoint/EndpointParameters.js +2 -3
  4. package/dist-cjs/runtimeExtensions.js +2 -14
  5. package/dist-es/QAppsClient.js +2 -1
  6. package/dist-es/auth/httpAuthSchemeProvider.js +1 -3
  7. package/dist-es/endpoint/EndpointParameters.js +2 -3
  8. package/dist-es/runtimeExtensions.js +2 -14
  9. package/dist-types/commands/AssociateLibraryItemReviewCommand.d.ts +8 -5
  10. package/dist-types/commands/AssociateQAppWithUserCommand.d.ts +8 -5
  11. package/dist-types/commands/BatchCreateCategoryCommand.d.ts +12 -9
  12. package/dist-types/commands/BatchDeleteCategoryCommand.d.ts +8 -5
  13. package/dist-types/commands/BatchUpdateCategoryCommand.d.ts +12 -9
  14. package/dist-types/commands/CreateLibraryItemCommand.d.ts +15 -15
  15. package/dist-types/commands/CreatePresignedUrlCommand.d.ts +33 -34
  16. package/dist-types/commands/CreateQAppCommand.d.ts +28 -28
  17. package/dist-types/commands/DeleteLibraryItemCommand.d.ts +8 -5
  18. package/dist-types/commands/DeleteQAppCommand.d.ts +8 -5
  19. package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +16 -16
  20. package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts +8 -5
  21. package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts +8 -5
  22. package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +1 -0
  23. package/dist-types/commands/GetLibraryItemCommand.d.ts +24 -24
  24. package/dist-types/commands/GetQAppCommand.d.ts +29 -29
  25. package/dist-types/commands/GetQAppSessionCommand.d.ts +22 -22
  26. package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +13 -13
  27. package/dist-types/commands/ImportDocumentCommand.d.ts +19 -20
  28. package/dist-types/commands/ListCategoriesCommand.d.ts +13 -13
  29. package/dist-types/commands/ListLibraryItemsCommand.d.ts +54 -54
  30. package/dist-types/commands/ListQAppSessionDataCommand.d.ts +1 -0
  31. package/dist-types/commands/ListQAppsCommand.d.ts +55 -56
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
  33. package/dist-types/commands/PredictQAppCommand.d.ts +1 -0
  34. package/dist-types/commands/StartQAppSessionCommand.d.ts +11 -11
  35. package/dist-types/commands/StopQAppSessionCommand.d.ts +1 -0
  36. package/dist-types/commands/TagResourceCommand.d.ts +9 -6
  37. package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
  38. package/dist-types/commands/UpdateLibraryItemCommand.d.ts +23 -23
  39. package/dist-types/commands/UpdateLibraryItemMetadataCommand.d.ts +9 -6
  40. package/dist-types/commands/UpdateQAppCommand.d.ts +36 -37
  41. package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +32 -33
  42. package/dist-types/commands/UpdateQAppSessionCommand.d.ts +1 -0
  43. package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +17 -17
  44. package/package.json +33 -33
@@ -221,76 +221,75 @@ declare const UpdateQAppCommand_base: {
221
221
  * @throws {@link QAppsServiceException}
222
222
  * <p>Base exception class for all service exceptions from QApps service.</p>
223
223
  *
224
- * @public
224
+ *
225
225
  * @example Updating the title of an app
226
226
  * ```javascript
227
227
  * //
228
228
  * const input = {
229
- * "appId": "7212ff04-de7b-4831-bd80-45d6975ba1b0",
230
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
231
- * "title": "This is the new title"
229
+ * appId: "7212ff04-de7b-4831-bd80-45d6975ba1b0",
230
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
231
+ * title: "This is the new title"
232
232
  * };
233
233
  * const command = new UpdateQAppCommand(input);
234
234
  * const response = await client.send(command);
235
- * /* response ==
235
+ * /* response is
236
236
  * {
237
- * "appArn": "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
238
- * "appId": "7212ff04-de7b-4831-bd80-45d6975ba1b0",
239
- * "appVersion": 2,
240
- * "createdAt": "2024-05-14T00:11:54.232Z",
241
- * "createdBy": "a841e300-40c1-7062-fa34-5b46dadbbaac",
242
- * "requiredCapabilities": [
237
+ * appArn: "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
238
+ * appId: "7212ff04-de7b-4831-bd80-45d6975ba1b0",
239
+ * appVersion: 2,
240
+ * createdAt: "2024-05-14T00:11:54.232Z",
241
+ * createdBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
242
+ * requiredCapabilities: [
243
243
  * "CreatorMode"
244
244
  * ],
245
- * "status": "DRAFT",
246
- * "title": "This is the new title",
247
- * "updatedAt": "2024-05-17T23:15:08.571Z",
248
- * "updatedBy": "a841e300-40c1-7062-fa34-5b46dadbbaac"
245
+ * status: "DRAFT",
246
+ * title: "This is the new title",
247
+ * updatedAt: "2024-05-17T23:15:08.571Z",
248
+ * updatedBy: "a841e300-40c1-7062-fa34-5b46dadbbaac"
249
249
  * }
250
250
  * *\/
251
- * // example id: example-1
252
251
  * ```
253
252
  *
254
253
  * @example Updating the app so it has a single q-query card
255
254
  * ```javascript
256
255
  * //
257
256
  * const input = {
258
- * "appDefinition": {
259
- * "cards": [
257
+ * appDefinition: {
258
+ * cards: [
260
259
  * {
261
- * "qQuery": {
262
- * "type": "q-query",
263
- * "id": "18870b94-1e63-40e0-8c12-669c90ac5acc",
264
- * "prompt": "Recommend me an itinerary for a trip",
265
- * "title": "Trip Ideas"
260
+ * qQuery: {
261
+ * id: "18870b94-1e63-40e0-8c12-669c90ac5acc",
262
+ * prompt: "Recommend me an itinerary for a trip",
263
+ * title: "Trip Ideas",
264
+ * type: "q-query"
266
265
  * }
267
266
  * }
268
267
  * ]
269
268
  * },
270
- * "appId": "7212ff04-de7b-4831-bd80-45d6975ba1b0",
271
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
269
+ * appId: "7212ff04-de7b-4831-bd80-45d6975ba1b0",
270
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
272
271
  * };
273
272
  * const command = new UpdateQAppCommand(input);
274
273
  * const response = await client.send(command);
275
- * /* response ==
274
+ * /* response is
276
275
  * {
277
- * "appArn": "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
278
- * "appId": "7212ff04-de7b-4831-bd80-45d6975ba1b0",
279
- * "appVersion": 99,
280
- * "createdAt": "2024-05-14T00:11:54.232Z",
281
- * "createdBy": "a841e300-40c1-7062-fa34-5b46dadbbaac",
282
- * "requiredCapabilities": [
276
+ * appArn: "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
277
+ * appId: "7212ff04-de7b-4831-bd80-45d6975ba1b0",
278
+ * appVersion: 99,
279
+ * createdAt: "2024-05-14T00:11:54.232Z",
280
+ * createdBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
281
+ * requiredCapabilities: [
283
282
  * "CreatorMode"
284
283
  * ],
285
- * "status": "DRAFT",
286
- * "title": "Previous Title Stays the Same",
287
- * "updatedAt": "2024-05-17T23:15:08.571Z",
288
- * "updatedBy": "a841e300-40c1-7062-fa34-5b46dadbbaac"
284
+ * status: "DRAFT",
285
+ * title: "Previous Title Stays the Same",
286
+ * updatedAt: "2024-05-17T23:15:08.571Z",
287
+ * updatedBy: "a841e300-40c1-7062-fa34-5b46dadbbaac"
289
288
  * }
290
289
  * *\/
291
- * // example id: example-2
292
290
  * ```
293
291
  *
292
+ * @public
294
293
  */
295
294
  export declare class UpdateQAppCommand extends UpdateQAppCommand_base {
296
295
  /** @internal type navigation helper, not in runtime. */
@@ -97,80 +97,79 @@ declare const UpdateQAppPermissionsCommand_base: {
97
97
  * @throws {@link QAppsServiceException}
98
98
  * <p>Base exception class for all service exceptions from QApps service.</p>
99
99
  *
100
- * @public
100
+ *
101
101
  * @example Grant permissions for the app
102
102
  * ```javascript
103
103
  * //
104
104
  * const input = {
105
- * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
106
- * "grantPermissions": [
105
+ * appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
106
+ * grantPermissions: [
107
107
  * {
108
- * "action": "read",
109
- * "principal": "user2@example.com"
108
+ * action: "read",
109
+ * principal: "user2@example.com"
110
110
  * }
111
111
  * ],
112
- * "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
112
+ * instanceId: "01793661-ad73-4c7d-8eaa-1c95a10151c2"
113
113
  * };
114
114
  * const command = new UpdateQAppPermissionsCommand(input);
115
115
  * const response = await client.send(command);
116
- * /* response ==
116
+ * /* response is
117
117
  * {
118
- * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
119
- * "permissions": [
118
+ * appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
119
+ * permissions: [
120
120
  * {
121
- * "action": "write",
122
- * "principal": {
123
- * "email": "user1@example.com",
124
- * "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
121
+ * action: "write",
122
+ * principal: {
123
+ * email: "user1@example.com",
124
+ * userId: "f8f15330-b091-708b-d46e-adb0d914b699"
125
125
  * }
126
126
  * },
127
127
  * {
128
- * "action": "read",
129
- * "principal": {
130
- * "email": "user2@example.com",
131
- * "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
128
+ * action: "read",
129
+ * principal: {
130
+ * email: "user2@example.com",
131
+ * userId: "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
132
132
  * }
133
133
  * }
134
134
  * ],
135
- * "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
135
+ * resourceArn: "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
136
136
  * }
137
137
  * *\/
138
- * // example id: example-1
139
138
  * ```
140
139
  *
141
140
  * @example Revoke permissions for the app
142
141
  * ```javascript
143
142
  * //
144
143
  * const input = {
145
- * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
146
- * "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2",
147
- * "revokePermissions": [
144
+ * appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
145
+ * instanceId: "01793661-ad73-4c7d-8eaa-1c95a10151c2",
146
+ * revokePermissions: [
148
147
  * {
149
- * "action": "read",
150
- * "principal": "user2@example.com"
148
+ * action: "read",
149
+ * principal: "user2@example.com"
151
150
  * }
152
151
  * ]
153
152
  * };
154
153
  * const command = new UpdateQAppPermissionsCommand(input);
155
154
  * const response = await client.send(command);
156
- * /* response ==
155
+ * /* response is
157
156
  * {
158
- * "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
159
- * "permissions": [
157
+ * appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
158
+ * permissions: [
160
159
  * {
161
- * "action": "write",
162
- * "principal": {
163
- * "email": "user1@example.com",
164
- * "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
160
+ * action: "write",
161
+ * principal: {
162
+ * email: "user1@example.com",
163
+ * userId: "f8f15330-b091-708b-d46e-adb0d914b699"
165
164
  * }
166
165
  * }
167
166
  * ],
168
- * "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
167
+ * resourceArn: "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
169
168
  * }
170
169
  * *\/
171
- * // example id: example-2
172
170
  * ```
173
171
  *
172
+ * @public
174
173
  */
175
174
  export declare class UpdateQAppPermissionsCommand extends UpdateQAppPermissionsCommand_base {
176
175
  /** @internal type navigation helper, not in runtime. */
@@ -93,6 +93,7 @@ declare const UpdateQAppSessionCommand_base: {
93
93
  * @throws {@link QAppsServiceException}
94
94
  * <p>Base exception class for all service exceptions from QApps service.</p>
95
95
  *
96
+ *
96
97
  * @public
97
98
  */
98
99
  export declare class UpdateQAppSessionCommand extends UpdateQAppSessionCommand_base {
@@ -92,37 +92,37 @@ declare const UpdateQAppSessionMetadataCommand_base: {
92
92
  * @throws {@link QAppsServiceException}
93
93
  * <p>Base exception class for all service exceptions from QApps service.</p>
94
94
  *
95
- * @public
95
+ *
96
96
  * @example Updates an existing session metadata for an Amazon Q App
97
97
  * ```javascript
98
98
  * //
99
99
  * const input = {
100
- * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
101
- * "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
102
- * "sessionName": "Trip itinerary collection session",
103
- * "sharingConfiguration": {
104
- * "acceptResponses": true,
105
- * "enabled": true,
106
- * "revealCards": false
100
+ * instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
101
+ * sessionId: "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
102
+ * sessionName: "Trip itinerary collection session",
103
+ * sharingConfiguration: {
104
+ * acceptResponses: true,
105
+ * enabled: true,
106
+ * revealCards: false
107
107
  * }
108
108
  * };
109
109
  * const command = new UpdateQAppSessionMetadataCommand(input);
110
110
  * const response = await client.send(command);
111
- * /* response ==
111
+ * /* response is
112
112
  * {
113
- * "sessionArn": "arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
114
- * "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
115
- * "sessionName": "Trip itinerary collection session",
116
- * "sharingConfiguration": {
117
- * "acceptResponses": true,
118
- * "enabled": true,
119
- * "revealCards": false
113
+ * sessionArn: "arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
114
+ * sessionId: "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
115
+ * sessionName: "Trip itinerary collection session",
116
+ * sharingConfiguration: {
117
+ * acceptResponses: true,
118
+ * enabled: true,
119
+ * revealCards: false
120
120
  * }
121
121
  * }
122
122
  * *\/
123
- * // example id: example-1
124
123
  * ```
125
124
  *
125
+ * @public
126
126
  */
127
127
  export declare class UpdateQAppSessionMetadataCommand extends UpdateQAppSessionMetadataCommand_base {
128
128
  /** @internal type navigation helper, not in runtime. */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-qapps",
3
3
  "description": "AWS SDK for JavaScript Qapps Client for Node.js, Browser and React Native",
4
- "version": "3.774.0",
4
+ "version": "3.777.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,41 +20,41 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.774.0",
24
- "@aws-sdk/credential-provider-node": "3.774.0",
25
- "@aws-sdk/middleware-host-header": "3.774.0",
26
- "@aws-sdk/middleware-logger": "3.734.0",
27
- "@aws-sdk/middleware-recursion-detection": "3.772.0",
28
- "@aws-sdk/middleware-user-agent": "3.774.0",
29
- "@aws-sdk/region-config-resolver": "3.734.0",
30
- "@aws-sdk/types": "3.734.0",
31
- "@aws-sdk/util-endpoints": "3.743.0",
32
- "@aws-sdk/util-user-agent-browser": "3.734.0",
33
- "@aws-sdk/util-user-agent-node": "3.774.0",
34
- "@smithy/config-resolver": "^4.0.1",
35
- "@smithy/core": "^3.1.5",
36
- "@smithy/fetch-http-handler": "^5.0.1",
37
- "@smithy/hash-node": "^4.0.1",
38
- "@smithy/invalid-dependency": "^4.0.1",
39
- "@smithy/middleware-content-length": "^4.0.1",
40
- "@smithy/middleware-endpoint": "^4.0.6",
41
- "@smithy/middleware-retry": "^4.0.7",
42
- "@smithy/middleware-serde": "^4.0.2",
43
- "@smithy/middleware-stack": "^4.0.1",
44
- "@smithy/node-config-provider": "^4.0.1",
45
- "@smithy/node-http-handler": "^4.0.3",
46
- "@smithy/protocol-http": "^5.0.1",
47
- "@smithy/smithy-client": "^4.1.6",
48
- "@smithy/types": "^4.1.0",
49
- "@smithy/url-parser": "^4.0.1",
23
+ "@aws-sdk/core": "3.775.0",
24
+ "@aws-sdk/credential-provider-node": "3.777.0",
25
+ "@aws-sdk/middleware-host-header": "3.775.0",
26
+ "@aws-sdk/middleware-logger": "3.775.0",
27
+ "@aws-sdk/middleware-recursion-detection": "3.775.0",
28
+ "@aws-sdk/middleware-user-agent": "3.775.0",
29
+ "@aws-sdk/region-config-resolver": "3.775.0",
30
+ "@aws-sdk/types": "3.775.0",
31
+ "@aws-sdk/util-endpoints": "3.775.0",
32
+ "@aws-sdk/util-user-agent-browser": "3.775.0",
33
+ "@aws-sdk/util-user-agent-node": "3.775.0",
34
+ "@smithy/config-resolver": "^4.1.0",
35
+ "@smithy/core": "^3.2.0",
36
+ "@smithy/fetch-http-handler": "^5.0.2",
37
+ "@smithy/hash-node": "^4.0.2",
38
+ "@smithy/invalid-dependency": "^4.0.2",
39
+ "@smithy/middleware-content-length": "^4.0.2",
40
+ "@smithy/middleware-endpoint": "^4.1.0",
41
+ "@smithy/middleware-retry": "^4.1.0",
42
+ "@smithy/middleware-serde": "^4.0.3",
43
+ "@smithy/middleware-stack": "^4.0.2",
44
+ "@smithy/node-config-provider": "^4.0.2",
45
+ "@smithy/node-http-handler": "^4.0.4",
46
+ "@smithy/protocol-http": "^5.1.0",
47
+ "@smithy/smithy-client": "^4.2.0",
48
+ "@smithy/types": "^4.2.0",
49
+ "@smithy/url-parser": "^4.0.2",
50
50
  "@smithy/util-base64": "^4.0.0",
51
51
  "@smithy/util-body-length-browser": "^4.0.0",
52
52
  "@smithy/util-body-length-node": "^4.0.0",
53
- "@smithy/util-defaults-mode-browser": "^4.0.7",
54
- "@smithy/util-defaults-mode-node": "^4.0.7",
55
- "@smithy/util-endpoints": "^3.0.1",
56
- "@smithy/util-middleware": "^4.0.1",
57
- "@smithy/util-retry": "^4.0.1",
53
+ "@smithy/util-defaults-mode-browser": "^4.0.8",
54
+ "@smithy/util-defaults-mode-node": "^4.0.8",
55
+ "@smithy/util-endpoints": "^3.0.2",
56
+ "@smithy/util-middleware": "^4.0.2",
57
+ "@smithy/util-retry": "^4.0.2",
58
58
  "@smithy/util-utf8": "^4.0.0",
59
59
  "tslib": "^2.6.2"
60
60
  },