com.amazonaws.services.kendraranking

Class AmazonKendraRankingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kendraranking.AmazonKendraRankingClient

All Implemented Interfaces:

AmazonKendraRanking

Direct Known Subclasses:

AmazonKendraRankingAsyncClient

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

Client for accessing Kendra Ranking. All service calls made using this client are blocking, and will not return until the service call 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 AmazonKendraRankingClientBuilder	builder()
CreateRescoreExecutionPlanResult	createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest request) Creates a rescore execution plan.
DeleteRescoreExecutionPlanResult	deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest request) Deletes a rescore execution plan.
DescribeRescoreExecutionPlanResult	describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest request) Gets information about a rescore execution plan.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListRescoreExecutionPlansResult	listRescoreExecutionPlans(ListRescoreExecutionPlansRequest request) Lists your rescore execution plans.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Gets a list of tags associated with a specified resource.
RescoreResult	rescore(RescoreRequest request) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds a specified tag to a specified rescore execution plan.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from a rescore execution plan.
UpdateRescoreExecutionPlanResult	updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest request) Updates a rescore execution plan.

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

Method Detail

builder

public static AmazonKendraRankingClientBuilder builder()

createRescoreExecutionPlan

public CreateRescoreExecutionPlanResult createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest request)

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:

createRescoreExecutionPlan in interface AmazonKendraRanking

Parameters:

createRescoreExecutionPlanRequest -

Returns:

Result of the CreateRescoreExecutionPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteRescoreExecutionPlan

public DeleteRescoreExecutionPlanResult deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest request)

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

Specified by:

deleteRescoreExecutionPlan in interface AmazonKendraRanking

Parameters:

deleteRescoreExecutionPlanRequest -

Returns:

Result of the DeleteRescoreExecutionPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeRescoreExecutionPlan

public DescribeRescoreExecutionPlanResult describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest request)

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:

describeRescoreExecutionPlan in interface AmazonKendraRanking

Parameters:

describeRescoreExecutionPlanRequest -

Returns:

Result of the DescribeRescoreExecutionPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listRescoreExecutionPlans

public ListRescoreExecutionPlansResult listRescoreExecutionPlans(ListRescoreExecutionPlansRequest request)

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

Specified by:

listRescoreExecutionPlans in interface AmazonKendraRanking

Parameters:

listRescoreExecutionPlansRequest -

Returns:

Result of the ListRescoreExecutionPlans operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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:

listTagsForResource in interface AmazonKendraRanking

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:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

rescore

public RescoreResult rescore(RescoreRequest request)

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:

rescore in interface AmazonKendraRanking

Parameters:

rescoreRequest -

Returns:

Result of the Rescore operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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:

tagResource in interface AmazonKendraRanking

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:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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:

untagResource in interface AmazonKendraRanking

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:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateRescoreExecutionPlan

public UpdateRescoreExecutionPlanResult updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest request)

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:

updateRescoreExecutionPlan in interface AmazonKendraRanking

Parameters:

updateRescoreExecutionPlanRequest -

Returns:

Result of the UpdateRescoreExecutionPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonKendraRanking

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonKendraRanking

Overrides:

shutdown in class AmazonWebServiceClient