Skip to content

Commit e8b4cd8

Browse files
author
awstools
committed
feat(client-qapps): Add support for 11 new plugins as action cards to help automate repetitive tasks and improve productivity.
1 parent c96da51 commit e8b4cd8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+518
-381
lines changed

‎clients/client-qapps/README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@
66

77
AWS SDK for JavaScript QApps Client for Node.js, Browser and React Native.
88

9-
<p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
10-
users to create lightweight, purpose-built AI apps to fulfill specific tasks from
11-
within their web experience. For example, users can create a Q App that exclusively
12-
generates marketing-related content to improve your marketing team's productivity or a
13-
Q App for writing customer emails and creating promotional content using a certain
14-
style of voice, tone, and branding. For more information on the capabilities, see
15-
<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>.
16-
</p>
17-
<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
18-
Amazon Q Apps API operations</a>.</p>
19-
<p>For information about the IAM access control permissions you need to
20-
use the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
21-
IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in the
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>
2322

2423
## Installing
2524

‎clients/client-qapps/src/QApps.ts

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -724,20 +724,19 @@ export interface QApps {
724724
}
725725

726726
/**
727-
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
728-
* users to create lightweight, purpose-built AI apps to fulfill specific tasks from
729-
* within their web experience. For example, users can create a Q App that exclusively
730-
* generates marketing-related content to improve your marketing team's productivity or a
731-
* Q App for writing customer emails and creating promotional content using a certain
732-
* style of voice, tone, and branding. For more information on the capabilities, see
733-
* <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>.
734-
* </p>
735-
* <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
736-
* Amazon Q Apps API operations</a>.</p>
737-
* <p>For information about the IAM access control permissions you need to
738-
* use the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
739-
* IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in the
740-
* <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
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>
741740
* @public
742741
*/
743742
export class QApps extends QAppsClient implements QApps {}

‎clients/client-qapps/src/QAppsClient.ts

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -396,20 +396,19 @@ export type QAppsClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
396396
export interface QAppsClientResolvedConfig extends QAppsClientResolvedConfigType {}
397397

398398
/**
399-
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
400-
* users to create lightweight, purpose-built AI apps to fulfill specific tasks from
401-
* within their web experience. For example, users can create a Q App that exclusively
402-
* generates marketing-related content to improve your marketing team's productivity or a
403-
* Q App for writing customer emails and creating promotional content using a certain
404-
* style of voice, tone, and branding. For more information on the capabilities, see
405-
* <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>.
406-
* </p>
407-
* <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
408-
* Amazon Q Apps API operations</a>.</p>
409-
* <p>For information about the IAM access control permissions you need to
410-
* use the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
411-
* IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in the
412-
* <i>Amazon Q Business User Guide</i>.</p>
399+
* <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
400+
* lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
401+
* For example, users can create a Q App that exclusively generates marketing-related content to
402+
* improve your marketing team's productivity or a Q App for writing customer emails and
403+
* creating promotional content using a certain style of voice, tone, and branding. For more
404+
* 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
405+
* Guide</i>. </p>
406+
* <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
407+
* operations</a>.</p>
408+
* <p>For information about the IAM access control permissions you need to use
409+
* the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
410+
* IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
411+
* the <i>Amazon Q Business User Guide</i>.</p>
413412
* @public
414413
*/
415414
export class QAppsClient extends __Client<

‎clients/client-qapps/src/commands/AssociateLibraryItemReviewCommand.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface AssociateLibraryItemReviewCommandInput extends AssociateLibrary
2828
export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Associates a rating or review for a library item with the user submitting
32-
* the request. 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.
32+
* This increments the rating count for the specified library item.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript
@@ -56,8 +56,8 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare
5656
* <p>The client is not authorized to perform the requested operation.</p>
5757
*
5858
* @throws {@link ConflictException} (client fault)
59-
* <p>The requested operation could not be completed due to a
60-
* conflict with the current state of the resource.</p>
59+
* <p>The requested operation could not be completed due to a conflict with the current state of
60+
* the resource.</p>
6161
*
6262
* @throws {@link InternalServerException} (server fault)
6363
* <p>An internal service error occurred while processing the request.</p>
@@ -66,12 +66,12 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare
6666
* <p>The requested resource could not be found.</p>
6767
*
6868
* @throws {@link ServiceQuotaExceededException} (client fault)
69-
* <p>The requested operation could not be completed because
70-
* it would exceed the service's quota or limit.</p>
69+
* <p>The requested operation could not be completed because it would exceed the service's quota
70+
* or limit.</p>
7171
*
7272
* @throws {@link ThrottlingException} (client fault)
73-
* <p>The requested operation could not be completed because too many
74-
* requests were sent at 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
74+
* once. Wait a bit and try again later.</p>
7575
*
7676
* @throws {@link UnauthorizedException} (client fault)
7777
* <p>The client is not authenticated or authorized to perform the requested operation.</p>

