QAppsClient

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.

Installation

NPM
npm install @aws-sdk/client-qapps
Yarn
yarn add @aws-sdk/client-qapps
pnpm
pnpm add @aws-sdk/client-qapps

QAppsClient Operations

Command
Summary
AssociateLibraryItemReviewCommand

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.

AssociateQAppWithUserCommand

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 inventory of Q Apps.

BatchCreateCategoryCommand

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 .

BatchDeleteCategoryCommand

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 .

BatchUpdateCategoryCommand

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 .

CreateLibraryItemCommand

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

CreatePresignedUrlCommand

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.

CreateQAppCommand

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.

DeleteLibraryItemCommand

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.

DeleteQAppCommand

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.

DescribeQAppPermissionsCommand

Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.

DisassociateLibraryItemReviewCommand

Removes a rating or review previously submitted by the user for a library item.

DisassociateQAppFromUserCommand

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

ExportQAppSessionDataCommand

Exports the collected data of a Q App data collection session.

GetLibraryItemCommand

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

GetQAppCommand

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

GetQAppSessionCommand

Retrieves the current state and results for an active session of an Amazon Q App.

GetQAppSessionMetadataCommand

Retrieves the current configuration of a Q App session.

ImportDocumentCommand

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.

ListCategoriesCommand

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

ListLibraryItemsCommand

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

ListQAppSessionDataCommand

Lists the collected data of a Q App data collection session.

ListQAppsCommand

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

ListTagsForResourceCommand

Lists the tags associated with an Amazon Q Apps resource.

PredictQAppCommand

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.

StartQAppSessionCommand

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.

StopQAppSessionCommand

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.

TagResourceCommand

Associates tags with an Amazon Q Apps resource.

UntagResourceCommand

Disassociates tags from an Amazon Q Apps resource.

UpdateLibraryItemCommand

Updates the library item for an Amazon Q App.

UpdateLibraryItemMetadataCommand

Updates the verification status of a library item for an Amazon Q App.

UpdateQAppCommand

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

UpdateQAppPermissionsCommand

Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.

UpdateQAppSessionCommand

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.

UpdateQAppSessionMetadataCommand

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

QAppsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: QAppsClientConfig