IAmazonQApps Interface | AWS SDK for .NET V3

Interface for accessing 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.

Inheritance Hierarchy

Amazon.QApps.IAmazonQApps

Namespace: Amazon.QApps
Assembly: AWSSDK.QApps.dll
Version: 3.x.y.z

Syntax

public interface IAmazonQApps
         IAmazonService, IDisposable

The IAmazonQApps type exposes the following members

Properties

	Name	Type	Description
	Paginators	Amazon.QApps.Model.IQAppsPaginatorFactory	Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	AssociateLibraryItemReview(AssociateLibraryItemReviewRequest)	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.
	AssociateLibraryItemReviewAsync(AssociateLibraryItemReviewRequest, CancellationToken)	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(AssociateQAppWithUserRequest)	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.
	AssociateQAppWithUserAsync(AssociateQAppWithUserRequest, CancellationToken)	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.
	BatchCreateCategory(BatchCreateCategoryRequest)	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.
	BatchCreateCategoryAsync(BatchCreateCategoryRequest, CancellationToken)	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.
	BatchDeleteCategory(BatchDeleteCategoryRequest)	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.
	BatchDeleteCategoryAsync(BatchDeleteCategoryRequest, CancellationToken)	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.
	BatchUpdateCategory(BatchUpdateCategoryRequest)	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.
	BatchUpdateCategoryAsync(BatchUpdateCategoryRequest, CancellationToken)	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.
	CreateLibraryItem(CreateLibraryItemRequest)	Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
	CreateLibraryItemAsync(CreateLibraryItemRequest, CancellationToken)	Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
	CreatePresignedUrl(CreatePresignedUrlRequest)	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.
	CreatePresignedUrlAsync(CreatePresignedUrlRequest, CancellationToken)	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.
	CreateQApp(CreateQAppRequest)	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.
	CreateQAppAsync(CreateQAppRequest, CancellationToken)	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(DeleteLibraryItemRequest)	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.
	DeleteLibraryItemAsync(DeleteLibraryItemRequest, CancellationToken)	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(DeleteQAppRequest)	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.
	DeleteQAppAsync(DeleteQAppRequest, CancellationToken)	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.
	DescribeQAppPermissions(DescribeQAppPermissionsRequest)	Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
	DescribeQAppPermissionsAsync(DescribeQAppPermissionsRequest, CancellationToken)	Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
	DetermineServiceOperationEndpoint(AmazonWebServiceRequest)	Returns the endpoint that will be used for a particular request.
	DisassociateLibraryItemReview(DisassociateLibraryItemReviewRequest)	Removes a rating or review previously submitted by the user for a library item.
	DisassociateLibraryItemReviewAsync(DisassociateLibraryItemReviewRequest, CancellationToken)	Removes a rating or review previously submitted by the user for a library item.
	DisassociateQAppFromUser(DisassociateQAppFromUserRequest)	Disassociates a Q App from a user removing the user's access to run the Q App.
	DisassociateQAppFromUserAsync(DisassociateQAppFromUserRequest, CancellationToken)	Disassociates a Q App from a user removing the user's access to run the Q App.
	ExportQAppSessionData(ExportQAppSessionDataRequest)	Exports the collected data of a Q App data collection session.
	ExportQAppSessionDataAsync(ExportQAppSessionDataRequest, CancellationToken)	Exports the collected data of a Q App data collection session.
	GetLibraryItem(GetLibraryItemRequest)	Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
	GetLibraryItemAsync(GetLibraryItemRequest, CancellationToken)	Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
	GetQApp(GetQAppRequest)	Retrieves the full details of an Q App, including its definition specifying the cards and flow.
	GetQAppAsync(GetQAppRequest, CancellationToken)	Retrieves the full details of an Q App, including its definition specifying the cards and flow.
	GetQAppSession(GetQAppSessionRequest)	Retrieves the current state and results for an active session of an Amazon Q App.
	GetQAppSessionAsync(GetQAppSessionRequest, CancellationToken)	Retrieves the current state and results for an active session of an Amazon Q App.
	GetQAppSessionMetadata(GetQAppSessionMetadataRequest)	Retrieves the current configuration of a Q App session.
	GetQAppSessionMetadataAsync(GetQAppSessionMetadataRequest, CancellationToken)	Retrieves the current configuration of a Q App session.
	ImportDocument(ImportDocumentRequest)	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.
	ImportDocumentAsync(ImportDocumentRequest, CancellationToken)	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.
	ListCategories(ListCategoriesRequest)	Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
	ListCategoriesAsync(ListCategoriesRequest, CancellationToken)	Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
	ListLibraryItems(ListLibraryItemsRequest)	Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
	ListLibraryItemsAsync(ListLibraryItemsRequest, CancellationToken)	Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
	ListQApps(ListQAppsRequest)	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..
	ListQAppsAsync(ListQAppsRequest, CancellationToken)	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..
	ListQAppSessionData(ListQAppSessionDataRequest)	Lists the collected data of a Q App data collection session.
	ListQAppSessionDataAsync(ListQAppSessionDataRequest, CancellationToken)	Lists the collected data of a Q App data collection session.
	ListTagsForResource(ListTagsForResourceRequest)	Lists the tags associated with an Amazon Q Apps resource.
	ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)	Lists the tags associated with an Amazon Q Apps resource.
	PredictQApp(PredictQAppRequest)	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.
	PredictQAppAsync(PredictQAppRequest, CancellationToken)	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(StartQAppSessionRequest)	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.
	StartQAppSessionAsync(StartQAppSessionRequest, CancellationToken)	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.
	StopQAppSession(StopQAppSessionRequest)	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.
	StopQAppSessionAsync(StopQAppSessionRequest, CancellationToken)	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(TagResourceRequest)	Associates tags with an Amazon Q Apps resource.
	TagResourceAsync(TagResourceRequest, CancellationToken)	Associates tags with an Amazon Q Apps resource.
	UntagResource(UntagResourceRequest)	Disassociates tags from an Amazon Q Apps resource.
	UntagResourceAsync(UntagResourceRequest, CancellationToken)	Disassociates tags from an Amazon Q Apps resource.
	UpdateLibraryItem(UpdateLibraryItemRequest)	Updates the library item for an Amazon Q App.
	UpdateLibraryItemAsync(UpdateLibraryItemRequest, CancellationToken)	Updates the library item for an Amazon Q App.
	UpdateLibraryItemMetadata(UpdateLibraryItemMetadataRequest)	Updates the verification status of a library item for an Amazon Q App.
	UpdateLibraryItemMetadataAsync(UpdateLibraryItemMetadataRequest, CancellationToken)	Updates the verification status of a library item for an Amazon Q App.
	UpdateQApp(UpdateQAppRequest)	Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
	UpdateQAppAsync(UpdateQAppRequest, CancellationToken)	Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
	UpdateQAppPermissions(UpdateQAppPermissionsRequest)	Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
	UpdateQAppPermissionsAsync(UpdateQAppPermissionsRequest, CancellationToken)	Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
	UpdateQAppSession(UpdateQAppSessionRequest)	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.
	UpdateQAppSessionAsync(UpdateQAppSessionRequest, CancellationToken)	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.
	UpdateQAppSessionMetadata(UpdateQAppSessionMetadataRequest)	Updates the configuration metadata of a session for a given Q App `sessionId`.
	UpdateQAppSessionMetadataAsync(UpdateQAppSessionMetadataRequest, CancellationToken)	Updates the configuration metadata of a session for a given Q App `sessionId`.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5