com.amazonaws.services.kendraranking

Class AmazonKendraRankingAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kendraranking.AmazonKendraRankingClient

com.amazonaws.services.kendraranking.AmazonKendraRankingAsyncClient

All Implemented Interfaces:

AmazonKendraRanking, AmazonKendraRankingAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonKendraRankingAsyncClient
extends AmazonKendraRankingClient
implements AmazonKendraRankingAsync

Client for accessing Kendra Ranking asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.kendraranking.AmazonKendraRanking

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonKendraRankingAsyncClientBuilder	asyncBuilder()
Future<CreateRescoreExecutionPlanResult>	createRescoreExecutionPlanAsync(CreateRescoreExecutionPlanRequest request) Creates a rescore execution plan.
Future<CreateRescoreExecutionPlanResult>	createRescoreExecutionPlanAsync(CreateRescoreExecutionPlanRequest request, AsyncHandler<CreateRescoreExecutionPlanRequest,CreateRescoreExecutionPlanResult> asyncHandler) Creates a rescore execution plan.
Future<DeleteRescoreExecutionPlanResult>	deleteRescoreExecutionPlanAsync(DeleteRescoreExecutionPlanRequest request) Deletes a rescore execution plan.
Future<DeleteRescoreExecutionPlanResult>	deleteRescoreExecutionPlanAsync(DeleteRescoreExecutionPlanRequest request, AsyncHandler<DeleteRescoreExecutionPlanRequest,DeleteRescoreExecutionPlanResult> asyncHandler) Deletes a rescore execution plan.
Future<DescribeRescoreExecutionPlanResult>	describeRescoreExecutionPlanAsync(DescribeRescoreExecutionPlanRequest request) Gets information about a rescore execution plan.
Future<DescribeRescoreExecutionPlanResult>	describeRescoreExecutionPlanAsync(DescribeRescoreExecutionPlanRequest request, AsyncHandler<DescribeRescoreExecutionPlanRequest,DescribeRescoreExecutionPlanResult> asyncHandler) Gets information about a rescore execution plan.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListRescoreExecutionPlansResult>	listRescoreExecutionPlansAsync(ListRescoreExecutionPlansRequest request) Lists your rescore execution plans.
Future<ListRescoreExecutionPlansResult>	listRescoreExecutionPlansAsync(ListRescoreExecutionPlansRequest request, AsyncHandler<ListRescoreExecutionPlansRequest,ListRescoreExecutionPlansResult> asyncHandler) Lists your rescore execution plans.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Gets a list of tags associated with a specified resource.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Gets a list of tags associated with a specified resource.
Future<RescoreResult>	rescoreAsync(RescoreRequest request) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
Future<RescoreResult>	rescoreAsync(RescoreRequest request, AsyncHandler<RescoreRequest,RescoreResult> asyncHandler) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Adds a specified tag to a specified rescore execution plan.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds a specified tag to a specified rescore execution plan.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes a tag from a rescore execution plan.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes a tag from a rescore execution plan.
Future<UpdateRescoreExecutionPlanResult>	updateRescoreExecutionPlanAsync(UpdateRescoreExecutionPlanRequest request) Updates a rescore execution plan.
Future<UpdateRescoreExecutionPlanResult>	updateRescoreExecutionPlanAsync(UpdateRescoreExecutionPlanRequest request, AsyncHandler<UpdateRescoreExecutionPlanRequest,UpdateRescoreExecutionPlanResult> asyncHandler) Updates a rescore execution plan.

Methods inherited from class com.amazonaws.services.kendraranking.AmazonKendraRankingClient

builder, createRescoreExecutionPlan, deleteRescoreExecutionPlan, describeRescoreExecutionPlan, getCachedResponseMetadata, listRescoreExecutionPlans, listTagsForResource, rescore, tagResource, untagResource, updateRescoreExecutionPlan

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.kendraranking.AmazonKendraRanking

createRescoreExecutionPlan, deleteRescoreExecutionPlan, describeRescoreExecutionPlan, getCachedResponseMetadata, listRescoreExecutionPlans, listTagsForResource, rescore, tagResource, untagResource, updateRescoreExecutionPlan

Method Detail

asyncBuilder

public static AmazonKendraRankingAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createRescoreExecutionPlanAsync

