Package software.amazon.awssdk.services.kendraranking

Interface KendraRankingAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface KendraRankingAsyncClient extends AwsClient
Service client for accessing Kendra Ranking 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 Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.

  • Field Details

  • Method Details

    • createRescoreExecutionPlan

      default CompletableFuture<CreateRescoreExecutionPlanResponse> createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest)

      Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.

      For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.

      Parameters:
      createRescoreExecutionPlanRequest -
      Returns:
      A Java Future containing the result of the CreateRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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.
      • ConflictException A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra Intelligent Ranking 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRescoreExecutionPlan

      default CompletableFuture<CreateRescoreExecutionPlanResponse> createRescoreExecutionPlan(Consumer<CreateRescoreExecutionPlanRequest.Builder> createRescoreExecutionPlanRequest)

      Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.

      For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.


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

      Parameters:
      createRescoreExecutionPlanRequest - A Consumer that will call methods on CreateRescoreExecutionPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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.
      • ConflictException A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.
      • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra Intelligent Ranking 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.
      • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRescoreExecutionPlan

      default CompletableFuture<DeleteRescoreExecutionPlanResponse> deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest)

      Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

      Parameters:
      deleteRescoreExecutionPlanRequest -
      Returns:
      A Java Future containing the result of the DeleteRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistencies 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRescoreExecutionPlan

      default CompletableFuture<DeleteRescoreExecutionPlanResponse> deleteRescoreExecutionPlan(Consumer<DeleteRescoreExecutionPlanRequest.Builder> deleteRescoreExecutionPlanRequest)

      Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.


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

      Parameters:
      deleteRescoreExecutionPlanRequest - A Consumer that will call methods on DeleteRescoreExecutionPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistencies 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRescoreExecutionPlan

      default CompletableFuture<DescribeRescoreExecutionPlanResponse> describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest)

      Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

      Parameters:
      describeRescoreExecutionPlanRequest -
      Returns:
      A Java Future containing the result of the DescribeRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRescoreExecutionPlan

      default CompletableFuture<DescribeRescoreExecutionPlanResponse> describeRescoreExecutionPlan(Consumer<DescribeRescoreExecutionPlanRequest.Builder> describeRescoreExecutionPlanRequest)

      Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.


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

      Parameters:
      describeRescoreExecutionPlanRequest - A Consumer that will call methods on DescribeRescoreExecutionPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRescoreExecutionPlans

      default CompletableFuture<ListRescoreExecutionPlansResponse> listRescoreExecutionPlans(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest)

      Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

      Parameters:
      listRescoreExecutionPlansRequest -
      Returns:
      A Java Future containing the result of the ListRescoreExecutionPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking service. Please provide the correct input 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRescoreExecutionPlans

      default CompletableFuture<ListRescoreExecutionPlansResponse> listRescoreExecutionPlans(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest)

      Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.


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

      Parameters:
      listRescoreExecutionPlansRequest - A Consumer that will call methods on ListRescoreExecutionPlansRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRescoreExecutionPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking service. Please provide the correct input 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRescoreExecutionPlansPaginator

      default ListRescoreExecutionPlansPublisher listRescoreExecutionPlansPaginator(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest)

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

      Parameters:
      listRescoreExecutionPlansRequest -
      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 Intelligent Ranking service. Please provide the correct input 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRescoreExecutionPlansPaginator

      default ListRescoreExecutionPlansPublisher listRescoreExecutionPlansPaginator(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest)

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


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

      Parameters:
      listRescoreExecutionPlansRequest - A Consumer that will call methods on ListRescoreExecutionPlansRequest.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 Intelligent Ranking service. Please provide the correct input 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.

      Parameters:
      listTagsForResourceRequest - The request information for listing tags associated with a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
      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 Intelligent Ranking service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

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

      Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.


      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. The request information for listing tags associated with a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
      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 Intelligent Ranking service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rescore

      default CompletableFuture<RescoreResponse> rescore(RescoreRequest rescoreRequest)

      Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.

      Parameters:
      rescoreRequest -
      Returns:
      A Java Future containing the result of the Rescore operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistencies 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.
      • 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rescore

      default CompletableFuture<RescoreResponse> rescore(Consumer<RescoreRequest.Builder> rescoreRequest)

      Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.


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

      Parameters:
      rescoreRequest - A Consumer that will call methods on RescoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Rescore operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking service. Please provide the correct input and try again.
      • ConflictException A conflict occurred with the request. Please fix any inconsistencies 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.
      • 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 Intelligent Ranking 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.
      • KendraRankingException 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 a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the existing value is replaced with the new value.

      Parameters:
      tagResourceRequest - The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
      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 Intelligent Ranking service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information 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 Intelligent Ranking 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.
      • KendraRankingException 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 a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. 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. The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
      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 Intelligent Ranking service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information 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 Intelligent Ranking 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.
      • KendraRankingException 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 a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore operation.

      Parameters:
      untagResourceRequest - The request information to remove a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
      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 Intelligent Ranking service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information 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 Intelligent Ranking 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.
      • KendraRankingException 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 a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore operation.


      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. The request information to remove a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
      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 Intelligent Ranking service. Please provide the correct input and try again.
      • ResourceUnavailableException The resource you want to use is unavailable. Please check you have provided the correct resource information 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 Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRescoreExecutionPlan

      default CompletableFuture<UpdateRescoreExecutionPlanResponse> updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest)

      Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.

      Parameters:
      updateRescoreExecutionPlanRequest -
      Returns:
      A Java Future containing the result of the UpdateRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking 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 Intelligent Ranking 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 inconsistencies with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRescoreExecutionPlan

      default CompletableFuture<UpdateRescoreExecutionPlanResponse> updateRescoreExecutionPlan(Consumer<UpdateRescoreExecutionPlanRequest.Builder> updateRescoreExecutionPlanRequest)

      Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.


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

      Parameters:
      updateRescoreExecutionPlanRequest - A Consumer that will call methods on UpdateRescoreExecutionPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRescoreExecutionPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 Intelligent Ranking 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 Intelligent Ranking 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 inconsistencies with your resources and try again.
      • InternalServerException An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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.
      • KendraRankingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static KendraRankingAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a KendraRankingAsyncClient.