@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.
- package/dist-types/commands/AssociateLibraryItemReviewCommand.d.ts +8 -5
- package/dist-types/commands/AssociateQAppWithUserCommand.d.ts +8 -5
- package/dist-types/commands/BatchCreateCategoryCommand.d.ts +12 -9
- package/dist-types/commands/BatchDeleteCategoryCommand.d.ts +8 -5
- package/dist-types/commands/BatchUpdateCategoryCommand.d.ts +12 -9
- package/dist-types/commands/CreateLibraryItemCommand.d.ts +15 -15
- package/dist-types/commands/CreatePresignedUrlCommand.d.ts +33 -34
- package/dist-types/commands/CreateQAppCommand.d.ts +28 -28
- package/dist-types/commands/DeleteLibraryItemCommand.d.ts +8 -5
- package/dist-types/commands/DeleteQAppCommand.d.ts +8 -5
- package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +16 -16
- package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts +8 -5
- package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts +8 -5
- package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +1 -0
- package/dist-types/commands/GetLibraryItemCommand.d.ts +24 -24
- package/dist-types/commands/GetQAppCommand.d.ts +29 -29
- package/dist-types/commands/GetQAppSessionCommand.d.ts +22 -22
- package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +13 -13
- package/dist-types/commands/ImportDocumentCommand.d.ts +19 -20
- package/dist-types/commands/ListCategoriesCommand.d.ts +13 -13
- package/dist-types/commands/ListLibraryItemsCommand.d.ts +54 -54
- package/dist-types/commands/ListQAppSessionDataCommand.d.ts +1 -0
- package/dist-types/commands/ListQAppsCommand.d.ts +55 -56
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
- package/dist-types/commands/PredictQAppCommand.d.ts +1 -0
- package/dist-types/commands/StartQAppSessionCommand.d.ts +11 -11
- package/dist-types/commands/StopQAppSessionCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +9 -6
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
- package/dist-types/commands/UpdateLibraryItemCommand.d.ts +23 -23
- package/dist-types/commands/UpdateLibraryItemMetadataCommand.d.ts +9 -6
- package/dist-types/commands/UpdateQAppCommand.d.ts +36 -37
- package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +32 -33
- package/dist-types/commands/UpdateQAppSessionCommand.d.ts +1 -0
- package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +17 -17
- package/package.json +5 -5
|
@@ -86,100 +86,99 @@ declare const ListQAppsCommand_base: {
|
|
|
86
86
|
* @throws {@link QAppsServiceException}
|
|
87
87
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
88
88
|
*
|
|
89
|
-
*
|
|
89
|
+
*
|
|
90
90
|
* @example List at most 3 Amazon Q Apps in an Q Business application
|
|
91
91
|
* ```javascript
|
|
92
92
|
* //
|
|
93
93
|
* const input = {
|
|
94
|
-
*
|
|
95
|
-
*
|
|
94
|
+
* instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
95
|
+
* limit: 3
|
|
96
96
|
* };
|
|
97
97
|
* const command = new ListQAppsCommand(input);
|
|
98
98
|
* const response = await client.send(command);
|
|
99
|
-
* /* response
|
|
99
|
+
* /* response is
|
|
100
100
|
* {
|
|
101
|
-
*
|
|
101
|
+
* apps: [
|
|
102
102
|
* {
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
103
|
+
* appArn: "arn:aws:qapps:us-west-2:..../7b9fe303-18bb-4643-952c-bfcf9f4c427f",
|
|
104
|
+
* appId: "7b9fe303-18bb-4643-952c-bfcf9f4c427f",
|
|
105
|
+
* createdAt: "2024-05-21T04:09:10.401Z",
|
|
106
|
+
* description: "Description 1",
|
|
107
|
+
* isVerified: false,
|
|
108
|
+
* status: "DRAFT",
|
|
109
|
+
* title: "App 1"
|
|
110
110
|
* },
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
112
|
+
* appArn: "arn:aws:qapps:us-west-2:..../dd178fd6-ad3d-49b3-a32d-e915cf423e37",
|
|
113
|
+
* appId: "dd178fd6-ad3d-49b3-a32d-e915cf423e37",
|
|
114
|
+
* createdAt: "2024-05-21T04:09:10.401Z",
|
|
115
|
+
* description: "Description 2",
|
|
116
|
+
* isVerified: true,
|
|
117
|
+
* status: "PUBLISHED",
|
|
118
|
+
* title: "App 2"
|
|
119
119
|
* },
|
|
120
120
|
* {
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
121
|
+
* appArn: "arn:aws:qapps:us-west-2:..../3274b744-1a13-4aad-953f-eda2e4149e6e",
|
|
122
|
+
* appId: "3274b744-1a13-4aad-953f-eda2e4149e6e",
|
|
123
|
+
* createdAt: "2024-05-21T04:09:10.401Z",
|
|
124
|
+
* description: "Description 3",
|
|
125
|
+
* isVerified: false,
|
|
126
|
+
* status: "DRAFT",
|
|
127
|
+
* title: "App 3"
|
|
128
128
|
* }
|
|
129
129
|
* ],
|
|
130
|
-
*
|
|
130
|
+
* nextToken: "bXlzdGVyaW91c1BhZ2luYXRpb25Ub2tlbg=="
|
|
131
131
|
* }
|
|
132
132
|
* *\/
|
|
133
|
-
* // example id: example-1
|
|
134
133
|
* ```
|
|
135
134
|
*
|
|
136
135
|
* @example Retrieve the next page of Amazon Q Apps
|
|
137
136
|
* ```javascript
|
|
138
137
|
* //
|
|
139
138
|
* const input = {
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
139
|
+
* instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
140
|
+
* limit: 3,
|
|
141
|
+
* nextToken: "bXlzdGVyaW91c1BhZ2luYXRpb25Ub2tlbg=="
|
|
143
142
|
* };
|
|
144
143
|
* const command = new ListQAppsCommand(input);
|
|
145
144
|
* const response = await client.send(command);
|
|
146
|
-
* /* response
|
|
145
|
+
* /* response is
|
|
147
146
|
* {
|
|
148
|
-
*
|
|
147
|
+
* apps: [
|
|
149
148
|
* {
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
149
|
+
* appArn: "arn:aws:qapps:us-west-2:..../bec8ee64-2635-41e8-aace-e1e418f4f295",
|
|
150
|
+
* appId: "bec8ee64-2635-41e8-aace-e1e418f4f295",
|
|
151
|
+
* createdAt: "2024-05-21T04:09:10.401Z",
|
|
152
|
+
* description: "Description 4",
|
|
153
|
+
* isVerified: true,
|
|
154
|
+
* status: "PUBLISHED",
|
|
155
|
+
* title: "App 4"
|
|
157
156
|
* },
|
|
158
157
|
* {
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
158
|
+
* appArn: "arn:aws:qapps:us-west-2:..../c380a45d-bd77-45b0-a0e5-8a266c1d8bc4",
|
|
159
|
+
* appId: "c380a45d-bd77-45b0-a0e5-8a266c1d8bc4",
|
|
160
|
+
* createdAt: "2024-05-21T04:09:10.401Z",
|
|
161
|
+
* description: "Description 5",
|
|
162
|
+
* isVerified: false,
|
|
163
|
+
* status: "PUBLISHED",
|
|
164
|
+
* title: "App 5"
|
|
166
165
|
* },
|
|
167
166
|
* {
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
167
|
+
* appArn: "arn:aws:qapps:us-west-2:..../afc4ee80-9722-4396-85a6-7aeaff52c177",
|
|
168
|
+
* appId: "afc4ee80-9722-4396-85a6-7aeaff52c177",
|
|
169
|
+
* createdAt: "2024-05-21T04:09:10.401Z",
|
|
170
|
+
* description: "Description 6",
|
|
171
|
+
* isVerified: false,
|
|
172
|
+
* status: "PUBLISHED",
|
|
173
|
+
* title: "App 6"
|
|
175
174
|
* }
|
|
176
175
|
* ],
|
|
177
|
-
*
|
|
176
|
+
* nextToken: "YW5vdGhlclRva2VuIQ=="
|
|
178
177
|
* }
|
|
179
178
|
* *\/
|
|
180
|
-
* // example id: example-2
|
|
181
179
|
* ```
|
|
182
180
|
*
|
|
181
|
+
* @public
|
|
183
182
|
*/
|
|
184
183
|
export declare class ListQAppsCommand extends ListQAppsCommand_base {
|
|
185
184
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,25 +72,25 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
72
72
|
* @throws {@link QAppsServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example A call to list tags for a resource
|
|
77
77
|
* ```javascript
|
|
78
78
|
* //
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
80
|
+
* resourceARN: "arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0"
|
|
81
81
|
* };
|
|
82
82
|
* const command = new ListTagsForResourceCommand(input);
|
|
83
83
|
* const response = await client.send(command);
|
|
84
|
-
* /* response
|
|
84
|
+
* /* response is
|
|
85
85
|
* {
|
|
86
|
-
*
|
|
87
|
-
*
|
|
86
|
+
* tags: {
|
|
87
|
+
* department: "HR"
|
|
88
88
|
* }
|
|
89
89
|
* }
|
|
90
90
|
* *\/
|
|
91
|
-
* // example id: example-1
|
|
92
91
|
* ```
|
|
93
92
|
*
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
|
|
96
96
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -212,6 +212,7 @@ declare const PredictQAppCommand_base: {
|
|
|
212
212
|
* @throws {@link QAppsServiceException}
|
|
213
213
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
214
214
|
*
|
|
215
|
+
*
|
|
215
216
|
* @public
|
|
216
217
|
*/
|
|
217
218
|
export declare class PredictQAppCommand extends PredictQAppCommand_base {
|
|
@@ -99,32 +99,32 @@ declare const StartQAppSessionCommand_base: {
|
|
|
99
99
|
* @throws {@link QAppsServiceException}
|
|
100
100
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
101
101
|
*
|
|
102
|
-
*
|
|
102
|
+
*
|
|
103
103
|
* @example Start a session for an Amazon Q App using version 1, passing in initial values for one card
|
|
104
104
|
* ```javascript
|
|
105
105
|
* //
|
|
106
106
|
* const input = {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
107
|
+
* appId: "65e7dce7-226a-47f9-b689-22850becef89",
|
|
108
|
+
* appVersion: 1,
|
|
109
|
+
* initialValues: [
|
|
110
110
|
* {
|
|
111
|
-
*
|
|
112
|
-
*
|
|
111
|
+
* cardId: "6fb5b404-3b7b-48a4-8a8b-56406922a606",
|
|
112
|
+
* value: "What is the circumference of Earth?"
|
|
113
113
|
* }
|
|
114
114
|
* ],
|
|
115
|
-
*
|
|
115
|
+
* instanceId: "4cc5e4c2-d2a2-4188-a114-9ca125b4aedc"
|
|
116
116
|
* };
|
|
117
117
|
* const command = new StartQAppSessionCommand(input);
|
|
118
118
|
* const response = await client.send(command);
|
|
119
|
-
* /* response
|
|
119
|
+
* /* response is
|
|
120
120
|
* {
|
|
121
|
-
*
|
|
122
|
-
*
|
|
121
|
+
* sessionArn: "arn:aws:qapps:us-west-2:0123456789012:application/a929ecd6-5765-4ec7-bd3e-2ca90098b18e/qapp/65e7dce7-226a-47f9-b689-22850becef89/session/1fca878e-64c5-4dc4-b1d9-c93effed4e82",
|
|
122
|
+
* sessionId: "1fca878e-64c5-4dc4-b1d9-c93effed4e82"
|
|
123
123
|
* }
|
|
124
124
|
* *\/
|
|
125
|
-
* // example id: example-1
|
|
126
125
|
* ```
|
|
127
126
|
*
|
|
127
|
+
* @public
|
|
128
128
|
*/
|
|
129
129
|
export declare class StartQAppSessionCommand extends StartQAppSessionCommand_base {
|
|
130
130
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -78,6 +78,7 @@ declare const StopQAppSessionCommand_base: {
|
|
|
78
78
|
* @throws {@link QAppsServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
80
80
|
*
|
|
81
|
+
*
|
|
81
82
|
* @public
|
|
82
83
|
*/
|
|
83
84
|
export declare class StopQAppSessionCommand extends StopQAppSessionCommand_base {
|
|
@@ -75,21 +75,24 @@ declare const TagResourceCommand_base: {
|
|
|
75
75
|
* @throws {@link QAppsServiceException}
|
|
76
76
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
77
77
|
*
|
|
78
|
-
*
|
|
78
|
+
*
|
|
79
79
|
* @example A call to tag a resource
|
|
80
80
|
* ```javascript
|
|
81
81
|
* //
|
|
82
82
|
* const input = {
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
83
|
+
* resourceARN: "arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0",
|
|
84
|
+
* tags: {
|
|
85
|
+
* department: "HR"
|
|
86
86
|
* }
|
|
87
87
|
* };
|
|
88
88
|
* const command = new TagResourceCommand(input);
|
|
89
|
-
* await client.send(command);
|
|
90
|
-
*
|
|
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 TagResourceCommand extends TagResourceCommand_base {
|
|
95
98
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -71,21 +71,24 @@ declare const UntagResourceCommand_base: {
|
|
|
71
71
|
* @throws {@link QAppsServiceException}
|
|
72
72
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
73
73
|
*
|
|
74
|
-
*
|
|
74
|
+
*
|
|
75
75
|
* @example A call to untag a resource
|
|
76
76
|
* ```javascript
|
|
77
77
|
* //
|
|
78
78
|
* const input = {
|
|
79
|
-
*
|
|
80
|
-
*
|
|
79
|
+
* resourceARN: "arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0",
|
|
80
|
+
* tagKeys: [
|
|
81
81
|
* "department"
|
|
82
82
|
* ]
|
|
83
83
|
* };
|
|
84
84
|
* const command = new UntagResourceCommand(input);
|
|
85
|
-
* await client.send(command);
|
|
86
|
-
*
|
|
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 UntagResourceCommand extends UntagResourceCommand_base {
|
|
91
94
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -101,48 +101,48 @@ declare const UpdateLibraryItemCommand_base: {
|
|
|
101
101
|
* @throws {@link QAppsServiceException}
|
|
102
102
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
103
103
|
*
|
|
104
|
-
*
|
|
104
|
+
*
|
|
105
105
|
* @example Sets the status of a library item to DISABLED
|
|
106
106
|
* ```javascript
|
|
107
107
|
* //
|
|
108
108
|
* const input = {
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
109
|
+
* instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
110
|
+
* libraryItemId: "cb9ecf72-8563-450d-9db9-994f98297316",
|
|
111
|
+
* status: "DISABLED"
|
|
112
112
|
* };
|
|
113
113
|
* const command = new UpdateLibraryItemCommand(input);
|
|
114
114
|
* const response = await client.send(command);
|
|
115
|
-
* /* response
|
|
115
|
+
* /* response is
|
|
116
116
|
* {
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
117
|
+
* appId: "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
|
|
118
|
+
* appVersion: 6,
|
|
119
|
+
* categories: [
|
|
120
120
|
* {
|
|
121
|
-
*
|
|
122
|
-
*
|
|
121
|
+
* id: "9c871ed4-1c41-4065-aefe-321cd4b61cf8",
|
|
122
|
+
* title: "HR"
|
|
123
123
|
* },
|
|
124
124
|
* {
|
|
125
|
-
*
|
|
126
|
-
*
|
|
125
|
+
* id: "fdc4b483-c4e2-44c9-b4b2-6c850bbdb579",
|
|
126
|
+
* title: "General"
|
|
127
127
|
* },
|
|
128
128
|
* {
|
|
129
|
-
*
|
|
130
|
-
*
|
|
129
|
+
* id: "c1c4e374-118c-446f-81fb-cba6225d88da",
|
|
130
|
+
* title: "IT"
|
|
131
131
|
* }
|
|
132
132
|
* ],
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
133
|
+
* createdAt: "2024-05-21T23:17:27.350Z",
|
|
134
|
+
* createdBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
|
|
135
|
+
* isVerified: false,
|
|
136
|
+
* libraryItemId: "cb9ecf72-8563-450d-9db9-994f98297316",
|
|
137
|
+
* ratingCount: 24,
|
|
138
|
+
* status: "DISABLED",
|
|
139
|
+
* updatedAt: "2024-05-28T19:43:48.577Z",
|
|
140
|
+
* updatedBy: "a841e300-40c1-7062-fa34-5b46dadbbaac"
|
|
141
141
|
* }
|
|
142
142
|
* *\/
|
|
143
|
-
* // example id: example-1
|
|
144
143
|
* ```
|
|
145
144
|
*
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
export declare class UpdateLibraryItemCommand extends UpdateLibraryItemCommand_base {
|
|
148
148
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -77,20 +77,23 @@ declare const UpdateLibraryItemMetadataCommand_base: {
|
|
|
77
77
|
* @throws {@link QAppsServiceException}
|
|
78
78
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
79
79
|
*
|
|
80
|
-
*
|
|
80
|
+
*
|
|
81
81
|
* @example Update a library item to be verified
|
|
82
82
|
* ```javascript
|
|
83
83
|
* //
|
|
84
84
|
* const input = {
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
85
|
+
* instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
86
|
+
* isVerified: true,
|
|
87
|
+
* libraryItemId: "cb9ecf72-8563-450d-9db9-994f98297316"
|
|
88
88
|
* };
|
|
89
89
|
* const command = new UpdateLibraryItemMetadataCommand(input);
|
|
90
|
-
* await client.send(command);
|
|
91
|
-
*
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* { /* metadata only *\/ }
|
|
93
|
+
* *\/
|
|
92
94
|
* ```
|
|
93
95
|
*
|
|
96
|
+
* @public
|
|
94
97
|
*/
|
|
95
98
|
export declare class UpdateLibraryItemMetadataCommand extends UpdateLibraryItemMetadataCommand_base {
|
|
96
99
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -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
|
-
*
|
|
224
|
+
*
|
|
225
225
|
* @example Updating the title of an app
|
|
226
226
|
* ```javascript
|
|
227
227
|
* //
|
|
228
228
|
* const input = {
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
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
|
-
*
|
|
238
|
-
*
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
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
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
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
|
-
*
|
|
259
|
-
*
|
|
257
|
+
* appDefinition: {
|
|
258
|
+
* cards: [
|
|
260
259
|
* {
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
*
|
|
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
|
-
*
|
|
271
|
-
*
|
|
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
|
-
*
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
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
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
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
|
-
*
|
|
100
|
+
*
|
|
101
101
|
* @example Grant permissions for the app
|
|
102
102
|
* ```javascript
|
|
103
103
|
* //
|
|
104
104
|
* const input = {
|
|
105
|
-
*
|
|
106
|
-
*
|
|
105
|
+
* appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
106
|
+
* grantPermissions: [
|
|
107
107
|
* {
|
|
108
|
-
*
|
|
109
|
-
*
|
|
108
|
+
* action: "read",
|
|
109
|
+
* principal: "user2@example.com"
|
|
110
110
|
* }
|
|
111
111
|
* ],
|
|
112
|
-
*
|
|
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
|
-
*
|
|
119
|
-
*
|
|
118
|
+
* appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
119
|
+
* permissions: [
|
|
120
120
|
* {
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
121
|
+
* action: "write",
|
|
122
|
+
* principal: {
|
|
123
|
+
* email: "user1@example.com",
|
|
124
|
+
* userId: "f8f15330-b091-708b-d46e-adb0d914b699"
|
|
125
125
|
* }
|
|
126
126
|
* },
|
|
127
127
|
* {
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
128
|
+
* action: "read",
|
|
129
|
+
* principal: {
|
|
130
|
+
* email: "user2@example.com",
|
|
131
|
+
* userId: "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
|
|
132
132
|
* }
|
|
133
133
|
* }
|
|
134
134
|
* ],
|
|
135
|
-
*
|
|
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
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
144
|
+
* appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
145
|
+
* instanceId: "01793661-ad73-4c7d-8eaa-1c95a10151c2",
|
|
146
|
+
* revokePermissions: [
|
|
148
147
|
* {
|
|
149
|
-
*
|
|
150
|
-
*
|
|
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
|
-
*
|
|
159
|
-
*
|
|
157
|
+
* appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
158
|
+
* permissions: [
|
|
160
159
|
* {
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
160
|
+
* action: "write",
|
|
161
|
+
* principal: {
|
|
162
|
+
* email: "user1@example.com",
|
|
163
|
+
* userId: "f8f15330-b091-708b-d46e-adb0d914b699"
|
|
165
164
|
* }
|
|
166
165
|
* }
|
|
167
166
|
* ],
|
|
168
|
-
*
|
|
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 {
|