@aws-sdk/client-qapps 3.863.0 → 3.868.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +1 -13
  2. package/dist-types/QApps.d.ts +1 -13
  3. package/dist-types/QAppsClient.d.ts +1 -13
  4. package/dist-types/commands/AssociateLibraryItemReviewCommand.d.ts +4 -8
  5. package/dist-types/commands/AssociateQAppWithUserCommand.d.ts +3 -8
  6. package/dist-types/commands/BatchCreateCategoryCommand.d.ts +3 -7
  7. package/dist-types/commands/BatchDeleteCategoryCommand.d.ts +3 -7
  8. package/dist-types/commands/BatchUpdateCategoryCommand.d.ts +3 -7
  9. package/dist-types/commands/CreateLibraryItemCommand.d.ts +3 -6
  10. package/dist-types/commands/CreatePresignedUrlCommand.d.ts +2 -6
  11. package/dist-types/commands/CreateQAppCommand.d.ts +5 -11
  12. package/dist-types/commands/DeleteLibraryItemCommand.d.ts +3 -6
  13. package/dist-types/commands/DeleteQAppCommand.d.ts +2 -4
  14. package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +1 -2
  15. package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts +3 -6
  16. package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts +1 -2
  17. package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +3 -6
  18. package/dist-types/commands/GetLibraryItemCommand.d.ts +2 -4
  19. package/dist-types/commands/GetQAppCommand.d.ts +2 -4
  20. package/dist-types/commands/GetQAppSessionCommand.d.ts +2 -4
  21. package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +2 -4
  22. package/dist-types/commands/ImportDocumentCommand.d.ts +4 -10
  23. package/dist-types/commands/ListCategoriesCommand.d.ts +2 -4
  24. package/dist-types/commands/ListLibraryItemsCommand.d.ts +2 -4
  25. package/dist-types/commands/ListQAppSessionDataCommand.d.ts +2 -4
  26. package/dist-types/commands/ListQAppsCommand.d.ts +2 -5
  27. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
  28. package/dist-types/commands/PredictQAppCommand.d.ts +2 -5
  29. package/dist-types/commands/StartQAppSessionCommand.d.ts +3 -10
  30. package/dist-types/commands/StopQAppSessionCommand.d.ts +3 -7
  31. package/dist-types/commands/TagResourceCommand.d.ts +2 -4
  32. package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
  33. package/dist-types/commands/UpdateLibraryItemCommand.d.ts +2 -4
  34. package/dist-types/commands/UpdateLibraryItemMetadataCommand.d.ts +2 -4
  35. package/dist-types/commands/UpdateQAppCommand.d.ts +3 -6
  36. package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +1 -2
  37. package/dist-types/commands/UpdateQAppSessionCommand.d.ts +3 -9
  38. package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +3 -6
  39. package/dist-types/index.d.ts +1 -13
  40. package/dist-types/models/models_0.d.ts +38 -91
  41. package/package.json +5 -5
