QApps

import { QApps } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/qapps.ts?docs=full";

class QApps {

constructor(apiFactory: client.ApiFactory);

async associateLibraryItemReview(params: AssociateLibraryItemReviewInput, opts?: client.RequestOptions): Promise<void>;

async associateQAppWithUser(params: AssociateQAppWithUserInput, opts?: client.RequestOptions): Promise<void>;

async createLibraryItem(params: CreateLibraryItemInput, opts?: client.RequestOptions): Promise<CreateLibraryItemOutput>;

async createQApp(params: CreateQAppInput, opts?: client.RequestOptions): Promise<CreateQAppOutput>;

async deleteLibraryItem(params: DeleteLibraryItemInput, opts?: client.RequestOptions): Promise<void>;

async deleteQApp(params: DeleteQAppInput, opts?: client.RequestOptions): Promise<void>;

async disassociateLibraryItemReview(params: DisassociateLibraryItemReviewInput, opts?: client.RequestOptions): Promise<void>;

async disassociateQAppFromUser(params: DisassociateQAppFromUserInput, opts?: client.RequestOptions): Promise<void>;

async getLibraryItem(params: GetLibraryItemInput, opts?: client.RequestOptions): Promise<GetLibraryItemOutput>;

async getQApp(params: GetQAppInput, opts?: client.RequestOptions): Promise<GetQAppOutput>;

async getQAppSession(params: GetQAppSessionInput, opts?: client.RequestOptions): Promise<GetQAppSessionOutput>;

async importDocument(params: ImportDocumentInput, opts?: client.RequestOptions): Promise<ImportDocumentOutput>;

async listLibraryItems(params: ListLibraryItemsInput, opts?: client.RequestOptions): Promise<ListLibraryItemsOutput>;

async listQApps(params: ListQAppsInput, opts?: client.RequestOptions): Promise<ListQAppsOutput>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async predictQApp(params: PredictQAppInput, opts?: client.RequestOptions): Promise<PredictQAppOutput>;

async startQAppSession(params: StartQAppSessionInput, opts?: client.RequestOptions): Promise<StartQAppSessionOutput>;

async stopQAppSession(params: StopQAppSessionInput, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateLibraryItem(params: UpdateLibraryItemInput, opts?: client.RequestOptions): Promise<UpdateLibraryItemOutput>;

async updateLibraryItemMetadata(params: UpdateLibraryItemMetadataInput, opts?: client.RequestOptions): Promise<void>;

async updateQApp(params: UpdateQAppInput, opts?: client.RequestOptions): Promise<UpdateQAppOutput>;

async updateQAppSession(params: UpdateQAppSessionInput, opts?: client.RequestOptions): Promise<UpdateQAppSessionOutput>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new QApps(apiFactory: client.ApiFactory)

[src]

§Methods

associateLibraryItemReview(params: AssociateLibraryItemReviewInput, opts?: client.RequestOptions): Promise<void>

[src]

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: AssociateQAppWithUserInput, opts?: client.RequestOptions): Promise<void>

[src]

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: CreateLibraryItemInput, opts?: client.RequestOptions): Promise<CreateLibraryItemOutput>

[src]

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

createQApp(params: CreateQAppInput, opts?: client.RequestOptions): Promise<CreateQAppOutput>

[src]

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: DeleteLibraryItemInput, opts?: client.RequestOptions): Promise<void>

[src]

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: DeleteQAppInput, opts?: client.RequestOptions): Promise<void>

[src]

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: DisassociateLibraryItemReviewInput, opts?: client.RequestOptions): Promise<void>

[src]

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

disassociateQAppFromUser(params: DisassociateQAppFromUserInput, opts?: client.RequestOptions): Promise<void>

[src]

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

getLibraryItem(params: GetLibraryItemInput, opts?: client.RequestOptions): Promise<GetLibraryItemOutput>

[src]

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

getQApp(params: GetQAppInput, opts?: client.RequestOptions): Promise<GetQAppOutput>

[src]

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

getQAppSession(params: GetQAppSessionInput, opts?: client.RequestOptions): Promise<GetQAppSessionOutput>

[src]

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

importDocument(params: ImportDocumentInput, opts?: client.RequestOptions): Promise<ImportDocumentOutput>

[src]

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: ListLibraryItemsInput, opts?: client.RequestOptions): Promise<ListLibraryItemsOutput>

[src]

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

listQApps(params: ListQAppsInput, opts?: client.RequestOptions): Promise<ListQAppsOutput>

[src]

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: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags associated with an Amazon Q Apps resource.

predictQApp(params: PredictQAppInput, opts?: client.RequestOptions): Promise<PredictQAppOutput>

[src]

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: StartQAppSessionInput, opts?: client.RequestOptions): Promise<StartQAppSessionOutput>

[src]

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: StopQAppSessionInput, opts?: client.RequestOptions): Promise<void>

[src]

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: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Associates tags with an Amazon Q Apps resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociates tags from an Amazon Q Apps resource.

updateLibraryItem(params: UpdateLibraryItemInput, opts?: client.RequestOptions): Promise<UpdateLibraryItemOutput>

[src]

Updates the library item for an Amazon Q App.

updateLibraryItemMetadata(params: UpdateLibraryItemMetadataInput, opts?: client.RequestOptions): Promise<void>

[src]

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

updateQApp(params: UpdateQAppInput, opts?: client.RequestOptions): Promise<UpdateQAppOutput>

[src]

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

updateQAppSession(params: UpdateQAppSessionInput, opts?: client.RequestOptions): Promise<UpdateQAppSessionOutput>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]