@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSQApps
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSQApps
instead.
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 an Q Appthat exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for marketing content-generation like writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information, see Amazon Q App in the Amazon Q Business User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateLibraryItemReviewResult |
associateLibraryItemReview(AssociateLibraryItemReviewRequest associateLibraryItemReviewRequest)
Associates a rating or review for a library item with the user submitting the request.
|
AssociateQAppWithUserResult |
associateQAppWithUser(AssociateQAppWithUserRequest associateQAppWithUserRequest)
This operation creates a link between the user's identity calling the operation and a specific Q App.
|
CreateLibraryItemResult |
createLibraryItem(CreateLibraryItemRequest createLibraryItemRequest)
Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
|
CreateQAppResult |
createQApp(CreateQAppRequest createQAppRequest)
Creates a new Amazon Q App based on the provided definition.
|
DeleteLibraryItemResult |
deleteLibraryItem(DeleteLibraryItemRequest 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.
|
DeleteQAppResult |
deleteQApp(DeleteQAppRequest deleteQAppRequest)
Deletes an Amazon Q App owned by the user.
|
DisassociateLibraryItemReviewResult |
disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest disassociateLibraryItemReviewRequest)
Removes a rating or review previously submitted by the user for a library item.
|
DisassociateQAppFromUserResult |
disassociateQAppFromUser(DisassociateQAppFromUserRequest disassociateQAppFromUserRequest)
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 getLibraryItemRequest)
Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and
usage statistics.
|
GetQAppResult |
getQApp(GetQAppRequest getQAppRequest)
Retrieves the full details of an Q App, including its definition specifying the cards and flow.
|
GetQAppSessionResult |
getQAppSession(GetQAppSessionRequest getQAppSessionRequest)
Retrieves the current state and results for an active session of an Amazon Q App.
|
ImportDocumentResult |
importDocument(ImportDocumentRequest 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. |
ListLibraryItemsResult |
listLibraryItems(ListLibraryItemsRequest listLibraryItemsRequest)
Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services
account.
|
ListQAppsResult |
listQApps(ListQAppsRequest 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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with an Amazon Q Apps resource.
|
PredictQAppResult |
predictQApp(PredictQAppRequest 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 . |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartQAppSessionResult |
startQAppSession(StartQAppSessionRequest startQAppSessionRequest)
Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
|
StopQAppSessionResult |
stopQAppSession(StopQAppSessionRequest 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.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates tags with an Amazon Q Apps resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Disassociates tags from an Amazon Q Apps resource.
|
UpdateLibraryItemResult |
updateLibraryItem(UpdateLibraryItemRequest updateLibraryItemRequest)
Updates the metadata and status of a library item for an Amazon Q App.
|
UpdateQAppResult |
updateQApp(UpdateQAppRequest updateQAppRequest)
Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
|
UpdateQAppSessionResult |
updateQAppSession(UpdateQAppSessionRequest updateQAppSessionRequest)
Updates the session for a given Q App
sessionId . |
static final String ENDPOINT_PREFIX
AssociateLibraryItemReviewResult associateLibraryItemReview(AssociateLibraryItemReviewRequest 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.
associateLibraryItemReviewRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.AssociateQAppWithUserResult associateQAppWithUser(AssociateQAppWithUserRequest 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.
associateQAppWithUserRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.CreateLibraryItemResult createLibraryItem(CreateLibraryItemRequest createLibraryItemRequest)
Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
createLibraryItemRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.CreateQAppResult createQApp(CreateQAppRequest 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.
createQAppRequest
- AccessDeniedException
- The client is not authorized to perform the requested operation.ConflictException
- The requested operation could not be completed due to a conflict with the current state of the resource.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ContentTooLargeException
- The requested operation could not be completed because the content exceeds the maximum allowed size.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.DeleteLibraryItemResult deleteLibraryItem(DeleteLibraryItemRequest 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.
deleteLibraryItemRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.DeleteQAppResult deleteQApp(DeleteQAppRequest 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.
deleteQAppRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.DisassociateLibraryItemReviewResult disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest disassociateLibraryItemReviewRequest)
Removes a rating or review previously submitted by the user for a library item.
disassociateLibraryItemReviewRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.DisassociateQAppFromUserResult disassociateQAppFromUser(DisassociateQAppFromUserRequest disassociateQAppFromUserRequest)
Disassociates a Q App from a user removing the user's access to run the Q App.
disassociateQAppFromUserRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.GetLibraryItemResult getLibraryItem(GetLibraryItemRequest getLibraryItemRequest)
Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
getLibraryItemRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.GetQAppResult getQApp(GetQAppRequest getQAppRequest)
Retrieves the full details of an Q App, including its definition specifying the cards and flow.
getQAppRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.GetQAppSessionResult getQAppSession(GetQAppSessionRequest getQAppSessionRequest)
Retrieves the current state and results for an active session of an Amazon Q App.
getQAppSessionRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.ImportDocumentResult importDocument(ImportDocumentRequest 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.
importDocumentRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ContentTooLargeException
- The requested operation could not be completed because the content exceeds the maximum allowed size.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.ListLibraryItemsResult listLibraryItems(ListLibraryItemsRequest listLibraryItemsRequest)
Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
listLibraryItemsRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.ListQAppsResult listQApps(ListQAppsRequest 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..
listQAppsRequest
- AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with an Amazon Q Apps resource.
listTagsForResourceRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.PredictQAppResult predictQApp(PredictQAppRequest 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.
predictQAppRequest
- AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.StartQAppSessionResult startQAppSession(StartQAppSessionRequest 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.
startQAppSessionRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.StopQAppSessionResult stopQAppSession(StopQAppSessionRequest 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.
stopQAppSessionRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associates tags with an Amazon Q Apps resource.
tagResourceRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ConflictException
- The requested operation could not be completed due to a conflict with the current state of the resource.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Disassociates tags from an Amazon Q Apps resource.
untagResourceRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.UpdateLibraryItemResult updateLibraryItem(UpdateLibraryItemRequest updateLibraryItemRequest)
Updates the metadata and status of a library item for an Amazon Q App.
updateLibraryItemRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.UpdateQAppResult updateQApp(UpdateQAppRequest updateQAppRequest)
Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
updateQAppRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ContentTooLargeException
- The requested operation could not be completed because the content exceeds the maximum allowed size.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.UpdateQAppSessionResult updateQAppSession(UpdateQAppSessionRequest 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.
updateQAppSessionRequest
- ResourceNotFoundException
- The requested resource could not be found.AccessDeniedException
- The client is not authorized to perform the requested operation.ValidationException
- The input failed to satisfy the constraints specified by the service.InternalServerException
- An internal service error occurred while processing the request.UnauthorizedException
- The client is not authenticated or authorized to perform the requested operation.ServiceQuotaExceededException
- The requested operation could not be completed because it would exceed the service's quota or limit.ThrottlingException
- The requested operation could not be completed because too many requests were sent at once. Wait a bit
and try again later.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.