public Future<CreateRescoreExecutionPlanResult> createRescoreExecutionPlanAsync(CreateRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

createRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

Returns:

A Java Future containing the result of the CreateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

createRescoreExecutionPlanAsync

public Future<CreateRescoreExecutionPlanResult> createRescoreExecutionPlanAsync(CreateRescoreExecutionPlanRequest request,
                                                                                AsyncHandler<CreateRescoreExecutionPlanRequest,CreateRescoreExecutionPlanResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

createRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

deleteRescoreExecutionPlanAsync

public Future<DeleteRescoreExecutionPlanResult> deleteRescoreExecutionPlanAsync(DeleteRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRankingAsync

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

Specified by:

deleteRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

Returns:

A Java Future containing the result of the DeleteRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

deleteRescoreExecutionPlanAsync

public Future<DeleteRescoreExecutionPlanResult> deleteRescoreExecutionPlanAsync(DeleteRescoreExecutionPlanRequest request,
                                                                                AsyncHandler<DeleteRescoreExecutionPlanRequest,DeleteRescoreExecutionPlanResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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

Specified by:

deleteRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

describeRescoreExecutionPlanAsync

public Future<DescribeRescoreExecutionPlanResult> describeRescoreExecutionPlanAsync(DescribeRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRankingAsync

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

Specified by:

describeRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

Returns:

A Java Future containing the result of the DescribeRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

describeRescoreExecutionPlanAsync

public Future<DescribeRescoreExecutionPlanResult> describeRescoreExecutionPlanAsync(DescribeRescoreExecutionPlanRequest request,
                                                                                    AsyncHandler<DescribeRescoreExecutionPlanRequest,DescribeRescoreExecutionPlanResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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

Specified by:

describeRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

listRescoreExecutionPlansAsync

public Future<ListRescoreExecutionPlansResult> listRescoreExecutionPlansAsync(ListRescoreExecutionPlansRequest request)

Description copied from interface: AmazonKendraRankingAsync

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

Specified by:

listRescoreExecutionPlansAsync in interface AmazonKendraRankingAsync

Returns:

A Java Future containing the result of the ListRescoreExecutionPlans operation returned by the service.

See Also:

AWS API Documentation

listRescoreExecutionPlansAsync

public Future<ListRescoreExecutionPlansResult> listRescoreExecutionPlansAsync(ListRescoreExecutionPlansRequest request,
                                                                              AsyncHandler<ListRescoreExecutionPlansRequest,ListRescoreExecutionPlansResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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

Specified by:

listRescoreExecutionPlansAsync in interface AmazonKendraRankingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListRescoreExecutionPlans operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

listTagsForResourceAsync in interface AmazonKendraRankingAsync

Parameters:

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.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

listTagsForResourceAsync in interface AmazonKendraRankingAsync

Parameters:

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.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

rescoreAsync

public Future<RescoreResult> rescoreAsync(RescoreRequest request)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

rescoreAsync in interface AmazonKendraRankingAsync

Returns:

A Java Future containing the result of the Rescore operation returned by the service.

See Also:

AWS API Documentation

rescoreAsync

public Future<RescoreResult> rescoreAsync(RescoreRequest request,
                                          AsyncHandler<RescoreRequest,RescoreResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

rescoreAsync in interface AmazonKendraRankingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the Rescore operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

tagResourceAsync in interface AmazonKendraRankingAsync

Parameters:

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.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

tagResourceAsync in interface AmazonKendraRankingAsync

Parameters:

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.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

untagResourceAsync in interface AmazonKendraRankingAsync

Parameters:

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.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

untagResourceAsync in interface AmazonKendraRankingAsync

Parameters:

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.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateRescoreExecutionPlanAsync

public Future<UpdateRescoreExecutionPlanResult> updateRescoreExecutionPlanAsync(UpdateRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

updateRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

Returns:

A Java Future containing the result of the UpdateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

updateRescoreExecutionPlanAsync

public Future<UpdateRescoreExecutionPlanResult> updateRescoreExecutionPlanAsync(UpdateRescoreExecutionPlanRequest request,
                                                                                AsyncHandler<UpdateRescoreExecutionPlanRequest,UpdateRescoreExecutionPlanResult> asyncHandler)

Description copied from interface: AmazonKendraRankingAsync

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.

Specified by:

updateRescoreExecutionPlanAsync in interface AmazonKendraRankingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonKendraRanking

Overrides:

shutdown in class AmazonKendraRankingClient