@aws-sdk/client-qapps 3.702.0 → 3.709.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/README.md +13 -14
- package/dist-cjs/models/models_0.js +11 -0
- package/dist-es/models/models_0.js +11 -0
- package/dist-types/QApps.d.ts +13 -14
- package/dist-types/QAppsClient.d.ts +13 -14
- package/dist-types/commands/AssociateLibraryItemReviewCommand.d.ts +8 -8
- package/dist-types/commands/AssociateQAppWithUserCommand.d.ts +6 -6
- package/dist-types/commands/BatchCreateCategoryCommand.d.ts +7 -5
- package/dist-types/commands/BatchDeleteCategoryCommand.d.ts +7 -5
- package/dist-types/commands/BatchUpdateCategoryCommand.d.ts +7 -5
- package/dist-types/commands/CreateLibraryItemCommand.d.ts +6 -6
- package/dist-types/commands/CreatePresignedUrlCommand.d.ts +14 -15
- package/dist-types/commands/CreateQAppCommand.d.ts +11 -10
- package/dist-types/commands/DeleteLibraryItemCommand.d.ts +6 -6
- package/dist-types/commands/DeleteQAppCommand.d.ts +4 -3
- package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts +6 -6
- package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts +3 -4
- package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +6 -6
- package/dist-types/commands/GetLibraryItemCommand.d.ts +2 -2
- package/dist-types/commands/GetQAppCommand.d.ts +6 -4
- package/dist-types/commands/GetQAppSessionCommand.d.ts +15 -5
- package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +4 -4
- package/dist-types/commands/ImportDocumentCommand.d.ts +10 -11
- package/dist-types/commands/ListCategoriesCommand.d.ts +4 -3
- package/dist-types/commands/ListLibraryItemsCommand.d.ts +4 -3
- package/dist-types/commands/ListQAppSessionDataCommand.d.ts +4 -4
- package/dist-types/commands/ListQAppsCommand.d.ts +5 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/PredictQAppCommand.d.ts +6 -6
- package/dist-types/commands/StartQAppSessionCommand.d.ts +8 -8
- package/dist-types/commands/StopQAppSessionCommand.d.ts +7 -7
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateLibraryItemCommand.d.ts +4 -4
- package/dist-types/commands/UpdateLibraryItemMetadataCommand.d.ts +4 -4
- package/dist-types/commands/UpdateQAppCommand.d.ts +7 -5
- package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateQAppSessionCommand.d.ts +9 -9
- package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +6 -5
- package/dist-types/index.d.ts +13 -14
- package/dist-types/models/models_0.d.ts +108 -78
- package/dist-types/ts3.4/models/models_0.d.ts +13 -0
- package/package.json +35 -35
package/README.md
CHANGED
|
@@ -6,20 +6,19 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript QApps Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
<i>Amazon Q Business User Guide</i>.</p>
|
|
9
|
+
<p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
|
|
10
|
+
lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
|
|
11
|
+
For example, users can create a Q App that exclusively generates marketing-related content to
|
|
12
|
+
improve your marketing team's productivity or a Q App for writing customer emails and
|
|
13
|
+
creating promotional content using a certain style of voice, tone, and branding. For more
|
|
14
|
+
information on the capabilities, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions">Amazon Q Apps capabilities</a> in the <i>Amazon Q Business User
|
|
15
|
+
Guide</i>. </p>
|
|
16
|
+
<p>For an overview of the Amazon Q App APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html">Overview of Amazon Q Apps API
|
|
17
|
+
operations</a>.</p>
|
|
18
|
+
<p>For information about the IAM access control permissions you need to use
|
|
19
|
+
the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
|
|
20
|
+
IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
|
|
21
|
+
the <i>Amazon Q Business User Guide</i>.</p>
|
|
23
22
|
|
|
24
23
|
## Installing
|
|
25
24
|
|
|
@@ -31,11 +31,22 @@ exports.InputCardComputeMode = {
|
|
|
31
31
|
REPLACE: "replace",
|
|
32
32
|
};
|
|
33
33
|
exports.PluginType = {
|
|
34
|
+
ASANA: "ASANA",
|
|
35
|
+
ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE",
|
|
34
36
|
CUSTOM: "CUSTOM",
|
|
37
|
+
GOOGLE_CALENDAR: "GOOGLE_CALENDAR",
|
|
35
38
|
JIRA: "JIRA",
|
|
39
|
+
JIRA_CLOUD: "JIRA_CLOUD",
|
|
40
|
+
MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE",
|
|
41
|
+
MICROSOFT_TEAMS: "MICROSOFT_TEAMS",
|
|
42
|
+
PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE",
|
|
36
43
|
SALESFORCE: "SALESFORCE",
|
|
44
|
+
SALESFORCE_CRM: "SALESFORCE_CRM",
|
|
45
|
+
SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM",
|
|
37
46
|
SERVICE_NOW: "SERVICE_NOW",
|
|
47
|
+
SMARTSHEET: "SMARTSHEET",
|
|
38
48
|
ZENDESK: "ZENDESK",
|
|
49
|
+
ZENDESK_SUITE: "ZENDESK_SUITE",
|
|
39
50
|
};
|
|
40
51
|
var DocumentAttributeValue;
|
|
41
52
|
(function (DocumentAttributeValue) {
|
|
@@ -27,11 +27,22 @@ export const InputCardComputeMode = {
|
|
|
27
27
|
REPLACE: "replace",
|
|
28
28
|
};
|
|
29
29
|
export const PluginType = {
|
|
30
|
+
ASANA: "ASANA",
|
|
31
|
+
ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE",
|
|
30
32
|
CUSTOM: "CUSTOM",
|
|
33
|
+
GOOGLE_CALENDAR: "GOOGLE_CALENDAR",
|
|
31
34
|
JIRA: "JIRA",
|
|
35
|
+
JIRA_CLOUD: "JIRA_CLOUD",
|
|
36
|
+
MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE",
|
|
37
|
+
MICROSOFT_TEAMS: "MICROSOFT_TEAMS",
|
|
38
|
+
PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE",
|
|
32
39
|
SALESFORCE: "SALESFORCE",
|
|
40
|
+
SALESFORCE_CRM: "SALESFORCE_CRM",
|
|
41
|
+
SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM",
|
|
33
42
|
SERVICE_NOW: "SERVICE_NOW",
|
|
43
|
+
SMARTSHEET: "SMARTSHEET",
|
|
34
44
|
ZENDESK: "ZENDESK",
|
|
45
|
+
ZENDESK_SUITE: "ZENDESK_SUITE",
|
|
35
46
|
};
|
|
36
47
|
export var DocumentAttributeValue;
|
|
37
48
|
(function (DocumentAttributeValue) {
|
package/dist-types/QApps.d.ts
CHANGED
|
@@ -248,20 +248,19 @@ export interface QApps {
|
|
|
248
248
|
updateQAppSessionMetadata(args: UpdateQAppSessionMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQAppSessionMetadataCommandOutput) => void): void;
|
|
249
249
|
}
|
|
250
250
|
/**
|
|
251
|
-
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
*
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
* <i>Amazon Q Business User Guide</i>.</p>
|
|
251
|
+
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
|
|
252
|
+
* lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
|
|
253
|
+
* For example, users can create a Q App that exclusively generates marketing-related content to
|
|
254
|
+
* improve your marketing team's productivity or a Q App for writing customer emails and
|
|
255
|
+
* creating promotional content using a certain style of voice, tone, and branding. For more
|
|
256
|
+
* information on the capabilities, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions">Amazon Q Apps capabilities</a> in the <i>Amazon Q Business User
|
|
257
|
+
* Guide</i>. </p>
|
|
258
|
+
* <p>For an overview of the Amazon Q App APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html">Overview of Amazon Q Apps API
|
|
259
|
+
* operations</a>.</p>
|
|
260
|
+
* <p>For information about the IAM access control permissions you need to use
|
|
261
|
+
* the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
|
|
262
|
+
* IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
|
|
263
|
+
* the <i>Amazon Q Business User Guide</i>.</p>
|
|
265
264
|
* @public
|
|
266
265
|
*/
|
|
267
266
|
export declare class QApps extends QAppsClient implements QApps {
|
|
@@ -186,20 +186,19 @@ export type QAppsClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
|
|
|
186
186
|
export interface QAppsClientResolvedConfig extends QAppsClientResolvedConfigType {
|
|
187
187
|
}
|
|
188
188
|
/**
|
|
189
|
-
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
* <i>Amazon Q Business User Guide</i>.</p>
|
|
189
|
+
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
|
|
190
|
+
* lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
|
|
191
|
+
* For example, users can create a Q App that exclusively generates marketing-related content to
|
|
192
|
+
* improve your marketing team's productivity or a Q App for writing customer emails and
|
|
193
|
+
* creating promotional content using a certain style of voice, tone, and branding. For more
|
|
194
|
+
* information on the capabilities, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions">Amazon Q Apps capabilities</a> in the <i>Amazon Q Business User
|
|
195
|
+
* Guide</i>. </p>
|
|
196
|
+
* <p>For an overview of the Amazon Q App APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html">Overview of Amazon Q Apps API
|
|
197
|
+
* operations</a>.</p>
|
|
198
|
+
* <p>For information about the IAM access control permissions you need to use
|
|
199
|
+
* the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
|
|
200
|
+
* IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
|
|
201
|
+
* the <i>Amazon Q Business User Guide</i>.</p>
|
|
203
202
|
* @public
|
|
204
203
|
*/
|
|
205
204
|
export declare class QAppsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, QAppsClientResolvedConfig> {
|
|
@@ -27,8 +27,8 @@ declare const AssociateLibraryItemReviewCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Associates a rating or review for a library item with the user submitting
|
|
31
|
-
*
|
|
30
|
+
* <p>Associates a rating or review for a library item with the user submitting the request.
|
|
31
|
+
* This increments the rating count for the specified library item.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -55,8 +55,8 @@ declare const AssociateLibraryItemReviewCommand_base: {
|
|
|
55
55
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
|
-
* <p>The requested operation could not be completed due to a
|
|
59
|
-
*
|
|
58
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
59
|
+
* the resource.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
62
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -65,12 +65,12 @@ declare const AssociateLibraryItemReviewCommand_base: {
|
|
|
65
65
|
* <p>The requested resource could not be found.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
68
|
-
* <p>The requested operation could not be completed because
|
|
69
|
-
*
|
|
68
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
69
|
+
* or limit.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link ThrottlingException} (client fault)
|
|
72
|
-
* <p>The requested operation could not be completed because too many
|
|
73
|
-
*
|
|
72
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
73
|
+
* once. Wait a bit and try again later.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link UnauthorizedException} (client fault)
|
|
76
76
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -28,8 +28,8 @@ declare const AssociateQAppWithUserCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>This operation creates a link between the user's identity calling the operation and a
|
|
31
|
-
* specific Q App. This is useful to mark the Q App as a <i>favorite</i> for
|
|
32
|
-
*
|
|
31
|
+
* specific Q App. This is useful to mark the Q App as a <i>favorite</i> for the
|
|
32
|
+
* user if the user doesn't own the Amazon Q App so they can still run it and see it in their
|
|
33
33
|
* inventory of Q Apps.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -63,12 +63,12 @@ declare const AssociateQAppWithUserCommand_base: {
|
|
|
63
63
|
* <p>The requested resource could not be found.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
66
|
-
* <p>The requested operation could not be completed because
|
|
67
|
-
*
|
|
66
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
67
|
+
* or limit.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
-
* <p>The requested operation could not be completed because too many
|
|
71
|
-
*
|
|
70
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
71
|
+
* once. Wait a bit and try again later.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link UnauthorizedException} (client fault)
|
|
74
74
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,7 +27,9 @@ declare const BatchCreateCategoryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates Categories for the Amazon Q Business application environment instance. Web experience users use
|
|
30
|
+
* <p>Creates Categories for the Amazon Q Business application environment instance. Web experience users use
|
|
31
|
+
* Categories to tag and filter library items. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom
|
|
32
|
+
* labels for Amazon Q Apps</a>.</p>
|
|
31
33
|
* @example
|
|
32
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
35
|
* ```javascript
|
|
@@ -60,8 +62,8 @@ declare const BatchCreateCategoryCommand_base: {
|
|
|
60
62
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
61
63
|
*
|
|
62
64
|
* @throws {@link ConflictException} (client fault)
|
|
63
|
-
* <p>The requested operation could not be completed due to a
|
|
64
|
-
*
|
|
65
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
66
|
+
* the resource.</p>
|
|
65
67
|
*
|
|
66
68
|
* @throws {@link InternalServerException} (server fault)
|
|
67
69
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -70,8 +72,8 @@ declare const BatchCreateCategoryCommand_base: {
|
|
|
70
72
|
* <p>The requested resource could not be found.</p>
|
|
71
73
|
*
|
|
72
74
|
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
-
* <p>The requested operation could not be completed because too many
|
|
74
|
-
*
|
|
75
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
76
|
+
* once. Wait a bit and try again later.</p>
|
|
75
77
|
*
|
|
76
78
|
* @throws {@link UnauthorizedException} (client fault)
|
|
77
79
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,7 +27,9 @@ declare const BatchDeleteCategoryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes Categories for the Amazon Q Business application environment instance. Web experience users use
|
|
30
|
+
* <p>Deletes Categories for the Amazon Q Business application environment instance. Web experience users use
|
|
31
|
+
* Categories to tag and filter library items. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom
|
|
32
|
+
* labels for Amazon Q Apps</a>.</p>
|
|
31
33
|
* @example
|
|
32
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
35
|
* ```javascript
|
|
@@ -56,8 +58,8 @@ declare const BatchDeleteCategoryCommand_base: {
|
|
|
56
58
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
57
59
|
*
|
|
58
60
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
* <p>The requested operation could not be completed due to a
|
|
60
|
-
*
|
|
61
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
62
|
+
* the resource.</p>
|
|
61
63
|
*
|
|
62
64
|
* @throws {@link InternalServerException} (server fault)
|
|
63
65
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -66,8 +68,8 @@ declare const BatchDeleteCategoryCommand_base: {
|
|
|
66
68
|
* <p>The requested resource could not be found.</p>
|
|
67
69
|
*
|
|
68
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
-
* <p>The requested operation could not be completed because too many
|
|
70
|
-
*
|
|
71
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
72
|
+
* once. Wait a bit and try again later.</p>
|
|
71
73
|
*
|
|
72
74
|
* @throws {@link UnauthorizedException} (client fault)
|
|
73
75
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,7 +27,9 @@ declare const BatchUpdateCategoryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates Categories for the Amazon Q Business application environment instance. Web experience users use
|
|
30
|
+
* <p>Updates Categories for the Amazon Q Business application environment instance. Web experience users use
|
|
31
|
+
* Categories to tag and filter library items. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom
|
|
32
|
+
* labels for Amazon Q Apps</a>.</p>
|
|
31
33
|
* @example
|
|
32
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
35
|
* ```javascript
|
|
@@ -60,8 +62,8 @@ declare const BatchUpdateCategoryCommand_base: {
|
|
|
60
62
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
61
63
|
*
|
|
62
64
|
* @throws {@link ConflictException} (client fault)
|
|
63
|
-
* <p>The requested operation could not be completed due to a
|
|
64
|
-
*
|
|
65
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
66
|
+
* the resource.</p>
|
|
65
67
|
*
|
|
66
68
|
* @throws {@link InternalServerException} (server fault)
|
|
67
69
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -70,8 +72,8 @@ declare const BatchUpdateCategoryCommand_base: {
|
|
|
70
72
|
* <p>The requested resource could not be found.</p>
|
|
71
73
|
*
|
|
72
74
|
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
-
* <p>The requested operation could not be completed because too many
|
|
74
|
-
*
|
|
75
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
76
|
+
* once. Wait a bit and try again later.</p>
|
|
75
77
|
*
|
|
76
78
|
* @throws {@link UnauthorizedException} (client fault)
|
|
77
79
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,8 +27,8 @@ declare const CreateLibraryItemCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new library item for an Amazon Q App, allowing it to be discovered and
|
|
31
|
-
*
|
|
30
|
+
* <p>Creates a new library item for an Amazon Q App, allowing it to be discovered and used by
|
|
31
|
+
* other allowed users. </p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -74,12 +74,12 @@ declare const CreateLibraryItemCommand_base: {
|
|
|
74
74
|
* <p>The requested resource could not be found.</p>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
77
|
-
* <p>The requested operation could not be completed because
|
|
78
|
-
*
|
|
77
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
78
|
+
* or limit.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link ThrottlingException} (client fault)
|
|
81
|
-
* <p>The requested operation could not be completed because too many
|
|
82
|
-
*
|
|
81
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
82
|
+
* once. Wait a bit and try again later.</p>
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link UnauthorizedException} (client fault)
|
|
85
85
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,11 +27,10 @@ declare const CreatePresignedUrlCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a presigned URL for an S3 POST operation to upload a file.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* either at the app definition level or the app session level.</p>
|
|
30
|
+
* <p>Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to
|
|
31
|
+
* set a default file for a <code>FileUploadCard</code> in a Q App definition or to provide a
|
|
32
|
+
* file for a single Q App run. The <code>scope</code> parameter determines how the file will be
|
|
33
|
+
* used, either at the app definition level or the app session level.</p>
|
|
35
34
|
* @example
|
|
36
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
36
|
* ```javascript
|
|
@@ -73,8 +72,8 @@ declare const CreatePresignedUrlCommand_base: {
|
|
|
73
72
|
* <p>An internal service error occurred while processing the request.</p>
|
|
74
73
|
*
|
|
75
74
|
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
-
* <p>The requested operation could not be completed because too many
|
|
77
|
-
*
|
|
75
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
76
|
+
* once. Wait a bit and try again later.</p>
|
|
78
77
|
*
|
|
79
78
|
* @throws {@link UnauthorizedException} (client fault)
|
|
80
79
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -92,7 +91,7 @@ declare const CreatePresignedUrlCommand_base: {
|
|
|
92
91
|
* const input = {
|
|
93
92
|
* "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
|
|
94
93
|
* "cardId": "82f69028-22a9-4bea-8727-0eabf58e9fed",
|
|
95
|
-
* "fileContentsSha256": "
|
|
94
|
+
* "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
|
|
96
95
|
* "fileName": "myFile.txt",
|
|
97
96
|
* "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
98
97
|
* "scope": "SESSION",
|
|
@@ -103,13 +102,13 @@ declare const CreatePresignedUrlCommand_base: {
|
|
|
103
102
|
* /* response ==
|
|
104
103
|
* {
|
|
105
104
|
* "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
|
|
106
|
-
* "presignedUrl": "https://
|
|
105
|
+
* "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/",
|
|
107
106
|
* "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
|
|
108
107
|
* "presignedUrlFields": {
|
|
109
|
-
* "x-amz-checksum-sha256": "
|
|
108
|
+
* "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
|
|
110
109
|
* "x-amz-server-side-encryption": "aws:kms",
|
|
111
110
|
* "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
|
|
112
|
-
* "x-amz-server-side-encryption-context": "
|
|
111
|
+
* "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9"
|
|
113
112
|
* }
|
|
114
113
|
* }
|
|
115
114
|
* *\/
|
|
@@ -122,7 +121,7 @@ declare const CreatePresignedUrlCommand_base: {
|
|
|
122
121
|
* const input = {
|
|
123
122
|
* "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
|
|
124
123
|
* "cardId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
|
|
125
|
-
* "fileContentsSha256": "
|
|
124
|
+
* "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
|
|
126
125
|
* "fileName": "anApplicationFile.txt",
|
|
127
126
|
* "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
128
127
|
* "scope": "APPLICATION"
|
|
@@ -132,13 +131,13 @@ declare const CreatePresignedUrlCommand_base: {
|
|
|
132
131
|
* /* response ==
|
|
133
132
|
* {
|
|
134
133
|
* "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4",
|
|
135
|
-
* "presignedUrl": "https://
|
|
134
|
+
* "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/",
|
|
136
135
|
* "presignedUrlExpiration": "2024-09-14T00:11:54.232Z",
|
|
137
136
|
* "presignedUrlFields": {
|
|
138
|
-
* "x-amz-checksum-sha256": "
|
|
137
|
+
* "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=",
|
|
139
138
|
* "x-amz-server-side-encryption": "aws:kms",
|
|
140
139
|
* "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f",
|
|
141
|
-
* "x-amz-server-side-encryption-context": "
|
|
140
|
+
* "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9"
|
|
142
141
|
* }
|
|
143
142
|
* }
|
|
144
143
|
* *\/
|
|
@@ -28,8 +28,8 @@ declare const CreateQAppCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates a new Amazon Q App based on the provided definition. The Q App definition specifies
|
|
31
|
-
* the cards and flow of the Q App. This operation also calculates the dependencies between the
|
|
32
|
-
* by inspecting the references in the prompts. </p>
|
|
31
|
+
* the cards and flow of the Q App. This operation also calculates the dependencies between the
|
|
32
|
+
* cards by inspecting the references in the prompts. </p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -144,6 +144,7 @@ declare const CreateQAppCommand_base: {
|
|
|
144
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
|
+
* actionIdentifier: "STRING_VALUE",
|
|
147
148
|
* },
|
|
148
149
|
* fileUpload: { // FileUploadCardInput
|
|
149
150
|
* title: "STRING_VALUE", // required
|
|
@@ -201,23 +202,23 @@ declare const CreateQAppCommand_base: {
|
|
|
201
202
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
202
203
|
*
|
|
203
204
|
* @throws {@link ConflictException} (client fault)
|
|
204
|
-
* <p>The requested operation could not be completed due to a
|
|
205
|
-
*
|
|
205
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
206
|
+
* the resource.</p>
|
|
206
207
|
*
|
|
207
208
|
* @throws {@link ContentTooLargeException} (client fault)
|
|
208
|
-
* <p>The requested operation could not be completed because
|
|
209
|
-
*
|
|
209
|
+
* <p>The requested operation could not be completed because the content exceeds the maximum
|
|
210
|
+
* allowed size.</p>
|
|
210
211
|
*
|
|
211
212
|
* @throws {@link InternalServerException} (server fault)
|
|
212
213
|
* <p>An internal service error occurred while processing the request.</p>
|
|
213
214
|
*
|
|
214
215
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
215
|
-
* <p>The requested operation could not be completed because
|
|
216
|
-
*
|
|
216
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
217
|
+
* or limit.</p>
|
|
217
218
|
*
|
|
218
219
|
* @throws {@link ThrottlingException} (client fault)
|
|
219
|
-
* <p>The requested operation could not be completed because too many
|
|
220
|
-
*
|
|
220
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
221
|
+
* once. Wait a bit and try again later.</p>
|
|
221
222
|
*
|
|
222
223
|
* @throws {@link UnauthorizedException} (client fault)
|
|
223
224
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,8 +27,8 @@ declare const DeleteLibraryItemCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a library item for an Amazon Q App, removing it from the library
|
|
31
|
-
*
|
|
30
|
+
* <p>Deletes a library item for an Amazon Q App, removing it from the library so it can no longer
|
|
31
|
+
* be discovered or used by other users.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -61,12 +61,12 @@ declare const DeleteLibraryItemCommand_base: {
|
|
|
61
61
|
* <p>The requested resource could not be found.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
64
|
-
* <p>The requested operation could not be completed because
|
|
65
|
-
*
|
|
64
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
65
|
+
* or limit.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ThrottlingException} (client fault)
|
|
68
|
-
* <p>The requested operation could not be completed because too many
|
|
69
|
-
*
|
|
68
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
69
|
+
* once. Wait a bit and try again later.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link UnauthorizedException} (client fault)
|
|
72
72
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,7 +27,8 @@ declare const DeleteQAppCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an Amazon Q App owned by the user. If the Q App was previously published to the
|
|
30
|
+
* <p>Deletes an Amazon Q App owned by the user. If the Q App was previously published to the
|
|
31
|
+
* library, it is also removed from the library.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -60,8 +61,8 @@ declare const DeleteQAppCommand_base: {
|
|
|
60
61
|
* <p>The requested resource could not be found.</p>
|
|
61
62
|
*
|
|
62
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
63
|
-
* <p>The requested operation could not be completed because too many
|
|
64
|
-
*
|
|
64
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
65
|
+
* once. Wait a bit and try again later.</p>
|
|
65
66
|
*
|
|
66
67
|
* @throws {@link UnauthorizedException} (client fault)
|
|
67
68
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -73,8 +73,8 @@ declare const DescribeQAppPermissionsCommand_base: {
|
|
|
73
73
|
* <p>The requested resource could not be found.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
-
* <p>The requested operation could not be completed because too many
|
|
77
|
-
*
|
|
76
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
77
|
+
* once. Wait a bit and try again later.</p>
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link UnauthorizedException} (client fault)
|
|
80
80
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -54,8 +54,8 @@ declare const DisassociateLibraryItemReviewCommand_base: {
|
|
|
54
54
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ConflictException} (client fault)
|
|
57
|
-
* <p>The requested operation could not be completed due to a
|
|
58
|
-
*
|
|
57
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
58
|
+
* the resource.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link InternalServerException} (server fault)
|
|
61
61
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -64,12 +64,12 @@ declare const DisassociateLibraryItemReviewCommand_base: {
|
|
|
64
64
|
* <p>The requested resource could not be found.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
67
|
-
* <p>The requested operation could not be completed because
|
|
68
|
-
*
|
|
67
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
68
|
+
* or limit.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
-
* <p>The requested operation could not be completed because too many
|
|
72
|
-
*
|
|
71
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
72
|
+
* once. Wait a bit and try again later.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link UnauthorizedException} (client fault)
|
|
75
75
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,8 +27,7 @@ declare const DisassociateQAppFromUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Disassociates a Q App from a user removing the user's access to run the
|
|
31
|
-
* Q App.</p>
|
|
30
|
+
* <p>Disassociates a Q App from a user removing the user's access to run the Q App.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -61,8 +60,8 @@ declare const DisassociateQAppFromUserCommand_base: {
|
|
|
61
60
|
* <p>The requested resource could not be found.</p>
|
|
62
61
|
*
|
|
63
62
|
* @throws {@link ThrottlingException} (client fault)
|
|
64
|
-
* <p>The requested operation could not be completed because too many
|
|
65
|
-
*
|
|
63
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
64
|
+
* once. Wait a bit and try again later.</p>
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link UnauthorizedException} (client fault)
|
|
68
67
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|