@aws-sdk/client-qapps 3.701.0 → 3.705.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 +65 -7
- 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 +36 -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 +29 -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 +75 -2
- package/dist-types/commands/UpdateQAppSessionCommand.d.ts +9 -9
- package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +36 -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 +1 -1
|
@@ -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>
|
|
@@ -58,8 +58,8 @@ declare const ExportQAppSessionDataCommand_base: {
|
|
|
58
58
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ConflictException} (client fault)
|
|
61
|
-
* <p>The requested operation could not be completed due to a
|
|
62
|
-
*
|
|
61
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
62
|
+
* the resource.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link InternalServerException} (server fault)
|
|
65
65
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -68,12 +68,12 @@ declare const ExportQAppSessionDataCommand_base: {
|
|
|
68
68
|
* <p>The requested resource could not be found.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
71
|
-
* <p>The requested operation could not be completed because
|
|
72
|
-
*
|
|
71
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
72
|
+
* or limit.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
-
* <p>The requested operation could not be completed because too many
|
|
76
|
-
*
|
|
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>
|
|
77
77
|
*
|
|
78
78
|
* @throws {@link UnauthorizedException} (client fault)
|
|
79
79
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -83,8 +83,8 @@ declare const GetLibraryItemCommand_base: {
|
|
|
83
83
|
* <p>The requested resource could not be found.</p>
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link ThrottlingException} (client fault)
|
|
86
|
-
* <p>The requested operation could not be completed because too many
|
|
87
|
-
*
|
|
86
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
87
|
+
* once. Wait a bit and try again later.</p>
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link UnauthorizedException} (client fault)
|
|
90
90
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,7 +27,8 @@ declare const GetQAppCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the full details of an Q App, including its definition specifying the cards and
|
|
30
|
+
* <p>Retrieves the full details of an Q App, including its definition specifying the cards and
|
|
31
|
+
* flow.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -172,8 +173,9 @@ declare const GetQAppCommand_base: {
|
|
|
172
173
|
* // ],
|
|
173
174
|
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
174
175
|
* // prompt: "STRING_VALUE", // required
|
|
175
|
-
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM", // required
|
|
176
|
+
* // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM" || "ASANA" || "ATLASSIAN_CONFLUENCE" || "GOOGLE_CALENDAR" || "JIRA_CLOUD" || "MICROSOFT_EXCHANGE" || "MICROSOFT_TEAMS" || "PAGERDUTY_ADVANCE" || "SALESFORCE_CRM" || "SERVICENOW_NOW_PLATFORM" || "SMARTSHEET" || "ZENDESK_SUITE", // required
|
|
176
177
|
* // pluginId: "STRING_VALUE", // required
|
|
178
|
+
* // actionIdentifier: "STRING_VALUE",
|
|
177
179
|
* // },
|
|
178
180
|
* // fileUpload: { // FileUploadCard
|
|
179
181
|
* // id: "STRING_VALUE", // required
|
|
@@ -222,8 +224,8 @@ declare const GetQAppCommand_base: {
|
|
|
222
224
|
* <p>The requested resource could not be found.</p>
|
|
223
225
|
*
|
|
224
226
|
* @throws {@link ThrottlingException} (client fault)
|
|
225
|
-
* <p>The requested operation could not be completed because too many
|
|
226
|
-
*
|
|
227
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
228
|
+
* once. Wait a bit and try again later.</p>
|
|
227
229
|
*
|
|
228
230
|
* @throws {@link UnauthorizedException} (client fault)
|
|
229
231
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -81,12 +81,12 @@ declare const GetQAppSessionCommand_base: {
|
|
|
81
81
|
* <p>The requested resource could not be found.</p>
|
|
82
82
|
*
|
|
83
83
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
84
|
-
* <p>The requested operation could not be completed because
|
|
85
|
-
*
|
|
84
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
85
|
+
* or limit.</p>
|
|
86
86
|
*
|
|
87
87
|
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
-
* <p>The requested operation could not be completed because too many
|
|
89
|
-
*
|
|
88
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
89
|
+
* once. Wait a bit and try again later.</p>
|
|
90
90
|
*
|
|
91
91
|
* @throws {@link UnauthorizedException} (client fault)
|
|
92
92
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -116,7 +116,17 @@ declare const GetQAppSessionCommand_base: {
|
|
|
116
116
|
* },
|
|
117
117
|
* "6fb5b404-3b7b-48a4-8a8b-56406922a606": {
|
|
118
118
|
* "currentState": "COMPLETED",
|
|
119
|
-
* "currentValue": ""
|
|
119
|
+
* "currentValue": "",
|
|
120
|
+
* "submissions": [
|
|
121
|
+
* {
|
|
122
|
+
* "value": {
|
|
123
|
+
* "18cee4cb-253e-4f87-9154-849fbb98e482": "user1",
|
|
124
|
+
* "d52030f9-6c4b-47a9-a946-377f632c77cc": "red"
|
|
125
|
+
* },
|
|
126
|
+
* "submissionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
|
|
127
|
+
* "timestamp": "2023-06-15T14:30:45Z"
|
|
128
|
+
* }
|
|
129
|
+
* ]
|
|
120
130
|
* }
|
|
121
131
|
* },
|
|
122
132
|
* "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",
|
|
@@ -70,12 +70,12 @@ declare const GetQAppSessionMetadataCommand_base: {
|
|
|
70
70
|
* <p>The requested resource could not be found.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
73
|
-
* <p>The requested operation could not be completed because
|
|
74
|
-
*
|
|
73
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
74
|
+
* or limit.</p>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
-
* <p>The requested operation could not be completed because too many
|
|
78
|
-
*
|
|
77
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
78
|
+
* once. Wait a bit and try again later.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link UnauthorizedException} (client fault)
|
|
81
81
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -87,6 +87,31 @@ declare const GetQAppSessionMetadataCommand_base: {
|
|
|
87
87
|
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
88
88
|
*
|
|
89
89
|
* @public
|
|
90
|
+
* @example Retrieves an existing session metadata for an Amazon Q App
|
|
91
|
+
* ```javascript
|
|
92
|
+
* //
|
|
93
|
+
* const input = {
|
|
94
|
+
* "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
95
|
+
* "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb"
|
|
96
|
+
* };
|
|
97
|
+
* const command = new GetQAppSessionMetadataCommand(input);
|
|
98
|
+
* const response = await client.send(command);
|
|
99
|
+
* /* response ==
|
|
100
|
+
* {
|
|
101
|
+
* "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",
|
|
102
|
+
* "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
|
|
103
|
+
* "sessionName": "Trip itinerary collection session",
|
|
104
|
+
* "sessionOwner": true,
|
|
105
|
+
* "sharingConfiguration": {
|
|
106
|
+
* "acceptResponses": true,
|
|
107
|
+
* "enabled": true,
|
|
108
|
+
* "revealCards": false
|
|
109
|
+
* }
|
|
110
|
+
* }
|
|
111
|
+
* *\/
|
|
112
|
+
* // example id: example-1
|
|
113
|
+
* ```
|
|
114
|
+
*
|
|
90
115
|
*/
|
|
91
116
|
export declare class GetQAppSessionMetadataCommand extends GetQAppSessionMetadataCommand_base {
|
|
92
117
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -27,11 +27,10 @@ declare const ImportDocumentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Uploads a file that can then be used either as a default in a
|
|
31
|
-
*
|
|
32
|
-
* is
|
|
33
|
-
*
|
|
34
|
-
* app definition level or at the app session level.</p>
|
|
30
|
+
* <p>Uploads a file that can then be used either as a default in a <code>FileUploadCard</code>
|
|
31
|
+
* from Q App definition or as a file that is used inside a single Q App run. The purpose of
|
|
32
|
+
* the document is determined by a scope parameter that indicates whether it is at the app
|
|
33
|
+
* definition level or at 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
|
|
@@ -65,8 +64,8 @@ declare const ImportDocumentCommand_base: {
|
|
|
65
64
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link ContentTooLargeException} (client fault)
|
|
68
|
-
* <p>The requested operation could not be completed because
|
|
69
|
-
*
|
|
67
|
+
* <p>The requested operation could not be completed because the content exceeds the maximum
|
|
68
|
+
* allowed size.</p>
|
|
70
69
|
*
|
|
71
70
|
* @throws {@link InternalServerException} (server fault)
|
|
72
71
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -75,12 +74,12 @@ declare const ImportDocumentCommand_base: {
|
|
|
75
74
|
* <p>The requested resource could not be found.</p>
|
|
76
75
|
*
|
|
77
76
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
-
* <p>The requested operation could not be completed because
|
|
79
|
-
*
|
|
77
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
78
|
+
* or limit.</p>
|
|
80
79
|
*
|
|
81
80
|
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
-
* <p>The requested operation could not be completed because too many
|
|
83
|
-
*
|
|
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>
|
|
84
83
|
*
|
|
85
84
|
* @throws {@link UnauthorizedException} (client fault)
|
|
86
85
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,7 +27,8 @@ declare const ListCategoriesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the categories of a Amazon Q Business application environment instance. For more information, see
|
|
30
|
+
* <p>Lists the categories of a Amazon Q Business application environment instance. For more information, see
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom labels for Amazon Q Apps</a>.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -68,8 +69,8 @@ declare const ListCategoriesCommand_base: {
|
|
|
68
69
|
* <p>The requested resource could not be found.</p>
|
|
69
70
|
*
|
|
70
71
|
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
-
* <p>The requested operation could not be completed because too many
|
|
72
|
-
*
|
|
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>
|
|
73
74
|
*
|
|
74
75
|
* @throws {@link UnauthorizedException} (client fault)
|
|
75
76
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,7 +27,8 @@ declare const ListLibraryItemsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the library items for Amazon Q Apps that are published and available for users in your
|
|
30
|
+
* <p>Lists the library items for Amazon Q Apps that are published and available for users in your
|
|
31
|
+
* Amazon Web Services account.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -88,8 +89,8 @@ declare const ListLibraryItemsCommand_base: {
|
|
|
88
89
|
* <p>The requested resource could not be found.</p>
|
|
89
90
|
*
|
|
90
91
|
* @throws {@link ThrottlingException} (client fault)
|
|
91
|
-
* <p>The requested operation could not be completed because too many
|
|
92
|
-
*
|
|
92
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
93
|
+
* once. Wait a bit and try again later.</p>
|
|
93
94
|
*
|
|
94
95
|
* @throws {@link UnauthorizedException} (client fault)
|
|
95
96
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -75,12 +75,12 @@ declare const ListQAppSessionDataCommand_base: {
|
|
|
75
75
|
* <p>The requested resource could not be found.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
-
* <p>The requested operation could not be completed because
|
|
79
|
-
*
|
|
78
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
79
|
+
* or limit.</p>
|
|
80
80
|
*
|
|
81
81
|
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
-
* <p>The requested operation could not be completed because too many
|
|
83
|
-
*
|
|
82
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
83
|
+
* once. Wait a bit and try again later.</p>
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link UnauthorizedException} (client fault)
|
|
86
86
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,9 +27,9 @@ declare const ListQAppsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the Amazon Q Apps owned by or associated with the user either because
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Lists the Amazon Q Apps owned by or associated with the user either because they created it
|
|
31
|
+
* or because they used it from the library in the past. The user identity is extracted from the
|
|
32
|
+
* credentials used to invoke this operation..</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -74,8 +74,8 @@ declare const ListQAppsCommand_base: {
|
|
|
74
74
|
* <p>An internal service error occurred while processing the request.</p>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
-
* <p>The requested operation could not be completed because too many
|
|
78
|
-
*
|
|
77
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
78
|
+
* once. Wait a bit and try again later.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link UnauthorizedException} (client fault)
|
|
81
81
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -63,8 +63,8 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
63
63
|
* <p>The requested resource could not be found.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
-
* <p>The requested operation could not be completed because too many
|
|
67
|
-
*
|
|
66
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
67
|
+
* once. Wait a bit and try again later.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
70
|
* <p>The input failed to satisfy the constraints specified by the service.</p>
|
|
@@ -27,10 +27,9 @@ declare const PredictQAppCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Generates an Amazon Q App definition based on either a conversation or
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* Amazon Q Apps directly.</p>
|
|
30
|
+
* <p>Generates an Amazon Q App definition based on either a conversation or a problem statement
|
|
31
|
+
* provided as input.The resulting app definition can be used to call <code>CreateQApp</code>.
|
|
32
|
+
* This API doesn't create Amazon Q Apps directly.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -159,6 +158,7 @@ declare const PredictQAppCommand_base: {
|
|
|
159
158
|
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
160
159
|
* // prompt: "STRING_VALUE", // required
|
|
161
160
|
* // pluginId: "STRING_VALUE", // required
|
|
161
|
+
* // actionIdentifier: "STRING_VALUE",
|
|
162
162
|
* // },
|
|
163
163
|
* // fileUpload: { // FileUploadCardInput
|
|
164
164
|
* // title: "STRING_VALUE", // required
|
|
@@ -200,8 +200,8 @@ declare const PredictQAppCommand_base: {
|
|
|
200
200
|
* <p>An internal service error occurred while processing the request.</p>
|
|
201
201
|
*
|
|
202
202
|
* @throws {@link ThrottlingException} (client fault)
|
|
203
|
-
* <p>The requested operation could not be completed because too many
|
|
204
|
-
*
|
|
203
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
204
|
+
* once. Wait a bit and try again later.</p>
|
|
205
205
|
*
|
|
206
206
|
* @throws {@link UnauthorizedException} (client fault)
|
|
207
207
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,11 +27,11 @@ declare const StartQAppSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Starts a new session for an Amazon Q App, allowing inputs to be provided
|
|
31
|
-
*
|
|
30
|
+
* <p>Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be
|
|
31
|
+
* run.</p>
|
|
32
32
|
* <note>
|
|
33
|
-
* <p>Each Q App session will be condensed into a single conversation
|
|
34
|
-
*
|
|
33
|
+
* <p>Each Q App session will be condensed into a single conversation in the web
|
|
34
|
+
* experience.</p>
|
|
35
35
|
* </note>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -83,12 +83,12 @@ declare const StartQAppSessionCommand_base: {
|
|
|
83
83
|
* <p>The requested resource could not be found.</p>
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
86
|
-
* <p>The requested operation could not be completed because
|
|
87
|
-
*
|
|
86
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
87
|
+
* or limit.</p>
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
-
* <p>The requested operation could not be completed because too many
|
|
91
|
-
*
|
|
90
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
91
|
+
* once. Wait a bit and try again later.</p>
|
|
92
92
|
*
|
|
93
93
|
* @throws {@link UnauthorizedException} (client fault)
|
|
94
94
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -27,9 +27,9 @@ declare const StopQAppSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Stops an active session for an Amazon Q App.This deletes all data
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Stops an active session for an Amazon Q App.This deletes all data related to the session and
|
|
31
|
+
* makes it invalid for future uses. The results of the session will be persisted as part of the
|
|
32
|
+
* conversation.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -62,12 +62,12 @@ declare const StopQAppSessionCommand_base: {
|
|
|
62
62
|
* <p>The requested resource could not be found.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
65
|
-
* <p>The requested operation could not be completed because
|
|
66
|
-
*
|
|
65
|
+
* <p>The requested operation could not be completed because it would exceed the service's quota
|
|
66
|
+
* or limit.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
-
* <p>The requested operation could not be completed because too many
|
|
70
|
-
*
|
|
69
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
70
|
+
* once. Wait a bit and try again later.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link UnauthorizedException} (client fault)
|
|
73
73
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -56,8 +56,8 @@ declare const TagResourceCommand_base: {
|
|
|
56
56
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
* <p>The requested operation could not be completed due to a
|
|
60
|
-
*
|
|
59
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
60
|
+
* the resource.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link InternalServerException} (server fault)
|
|
63
63
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -66,8 +66,8 @@ declare const TagResourceCommand_base: {
|
|
|
66
66
|
* <p>The requested resource could not be found.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
-
* <p>The requested operation could not be completed because too many
|
|
70
|
-
*
|
|
69
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
70
|
+
* once. Wait a bit and try again later.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ValidationException} (client fault)
|
|
73
73
|
* <p>The input failed to satisfy the constraints specified by the service.</p>
|
|
@@ -62,8 +62,8 @@ declare const UntagResourceCommand_base: {
|
|
|
62
62
|
* <p>The requested resource could not be found.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
-
* <p>The requested operation could not be completed because too many
|
|
66
|
-
*
|
|
65
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
66
|
+
* once. Wait a bit and try again later.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ValidationException} (client fault)
|
|
69
69
|
* <p>The input failed to satisfy the constraints specified by the service.</p>
|
|
@@ -79,8 +79,8 @@ declare const UpdateLibraryItemCommand_base: {
|
|
|
79
79
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
80
80
|
*
|
|
81
81
|
* @throws {@link ConflictException} (client fault)
|
|
82
|
-
* <p>The requested operation could not be completed due to a
|
|
83
|
-
*
|
|
82
|
+
* <p>The requested operation could not be completed due to a conflict with the current state of
|
|
83
|
+
* the resource.</p>
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link InternalServerException} (server fault)
|
|
86
86
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -89,8 +89,8 @@ declare const UpdateLibraryItemCommand_base: {
|
|
|
89
89
|
* <p>The requested resource could not be found.</p>
|
|
90
90
|
*
|
|
91
91
|
* @throws {@link ThrottlingException} (client fault)
|
|
92
|
-
* <p>The requested operation could not be completed because too many
|
|
93
|
-
*
|
|
92
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
93
|
+
* once. Wait a bit and try again later.</p>
|
|
94
94
|
*
|
|
95
95
|
* @throws {@link UnauthorizedException} (client fault)
|
|
96
96
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
@@ -55,8 +55,8 @@ declare const UpdateLibraryItemMetadataCommand_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,8 +65,8 @@ declare const UpdateLibraryItemMetadataCommand_base: {
|
|
|
65
65
|
* <p>The requested resource could not be found.</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 UpdateQAppCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates an existing Amazon Q App, allowing modifications to its title, description, and
|
|
30
|
+
* <p>Updates an existing Amazon Q App, allowing modifications to its title, description, and
|
|
31
|
+
* definition.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -143,6 +144,7 @@ declare const UpdateQAppCommand_base: {
|
|
|
143
144
|
* type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
144
145
|
* prompt: "STRING_VALUE", // required
|
|
145
146
|
* pluginId: "STRING_VALUE", // required
|
|
147
|
+
* actionIdentifier: "STRING_VALUE",
|
|
146
148
|
* },
|
|
147
149
|
* fileUpload: { // FileUploadCardInput
|
|
148
150
|
* title: "STRING_VALUE", // required
|
|
@@ -197,8 +199,8 @@ declare const UpdateQAppCommand_base: {
|
|
|
197
199
|
* <p>The client is not authorized to perform the requested operation.</p>
|
|
198
200
|
*
|
|
199
201
|
* @throws {@link ContentTooLargeException} (client fault)
|
|
200
|
-
* <p>The requested operation could not be completed because
|
|
201
|
-
*
|
|
202
|
+
* <p>The requested operation could not be completed because the content exceeds the maximum
|
|
203
|
+
* allowed size.</p>
|
|
202
204
|
*
|
|
203
205
|
* @throws {@link InternalServerException} (server fault)
|
|
204
206
|
* <p>An internal service error occurred while processing the request.</p>
|
|
@@ -207,8 +209,8 @@ declare const UpdateQAppCommand_base: {
|
|
|
207
209
|
* <p>The requested resource could not be found.</p>
|
|
208
210
|
*
|
|
209
211
|
* @throws {@link ThrottlingException} (client fault)
|
|
210
|
-
* <p>The requested operation could not be completed because too many
|
|
211
|
-
*
|
|
212
|
+
* <p>The requested operation could not be completed because too many requests were sent at
|
|
213
|
+
* once. Wait a bit and try again later.</p>
|
|
212
214
|
*
|
|
213
215
|
* @throws {@link UnauthorizedException} (client fault)
|
|
214
216
|
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|