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 StringValue 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 AssociateQAppWithUserResponseassociateQAppWithUser(Consumer<AssociateQAppWithUserRequest.Builder> associateQAppWithUserRequest) This operation creates a link between the user's identity calling the operation and a specific Q App.default AssociateQAppWithUserResponseassociateQAppWithUser(AssociateQAppWithUserRequest associateQAppWithUserRequest) This operation creates a link between the user's identity calling the operation and a specific Q App.default BatchCreateCategoryResponsebatchCreateCategory(Consumer<BatchCreateCategoryRequest.Builder> batchCreateCategoryRequest) Creates Categories for the Amazon Q Business application environment instance.default BatchCreateCategoryResponsebatchCreateCategory(BatchCreateCategoryRequest batchCreateCategoryRequest) Creates Categories for the Amazon Q Business application environment instance.default BatchDeleteCategoryResponsebatchDeleteCategory(Consumer<BatchDeleteCategoryRequest.Builder> batchDeleteCategoryRequest) Deletes Categories for the Amazon Q Business application environment instance.default BatchDeleteCategoryResponsebatchDeleteCategory(BatchDeleteCategoryRequest batchDeleteCategoryRequest) Deletes Categories for the Amazon Q Business application environment instance.default BatchUpdateCategoryResponsebatchUpdateCategory(Consumer<BatchUpdateCategoryRequest.Builder> batchUpdateCategoryRequest) Updates Categories for the Amazon Q Business application environment instance.default BatchUpdateCategoryResponsebatchUpdateCategory(BatchUpdateCategoryRequest batchUpdateCategoryRequest) Updates Categories for the Amazon Q Business application environment instance.static QAppsClientBuilderbuilder()Create a builder that can be used to configure and create aQAppsClient.static QAppsClientcreate()Create aQAppsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateLibraryItemResponsecreateLibraryItem(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 CreateLibraryItemResponsecreateLibraryItem(CreateLibraryItemRequest createLibraryItemRequest) Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.default CreatePresignedUrlResponsecreatePresignedUrl(Consumer<CreatePresignedUrlRequest.Builder> createPresignedUrlRequest) Creates a presigned URL for an S3 POST operation to upload a file.default CreatePresignedUrlResponsecreatePresignedUrl(CreatePresignedUrlRequest createPresignedUrlRequest) Creates a presigned URL for an S3 POST operation to upload a file.default CreateQAppResponsecreateQApp(Consumer<CreateQAppRequest.Builder> createQAppRequest) Creates a new Amazon Q App based on the provided definition.default CreateQAppResponsecreateQApp(CreateQAppRequest createQAppRequest) Creates a new Amazon Q App based on the provided definition.default DeleteLibraryItemResponsedeleteLibraryItem(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 DeleteLibraryItemResponsedeleteLibraryItem(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 DeleteQAppResponsedeleteQApp(Consumer<DeleteQAppRequest.Builder> deleteQAppRequest) Deletes an Amazon Q App owned by the user.default DeleteQAppResponsedeleteQApp(DeleteQAppRequest deleteQAppRequest) Deletes an Amazon Q App owned by the user.default DescribeQAppPermissionsResponsedescribeQAppPermissions(Consumer<DescribeQAppPermissionsRequest.Builder> describeQAppPermissionsRequest) Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.default DescribeQAppPermissionsResponsedescribeQAppPermissions(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 DisassociateQAppFromUserResponsedisassociateQAppFromUser(Consumer<DisassociateQAppFromUserRequest.Builder> disassociateQAppFromUserRequest) Disassociates a Q App from a user removing the user's access to run the Q App.default DisassociateQAppFromUserResponsedisassociateQAppFromUser(DisassociateQAppFromUserRequest disassociateQAppFromUserRequest) Disassociates a Q App from a user removing the user's access to run the Q App.default ExportQAppSessionDataResponseexportQAppSessionData(Consumer<ExportQAppSessionDataRequest.Builder> exportQAppSessionDataRequest) Exports the collected data of a Q App data collection session.default ExportQAppSessionDataResponseexportQAppSessionData(ExportQAppSessionDataRequest exportQAppSessionDataRequest) Exports the collected data of a Q App data collection session.default GetLibraryItemResponsegetLibraryItem(Consumer<GetLibraryItemRequest.Builder> getLibraryItemRequest) Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.default GetLibraryItemResponsegetLibraryItem(GetLibraryItemRequest getLibraryItemRequest) Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.default GetQAppResponsegetQApp(Consumer<GetQAppRequest.Builder> getQAppRequest) Retrieves the full details of an Q App, including its definition specifying the cards and flow.default GetQAppResponsegetQApp(GetQAppRequest getQAppRequest) Retrieves the full details of an Q App, including its definition specifying the cards and flow.default GetQAppSessionResponsegetQAppSession(Consumer<GetQAppSessionRequest.Builder> getQAppSessionRequest) Retrieves the current state and results for an active session of an Amazon Q App.default GetQAppSessionResponsegetQAppSession(GetQAppSessionRequest getQAppSessionRequest) Retrieves the current state and results for an active session of an Amazon Q App.default GetQAppSessionMetadataResponsegetQAppSessionMetadata(Consumer<GetQAppSessionMetadataRequest.Builder> getQAppSessionMetadataRequest) Retrieves the current configuration of a Q App session.default GetQAppSessionMetadataResponsegetQAppSessionMetadata(GetQAppSessionMetadataRequest getQAppSessionMetadataRequest) Retrieves the current configuration of a Q App session.default ImportDocumentResponseimportDocument(Consumer<ImportDocumentRequest.Builder> importDocumentRequest) Uploads a file that can then be used either as a default in aFileUploadCardfrom Q App definition or as a file that is used inside a single Q App run.default ImportDocumentResponseimportDocument(ImportDocumentRequest importDocumentRequest) Uploads a file that can then be used either as a default in aFileUploadCardfrom Q App definition or as a file that is used inside a single Q App run.default ListCategoriesResponselistCategories(Consumer<ListCategoriesRequest.Builder> listCategoriesRequest) Lists the categories of a Amazon Q Business application environment instance.default ListCategoriesResponselistCategories(ListCategoriesRequest listCategoriesRequest) Lists the categories of a Amazon Q Business application environment instance.default ListLibraryItemsResponselistLibraryItems(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 ListLibraryItemsResponselistLibraryItems(ListLibraryItemsRequest listLibraryItemsRequest) Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.default ListLibraryItemsIterablelistLibraryItemsPaginator(Consumer<ListLibraryItemsRequest.Builder> listLibraryItemsRequest) This is a variant oflistLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest)operation.default ListLibraryItemsIterablelistLibraryItemsPaginator(ListLibraryItemsRequest listLibraryItemsRequest) This is a variant oflistLibraryItems(software.amazon.awssdk.services.qapps.model.ListLibraryItemsRequest)operation.default ListQAppsResponselistQApps(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 ListQAppsResponselistQApps(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 ListQAppSessionDataResponselistQAppSessionData(Consumer<ListQAppSessionDataRequest.Builder> listQAppSessionDataRequest) Lists the collected data of a Q App data collection session.default ListQAppSessionDataResponselistQAppSessionData(ListQAppSessionDataRequest listQAppSessionDataRequest) Lists the collected data of a Q App data collection session.default ListQAppsIterablelistQAppsPaginator(Consumer<ListQAppsRequest.Builder> listQAppsRequest) This is a variant oflistQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest)operation.default ListQAppsIterablelistQAppsPaginator(ListQAppsRequest listQAppsRequest) This is a variant oflistQApps(software.amazon.awssdk.services.qapps.model.ListQAppsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with an Amazon Q Apps resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with an Amazon Q Apps resource.default PredictQAppResponsepredictQApp(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 PredictQAppResponsepredictQApp(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 QAppsServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartQAppSessionResponsestartQAppSession(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 StartQAppSessionResponsestartQAppSession(StartQAppSessionRequest startQAppSessionRequest) Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.default StopQAppSessionResponsestopQAppSession(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 StopQAppSessionResponsestopQAppSession(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 TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates tags with an Amazon Q Apps resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Associates tags with an Amazon Q Apps resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Disassociates tags from an Amazon Q Apps resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Disassociates tags from an Amazon Q Apps resource.default UpdateLibraryItemResponseupdateLibraryItem(Consumer<UpdateLibraryItemRequest.Builder> updateLibraryItemRequest) Updates the library item for an Amazon Q App.default UpdateLibraryItemResponseupdateLibraryItem(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 UpdateQAppResponseupdateQApp(Consumer<UpdateQAppRequest.Builder> updateQAppRequest) Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.default UpdateQAppResponseupdateQApp(UpdateQAppRequest updateQAppRequest) Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.default UpdateQAppPermissionsResponseupdateQAppPermissions(Consumer<UpdateQAppPermissionsRequest.Builder> updateQAppPermissionsRequest) Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.default UpdateQAppPermissionsResponseupdateQAppPermissions(UpdateQAppPermissionsRequest updateQAppPermissionsRequest) Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.default UpdateQAppSessionResponseupdateQAppSession(Consumer<UpdateQAppSessionRequest.Builder> updateQAppSessionRequest) Updates the session for a given Q AppsessionId.default UpdateQAppSessionResponseupdateQAppSession(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
closeMethods 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.Builderavoiding the need to create one manually viaAssociateLibraryItemReviewRequest.builder()- Parameters:
associateLibraryItemReviewRequest- AConsumerthat will call methods onAssociateLibraryItemReviewRequest.Builderto 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.Builderavoiding the need to create one manually viaAssociateQAppWithUserRequest.builder()- Parameters:
associateQAppWithUserRequest- AConsumerthat will call methods onAssociateQAppWithUserRequest.Builderto 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.Builderavoiding the need to create one manually viaBatchCreateCategoryRequest.builder()- Parameters:
batchCreateCategoryRequest- AConsumerthat will call methods onBatchCreateCategoryRequest.Builderto 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.Builderavoiding the need to create one manually viaBatchDeleteCategoryRequest.builder()- Parameters:
batchDeleteCategoryRequest- AConsumerthat will call methods onBatchDeleteCategoryRequest.Builderto 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.Builderavoiding the need to create one manually viaBatchUpdateCategoryRequest.builder()- Parameters:
batchUpdateCategoryRequest- AConsumerthat will call methods onBatchUpdateCategoryRequest.Builderto 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.Builderavoiding the need to create one manually viaCreateLibraryItemRequest.builder()- Parameters:
createLibraryItemRequest- AConsumerthat will call methods onCreateLibraryItemRequest.Builderto 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
FileUploadCardin a Q App definition or to provide a file for a single Q App run. Thescopeparameter determines how the file will be used, either at the app definition level or the app session level.The IAM permissions are derived from the
qapps:ImportDocumentaction. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.- 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
FileUploadCardin a Q App definition or to provide a file for a single Q App run. Thescopeparameter determines how the file will be used, either at the app definition level or the app session level.The IAM permissions are derived from the
qapps:ImportDocumentaction. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.
This is a convenience which creates an instance of the
CreatePresignedUrlRequest.Builderavoiding the need to create one manually viaCreatePresignedUrlRequest.builder()- Parameters:
createPresignedUrlRequest- AConsumerthat will call methods onCreatePresignedUrlRequest.Builderto 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.Builderavoiding the need to create one manually viaCreateQAppRequest.builder()- Parameters:
createQAppRequest- AConsumerthat will call methods onCreateQAppRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteLibraryItemRequest.builder()- Parameters:
deleteLibraryItemRequest- AConsumerthat will call methods onDeleteLibraryItemRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteQAppRequest.builder()- Parameters:
deleteQAppRequest- AConsumerthat will call methods onDeleteQAppRequest.Builderto 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.Builderavoiding the need to create one manually viaDescribeQAppPermissionsRequest.builder()- Parameters:
describeQAppPermissionsRequest- AConsumerthat will call methods onDescribeQAppPermissionsRequest.Builderto 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.Builderavoiding the need to create one manually viaDisassociateLibraryItemReviewRequest.builder()- Parameters:
disassociateLibraryItemReviewRequest- AConsumerthat will call methods onDisassociateLibraryItemReviewRequest.Builderto 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.Builderavoiding the need to create one manually viaDisassociateQAppFromUserRequest.builder()- Parameters:
disassociateQAppFromUserRequest- AConsumerthat will call methods onDisassociateQAppFromUserRequest.Builderto 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.Builderavoiding the need to create one manually viaExportQAppSessionDataRequest.builder()- Parameters:
exportQAppSessionDataRequest- AConsumerthat will call methods onExportQAppSessionDataRequest.Builderto 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.Builderavoiding the need to create one manually viaGetLibraryItemRequest.builder()- Parameters:
getLibraryItemRequest- AConsumerthat will call methods onGetLibraryItemRequest.Builderto 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.Builderavoiding the need to create one manually viaGetQAppRequest.builder()- Parameters:
getQAppRequest- AConsumerthat will call methods onGetQAppRequest.Builderto 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.Builderavoiding the need to create one manually viaGetQAppSessionRequest.builder()- Parameters:
getQAppSessionRequest- AConsumerthat will call methods onGetQAppSessionRequest.Builderto 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.Builderavoiding the need to create one manually viaGetQAppSessionMetadataRequest.builder()- Parameters:
getQAppSessionMetadataRequest- AConsumerthat will call methods onGetQAppSessionMetadataRequest.Builderto 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
FileUploadCardfrom 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
FileUploadCardfrom 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.Builderavoiding the need to create one manually viaImportDocumentRequest.builder()- Parameters:
importDocumentRequest- AConsumerthat will call methods onImportDocumentRequest.Builderto 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.Builderavoiding the need to create one manually viaListCategoriesRequest.builder()- Parameters:
listCategoriesRequest- AConsumerthat will call methods onListCategoriesRequest.Builderto 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.Builderavoiding the need to create one manually viaListLibraryItemsRequest.builder()- Parameters:
listLibraryItemsRequest- AConsumerthat will call methods onListLibraryItemsRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListLibraryItemsRequest.builder()- Parameters:
listLibraryItemsRequest- AConsumerthat will call methods onListLibraryItemsRequest.Builderto 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.Builderavoiding the need to create one manually viaListQAppSessionDataRequest.builder()- Parameters:
listQAppSessionDataRequest- AConsumerthat will call methods onListQAppSessionDataRequest.Builderto 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.Builderavoiding the need to create one manually viaListQAppsRequest.builder()- Parameters:
listQAppsRequest- AConsumerthat will call methods onListQAppsRequest.Builderto 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 Stream
2) Using For loopsoftware.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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListQAppsRequest.builder()- Parameters:
listQAppsRequest- AConsumerthat will call methods onListQAppsRequest.Builderto 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaPredictQAppRequest.builder()- Parameters:
predictQAppRequest- AConsumerthat will call methods onPredictQAppRequest.Builderto 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.Builderavoiding the need to create one manually viaStartQAppSessionRequest.builder()- Parameters:
startQAppSessionRequest- AConsumerthat will call methods onStartQAppSessionRequest.Builderto 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.Builderavoiding the need to create one manually viaStopQAppSessionRequest.builder()- Parameters:
stopQAppSessionRequest- AConsumerthat will call methods onStopQAppSessionRequest.Builderto 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateLibraryItemRequest.builder()- Parameters:
updateLibraryItemRequest- AConsumerthat will call methods onUpdateLibraryItemRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateLibraryItemMetadataRequest.builder()- Parameters:
updateLibraryItemMetadataRequest- AConsumerthat will call methods onUpdateLibraryItemMetadataRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateQAppRequest.builder()- Parameters:
updateQAppRequest- AConsumerthat will call methods onUpdateQAppRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateQAppPermissionsRequest.builder()- Parameters:
updateQAppPermissionsRequest- AConsumerthat will call methods onUpdateQAppPermissionsRequest.Builderto 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 theWAITINGstate. Data for eachWAITINGcard 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 theWAITINGstatus 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 theWAITINGstate. Data for eachWAITINGcard 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 theWAITINGstatus will be ignored.
This is a convenience which creates an instance of the
UpdateQAppSessionRequest.Builderavoiding the need to create one manually viaUpdateQAppSessionRequest.builder()- Parameters:
updateQAppSessionRequest- AConsumerthat will call methods onUpdateQAppSessionRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateQAppSessionMetadataRequest.builder()- Parameters:
updateQAppSessionMetadataRequest- AConsumerthat will call methods onUpdateQAppSessionMetadataRequest.Builderto create a request.- Returns:
- Result of the UpdateQAppSessionMetadata operation returned by the service.
- See Also:
-
create
Create aQAppsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aQAppsClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-