+188
-394
lines changedFilter options
+188
-394
lines changed Original file line number Diff line number Diff line change
@@ -6,19 +6,7 @@
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 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>
9 +
<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>
22 10 23 11
## Installing
24 12
@@ -724,19 +724,7 @@ export interface QApps {
724 724
}
725 725 726 726
/**
727 -
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
728 -
* lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
729 -
* For example, users can create a Q App that exclusively generates marketing-related content to
730 -
* improve your marketing team's productivity or a Q App for writing customer emails and
731 -
* creating promotional content using a certain style of voice, tone, and branding. For more
732 -
* 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
733 -
* Guide</i>. </p>
734 -
* <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
735 -
* operations</a>.</p>
736 -
* <p>For information about the IAM access control permissions you need to use
737 -
* the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
738 -
* IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
739 -
* the <i>Amazon Q Business User Guide</i>.</p>
727 +
* <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>
740 728
* @public
741 729
*/
742 730
export class QApps extends QAppsClient implements QApps {}
@@ -415,19 +415,7 @@ export type QAppsClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
415 415
export interface QAppsClientResolvedConfig extends QAppsClientResolvedConfigType {}
416 416 417 417
/**
418 -
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
419 -
* lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
420 -
* For example, users can create a Q App that exclusively generates marketing-related content to
421 -
* improve your marketing team's productivity or a Q App for writing customer emails and
422 -
* creating promotional content using a certain style of voice, tone, and branding. For more
423 -
* 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
424 -
* Guide</i>. </p>
425 -
* <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
426 -
* operations</a>.</p>
427 -
* <p>For information about the IAM access control permissions you need to use
428 -
* the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
429 -
* IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
430 -
* the <i>Amazon Q Business User Guide</i>.</p>
418 +
* <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>
431 419
* @public
432 420
*/
433 421
export class QAppsClient extends __Client<
@@ -28,8 +28,7 @@ export interface AssociateLibraryItemReviewCommandInput extends AssociateLibrary
28 28
export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Associates a rating or review for a library item with the user submitting the request.
32 -
* This increments the rating count for the specified library item.</p>
31 +
* <p>Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.</p>
33 32
* @example
34 33
* Use a bare-bones client and the command you need to make an API call.
35 34
* ```javascript
@@ -56,8 +55,7 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare
56 55
* <p>The client is not authorized to perform the requested operation.</p>
57 56
*
58 57
* @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>
58 +
* <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
61 59
*
62 60
* @throws {@link InternalServerException} (server fault)
63 61
* <p>An internal service error occurred while processing the request.</p>
@@ -66,12 +64,10 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare
66 64
* <p>The requested resource could not be found.</p>
67 65
*
68 66
* @throws {@link ServiceQuotaExceededException} (client fault)
69 -
* <p>The requested operation could not be completed because it would exceed the service's quota
70 -
* or limit.</p>
67 +
* <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
71 68
*
72 69
* @throws {@link ThrottlingException} (client fault)
73 -
* <p>The requested operation could not be completed because too many requests were sent at
74 -
* once. Wait a bit and try again later.</p>
70 +
* <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
75 71
*
76 72
* @throws {@link UnauthorizedException} (client fault)
77 73
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -28,10 +28,7 @@ export interface AssociateQAppWithUserCommandInput extends AssociateQAppWithUser
28 28
export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>This operation creates a link between the user's identity calling the operation and a
32 -
* specific Q App. This is useful to mark the Q App as a <i>favorite</i> for the
33 -
* user if the user doesn't own the Amazon Q App so they can still run it and see it in their
34 -
* inventory of Q Apps.</p>
31 +
* <p>This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a <i>favorite</i> for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.</p>
35 32
* @example
36 33
* Use a bare-bones client and the command you need to make an API call.
37 34
* ```javascript
@@ -64,12 +61,10 @@ export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {}
64 61
* <p>The requested resource could not be found.</p>
65 62
*
66 63
* @throws {@link ServiceQuotaExceededException} (client fault)
67 -
* <p>The requested operation could not be completed because it would exceed the service's quota
68 -
* or limit.</p>
64 +
* <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
69 65
*
70 66
* @throws {@link ThrottlingException} (client fault)
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>
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>
73 68
*
74 69
* @throws {@link UnauthorizedException} (client fault)
75 70
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -28,9 +28,7 @@ export interface BatchCreateCategoryCommandInput extends BatchCreateCategoryInpu
28 28
export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Creates Categories for the Amazon Q Business application environment instance. Web experience users use
32 -
* 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
33 -
* labels for Amazon Q Apps</a>.</p>
31 +
* <p>Creates Categories for the Amazon Q Business application environment instance. Web experience users use 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 labels for Amazon Q Apps</a>.</p>
34 32
* @example
35 33
* Use a bare-bones client and the command you need to make an API call.
36 34
* ```javascript
@@ -63,8 +61,7 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
63 61
* <p>The client is not authorized to perform the requested operation.</p>
64 62
*
65 63
* @throws {@link ConflictException} (client fault)
66 -
* <p>The requested operation could not be completed due to a conflict with the current state of
67 -
* the resource.</p>
64 +
* <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
68 65
*
69 66
* @throws {@link InternalServerException} (server fault)
70 67
* <p>An internal service error occurred while processing the request.</p>
@@ -73,8 +70,7 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
73 70
* <p>The requested resource could not be found.</p>
74 71
*
75 72
* @throws {@link ThrottlingException} (client fault)
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>
73 +
* <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
78 74
*
79 75
* @throws {@link UnauthorizedException} (client fault)
80 76
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -28,9 +28,7 @@ export interface BatchDeleteCategoryCommandInput extends BatchDeleteCategoryInpu
28 28
export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Deletes Categories for the Amazon Q Business application environment instance. Web experience users use
32 -
* 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
33 -
* labels for Amazon Q Apps</a>.</p>
31 +
* <p>Deletes Categories for the Amazon Q Business application environment instance. Web experience users use 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 labels for Amazon Q Apps</a>.</p>
34 32
* @example
35 33
* Use a bare-bones client and the command you need to make an API call.
36 34
* ```javascript
@@ -59,8 +57,7 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
59 57
* <p>The client is not authorized to perform the requested operation.</p>
60 58
*
61 59
* @throws {@link ConflictException} (client fault)
62 -
* <p>The requested operation could not be completed due to a conflict with the current state of
63 -
* the resource.</p>
60 +
* <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
64 61
*
65 62
* @throws {@link InternalServerException} (server fault)
66 63
* <p>An internal service error occurred while processing the request.</p>
@@ -69,8 +66,7 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
69 66
* <p>The requested resource could not be found.</p>
70 67
*
71 68
* @throws {@link ThrottlingException} (client fault)
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>
69 +
* <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
74 70
*
75 71
* @throws {@link UnauthorizedException} (client fault)
76 72
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -28,9 +28,7 @@ export interface BatchUpdateCategoryCommandInput extends BatchUpdateCategoryInpu
28 28
export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Updates Categories for the Amazon Q Business application environment instance. Web experience users use
32 -
* 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
33 -
* labels for Amazon Q Apps</a>.</p>
31 +
* <p>Updates Categories for the Amazon Q Business application environment instance. Web experience users use 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 labels for Amazon Q Apps</a>.</p>
34 32
* @example
35 33
* Use a bare-bones client and the command you need to make an API call.
36 34
* ```javascript
@@ -63,8 +61,7 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
63 61
* <p>The client is not authorized to perform the requested operation.</p>
64 62
*
65 63
* @throws {@link ConflictException} (client fault)
66 -
* <p>The requested operation could not be completed due to a conflict with the current state of
67 -
* the resource.</p>
64 +
* <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
68 65
*
69 66
* @throws {@link InternalServerException} (server fault)
70 67
* <p>An internal service error occurred while processing the request.</p>
@@ -73,8 +70,7 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
73 70
* <p>The requested resource could not be found.</p>
74 71
*
75 72
* @throws {@link ThrottlingException} (client fault)
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>
73 +
* <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
78 74
*
79 75
* @throws {@link UnauthorizedException} (client fault)
80 76
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -28,8 +28,7 @@ export interface CreateLibraryItemCommandInput extends CreateLibraryItemInput {}
28 28
export interface CreateLibraryItemCommandOutput extends CreateLibraryItemOutput, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Creates a new library item for an Amazon Q App, allowing it to be discovered and used by
32 -
* other allowed users. </p>
31 +
* <p>Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users. </p>
33 32
* @example
34 33
* Use a bare-bones client and the command you need to make an API call.
35 34
* ```javascript
@@ -75,12 +74,10 @@ export interface CreateLibraryItemCommandOutput extends CreateLibraryItemOutput,
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 it would exceed the service's quota
79 -
* or limit.</p>
77 +
* <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
80 78
*
81 79
* @throws {@link ThrottlingException} (client fault)
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>
80 +
* <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
84 81
*
85 82
* @throws {@link UnauthorizedException} (client fault)
86 83
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
You can’t perform that action at this time.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4