Package software.amazon.awssdk.services.qapps

Interface QAppsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface QAppsClient
extends AwsClient

Service client for accessing QApps. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateLibraryItemReviewResponse	associateLibraryItemReview(Consumer<AssociateLibraryItemReviewRequest.Builder> associateLibraryItemReviewRequest)	Associates a rating or review for a library item with the user submitting the request.
default AssociateLibraryItemReviewResponse	associateLibraryItemReview(AssociateLibraryItemReviewRequest associateLibraryItemReviewRequest)	Associates a rating or review for a library item with the user submitting the request.
default AssociateQAppWithUserResponse	associateQAppWithUser(Consumer<AssociateQAppWithUserRequest.Builder> associateQAppWithUserRequest)	This operation creates a link between the user's identity calling the operation and a specific Q App.
default AssociateQAppWithUserResponse	associateQAppWithUser(AssociateQAppWithUserRequest associateQAppWithUserRequest)	This operation creates a link between the user's identity calling the operation and a specific Q App.
static QAppsClientBuilder	builder()	Create a builder that can be used to configure and create a QAppsClient.
static QAppsClient	create()	Create a QAppsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateLibraryItemResponse	createLibraryItem(Consumer<CreateLibraryItemRequest.Builder> createLibraryItemRequest)	Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
default CreateLibraryItemResponse	createLibraryItem(CreateLibraryItemRequest createLibraryItemRequest)	Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
default CreateQAppResponse	createQApp(Consumer<CreateQAppRequest.Builder> createQAppRequest)	Creates a new Amazon Q App based on the provided definition.
default CreateQAppResponse	createQApp(CreateQAppRequest createQAppRequest)	Creates a new Amazon Q App based on the provided definition.
default DeleteLibraryItemResponse	deleteLibraryItem(Consumer<DeleteLibraryItemRequest.Builder> 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.
default DeleteLibraryItemResponse	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.
default DeleteQAppResponse	deleteQApp(Consumer<DeleteQAppRequest.Builder> deleteQAppRequest)	Deletes an Amazon Q App owned by the user.
default DeleteQAppResponse	deleteQApp(DeleteQAppRequest deleteQAppRequest)	Deletes an Amazon Q App owned by the user.
default DisassociateLibraryItemReviewResponse	disassociateLibraryItemReview(Consumer<DisassociateLibraryItemReviewRequest.Builder> disassociateLibraryItemReviewRequest)	Removes a rating or review previously submitted by the user for a library item.
default DisassociateLibraryItemReviewResponse	disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest disassociateLibraryItemReviewRequest)	Removes a rating or review previously submitted by the user for a library item.
default DisassociateQAppFromUserResponse	disassociateQAppFromUser(Consumer<DisassociateQAppFromUserRequest.Builder> disassociateQAppFromUserRequest)	Disassociates a Q App from a user removing the user's access to run the Q App.
default DisassociateQAppFromUserResponse	disassociateQAppFromUser(DisassociateQAppFromUserRequest disassociateQAppFromUserRequest)	Disassociates a Q App from a user removing the user's access to run the Q App.
default GetLibraryItemResponse	getLibraryItem(Consumer<GetLibraryItemRequest.Builder> getLibraryItemRequest)	Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
default GetLibraryItemResponse	getLibraryItem(GetLibraryItemRequest getLibraryItemRequest)	Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
default GetQAppResponse	getQApp(Consumer<GetQAppRequest.Builder> getQAppRequest)	Retrieves the full details of an Q App, including its definition specifying the cards and flow.
default GetQAppResponse	getQApp(GetQAppRequest getQAppRequest)	Retrieves the full details of an Q App, including its definition specifying the cards and flow.
default GetQAppSessionResponse	getQAppSession(Consumer<GetQAppSessionRequest.Builder> getQAppSessionRequest)	Retrieves the current state and results for an active session of an Amazon Q App.
default GetQAppSessionResponse	getQAppSession(GetQAppSessionRequest getQAppSessionRequest)	Retrieves the current state and results for an active session of an Amazon Q App.
default ImportDocumentResponse	importDocument(Consumer<ImportDocumentRequest.Builder> 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.
default ImportDocumentResponse	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.
default ListLibraryItemsResponse	listLibraryItems(Consumer<ListLibraryItemsRequest.Builder> listLibraryItemsRequest)	Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
default ListLibraryItemsResponse	listLibraryItems(ListLibraryItemsRequest listLibraryItemsRequest)	Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
default ListLibraryItemsIterable	listLibraryItemsPaginator(Consumer<ListLibraryItemsRequest.Builder> listLibraryItemsRequest)	This is a variant of listLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest) operation.
default ListLibraryItemsIterable	listLibraryItemsPaginator(ListLibraryItemsRequest listLibraryItemsRequest)	This is a variant of listLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest) operation.
default ListQAppsResponse	listQApps(Consumer<ListQAppsRequest.Builder> 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.
default ListQAppsResponse	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.
default ListQAppsIterable	listQAppsPaginator(Consumer<ListQAppsRequest.Builder> listQAppsRequest)	This is a variant of listQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest) operation.
default ListQAppsIterable	listQAppsPaginator(ListQAppsRequest listQAppsRequest)	This is a variant of listQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags associated with an Amazon Q Apps resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags associated with an Amazon Q Apps resource.
default PredictQAppResponse	predictQApp(Consumer<PredictQAppRequest.Builder> 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.
default PredictQAppResponse	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.
default QAppsServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StartQAppSessionResponse	startQAppSession(Consumer<StartQAppSessionRequest.Builder> startQAppSessionRequest)	Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
default StartQAppSessionResponse	startQAppSession(StartQAppSessionRequest startQAppSessionRequest)	Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
default StopQAppSessionResponse	stopQAppSession(Consumer<StopQAppSessionRequest.Builder> 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.
default StopQAppSessionResponse	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.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Associates tags with an Amazon Q Apps resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associates tags with an Amazon Q Apps resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Disassociates tags from an Amazon Q Apps resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Disassociates tags from an Amazon Q Apps resource.
default UpdateLibraryItemResponse	updateLibraryItem(Consumer<UpdateLibraryItemRequest.Builder> updateLibraryItemRequest)	Updates the metadata and status of a library item for an Amazon Q App.
default UpdateLibraryItemResponse	updateLibraryItem(UpdateLibraryItemRequest updateLibraryItemRequest)	Updates the metadata and status of a library item for an Amazon Q App.
default UpdateQAppResponse	updateQApp(Consumer<UpdateQAppRequest.Builder> updateQAppRequest)	Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
default UpdateQAppResponse	updateQApp(UpdateQAppRequest updateQAppRequest)	Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
default UpdateQAppSessionResponse	updateQAppSession(Consumer<UpdateQAppSessionRequest.Builder> updateQAppSessionRequest)	Updates the session for a given Q App sessionId.
default UpdateQAppSessionResponse	updateQAppSession(UpdateQAppSessionRequest updateQAppSessionRequest)	Updates the session for a given Q App sessionId.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

associateLibraryItemReview

default AssociateLibraryItemReviewResponse associateLibraryItemReview(AssociateLibraryItemReviewRequest associateLibraryItemReviewRequest)
                                                               throws ResourceNotFoundException,
                                                                      AccessDeniedException,
                                                                      ValidationException,
                                                                      InternalServerException,
                                                                      UnauthorizedException,
                                                                      ServiceQuotaExceededException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      QAppsException

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.

Parameters:

associateLibraryItemReviewRequest -

Returns:

Result of the AssociateLibraryItemReview operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateLibraryItemReview

default AssociateLibraryItemReviewResponse associateLibraryItemReview(Consumer<AssociateLibraryItemReviewRequest.Builder> associateLibraryItemReviewRequest)
                                                               throws ResourceNotFoundException,
                                                                      AccessDeniedException,
                                                                      ValidationException,
                                                                      InternalServerException,
                                                                      UnauthorizedException,
                                                                      ServiceQuotaExceededException,
                                                                      ThrottlingException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      QAppsException

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.

This is a convenience which creates an instance of the AssociateLibraryItemReviewRequest.Builder avoiding the need to create one manually via AssociateLibraryItemReviewRequest.builder()

Parameters:

associateLibraryItemReviewRequest - A Consumer that will call methods on AssociateLibraryItemReviewRequest.Builder to create a request.

Returns:

Result of the AssociateLibraryItemReview operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateQAppWithUser

default AssociateQAppWithUserResponse associateQAppWithUser(AssociateQAppWithUserRequest associateQAppWithUserRequest)
                                                     throws ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            ValidationException,
                                                            InternalServerException,
                                                            UnauthorizedException,
                                                            ServiceQuotaExceededException,
                                                            ThrottlingException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            QAppsException

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.

Parameters:

associateQAppWithUserRequest -

Returns:

Result of the AssociateQAppWithUser operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

associateQAppWithUser

default AssociateQAppWithUserResponse associateQAppWithUser(Consumer<AssociateQAppWithUserRequest.Builder> associateQAppWithUserRequest)
                                                     throws ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            ValidationException,
                                                            InternalServerException,
                                                            UnauthorizedException,
                                                            ServiceQuotaExceededException,
                                                            ThrottlingException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            QAppsException

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.

This is a convenience which creates an instance of the AssociateQAppWithUserRequest.Builder avoiding the need to create one manually via AssociateQAppWithUserRequest.builder()

Parameters:

associateQAppWithUserRequest - A Consumer that will call methods on AssociateQAppWithUserRequest.Builder to create a request.

Returns:

Result of the AssociateQAppWithUser operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createLibraryItem

default CreateLibraryItemResponse createLibraryItem(CreateLibraryItemRequest createLibraryItemRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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

Parameters:

createLibraryItemRequest -

Returns:

Result of the CreateLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createLibraryItem

default CreateLibraryItemResponse createLibraryItem(Consumer<CreateLibraryItemRequest.Builder> createLibraryItemRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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

This is a convenience which creates an instance of the CreateLibraryItemRequest.Builder avoiding the need to create one manually via CreateLibraryItemRequest.builder()

Parameters:

createLibraryItemRequest - A Consumer that will call methods on CreateLibraryItemRequest.Builder to create a request.

Returns:

Result of the CreateLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createQApp

default CreateQAppResponse createQApp(CreateQAppRequest createQAppRequest)
                               throws AccessDeniedException,
                                      ConflictException,
                                      ValidationException,
                                      InternalServerException,
                                      UnauthorizedException,
                                      ServiceQuotaExceededException,
                                      ContentTooLargeException,
                                      ThrottlingException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QAppsException

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.

Parameters:

createQAppRequest -

Returns:

Result of the CreateQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createQApp

default CreateQAppResponse createQApp(Consumer<CreateQAppRequest.Builder> createQAppRequest)
                               throws AccessDeniedException,
                                      ConflictException,
                                      ValidationException,
                                      InternalServerException,
                                      UnauthorizedException,
                                      ServiceQuotaExceededException,
                                      ContentTooLargeException,
                                      ThrottlingException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QAppsException

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.

This is a convenience which creates an instance of the CreateQAppRequest.Builder avoiding the need to create one manually via CreateQAppRequest.builder()

Parameters:

createQAppRequest - A Consumer that will call methods on CreateQAppRequest.Builder to create a request.

Returns:

Result of the CreateQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteLibraryItem

default DeleteLibraryItemResponse deleteLibraryItem(DeleteLibraryItemRequest deleteLibraryItemRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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.

Parameters:

deleteLibraryItemRequest -

Returns:

Result of the DeleteLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteLibraryItem

default DeleteLibraryItemResponse deleteLibraryItem(Consumer<DeleteLibraryItemRequest.Builder> deleteLibraryItemRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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.

This is a convenience which creates an instance of the DeleteLibraryItemRequest.Builder avoiding the need to create one manually via DeleteLibraryItemRequest.builder()

Parameters:

deleteLibraryItemRequest - A Consumer that will call methods on DeleteLibraryItemRequest.Builder to create a request.

Returns:

Result of the DeleteLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteQApp

default DeleteQAppResponse deleteQApp(DeleteQAppRequest deleteQAppRequest)
                               throws ResourceNotFoundException,
                                      AccessDeniedException,
                                      ValidationException,
                                      InternalServerException,
                                      UnauthorizedException,
                                      ThrottlingException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QAppsException

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.

Parameters:

deleteQAppRequest -

Returns:

Result of the DeleteQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteQApp

default DeleteQAppResponse deleteQApp(Consumer<DeleteQAppRequest.Builder> deleteQAppRequest)
                               throws ResourceNotFoundException,
                                      AccessDeniedException,
                                      ValidationException,
                                      InternalServerException,
                                      UnauthorizedException,
                                      ThrottlingException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QAppsException

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.

This is a convenience which creates an instance of the DeleteQAppRequest.Builder avoiding the need to create one manually via DeleteQAppRequest.builder()

Parameters:

deleteQAppRequest - A Consumer that will call methods on DeleteQAppRequest.Builder to create a request.

Returns:

Result of the DeleteQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateLibraryItemReview

default DisassociateLibraryItemReviewResponse disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest disassociateLibraryItemReviewRequest)
                                                                     throws ResourceNotFoundException,
                                                                            AccessDeniedException,
                                                                            ValidationException,
                                                                            InternalServerException,
                                                                            UnauthorizedException,
                                                                            ServiceQuotaExceededException,
                                                                            ThrottlingException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            QAppsException

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

Parameters:

disassociateLibraryItemReviewRequest -

Returns:

Result of the DisassociateLibraryItemReview operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateLibraryItemReview

default DisassociateLibraryItemReviewResponse disassociateLibraryItemReview(Consumer<DisassociateLibraryItemReviewRequest.Builder> disassociateLibraryItemReviewRequest)
                                                                     throws ResourceNotFoundException,
                                                                            AccessDeniedException,
                                                                            ValidationException,
                                                                            InternalServerException,
                                                                            UnauthorizedException,
                                                                            ServiceQuotaExceededException,
                                                                            ThrottlingException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            QAppsException

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

This is a convenience which creates an instance of the DisassociateLibraryItemReviewRequest.Builder avoiding the need to create one manually via DisassociateLibraryItemReviewRequest.builder()

Parameters:

disassociateLibraryItemReviewRequest - A Consumer that will call methods on DisassociateLibraryItemReviewRequest.Builder to create a request.

Returns:

Result of the DisassociateLibraryItemReview operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateQAppFromUser

default DisassociateQAppFromUserResponse disassociateQAppFromUser(DisassociateQAppFromUserRequest disassociateQAppFromUserRequest)
                                                           throws ResourceNotFoundException,
                                                                  AccessDeniedException,
                                                                  ValidationException,
                                                                  InternalServerException,
                                                                  UnauthorizedException,
                                                                  ThrottlingException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  QAppsException

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

Parameters:

disassociateQAppFromUserRequest -

Returns:

Result of the DisassociateQAppFromUser operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disassociateQAppFromUser

default DisassociateQAppFromUserResponse disassociateQAppFromUser(Consumer<DisassociateQAppFromUserRequest.Builder> disassociateQAppFromUserRequest)
                                                           throws ResourceNotFoundException,
                                                                  AccessDeniedException,
                                                                  ValidationException,
                                                                  InternalServerException,
                                                                  UnauthorizedException,
                                                                  ThrottlingException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  QAppsException

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

This is a convenience which creates an instance of the DisassociateQAppFromUserRequest.Builder avoiding the need to create one manually via DisassociateQAppFromUserRequest.builder()

Parameters:

disassociateQAppFromUserRequest - A Consumer that will call methods on DisassociateQAppFromUserRequest.Builder to create a request.

Returns:

Result of the DisassociateQAppFromUser operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getLibraryItem

default GetLibraryItemResponse getLibraryItem(GetLibraryItemRequest getLibraryItemRequest)
                                       throws ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              UnauthorizedException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QAppsException

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

Parameters:

getLibraryItemRequest -

Returns:

Result of the GetLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getLibraryItem

default GetLibraryItemResponse getLibraryItem(Consumer<GetLibraryItemRequest.Builder> getLibraryItemRequest)
                                       throws ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              UnauthorizedException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QAppsException

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

This is a convenience which creates an instance of the GetLibraryItemRequest.Builder avoiding the need to create one manually via GetLibraryItemRequest.builder()

Parameters:

getLibraryItemRequest - A Consumer that will call methods on GetLibraryItemRequest.Builder to create a request.

Returns:

Result of the GetLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getQApp

default GetQAppResponse getQApp(GetQAppRequest getQAppRequest)
                         throws ResourceNotFoundException,
                                AccessDeniedException,
                                ValidationException,
                                InternalServerException,
                                UnauthorizedException,
                                ThrottlingException,
                                AwsServiceException,
                                SdkClientException,
                                QAppsException

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

Parameters:

getQAppRequest -

Returns:

Result of the GetQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getQApp

default GetQAppResponse getQApp(Consumer<GetQAppRequest.Builder> getQAppRequest)
                         throws ResourceNotFoundException,
                                AccessDeniedException,
                                ValidationException,
                                InternalServerException,
                                UnauthorizedException,
                                ThrottlingException,
                                AwsServiceException,
                                SdkClientException,
                                QAppsException

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

This is a convenience which creates an instance of the GetQAppRequest.Builder avoiding the need to create one manually via GetQAppRequest.builder()

Parameters:

getQAppRequest - A Consumer that will call methods on GetQAppRequest.Builder to create a request.

Returns:

Result of the GetQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getQAppSession

default GetQAppSessionResponse getQAppSession(GetQAppSessionRequest getQAppSessionRequest)
                                       throws ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              UnauthorizedException,
                                              ServiceQuotaExceededException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QAppsException

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

Parameters:

getQAppSessionRequest -

Returns:

Result of the GetQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getQAppSession

default GetQAppSessionResponse getQAppSession(Consumer<GetQAppSessionRequest.Builder> getQAppSessionRequest)
                                       throws ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              UnauthorizedException,
                                              ServiceQuotaExceededException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QAppsException

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

This is a convenience which creates an instance of the GetQAppSessionRequest.Builder avoiding the need to create one manually via GetQAppSessionRequest.builder()

Parameters:

getQAppSessionRequest - A Consumer that will call methods on GetQAppSessionRequest.Builder to create a request.

Returns:

Result of the GetQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

importDocument

default ImportDocumentResponse importDocument(ImportDocumentRequest importDocumentRequest)
                                       throws ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              UnauthorizedException,
                                              ServiceQuotaExceededException,
                                              ContentTooLargeException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QAppsException

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.

Parameters:

importDocumentRequest -

Returns:

Result of the ImportDocument operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

importDocument

default ImportDocumentResponse importDocument(Consumer<ImportDocumentRequest.Builder> importDocumentRequest)
                                       throws ResourceNotFoundException,
                                              AccessDeniedException,
                                              ValidationException,
                                              InternalServerException,
                                              UnauthorizedException,
                                              ServiceQuotaExceededException,
                                              ContentTooLargeException,
                                              ThrottlingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              QAppsException

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.

This is a convenience which creates an instance of the ImportDocumentRequest.Builder avoiding the need to create one manually via ImportDocumentRequest.builder()

Parameters:

importDocumentRequest - A Consumer that will call methods on ImportDocumentRequest.Builder to create a request.

Returns:

Result of the ImportDocument operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLibraryItems

default ListLibraryItemsResponse listLibraryItems(ListLibraryItemsRequest listLibraryItemsRequest)
                                           throws ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  InternalServerException,
                                                  UnauthorizedException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  QAppsException

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

Parameters:

listLibraryItemsRequest -

Returns:

Result of the ListLibraryItems operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLibraryItems

default ListLibraryItemsResponse listLibraryItems(Consumer<ListLibraryItemsRequest.Builder> listLibraryItemsRequest)
                                           throws ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  InternalServerException,
                                                  UnauthorizedException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  QAppsException

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

This is a convenience which creates an instance of the ListLibraryItemsRequest.Builder avoiding the need to create one manually via ListLibraryItemsRequest.builder()

Parameters:

listLibraryItemsRequest - A Consumer that will call methods on ListLibraryItemsRequest.Builder to create a request.

Returns:

Result of the ListLibraryItems operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLibraryItemsPaginator

default ListLibraryItemsIterable listLibraryItemsPaginator(ListLibraryItemsRequest listLibraryItemsRequest)
                                                    throws ResourceNotFoundException,
                                                           AccessDeniedException,
                                                           ValidationException,
                                                           InternalServerException,
                                                           UnauthorizedException,
                                                           ThrottlingException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           QAppsException

This is a variant of listLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client.listLibraryItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client
             .listLibraryItemsPaginator(request);
     for (software.amazon.awssdk.services.qapps.model.ListLibraryItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client.listLibraryItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest) operation.

Parameters:

listLibraryItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listLibraryItemsPaginator

default ListLibraryItemsIterable listLibraryItemsPaginator(Consumer<ListLibraryItemsRequest.Builder> listLibraryItemsRequest)
                                                    throws ResourceNotFoundException,
                                                           AccessDeniedException,
                                                           ValidationException,
                                                           InternalServerException,
                                                           UnauthorizedException,
                                                           ThrottlingException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           QAppsException

This is a variant of listLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client.listLibraryItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client
             .listLibraryItemsPaginator(request);
     for (software.amazon.awssdk.services.qapps.model.ListLibraryItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client.listLibraryItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest) operation.

This is a convenience which creates an instance of the ListLibraryItemsRequest.Builder avoiding the need to create one manually via ListLibraryItemsRequest.builder()

Parameters:

listLibraryItemsRequest - A Consumer that will call methods on ListLibraryItemsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQApps

default ListQAppsResponse listQApps(ListQAppsRequest listQAppsRequest)
                             throws AccessDeniedException,
                                    ValidationException,
                                    InternalServerException,
                                    UnauthorizedException,
                                    ThrottlingException,
                                    AwsServiceException,
                                    SdkClientException,
                                    QAppsException

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

Parameters:

listQAppsRequest -

Returns:

Result of the ListQApps operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQApps

default ListQAppsResponse listQApps(Consumer<ListQAppsRequest.Builder> listQAppsRequest)
                             throws AccessDeniedException,
                                    ValidationException,
                                    InternalServerException,
                                    UnauthorizedException,
                                    ThrottlingException,
                                    AwsServiceException,
                                    SdkClientException,
                                    QAppsException

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

This is a convenience which creates an instance of the ListQAppsRequest.Builder avoiding the need to create one manually via ListQAppsRequest.builder()

Parameters:

listQAppsRequest - A Consumer that will call methods on ListQAppsRequest.Builder to create a request.

Returns:

Result of the ListQApps operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQAppsPaginator

default ListQAppsIterable listQAppsPaginator(ListQAppsRequest listQAppsRequest)
                                      throws AccessDeniedException,
                                             ValidationException,
                                             InternalServerException,
                                             UnauthorizedException,
                                             ThrottlingException,
                                             AwsServiceException,
                                             SdkClientException,
                                             QAppsException

This is a variant of listQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request);
     for (software.amazon.awssdk.services.qapps.model.ListQAppsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest) operation.

Parameters:

listQAppsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listQAppsPaginator

default ListQAppsIterable listQAppsPaginator(Consumer<ListQAppsRequest.Builder> listQAppsRequest)
                                      throws AccessDeniedException,
                                             ValidationException,
                                             InternalServerException,
                                             UnauthorizedException,
                                             ThrottlingException,
                                             AwsServiceException,
                                             SdkClientException,
                                             QAppsException

This is a variant of listQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request);
     for (software.amazon.awssdk.services.qapps.model.ListQAppsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest) operation.

This is a convenience which creates an instance of the ListQAppsRequest.Builder avoiding the need to create one manually via ListQAppsRequest.builder()

Parameters:

listQAppsRequest - A Consumer that will call methods on ListQAppsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        QAppsException

Lists the tags associated with an Amazon Q Apps resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        QAppsException

Lists the tags associated with an Amazon Q Apps resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

predictQApp

default PredictQAppResponse predictQApp(PredictQAppRequest predictQAppRequest)
                                 throws AccessDeniedException,
                                        ValidationException,
                                        InternalServerException,
                                        UnauthorizedException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QAppsException

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.

Parameters:

predictQAppRequest -

Returns:

Result of the PredictQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

predictQApp

default PredictQAppResponse predictQApp(Consumer<PredictQAppRequest.Builder> predictQAppRequest)
                                 throws AccessDeniedException,
                                        ValidationException,
                                        InternalServerException,
                                        UnauthorizedException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QAppsException

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.

This is a convenience which creates an instance of the PredictQAppRequest.Builder avoiding the need to create one manually via PredictQAppRequest.builder()

Parameters:

predictQAppRequest - A Consumer that will call methods on PredictQAppRequest.Builder to create a request.

Returns:

Result of the PredictQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startQAppSession

default StartQAppSessionResponse startQAppSession(StartQAppSessionRequest startQAppSessionRequest)
                                           throws ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  InternalServerException,
                                                  UnauthorizedException,
                                                  ServiceQuotaExceededException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  QAppsException

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.

Parameters:

startQAppSessionRequest -

Returns:

Result of the StartQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startQAppSession

default StartQAppSessionResponse startQAppSession(Consumer<StartQAppSessionRequest.Builder> startQAppSessionRequest)
                                           throws ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  InternalServerException,
                                                  UnauthorizedException,
                                                  ServiceQuotaExceededException,
                                                  ThrottlingException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  QAppsException

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.

This is a convenience which creates an instance of the StartQAppSessionRequest.Builder avoiding the need to create one manually via StartQAppSessionRequest.builder()

Parameters:

startQAppSessionRequest - A Consumer that will call methods on StartQAppSessionRequest.Builder to create a request.

Returns:

Result of the StartQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopQAppSession

default StopQAppSessionResponse stopQAppSession(StopQAppSessionRequest stopQAppSessionRequest)
                                         throws ResourceNotFoundException,
                                                AccessDeniedException,
                                                ValidationException,
                                                InternalServerException,
                                                UnauthorizedException,
                                                ServiceQuotaExceededException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                QAppsException

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.

Parameters:

stopQAppSessionRequest -

Returns:

Result of the StopQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopQAppSession

default StopQAppSessionResponse stopQAppSession(Consumer<StopQAppSessionRequest.Builder> stopQAppSessionRequest)
                                         throws ResourceNotFoundException,
                                                AccessDeniedException,
                                                ValidationException,
                                                InternalServerException,
                                                UnauthorizedException,
                                                ServiceQuotaExceededException,
                                                ThrottlingException,
                                                AwsServiceException,
                                                SdkClientException,
                                                QAppsException

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.

This is a convenience which creates an instance of the StopQAppSessionRequest.Builder avoiding the need to create one manually via StopQAppSessionRequest.builder()

Parameters:

stopQAppSessionRequest - A Consumer that will call methods on StopQAppSessionRequest.Builder to create a request.

Returns:

Result of the StopQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        AccessDeniedException,
                                        ConflictException,
                                        ValidationException,
                                        InternalServerException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QAppsException

Associates tags with an Amazon Q Apps resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        AccessDeniedException,
                                        ConflictException,
                                        ValidationException,
                                        InternalServerException,
                                        ThrottlingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        QAppsException

Associates tags with an Amazon Q Apps resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            QAppsException

Disassociates tags from an Amazon Q Apps resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            InternalServerException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            QAppsException

Disassociates tags from an Amazon Q Apps resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateLibraryItem

default UpdateLibraryItemResponse updateLibraryItem(UpdateLibraryItemRequest updateLibraryItemRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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

Parameters:

updateLibraryItemRequest -

Returns:

Result of the UpdateLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateLibraryItem

default UpdateLibraryItemResponse updateLibraryItem(Consumer<UpdateLibraryItemRequest.Builder> updateLibraryItemRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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

This is a convenience which creates an instance of the UpdateLibraryItemRequest.Builder avoiding the need to create one manually via UpdateLibraryItemRequest.builder()

Parameters:

updateLibraryItemRequest - A Consumer that will call methods on UpdateLibraryItemRequest.Builder to create a request.

Returns:

Result of the UpdateLibraryItem operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQApp

default UpdateQAppResponse updateQApp(UpdateQAppRequest updateQAppRequest)
                               throws ResourceNotFoundException,
                                      AccessDeniedException,
                                      ValidationException,
                                      InternalServerException,
                                      UnauthorizedException,
                                      ContentTooLargeException,
                                      ThrottlingException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QAppsException

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

Parameters:

updateQAppRequest -

Returns:

Result of the UpdateQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQApp

default UpdateQAppResponse updateQApp(Consumer<UpdateQAppRequest.Builder> updateQAppRequest)
                               throws ResourceNotFoundException,
                                      AccessDeniedException,
                                      ValidationException,
                                      InternalServerException,
                                      UnauthorizedException,
                                      ContentTooLargeException,
                                      ThrottlingException,
                                      AwsServiceException,
                                      SdkClientException,
                                      QAppsException

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

This is a convenience which creates an instance of the UpdateQAppRequest.Builder avoiding the need to create one manually via UpdateQAppRequest.builder()

Parameters:

updateQAppRequest - A Consumer that will call methods on UpdateQAppRequest.Builder to create a request.

Returns:

Result of the UpdateQApp operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQAppSession

default UpdateQAppSessionResponse updateQAppSession(UpdateQAppSessionRequest updateQAppSessionRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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.

Parameters:

updateQAppSessionRequest -

Returns:

Result of the UpdateQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateQAppSession

default UpdateQAppSessionResponse updateQAppSession(Consumer<UpdateQAppSessionRequest.Builder> updateQAppSessionRequest)
                                             throws ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    UnauthorizedException,
                                                    ServiceQuotaExceededException,
                                                    ThrottlingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    QAppsException

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.

This is a convenience which creates an instance of the UpdateQAppSessionRequest.Builder avoiding the need to create one manually via UpdateQAppSessionRequest.builder()

Parameters:

updateQAppSessionRequest - A Consumer that will call methods on UpdateQAppSessionRequest.Builder to create a request.

Returns:

Result of the UpdateQAppSession operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

QAppsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static QAppsClient create()

Create a QAppsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static QAppsClientBuilder builder()

Create a builder that can be used to configure and create a QAppsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default QAppsServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient