From e8b4cd83f24be93213e547a4cb944b567bf42445 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 3 Dec 2024 19:15:21 +0000 Subject: [PATCH] feat(client-qapps): Add support for 11 new plugins as action cards to help automate repetitive tasks and improve productivity. --- clients/client-qapps/README.md | 27 +-- clients/client-qapps/src/QApps.ts | 27 +-- clients/client-qapps/src/QAppsClient.ts | 27 +-- .../AssociateLibraryItemReviewCommand.ts | 16 +- .../commands/AssociateQAppWithUserCommand.ts | 12 +- .../commands/BatchCreateCategoryCommand.ts | 12 +- .../commands/BatchDeleteCategoryCommand.ts | 12 +- .../commands/BatchUpdateCategoryCommand.ts | 12 +- .../src/commands/CreateLibraryItemCommand.ts | 12 +- .../src/commands/CreatePresignedUrlCommand.ts | 13 +- .../src/commands/CreateQAppCommand.ts | 21 +- .../src/commands/DeleteLibraryItemCommand.ts | 12 +- .../src/commands/DeleteQAppCommand.ts | 7 +- .../DescribeQAppPermissionsCommand.ts | 4 +- .../DisassociateLibraryItemReviewCommand.ts | 12 +- .../DisassociateQAppFromUserCommand.ts | 7 +- .../commands/ExportQAppSessionDataCommand.ts | 12 +- .../src/commands/GetLibraryItemCommand.ts | 4 +- .../src/commands/GetQAppCommand.ts | 10 +- .../src/commands/GetQAppSessionCommand.ts | 20 +- .../commands/GetQAppSessionMetadataCommand.ts | 8 +- .../src/commands/ImportDocumentCommand.ts | 21 +- .../src/commands/ListCategoriesCommand.ts | 7 +- .../src/commands/ListLibraryItemsCommand.ts | 7 +- .../commands/ListQAppSessionDataCommand.ts | 8 +- .../src/commands/ListQAppsCommand.ts | 10 +- .../commands/ListTagsForResourceCommand.ts | 4 +- .../src/commands/PredictQAppCommand.ts | 12 +- .../src/commands/StartQAppSessionCommand.ts | 16 +- .../src/commands/StopQAppSessionCommand.ts | 14 +- .../src/commands/TagResourceCommand.ts | 8 +- .../src/commands/UntagResourceCommand.ts | 4 +- .../src/commands/UpdateLibraryItemCommand.ts | 8 +- .../UpdateLibraryItemMetadataCommand.ts | 8 +- .../src/commands/UpdateQAppCommand.ts | 12 +- .../commands/UpdateQAppPermissionsCommand.ts | 4 +- .../src/commands/UpdateQAppSessionCommand.ts | 18 +- .../UpdateQAppSessionMetadataCommand.ts | 11 +- clients/client-qapps/src/index.ts | 27 +-- clients/client-qapps/src/models/models_0.ts | 188 +++++++++------ codegen/sdk-codegen/aws-models/qapps.json | 225 ++++++++++++------ 41 files changed, 518 insertions(+), 381 deletions(-) diff --git a/clients/client-qapps/README.md b/clients/client-qapps/README.md index 616dabc58125..587d32044bd1 100644 --- a/clients/client-qapps/README.md +++ b/clients/client-qapps/README.md @@ -6,20 +6,19 @@ AWS SDK for JavaScript QApps Client for Node.js, Browser and React Native. -

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 -Amazon Q Apps capabilities in the Amazon Q Business User Guide. -

-

For an overview of the Amazon Q App APIs, see Overview of -Amazon Q Apps API operations.

-

For information about the IAM access control permissions you need to -use the Amazon Q Apps API, see -IAM role for the Amazon Q Business web experience including Amazon Q Apps in the -Amazon Q Business User Guide.

+

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 Amazon Q Apps capabilities in the Amazon Q Business User +Guide.

+

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API +operations.

+

For information about the IAM access control permissions you need to use +the Amazon Q Apps API, see +IAM role for the Amazon Q Business web experience including Amazon Q Apps in +the Amazon Q Business User Guide.

## Installing diff --git a/clients/client-qapps/src/QApps.ts b/clients/client-qapps/src/QApps.ts index 74a1dcef301c..dab72e89045d 100644 --- a/clients/client-qapps/src/QApps.ts +++ b/clients/client-qapps/src/QApps.ts @@ -724,20 +724,19 @@ export interface QApps { } /** - *

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 - * Amazon Q Apps capabilities in the Amazon Q Business User Guide. - *

- *

For an overview of the Amazon Q App APIs, see Overview of - * Amazon Q Apps API operations.

- *

For information about the IAM access control permissions you need to - * use the Amazon Q Apps API, see - * IAM role for the Amazon Q Business web experience including Amazon Q Apps in the - * Amazon Q Business User Guide.

+ *

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 Amazon Q Apps capabilities in the Amazon Q Business User + * Guide.

+ *

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API + * operations.

+ *

For information about the IAM access control permissions you need to use + * the Amazon Q Apps API, see + * IAM role for the Amazon Q Business web experience including Amazon Q Apps in + * the Amazon Q Business User Guide.

