@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonKendraRankingClient extends AmazonWebServiceClient implements AmazonKendraRanking
Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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.
|
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
public static AmazonKendraRankingClientBuilder builder()
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.
createRescoreExecutionPlan
in interface AmazonKendraRanking
createRescoreExecutionPlanRequest
- 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.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.
deleteRescoreExecutionPlan
in interface AmazonKendraRanking
deleteRescoreExecutionPlanRequest
- 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.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.
describeRescoreExecutionPlan
in interface AmazonKendraRanking
describeRescoreExecutionPlanRequest
- 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.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.
listRescoreExecutionPlans
in interface AmazonKendraRanking
listRescoreExecutionPlansRequest
- 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.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.
listTagsForResource
in interface AmazonKendraRanking
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.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.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.
rescore
in interface AmazonKendraRanking
rescoreRequest
- 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.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.
tagResource
in interface AmazonKendraRanking
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.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.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.
untagResource
in interface AmazonKendraRanking
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.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.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.
updateRescoreExecutionPlan
in interface AmazonKendraRanking
updateRescoreExecutionPlanRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonKendraRanking
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonKendraRanking
shutdown
in class AmazonWebServiceClient