com.amazonaws.services.qapps

Class AbstractAWSQApps

java.lang.Object

com.amazonaws.services.qapps.AbstractAWSQApps

All Implemented Interfaces:

AWSQApps

Direct Known Subclasses:

AbstractAWSQAppsAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSQApps
extends Object
implements AWSQApps

Abstract implementation of AWSQApps. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.qapps.AWSQApps

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateLibraryItemReviewResult	associateLibraryItemReview(AssociateLibraryItemReviewRequest request) Associates a rating or review for a library item with the user submitting the request.
AssociateQAppWithUserResult	associateQAppWithUser(AssociateQAppWithUserRequest request) This operation creates a link between the user's identity calling the operation and a specific Q App.
CreateLibraryItemResult	createLibraryItem(CreateLibraryItemRequest request) Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
CreateQAppResult	createQApp(CreateQAppRequest request) Creates a new Amazon Q App based on the provided definition.
DeleteLibraryItemResult	deleteLibraryItem(DeleteLibraryItemRequest 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.
DeleteQAppResult	deleteQApp(DeleteQAppRequest request) Deletes an Amazon Q App owned by the user.
DisassociateLibraryItemReviewResult	disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest request) Removes a rating or review previously submitted by the user for a library item.
DisassociateQAppFromUserResult	disassociateQAppFromUser(DisassociateQAppFromUserRequest request) Disassociates a Q App from a user removing the user's access to run the Q App.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetLibraryItemResult	getLibraryItem(GetLibraryItemRequest request) Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
GetQAppResult	getQApp(GetQAppRequest request) Retrieves the full details of an Q App, including its definition specifying the cards and flow.
GetQAppSessionResult	getQAppSession(GetQAppSessionRequest request) Retrieves the current state and results for an active session of an Amazon Q App.
ImportDocumentResult	importDocument(ImportDocumentRequest 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.
ListLibraryItemsResult	listLibraryItems(ListLibraryItemsRequest request) Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
ListQAppsResult	listQApps(ListQAppsRequest 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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags associated with an Amazon Q Apps resource.
PredictQAppResult	predictQApp(PredictQAppRequest 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartQAppSessionResult	startQAppSession(StartQAppSessionRequest request) Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
StopQAppSessionResult	stopQAppSession(StopQAppSessionRequest 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.
TagResourceResult	tagResource(TagResourceRequest request) Associates tags with an Amazon Q Apps resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Disassociates tags from an Amazon Q Apps resource.
UpdateLibraryItemResult	updateLibraryItem(UpdateLibraryItemRequest request) Updates the metadata and status of a library item for an Amazon Q App.
UpdateQAppResult	updateQApp(UpdateQAppRequest request) Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
UpdateQAppSessionResult	updateQAppSession(UpdateQAppSessionRequest request) Updates the session for a given Q App sessionId.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

associateLibraryItemReview

public AssociateLibraryItemReviewResult associateLibraryItemReview(AssociateLibraryItemReviewRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

associateLibraryItemReview in interface AWSQApps

Returns:

Result of the AssociateLibraryItemReview operation returned by the service.

See Also:

AWS API Documentation

associateQAppWithUser

public AssociateQAppWithUserResult associateQAppWithUser(AssociateQAppWithUserRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

associateQAppWithUser in interface AWSQApps

Returns:

Result of the AssociateQAppWithUser operation returned by the service.

See Also:

AWS API Documentation

createLibraryItem

public CreateLibraryItemResult createLibraryItem(CreateLibraryItemRequest request)

Description copied from interface: AWSQApps

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

Specified by:

createLibraryItem in interface AWSQApps

Returns:

Result of the CreateLibraryItem operation returned by the service.

See Also:

AWS API Documentation

createQApp

public CreateQAppResult createQApp(CreateQAppRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

createQApp in interface AWSQApps

Returns:

Result of the CreateQApp operation returned by the service.

See Also:

AWS API Documentation

deleteLibraryItem

public DeleteLibraryItemResult deleteLibraryItem(DeleteLibraryItemRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

deleteLibraryItem in interface AWSQApps

Returns:

Result of the DeleteLibraryItem operation returned by the service.

See Also:

AWS API Documentation

deleteQApp

public DeleteQAppResult deleteQApp(DeleteQAppRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

deleteQApp in interface AWSQApps

Returns:

Result of the DeleteQApp operation returned by the service.

See Also:

AWS API Documentation

disassociateLibraryItemReview

public DisassociateLibraryItemReviewResult disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest request)

Description copied from interface: AWSQApps

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

Specified by:

disassociateLibraryItemReview in interface AWSQApps

Returns:

Result of the DisassociateLibraryItemReview operation returned by the service.

See Also:

AWS API Documentation

disassociateQAppFromUser

public DisassociateQAppFromUserResult disassociateQAppFromUser(DisassociateQAppFromUserRequest request)

Description copied from interface: AWSQApps

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

Specified by:

disassociateQAppFromUser in interface AWSQApps

Returns:

Result of the DisassociateQAppFromUser operation returned by the service.

See Also:

AWS API Documentation

getLibraryItem

public GetLibraryItemResult getLibraryItem(GetLibraryItemRequest request)

Description copied from interface: AWSQApps

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

Specified by:

getLibraryItem in interface AWSQApps

Returns:

Result of the GetLibraryItem operation returned by the service.

See Also:

AWS API Documentation

getQApp

public GetQAppResult getQApp(GetQAppRequest request)

Description copied from interface: AWSQApps

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

Specified by:

getQApp in interface AWSQApps

Returns:

Result of the GetQApp operation returned by the service.

See Also:

AWS API Documentation

getQAppSession

public GetQAppSessionResult getQAppSession(GetQAppSessionRequest request)

Description copied from interface: AWSQApps

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

Specified by:

getQAppSession in interface AWSQApps

Returns:

Result of the GetQAppSession operation returned by the service.

See Also:

AWS API Documentation

importDocument

public ImportDocumentResult importDocument(ImportDocumentRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

importDocument in interface AWSQApps

Returns:

Result of the ImportDocument operation returned by the service.

See Also:

AWS API Documentation

listLibraryItems

public ListLibraryItemsResult listLibraryItems(ListLibraryItemsRequest request)

Description copied from interface: AWSQApps

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

Specified by:

listLibraryItems in interface AWSQApps

Returns:

Result of the ListLibraryItems operation returned by the service.

See Also:

AWS API Documentation

listQApps

public ListQAppsResult listQApps(ListQAppsRequest request)

Description copied from interface: AWSQApps

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

Specified by:

listQApps in interface AWSQApps

Returns:

Result of the ListQApps operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AWSQApps

Lists the tags associated with an Amazon Q Apps resource.

Specified by:

listTagsForResource in interface AWSQApps

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

predictQApp

public PredictQAppResult predictQApp(PredictQAppRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

predictQApp in interface AWSQApps

Returns:

Result of the PredictQApp operation returned by the service.

See Also:

AWS API Documentation

startQAppSession

public StartQAppSessionResult startQAppSession(StartQAppSessionRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

startQAppSession in interface AWSQApps

Returns:

Result of the StartQAppSession operation returned by the service.

See Also:

AWS API Documentation

stopQAppSession

public StopQAppSessionResult stopQAppSession(StopQAppSessionRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

stopQAppSession in interface AWSQApps

Returns:

Result of the StopQAppSession operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AWSQApps

Associates tags with an Amazon Q Apps resource.

Specified by:

tagResource in interface AWSQApps

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AWSQApps

Disassociates tags from an Amazon Q Apps resource.

Specified by:

untagResource in interface AWSQApps

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateLibraryItem

public UpdateLibraryItemResult updateLibraryItem(UpdateLibraryItemRequest request)

Description copied from interface: AWSQApps

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

Specified by:

updateLibraryItem in interface AWSQApps

Returns:

Result of the UpdateLibraryItem operation returned by the service.

See Also:

AWS API Documentation

updateQApp

public UpdateQAppResult updateQApp(UpdateQAppRequest request)

Description copied from interface: AWSQApps

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

Specified by:

updateQApp in interface AWSQApps

Returns:

Result of the UpdateQApp operation returned by the service.

See Also:

AWS API Documentation

updateQAppSession

public UpdateQAppSessionResult updateQAppSession(UpdateQAppSessionRequest request)

Description copied from interface: AWSQApps

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.

Specified by:

updateQAppSession in interface AWSQApps

Returns:

Result of the UpdateQAppSession operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSQApps

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSQApps

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSQApps

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AWSQApps

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.