qapps/aws.sdk.kotlin.services.qapps

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateLibraryItemReview

inline suspend fun QAppsClient.associateLibraryItemReview(crossinline block: AssociateLibraryItemReviewRequest.Builder.() -> Unit): AssociateLibraryItemReviewResponse

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

inline suspend fun QAppsClient.associateQAppWithUser(crossinline block: AssociateQAppWithUserRequest.Builder.() -> Unit): AssociateQAppWithUserResponse

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

inline suspend fun QAppsClient.batchCreateCategory(crossinline block: BatchCreateCategoryRequest.Builder.() -> Unit): BatchCreateCategoryResponse

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

inline suspend fun QAppsClient.batchDeleteCategory(crossinline block: BatchDeleteCategoryRequest.Builder.() -> Unit): BatchDeleteCategoryResponse

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

inline suspend fun QAppsClient.batchUpdateCategory(crossinline block: BatchUpdateCategoryRequest.Builder.() -> Unit): BatchUpdateCategoryResponse

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

inline suspend fun QAppsClient.createLibraryItem(crossinline block: CreateLibraryItemRequest.Builder.() -> Unit): CreateLibraryItemResponse

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

createPresignedUrl

inline suspend fun QAppsClient.createPresignedUrl(crossinline block: CreatePresignedUrlRequest.Builder.() -> Unit): CreatePresignedUrlResponse

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

inline suspend fun QAppsClient.createQApp(crossinline block: CreateQAppRequest.Builder.() -> Unit): CreateQAppResponse

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

inline suspend fun QAppsClient.deleteLibraryItem(crossinline block: DeleteLibraryItemRequest.Builder.() -> Unit): DeleteLibraryItemResponse

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

inline suspend fun QAppsClient.deleteQApp(crossinline block: DeleteQAppRequest.Builder.() -> Unit): DeleteQAppResponse

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

inline suspend fun QAppsClient.describeQAppPermissions(crossinline block: DescribeQAppPermissionsRequest.Builder.() -> Unit): DescribeQAppPermissionsResponse

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

disassociateLibraryItemReview

inline suspend fun QAppsClient.disassociateLibraryItemReview(crossinline block: DisassociateLibraryItemReviewRequest.Builder.() -> Unit): DisassociateLibraryItemReviewResponse

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

disassociateQAppFromUser

inline suspend fun QAppsClient.disassociateQAppFromUser(crossinline block: DisassociateQAppFromUserRequest.Builder.() -> Unit): DisassociateQAppFromUserResponse

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

exportQAppSessionData

inline suspend fun QAppsClient.exportQAppSessionData(crossinline block: ExportQAppSessionDataRequest.Builder.() -> Unit): ExportQAppSessionDataResponse

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

getLibraryItem

inline suspend fun QAppsClient.getLibraryItem(crossinline block: GetLibraryItemRequest.Builder.() -> Unit): GetLibraryItemResponse

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

getQApp

inline suspend fun QAppsClient.getQApp(crossinline block: GetQAppRequest.Builder.() -> Unit): GetQAppResponse

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

getQAppSession

inline suspend fun QAppsClient.getQAppSession(crossinline block: GetQAppSessionRequest.Builder.() -> Unit): GetQAppSessionResponse

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

getQAppSessionMetadata

inline suspend fun QAppsClient.getQAppSessionMetadata(crossinline block: GetQAppSessionMetadataRequest.Builder.() -> Unit): GetQAppSessionMetadataResponse

Retrieves the current configuration of a Q App session.

importDocument

inline suspend fun QAppsClient.importDocument(crossinline block: ImportDocumentRequest.Builder.() -> Unit): ImportDocumentResponse

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

inline suspend fun QAppsClient.listCategories(crossinline block: ListCategoriesRequest.Builder.() -> Unit): ListCategoriesResponse

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

listLibraryItems

inline suspend fun QAppsClient.listLibraryItems(crossinline block: ListLibraryItemsRequest.Builder.() -> Unit): ListLibraryItemsResponse

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

listQApps

inline suspend fun QAppsClient.listQApps(crossinline block: ListQAppsRequest.Builder.() -> Unit): ListQAppsResponse

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

inline suspend fun QAppsClient.listQAppSessionData(crossinline block: ListQAppSessionDataRequest.Builder.() -> Unit): ListQAppSessionDataResponse

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

listTagsForResource

inline suspend fun QAppsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags associated with an Amazon Q Apps resource.

predictQApp

inline suspend fun QAppsClient.predictQApp(crossinline block: PredictQAppRequest.Builder.() -> Unit): PredictQAppResponse

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

inline suspend fun QAppsClient.startQAppSession(crossinline block: StartQAppSessionRequest.Builder.() -> Unit): StartQAppSessionResponse

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

stopQAppSession

inline suspend fun QAppsClient.stopQAppSession(crossinline block: StopQAppSessionRequest.Builder.() -> Unit): StopQAppSessionResponse

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

inline suspend fun QAppsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates tags with an Amazon Q Apps resource.

untagResource

inline suspend fun QAppsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Disassociates tags from an Amazon Q Apps resource.

updateLibraryItem

inline suspend fun QAppsClient.updateLibraryItem(crossinline block: UpdateLibraryItemRequest.Builder.() -> Unit): UpdateLibraryItemResponse

Updates the library item for an Amazon Q App.

updateLibraryItemMetadata

inline suspend fun QAppsClient.updateLibraryItemMetadata(crossinline block: UpdateLibraryItemMetadataRequest.Builder.() -> Unit): UpdateLibraryItemMetadataResponse

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

updateQApp

inline suspend fun QAppsClient.updateQApp(crossinline block: UpdateQAppRequest.Builder.() -> Unit): UpdateQAppResponse

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

updateQAppPermissions

inline suspend fun QAppsClient.updateQAppPermissions(crossinline block: UpdateQAppPermissionsRequest.Builder.() -> Unit): UpdateQAppPermissionsResponse

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

updateQAppSession

inline suspend fun QAppsClient.updateQAppSession(crossinline block: UpdateQAppSessionRequest.Builder.() -> Unit): UpdateQAppSessionResponse

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

inline suspend fun QAppsClient.updateQAppSessionMetadata(crossinline block: UpdateQAppSessionMetadataRequest.Builder.() -> Unit): UpdateQAppSessionMetadataResponse

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

withConfig

fun QAppsClient.withConfig(block: QAppsClient.Config.Builder.() -> Unit): QAppsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.