Interface QBusinessAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface QBusinessAsyncClient extends AwsClient
Service client for accessing QBusiness asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

The following resources provide additional information about using the Amazon Q Business API:

  • Field Details

  • Method Details

    • associatePermission

      default CompletableFuture<AssociatePermissionResponse> associatePermission(AssociatePermissionRequest associatePermissionRequest)

      Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.

      Parameters:
      associatePermissionRequest -
      Returns:
      A Java Future containing the result of the AssociatePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associatePermission

      default CompletableFuture<AssociatePermissionResponse> associatePermission(Consumer<AssociatePermissionRequest.Builder> associatePermissionRequest)

      Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.


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

      Parameters:
      associatePermissionRequest - A Consumer that will call methods on AssociatePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociatePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeleteDocument

      default CompletableFuture<BatchDeleteDocumentResponse> batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)

      Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

      You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

      Parameters:
      batchDeleteDocumentRequest -
      Returns:
      A Java Future containing the result of the BatchDeleteDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeleteDocument

      default CompletableFuture<BatchDeleteDocumentResponse> batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)

      Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

      You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.


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

      Parameters:
      batchDeleteDocumentRequest - A Consumer that will call methods on BatchDeleteDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDeleteDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchPutDocument

      default CompletableFuture<BatchPutDocumentResponse> batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)

      Adds one or more documents to an Amazon Q Business index.

      You use this API to:

      • ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.

      • add custom attributes to documents in an Amazon Q Business index.

      • attach an access control list to the documents added to an Amazon Q Business index.

      You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

      Parameters:
      batchPutDocumentRequest -
      Returns:
      A Java Future containing the result of the BatchPutDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchPutDocument

      default CompletableFuture<BatchPutDocumentResponse> batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)

      Adds one or more documents to an Amazon Q Business index.

      You use this API to:

      • ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.

      • add custom attributes to documents in an Amazon Q Business index.

      • attach an access control list to the documents added to an Amazon Q Business index.

      You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.


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

      Parameters:
      batchPutDocumentRequest - A Consumer that will call methods on BatchPutDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchPutDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelSubscription

      default CompletableFuture<CancelSubscriptionResponse> cancelSubscription(CancelSubscriptionRequest cancelSubscriptionRequest)

      Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.

      Parameters:
      cancelSubscriptionRequest -
      Returns:
      A Java Future containing the result of the CancelSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelSubscription

      default CompletableFuture<CancelSubscriptionResponse> cancelSubscription(Consumer<CancelSubscriptionRequest.Builder> cancelSubscriptionRequest)

      Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.


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

      Parameters:
      cancelSubscriptionRequest - A Consumer that will call methods on CancelSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • chat

      default CompletableFuture<Void> chat(ChatRequest chatRequest, org.reactivestreams.Publisher<ChatInputStream> requestStream, ChatResponseHandler asyncResponseHandler)

      Starts or continues a streaming Amazon Q Business conversation.

      Parameters:
      chatRequest -
      Returns:
      A Java Future containing the result of the Chat operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ExternalResourceException An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • chat

      default CompletableFuture<Void> chat(Consumer<ChatRequest.Builder> chatRequest, org.reactivestreams.Publisher<ChatInputStream> requestStream, ChatResponseHandler asyncResponseHandler)

      Starts or continues a streaming Amazon Q Business conversation.


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

      Parameters:
      chatRequest - A Consumer that will call methods on ChatRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Chat operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ExternalResourceException An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • chatSync

      default CompletableFuture<ChatSyncResponse> chatSync(ChatSyncRequest chatSyncRequest)

      Starts or continues a non-streaming Amazon Q Business conversation.

      Parameters:
      chatSyncRequest -
      Returns:
      A Java Future containing the result of the ChatSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ExternalResourceException An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • chatSync

      default CompletableFuture<ChatSyncResponse> chatSync(Consumer<ChatSyncRequest.Builder> chatSyncRequest)

      Starts or continues a non-streaming Amazon Q Business conversation.


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

      Parameters:
      chatSyncRequest - A Consumer that will call methods on ChatSyncRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ChatSync operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ExternalResourceException An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • checkDocumentAccess

      default CompletableFuture<CheckDocumentAccessResponse> checkDocumentAccess(CheckDocumentAccessRequest checkDocumentAccessRequest)

      Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.

      Parameters:
      checkDocumentAccessRequest -
      Returns:
      A Java Future containing the result of the CheckDocumentAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • checkDocumentAccess

      default CompletableFuture<CheckDocumentAccessResponse> checkDocumentAccess(Consumer<CheckDocumentAccessRequest.Builder> checkDocumentAccessRequest)

      Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.


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

      Parameters:
      checkDocumentAccessRequest - A Consumer that will call methods on CheckDocumentAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CheckDocumentAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAnonymousWebExperienceUrl

      default CompletableFuture<CreateAnonymousWebExperienceUrlResponse> createAnonymousWebExperienceUrl(CreateAnonymousWebExperienceUrlRequest createAnonymousWebExperienceUrlRequest)

      Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.

      Parameters:
      createAnonymousWebExperienceUrlRequest -
      Returns:
      A Java Future containing the result of the CreateAnonymousWebExperienceUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAnonymousWebExperienceUrl

      default CompletableFuture<CreateAnonymousWebExperienceUrlResponse> createAnonymousWebExperienceUrl(Consumer<CreateAnonymousWebExperienceUrlRequest.Builder> createAnonymousWebExperienceUrlRequest)

      Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.


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

      Parameters:
      createAnonymousWebExperienceUrlRequest - A Consumer that will call methods on CreateAnonymousWebExperienceUrlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAnonymousWebExperienceUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)

      Creates an Amazon Q Business application.

      There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.

      An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

      When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.

      Parameters:
      createApplicationRequest -
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)

      Creates an Amazon Q Business application.

      There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.

      An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

      When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.


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

      Parameters:
      createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createChatResponseConfiguration

      default CompletableFuture<CreateChatResponseConfigurationResponse> createChatResponseConfiguration(CreateChatResponseConfigurationRequest createChatResponseConfigurationRequest)

      Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.

      Parameters:
      createChatResponseConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createChatResponseConfiguration

      default CompletableFuture<CreateChatResponseConfigurationResponse> createChatResponseConfiguration(Consumer<CreateChatResponseConfigurationRequest.Builder> createChatResponseConfigurationRequest)

      Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.


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

      Parameters:
      createChatResponseConfigurationRequest - A Consumer that will call methods on CreateChatResponseConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataAccessor

      default CompletableFuture<CreateDataAccessorResponse> createDataAccessor(CreateDataAccessorRequest createDataAccessorRequest)

      Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.

      Parameters:
      createDataAccessorRequest -
      Returns:
      A Java Future containing the result of the CreateDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataAccessor

      default CompletableFuture<CreateDataAccessorResponse> createDataAccessor(Consumer<CreateDataAccessorRequest.Builder> createDataAccessorRequest)

      Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.


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

      Parameters:
      createDataAccessorRequest - A Consumer that will call methods on CreateDataAccessorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataSource

      default CompletableFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest createDataSourceRequest)

      Creates a data source connector for an Amazon Q Business application.

      CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

      Parameters:
      createDataSourceRequest -
      Returns:
      A Java Future containing the result of the CreateDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataSource

      default CompletableFuture<CreateDataSourceResponse> createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)

      Creates a data source connector for an Amazon Q Business application.

      CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.


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

      Parameters:
      createDataSourceRequest - A Consumer that will call methods on CreateDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIndex

      default CompletableFuture<CreateIndexResponse> createIndex(CreateIndexRequest createIndexRequest)

      Creates an Amazon Q Business index.

      To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

      Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

      Parameters:
      createIndexRequest -
      Returns:
      A Java Future containing the result of the CreateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIndex

      default CompletableFuture<CreateIndexResponse> createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)

      Creates an Amazon Q Business index.

      To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

      Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.


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

      Parameters:
      createIndexRequest - A Consumer that will call methods on CreateIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPlugin

      default CompletableFuture<CreatePluginResponse> createPlugin(CreatePluginRequest createPluginRequest)

      Creates an Amazon Q Business plugin.

      Parameters:
      createPluginRequest -
      Returns:
      A Java Future containing the result of the CreatePlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPlugin

      default CompletableFuture<CreatePluginResponse> createPlugin(Consumer<CreatePluginRequest.Builder> createPluginRequest)

      Creates an Amazon Q Business plugin.


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

      Parameters:
      createPluginRequest - A Consumer that will call methods on CreatePluginRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRetriever

      default CompletableFuture<CreateRetrieverResponse> createRetriever(CreateRetrieverRequest createRetrieverRequest)

      Adds a retriever to your Amazon Q Business application.

      Parameters:
      createRetrieverRequest -
      Returns:
      A Java Future containing the result of the CreateRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRetriever

      default CompletableFuture<CreateRetrieverResponse> createRetriever(Consumer<CreateRetrieverRequest.Builder> createRetrieverRequest)

      Adds a retriever to your Amazon Q Business application.


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

      Parameters:
      createRetrieverRequest - A Consumer that will call methods on CreateRetrieverRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSubscription

      default CompletableFuture<CreateSubscriptionResponse> createSubscription(CreateSubscriptionRequest createSubscriptionRequest)

      Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

      Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

      Parameters:
      createSubscriptionRequest -
      Returns:
      A Java Future containing the result of the CreateSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSubscription

      default CompletableFuture<CreateSubscriptionResponse> createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)

      Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

      Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.


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

      Parameters:
      createSubscriptionRequest - A Consumer that will call methods on CreateSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)

      Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

      Parameters:
      createUserRequest -
      Returns:
      A Java Future containing the result of the CreateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)

      Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.


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

      Parameters:
      createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWebExperience

      default CompletableFuture<CreateWebExperienceResponse> createWebExperience(CreateWebExperienceRequest createWebExperienceRequest)

      Creates an Amazon Q Business web experience.

      Parameters:
      createWebExperienceRequest -
      Returns:
      A Java Future containing the result of the CreateWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWebExperience

      default CompletableFuture<CreateWebExperienceResponse> createWebExperience(Consumer<CreateWebExperienceRequest.Builder> createWebExperienceRequest)

      Creates an Amazon Q Business web experience.


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

      Parameters:
      createWebExperienceRequest - A Consumer that will call methods on CreateWebExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

      Deletes an Amazon Q Business application.

      Parameters:
      deleteApplicationRequest -
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)

      Deletes an Amazon Q Business application.


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

      Parameters:
      deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAttachment

      default CompletableFuture<DeleteAttachmentResponse> deleteAttachment(DeleteAttachmentRequest deleteAttachmentRequest)

      Deletes an attachment associated with a specific Amazon Q Business conversation.

      Parameters:
      deleteAttachmentRequest -
      Returns:
      A Java Future containing the result of the DeleteAttachment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAttachment

      default CompletableFuture<DeleteAttachmentResponse> deleteAttachment(Consumer<DeleteAttachmentRequest.Builder> deleteAttachmentRequest)

      Deletes an attachment associated with a specific Amazon Q Business conversation.


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

      Parameters:
      deleteAttachmentRequest - A Consumer that will call methods on DeleteAttachmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAttachment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteChatControlsConfiguration

      default CompletableFuture<DeleteChatControlsConfigurationResponse> deleteChatControlsConfiguration(DeleteChatControlsConfigurationRequest deleteChatControlsConfigurationRequest)

      Deletes chat controls configured for an existing Amazon Q Business application.

      Parameters:
      deleteChatControlsConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteChatControlsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteChatControlsConfiguration

      default CompletableFuture<DeleteChatControlsConfigurationResponse> deleteChatControlsConfiguration(Consumer<DeleteChatControlsConfigurationRequest.Builder> deleteChatControlsConfigurationRequest)

      Deletes chat controls configured for an existing Amazon Q Business application.


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

      Parameters:
      deleteChatControlsConfigurationRequest - A Consumer that will call methods on DeleteChatControlsConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteChatControlsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteChatResponseConfiguration

      default CompletableFuture<DeleteChatResponseConfigurationResponse> deleteChatResponseConfiguration(DeleteChatResponseConfigurationRequest deleteChatResponseConfigurationRequest)

      Deletes a specified chat response configuration from an Amazon Q Business application.

      Parameters:
      deleteChatResponseConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteChatResponseConfiguration

      default CompletableFuture<DeleteChatResponseConfigurationResponse> deleteChatResponseConfiguration(Consumer<DeleteChatResponseConfigurationRequest.Builder> deleteChatResponseConfigurationRequest)

      Deletes a specified chat response configuration from an Amazon Q Business application.


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

      Parameters:
      deleteChatResponseConfigurationRequest - A Consumer that will call methods on DeleteChatResponseConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConversation

      default CompletableFuture<DeleteConversationResponse> deleteConversation(DeleteConversationRequest deleteConversationRequest)

      Deletes an Amazon Q Business web experience conversation.

      Parameters:
      deleteConversationRequest -
      Returns:
      A Java Future containing the result of the DeleteConversation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConversation

      default CompletableFuture<DeleteConversationResponse> deleteConversation(Consumer<DeleteConversationRequest.Builder> deleteConversationRequest)

      Deletes an Amazon Q Business web experience conversation.


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

      Parameters:
      deleteConversationRequest - A Consumer that will call methods on DeleteConversationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConversation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataAccessor

      default CompletableFuture<DeleteDataAccessorResponse> deleteDataAccessor(DeleteDataAccessorRequest deleteDataAccessorRequest)

      Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.

      Parameters:
      deleteDataAccessorRequest -
      Returns:
      A Java Future containing the result of the DeleteDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataAccessor

      default CompletableFuture<DeleteDataAccessorResponse> deleteDataAccessor(Consumer<DeleteDataAccessorRequest.Builder> deleteDataAccessorRequest)

      Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.


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

      Parameters:
      deleteDataAccessorRequest - A Consumer that will call methods on DeleteDataAccessorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataSource

      default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

      Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

      Parameters:
      deleteDataSourceRequest -
      Returns:
      A Java Future containing the result of the DeleteDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataSource

      default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)

      Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.


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

      Parameters:
      deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)

      Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.

      If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.

      Parameters:
      deleteGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)

      Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.

      If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.


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

      Parameters:
      deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIndex

      default CompletableFuture<DeleteIndexResponse> deleteIndex(DeleteIndexRequest deleteIndexRequest)

      Deletes an Amazon Q Business index.

      Parameters:
      deleteIndexRequest -
      Returns:
      A Java Future containing the result of the DeleteIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIndex

      default CompletableFuture<DeleteIndexResponse> deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)

      Deletes an Amazon Q Business index.


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

      Parameters:
      deleteIndexRequest - A Consumer that will call methods on DeleteIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePlugin

      default CompletableFuture<DeletePluginResponse> deletePlugin(DeletePluginRequest deletePluginRequest)

      Deletes an Amazon Q Business plugin.

      Parameters:
      deletePluginRequest -
      Returns:
      A Java Future containing the result of the DeletePlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePlugin

      default CompletableFuture<DeletePluginResponse> deletePlugin(Consumer<DeletePluginRequest.Builder> deletePluginRequest)

      Deletes an Amazon Q Business plugin.


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

      Parameters:
      deletePluginRequest - A Consumer that will call methods on DeletePluginRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRetriever

      default CompletableFuture<DeleteRetrieverResponse> deleteRetriever(DeleteRetrieverRequest deleteRetrieverRequest)

      Deletes the retriever used by an Amazon Q Business application.

      Parameters:
      deleteRetrieverRequest -
      Returns:
      A Java Future containing the result of the DeleteRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRetriever

      default CompletableFuture<DeleteRetrieverResponse> deleteRetriever(Consumer<DeleteRetrieverRequest.Builder> deleteRetrieverRequest)

      Deletes the retriever used by an Amazon Q Business application.


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

      Parameters:
      deleteRetrieverRequest - A Consumer that will call methods on DeleteRetrieverRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

      Deletes a user by email id.

      Parameters:
      deleteUserRequest -
      Returns:
      A Java Future containing the result of the DeleteUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

      Deletes a user by email id.


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

      Parameters:
      deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWebExperience

      default CompletableFuture<DeleteWebExperienceResponse> deleteWebExperience(DeleteWebExperienceRequest deleteWebExperienceRequest)

      Deletes an Amazon Q Business web experience.

      Parameters:
      deleteWebExperienceRequest -
      Returns:
      A Java Future containing the result of the DeleteWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWebExperience

      default CompletableFuture<DeleteWebExperienceResponse> deleteWebExperience(Consumer<DeleteWebExperienceRequest.Builder> deleteWebExperienceRequest)

      Deletes an Amazon Q Business web experience.


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

      Parameters:
      deleteWebExperienceRequest - A Consumer that will call methods on DeleteWebExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePermission

      default CompletableFuture<DisassociatePermissionResponse> disassociatePermission(DisassociatePermissionRequest disassociatePermissionRequest)

      Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

      Parameters:
      disassociatePermissionRequest -
      Returns:
      A Java Future containing the result of the DisassociatePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePermission

      default CompletableFuture<DisassociatePermissionResponse> disassociatePermission(Consumer<DisassociatePermissionRequest.Builder> disassociatePermissionRequest)

      Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.


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

      Parameters:
      disassociatePermissionRequest - A Consumer that will call methods on DisassociatePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociatePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest)

      Gets information about an existing Amazon Q Business application.

      Parameters:
      getApplicationRequest -
      Returns:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)

      Gets information about an existing Amazon Q Business application.


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

      Parameters:
      getApplicationRequest - A Consumer that will call methods on GetApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChatControlsConfiguration

      default CompletableFuture<GetChatControlsConfigurationResponse> getChatControlsConfiguration(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)

      Gets information about chat controls configured for an existing Amazon Q Business application.

      Parameters:
      getChatControlsConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetChatControlsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChatControlsConfiguration

      default CompletableFuture<GetChatControlsConfigurationResponse> getChatControlsConfiguration(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest)

      Gets information about chat controls configured for an existing Amazon Q Business application.


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

      Parameters:
      getChatControlsConfigurationRequest - A Consumer that will call methods on GetChatControlsConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetChatControlsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChatControlsConfigurationPaginator

      default GetChatControlsConfigurationPublisher getChatControlsConfigurationPaginator(GetChatControlsConfigurationRequest getChatControlsConfigurationRequest)

      This is a variant of getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationPublisher publisher = client.getChatControlsConfigurationPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationPublisher publisher = client.getChatControlsConfigurationPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest) operation.

      Parameters:
      getChatControlsConfigurationRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChatControlsConfigurationPaginator

      default GetChatControlsConfigurationPublisher getChatControlsConfigurationPaginator(Consumer<GetChatControlsConfigurationRequest.Builder> getChatControlsConfigurationRequest)

      This is a variant of getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationPublisher publisher = client.getChatControlsConfigurationPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.GetChatControlsConfigurationPublisher publisher = client.getChatControlsConfigurationPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 getChatControlsConfiguration(software.amazon.awssdk.services.qbusiness.model.GetChatControlsConfigurationRequest) operation.


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

      Parameters:
      getChatControlsConfigurationRequest - A Consumer that will call methods on GetChatControlsConfigurationRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChatResponseConfiguration

      default CompletableFuture<GetChatResponseConfigurationResponse> getChatResponseConfiguration(GetChatResponseConfigurationRequest getChatResponseConfigurationRequest)

      Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

      Parameters:
      getChatResponseConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChatResponseConfiguration

      default CompletableFuture<GetChatResponseConfigurationResponse> getChatResponseConfiguration(Consumer<GetChatResponseConfigurationRequest.Builder> getChatResponseConfigurationRequest)

      Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.


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

      Parameters:
      getChatResponseConfigurationRequest - A Consumer that will call methods on GetChatResponseConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataAccessor

      default CompletableFuture<GetDataAccessorResponse> getDataAccessor(GetDataAccessorRequest getDataAccessorRequest)

      Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

      Parameters:
      getDataAccessorRequest -
      Returns:
      A Java Future containing the result of the GetDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataAccessor

      default CompletableFuture<GetDataAccessorResponse> getDataAccessor(Consumer<GetDataAccessorRequest.Builder> getDataAccessorRequest)

      Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.


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

      Parameters:
      getDataAccessorRequest - A Consumer that will call methods on GetDataAccessorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataSource

      default CompletableFuture<GetDataSourceResponse> getDataSource(GetDataSourceRequest getDataSourceRequest)

      Gets information about an existing Amazon Q Business data source connector.

      Parameters:
      getDataSourceRequest -
      Returns:
      A Java Future containing the result of the GetDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataSource

      default CompletableFuture<GetDataSourceResponse> getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest)

      Gets information about an existing Amazon Q Business data source connector.


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

      Parameters:
      getDataSourceRequest - A Consumer that will call methods on GetDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroup

      default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)

      Describes a group by group name.

      Parameters:
      getGroupRequest -
      Returns:
      A Java Future containing the result of the GetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroup

      default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)

      Describes a group by group name.


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

      Parameters:
      getGroupRequest - A Consumer that will call methods on GetGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIndex

      default CompletableFuture<GetIndexResponse> getIndex(GetIndexRequest getIndexRequest)

      Gets information about an existing Amazon Q Business index.

      Parameters:
      getIndexRequest -
      Returns:
      A Java Future containing the result of the GetIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIndex

      default CompletableFuture<GetIndexResponse> getIndex(Consumer<GetIndexRequest.Builder> getIndexRequest)

      Gets information about an existing Amazon Q Business index.


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

      Parameters:
      getIndexRequest - A Consumer that will call methods on GetIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMedia

      default CompletableFuture<GetMediaResponse> getMedia(GetMediaRequest getMediaRequest)

      Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses.

      For more information, see Extracting semantic meaning from images and visuals.

      Parameters:
      getMediaRequest -
      Returns:
      A Java Future containing the result of the GetMedia operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • MediaTooLargeException The requested media object is too large to be returned.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMedia

      default CompletableFuture<GetMediaResponse> getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest)

      Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses.

      For more information, see Extracting semantic meaning from images and visuals.


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

      Parameters:
      getMediaRequest - A Consumer that will call methods on GetMediaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMedia operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • MediaTooLargeException The requested media object is too large to be returned.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlugin

      default CompletableFuture<GetPluginResponse> getPlugin(GetPluginRequest getPluginRequest)

      Gets information about an existing Amazon Q Business plugin.

      Parameters:
      getPluginRequest -
      Returns:
      A Java Future containing the result of the GetPlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlugin

      default CompletableFuture<GetPluginResponse> getPlugin(Consumer<GetPluginRequest.Builder> getPluginRequest)

      Gets information about an existing Amazon Q Business plugin.


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

      Parameters:
      getPluginRequest - A Consumer that will call methods on GetPluginRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPolicy

      default CompletableFuture<GetPolicyResponse> getPolicy(GetPolicyRequest getPolicyRequest)

      Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

      Parameters:
      getPolicyRequest -
      Returns:
      A Java Future containing the result of the GetPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPolicy

      default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)

      Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.


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

      Parameters:
      getPolicyRequest - A Consumer that will call methods on GetPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRetriever

      default CompletableFuture<GetRetrieverResponse> getRetriever(GetRetrieverRequest getRetrieverRequest)

      Gets information about an existing retriever used by an Amazon Q Business application.

      Parameters:
      getRetrieverRequest -
      Returns:
      A Java Future containing the result of the GetRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRetriever

      default CompletableFuture<GetRetrieverResponse> getRetriever(Consumer<GetRetrieverRequest.Builder> getRetrieverRequest)

      Gets information about an existing retriever used by an Amazon Q Business application.


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

      Parameters:
      getRetrieverRequest - A Consumer that will call methods on GetRetrieverRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUser

      default CompletableFuture<GetUserResponse> getUser(GetUserRequest getUserRequest)

      Describes the universally unique identifier (UUID) associated with a local user in a data source.

      Parameters:
      getUserRequest -
      Returns:
      A Java Future containing the result of the GetUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUser

      default CompletableFuture<GetUserResponse> getUser(Consumer<GetUserRequest.Builder> getUserRequest)

      Describes the universally unique identifier (UUID) associated with a local user in a data source.


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

      Parameters:
      getUserRequest - A Consumer that will call methods on GetUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWebExperience

      default CompletableFuture<GetWebExperienceResponse> getWebExperience(GetWebExperienceRequest getWebExperienceRequest)

      Gets information about an existing Amazon Q Business web experience.

      Parameters:
      getWebExperienceRequest -
      Returns:
      A Java Future containing the result of the GetWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWebExperience

      default CompletableFuture<GetWebExperienceResponse> getWebExperience(Consumer<GetWebExperienceRequest.Builder> getWebExperienceRequest)

      Gets information about an existing Amazon Q Business web experience.


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

      Parameters:
      getWebExperienceRequest - A Consumer that will call methods on GetWebExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)

      Lists Amazon Q Business applications.

      Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

      Parameters:
      listApplicationsRequest -
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      Lists Amazon Q Business applications.

      Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.


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

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)

      This is a variant of listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest) operation.

      Parameters:
      listApplicationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      This is a variant of listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listApplications(software.amazon.awssdk.services.qbusiness.model.ListApplicationsRequest) operation.


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

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachments

      default CompletableFuture<ListAttachmentsResponse> listAttachments(ListAttachmentsRequest listAttachmentsRequest)

      Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.

      Parameters:
      listAttachmentsRequest -
      Returns:
      A Java Future containing the result of the ListAttachments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachments

      default CompletableFuture<ListAttachmentsResponse> listAttachments(Consumer<ListAttachmentsRequest.Builder> listAttachmentsRequest)

      Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.


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

      Parameters:
      listAttachmentsRequest - A Consumer that will call methods on ListAttachmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAttachments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachmentsPaginator

      default ListAttachmentsPublisher listAttachmentsPaginator(ListAttachmentsRequest listAttachmentsRequest)

      This is a variant of listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsPublisher publisher = client.listAttachmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsPublisher publisher = client.listAttachmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListAttachmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest) operation.

      Parameters:
      listAttachmentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachmentsPaginator

      default ListAttachmentsPublisher listAttachmentsPaginator(Consumer<ListAttachmentsRequest.Builder> listAttachmentsRequest)

      This is a variant of listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsPublisher publisher = client.listAttachmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListAttachmentsPublisher publisher = client.listAttachmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListAttachmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listAttachments(software.amazon.awssdk.services.qbusiness.model.ListAttachmentsRequest) operation.


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

      Parameters:
      listAttachmentsRequest - A Consumer that will call methods on ListAttachmentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChatResponseConfigurations

      default CompletableFuture<ListChatResponseConfigurationsResponse> listChatResponseConfigurations(ListChatResponseConfigurationsRequest listChatResponseConfigurationsRequest)

      Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.

      Parameters:
      listChatResponseConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListChatResponseConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChatResponseConfigurations

      default CompletableFuture<ListChatResponseConfigurationsResponse> listChatResponseConfigurations(Consumer<ListChatResponseConfigurationsRequest.Builder> listChatResponseConfigurationsRequest)

      Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.


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

      Parameters:
      listChatResponseConfigurationsRequest - A Consumer that will call methods on ListChatResponseConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListChatResponseConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChatResponseConfigurationsPaginator

      default ListChatResponseConfigurationsPublisher listChatResponseConfigurationsPaginator(ListChatResponseConfigurationsRequest listChatResponseConfigurationsRequest)

      This is a variant of listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsPublisher publisher = client.listChatResponseConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsPublisher publisher = client.listChatResponseConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest) operation.

      Parameters:
      listChatResponseConfigurationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listChatResponseConfigurationsPaginator

      default ListChatResponseConfigurationsPublisher listChatResponseConfigurationsPaginator(Consumer<ListChatResponseConfigurationsRequest.Builder> listChatResponseConfigurationsRequest)

      This is a variant of listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsPublisher publisher = client.listChatResponseConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListChatResponseConfigurationsPublisher publisher = client.listChatResponseConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listChatResponseConfigurations(software.amazon.awssdk.services.qbusiness.model.ListChatResponseConfigurationsRequest) operation.


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

      Parameters:
      listChatResponseConfigurationsRequest - A Consumer that will call methods on ListChatResponseConfigurationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConversations

      default CompletableFuture<ListConversationsResponse> listConversations(ListConversationsRequest listConversationsRequest)

      Lists one or more Amazon Q Business conversations.

      Parameters:
      listConversationsRequest -
      Returns:
      A Java Future containing the result of the ListConversations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConversations

      default CompletableFuture<ListConversationsResponse> listConversations(Consumer<ListConversationsRequest.Builder> listConversationsRequest)

      Lists one or more Amazon Q Business conversations.


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

      Parameters:
      listConversationsRequest - A Consumer that will call methods on ListConversationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListConversations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConversationsPaginator

      default ListConversationsPublisher listConversationsPaginator(ListConversationsRequest listConversationsRequest)

      This is a variant of listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListConversationsPublisher publisher = client.listConversationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListConversationsPublisher publisher = client.listConversationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListConversationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListConversationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest) operation.

      Parameters:
      listConversationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConversationsPaginator

      default ListConversationsPublisher listConversationsPaginator(Consumer<ListConversationsRequest.Builder> listConversationsRequest)

      This is a variant of listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListConversationsPublisher publisher = client.listConversationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListConversationsPublisher publisher = client.listConversationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListConversationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListConversationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listConversations(software.amazon.awssdk.services.qbusiness.model.ListConversationsRequest) operation.


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

      Parameters:
      listConversationsRequest - A Consumer that will call methods on ListConversationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataAccessors

      default CompletableFuture<ListDataAccessorsResponse> listDataAccessors(ListDataAccessorsRequest listDataAccessorsRequest)

      Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

      Parameters:
      listDataAccessorsRequest -
      Returns:
      A Java Future containing the result of the ListDataAccessors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataAccessors

      default CompletableFuture<ListDataAccessorsResponse> listDataAccessors(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest)

      Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.


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

      Parameters:
      listDataAccessorsRequest - A Consumer that will call methods on ListDataAccessorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDataAccessors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataAccessorsPaginator

      default ListDataAccessorsPublisher listDataAccessorsPaginator(ListDataAccessorsRequest listDataAccessorsRequest)

      This is a variant of listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsPublisher publisher = client.listDataAccessorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsPublisher publisher = client.listDataAccessorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest) operation.

      Parameters:
      listDataAccessorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataAccessorsPaginator

      default ListDataAccessorsPublisher listDataAccessorsPaginator(Consumer<ListDataAccessorsRequest.Builder> listDataAccessorsRequest)

      This is a variant of listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsPublisher publisher = client.listDataAccessorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataAccessorsPublisher publisher = client.listDataAccessorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDataAccessors(software.amazon.awssdk.services.qbusiness.model.ListDataAccessorsRequest) operation.


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

      Parameters:
      listDataAccessorsRequest - A Consumer that will call methods on ListDataAccessorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourceSyncJobs

      default CompletableFuture<ListDataSourceSyncJobsResponse> listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)

      Get information about an Amazon Q Business data source connector synchronization.

      Parameters:
      listDataSourceSyncJobsRequest -
      Returns:
      A Java Future containing the result of the ListDataSourceSyncJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourceSyncJobs

      default CompletableFuture<ListDataSourceSyncJobsResponse> listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)

      Get information about an Amazon Q Business data source connector synchronization.


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

      Parameters:
      listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDataSourceSyncJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourceSyncJobsPaginator

      default ListDataSourceSyncJobsPublisher listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)

      This is a variant of listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest) operation.

      Parameters:
      listDataSourceSyncJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourceSyncJobsPaginator

      default ListDataSourceSyncJobsPublisher listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)

      This is a variant of listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDataSourceSyncJobs(software.amazon.awssdk.services.qbusiness.model.ListDataSourceSyncJobsRequest) operation.


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

      Parameters:
      listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSources

      default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest)

      Lists the Amazon Q Business data source connectors that you have created.

      Parameters:
      listDataSourcesRequest -
      Returns:
      A Java Future containing the result of the ListDataSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSources

      default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)

      Lists the Amazon Q Business data source connectors that you have created.


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

      Parameters:
      listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDataSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourcesPaginator

      default ListDataSourcesPublisher listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)

      This is a variant of listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDataSourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest) operation.

      Parameters:
      listDataSourcesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourcesPaginator

      default ListDataSourcesPublisher listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)

      This is a variant of listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDataSourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDataSources(software.amazon.awssdk.services.qbusiness.model.ListDataSourcesRequest) operation.


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

      Parameters:
      listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocuments

      default CompletableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest listDocumentsRequest)

      A list of documents attached to an index.

      Parameters:
      listDocumentsRequest -
      Returns:
      A Java Future containing the result of the ListDocuments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocuments

      default CompletableFuture<ListDocumentsResponse> listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)

      A list of documents attached to an index.


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

      Parameters:
      listDocumentsRequest - A Consumer that will call methods on ListDocumentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDocuments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentsPaginator

      default ListDocumentsPublisher listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)

      This is a variant of listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDocumentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDocumentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest) operation.

      Parameters:
      listDocumentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDocumentsPaginator

      default ListDocumentsPublisher listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)

      This is a variant of listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListDocumentsPublisher publisher = client.listDocumentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListDocumentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListDocumentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listDocuments(software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest) operation.


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

      Parameters:
      listDocumentsRequest - A Consumer that will call methods on ListDocumentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroups

      default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)

      Provides a list of groups that are mapped to users.

      Parameters:
      listGroupsRequest -
      Returns:
      A Java Future containing the result of the ListGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroups

      default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

      Provides a list of groups that are mapped to users.


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

      Parameters:
      listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsPaginator

      default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)

      This is a variant of listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest) operation.

      Parameters:
      listGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsPaginator

      default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

      This is a variant of listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listGroups(software.amazon.awssdk.services.qbusiness.model.ListGroupsRequest) operation.


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

      Parameters:
      listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndices

      default CompletableFuture<ListIndicesResponse> listIndices(ListIndicesRequest listIndicesRequest)

      Lists the Amazon Q Business indices you have created.

      Parameters:
      listIndicesRequest -
      Returns:
      A Java Future containing the result of the ListIndices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndices

      default CompletableFuture<ListIndicesResponse> listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)

      Lists the Amazon Q Business indices you have created.


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

      Parameters:
      listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIndices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndicesPaginator

      default ListIndicesPublisher listIndicesPaginator(ListIndicesRequest listIndicesRequest)

      This is a variant of listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListIndicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListIndicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest) operation.

      Parameters:
      listIndicesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndicesPaginator

      default ListIndicesPublisher listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)

      This is a variant of listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListIndicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListIndicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listIndices(software.amazon.awssdk.services.qbusiness.model.ListIndicesRequest) operation.


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

      Parameters:
      listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessages

      default CompletableFuture<ListMessagesResponse> listMessages(ListMessagesRequest listMessagesRequest)

      Gets a list of messages associated with an Amazon Q Business web experience.

      Parameters:
      listMessagesRequest -
      Returns:
      A Java Future containing the result of the ListMessages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessages

      default CompletableFuture<ListMessagesResponse> listMessages(Consumer<ListMessagesRequest.Builder> listMessagesRequest)

      Gets a list of messages associated with an Amazon Q Business web experience.


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

      Parameters:
      listMessagesRequest - A Consumer that will call methods on ListMessagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMessages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessagesPaginator

      default ListMessagesPublisher listMessagesPaginator(ListMessagesRequest listMessagesRequest)

      This is a variant of listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListMessagesPublisher publisher = client.listMessagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListMessagesPublisher publisher = client.listMessagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListMessagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListMessagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest) operation.

      Parameters:
      listMessagesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessagesPaginator

      default ListMessagesPublisher listMessagesPaginator(Consumer<ListMessagesRequest.Builder> listMessagesRequest)

      This is a variant of listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListMessagesPublisher publisher = client.listMessagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListMessagesPublisher publisher = client.listMessagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListMessagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListMessagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listMessages(software.amazon.awssdk.services.qbusiness.model.ListMessagesRequest) operation.


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

      Parameters:
      listMessagesRequest - A Consumer that will call methods on ListMessagesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginActions

      default CompletableFuture<ListPluginActionsResponse> listPluginActions(ListPluginActionsRequest listPluginActionsRequest)

      Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

      Parameters:
      listPluginActionsRequest -
      Returns:
      A Java Future containing the result of the ListPluginActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginActions

      default CompletableFuture<ListPluginActionsResponse> listPluginActions(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest)

      Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.


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

      Parameters:
      listPluginActionsRequest - A Consumer that will call methods on ListPluginActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPluginActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginActionsPaginator

      default ListPluginActionsPublisher listPluginActionsPaginator(ListPluginActionsRequest listPluginActionsRequest)

      This is a variant of listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsPublisher publisher = client.listPluginActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsPublisher publisher = client.listPluginActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest) operation.

      Parameters:
      listPluginActionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginActionsPaginator

      default ListPluginActionsPublisher listPluginActionsPaginator(Consumer<ListPluginActionsRequest.Builder> listPluginActionsRequest)

      This is a variant of listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsPublisher publisher = client.listPluginActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginActionsPublisher publisher = client.listPluginActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPluginActions(software.amazon.awssdk.services.qbusiness.model.ListPluginActionsRequest) operation.


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

      Parameters:
      listPluginActionsRequest - A Consumer that will call methods on ListPluginActionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeActions

      default CompletableFuture<ListPluginTypeActionsResponse> listPluginTypeActions(ListPluginTypeActionsRequest listPluginTypeActionsRequest)

      Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

      Parameters:
      listPluginTypeActionsRequest -
      Returns:
      A Java Future containing the result of the ListPluginTypeActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeActions

      default CompletableFuture<ListPluginTypeActionsResponse> listPluginTypeActions(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest)

      Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.


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

      Parameters:
      listPluginTypeActionsRequest - A Consumer that will call methods on ListPluginTypeActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPluginTypeActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeActionsPaginator

      default ListPluginTypeActionsPublisher listPluginTypeActionsPaginator(ListPluginTypeActionsRequest listPluginTypeActionsRequest)

      This is a variant of listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsPublisher publisher = client.listPluginTypeActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsPublisher publisher = client.listPluginTypeActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest) operation.

      Parameters:
      listPluginTypeActionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeActionsPaginator

      default ListPluginTypeActionsPublisher listPluginTypeActionsPaginator(Consumer<ListPluginTypeActionsRequest.Builder> listPluginTypeActionsRequest)

      This is a variant of listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsPublisher publisher = client.listPluginTypeActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeActionsPublisher publisher = client.listPluginTypeActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPluginTypeActions(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeActionsRequest) operation.


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

      Parameters:
      listPluginTypeActionsRequest - A Consumer that will call methods on ListPluginTypeActionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeMetadata

      default CompletableFuture<ListPluginTypeMetadataResponse> listPluginTypeMetadata(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest)

      Lists metadata for all Amazon Q Business plugin types.

      Parameters:
      listPluginTypeMetadataRequest -
      Returns:
      A Java Future containing the result of the ListPluginTypeMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeMetadata

      default CompletableFuture<ListPluginTypeMetadataResponse> listPluginTypeMetadata(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest)

      Lists metadata for all Amazon Q Business plugin types.


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

      Parameters:
      listPluginTypeMetadataRequest - A Consumer that will call methods on ListPluginTypeMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPluginTypeMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeMetadataPaginator

      default ListPluginTypeMetadataPublisher listPluginTypeMetadataPaginator(ListPluginTypeMetadataRequest listPluginTypeMetadataRequest)

      This is a variant of listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataPublisher publisher = client.listPluginTypeMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataPublisher publisher = client.listPluginTypeMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest) operation.

      Parameters:
      listPluginTypeMetadataRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginTypeMetadataPaginator

      default ListPluginTypeMetadataPublisher listPluginTypeMetadataPaginator(Consumer<ListPluginTypeMetadataRequest.Builder> listPluginTypeMetadataRequest)

      This is a variant of listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataPublisher publisher = client.listPluginTypeMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginTypeMetadataPublisher publisher = client.listPluginTypeMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPluginTypeMetadata(software.amazon.awssdk.services.qbusiness.model.ListPluginTypeMetadataRequest) operation.


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

      Parameters:
      listPluginTypeMetadataRequest - A Consumer that will call methods on ListPluginTypeMetadataRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlugins

      default CompletableFuture<ListPluginsResponse> listPlugins(ListPluginsRequest listPluginsRequest)

      Lists configured Amazon Q Business plugins.

      Parameters:
      listPluginsRequest -
      Returns:
      A Java Future containing the result of the ListPlugins operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlugins

      default CompletableFuture<ListPluginsResponse> listPlugins(Consumer<ListPluginsRequest.Builder> listPluginsRequest)

      Lists configured Amazon Q Business plugins.


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

      Parameters:
      listPluginsRequest - A Consumer that will call methods on ListPluginsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPlugins operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginsPaginator

      default ListPluginsPublisher listPluginsPaginator(ListPluginsRequest listPluginsRequest)

      This is a variant of listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginsPublisher publisher = client.listPluginsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginsPublisher publisher = client.listPluginsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest) operation.

      Parameters:
      listPluginsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPluginsPaginator

      default ListPluginsPublisher listPluginsPaginator(Consumer<ListPluginsRequest.Builder> listPluginsRequest)

      This is a variant of listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginsPublisher publisher = client.listPluginsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListPluginsPublisher publisher = client.listPluginsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListPluginsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListPluginsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listPlugins(software.amazon.awssdk.services.qbusiness.model.ListPluginsRequest) operation.


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

      Parameters:
      listPluginsRequest - A Consumer that will call methods on ListPluginsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRetrievers

      default CompletableFuture<ListRetrieversResponse> listRetrievers(ListRetrieversRequest listRetrieversRequest)

      Lists the retriever used by an Amazon Q Business application.

      Parameters:
      listRetrieversRequest -
      Returns:
      A Java Future containing the result of the ListRetrievers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRetrievers

      default CompletableFuture<ListRetrieversResponse> listRetrievers(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest)

      Lists the retriever used by an Amazon Q Business application.


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

      Parameters:
      listRetrieversRequest - A Consumer that will call methods on ListRetrieversRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRetrievers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRetrieversPaginator

      default ListRetrieversPublisher listRetrieversPaginator(ListRetrieversRequest listRetrieversRequest)

      This is a variant of listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListRetrieversPublisher publisher = client.listRetrieversPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListRetrieversPublisher publisher = client.listRetrieversPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListRetrieversResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListRetrieversResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest) operation.

      Parameters:
      listRetrieversRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRetrieversPaginator

      default ListRetrieversPublisher listRetrieversPaginator(Consumer<ListRetrieversRequest.Builder> listRetrieversRequest)

      This is a variant of listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListRetrieversPublisher publisher = client.listRetrieversPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListRetrieversPublisher publisher = client.listRetrieversPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListRetrieversResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListRetrieversResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listRetrievers(software.amazon.awssdk.services.qbusiness.model.ListRetrieversRequest) operation.


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

      Parameters:
      listRetrieversRequest - A Consumer that will call methods on ListRetrieversRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptions

      default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)

      Lists all subscriptions created in an Amazon Q Business application.

      Parameters:
      listSubscriptionsRequest -
      Returns:
      A Java Future containing the result of the ListSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptions

      default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)

      Lists all subscriptions created in an Amazon Q Business application.


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

      Parameters:
      listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptionsPaginator

      default ListSubscriptionsPublisher listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)

      This is a variant of listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest) operation.

      Parameters:
      listSubscriptionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptionsPaginator

      default ListSubscriptionsPublisher listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)

      This is a variant of listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listSubscriptions(software.amazon.awssdk.services.qbusiness.model.ListSubscriptionsRequest) operation.


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

      Parameters:
      listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWebExperiences

      default CompletableFuture<ListWebExperiencesResponse> listWebExperiences(ListWebExperiencesRequest listWebExperiencesRequest)

      Lists one or more Amazon Q Business Web Experiences.

      Parameters:
      listWebExperiencesRequest -
      Returns:
      A Java Future containing the result of the ListWebExperiences operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWebExperiences

      default CompletableFuture<ListWebExperiencesResponse> listWebExperiences(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest)

      Lists one or more Amazon Q Business Web Experiences.


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

      Parameters:
      listWebExperiencesRequest - A Consumer that will call methods on ListWebExperiencesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWebExperiences operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWebExperiencesPaginator

      default ListWebExperiencesPublisher listWebExperiencesPaginator(ListWebExperiencesRequest listWebExperiencesRequest)

      This is a variant of listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesPublisher publisher = client.listWebExperiencesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesPublisher publisher = client.listWebExperiencesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest) operation.

      Parameters:
      listWebExperiencesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWebExperiencesPaginator

      default ListWebExperiencesPublisher listWebExperiencesPaginator(Consumer<ListWebExperiencesRequest.Builder> listWebExperiencesRequest)

      This is a variant of listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesPublisher publisher = client.listWebExperiencesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.ListWebExperiencesPublisher publisher = client.listWebExperiencesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 listWebExperiences(software.amazon.awssdk.services.qbusiness.model.ListWebExperiencesRequest) operation.


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

      Parameters:
      listWebExperiencesRequest - A Consumer that will call methods on ListWebExperiencesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFeedback

      default CompletableFuture<PutFeedbackResponse> putFeedback(PutFeedbackRequest putFeedbackRequest)

      Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

      Parameters:
      putFeedbackRequest -
      Returns:
      A Java Future containing the result of the PutFeedback operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFeedback

      default CompletableFuture<PutFeedbackResponse> putFeedback(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest)

      Enables your end user to provide feedback on their Amazon Q Business generated chat responses.


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

      Parameters:
      putFeedbackRequest - A Consumer that will call methods on PutFeedbackRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutFeedback operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putGroup

      default CompletableFuture<PutGroupResponse> putGroup(PutGroupRequest putGroupRequest)

      Create, or updates, a mapping of users—who have access to a document—to groups.

      You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

      There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.

      Parameters:
      putGroupRequest -
      Returns:
      A Java Future containing the result of the PutGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putGroup

      default CompletableFuture<PutGroupResponse> putGroup(Consumer<PutGroupRequest.Builder> putGroupRequest)

      Create, or updates, a mapping of users—who have access to a document—to groups.

      You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

      There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.


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

      Parameters:
      putGroupRequest - A Consumer that will call methods on PutGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRelevantContent

      default CompletableFuture<SearchRelevantContentResponse> searchRelevantContent(SearchRelevantContentRequest searchRelevantContentRequest)

      Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

      Parameters:
      searchRelevantContentRequest -
      Returns:
      A Java Future containing the result of the SearchRelevantContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRelevantContent

      default CompletableFuture<SearchRelevantContentResponse> searchRelevantContent(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest)

      Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.


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

      Parameters:
      searchRelevantContentRequest - A Consumer that will call methods on SearchRelevantContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchRelevantContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRelevantContentPaginator

      default SearchRelevantContentPublisher searchRelevantContentPaginator(SearchRelevantContentRequest searchRelevantContentRequest)

      This is a variant of searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentPublisher publisher = client.searchRelevantContentPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentPublisher publisher = client.searchRelevantContentPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest) operation.

      Parameters:
      searchRelevantContentRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRelevantContentPaginator

      default SearchRelevantContentPublisher searchRelevantContentPaginator(Consumer<SearchRelevantContentRequest.Builder> searchRelevantContentRequest)

      This is a variant of searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentPublisher publisher = client.searchRelevantContentPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.qbusiness.paginators.SearchRelevantContentPublisher publisher = client.searchRelevantContentPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults 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 searchRelevantContent(software.amazon.awssdk.services.qbusiness.model.SearchRelevantContentRequest) operation.


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

      Parameters:
      searchRelevantContentRequest - A Consumer that will call methods on SearchRelevantContentRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDataSourceSyncJob

      default CompletableFuture<StartDataSourceSyncJobResponse> startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)

      Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

      Parameters:
      startDataSourceSyncJobRequest -
      Returns:
      A Java Future containing the result of the StartDataSourceSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDataSourceSyncJob

      default CompletableFuture<StartDataSourceSyncJobResponse> startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)

      Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.


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

      Parameters:
      startDataSourceSyncJobRequest - A Consumer that will call methods on StartDataSourceSyncJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartDataSourceSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopDataSourceSyncJob

      default CompletableFuture<StopDataSourceSyncJobResponse> stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)

      Stops an Amazon Q Business data source connector synchronization job already in progress.

      Parameters:
      stopDataSourceSyncJobRequest -
      Returns:
      A Java Future containing the result of the StopDataSourceSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopDataSourceSyncJob

      default CompletableFuture<StopDataSourceSyncJobResponse> stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)

      Stops an Amazon Q Business data source connector synchronization job already in progress.


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

      Parameters:
      stopDataSourceSyncJobRequest - A Consumer that will call methods on StopDataSourceSyncJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopDataSourceSyncJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag from an Amazon Q Business application or a data source.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes a tag from an Amazon Q Business application or a data source.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplication

      default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)

      Updates an existing Amazon Q Business application.

      Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

      An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

      Parameters:
      updateApplicationRequest -
      Returns:
      A Java Future containing the result of the UpdateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplication

      default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)

      Updates an existing Amazon Q Business application.

      Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

      An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.


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

      Parameters:
      updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateChatControlsConfiguration

      default CompletableFuture<UpdateChatControlsConfigurationResponse> updateChatControlsConfiguration(UpdateChatControlsConfigurationRequest updateChatControlsConfigurationRequest)

      Updates a set of chat controls configured for an existing Amazon Q Business application.

      Parameters:
      updateChatControlsConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateChatControlsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateChatControlsConfiguration

      default CompletableFuture<UpdateChatControlsConfigurationResponse> updateChatControlsConfiguration(Consumer<UpdateChatControlsConfigurationRequest.Builder> updateChatControlsConfigurationRequest)

      Updates a set of chat controls configured for an existing Amazon Q Business application.


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

      Parameters:
      updateChatControlsConfigurationRequest - A Consumer that will call methods on UpdateChatControlsConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateChatControlsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateChatResponseConfiguration

      default CompletableFuture<UpdateChatResponseConfigurationResponse> updateChatResponseConfiguration(UpdateChatResponseConfigurationRequest updateChatResponseConfigurationRequest)

      Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.

      Parameters:
      updateChatResponseConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateChatResponseConfiguration

      default CompletableFuture<UpdateChatResponseConfigurationResponse> updateChatResponseConfiguration(Consumer<UpdateChatResponseConfigurationRequest.Builder> updateChatResponseConfigurationRequest)

      Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.


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

      Parameters:
      updateChatResponseConfigurationRequest - A Consumer that will call methods on UpdateChatResponseConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateChatResponseConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataAccessor

      default CompletableFuture<UpdateDataAccessorResponse> updateDataAccessor(UpdateDataAccessorRequest updateDataAccessorRequest)

      Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

      Parameters:
      updateDataAccessorRequest -
      Returns:
      A Java Future containing the result of the UpdateDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataAccessor

      default CompletableFuture<UpdateDataAccessorResponse> updateDataAccessor(Consumer<UpdateDataAccessorRequest.Builder> updateDataAccessorRequest)

      Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.


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

      Parameters:
      updateDataAccessorRequest - A Consumer that will call methods on UpdateDataAccessorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDataAccessor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataSource

      default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

      Updates an existing Amazon Q Business data source connector.

      Parameters:
      updateDataSourceRequest -
      Returns:
      A Java Future containing the result of the UpdateDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataSource

      default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)

      Updates an existing Amazon Q Business data source connector.


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

      Parameters:
      updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDataSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIndex

      default CompletableFuture<UpdateIndexResponse> updateIndex(UpdateIndexRequest updateIndexRequest)

      Updates an Amazon Q Business index.

      Parameters:
      updateIndexRequest -
      Returns:
      A Java Future containing the result of the UpdateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIndex

      default CompletableFuture<UpdateIndexResponse> updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)

      Updates an Amazon Q Business index.


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

      Parameters:
      updateIndexRequest - A Consumer that will call methods on UpdateIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlugin

      default CompletableFuture<UpdatePluginResponse> updatePlugin(UpdatePluginRequest updatePluginRequest)

      Updates an Amazon Q Business plugin.

      Parameters:
      updatePluginRequest -
      Returns:
      A Java Future containing the result of the UpdatePlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlugin

      default CompletableFuture<UpdatePluginResponse> updatePlugin(Consumer<UpdatePluginRequest.Builder> updatePluginRequest)

      Updates an Amazon Q Business plugin.


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

      Parameters:
      updatePluginRequest - A Consumer that will call methods on UpdatePluginRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePlugin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRetriever

      default CompletableFuture<UpdateRetrieverResponse> updateRetriever(UpdateRetrieverRequest updateRetrieverRequest)

      Updates the retriever used for your Amazon Q Business application.

      Parameters:
      updateRetrieverRequest -
      Returns:
      A Java Future containing the result of the UpdateRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRetriever

      default CompletableFuture<UpdateRetrieverResponse> updateRetriever(Consumer<UpdateRetrieverRequest.Builder> updateRetrieverRequest)

      Updates the retriever used for your Amazon Q Business application.


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

      Parameters:
      updateRetrieverRequest - A Consumer that will call methods on UpdateRetrieverRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRetriever operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSubscription

      default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest)

      Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

      Parameters:
      updateSubscriptionRequest -
      Returns:
      A Java Future containing the result of the UpdateSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSubscription

      default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest)

      Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.


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

      Parameters:
      updateSubscriptionRequest - A Consumer that will call methods on UpdateSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUser

      default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)

      Updates a information associated with a user id.

      Parameters:
      updateUserRequest -
      Returns:
      A Java Future containing the result of the UpdateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUser

      default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)

      Updates a information associated with a user id.


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

      Parameters:
      updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWebExperience

      default CompletableFuture<UpdateWebExperienceResponse> updateWebExperience(UpdateWebExperienceRequest updateWebExperienceRequest)

      Updates an Amazon Q Business web experience.

      Parameters:
      updateWebExperienceRequest -
      Returns:
      A Java Future containing the result of the UpdateWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWebExperience

      default CompletableFuture<UpdateWebExperienceResponse> updateWebExperience(Consumer<UpdateWebExperienceRequest.Builder> updateWebExperienceRequest)

      Updates an Amazon Q Business web experience.


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

      Parameters:
      updateWebExperienceRequest - A Consumer that will call methods on UpdateWebExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWebExperience operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
      • ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
      • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
      • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
      • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
      • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QBusinessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default QBusinessServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static QBusinessAsyncClient create()
      Create a QBusinessAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static QBusinessAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a QBusinessAsyncClient.