@@ -27,9 +27,7 @@ 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 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>
30
+ * <p>Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -74,8 +72,7 @@ declare const ListQAppsCommand_base: {
74
72
  * <p>An internal service error occurred while processing the request.</p>
75
73
  *
76
74
  * @throws {@link ThrottlingException} (client fault)
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>
75
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
79
76
  *
80
77
  * @throws {@link UnauthorizedException} (client fault)
81
78
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -63,8 +63,7 @@ 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 requests were sent at
67
- * once. Wait a bit and try again later.</p>
66
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
68
67
  *
69
68
  * @throws {@link ValidationException} (client fault)
70
69
  * <p>The input failed to satisfy the constraints specified by the service.</p>
@@ -27,9 +27,7 @@ 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 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>
30
+ * <p>Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call <code>CreateQApp</code>. This API doesn't create Amazon Q Apps directly.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -200,8 +198,7 @@ declare const PredictQAppCommand_base: {
200
198
  * <p>An internal service error occurred while processing the request.</p>
201
199
  *
202
200
  * @throws {@link ThrottlingException} (client fault)
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>
201
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
205
202
  *
206
203
  * @throws {@link UnauthorizedException} (client fault)
207
204
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -27,12 +27,7 @@ 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 and the app to be
31
- * run.</p>
32
- * <note>
33
- * <p>Each Q App session will be condensed into a single conversation in the web
34
- * experience.</p>
35
- * </note>
30
+ * <p>Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.</p> <note> <p>Each Q App session will be condensed into a single conversation in the web experience.</p> </note>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -83,12 +78,10 @@ declare const StartQAppSessionCommand_base: {
83
78
  * <p>The requested resource could not be found.</p>
84
79
  *
85
80
  * @throws {@link ServiceQuotaExceededException} (client fault)
86
- * <p>The requested operation could not be completed because it would exceed the service's quota
87
- * or limit.</p>
81
+ * <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
88
82
  *
89
83
  * @throws {@link ThrottlingException} (client fault)
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>
84
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
92
85
  *
93
86
  * @throws {@link UnauthorizedException} (client fault)
94
87
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -27,9 +27,7 @@ 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 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>
30
+ * <p>Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -62,12 +60,10 @@ declare const StopQAppSessionCommand_base: {
62
60
  * <p>The requested resource could not be found.</p>
63
61
  *
64
62
  * @throws {@link ServiceQuotaExceededException} (client fault)
65
- * <p>The requested operation could not be completed because it would exceed the service's quota
66
- * or limit.</p>
63
+ * <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
67
64
  *
68
65
  * @throws {@link ThrottlingException} (client fault)
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>
66
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
71
67
  *
72
68
  * @throws {@link UnauthorizedException} (client fault)
73
69
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -56,8 +56,7 @@ 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 conflict with the current state of
60
- * the resource.</p>
59
+ * <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
61
60
  *
62
61
  * @throws {@link InternalServerException} (server fault)
63
62
  * <p>An internal service error occurred while processing the request.</p>
@@ -66,8 +65,7 @@ declare const TagResourceCommand_base: {
66
65
  * <p>The requested resource could not be found.</p>
67
66
  *
68
67
  * @throws {@link ThrottlingException} (client fault)
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>
68
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
71
69
  *
72
70
  * @throws {@link ValidationException} (client fault)
73
71
  * <p>The input failed to satisfy the constraints specified by the service.</p>
@@ -62,8 +62,7 @@ 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 requests were sent at
66
- * once. Wait a bit and try again later.</p>
65
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
67
66
  *
68
67
  * @throws {@link ValidationException} (client fault)
69
68
  * <p>The input failed to satisfy the constraints specified by the service.</p>
@@ -79,8 +79,7 @@ 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 conflict with the current state of
83
- * the resource.</p>
82
+ * <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
84
83
  *
85
84
  * @throws {@link InternalServerException} (server fault)
86
85
  * <p>An internal service error occurred while processing the request.</p>
@@ -89,8 +88,7 @@ declare const UpdateLibraryItemCommand_base: {
89
88
  * <p>The requested resource could not be found.</p>
90
89
  *
91
90
  * @throws {@link ThrottlingException} (client fault)
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>
91
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
94
92
  *
95
93
  * @throws {@link UnauthorizedException} (client fault)
96
94
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -55,8 +55,7 @@ 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 conflict with the current state of
59
- * the resource.</p>
58
+ * <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
60
59
  *
61
60
  * @throws {@link InternalServerException} (server fault)
62
61
  * <p>An internal service error occurred while processing the request.</p>
@@ -65,8 +64,7 @@ declare const UpdateLibraryItemMetadataCommand_base: {
65
64
  * <p>The requested resource could not be found.</p>
66
65
  *
67
66
  * @throws {@link ThrottlingException} (client fault)
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>
67
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
70
68
  *
71
69
  * @throws {@link UnauthorizedException} (client fault)
72
70
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -27,8 +27,7 @@ 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
31
- * definition.</p>
30
+ * <p>Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -199,8 +198,7 @@ declare const UpdateQAppCommand_base: {
199
198
  * <p>The client is not authorized to perform the requested operation.</p>
200
199
  *
201
200
  * @throws {@link ContentTooLargeException} (client fault)
202
- * <p>The requested operation could not be completed because the content exceeds the maximum
203
- * allowed size.</p>
201
+ * <p>The requested operation could not be completed because the content exceeds the maximum allowed size.</p>
204
202
  *
205
203
  * @throws {@link InternalServerException} (server fault)
206
204
  * <p>An internal service error occurred while processing the request.</p>
@@ -209,8 +207,7 @@ declare const UpdateQAppCommand_base: {
209
207
  * <p>The requested resource could not be found.</p>
210
208
  *
211
209
  * @throws {@link ThrottlingException} (client fault)
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>
210
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
214
211
  *
215
212
  * @throws {@link UnauthorizedException} (client fault)
216
213
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -85,8 +85,7 @@ declare const UpdateQAppPermissionsCommand_base: {
85
85
  * <p>The requested resource could not be found.</p>
86
86
  *
87
87
  * @throws {@link ThrottlingException} (client fault)
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>
88
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
90
89
  *
91
90
  * @throws {@link UnauthorizedException} (client fault)
92
91
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -27,11 +27,7 @@ declare const UpdateQAppSessionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the session for a given Q App <code>sessionId</code>. This is only valid when at
31
- * least one card of the session is in the <code>WAITING</code> state. Data for each
32
- * <code>WAITING</code> card can be provided as input. If inputs are not provided, the call
33
- * will be accepted but session will not move forward. Inputs for cards that are not in the
34
- * <code>WAITING</code> status will be ignored.</p>
30
+ * <p>Updates the session for a given Q App <code>sessionId</code>. This is only valid when at least one card of the session is in the <code>WAITING</code> state. Data for each <code>WAITING</code> card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the <code>WAITING</code> status will be ignored.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -77,12 +73,10 @@ declare const UpdateQAppSessionCommand_base: {
77
73
  * <p>The requested resource could not be found.</p>
78
74
  *
79
75
  * @throws {@link ServiceQuotaExceededException} (client fault)
80
- * <p>The requested operation could not be completed because it would exceed the service's quota
81
- * or limit.</p>
76
+ * <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
82
77
  *
83
78
  * @throws {@link ThrottlingException} (client fault)
84
- * <p>The requested operation could not be completed because too many requests were sent at
85
- * once. Wait a bit and try again later.</p>
79
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
86
80
  *
87
81
  * @throws {@link UnauthorizedException} (client fault)
88
82
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -27,8 +27,7 @@ declare const UpdateQAppSessionMetadataCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the configuration metadata of a session for a given Q App
31
- * <code>sessionId</code>.</p>
30
+ * <p>Updates the configuration metadata of a session for a given Q App <code>sessionId</code>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -76,12 +75,10 @@ declare const UpdateQAppSessionMetadataCommand_base: {
76
75
  * <p>The requested resource could not be found.</p>
77
76
  *
78
77
  * @throws {@link ServiceQuotaExceededException} (client fault)
79
- * <p>The requested operation could not be completed because it would exceed the service's quota
80
- * or limit.</p>
78
+ * <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
81
79
  *
82
80
  * @throws {@link ThrottlingException} (client fault)
83
- * <p>The requested operation could not be completed because too many requests were sent at
84
- * once. Wait a bit and try again later.</p>
81
+ * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
85
82
  *
86
83
  * @throws {@link UnauthorizedException} (client fault)
87
84
  * <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -1,17 +1,5 @@
1
1
  /**
2
- * <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
3
- * lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
4
- * For example, users can create a Q App that exclusively generates marketing-related content to
5
- * improve your marketing team's productivity or a Q App for writing customer emails and
6
- * creating promotional content using a certain style of voice, tone, and branding. For more
7
- * 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
8
- * Guide</i>. </p>
9
- * <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
10
- * operations</a>.</p>
11
- * <p>For information about the IAM access control permissions you need to use
12
- * the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
13
- * IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
14
- * the <i>Amazon Q Business User Guide</i>.</p>
2
+ * <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more 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 Guide</i>. </p> <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 operations</a>.</p> <p>For information about the IAM access control permissions you need to use the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html"> IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in the <i>Amazon Q Business User Guide</i>.</p>
15
3
  *
16
4
  * @packageDocumentation
17
5
  */