* @public */ export class QApps extends QAppsClient implements QApps {} diff --git a/clients/client-qapps/src/QAppsClient.ts b/clients/client-qapps/src/QAppsClient.ts index 282073268c53..19b09b6c2348 100644 --- a/clients/client-qapps/src/QAppsClient.ts +++ b/clients/client-qapps/src/QAppsClient.ts @@ -396,20 +396,19 @@ export type QAppsClientResolvedConfigType = __SmithyResolvedConfiguration<__Http export interface QAppsClientResolvedConfig extends QAppsClientResolvedConfigType {} /** - *

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 - * Amazon Q Apps capabilities in the Amazon Q Business User Guide. - *

- *

For an overview of the Amazon Q App APIs, see Overview of - * Amazon Q Apps API operations.

- *

For information about the IAM access control permissions you need to - * use the Amazon Q Apps API, see - * IAM role for the Amazon Q Business web experience including Amazon Q Apps in the - * Amazon Q Business User Guide.

+ *

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 Amazon Q Apps capabilities in the Amazon Q Business User + * Guide.

+ *

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API + * operations.

+ *

For information about the IAM access control permissions you need to use + * the Amazon Q Apps API, see + * IAM role for the Amazon Q Business web experience including Amazon Q Apps in + * the Amazon Q Business User Guide.

* @public */ export class QAppsClient extends __Client< diff --git a/clients/client-qapps/src/commands/AssociateLibraryItemReviewCommand.ts b/clients/client-qapps/src/commands/AssociateLibraryItemReviewCommand.ts index f64ca7cab1ba..caba37ead0a6 100644 --- a/clients/client-qapps/src/commands/AssociateLibraryItemReviewCommand.ts +++ b/clients/client-qapps/src/commands/AssociateLibraryItemReviewCommand.ts @@ -28,8 +28,8 @@ export interface AssociateLibraryItemReviewCommandInput extends AssociateLibrary export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBearer {} /** - *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,8 +56,8 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -66,12 +66,12 @@ export interface AssociateLibraryItemReviewCommandOutput extends __MetadataBeare *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/AssociateQAppWithUserCommand.ts b/clients/client-qapps/src/commands/AssociateQAppWithUserCommand.ts index e9190db4efcb..f1ac42866b7a 100644 --- a/clients/client-qapps/src/commands/AssociateQAppWithUserCommand.ts +++ b/clients/client-qapps/src/commands/AssociateQAppWithUserCommand.ts @@ -29,8 +29,8 @@ export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {} /** *

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

* @example * Use a bare-bones client and the command you need to make an API call. @@ -64,12 +64,12 @@ export interface AssociateQAppWithUserCommandOutput extends __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/BatchCreateCategoryCommand.ts b/clients/client-qapps/src/commands/BatchCreateCategoryCommand.ts index 77b427134bb8..d65a0f2ae758 100644 --- a/clients/client-qapps/src/commands/BatchCreateCategoryCommand.ts +++ b/clients/client-qapps/src/commands/BatchCreateCategoryCommand.ts @@ -28,7 +28,9 @@ export interface BatchCreateCategoryCommandInput extends BatchCreateCategoryInpu export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {} /** - *

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 Custom labels for Amazon Q Apps.

+ *

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 Custom + * labels for Amazon Q Apps.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,8 +63,8 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {} *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -71,8 +73,8 @@ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/BatchDeleteCategoryCommand.ts b/clients/client-qapps/src/commands/BatchDeleteCategoryCommand.ts index fb69a51b48e0..71d3767b11be 100644 --- a/clients/client-qapps/src/commands/BatchDeleteCategoryCommand.ts +++ b/clients/client-qapps/src/commands/BatchDeleteCategoryCommand.ts @@ -28,7 +28,9 @@ export interface BatchDeleteCategoryCommandInput extends BatchDeleteCategoryInpu export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {} /** - *

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 Custom labels for Amazon Q Apps.

+ *

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 Custom + * labels for Amazon Q Apps.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -57,8 +59,8 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {} *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -67,8 +69,8 @@ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/BatchUpdateCategoryCommand.ts b/clients/client-qapps/src/commands/BatchUpdateCategoryCommand.ts index efbc64336511..df415851d9ef 100644 --- a/clients/client-qapps/src/commands/BatchUpdateCategoryCommand.ts +++ b/clients/client-qapps/src/commands/BatchUpdateCategoryCommand.ts @@ -28,7 +28,9 @@ export interface BatchUpdateCategoryCommandInput extends BatchUpdateCategoryInpu export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {} /** - *

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 Custom labels for Amazon Q Apps.

+ *

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 Custom + * labels for Amazon Q Apps.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,8 +63,8 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {} *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -71,8 +73,8 @@ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/CreateLibraryItemCommand.ts b/clients/client-qapps/src/commands/CreateLibraryItemCommand.ts index 717cb32a9b2a..7487f47cf73b 100644 --- a/clients/client-qapps/src/commands/CreateLibraryItemCommand.ts +++ b/clients/client-qapps/src/commands/CreateLibraryItemCommand.ts @@ -28,8 +28,8 @@ export interface CreateLibraryItemCommandInput extends CreateLibraryItemInput {} export interface CreateLibraryItemCommandOutput extends CreateLibraryItemOutput, __MetadataBearer {} /** - *

Creates a new library item for an Amazon Q App, allowing it to be discovered and - * used by other allowed users.

+ *

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by + * other allowed users.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -75,12 +75,12 @@ export interface CreateLibraryItemCommandOutput extends CreateLibraryItemOutput, *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/CreatePresignedUrlCommand.ts b/clients/client-qapps/src/commands/CreatePresignedUrlCommand.ts index 54b1e0819b3a..db8b81f41212 100644 --- a/clients/client-qapps/src/commands/CreatePresignedUrlCommand.ts +++ b/clients/client-qapps/src/commands/CreatePresignedUrlCommand.ts @@ -28,11 +28,10 @@ export interface CreatePresignedUrlCommandInput extends CreatePresignedUrlInput export interface CreatePresignedUrlCommandOutput extends CreatePresignedUrlOutput, __MetadataBearer {} /** - *

Creates a presigned URL for an S3 POST operation to upload a file. - * You can use this URL to set a default file for a FileUploadCard - * in a Q App definition or to provide a file for a single Q App run. - * The scope parameter determines how the file will be used, - * either at the app definition level or the app session level.

+ *

Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to + * set a default file for a FileUploadCard in a Q App definition or to provide a + * file for a single Q App run. The scope parameter determines how the file will be + * used, either at the app definition level or the app session level.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -74,8 +73,8 @@ export interface CreatePresignedUrlCommandOutput extends CreatePresignedUrlOutpu *

An internal service error occurred while processing the request.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/CreateQAppCommand.ts b/clients/client-qapps/src/commands/CreateQAppCommand.ts index f4e51b372e8e..edde3475256f 100644 --- a/clients/client-qapps/src/commands/CreateQAppCommand.ts +++ b/clients/client-qapps/src/commands/CreateQAppCommand.ts @@ -29,8 +29,8 @@ export interface CreateQAppCommandOutput extends CreateQAppOutput, __MetadataBea /** *

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies - * the cards and flow of the Q App. This operation also calculates the dependencies between the cards - * by inspecting the references in the prompts.

+ * the cards and flow of the Q App. This operation also calculates the dependencies between the + * cards by inspecting the references in the prompts.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -145,6 +145,7 @@ export interface CreateQAppCommandOutput extends CreateQAppOutput, __MetadataBea * type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required * prompt: "STRING_VALUE", // required * pluginId: "STRING_VALUE", // required + * actionIdentifier: "STRING_VALUE", * }, * fileUpload: { // FileUploadCardInput * title: "STRING_VALUE", // required @@ -202,23 +203,23 @@ export interface CreateQAppCommandOutput extends CreateQAppOutput, __MetadataBea *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link ContentTooLargeException} (client fault) - *

The requested operation could not be completed because - * the content exceeds the maximum allowed size.

+ *

The requested operation could not be completed because the content exceeds the maximum + * allowed size.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/DeleteLibraryItemCommand.ts b/clients/client-qapps/src/commands/DeleteLibraryItemCommand.ts index 3b31628aee29..80a877aa88dd 100644 --- a/clients/client-qapps/src/commands/DeleteLibraryItemCommand.ts +++ b/clients/client-qapps/src/commands/DeleteLibraryItemCommand.ts @@ -28,8 +28,8 @@ export interface DeleteLibraryItemCommandInput extends DeleteLibraryItemInput {} export interface DeleteLibraryItemCommandOutput extends __MetadataBearer {} /** - *

Deletes a library item for an Amazon Q App, removing it from the library - * so it can no longer be discovered or used by other users.

+ *

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer + * be discovered or used by other users.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -62,12 +62,12 @@ export interface DeleteLibraryItemCommandOutput extends __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/DeleteQAppCommand.ts b/clients/client-qapps/src/commands/DeleteQAppCommand.ts index 23a332d54f0d..f4adefe25c94 100644 --- a/clients/client-qapps/src/commands/DeleteQAppCommand.ts +++ b/clients/client-qapps/src/commands/DeleteQAppCommand.ts @@ -28,7 +28,8 @@ export interface DeleteQAppCommandInput extends DeleteQAppInput {} export interface DeleteQAppCommandOutput extends __MetadataBearer {} /** - *

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

+ *

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the + * library, it is also removed from the library.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,8 +62,8 @@ export interface DeleteQAppCommandOutput extends __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/DescribeQAppPermissionsCommand.ts b/clients/client-qapps/src/commands/DescribeQAppPermissionsCommand.ts index 53b211e3cc4e..0c9d3ee7df62 100644 --- a/clients/client-qapps/src/commands/DescribeQAppPermissionsCommand.ts +++ b/clients/client-qapps/src/commands/DescribeQAppPermissionsCommand.ts @@ -74,8 +74,8 @@ export interface DescribeQAppPermissionsCommandOutput extends DescribeQAppPermis *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/DisassociateLibraryItemReviewCommand.ts b/clients/client-qapps/src/commands/DisassociateLibraryItemReviewCommand.ts index dbcf4a813aac..749b23afc110 100644 --- a/clients/client-qapps/src/commands/DisassociateLibraryItemReviewCommand.ts +++ b/clients/client-qapps/src/commands/DisassociateLibraryItemReviewCommand.ts @@ -58,8 +58,8 @@ export interface DisassociateLibraryItemReviewCommandOutput extends __MetadataBe *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -68,12 +68,12 @@ export interface DisassociateLibraryItemReviewCommandOutput extends __MetadataBe *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/DisassociateQAppFromUserCommand.ts b/clients/client-qapps/src/commands/DisassociateQAppFromUserCommand.ts index b6af90fffdc5..1e842652a0a5 100644 --- a/clients/client-qapps/src/commands/DisassociateQAppFromUserCommand.ts +++ b/clients/client-qapps/src/commands/DisassociateQAppFromUserCommand.ts @@ -28,8 +28,7 @@ export interface DisassociateQAppFromUserCommandInput extends DisassociateQAppFr export interface DisassociateQAppFromUserCommandOutput extends __MetadataBearer {} /** - *

Disassociates a Q App from a user removing the user's access to run the - * Q App.

+ *

Disassociates a Q App from a user removing the user's access to run the Q App.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -62,8 +61,8 @@ export interface DisassociateQAppFromUserCommandOutput extends __MetadataBearer *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/ExportQAppSessionDataCommand.ts b/clients/client-qapps/src/commands/ExportQAppSessionDataCommand.ts index 12a5affab40d..fc9bc5f91fbe 100644 --- a/clients/client-qapps/src/commands/ExportQAppSessionDataCommand.ts +++ b/clients/client-qapps/src/commands/ExportQAppSessionDataCommand.ts @@ -59,8 +59,8 @@ export interface ExportQAppSessionDataCommandOutput extends ExportQAppSessionDat *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -69,12 +69,12 @@ export interface ExportQAppSessionDataCommandOutput extends ExportQAppSessionDat *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/GetLibraryItemCommand.ts b/clients/client-qapps/src/commands/GetLibraryItemCommand.ts index 10d9a8d2889b..de769e6a7d48 100644 --- a/clients/client-qapps/src/commands/GetLibraryItemCommand.ts +++ b/clients/client-qapps/src/commands/GetLibraryItemCommand.ts @@ -84,8 +84,8 @@ export interface GetLibraryItemCommandOutput extends GetLibraryItemOutput, __Met *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/GetQAppCommand.ts b/clients/client-qapps/src/commands/GetQAppCommand.ts index 5185fb37438d..f73e19257090 100644 --- a/clients/client-qapps/src/commands/GetQAppCommand.ts +++ b/clients/client-qapps/src/commands/GetQAppCommand.ts @@ -28,7 +28,8 @@ export interface GetQAppCommandInput extends GetQAppInput {} export interface GetQAppCommandOutput extends GetQAppOutput, __MetadataBearer {} /** - *

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

+ *

Retrieves the full details of an Q App, including its definition specifying the cards and + * flow.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -173,8 +174,9 @@ export interface GetQAppCommandOutput extends GetQAppOutput, __MetadataBearer {} * // ], * // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required * // prompt: "STRING_VALUE", // required - * // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK" || "CUSTOM", // required + * // 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 * // pluginId: "STRING_VALUE", // required + * // actionIdentifier: "STRING_VALUE", * // }, * // fileUpload: { // FileUploadCard * // id: "STRING_VALUE", // required @@ -223,8 +225,8 @@ export interface GetQAppCommandOutput extends GetQAppOutput, __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/GetQAppSessionCommand.ts b/clients/client-qapps/src/commands/GetQAppSessionCommand.ts index a25d3546ac0d..b7a5f27bad0b 100644 --- a/clients/client-qapps/src/commands/GetQAppSessionCommand.ts +++ b/clients/client-qapps/src/commands/GetQAppSessionCommand.ts @@ -82,12 +82,12 @@ export interface GetQAppSessionCommandOutput extends GetQAppSessionOutput, __Met *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

@@ -117,7 +117,17 @@ export interface GetQAppSessionCommandOutput extends GetQAppSessionOutput, __Met * }, * "6fb5b404-3b7b-48a4-8a8b-56406922a606": { * "currentState": "COMPLETED", - * "currentValue": "" + * "currentValue": "", + * "submissions": [ + * { + * "value": { + * "18cee4cb-253e-4f87-9154-849fbb98e482": "user1", + * "d52030f9-6c4b-47a9-a946-377f632c77cc": "red" + * }, + * "submissionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + * "timestamp": "2023-06-15T14:30:45Z" + * } + * ] * } * }, * "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", diff --git a/clients/client-qapps/src/commands/GetQAppSessionMetadataCommand.ts b/clients/client-qapps/src/commands/GetQAppSessionMetadataCommand.ts index 0e9238a1002a..9c4804b4740d 100644 --- a/clients/client-qapps/src/commands/GetQAppSessionMetadataCommand.ts +++ b/clients/client-qapps/src/commands/GetQAppSessionMetadataCommand.ts @@ -71,12 +71,12 @@ export interface GetQAppSessionMetadataCommandOutput extends GetQAppSessionMetad *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/ImportDocumentCommand.ts b/clients/client-qapps/src/commands/ImportDocumentCommand.ts index 7e74becce785..7688d5f8290e 100644 --- a/clients/client-qapps/src/commands/ImportDocumentCommand.ts +++ b/clients/client-qapps/src/commands/ImportDocumentCommand.ts @@ -28,11 +28,10 @@ export interface ImportDocumentCommandInput extends ImportDocumentInput {} export interface ImportDocumentCommandOutput extends ImportDocumentOutput, __MetadataBearer {} /** - *

Uploads a file that can then be used either as a default in a - * FileUploadCard from Q App definition or as a file that - * is used inside a single Q App run. The purpose of the document is - * determined by a scope parameter that indicates whether it is at the - * app definition level or at the app session level.

+ *

Uploads a file that can then be used either as a default in a FileUploadCard + * from Q App definition or as a file that is used inside a single Q App run. The purpose of + * the document is determined by a scope parameter that indicates whether it is at the app + * definition level or at the app session level.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -66,8 +65,8 @@ export interface ImportDocumentCommandOutput extends ImportDocumentOutput, __Met *

The client is not authorized to perform the requested operation.

* * @throws {@link ContentTooLargeException} (client fault) - *

The requested operation could not be completed because - * the content exceeds the maximum allowed size.

+ *

The requested operation could not be completed because the content exceeds the maximum + * allowed size.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -76,12 +75,12 @@ export interface ImportDocumentCommandOutput extends ImportDocumentOutput, __Met *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/ListCategoriesCommand.ts b/clients/client-qapps/src/commands/ListCategoriesCommand.ts index 8bf70bfceed7..fc1aed749021 100644 --- a/clients/client-qapps/src/commands/ListCategoriesCommand.ts +++ b/clients/client-qapps/src/commands/ListCategoriesCommand.ts @@ -28,7 +28,8 @@ export interface ListCategoriesCommandInput extends ListCategoriesInput {} export interface ListCategoriesCommandOutput extends ListCategoriesOutput, __MetadataBearer {} /** - *

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

+ *

Lists the categories of a Amazon Q Business application environment instance. For more information, see + * Custom labels for Amazon Q Apps.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,8 +70,8 @@ export interface ListCategoriesCommandOutput extends ListCategoriesOutput, __Met *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/ListLibraryItemsCommand.ts b/clients/client-qapps/src/commands/ListLibraryItemsCommand.ts index d916c53fb70f..fecc0707f321 100644 --- a/clients/client-qapps/src/commands/ListLibraryItemsCommand.ts +++ b/clients/client-qapps/src/commands/ListLibraryItemsCommand.ts @@ -28,7 +28,8 @@ export interface ListLibraryItemsCommandInput extends ListLibraryItemsInput {} export interface ListLibraryItemsCommandOutput extends ListLibraryItemsOutput, __MetadataBearer {} /** - *

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

+ *

Lists the library items for Amazon Q Apps that are published and available for users in your + * Amazon Web Services account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -89,8 +90,8 @@ export interface ListLibraryItemsCommandOutput extends ListLibraryItemsOutput, _ *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/ListQAppSessionDataCommand.ts b/clients/client-qapps/src/commands/ListQAppSessionDataCommand.ts index f70fc098eee4..9143a6a6376a 100644 --- a/clients/client-qapps/src/commands/ListQAppSessionDataCommand.ts +++ b/clients/client-qapps/src/commands/ListQAppSessionDataCommand.ts @@ -76,12 +76,12 @@ export interface ListQAppSessionDataCommandOutput extends ListQAppSessionDataOut *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/ListQAppsCommand.ts b/clients/client-qapps/src/commands/ListQAppsCommand.ts index 80b442e69391..321fb053874e 100644 --- a/clients/client-qapps/src/commands/ListQAppsCommand.ts +++ b/clients/client-qapps/src/commands/ListQAppsCommand.ts @@ -28,9 +28,9 @@ export interface ListQAppsCommandInput extends ListQAppsInput {} export interface ListQAppsCommandOutput extends ListQAppsOutput, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -75,8 +75,8 @@ export interface ListQAppsCommandOutput extends ListQAppsOutput, __MetadataBeare *

An internal service error occurred while processing the request.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/ListTagsForResourceCommand.ts b/clients/client-qapps/src/commands/ListTagsForResourceCommand.ts index 403aba746eb7..e9ffe9fa3a05 100644 --- a/clients/client-qapps/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-qapps/src/commands/ListTagsForResourceCommand.ts @@ -64,8 +64,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link ValidationException} (client fault) *

The input failed to satisfy the constraints specified by the service.

diff --git a/clients/client-qapps/src/commands/PredictQAppCommand.ts b/clients/client-qapps/src/commands/PredictQAppCommand.ts index a4a3ae19407b..b4e6097289ff 100644 --- a/clients/client-qapps/src/commands/PredictQAppCommand.ts +++ b/clients/client-qapps/src/commands/PredictQAppCommand.ts @@ -28,10 +28,9 @@ export interface PredictQAppCommandInput extends PredictQAppInput {} export interface PredictQAppCommandOutput extends PredictQAppOutput, __MetadataBearer {} /** - *

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 CreateQApp. This API doesn't create - * Amazon Q Apps directly.

+ *

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 CreateQApp. + * This API doesn't create Amazon Q Apps directly.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -160,6 +159,7 @@ export interface PredictQAppCommandOutput extends PredictQAppOutput, __MetadataB * // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required * // prompt: "STRING_VALUE", // required * // pluginId: "STRING_VALUE", // required + * // actionIdentifier: "STRING_VALUE", * // }, * // fileUpload: { // FileUploadCardInput * // title: "STRING_VALUE", // required @@ -201,8 +201,8 @@ export interface PredictQAppCommandOutput extends PredictQAppOutput, __MetadataB *

An internal service error occurred while processing the request.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/StartQAppSessionCommand.ts b/clients/client-qapps/src/commands/StartQAppSessionCommand.ts index d419e9d1a44a..b8d33baa85a8 100644 --- a/clients/client-qapps/src/commands/StartQAppSessionCommand.ts +++ b/clients/client-qapps/src/commands/StartQAppSessionCommand.ts @@ -28,11 +28,11 @@ export interface StartQAppSessionCommandInput extends StartQAppSessionInput {} export interface StartQAppSessionCommandOutput extends StartQAppSessionOutput, __MetadataBearer {} /** - *

Starts a new session for an Amazon Q App, allowing inputs to be provided - * and the app to be run.

+ *

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be + * run.

* - *

Each Q App session will be condensed into a single conversation - * in the web experience.

+ *

Each Q App session will be condensed into a single conversation in the web + * experience.

* * @example * Use a bare-bones client and the command you need to make an API call. @@ -84,12 +84,12 @@ export interface StartQAppSessionCommandOutput extends StartQAppSessionOutput, _ *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/StopQAppSessionCommand.ts b/clients/client-qapps/src/commands/StopQAppSessionCommand.ts index ce39dec6325f..dc4d5c588359 100644 --- a/clients/client-qapps/src/commands/StopQAppSessionCommand.ts +++ b/clients/client-qapps/src/commands/StopQAppSessionCommand.ts @@ -28,9 +28,9 @@ export interface StopQAppSessionCommandInput extends StopQAppSessionInput {} export interface StopQAppSessionCommandOutput extends __MetadataBearer {} /** - *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,12 +63,12 @@ export interface StopQAppSessionCommandOutput extends __MetadataBearer {} *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/TagResourceCommand.ts b/clients/client-qapps/src/commands/TagResourceCommand.ts index 1aeefc6e3dad..aace20636c39 100644 --- a/clients/client-qapps/src/commands/TagResourceCommand.ts +++ b/clients/client-qapps/src/commands/TagResourceCommand.ts @@ -57,8 +57,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -67,8 +67,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link ValidationException} (client fault) *

The input failed to satisfy the constraints specified by the service.

diff --git a/clients/client-qapps/src/commands/UntagResourceCommand.ts b/clients/client-qapps/src/commands/UntagResourceCommand.ts index 8bd7962f37cb..fbf500a698fe 100644 --- a/clients/client-qapps/src/commands/UntagResourceCommand.ts +++ b/clients/client-qapps/src/commands/UntagResourceCommand.ts @@ -63,8 +63,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link ValidationException} (client fault) *

The input failed to satisfy the constraints specified by the service.

diff --git a/clients/client-qapps/src/commands/UpdateLibraryItemCommand.ts b/clients/client-qapps/src/commands/UpdateLibraryItemCommand.ts index c2928b8a0b24..98f03a6f62b0 100644 --- a/clients/client-qapps/src/commands/UpdateLibraryItemCommand.ts +++ b/clients/client-qapps/src/commands/UpdateLibraryItemCommand.ts @@ -80,8 +80,8 @@ export interface UpdateLibraryItemCommandOutput extends UpdateLibraryItemOutput, *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -90,8 +90,8 @@ export interface UpdateLibraryItemCommandOutput extends UpdateLibraryItemOutput, *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/UpdateLibraryItemMetadataCommand.ts b/clients/client-qapps/src/commands/UpdateLibraryItemMetadataCommand.ts index 8894398608c3..40f3bf3e52ce 100644 --- a/clients/client-qapps/src/commands/UpdateLibraryItemMetadataCommand.ts +++ b/clients/client-qapps/src/commands/UpdateLibraryItemMetadataCommand.ts @@ -56,8 +56,8 @@ export interface UpdateLibraryItemMetadataCommandOutput extends __MetadataBearer *

The client is not authorized to perform the requested operation.

* * @throws {@link ConflictException} (client fault) - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -66,8 +66,8 @@ export interface UpdateLibraryItemMetadataCommandOutput extends __MetadataBearer *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/UpdateQAppCommand.ts b/clients/client-qapps/src/commands/UpdateQAppCommand.ts index 90225dc1d0b2..ba76187c308e 100644 --- a/clients/client-qapps/src/commands/UpdateQAppCommand.ts +++ b/clients/client-qapps/src/commands/UpdateQAppCommand.ts @@ -28,7 +28,8 @@ export interface UpdateQAppCommandInput extends UpdateQAppInput {} export interface UpdateQAppCommandOutput extends UpdateQAppOutput, __MetadataBearer {} /** - *

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

+ *

Updates an existing Amazon Q App, allowing modifications to its title, description, and + * definition.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -144,6 +145,7 @@ export interface UpdateQAppCommandOutput extends UpdateQAppOutput, __MetadataBea * type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required * prompt: "STRING_VALUE", // required * pluginId: "STRING_VALUE", // required + * actionIdentifier: "STRING_VALUE", * }, * fileUpload: { // FileUploadCardInput * title: "STRING_VALUE", // required @@ -198,8 +200,8 @@ export interface UpdateQAppCommandOutput extends UpdateQAppOutput, __MetadataBea *

The client is not authorized to perform the requested operation.

* * @throws {@link ContentTooLargeException} (client fault) - *

The requested operation could not be completed because - * the content exceeds the maximum allowed size.

+ *

The requested operation could not be completed because the content exceeds the maximum + * allowed size.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred while processing the request.

@@ -208,8 +210,8 @@ export interface UpdateQAppCommandOutput extends UpdateQAppOutput, __MetadataBea *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/UpdateQAppPermissionsCommand.ts b/clients/client-qapps/src/commands/UpdateQAppPermissionsCommand.ts index e721c0d3e5dc..4c6221121686 100644 --- a/clients/client-qapps/src/commands/UpdateQAppPermissionsCommand.ts +++ b/clients/client-qapps/src/commands/UpdateQAppPermissionsCommand.ts @@ -86,8 +86,8 @@ export interface UpdateQAppPermissionsCommandOutput extends UpdateQAppPermission *

The requested resource could not be found.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/UpdateQAppSessionCommand.ts b/clients/client-qapps/src/commands/UpdateQAppSessionCommand.ts index 1a05d825e057..21bcc7dd36be 100644 --- a/clients/client-qapps/src/commands/UpdateQAppSessionCommand.ts +++ b/clients/client-qapps/src/commands/UpdateQAppSessionCommand.ts @@ -28,11 +28,11 @@ export interface UpdateQAppSessionCommandInput extends UpdateQAppSessionInput {} export interface UpdateQAppSessionCommandOutput extends UpdateQAppSessionOutput, __MetadataBearer {} /** - *

Updates the session for a given Q App sessionId. This is only - * valid when at least one card of the session is in the WAITING state. - * Data for each WAITING 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 WAITING status will be ignored.

+ *

Updates the session for a given Q App sessionId. This is only valid when at + * least one card of the session is in the WAITING state. Data for each + * WAITING 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 + * WAITING status will be ignored.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -78,12 +78,12 @@ export interface UpdateQAppSessionCommandOutput extends UpdateQAppSessionOutput, *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/commands/UpdateQAppSessionMetadataCommand.ts b/clients/client-qapps/src/commands/UpdateQAppSessionMetadataCommand.ts index 21a8f260b917..8a3c0c1be44b 100644 --- a/clients/client-qapps/src/commands/UpdateQAppSessionMetadataCommand.ts +++ b/clients/client-qapps/src/commands/UpdateQAppSessionMetadataCommand.ts @@ -28,7 +28,8 @@ export interface UpdateQAppSessionMetadataCommandInput extends UpdateQAppSession export interface UpdateQAppSessionMetadataCommandOutput extends UpdateQAppSessionMetadataOutput, __MetadataBearer {} /** - *

Updates the configuration metadata of a session for a given Q App sessionId.

+ *

Updates the configuration metadata of a session for a given Q App + * sessionId.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -76,12 +77,12 @@ export interface UpdateQAppSessionMetadataCommandOutput extends UpdateQAppSessio *

The requested resource could not be found.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* * @throws {@link ThrottlingException} (client fault) - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* * @throws {@link UnauthorizedException} (client fault) *

The client is not authenticated or authorized to perform the requested operation.

diff --git a/clients/client-qapps/src/index.ts b/clients/client-qapps/src/index.ts index 3916d55ae4d1..a2178986cbe5 100644 --- a/clients/client-qapps/src/index.ts +++ b/clients/client-qapps/src/index.ts @@ -1,20 +1,19 @@ // smithy-typescript generated code /* eslint-disable */ /** - *

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 - * Amazon Q Apps capabilities in the Amazon Q Business User Guide. - *

- *

For an overview of the Amazon Q App APIs, see Overview of - * Amazon Q Apps API operations.

- *

For information about the IAM access control permissions you need to - * use the Amazon Q Apps API, see - * IAM role for the Amazon Q Business web experience including Amazon Q Apps in the - * Amazon Q Business User Guide.

+ *

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 Amazon Q Apps capabilities in the Amazon Q Business User + * Guide.

+ *

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API + * operations.

+ *

For information about the IAM access control permissions you need to use + * the Amazon Q Apps API, see + * IAM role for the Amazon Q Business web experience including Amazon Q Apps in + * the Amazon Q Business User Guide.

* * @packageDocumentation */ diff --git a/clients/client-qapps/src/models/models_0.ts b/clients/client-qapps/src/models/models_0.ts index 81f2bcd9a297..fab2887eba5a 100644 --- a/clients/client-qapps/src/models/models_0.ts +++ b/clients/client-qapps/src/models/models_0.ts @@ -166,13 +166,11 @@ export interface FormInputCard { metadata: FormInputCardMetadata | undefined; /** - *

The compute mode of the form input card. - * This property determines whether individual participants of a - * data collection session can submit multiple response or one response. - * A compute mode of append shall allow participants - * to submit the same form multiple times with different values. - * A compute mode of replacecode> shall overwrite - * the current value for each participant.

+ *

The compute mode of the form input card. This property determines whether individual + * participants of a data collection session can submit multiple response or one response. A + * compute mode of append shall allow participants to submit the same form multiple + * times with different values. A compute mode of replacecode> shall overwrite the + * current value for each participant.

* @public */ computeMode?: InputCardComputeMode | undefined; @@ -183,11 +181,22 @@ export interface FormInputCard { * @enum */ export const PluginType = { + ASANA: "ASANA", + ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE", CUSTOM: "CUSTOM", + GOOGLE_CALENDAR: "GOOGLE_CALENDAR", JIRA: "JIRA", + JIRA_CLOUD: "JIRA_CLOUD", + MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE", + MICROSOFT_TEAMS: "MICROSOFT_TEAMS", + PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE", SALESFORCE: "SALESFORCE", + SALESFORCE_CRM: "SALESFORCE_CRM", + SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM", SERVICE_NOW: "SERVICE_NOW", + SMARTSHEET: "SMARTSHEET", ZENDESK: "ZENDESK", + ZENDESK_SUITE: "ZENDESK_SUITE", } as const; /** @@ -241,6 +250,12 @@ export interface QPluginCard { * @public */ pluginId: string | undefined; + + /** + *

The action identifier of the action to be performed by the plugin card.

+ * @public + */ + actionIdentifier?: string | undefined; } /** @@ -297,9 +312,10 @@ export namespace DocumentAttributeValue { /** *

A date expressed as an ISO 8601 string.

- *

It's important for the time zone to be included in the ISO 8601 date-time format. For - * example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 - * at 12:30PM (plus 10 seconds) in Central European Time.

+ *

It's important for the time zone to be included in the ISO 8601 + * date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 + * date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. + *

* @public */ export interface DateValueMember { @@ -413,9 +429,8 @@ export interface TextInputCard { } /** - *

Represents a file upload card. It can optionally - * receive a filename and fileId to set a - * default file. If not received, the user must provide the file + *

Represents a file upload card. It can optionally receive a filename and + * fileId to set a default file. If not received, the user must provide the file * when the Q App runs.

* @public */ @@ -487,13 +502,11 @@ export interface FormInputCardInput { metadata: FormInputCardMetadata | undefined; /** - *

The compute mode of the form input card. - * This property determines whether individual participants of a - * data collection session can submit multiple response or one response. - * A compute mode of append shall allow participants - * to submit the same form multiple times with different values. - * A compute mode of replacecode> shall overwrite - * the current value for each participant.

+ *

The compute mode of the form input card. This property determines whether individual + * participants of a data collection session can submit multiple response or one response. A + * compute mode of append shall allow participants to submit the same form multiple + * times with different values. A compute mode of replacecode> shall overwrite the + * current value for each participant.

* @public */ computeMode?: InputCardComputeMode | undefined; @@ -533,6 +546,12 @@ export interface QPluginCardInput { * @public */ pluginId: string | undefined; + + /** + *

The action identifier of the action to be performed by the plugin card.

+ * @public + */ + actionIdentifier?: string | undefined; } /** @@ -620,8 +639,8 @@ export interface AssociateLibraryItemReviewInput { } /** - *

The requested operation could not be completed due to a - * conflict with the current state of the resource.

+ *

The requested operation could not be completed due to a conflict with the current state of + * the resource.

* @public */ export class ConflictException extends __BaseException { @@ -717,8 +736,8 @@ export class ResourceNotFoundException extends __BaseException { } /** - *

The requested operation could not be completed because - * it would exceed the service's quota or limit.

+ *

The requested operation could not be completed because it would exceed the service's quota + * or limit.

* @public */ export class ServiceQuotaExceededException extends __BaseException { @@ -766,8 +785,8 @@ export class ServiceQuotaExceededException extends __BaseException { } /** - *

The requested operation could not be completed because too many - * requests were sent at once. Wait a bit and try again later.

+ *

The requested operation could not be completed because too many requests were sent at + * once. Wait a bit and try again later.

* @public */ export class ThrottlingException extends __BaseException { @@ -873,7 +892,8 @@ export interface AssociateQAppWithUserInput { */ export interface BatchCreateCategoryInputCategory { /** - *

The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.

+ *

The unique identifier to be associated with a category. If you don't include a value, the + * category is automatically assigned a unique identifier.

* @public */ id?: string | undefined; @@ -885,7 +905,8 @@ export interface BatchCreateCategoryInputCategory { title: string | undefined; /** - *

The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.

+ *

The color to be associated with a category. The color must be a hexadecimal value of + * either 3 or 6 digits.

* @public */ color?: string | undefined; @@ -926,7 +947,8 @@ export interface BatchDeleteCategoryInput { } /** - *

A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.

+ *

A label that web experience users associate with a library item. Web experience users use + * Categories to tag and filter library items.

* @public */ export interface CategoryInput { @@ -943,7 +965,8 @@ export interface CategoryInput { title: string | undefined; /** - *

The color of the category, represented as a hexadecimal value of either 3 or 6 digits.

+ *

The color of the category, represented as a hexadecimal value of either 3 or 6 + * digits.

* @public */ color?: string | undefined; @@ -1081,8 +1104,8 @@ export interface CardValue { value: string | undefined; /** - *

The structure that describes how the current form card value is mutated. - * Only applies for form cards when multiple responses are allowed.

+ *

The structure that describes how the current form card value is mutated. Only applies for + * form cards when multiple responses are allowed.

* @public */ submissionMutation?: SubmissionMutation | undefined; @@ -1119,8 +1142,8 @@ export interface Category { } /** - *

The requested operation could not be completed because - * the content exceeds the maximum allowed size.

+ *

The requested operation could not be completed because the content exceeds the maximum + * allowed size.

* @public */ export class ContentTooLargeException extends __BaseException { @@ -1316,13 +1339,15 @@ export interface CreatePresignedUrlInput { fileName: string | undefined; /** - *

Whether the file is associated with a Q App definition or a specific Q App session.

+ *

Whether the file is associated with a Q App definition or a specific Q App + * session.

* @public */ scope: DocumentScope | undefined; /** - *

The unique identifier of the Q App session the file is associated with, if applicable.

+ *

The unique identifier of the Q App session the file is associated with, if + * applicable.

* @public */ sessionId?: string | undefined; @@ -1345,7 +1370,8 @@ export interface CreatePresignedUrlOutput { presignedUrl: string | undefined; /** - *

The form fields to include in the presigned S3 POST operation used to upload a file.

+ *

The form fields to include in the presigned S3 POST operation used to upload a + * file.

* @public */ presignedUrlFields: Record | undefined; @@ -1428,7 +1454,8 @@ export interface CreateQAppOutput { updatedBy: string | undefined; /** - *

The capabilities required to run the Q App, such as file upload or third-party integrations.

+ *

The capabilities required to run the Q App, such as file upload or third-party + * integrations.

* @public */ requiredCapabilities?: AppRequiredCapability[] | undefined; @@ -1546,7 +1573,8 @@ export interface PermissionOutput { */ export interface DescribeQAppPermissionsOutput { /** - *

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.

+ *

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are + * returned.

* @public */ resourceArn?: string | undefined; @@ -1831,7 +1859,8 @@ export interface GetQAppSessionOutput { cardStatus: Record | undefined; /** - *

Indicates whether the current user is the owner of the Q App data collection session.

+ *

Indicates whether the current user is the owner of the Q App data collection + * session.

* @public */ userIsHost?: boolean | undefined; @@ -1872,7 +1901,8 @@ export interface SessionSharingConfiguration { acceptResponses?: boolean | undefined; /** - *

Indicates whether collected responses for an Q App session are revealed for all users.

+ *

Indicates whether collected responses for an Q App session are revealed for all + * users.

* @public */ revealCards?: boolean | undefined; @@ -1948,13 +1978,15 @@ export interface ImportDocumentInput { fileName: string | undefined; /** - *

Whether the file is associated with a Q App definition or a specific Q App session.

+ *

Whether the file is associated with a Q App definition or a specific Q App + * session.

* @public */ scope: DocumentScope | undefined; /** - *

The unique identifier of the Q App session the file is associated with, if applicable.

+ *

The unique identifier of the Q App session the file is associated with, if + * applicable.

* @public */ sessionId?: string | undefined; @@ -1972,9 +2004,8 @@ export interface ImportDocumentOutput { } /** - *

A library item is a snapshot of an Amazon Q App - * that can be published so the users in their Amazon Q Apps library - * can discover it, clone it, and run it.

+ *

A library item is a snapshot of an Amazon Q App that can be published so the users in their + * Amazon Q Apps library can discover it, clone it, and run it.

* @public */ export interface LibraryItemMember { @@ -2263,8 +2294,8 @@ export interface User { } /** - *

The response collected for a Amazon Q App session. - * This container represents a single response to a Q App session.

+ *

The response collected for a Amazon Q App session. This container represents a single + * response to a Q App session.

* @public */ export interface QAppSessionData { @@ -2434,7 +2465,8 @@ export interface PredictQAppInput { instanceId: string | undefined; /** - *

The input to generate the Q App definition from, either a conversation or problem statement.

+ *

The input to generate the Q App definition from, either a conversation or problem + * statement.

* @public */ options?: PredictQAppInputOptions | undefined; @@ -2805,7 +2837,8 @@ export interface UpdateQAppPermissionsInput { */ export interface UpdateQAppPermissionsOutput { /** - *

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.

+ *

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were + * updated.

* @public */ resourceArn?: string | undefined; @@ -2922,7 +2955,8 @@ export interface UpdateQAppSessionMetadataOutput { } /** - *

The filter criteria used on responses based on document attributes or metadata fields.

+ *

The filter criteria used on responses based on document attributes or metadata + * fields.

* @public */ export interface AttributeFilter { @@ -2945,66 +2979,62 @@ export interface AttributeFilter { notFilter?: AttributeFilter | undefined; /** - *

Performs an equals operation on two document attributes or metadata fields. Supported - * for the following document attribute value types: dateValue, - * longValue, stringListValue and - * stringValue.

+ *

Performs an equals operation on two document attributes or metadata + * fields. Supported for the following document attribute value types: dateValue, longValue, + * stringListValue and stringValue.

* @public */ equalsTo?: DocumentAttribute | undefined; /** - *

Returns true when a document contains all the specified document - * attributes or metadata fields. Supported for the following document attribute value types: - * stringListValue.

+ *

Returns true when a document contains all the specified document attributes + * or metadata fields. Supported for the following document attribute value types: stringListValue.

* @public */ containsAll?: DocumentAttribute | undefined; /** *

Returns true when a document contains any of the specified document - * attributes or metadata fields. Supported for the following document attribute value types: - * stringListValue.

+ * attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

* @public */ containsAny?: DocumentAttribute | undefined; /** - *

Performs a greater than operation on two document attributes or metadata fields. - * Supported for the following document attribute value types: dateValue - * and longValue.

+ *

Performs a greater than operation on two document attributes or + * metadata fields. Supported for the following document attribute value types: dateValue and + * longValue.

* @public */ greaterThan?: DocumentAttribute | undefined; /** - *

Performs a greater than or equals operation on two document attributes or metadata - * fields. Supported for the following document attribute value types: dateValue - * and longValue.

+ *

Performs a greater than or equals operation on two document + * attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue. + *

* @public */ greaterThanOrEquals?: DocumentAttribute | undefined; /** - *

Performs a less than operation on two document attributes or metadata fields. - * Supported for the following document attribute value types: dateValue - * and longValue.

+ *

Performs a less than operation on two document attributes or metadata + * fields. Supported for the following document attribute value types: dateValue and + * longValue.

* @public */ lessThan?: DocumentAttribute | undefined; /** - *

Performs a less than or equals operation on two document attributes or metadata - * fields.Supported for the following document attribute value type: dateValue - * and longValue.

+ *

Performs a less than or equals operation on two document attributes + * or metadata fields.Supported for the following document attribute value type: dateValue and longValue. + *

* @public */ lessThanOrEquals?: DocumentAttribute | undefined; } /** - *

A card in a Amazon Q App that generates a response - * based on the Amazon Q Business service.

+ *

A card in a Amazon Q App that generates a response based on the Amazon Q Business service.

* @public */ export interface QQueryCard { @@ -3051,7 +3081,8 @@ export interface QQueryCard { attributeFilter?: AttributeFilter | undefined; /** - *

Any dependencies for the query card, where the dependencies are references to the collected responses.

+ *

Any dependencies for the query card, where the dependencies are references to the + * collected responses.

* @public */ memoryReferences?: string[] | undefined; @@ -3471,7 +3502,8 @@ export interface GetQAppOutput { updatedBy: string | undefined; /** - *

The capabilities required to run the Q App, such as file upload or third-party integrations.

+ *

The capabilities required to run the Q App, such as file upload or third-party + * integrations.

* @public */ requiredCapabilities?: AppRequiredCapability[] | undefined; @@ -3484,8 +3516,8 @@ export interface GetQAppOutput { } /** - *

The definition of an Amazon Q App generated based on input such as a conversation - * or problem statement.

+ *

The definition of an Amazon Q App generated based on input such as a conversation or problem + * statement.

* @public */ export interface PredictAppDefinition { diff --git a/codegen/sdk-codegen/aws-models/qapps.json b/codegen/sdk-codegen/aws-models/qapps.json index 661f4f0e094b..f71313921b33 100644 --- a/codegen/sdk-codegen/aws-models/qapps.json +++ b/codegen/sdk-codegen/aws-models/qapps.json @@ -34,6 +34,15 @@ } } }, + "com.amazonaws.qapps#ActionIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.qapps#AmazonResourceName": { "type": "string", "traits": { @@ -197,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a rating or review for a library item with the user submitting\n the request. This increments the rating count for the specified library item.

", + "smithy.api#documentation": "

Associates a rating or review for a library item with the user submitting the request.\n This increments the rating count for the specified library item.

", "smithy.api#examples": [ { "title": "Increase the rating counter by 1 for the related app for this user", @@ -268,7 +277,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation creates a link between the user's identity calling the operation and a\n specific Q App. This is useful to mark the Q App as a favorite for\n the user if the user doesn't own the Amazon Q App so they can still run it and see it in their\n inventory of Q Apps.

", + "smithy.api#documentation": "

This operation creates a link between the user's identity calling the operation and a\n specific Q App. This is useful to mark the Q App as a favorite for the\n user if the user doesn't own the Amazon Q App so they can still run it and see it in their\n inventory of Q Apps.

", "smithy.api#examples": [ { "title": "Links an Amazon Q App to the invoker's list of apps", @@ -331,48 +340,48 @@ "equalsTo": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata fields. Supported\n for the following document attribute value types: dateValue,\n longValue, stringListValue and\n stringValue.

" + "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue, longValue,\n stringListValue and stringValue.

" } }, "containsAll": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains all the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains all the specified document attributes\n or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "containsAny": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "greaterThan": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a greater than operation on two document attributes or\n metadata fields. Supported for the following document attribute value types: dateValue and\n longValue.

" } }, "greaterThanOrEquals": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than or equals operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a greater than or equals operation on two document\n attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.\n

" } }, "lessThan": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue and\n longValue.

" } }, "lessThanOrEquals": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes or metadata\n fields.Supported for the following document attribute value type: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes\n or metadata fields.Supported for the following document attribute value type: dateValue and longValue.\n

" } } }, "traits": { - "smithy.api#documentation": "

The filter criteria used on responses based on document attributes or metadata fields.

" + "smithy.api#documentation": "

The filter criteria used on responses based on document attributes or metadata\n fields.

" } }, "com.amazonaws.qapps#AttributeFilters": { @@ -413,7 +422,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Creates Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Creates the categories for the library", @@ -467,7 +476,7 @@ "id": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.

" + "smithy.api#documentation": "

The unique identifier to be associated with a category. If you don't include a value, the\n category is automatically assigned a unique identifier.

" } }, "title": { @@ -485,7 +494,7 @@ "color": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.

", + "smithy.api#documentation": "

The color to be associated with a category. The color must be a hexadecimal value of\n either 3 or 6 digits.

", "smithy.api#length": { "min": 4, "max": 7 @@ -541,7 +550,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Deletes Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Deletes the categories in the library", @@ -612,7 +621,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Updates Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Updates the categories in the library", @@ -870,7 +879,7 @@ "submissionMutation": { "target": "com.amazonaws.qapps#SubmissionMutation", "traits": { - "smithy.api#documentation": "

The structure that describes how the current form card value is mutated.\n Only applies for form cards when multiple responses are allowed.

" + "smithy.api#documentation": "

The structure that describes how the current form card value is mutated. Only applies for\n form cards when multiple responses are allowed.

" } } }, @@ -970,7 +979,7 @@ "color": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The color of the category, represented as a hexadecimal value of either 3 or 6 digits.

", + "smithy.api#documentation": "

The color of the category, represented as a hexadecimal value of either 3 or 6\n digits.

", "smithy.api#length": { "min": 4, "max": 7 @@ -980,7 +989,7 @@ } }, "traits": { - "smithy.api#documentation": "

A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.

" + "smithy.api#documentation": "

A label that web experience users associate with a library item. Web experience users use\n Categories to tag and filter library items.

" } }, "com.amazonaws.qapps#CategoryList": { @@ -1030,7 +1039,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed due to a\n conflict with the current state of the resource.

", + "smithy.api#documentation": "

The requested operation could not be completed due to a conflict with the current state of\n the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1060,7 +1069,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because\n the content exceeds the maximum allowed size.

", + "smithy.api#documentation": "

The requested operation could not be completed because the content exceeds the maximum\n allowed size.

", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -1122,7 +1131,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new library item for an Amazon Q App, allowing it to be discovered and\n used by other allowed users.

", + "smithy.api#documentation": "

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by\n other allowed users.

", "smithy.api#examples": [ { "title": "Create a Library Item", @@ -1274,13 +1283,13 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a presigned URL for an S3 POST operation to upload a file.\n You can use this URL to set a default file for a FileUploadCard\n in a Q App definition or to provide a file for a single Q App run.\n The scope parameter determines how the file will be used,\n either at the app definition level or the app session level.

", + "smithy.api#documentation": "

Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to\n set a default file for a FileUploadCard in a Q App definition or to provide a\n file for a single Q App run. The scope parameter determines how the file will be\n used, either at the app definition level or the app session level.

", "smithy.api#examples": [ { "title": "Upload a file to a specific session", "input": { "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f", - "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=", + "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=", "fileName": "myFile.txt", "cardId": "82f69028-22a9-4bea-8727-0eabf58e9fed", "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0", @@ -1289,12 +1298,12 @@ }, "output": { "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4", - "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/", + "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/", "presignedUrlFields": { "x-amz-server-side-encryption": "aws:kms", "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f", - "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9", - "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=" + "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9", + "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=" }, "presignedUrlExpiration": "2024-09-14T00:11:54.232Z" } @@ -1303,7 +1312,7 @@ "title": "Upload a file into a application", "input": { "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f", - "fileContentsSha256": "myMXwslBoXkTDQ0olhq1QsiHRWWL4yj1V0IuoK+PYOg=", + "fileContentsSha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=", "fileName": "anApplicationFile.txt", "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0", "cardId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e", @@ -1311,12 +1320,12 @@ }, "output": { "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4", - "presignedUrl": "https://presign-test-omg-6f98533b-3f9f-4e8a-8183-63793b9ffef0.s3.us-west-2.amazonaws.com/", + "presignedUrl": "https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/", "presignedUrlFields": { "x-amz-server-side-encryption": "aws:kms", "x-amz-server-side-encryption-aws-kms-key-id": "0a6a474b-f2ca-46ea-9e72-deea9077d92f", - "x-amz-server-side-encryption-context": "eyJzb21ldGhpbmciOiJ0aGVyZSJ9", - "x-amz-checksum-sha256": "fmHCdgdPjOGub9TVZ4NIOpAYP4UlIOaPRUwHw8nihR4=" + "x-amz-server-side-encryption-context": "eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9", + "x-amz-checksum-sha256": "wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=" }, "presignedUrlExpiration": "2024-09-14T00:11:54.232Z" } @@ -1371,14 +1380,14 @@ "scope": { "target": "com.amazonaws.qapps#DocumentScope", "traits": { - "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App session.

", + "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App\n session.

", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if applicable.

" + "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if\n applicable.

" } } }, @@ -1406,7 +1415,7 @@ "presignedUrlFields": { "target": "com.amazonaws.qapps#PresignedUrlFields", "traits": { - "smithy.api#documentation": "

The form fields to include in the presigned S3 POST operation used to upload a file.

", + "smithy.api#documentation": "

The form fields to include in the presigned S3 POST operation used to upload a\n file.

", "smithy.api#required": {} } }, @@ -1457,7 +1466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies\n the cards and flow of the Q App. This operation also calculates the dependencies between the cards\n by inspecting the references in the prompts.

", + "smithy.api#documentation": "

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies\n the cards and flow of the Q App. This operation also calculates the dependencies between the\n cards by inspecting the references in the prompts.

", "smithy.api#examples": [ { "title": "A basic application with 1 text input card and 1 output card", @@ -1629,7 +1638,7 @@ "requiredCapabilities": { "target": "com.amazonaws.qapps#AppRequiredCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party integrations.

" + "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party\n integrations.

" } } }, @@ -1688,7 +1697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a library item for an Amazon Q App, removing it from the library\n so it can no longer be discovered or used by other users.

", + "smithy.api#documentation": "

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer\n be discovered or used by other users.

", "smithy.api#examples": [ { "title": "Delete a library item", @@ -1757,7 +1766,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

", + "smithy.api#documentation": "

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the\n library, it is also removed from the library.

", "smithy.api#examples": [ { "title": "Delete an Amazon Q App", @@ -1899,7 +1908,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are\n returned.

" } }, "appId": { @@ -2030,7 +2039,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a Q App from a user removing the user's access to run the\n Q App.

", + "smithy.api#documentation": "

Disassociates a Q App from a user removing the user's access to run the Q App.

", "smithy.api#examples": [ { "title": "Unlinks an Amazon Q App from the invoker's list of apps", @@ -2142,7 +2151,7 @@ "dateValue": { "target": "com.amazonaws.qapps#Timestamp", "traits": { - "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

\n

It's important for the time zone to be included in the ISO 8601 date-time format. For\n example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012\n at 12:30PM (plus 10 seconds) in Central European Time.

" + "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

\n

It's important for the time zone to be included in the ISO 8601\n date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601\n date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.\n

" } } }, @@ -2389,7 +2398,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a file upload card. It can optionally\n receive a filename and fileId to set a\n default file. If not received, the user must provide the file\n when the Q App runs.

" + "smithy.api#documentation": "

Represents a file upload card. It can optionally receive a filename and\n fileId to set a default file. If not received, the user must provide the file\n when the Q App runs.

" } }, "com.amazonaws.qapps#Filename": { @@ -2441,7 +2450,7 @@ "computeMode": { "target": "com.amazonaws.qapps#InputCardComputeMode", "traits": { - "smithy.api#documentation": "

The compute mode of the form input card.\n This property determines whether individual participants of a\n data collection session can submit multiple response or one response.\n A compute mode of append shall allow participants\n to submit the same form multiple times with different values.\n A compute mode of replacecode> shall overwrite\n the current value for each participant.

" + "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual\n participants of a data collection session can submit multiple response or one response. A\n compute mode of append shall allow participants to submit the same form multiple\n times with different values. A compute mode of replacecode> shall overwrite the\n current value for each participant.

" } } }, @@ -2484,7 +2493,7 @@ "computeMode": { "target": "com.amazonaws.qapps#InputCardComputeMode", "traits": { - "smithy.api#documentation": "

The compute mode of the form input card.\n This property determines whether individual participants of a\n data collection session can submit multiple response or one response.\n A compute mode of append shall allow participants\n to submit the same form multiple times with different values.\n A compute mode of replacecode> shall overwrite\n the current value for each participant.

" + "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual\n participants of a data collection session can submit multiple response or one response. A\n compute mode of append shall allow participants to submit the same form multiple\n times with different values. A compute mode of replacecode> shall overwrite the\n current value for each participant.

" } } }, @@ -2738,7 +2747,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

", + "smithy.api#documentation": "

Retrieves the full details of an Q App, including its definition specifying the cards and\n flow.

", "smithy.api#examples": [ { "title": "A basic application with 1 text input card and 1 output card", @@ -2901,7 +2910,7 @@ "requiredCapabilities": { "target": "com.amazonaws.qapps#AppRequiredCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party integrations.

" + "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party\n integrations.

" } }, "appDefinition": { @@ -3191,7 +3200,7 @@ "userIsHost": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the current user is the owner of the Q App data collection session.

" + "smithy.api#documentation": "

Indicates whether the current user is the owner of the Q App data collection\n session.

" } } }, @@ -3234,7 +3243,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uploads a file that can then be used either as a default in a\n FileUploadCard from Q App definition or as a file that\n is used inside a single Q App run. The purpose of the document is\n determined by a scope parameter that indicates whether it is at the\n app definition level or at the app session level.

", + "smithy.api#documentation": "

Uploads a file that can then be used either as a default in a FileUploadCard\n from Q App definition or as a file that is used inside a single Q App run. The purpose of\n the document is determined by a scope parameter that indicates whether it is at the app\n definition level or at the app session level.

", "smithy.api#examples": [ { "title": "Upload a file to a specific session", @@ -3314,14 +3323,14 @@ "scope": { "target": "com.amazonaws.qapps#DocumentScope", "traits": { - "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App session.

", + "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App\n session.

", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if applicable.

" + "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if\n applicable.

" } } }, @@ -3492,7 +3501,7 @@ } }, "traits": { - "smithy.api#documentation": "

A library item is a snapshot of an Amazon Q App\n that can be published so the users in their Amazon Q Apps library\n can discover it, clone it, and run it.

" + "smithy.api#documentation": "

A library item is a snapshot of an Amazon Q App that can be published so the users in their\n Amazon Q Apps library can discover it, clone it, and run it.

" } }, "com.amazonaws.qapps#LibraryItemStatus": { @@ -3541,7 +3550,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Lists the categories of a Amazon Q Business application environment instance. For more information, see\n Custom labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "List categories available for the library items in this instance", @@ -3632,7 +3641,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

", + "smithy.api#documentation": "

Lists the library items for Amazon Q Apps that are published and available for users in your\n Amazon Web Services account.

", "smithy.api#examples": [ { "title": "List at most 3 library items for this instance", @@ -3905,7 +3914,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon Q Apps owned by or associated with the user either because\n they created it or because they used it from the library in the past. The user\n identity is extracted from the credentials used to invoke this operation..

", + "smithy.api#documentation": "

Lists the Amazon Q Apps owned by or associated with the user either because they created it\n or because they used it from the library in the past. The user identity is extracted from the\n credentials used to invoke this operation..

", "smithy.api#examples": [ { "title": "List at most 3 Amazon Q Apps in an Q Business application", @@ -4297,6 +4306,72 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "ASANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASANA" + } + }, + "ATLASSIAN_CONFLUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATLASSIAN_CONFLUENCE" + } + }, + "GOOGLE_CALENDAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLE_CALENDAR" + } + }, + "JIRA_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRA_CLOUD" + } + }, + "MICROSOFT_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_EXCHANGE" + } + }, + "MICROSOFT_TEAMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_TEAMS" + } + }, + "PAGERDUTY_ADVANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGERDUTY_ADVANCE" + } + }, + "SALESFORCE_CRM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE_CRM" + } + }, + "SERVICENOW_NOW_PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICENOW_NOW_PLATFORM" + } + }, + "SMARTSHEET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMARTSHEET" + } + }, + "ZENDESK_SUITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZENDESK_SUITE" + } } } }, @@ -4325,7 +4400,7 @@ } }, "traits": { - "smithy.api#documentation": "

The definition of an Amazon Q App generated based on input such as a conversation\n or problem statement.

" + "smithy.api#documentation": "

The definition of an Amazon Q App generated based on input such as a conversation or problem\n statement.

" } }, "com.amazonaws.qapps#PredictQApp": { @@ -4354,7 +4429,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates an Amazon Q App definition based on either a conversation or\n a problem statement provided as input.The resulting app definition\n can be used to call CreateQApp. This API doesn't create\n Amazon Q Apps directly.

", + "smithy.api#documentation": "

Generates an Amazon Q App definition based on either a conversation or a problem statement\n provided as input.The resulting app definition can be used to call CreateQApp.\n This API doesn't create Amazon Q Apps directly.

", "smithy.api#http": { "method": "POST", "uri": "/apps.predictQApp" @@ -4376,7 +4451,7 @@ "options": { "target": "com.amazonaws.qapps#PredictQAppInputOptions", "traits": { - "smithy.api#documentation": "

The input to generate the Q App definition from, either a conversation or problem statement.

" + "smithy.api#documentation": "

The input to generate the Q App definition from, either a conversation or problem\n statement.

" } } }, @@ -4525,7 +4600,7 @@ } }, "traits": { - "smithy.api#documentation": "

The response collected for a Amazon Q App session.\n This container represents a single response to a Q App session.

" + "smithy.api#documentation": "

The response collected for a Amazon Q App session. This container represents a single\n response to a Q App session.

" } }, "com.amazonaws.qapps#QAppSessionDataList": { @@ -4654,7 +4729,7 @@ "name": "qapps" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Q Apps feature capability within Amazon Q Business allows web experience\n users to create lightweight, purpose-built AI apps to fulfill specific tasks from\n within their web experience. For example, users can create a Q App that exclusively\n generates marketing-related content to improve your marketing team's productivity or a\n Q App for writing customer emails and creating promotional content using a certain\n style of voice, tone, and branding. For more information on the capabilities, see\n Amazon Q Apps capabilities in the Amazon Q Business User Guide.\n

\n

For an overview of the Amazon Q App APIs, see Overview of\n Amazon Q Apps API operations.

\n

For information about the IAM access control permissions you need to\n use the Amazon Q Apps API, see \n IAM role for the Amazon Q Business web experience including Amazon Q Apps in the\n Amazon Q Business User Guide.

", + "smithy.api#documentation": "

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create\n lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.\n For example, users can create a Q App that exclusively generates marketing-related content to\n improve your marketing team's productivity or a Q App for writing customer emails and\n creating promotional content using a certain style of voice, tone, and branding. For more\n information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User\n Guide.

\n

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API\n operations.

\n

For information about the IAM access control permissions you need to use\n the Amazon Q Apps API, see \n IAM role for the Amazon Q Business web experience including Amazon Q Apps in\n the Amazon Q Business User Guide.

", "smithy.api#title": "QApps", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5379,6 +5454,12 @@ "smithy.api#documentation": "

The unique identifier of the plugin used by the card.

", "smithy.api#required": {} } + }, + "actionIdentifier": { + "target": "com.amazonaws.qapps#ActionIdentifier", + "traits": { + "smithy.api#documentation": "

The action identifier of the action to be performed by the plugin card.

" + } } }, "traits": { @@ -5423,6 +5504,12 @@ "smithy.api#documentation": "

The unique identifier of the plugin used by the card.

", "smithy.api#required": {} } + }, + "actionIdentifier": { + "target": "com.amazonaws.qapps#ActionIdentifier", + "traits": { + "smithy.api#documentation": "

The action identifier of the action to be performed by the plugin card.

" + } } }, "traits": { @@ -5483,12 +5570,12 @@ "memoryReferences": { "target": "com.amazonaws.qapps#MemoryReferenceList", "traits": { - "smithy.api#documentation": "

Any dependencies for the query card, where the dependencies are references to the collected responses.

" + "smithy.api#documentation": "

Any dependencies for the query card, where the dependencies are references to the\n collected responses.

" } } }, "traits": { - "smithy.api#documentation": "

A card in a Amazon Q App that generates a response\n based on the Amazon Q Business service.

" + "smithy.api#documentation": "

A card in a Amazon Q App that generates a response based on the Amazon Q Business service.

" } }, "com.amazonaws.qapps#QQueryCardInput": { @@ -5627,7 +5714,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because\n it would exceed the service's quota or limit.

", + "smithy.api#documentation": "

The requested operation could not be completed because it would exceed the service's quota\n or limit.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -5662,7 +5749,7 @@ "revealCards": { "target": "com.amazonaws.qapps#SessionSharingRevealCards", "traits": { - "smithy.api#documentation": "

Indicates whether collected responses for an Q App session are revealed for all users.

" + "smithy.api#documentation": "

Indicates whether collected responses for an Q App session are revealed for all\n users.

" } } }, @@ -5708,7 +5795,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new session for an Amazon Q App, allowing inputs to be provided\n and the app to be run.

\n \n

Each Q App session will be condensed into a single conversation\n in the web experience.

\n ", + "smithy.api#documentation": "

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be\n run.

\n \n

Each Q App session will be condensed into a single conversation in the web\n experience.

\n ", "smithy.api#examples": [ { "title": "Start a session for an Amazon Q App using version 1, passing in initial values for one card", @@ -5837,7 +5924,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an active session for an Amazon Q App.This deletes all data\n related to the session and makes it invalid for future uses. The\n results of the session will be persisted as part of the conversation.

", + "smithy.api#documentation": "

Stops an active session for an Amazon Q App.This deletes all data related to the session and\n makes it invalid for future uses. The results of the session will be persisted as part of the\n conversation.

", "smithy.api#http": { "method": "POST", "uri": "/runtime.deleteMiniAppRun" @@ -6193,7 +6280,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because too many\n requests were sent at once. Wait a bit and try again later.

", + "smithy.api#documentation": "

The requested operation could not be completed because too many requests were sent at\n once. Wait a bit and try again later.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -6625,7 +6712,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

", + "smithy.api#documentation": "

Updates an existing Amazon Q App, allowing modifications to its title, description, and\n definition.

", "smithy.api#examples": [ { "title": "Updating the title of an app", @@ -6961,7 +7048,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were\n updated.

" } }, "appId": { @@ -7013,7 +7100,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the session for a given Q App sessionId. This is only\n valid when at least one card of the session is in the WAITING state.\n Data for each WAITING card can be provided as input. If inputs\n are not provided, the call will be accepted but session will not move forward.\n Inputs for cards that are not in the WAITING status will be ignored.

", + "smithy.api#documentation": "

Updates the session for a given Q App sessionId. This is only valid when at\n least one card of the session is in the WAITING state. Data for each\n WAITING card can be provided as input. If inputs are not provided, the call\n will be accepted but session will not move forward. Inputs for cards that are not in the\n WAITING status will be ignored.

", "smithy.api#http": { "method": "POST", "uri": "/runtime.updateQAppSession" @@ -7081,7 +7168,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration metadata of a session for a given Q App sessionId.

", + "smithy.api#documentation": "

Updates the configuration metadata of a session for a given Q App\n sessionId.

", "smithy.api#examples": [ { "title": "Updates an existing session metadata for an Amazon Q App",