com.amazonaws.services.kendraranking

Interface AmazonKendraRanking

All Known Subinterfaces:

AmazonKendraRankingAsync

All Known Implementing Classes:

AbstractAmazonKendraRanking, AbstractAmazonKendraRankingAsync, AmazonKendraRankingAsyncClient, AmazonKendraRankingClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKendraRanking

Interface for accessing Kendra Ranking.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKendraRanking instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateRescoreExecutionPlanResult	createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest) Creates a rescore execution plan.
DeleteRescoreExecutionPlanResult	deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest) Deletes a rescore execution plan.
DescribeRescoreExecutionPlanResult	describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest) 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 listRescoreExecutionPlansRequest) Lists your rescore execution plans.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of tags associated with a specified resource.
RescoreResult	rescore(RescoreRequest rescoreRequest) 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 tagResourceRequest) Adds a specified tag to a specified rescore execution plan.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from a rescore execution plan.
UpdateRescoreExecutionPlanResult	updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest) Updates a rescore execution plan.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createRescoreExecutionPlan

CreateRescoreExecutionPlanResult 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:

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

DeleteRescoreExecutionPlanResult 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:

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

DescribeRescoreExecutionPlanResult 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:

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

ListRescoreExecutionPlansResult 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:

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

ListTagsForResourceResult 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:

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

RescoreResult 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:

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

TagResourceResult 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:

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

UntagResourceResult 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:

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

UpdateRescoreExecutionPlanResult 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:

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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