Interface KendraAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface KendraAsyncClient extends AwsClient
Service client for accessing kendra 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.

Amazon Kendra is a service for indexing large document sets.

  • Field Details

  • Method Details

    • associateEntitiesToExperience

      default CompletableFuture<AssociateEntitiesToExperienceResponse> associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)

      Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      associateEntitiesToExperienceRequest -
      Returns:
      A Java Future containing the result of the AssociateEntitiesToExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateEntitiesToExperience

      default CompletableFuture<AssociateEntitiesToExperienceResponse> associateEntitiesToExperience(Consumer<AssociateEntitiesToExperienceRequest.Builder> associateEntitiesToExperienceRequest)

      Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      associateEntitiesToExperienceRequest - A Consumer that will call methods on AssociateEntitiesToExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateEntitiesToExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associatePersonasToEntities

      default CompletableFuture<AssociatePersonasToEntitiesResponse> associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest)

      Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      associatePersonasToEntitiesRequest -
      Returns:
      A Java Future containing the result of the AssociatePersonasToEntities 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associatePersonasToEntities

      default CompletableFuture<AssociatePersonasToEntitiesResponse> associatePersonasToEntities(Consumer<AssociatePersonasToEntitiesRequest.Builder> associatePersonasToEntitiesRequest)

      Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      associatePersonasToEntitiesRequest - A Consumer that will call methods on AssociatePersonasToEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociatePersonasToEntities 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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)

      Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

      The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.

      Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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)

      Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

      The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.

      Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeleteFeaturedResultsSet

      default CompletableFuture<BatchDeleteFeaturedResultsSetResponse> batchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest)

      Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

      Parameters:
      batchDeleteFeaturedResultsSetRequest -
      Returns:
      A Java Future containing the result of the BatchDeleteFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeleteFeaturedResultsSet

      default CompletableFuture<BatchDeleteFeaturedResultsSetResponse> batchDeleteFeaturedResultsSet(Consumer<BatchDeleteFeaturedResultsSetRequest.Builder> batchDeleteFeaturedResultsSetRequest)

      Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.


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

      Parameters:
      batchDeleteFeaturedResultsSetRequest - A Consumer that will call methods on BatchDeleteFeaturedResultsSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDeleteFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetDocumentStatus

      default CompletableFuture<BatchGetDocumentStatusResponse> batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)

      Returns the indexing status for one or more documents submitted with the BatchPutDocument API.

      When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

      You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

      Parameters:
      batchGetDocumentStatusRequest -
      Returns:
      A Java Future containing the result of the BatchGetDocumentStatus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetDocumentStatus

      default CompletableFuture<BatchGetDocumentStatusResponse> batchGetDocumentStatus(Consumer<BatchGetDocumentStatusRequest.Builder> batchGetDocumentStatusRequest)

      Returns the indexing status for one or more documents submitted with the BatchPutDocument API.

      When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

      You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.


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

      Parameters:
      batchGetDocumentStatusRequest - A Consumer that will call methods on BatchGetDocumentStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetDocumentStatus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 index.

      The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

      The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your documents.

      For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 index.

      The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

      The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your documents.

      For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • clearQuerySuggestions

      default CompletableFuture<ClearQuerySuggestionsResponse> clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)

      Clears existing query suggestions from an index.

      This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

      ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      clearQuerySuggestionsRequest -
      Returns:
      A Java Future containing the result of the ClearQuerySuggestions 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • clearQuerySuggestions

      default CompletableFuture<ClearQuerySuggestionsResponse> clearQuerySuggestions(Consumer<ClearQuerySuggestionsRequest.Builder> clearQuerySuggestionsRequest)

      Clears existing query suggestions from an index.

      This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

      ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      clearQuerySuggestionsRequest - A Consumer that will call methods on ClearQuerySuggestionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ClearQuerySuggestions 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessControlConfiguration

      default CompletableFuture<CreateAccessControlConfigurationResponse> createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)

      Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.

      To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

      You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.

      Parameters:
      createAccessControlConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateAccessControlConfiguration 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.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessControlConfiguration

      default CompletableFuture<CreateAccessControlConfigurationResponse> createAccessControlConfiguration(Consumer<CreateAccessControlConfigurationRequest.Builder> createAccessControlConfigurationRequest)

      Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.

      To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

      You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.


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

      Parameters:
      createAccessControlConfigurationRequest - A Consumer that will call methods on CreateAccessControlConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessControlConfiguration 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.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 that you want to use with an Amazon Kendra index.

      You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

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

      For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 that you want to use with an Amazon Kendra index.

      You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

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

      For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createExperience

      default CompletableFuture<CreateExperienceResponse> createExperience(CreateExperienceRequest createExperienceRequest)

      Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.

      Parameters:
      createExperienceRequest -
      Returns:
      A Java Future containing the result of the CreateExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createExperience

      default CompletableFuture<CreateExperienceResponse> createExperience(Consumer<CreateExperienceRequest.Builder> createExperienceRequest)

      Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.


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

      Parameters:
      createExperienceRequest - A Consumer that will call methods on CreateExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFaq

      default CompletableFuture<CreateFaqResponse> createFaq(CreateFaqRequest createFaqRequest)

      Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.

      Adding FAQs to an index is an asynchronous operation.

      For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.

      Parameters:
      createFaqRequest -
      Returns:
      A Java Future containing the result of the CreateFaq 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFaq

      default CompletableFuture<CreateFaqResponse> createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)

      Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.

      Adding FAQs to an index is an asynchronous operation.

      For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.


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

      Parameters:
      createFaqRequest - A Consumer that will call methods on CreateFaqRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFaq 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFeaturedResultsSet

      default CompletableFuture<CreateFeaturedResultsSetResponse> createFeaturedResultsSet(CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest)

      Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.

      You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.

      Parameters:
      createFeaturedResultsSetRequest -
      Returns:
      A Java Future containing the result of the CreateFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • FeaturedResultsConflictException An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFeaturedResultsSet

      default CompletableFuture<CreateFeaturedResultsSetResponse> createFeaturedResultsSet(Consumer<CreateFeaturedResultsSetRequest.Builder> createFeaturedResultsSetRequest)

      Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.

      You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.


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

      Parameters:
      createFeaturedResultsSetRequest - A Consumer that will call methods on CreateFeaturedResultsSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • FeaturedResultsConflictException An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra index. Index creation is an asynchronous API. 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 using one of the supported data sources.

      For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra index. Index creation is an asynchronous API. 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 using one of the supported data sources.

      For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuerySuggestionsBlockList

      default CompletableFuture<CreateQuerySuggestionsBlockListResponse> createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)

      Creates a block list to exlcude certain queries from suggestions.

      Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

      You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

      For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

      CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.

      Parameters:
      createQuerySuggestionsBlockListRequest -
      Returns:
      A Java Future containing the result of the CreateQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuerySuggestionsBlockList

      default CompletableFuture<CreateQuerySuggestionsBlockListResponse> createQuerySuggestionsBlockList(Consumer<CreateQuerySuggestionsBlockListRequest.Builder> createQuerySuggestionsBlockListRequest)

      Creates a block list to exlcude certain queries from suggestions.

      Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

      You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

      For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

      CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.


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

      Parameters:
      createQuerySuggestionsBlockListRequest - A Consumer that will call methods on CreateQuerySuggestionsBlockListRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createThesaurus

      default CompletableFuture<CreateThesaurusResponse> createThesaurus(CreateThesaurusRequest createThesaurusRequest)

      Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

      For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.

      Parameters:
      createThesaurusRequest -
      Returns:
      A Java Future containing the result of the CreateThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createThesaurus

      default CompletableFuture<CreateThesaurusResponse> createThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest)

      Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

      For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.


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

      Parameters:
      createThesaurusRequest - A Consumer that will call methods on CreateThesaurusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessControlConfiguration

      default CompletableFuture<DeleteAccessControlConfigurationResponse> deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)

      Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      Parameters:
      deleteAccessControlConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteAccessControlConfiguration 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessControlConfiguration

      default CompletableFuture<DeleteAccessControlConfigurationResponse> deleteAccessControlConfiguration(Consumer<DeleteAccessControlConfigurationRequest.Builder> deleteAccessControlConfigurationRequest)

      Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.


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

      Parameters:
      deleteAccessControlConfigurationRequest - A Consumer that will call methods on DeleteAccessControlConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessControlConfiguration 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.

      Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.

      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.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.

      Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.


      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.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteExperience

      default CompletableFuture<DeleteExperienceResponse> deleteExperience(DeleteExperienceRequest deleteExperienceRequest)

      Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      deleteExperienceRequest -
      Returns:
      A Java Future containing the result of the DeleteExperience 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.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteExperience

      default CompletableFuture<DeleteExperienceResponse> deleteExperience(Consumer<DeleteExperienceRequest.Builder> deleteExperienceRequest)

      Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      deleteExperienceRequest - A Consumer that will call methods on DeleteExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteExperience 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.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFaq

      default CompletableFuture<DeleteFaqResponse> deleteFaq(DeleteFaqRequest deleteFaqRequest)

      Removes a FAQ from an index.

      Parameters:
      deleteFaqRequest -
      Returns:
      A Java Future containing the result of the DeleteFaq 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFaq

      default CompletableFuture<DeleteFaqResponse> deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)

      Removes a FAQ from an index.


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

      Parameters:
      deleteFaqRequest - A Consumer that will call methods on DeleteFaqRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFaq 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePrincipalMapping

      default CompletableFuture<DeletePrincipalMappingResponse> deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)

      Deletes a group so that all users 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 search results.

      If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping 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 PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

      DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      deletePrincipalMappingRequest -
      Returns:
      A Java Future containing the result of the DeletePrincipalMapping 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePrincipalMapping

      default CompletableFuture<DeletePrincipalMappingResponse> deletePrincipalMapping(Consumer<DeletePrincipalMappingRequest.Builder> deletePrincipalMappingRequest)

      Deletes a group so that all users 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 search results.

      If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping 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 PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

      DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      deletePrincipalMappingRequest - A Consumer that will call methods on DeletePrincipalMappingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePrincipalMapping 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQuerySuggestionsBlockList

      default CompletableFuture<DeleteQuerySuggestionsBlockListResponse> deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)

      Deletes a block list used for query suggestions for an index.

      A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

      DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      deleteQuerySuggestionsBlockListRequest -
      Returns:
      A Java Future containing the result of the DeleteQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQuerySuggestionsBlockList

      default CompletableFuture<DeleteQuerySuggestionsBlockListResponse> deleteQuerySuggestionsBlockList(Consumer<DeleteQuerySuggestionsBlockListRequest.Builder> deleteQuerySuggestionsBlockListRequest)

      Deletes a block list used for query suggestions for an index.

      A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

      DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      deleteQuerySuggestionsBlockListRequest - A Consumer that will call methods on DeleteQuerySuggestionsBlockListRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteThesaurus

      default CompletableFuture<DeleteThesaurusResponse> deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)

      Deletes an Amazon Kendra thesaurus.

      Parameters:
      deleteThesaurusRequest -
      Returns:
      A Java Future containing the result of the DeleteThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteThesaurus

      default CompletableFuture<DeleteThesaurusResponse> deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest)

      Deletes an Amazon Kendra thesaurus.


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

      Parameters:
      deleteThesaurusRequest - A Consumer that will call methods on DeleteThesaurusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessControlConfiguration

      default CompletableFuture<DescribeAccessControlConfigurationResponse> describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)

      Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      Parameters:
      describeAccessControlConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeAccessControlConfiguration 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessControlConfiguration

      default CompletableFuture<DescribeAccessControlConfigurationResponse> describeAccessControlConfiguration(Consumer<DescribeAccessControlConfigurationRequest.Builder> describeAccessControlConfigurationRequest)

      Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.


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

      Parameters:
      describeAccessControlConfigurationRequest - A Consumer that will call methods on DescribeAccessControlConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccessControlConfiguration 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataSource

      default CompletableFuture<DescribeDataSourceResponse> describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)

      Gets information about an Amazon Kendra data source connector.

      Parameters:
      describeDataSourceRequest -
      Returns:
      A Java Future containing the result of the DescribeDataSource 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataSource

      default CompletableFuture<DescribeDataSourceResponse> describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)

      Gets information about an Amazon Kendra data source connector.


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

      Parameters:
      describeDataSourceRequest - A Consumer that will call methods on DescribeDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDataSource 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExperience

      default CompletableFuture<DescribeExperienceResponse> describeExperience(DescribeExperienceRequest describeExperienceRequest)

      Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      describeExperienceRequest -
      Returns:
      A Java Future containing the result of the DescribeExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExperience

      default CompletableFuture<DescribeExperienceResponse> describeExperience(Consumer<DescribeExperienceRequest.Builder> describeExperienceRequest)

      Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      describeExperienceRequest - A Consumer that will call methods on DescribeExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFaq

      default CompletableFuture<DescribeFaqResponse> describeFaq(DescribeFaqRequest describeFaqRequest)

      Gets information about a FAQ.

      Parameters:
      describeFaqRequest -
      Returns:
      A Java Future containing the result of the DescribeFaq 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFaq

      default CompletableFuture<DescribeFaqResponse> describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)

      Gets information about a FAQ.


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

      Parameters:
      describeFaqRequest - A Consumer that will call methods on DescribeFaqRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFaq 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFeaturedResultsSet

      default CompletableFuture<DescribeFeaturedResultsSetResponse> describeFeaturedResultsSet(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest)

      Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

      Parameters:
      describeFeaturedResultsSetRequest -
      Returns:
      A Java Future containing the result of the DescribeFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFeaturedResultsSet

      default CompletableFuture<DescribeFeaturedResultsSetResponse> describeFeaturedResultsSet(Consumer<DescribeFeaturedResultsSetRequest.Builder> describeFeaturedResultsSetRequest)

      Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.


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

      Parameters:
      describeFeaturedResultsSetRequest - A Consumer that will call methods on DescribeFeaturedResultsSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIndex

      default CompletableFuture<DescribeIndexResponse> describeIndex(DescribeIndexRequest describeIndexRequest)

      Gets information about an Amazon Kendra index.

      Parameters:
      describeIndexRequest -
      Returns:
      A Java Future containing the result of the DescribeIndex 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeIndex

      default CompletableFuture<DescribeIndexResponse> describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)

      Gets information about an Amazon Kendra index.


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

      Parameters:
      describeIndexRequest - A Consumer that will call methods on DescribeIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeIndex 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePrincipalMapping

      default CompletableFuture<DescribePrincipalMappingResponse> describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)

      Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

      DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      describePrincipalMappingRequest -
      Returns:
      A Java Future containing the result of the DescribePrincipalMapping 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePrincipalMapping

      default CompletableFuture<DescribePrincipalMappingResponse> describePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest)

      Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

      DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      describePrincipalMappingRequest - A Consumer that will call methods on DescribePrincipalMappingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePrincipalMapping 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQuerySuggestionsBlockList

      default CompletableFuture<DescribeQuerySuggestionsBlockListResponse> describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)

      Gets information about a block list used for query suggestions for an index.

      This is used to check the current settings that are applied to a block list.

      DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      describeQuerySuggestionsBlockListRequest -
      Returns:
      A Java Future containing the result of the DescribeQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQuerySuggestionsBlockList

      default CompletableFuture<DescribeQuerySuggestionsBlockListResponse> describeQuerySuggestionsBlockList(Consumer<DescribeQuerySuggestionsBlockListRequest.Builder> describeQuerySuggestionsBlockListRequest)

      Gets information about a block list used for query suggestions for an index.

      This is used to check the current settings that are applied to a block list.

      DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      describeQuerySuggestionsBlockListRequest - A Consumer that will call methods on DescribeQuerySuggestionsBlockListRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQuerySuggestionsConfig

      default CompletableFuture<DescribeQuerySuggestionsConfigResponse> describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)

      Gets information on the settings of query suggestions for an index.

      This is used to check the current settings applied to query suggestions.

      DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      describeQuerySuggestionsConfigRequest -
      Returns:
      A Java Future containing the result of the DescribeQuerySuggestionsConfig 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQuerySuggestionsConfig

      default CompletableFuture<DescribeQuerySuggestionsConfigResponse> describeQuerySuggestionsConfig(Consumer<DescribeQuerySuggestionsConfigRequest.Builder> describeQuerySuggestionsConfigRequest)

      Gets information on the settings of query suggestions for an index.

      This is used to check the current settings applied to query suggestions.

      DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      describeQuerySuggestionsConfigRequest - A Consumer that will call methods on DescribeQuerySuggestionsConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeQuerySuggestionsConfig 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeThesaurus

      default CompletableFuture<DescribeThesaurusResponse> describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)

      Gets information about an Amazon Kendra thesaurus.

      Parameters:
      describeThesaurusRequest -
      Returns:
      A Java Future containing the result of the DescribeThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeThesaurus

      default CompletableFuture<DescribeThesaurusResponse> describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest)

      Gets information about an Amazon Kendra thesaurus.


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

      Parameters:
      describeThesaurusRequest - A Consumer that will call methods on DescribeThesaurusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateEntitiesFromExperience

      default CompletableFuture<DisassociateEntitiesFromExperienceResponse> disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)

      Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      disassociateEntitiesFromExperienceRequest -
      Returns:
      A Java Future containing the result of the DisassociateEntitiesFromExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateEntitiesFromExperience

      default CompletableFuture<DisassociateEntitiesFromExperienceResponse> disassociateEntitiesFromExperience(Consumer<DisassociateEntitiesFromExperienceRequest.Builder> disassociateEntitiesFromExperienceRequest)

      Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      disassociateEntitiesFromExperienceRequest - A Consumer that will call methods on DisassociateEntitiesFromExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateEntitiesFromExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePersonasFromEntities

      default CompletableFuture<DisassociatePersonasFromEntitiesResponse> disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest)

      Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      disassociatePersonasFromEntitiesRequest -
      Returns:
      A Java Future containing the result of the DisassociatePersonasFromEntities 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePersonasFromEntities

      default CompletableFuture<DisassociatePersonasFromEntitiesResponse> disassociatePersonasFromEntities(Consumer<DisassociatePersonasFromEntitiesRequest.Builder> disassociatePersonasFromEntitiesRequest)

      Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      disassociatePersonasFromEntitiesRequest - A Consumer that will call methods on DisassociatePersonasFromEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociatePersonasFromEntities 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQuerySuggestions

      default CompletableFuture<GetQuerySuggestionsResponse> getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)

      Fetches the queries that are suggested to your users.

      GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      getQuerySuggestionsRequest -
      Returns:
      A Java Future containing the result of the GetQuerySuggestions 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQuerySuggestions

      default CompletableFuture<GetQuerySuggestionsResponse> getQuerySuggestions(Consumer<GetQuerySuggestionsRequest.Builder> getQuerySuggestionsRequest)

      Fetches the queries that are suggested to your users.

      GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      getQuerySuggestionsRequest - A Consumer that will call methods on GetQuerySuggestionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQuerySuggestions 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSnapshots

      default CompletableFuture<GetSnapshotsResponse> getSnapshots(GetSnapshotsRequest getSnapshotsRequest)

      Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

      Parameters:
      getSnapshotsRequest -
      Returns:
      A Java Future containing the result of the GetSnapshots 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.
      • InvalidRequestException The input to the request is not valid. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSnapshots

      default CompletableFuture<GetSnapshotsResponse> getSnapshots(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)

      Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.


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

      Parameters:
      getSnapshotsRequest - A Consumer that will call methods on GetSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSnapshots 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.
      • InvalidRequestException The input to the request is not valid. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSnapshotsPaginator

      default GetSnapshotsPublisher getSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest)

      This is a variant of getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) 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.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse 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 getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) operation.

      Parameters:
      getSnapshotsRequest -
      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.
      • InvalidRequestException The input to the request is not valid. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSnapshotsPaginator

      default GetSnapshotsPublisher getSnapshotsPaginator(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)

      This is a variant of getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) 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.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse 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 getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) operation.


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

      Parameters:
      getSnapshotsRequest - A Consumer that will call methods on GetSnapshotsRequest.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.
      • InvalidRequestException The input to the request is not valid. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessControlConfigurations

      default CompletableFuture<ListAccessControlConfigurationsResponse> listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)

      Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      Parameters:
      listAccessControlConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListAccessControlConfigurations 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessControlConfigurations

      default CompletableFuture<ListAccessControlConfigurationsResponse> listAccessControlConfigurations(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)

      Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.


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

      Parameters:
      listAccessControlConfigurationsRequest - A Consumer that will call methods on ListAccessControlConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessControlConfigurations 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessControlConfigurationsPaginator

      default ListAccessControlConfigurationsPublisher listAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)

      This is a variant of listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest) 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.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse 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 listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest) operation.

      Parameters:
      listAccessControlConfigurationsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessControlConfigurationsPaginator

      default ListAccessControlConfigurationsPublisher listAccessControlConfigurationsPaginator(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)

      This is a variant of listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest) 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.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse 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 listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest) operation.


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

      Parameters:
      listAccessControlConfigurationsRequest - A Consumer that will call methods on ListAccessControlConfigurationsRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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)

      Gets statistics about synchronizing a data source connector.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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)

      Gets statistics about synchronizing a data source connector.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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.kendra.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.kendra.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.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.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.kendra.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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.kendra.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.kendra.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.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.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.kendra.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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.kendra.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.kendra.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.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.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.kendra.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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.kendra.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.kendra.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.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.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.kendra.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityPersonas

      default CompletableFuture<ListEntityPersonasResponse> listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)

      Lists specific permissions of users and groups with access to your Amazon Kendra experience.

      Parameters:
      listEntityPersonasRequest -
      Returns:
      A Java Future containing the result of the ListEntityPersonas 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityPersonas

      default CompletableFuture<ListEntityPersonasResponse> listEntityPersonas(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)

      Lists specific permissions of users and groups with access to your Amazon Kendra experience.


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

      Parameters:
      listEntityPersonasRequest - A Consumer that will call methods on ListEntityPersonasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEntityPersonas 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityPersonasPaginator

      default ListEntityPersonasPublisher listEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest)

      This is a variant of listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) 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.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse 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 listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) operation.

      Parameters:
      listEntityPersonasRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEntityPersonasPaginator

      default ListEntityPersonasPublisher listEntityPersonasPaginator(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)

      This is a variant of listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) 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.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse 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 listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) operation.


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

      Parameters:
      listEntityPersonasRequest - A Consumer that will call methods on ListEntityPersonasRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperienceEntities

      default CompletableFuture<ListExperienceEntitiesResponse> listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)

      Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      listExperienceEntitiesRequest -
      Returns:
      A Java Future containing the result of the ListExperienceEntities 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperienceEntities

      default CompletableFuture<ListExperienceEntitiesResponse> listExperienceEntities(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)

      Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      listExperienceEntitiesRequest - A Consumer that will call methods on ListExperienceEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExperienceEntities 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperienceEntitiesPaginator

      default ListExperienceEntitiesPublisher listExperienceEntitiesPaginator(ListExperienceEntitiesRequest listExperienceEntitiesRequest)

      This is a variant of listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest) 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.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse 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 null 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 listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest) operation.

      Parameters:
      listExperienceEntitiesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperienceEntitiesPaginator

      default ListExperienceEntitiesPublisher listExperienceEntitiesPaginator(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)

      This is a variant of listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest) 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.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse 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 null 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 listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest) operation.


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

      Parameters:
      listExperienceEntitiesRequest - A Consumer that will call methods on ListExperienceEntitiesRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperiences

      default CompletableFuture<ListExperiencesResponse> listExperiences(ListExperiencesRequest listExperiencesRequest)

      Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      listExperiencesRequest -
      Returns:
      A Java Future containing the result of the ListExperiences 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperiences

      default CompletableFuture<ListExperiencesResponse> listExperiences(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)

      Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      listExperiencesRequest - A Consumer that will call methods on ListExperiencesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExperiences 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperiencesPaginator

      default ListExperiencesPublisher listExperiencesPaginator(ListExperiencesRequest listExperiencesRequest)

      This is a variant of listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) 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.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperiencesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListExperiencesResponse 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 listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation.

      Parameters:
      listExperiencesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperiencesPaginator

      default ListExperiencesPublisher listExperiencesPaginator(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)

      This is a variant of listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) 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.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperiencesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListExperiencesResponse 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 listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation.


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

      Parameters:
      listExperiencesRequest - A Consumer that will call methods on ListExperiencesRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFaqs

      default CompletableFuture<ListFaqsResponse> listFaqs(ListFaqsRequest listFaqsRequest)

      Gets a list of FAQs associated with an index.

      Parameters:
      listFaqsRequest -
      Returns:
      A Java Future containing the result of the ListFaqs 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFaqs

      default CompletableFuture<ListFaqsResponse> listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)

      Gets a list of FAQs associated with an index.


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

      Parameters:
      listFaqsRequest - A Consumer that will call methods on ListFaqsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFaqs 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFaqsPaginator

      default ListFaqsPublisher listFaqsPaginator(ListFaqsRequest listFaqsRequest)

      This is a variant of listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) 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.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListFaqsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListFaqsResponse 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 listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.

      Parameters:
      listFaqsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFaqsPaginator

      default ListFaqsPublisher listFaqsPaginator(Consumer<ListFaqsRequest.Builder> listFaqsRequest)

      This is a variant of listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) 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.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListFaqsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListFaqsResponse 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 listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.


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

      Parameters:
      listFaqsRequest - A Consumer that will call methods on ListFaqsRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFeaturedResultsSets

      default CompletableFuture<ListFeaturedResultsSetsResponse> listFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest)

      Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

      Parameters:
      listFeaturedResultsSetsRequest -
      Returns:
      A Java Future containing the result of the ListFeaturedResultsSets 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFeaturedResultsSets

      default CompletableFuture<ListFeaturedResultsSetsResponse> listFeaturedResultsSets(Consumer<ListFeaturedResultsSetsRequest.Builder> listFeaturedResultsSetsRequest)

      Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.


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

      Parameters:
      listFeaturedResultsSetsRequest - A Consumer that will call methods on ListFeaturedResultsSetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFeaturedResultsSets 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsOlderThanOrderingId

      default CompletableFuture<ListGroupsOlderThanOrderingIdResponse> listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)

      Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

      ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      listGroupsOlderThanOrderingIdRequest -
      Returns:
      A Java Future containing the result of the ListGroupsOlderThanOrderingId 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsOlderThanOrderingId

      default CompletableFuture<ListGroupsOlderThanOrderingIdResponse> listGroupsOlderThanOrderingId(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)

      Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

      ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      listGroupsOlderThanOrderingIdRequest - A Consumer that will call methods on ListGroupsOlderThanOrderingIdRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroupsOlderThanOrderingId 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsOlderThanOrderingIdPaginator

      default ListGroupsOlderThanOrderingIdPublisher listGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)

      This is a variant of listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest) 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.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse 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 listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest) operation.

      Parameters:
      listGroupsOlderThanOrderingIdRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsOlderThanOrderingIdPaginator

      default ListGroupsOlderThanOrderingIdPublisher listGroupsOlderThanOrderingIdPaginator(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)

      This is a variant of listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest) 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.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse 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 listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest) operation.


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

      Parameters:
      listGroupsOlderThanOrderingIdRequest - A Consumer that will call methods on ListGroupsOlderThanOrderingIdRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra indexes that you 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra indexes that you 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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.kendra.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.kendra.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.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListIndicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.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.kendra.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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.kendra.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.kendra.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.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListIndicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.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.kendra.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuerySuggestionsBlockLists

      default CompletableFuture<ListQuerySuggestionsBlockListsResponse> listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)

      Lists the block lists used for query suggestions for an index.

      For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

      ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      listQuerySuggestionsBlockListsRequest -
      Returns:
      A Java Future containing the result of the ListQuerySuggestionsBlockLists 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuerySuggestionsBlockLists

      default CompletableFuture<ListQuerySuggestionsBlockListsResponse> listQuerySuggestionsBlockLists(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)

      Lists the block lists used for query suggestions for an index.

      For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

      ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      listQuerySuggestionsBlockListsRequest - A Consumer that will call methods on ListQuerySuggestionsBlockListsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQuerySuggestionsBlockLists 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuerySuggestionsBlockListsPaginator

      default ListQuerySuggestionsBlockListsPublisher listQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)

      This is a variant of listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest) 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.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse 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 listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest) operation.

      Parameters:
      listQuerySuggestionsBlockListsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuerySuggestionsBlockListsPaginator

      default ListQuerySuggestionsBlockListsPublisher listQuerySuggestionsBlockListsPaginator(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)

      This is a variant of listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest) 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.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse 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 listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest) operation.


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

      Parameters:
      listQuerySuggestionsBlockListsRequest - A Consumer that will call methods on ListQuerySuggestionsBlockListsRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 resource. Indexes, FAQs, data sources, and other resources 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 resource. Indexes, FAQs, data sources, and other resources 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThesauri

      default CompletableFuture<ListThesauriResponse> listThesauri(ListThesauriRequest listThesauriRequest)

      Lists the thesauri for an index.

      Parameters:
      listThesauriRequest -
      Returns:
      A Java Future containing the result of the ListThesauri 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThesauri

      default CompletableFuture<ListThesauriResponse> listThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest)

      Lists the thesauri for an index.


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

      Parameters:
      listThesauriRequest - A Consumer that will call methods on ListThesauriRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListThesauri 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThesauriPaginator

      default ListThesauriPublisher listThesauriPaginator(ListThesauriRequest listThesauriRequest)

      This is a variant of listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) 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.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListThesauriResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListThesauriResponse 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 listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) operation.

      Parameters:
      listThesauriRequest -
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listThesauriPaginator

      default ListThesauriPublisher listThesauriPaginator(Consumer<ListThesauriRequest.Builder> listThesauriRequest)

      This is a variant of listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) 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.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListThesauriResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.kendra.model.ListThesauriResponse 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 listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) operation.


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

      Parameters:
      listThesauriRequest - A Consumer that will call methods on ListThesauriRequest.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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPrincipalMapping

      default CompletableFuture<PutPrincipalMappingResponse> putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)

      Maps users to their groups so that you only need to provide the user ID when you issue the query.

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

      This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.

      If more than five PUT actions for a group are currently processing, a validation exception is thrown.

      Parameters:
      putPrincipalMappingRequest -
      Returns:
      A Java Future containing the result of the PutPrincipalMapping 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPrincipalMapping

      default CompletableFuture<PutPrincipalMappingResponse> putPrincipalMapping(Consumer<PutPrincipalMappingRequest.Builder> putPrincipalMappingRequest)

      Maps users to their groups so that you only need to provide the user ID when you issue the query.

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

      This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.

      If more than five PUT actions for a group are currently processing, a validation exception is thrown.


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

      Parameters:
      putPrincipalMappingRequest - A Consumer that will call methods on PutPrincipalMappingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutPrincipalMapping 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • query

      default CompletableFuture<QueryResponse> query(QueryRequest queryRequest)

      Searches an index given an input query.

      If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length.

      You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.

      A query response contains three types of results.

      • Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.

      • Matching FAQs or questions-answer from your FAQ file.

      • Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.

      You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

      Parameters:
      queryRequest -
      Returns:
      A Java Future containing the result of the Query 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • query

      default CompletableFuture<QueryResponse> query(Consumer<QueryRequest.Builder> queryRequest)

      Searches an index given an input query.

      If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length.

      You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.

      A query response contains three types of results.

      • Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.

      • Matching FAQs or questions-answer from your FAQ file.

      • Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.

      You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.


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

      Parameters:
      queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Query 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retrieve

      default CompletableFuture<RetrieveResponse> retrieve(RetrieveRequest retrieveRequest)

      Retrieves relevant passages or text excerpts given an input query.

      This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses.

      You can also do the following:

      • Override boosting at the index level

      • Filter based on document fields or attributes

      • Filter based on the user or their group access to documents

      • View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

        Confidence score buckets are currently available only for English.

      You can also include certain fields in the response that might provide useful additional information.

      The Retrieve API shares the number of query capacity units that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

      Parameters:
      retrieveRequest -
      Returns:
      A Java Future containing the result of the Retrieve 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retrieve

      default CompletableFuture<RetrieveResponse> retrieve(Consumer<RetrieveRequest.Builder> retrieveRequest)

      Retrieves relevant passages or text excerpts given an input query.

      This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses.

      You can also do the following:

      • Override boosting at the index level

      • Filter based on document fields or attributes

      • Filter based on the user or their group access to documents

      • View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

        Confidence score buckets are currently available only for English.

      You can also include certain fields in the response that might provide useful additional information.

      The Retrieve API shares the number of query capacity units that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.


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

      Parameters:
      retrieveRequest - A Consumer that will call methods on RetrieveRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Retrieve 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

      Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceInUseException The resource you want to use is currently in use. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

      Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ResourceInUseException The resource you want to use is currently in use. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 a synchronization job that is currently running. You can't stop a scheduled synchronization job.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 a synchronization job that is currently running. You can't stop a scheduled synchronization job.


      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitFeedback

      default CompletableFuture<SubmitFeedbackResponse> submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)

      Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

      SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      submitFeedbackRequest -
      Returns:
      A Java Future containing the result of the SubmitFeedback 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitFeedback

      default CompletableFuture<SubmitFeedbackResponse> submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)

      Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

      SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      submitFeedbackRequest - A Consumer that will call methods on SubmitFeedbackRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SubmitFeedback 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 index, FAQ, data source, or other 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 index, FAQ, data source, or other 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 index, FAQ, data source, or other resource.

      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 index, FAQ, data source, or other resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessControlConfiguration

      default CompletableFuture<UpdateAccessControlConfigurationResponse> updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)

      Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.

      You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

      You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.

      Parameters:
      updateAccessControlConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateAccessControlConfiguration 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessControlConfiguration

      default CompletableFuture<UpdateAccessControlConfigurationResponse> updateAccessControlConfiguration(Consumer<UpdateAccessControlConfigurationRequest.Builder> updateAccessControlConfigurationRequest)

      Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.

      You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

      You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.


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

      Parameters:
      updateAccessControlConfigurationRequest - A Consumer that will call methods on UpdateAccessControlConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccessControlConfiguration 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Amazon Kendra 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Amazon Kendra 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateExperience

      default CompletableFuture<UpdateExperienceResponse> updateExperience(UpdateExperienceRequest updateExperienceRequest)

      Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

      Parameters:
      updateExperienceRequest -
      Returns:
      A Java Future containing the result of the UpdateExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateExperience

      default CompletableFuture<UpdateExperienceResponse> updateExperience(Consumer<UpdateExperienceRequest.Builder> updateExperienceRequest)

      Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.


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

      Parameters:
      updateExperienceRequest - A Consumer that will call methods on UpdateExperienceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateExperience 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFeaturedResultsSet

      default CompletableFuture<UpdateFeaturedResultsSetResponse> updateFeaturedResultsSet(UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest)

      Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.

      Parameters:
      updateFeaturedResultsSetRequest -
      Returns:
      A Java Future containing the result of the UpdateFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • FeaturedResultsConflictException An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFeaturedResultsSet

      default CompletableFuture<UpdateFeaturedResultsSetResponse> updateFeaturedResultsSet(Consumer<UpdateFeaturedResultsSetRequest.Builder> updateFeaturedResultsSetRequest)

      Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.


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

      Parameters:
      updateFeaturedResultsSetRequest - A Consumer that will call methods on UpdateFeaturedResultsSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFeaturedResultsSet 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.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • FeaturedResultsConflictException An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException 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 Kendra 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuerySuggestionsBlockList

      default CompletableFuture<UpdateQuerySuggestionsBlockListResponse> updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)

      Updates a block list used for query suggestions for an index.

      Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

      If a block list is updating, then you need to wait for the first update to finish before submitting another update.

      Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

      UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      updateQuerySuggestionsBlockListRequest -
      Returns:
      A Java Future containing the result of the UpdateQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuerySuggestionsBlockList

      default CompletableFuture<UpdateQuerySuggestionsBlockListResponse> updateQuerySuggestionsBlockList(Consumer<UpdateQuerySuggestionsBlockListRequest.Builder> updateQuerySuggestionsBlockListRequest)

      Updates a block list used for query suggestions for an index.

      Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

      If a block list is updating, then you need to wait for the first update to finish before submitting another update.

      Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

      UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      updateQuerySuggestionsBlockListRequest - A Consumer that will call methods on UpdateQuerySuggestionsBlockListRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQuerySuggestionsBlockList 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuerySuggestionsConfig

      default CompletableFuture<UpdateQuerySuggestionsConfigResponse> updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)

      Updates the settings of query suggestions for an index.

      Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

      If an update is currently processing, you need to wait for the update to finish before making another update.

      Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

      You can still enable/disable query suggestions at any time.

      UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

      Parameters:
      updateQuerySuggestionsConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateQuerySuggestionsConfig 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuerySuggestionsConfig

      default CompletableFuture<UpdateQuerySuggestionsConfigResponse> updateQuerySuggestionsConfig(Consumer<UpdateQuerySuggestionsConfigRequest.Builder> updateQuerySuggestionsConfigRequest)

      Updates the settings of query suggestions for an index.

      Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

      If an update is currently processing, you need to wait for the update to finish before making another update.

      Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

      You can still enable/disable query suggestions at any time.

      UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.


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

      Parameters:
      updateQuerySuggestionsConfigRequest - A Consumer that will call methods on UpdateQuerySuggestionsConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQuerySuggestionsConfig 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateThesaurus

      default CompletableFuture<UpdateThesaurusResponse> updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)

      Updates a thesaurus for an index.

      Parameters:
      updateThesaurusRequest -
      Returns:
      A Java Future containing the result of the UpdateThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateThesaurus

      default CompletableFuture<UpdateThesaurusResponse> updateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest)

      Updates a thesaurus for an index.


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

      Parameters:
      updateThesaurusRequest - A Consumer that will call methods on UpdateThesaurusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateThesaurus 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
      • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
      • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
      • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
      • 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.
      • KendraException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default KendraServiceClientConfiguration 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 KendraAsyncClient create()
      Create a KendraAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static KendraAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a KendraAsyncClient.