‎clients/client-qapps/src/commands/AssociateQAppWithUserCommand.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <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
33-
* the user if the user doesn't own the Amazon Q App so they can still run it and see it in their
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
3434
* inventory of Q Apps.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
@@ -64,12 +64,12 @@ export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {}
6464
* <p>The requested resource could not be found.</p>
6565
*
6666
* @throws {@link ServiceQuotaExceededException} (client fault)
67-
* <p>The requested operation could not be completed because
68-
* it would exceed the service's quota or limit.</p>
67+
* <p>The requested operation could not be completed because it would exceed the service's quota
68+
* or limit.</p>
6969
*
7070
* @throws {@link ThrottlingException} (client fault)
71-
* <p>The requested operation could not be completed because too many
72-
* requests were sent at once. Wait a bit and try again later.</p>
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>
7373
*
7474
* @throws {@link UnauthorizedException} (client fault)
7575
* <p>The client is not authenticated or authorized to perform the requested operation.</p>

‎clients/client-qapps/src/commands/BatchCreateCategoryCommand.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export interface BatchCreateCategoryCommandInput extends BatchCreateCategoryInpu
2828
export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript
@@ -61,8 +63,8 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
6163
* <p>The client is not authorized to perform the requested operation.</p>
6264
*
6365
* @throws {@link ConflictException} (client fault)
64-
* <p>The requested operation could not be completed due to a
65-
* conflict with the current state of the resource.</p>
66+
* <p>The requested operation could not be completed due to a conflict with the current state of
67+
* the resource.</p>
6668
*
6769
* @throws {@link InternalServerException} (server fault)
6870
* <p>An internal service error occurred while processing the request.</p>
@@ -71,8 +73,8 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
7173
* <p>The requested resource could not be found.</p>
7274
*
7375
* @throws {@link ThrottlingException} (client fault)
74-
* <p>The requested operation could not be completed because too many
75-
* requests were sent at once. Wait a bit and try again later.</p>
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>
7678
*
7779
* @throws {@link UnauthorizedException} (client fault)
7880
* <p>The client is not authenticated or authorized to perform the requested operation.</p>

‎clients/client-qapps/src/commands/BatchDeleteCategoryCommand.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export interface BatchDeleteCategoryCommandInput extends BatchDeleteCategoryInpu
2828
export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript
@@ -57,8 +59,8 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
5759
* <p>The client is not authorized to perform the requested operation.</p>
5860
*
5961
* @throws {@link ConflictException} (client fault)
60-
* <p>The requested operation could not be completed due to a
61-
* conflict with the current state of the resource.</p>
62+
* <p>The requested operation could not be completed due to a conflict with the current state of
63+
* the resource.</p>
6264
*
6365
* @throws {@link InternalServerException} (server fault)
6466
* <p>An internal service error occurred while processing the request.</p>
@@ -67,8 +69,8 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
6769
* <p>The requested resource could not be found.</p>
6870
*
6971
* @throws {@link ThrottlingException} (client fault)
70-
* <p>The requested operation could not be completed because too many
71-
* requests were sent at once. Wait a bit and try again later.</p>
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>
7274
*
7375
* @throws {@link UnauthorizedException} (client fault)
7476
* <p>The client is not authenticated or authorized to perform the requested operation.</p>

‎clients/client-qapps/src/commands/BatchUpdateCategoryCommand.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export interface BatchUpdateCategoryCommandInput extends BatchUpdateCategoryInpu
2828
export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript
@@ -61,8 +63,8 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
6163
* <p>The client is not authorized to perform the requested operation.</p>
6264
*
6365
* @throws {@link ConflictException} (client fault)
64-
* <p>The requested operation could not be completed due to a
65-
* conflict with the current state of the resource.</p>
66+
* <p>The requested operation could not be completed due to a conflict with the current state of
67+
* the resource.</p>
6668
*
6769
* @throws {@link InternalServerException} (server fault)
6870
* <p>An internal service error occurred while processing the request.</p>
@@ -71,8 +73,8 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
7173
* <p>The requested resource could not be found.</p>
7274
*
7375
* @throws {@link ThrottlingException} (client fault)
74-
* <p>The requested operation could not be completed because too many
75-
* requests were sent at once. Wait a bit and try again later.</p>
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>
7678
*
7779
* @throws {@link UnauthorizedException} (client fault)
7880
* <p>The client is not authenticated or authorized to perform the requested operation.</p>

0 commit comments

Comments
 (0)