AWS.QApps — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.QApps

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using QApps

var qapps = new AWS.QApps();
qapps.associateLibraryItemReview(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the QApps object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var qapps = new AWS.QApps({apiVersion: '2023-11-27'});

You can also set the API version globally in AWS.config.apiVersions using the qapps service identifier:

AWS.config.apiVersions = {
  qapps: '2023-11-27',
  // other service API versions
};

var qapps = new AWS.QApps();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.QApps(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateLibraryItemReview(params = {}, callback) ⇒ AWS.Request

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.

associateQAppWithUser(params = {}, callback) ⇒ AWS.Request

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.

createLibraryItem(params = {}, callback) ⇒ AWS.Request

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

createQApp(params = {}, callback) ⇒ AWS.Request

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.

deleteLibraryItem(params = {}, callback) ⇒ AWS.Request

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.

deleteQApp(params = {}, callback) ⇒ AWS.Request

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.

disassociateLibraryItemReview(params = {}, callback) ⇒ AWS.Request

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

disassociateQAppFromUser(params = {}, callback) ⇒ AWS.Request

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

getLibraryItem(params = {}, callback) ⇒ AWS.Request

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

getQApp(params = {}, callback) ⇒ AWS.Request

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

getQAppSession(params = {}, callback) ⇒ AWS.Request

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

importDocument(params = {}, callback) ⇒ AWS.Request

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.

listLibraryItems(params = {}, callback) ⇒ AWS.Request

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

listQApps(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags associated with an Amazon Q Apps resource.

predictQApp(params = {}, callback) ⇒ AWS.Request

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.

startQAppSession(params = {}, callback) ⇒ AWS.Request

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

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

stopQAppSession(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates tags with an Amazon Q Apps resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Disassociates tags from an Amazon Q Apps resource.

updateLibraryItem(params = {}, callback) ⇒ AWS.Request

Updates the library item for an Amazon Q App.

updateLibraryItemMetadata(params = {}, callback) ⇒ AWS.Request

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

updateQApp(params = {}, callback) ⇒ AWS.Request

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

updateQAppSession(params = {}, callback) ⇒ AWS.Request

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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given QApps resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.