Skip to content

Commit

Permalink
feat(client-qapps): Add support for 11 new plugins as action cards to…
Browse files Browse the repository at this point in the history
… help automate repetitive tasks and improve productivity.
  • Loading branch information
awstools committed Dec 3, 2024
1 parent c96da51 commit e8b4cd8
Show file tree
Hide file tree
Showing 41 changed files with 518 additions and 381 deletions.
27 changes: 13 additions & 14 deletions clients/client-qapps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,19 @@

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

<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>
<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>

## Installing

Expand Down
27 changes: 13 additions & 14 deletions clients/client-qapps/src/QApps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -724,20 +724,19 @@ export interface QApps {
}

/**
* <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>
* <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>
* @public
*/
export class QApps extends QAppsClient implements QApps {}
Expand Down
27 changes: 13 additions & 14 deletions clients/client-qapps/src/QAppsClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -396,20 +396,19 @@ export type QAppsClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
export interface QAppsClientResolvedConfig extends QAppsClientResolvedConfigType {}

/**
* <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>
* <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>
* @public
*/
export class QAppsClient extends __Client<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ export interface AssociateLibraryItemReviewCommandInput extends AssociateLibrary
export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBearer {}

/**
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -56,8 +56,8 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare
* <p>The client is not authorized to perform the requested operation.</p>
*
* @throws {@link ConflictException} (client fault)
* <p>The requested operation could not be completed due to a
* conflict with the current state of the resource.</p>
* <p>The requested operation could not be completed due to a conflict with the current state of
* the resource.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>An internal service error occurred while processing the request.</p>
Expand All @@ -66,12 +66,12 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare
* <p>The requested resource could not be found.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>The requested operation could not be completed because
* it would exceed the service's quota or limit.</p>
* <p>The requested operation could not be completed because it would exceed the service's quota
* or limit.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The requested operation could not be completed because too many
* requests were sent at once. Wait a bit and try again later.</p>
* <p>The requested operation could not be completed because too many requests were sent at
* once. Wait a bit and try again later.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {}

/**
* <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
* 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -64,12 +64,12 @@ export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {}
* <p>The requested resource could not be found.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>The requested operation could not be completed because
* it would exceed the service's quota or limit.</p>
* <p>The requested operation could not be completed because it would exceed the service's quota
* or limit.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The requested operation could not be completed because too many
* requests were sent at once. Wait a bit and try again later.</p>
* <p>The requested operation could not be completed because too many requests were sent at
* once. Wait a bit and try again later.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
Expand Down
12 changes: 7 additions & 5 deletions clients/client-qapps/src/commands/BatchCreateCategoryCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ export interface BatchCreateCategoryCommandInput extends BatchCreateCategoryInpu
export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}

/**
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -61,8 +63,8 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
* <p>The client is not authorized to perform the requested operation.</p>
*
* @throws {@link ConflictException} (client fault)
* <p>The requested operation could not be completed due to a
* conflict with the current state of the resource.</p>
* <p>The requested operation could not be completed due to a conflict with the current state of
* the resource.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>An internal service error occurred while processing the request.</p>
Expand All @@ -71,8 +73,8 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {}
* <p>The requested resource could not be found.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The requested operation could not be completed because too many
* requests were sent at once. Wait a bit and try again later.</p>
* <p>The requested operation could not be completed because too many requests were sent at
* once. Wait a bit and try again later.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
Expand Down
12 changes: 7 additions & 5 deletions clients/client-qapps/src/commands/BatchDeleteCategoryCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ export interface BatchDeleteCategoryCommandInput extends BatchDeleteCategoryInpu
export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}

/**
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -57,8 +59,8 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
* <p>The client is not authorized to perform the requested operation.</p>
*
* @throws {@link ConflictException} (client fault)
* <p>The requested operation could not be completed due to a
* conflict with the current state of the resource.</p>
* <p>The requested operation could not be completed due to a conflict with the current state of
* the resource.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>An internal service error occurred while processing the request.</p>
Expand All @@ -67,8 +69,8 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {}
* <p>The requested resource could not be found.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The requested operation could not be completed because too many
* requests were sent at once. Wait a bit and try again later.</p>
* <p>The requested operation could not be completed because too many requests were sent at
* once. Wait a bit and try again later.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
Expand Down
12 changes: 7 additions & 5 deletions clients/client-qapps/src/commands/BatchUpdateCategoryCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ export interface BatchUpdateCategoryCommandInput extends BatchUpdateCategoryInpu
export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}

/**
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -61,8 +63,8 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
* <p>The client is not authorized to perform the requested operation.</p>
*
* @throws {@link ConflictException} (client fault)
* <p>The requested operation could not be completed due to a
* conflict with the current state of the resource.</p>
* <p>The requested operation could not be completed due to a conflict with the current state of
* the resource.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>An internal service error occurred while processing the request.</p>
Expand All @@ -71,8 +73,8 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {}
* <p>The requested resource could not be found.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The requested operation could not be completed because too many
* requests were sent at once. Wait a bit and try again later.</p>
* <p>The requested operation could not be completed because too many requests were sent at
* once. Wait a bit and try again later.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
Expand Down
Loading

0 comments on commit e8b4cd8

Please sign in to comment.