Interface QAppsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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 a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User Guide.
For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API operations.
For information about the IAM access control permissions you need to use the Amazon Q Apps API, see IAM role for the Amazon Q Business web experience including Amazon Q Apps in the Amazon Q Business User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateLibraryItemReview
(Consumer<AssociateLibraryItemReviewRequest.Builder> associateLibraryItemReviewRequest) Associates a rating or review for a library item with the user submitting the request.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.default BatchCreateCategoryResponse
batchCreateCategory
(Consumer<BatchCreateCategoryRequest.Builder> batchCreateCategoryRequest) Creates Categories for the Amazon Q Business application environment instance.default BatchCreateCategoryResponse
batchCreateCategory
(BatchCreateCategoryRequest batchCreateCategoryRequest) Creates Categories for the Amazon Q Business application environment instance.default BatchDeleteCategoryResponse
batchDeleteCategory
(Consumer<BatchDeleteCategoryRequest.Builder> batchDeleteCategoryRequest) Deletes Categories for the Amazon Q Business application environment instance.default BatchDeleteCategoryResponse
batchDeleteCategory
(BatchDeleteCategoryRequest batchDeleteCategoryRequest) Deletes Categories for the Amazon Q Business application environment instance.default BatchUpdateCategoryResponse
batchUpdateCategory
(Consumer<BatchUpdateCategoryRequest.Builder> batchUpdateCategoryRequest) Updates Categories for the Amazon Q Business application environment instance.default BatchUpdateCategoryResponse
batchUpdateCategory
(BatchUpdateCategoryRequest batchUpdateCategoryRequest) Updates Categories for the Amazon Q Business application environment instance.static QAppsClientBuilder
builder()
Create a builder that can be used to configure and create aQAppsClient
.static QAppsClient
create()
Create aQAppsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 CreatePresignedUrlResponse
createPresignedUrl
(Consumer<CreatePresignedUrlRequest.Builder> createPresignedUrlRequest) Creates a presigned URL for an S3 POST operation to upload a file.default CreatePresignedUrlResponse
createPresignedUrl
(CreatePresignedUrlRequest createPresignedUrlRequest) Creates a presigned URL for an S3 POST operation to upload a file.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 DescribeQAppPermissionsResponse
describeQAppPermissions
(Consumer<DescribeQAppPermissionsRequest.Builder> describeQAppPermissionsRequest) Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.default DescribeQAppPermissionsResponse
describeQAppPermissions
(DescribeQAppPermissionsRequest describeQAppPermissionsRequest) Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.disassociateLibraryItemReview
(Consumer<DisassociateLibraryItemReviewRequest.Builder> disassociateLibraryItemReviewRequest) Removes a rating or review previously submitted by the user for a library item.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 ExportQAppSessionDataResponse
exportQAppSessionData
(Consumer<ExportQAppSessionDataRequest.Builder> exportQAppSessionDataRequest) Exports the collected data of a Q App data collection session.default ExportQAppSessionDataResponse
exportQAppSessionData
(ExportQAppSessionDataRequest exportQAppSessionDataRequest) Exports the collected data of a Q App data collection session.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 GetQAppSessionMetadataResponse
getQAppSessionMetadata
(Consumer<GetQAppSessionMetadataRequest.Builder> getQAppSessionMetadataRequest) Retrieves the current configuration of a Q App session.default GetQAppSessionMetadataResponse
getQAppSessionMetadata
(GetQAppSessionMetadataRequest getQAppSessionMetadataRequest) Retrieves the current configuration of a Q App session.default ImportDocumentResponse
importDocument
(Consumer<ImportDocumentRequest.Builder> importDocumentRequest) Uploads a file that can then be used either as a default in aFileUploadCard
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 aFileUploadCard
from Q App definition or as a file that is used inside a single Q App run.default ListCategoriesResponse
listCategories
(Consumer<ListCategoriesRequest.Builder> listCategoriesRequest) Lists the categories of a Amazon Q Business application environment instance.default ListCategoriesResponse
listCategories
(ListCategoriesRequest listCategoriesRequest) Lists the categories of a Amazon Q Business application environment instance.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 oflistLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest)
operation.default ListLibraryItemsIterable
listLibraryItemsPaginator
(ListLibraryItemsRequest listLibraryItemsRequest) This is a variant oflistLibraryItems(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 ListQAppSessionDataResponse
listQAppSessionData
(Consumer<ListQAppSessionDataRequest.Builder> listQAppSessionDataRequest) Lists the collected data of a Q App data collection session.default ListQAppSessionDataResponse
listQAppSessionData
(ListQAppSessionDataRequest listQAppSessionDataRequest) Lists the collected data of a Q App data collection session.default ListQAppsIterable
listQAppsPaginator
(Consumer<ListQAppsRequest.Builder> listQAppsRequest) This is a variant oflistQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest)
operation.default ListQAppsIterable
listQAppsPaginator
(ListQAppsRequest listQAppsRequest) This is a variant oflistQApps(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 callCreateQApp
.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 callCreateQApp
.default QAppsServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 library item for an Amazon Q App.default UpdateLibraryItemResponse
updateLibraryItem
(UpdateLibraryItemRequest updateLibraryItemRequest) Updates the library item for an Amazon Q App.updateLibraryItemMetadata
(Consumer<UpdateLibraryItemMetadataRequest.Builder> updateLibraryItemMetadataRequest) Updates the verification status of a library item for an Amazon Q App.updateLibraryItemMetadata
(UpdateLibraryItemMetadataRequest updateLibraryItemMetadataRequest) Updates the verification 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 UpdateQAppPermissionsResponse
updateQAppPermissions
(Consumer<UpdateQAppPermissionsRequest.Builder> updateQAppPermissionsRequest) Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.default UpdateQAppPermissionsResponse
updateQAppPermissions
(UpdateQAppPermissionsRequest updateQAppPermissionsRequest) Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.default UpdateQAppSessionResponse
updateQAppSession
(Consumer<UpdateQAppSessionRequest.Builder> updateQAppSessionRequest) Updates the session for a given Q AppsessionId
.default UpdateQAppSessionResponse
updateQAppSession
(UpdateQAppSessionRequest updateQAppSessionRequest) Updates the session for a given Q AppsessionId
.updateQAppSessionMetadata
(Consumer<UpdateQAppSessionMetadataRequest.Builder> updateQAppSessionMetadataRequest) Updates the configuration metadata of a session for a given Q AppsessionId
.updateQAppSessionMetadata
(UpdateQAppSessionMetadataRequest updateQAppSessionMetadataRequest) Updates the configuration metadata of a session for a given Q AppsessionId
.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateLibraryItemReview
default AssociateLibraryItemReviewResponse associateLibraryItemReview(AssociateLibraryItemReviewRequest associateLibraryItemReviewRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, 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.
- See Also:
-
associateLibraryItemReview
default AssociateLibraryItemReviewResponse associateLibraryItemReview(Consumer<AssociateLibraryItemReviewRequest.Builder> associateLibraryItemReviewRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, 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 viaAssociateLibraryItemReviewRequest.builder()
- Parameters:
associateLibraryItemReviewRequest
- AConsumer
that will call methods onAssociateLibraryItemReviewRequest.Builder
to create a request.- Returns:
- Result of the AssociateLibraryItemReview operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaAssociateQAppWithUserRequest.builder()
- Parameters:
associateQAppWithUserRequest
- AConsumer
that will call methods onAssociateQAppWithUserRequest.Builder
to create a request.- Returns:
- Result of the AssociateQAppWithUser operation returned by the service.
- See Also:
-
batchCreateCategory
default BatchCreateCategoryResponse batchCreateCategory(BatchCreateCategoryRequest batchCreateCategoryRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
- Parameters:
batchCreateCategoryRequest
-- Returns:
- Result of the BatchCreateCategory operation returned by the service.
- See Also:
-
batchCreateCategory
default BatchCreateCategoryResponse batchCreateCategory(Consumer<BatchCreateCategoryRequest.Builder> batchCreateCategoryRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
This is a convenience which creates an instance of the
BatchCreateCategoryRequest.Builder
avoiding the need to create one manually viaBatchCreateCategoryRequest.builder()
- Parameters:
batchCreateCategoryRequest
- AConsumer
that will call methods onBatchCreateCategoryRequest.Builder
to create a request.- Returns:
- Result of the BatchCreateCategory operation returned by the service.
- See Also:
-
batchDeleteCategory
default BatchDeleteCategoryResponse batchDeleteCategory(BatchDeleteCategoryRequest batchDeleteCategoryRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
- Parameters:
batchDeleteCategoryRequest
-- Returns:
- Result of the BatchDeleteCategory operation returned by the service.
- See Also:
-
batchDeleteCategory
default BatchDeleteCategoryResponse batchDeleteCategory(Consumer<BatchDeleteCategoryRequest.Builder> batchDeleteCategoryRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
This is a convenience which creates an instance of the
BatchDeleteCategoryRequest.Builder
avoiding the need to create one manually viaBatchDeleteCategoryRequest.builder()
- Parameters:
batchDeleteCategoryRequest
- AConsumer
that will call methods onBatchDeleteCategoryRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteCategory operation returned by the service.
- See Also:
-
batchUpdateCategory
default BatchUpdateCategoryResponse batchUpdateCategory(BatchUpdateCategoryRequest batchUpdateCategoryRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
- Parameters:
batchUpdateCategoryRequest
-- Returns:
- Result of the BatchUpdateCategory operation returned by the service.
- See Also:
-
batchUpdateCategory
default BatchUpdateCategoryResponse batchUpdateCategory(Consumer<BatchUpdateCategoryRequest.Builder> batchUpdateCategoryRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.
This is a convenience which creates an instance of the
BatchUpdateCategoryRequest.Builder
avoiding the need to create one manually viaBatchUpdateCategoryRequest.builder()
- Parameters:
batchUpdateCategoryRequest
- AConsumer
that will call methods onBatchUpdateCategoryRequest.Builder
to create a request.- Returns:
- Result of the BatchUpdateCategory operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateLibraryItemRequest.builder()
- Parameters:
createLibraryItemRequest
- AConsumer
that will call methods onCreateLibraryItemRequest.Builder
to create a request.- Returns:
- Result of the CreateLibraryItem operation returned by the service.
- See Also:
-
createPresignedUrl
default CreatePresignedUrlResponse createPresignedUrl(CreatePresignedUrlRequest createPresignedUrlRequest) throws AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a
FileUploadCard
in a Q App definition or to provide a file for a single Q App run. Thescope
parameter determines how the file will be used, either at the app definition level or the app session level.- Parameters:
createPresignedUrlRequest
-- Returns:
- Result of the CreatePresignedUrl operation returned by the service.
- See Also:
-
createPresignedUrl
default CreatePresignedUrlResponse createPresignedUrl(Consumer<CreatePresignedUrlRequest.Builder> createPresignedUrlRequest) throws AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a
FileUploadCard
in a Q App definition or to provide a file for a single Q App run. Thescope
parameter determines how the file will be used, either at the app definition level or the app session level.
This is a convenience which creates an instance of the
CreatePresignedUrlRequest.Builder
avoiding the need to create one manually viaCreatePresignedUrlRequest.builder()
- Parameters:
createPresignedUrlRequest
- AConsumer
that will call methods onCreatePresignedUrlRequest.Builder
to create a request.- Returns:
- Result of the CreatePresignedUrl operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaCreateQAppRequest.builder()
- Parameters:
createQAppRequest
- AConsumer
that will call methods onCreateQAppRequest.Builder
to create a request.- Returns:
- Result of the CreateQApp operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteLibraryItemRequest.builder()
- Parameters:
deleteLibraryItemRequest
- AConsumer
that will call methods onDeleteLibraryItemRequest.Builder
to create a request.- Returns:
- Result of the DeleteLibraryItem operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteQAppRequest.builder()
- Parameters:
deleteQAppRequest
- AConsumer
that will call methods onDeleteQAppRequest.Builder
to create a request.- Returns:
- Result of the DeleteQApp operation returned by the service.
- See Also:
-
describeQAppPermissions
default DescribeQAppPermissionsResponse describeQAppPermissions(DescribeQAppPermissionsRequest describeQAppPermissionsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
- Parameters:
describeQAppPermissionsRequest
-- Returns:
- Result of the DescribeQAppPermissions operation returned by the service.
- See Also:
-
describeQAppPermissions
default DescribeQAppPermissionsResponse describeQAppPermissions(Consumer<DescribeQAppPermissionsRequest.Builder> describeQAppPermissionsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
This is a convenience which creates an instance of the
DescribeQAppPermissionsRequest.Builder
avoiding the need to create one manually viaDescribeQAppPermissionsRequest.builder()
- Parameters:
describeQAppPermissionsRequest
- AConsumer
that will call methods onDescribeQAppPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeQAppPermissions operation returned by the service.
- See Also:
-
disassociateLibraryItemReview
default DisassociateLibraryItemReviewResponse disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest disassociateLibraryItemReviewRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, 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.
- See Also:
-
disassociateLibraryItemReview
default DisassociateLibraryItemReviewResponse disassociateLibraryItemReview(Consumer<DisassociateLibraryItemReviewRequest.Builder> disassociateLibraryItemReviewRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, 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 viaDisassociateLibraryItemReviewRequest.builder()
- Parameters:
disassociateLibraryItemReviewRequest
- AConsumer
that will call methods onDisassociateLibraryItemReviewRequest.Builder
to create a request.- Returns:
- Result of the DisassociateLibraryItemReview operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDisassociateQAppFromUserRequest.builder()
- Parameters:
disassociateQAppFromUserRequest
- AConsumer
that will call methods onDisassociateQAppFromUserRequest.Builder
to create a request.- Returns:
- Result of the DisassociateQAppFromUser operation returned by the service.
- See Also:
-
exportQAppSessionData
default ExportQAppSessionDataResponse exportQAppSessionData(ExportQAppSessionDataRequest exportQAppSessionDataRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Exports the collected data of a Q App data collection session.
- Parameters:
exportQAppSessionDataRequest
-- Returns:
- Result of the ExportQAppSessionData operation returned by the service.
- See Also:
-
exportQAppSessionData
default ExportQAppSessionDataResponse exportQAppSessionData(Consumer<ExportQAppSessionDataRequest.Builder> exportQAppSessionDataRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Exports the collected data of a Q App data collection session.
This is a convenience which creates an instance of the
ExportQAppSessionDataRequest.Builder
avoiding the need to create one manually viaExportQAppSessionDataRequest.builder()
- Parameters:
exportQAppSessionDataRequest
- AConsumer
that will call methods onExportQAppSessionDataRequest.Builder
to create a request.- Returns:
- Result of the ExportQAppSessionData operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetLibraryItemRequest.builder()
- Parameters:
getLibraryItemRequest
- AConsumer
that will call methods onGetLibraryItemRequest.Builder
to create a request.- Returns:
- Result of the GetLibraryItem operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetQAppRequest.builder()
- Parameters:
getQAppRequest
- AConsumer
that will call methods onGetQAppRequest.Builder
to create a request.- Returns:
- Result of the GetQApp operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetQAppSessionRequest.builder()
- Parameters:
getQAppSessionRequest
- AConsumer
that will call methods onGetQAppSessionRequest.Builder
to create a request.- Returns:
- Result of the GetQAppSession operation returned by the service.
- See Also:
-
getQAppSessionMetadata
default GetQAppSessionMetadataResponse getQAppSessionMetadata(GetQAppSessionMetadataRequest getQAppSessionMetadataRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Retrieves the current configuration of a Q App session.
- Parameters:
getQAppSessionMetadataRequest
-- Returns:
- Result of the GetQAppSessionMetadata operation returned by the service.
- See Also:
-
getQAppSessionMetadata
default GetQAppSessionMetadataResponse getQAppSessionMetadata(Consumer<GetQAppSessionMetadataRequest.Builder> getQAppSessionMetadataRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Retrieves the current configuration of a Q App session.
This is a convenience which creates an instance of the
GetQAppSessionMetadataRequest.Builder
avoiding the need to create one manually viaGetQAppSessionMetadataRequest.builder()
- Parameters:
getQAppSessionMetadataRequest
- AConsumer
that will call methods onGetQAppSessionMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetQAppSessionMetadata operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaImportDocumentRequest.builder()
- Parameters:
importDocumentRequest
- AConsumer
that will call methods onImportDocumentRequest.Builder
to create a request.- Returns:
- Result of the ImportDocument operation returned by the service.
- See Also:
-
listCategories
default ListCategoriesResponse listCategories(ListCategoriesRequest listCategoriesRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
- Parameters:
listCategoriesRequest
-- Returns:
- Result of the ListCategories operation returned by the service.
- See Also:
-
listCategories
default ListCategoriesResponse listCategories(Consumer<ListCategoriesRequest.Builder> listCategoriesRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.
This is a convenience which creates an instance of the
ListCategoriesRequest.Builder
avoiding the need to create one manually viaListCategoriesRequest.builder()
- Parameters:
listCategoriesRequest
- AConsumer
that will call methods onListCategoriesRequest.Builder
to create a request.- Returns:
- Result of the ListCategories operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListLibraryItemsRequest.builder()
- Parameters:
listLibraryItemsRequest
- AConsumer
that will call methods onListLibraryItemsRequest.Builder
to create a request.- Returns:
- Result of the ListLibraryItems operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client.listLibraryItemsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.qapps.paginators.ListLibraryItemsIterable responses = client.listLibraryItemsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListLibraryItemsRequest.builder()
- Parameters:
listLibraryItemsRequest
- AConsumer
that will call methods onListLibraryItemsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQAppSessionData
default ListQAppSessionDataResponse listQAppSessionData(ListQAppSessionDataRequest listQAppSessionDataRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Lists the collected data of a Q App data collection session.
- Parameters:
listQAppSessionDataRequest
-- Returns:
- Result of the ListQAppSessionData operation returned by the service.
- See Also:
-
listQAppSessionData
default ListQAppSessionDataResponse listQAppSessionData(Consumer<ListQAppSessionDataRequest.Builder> listQAppSessionDataRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Lists the collected data of a Q App data collection session.
This is a convenience which creates an instance of the
ListQAppSessionDataRequest.Builder
avoiding the need to create one manually viaListQAppSessionDataRequest.builder()
- Parameters:
listQAppSessionDataRequest
- AConsumer
that will call methods onListQAppSessionDataRequest.Builder
to create a request.- Returns:
- Result of the ListQAppSessionData operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListQAppsRequest.builder()
- Parameters:
listQAppsRequest
- AConsumer
that will call methods onListQAppsRequest.Builder
to create a request.- Returns:
- Result of the ListQApps operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.qapps.paginators.ListQAppsIterable responses = client.listQAppsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListQAppsRequest.builder()
- Parameters:
listQAppsRequest
- AConsumer
that will call methods onListQAppsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaPredictQAppRequest.builder()
- Parameters:
predictQAppRequest
- AConsumer
that will call methods onPredictQAppRequest.Builder
to create a request.- Returns:
- Result of the PredictQApp operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaStartQAppSessionRequest.builder()
- Parameters:
startQAppSessionRequest
- AConsumer
that will call methods onStartQAppSessionRequest.Builder
to create a request.- Returns:
- Result of the StartQAppSession operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaStopQAppSessionRequest.builder()
- Parameters:
stopQAppSessionRequest
- AConsumer
that will call methods onStopQAppSessionRequest.Builder
to create a request.- Returns:
- Result of the StopQAppSession operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateLibraryItem
default UpdateLibraryItemResponse updateLibraryItem(UpdateLibraryItemRequest updateLibraryItemRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates the library item for an Amazon Q App.
- Parameters:
updateLibraryItemRequest
-- Returns:
- Result of the UpdateLibraryItem operation returned by the service.
- See Also:
-
updateLibraryItem
default UpdateLibraryItemResponse updateLibraryItem(Consumer<UpdateLibraryItemRequest.Builder> updateLibraryItemRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates the 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 viaUpdateLibraryItemRequest.builder()
- Parameters:
updateLibraryItemRequest
- AConsumer
that will call methods onUpdateLibraryItemRequest.Builder
to create a request.- Returns:
- Result of the UpdateLibraryItem operation returned by the service.
- See Also:
-
updateLibraryItemMetadata
default UpdateLibraryItemMetadataResponse updateLibraryItemMetadata(UpdateLibraryItemMetadataRequest updateLibraryItemMetadataRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates the verification status of a library item for an Amazon Q App.
- Parameters:
updateLibraryItemMetadataRequest
-- Returns:
- Result of the UpdateLibraryItemMetadata operation returned by the service.
- See Also:
-
updateLibraryItemMetadata
default UpdateLibraryItemMetadataResponse updateLibraryItemMetadata(Consumer<UpdateLibraryItemMetadataRequest.Builder> updateLibraryItemMetadataRequest) throws ResourceNotFoundException, AccessDeniedException, ConflictException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates the verification status of a library item for an Amazon Q App.
This is a convenience which creates an instance of the
UpdateLibraryItemMetadataRequest.Builder
avoiding the need to create one manually viaUpdateLibraryItemMetadataRequest.builder()
- Parameters:
updateLibraryItemMetadataRequest
- AConsumer
that will call methods onUpdateLibraryItemMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateLibraryItemMetadata operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateQAppRequest.builder()
- Parameters:
updateQAppRequest
- AConsumer
that will call methods onUpdateQAppRequest.Builder
to create a request.- Returns:
- Result of the UpdateQApp operation returned by the service.
- See Also:
-
updateQAppPermissions
default UpdateQAppPermissionsResponse updateQAppPermissions(UpdateQAppPermissionsRequest updateQAppPermissionsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
- Parameters:
updateQAppPermissionsRequest
-- Returns:
- Result of the UpdateQAppPermissions operation returned by the service.
- See Also:
-
updateQAppPermissions
default UpdateQAppPermissionsResponse updateQAppPermissions(Consumer<UpdateQAppPermissionsRequest.Builder> updateQAppPermissionsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
This is a convenience which creates an instance of the
UpdateQAppPermissionsRequest.Builder
avoiding the need to create one manually viaUpdateQAppPermissionsRequest.builder()
- Parameters:
updateQAppPermissionsRequest
- AConsumer
that will call methods onUpdateQAppPermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateQAppPermissions operation returned by the service.
- See Also:
-
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 theWAITING
state. Data for eachWAITING
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 theWAITING
status will be ignored.- Parameters:
updateQAppSessionRequest
-- Returns:
- Result of the UpdateQAppSession operation returned by the service.
- See Also:
-
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 theWAITING
state. Data for eachWAITING
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 theWAITING
status will be ignored.
This is a convenience which creates an instance of the
UpdateQAppSessionRequest.Builder
avoiding the need to create one manually viaUpdateQAppSessionRequest.builder()
- Parameters:
updateQAppSessionRequest
- AConsumer
that will call methods onUpdateQAppSessionRequest.Builder
to create a request.- Returns:
- Result of the UpdateQAppSession operation returned by the service.
- See Also:
-
updateQAppSessionMetadata
default UpdateQAppSessionMetadataResponse updateQAppSessionMetadata(UpdateQAppSessionMetadataRequest updateQAppSessionMetadataRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates the configuration metadata of a session for a given Q App
sessionId
.- Parameters:
updateQAppSessionMetadataRequest
-- Returns:
- Result of the UpdateQAppSessionMetadata operation returned by the service.
- See Also:
-
updateQAppSessionMetadata
default UpdateQAppSessionMetadataResponse updateQAppSessionMetadata(Consumer<UpdateQAppSessionMetadataRequest.Builder> updateQAppSessionMetadataRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, UnauthorizedException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, QAppsException Updates the configuration metadata of a session for a given Q App
sessionId
.
This is a convenience which creates an instance of the
UpdateQAppSessionMetadataRequest.Builder
avoiding the need to create one manually viaUpdateQAppSessionMetadataRequest.builder()
- Parameters:
updateQAppSessionMetadataRequest
- AConsumer
that will call methods onUpdateQAppSessionMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateQAppSessionMetadata operation returned by the service.
- See Also:
-
create
Create aQAppsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aQAppsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-