software.amazon.awssdk.services.kendraranking

Interface KendraRankingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface KendraRankingClient
extends AwsClient

Service client for accessing Kendra Ranking. This can be created using the static builder() method.

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	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static KendraRankingClientBuilder	builder() Create a builder that can be used to configure and create a KendraRankingClient.
static KendraRankingClient	create() Create a KendraRankingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateRescoreExecutionPlanResponse	createRescoreExecutionPlan(Consumer<CreateRescoreExecutionPlanRequest.Builder> createRescoreExecutionPlanRequest) Creates a rescore execution plan.
default CreateRescoreExecutionPlanResponse	createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest) Creates a rescore execution plan.
default DeleteRescoreExecutionPlanResponse	deleteRescoreExecutionPlan(Consumer<DeleteRescoreExecutionPlanRequest.Builder> deleteRescoreExecutionPlanRequest) Deletes a rescore execution plan.
default DeleteRescoreExecutionPlanResponse	deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest) Deletes a rescore execution plan.
default DescribeRescoreExecutionPlanResponse	describeRescoreExecutionPlan(Consumer<DescribeRescoreExecutionPlanRequest.Builder> describeRescoreExecutionPlanRequest) Gets information about a rescore execution plan.
default DescribeRescoreExecutionPlanResponse	describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest) Gets information about a rescore execution plan.
default ListRescoreExecutionPlansResponse	listRescoreExecutionPlans(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest) Lists your rescore execution plans.
default ListRescoreExecutionPlansResponse	listRescoreExecutionPlans(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest) Lists your rescore execution plans.
default ListRescoreExecutionPlansIterable	listRescoreExecutionPlansPaginator(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest) Lists your rescore execution plans.
default ListRescoreExecutionPlansIterable	listRescoreExecutionPlansPaginator(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest) Lists your rescore execution plans.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of tags associated with a specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of tags associated with a specified resource.
default RescoreResponse	rescore(Consumer<RescoreRequest.Builder> rescoreRequest) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
default RescoreResponse	rescore(RescoreRequest rescoreRequest) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
default KendraRankingServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a specified tag to a specified rescore execution plan.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Adds a specified tag to a specified rescore execution plan.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from a rescore execution plan.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from a rescore execution plan.
default UpdateRescoreExecutionPlanResponse	updateRescoreExecutionPlan(Consumer<UpdateRescoreExecutionPlanRequest.Builder> updateRescoreExecutionPlanRequest) Updates a rescore execution plan.
default UpdateRescoreExecutionPlanResponse	updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest) Updates a rescore execution plan.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

createRescoreExecutionPlan

default CreateRescoreExecutionPlanResponse createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest)
                                                               throws AccessDeniedException,
                                                                      ConflictException,
                                                                      ServiceQuotaExceededException,
                                                                      ThrottlingException,
                                                                      ValidationException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

createRescoreExecutionPlan

default CreateRescoreExecutionPlanResponse createRescoreExecutionPlan(Consumer<CreateRescoreExecutionPlanRequest.Builder> createRescoreExecutionPlanRequest)
                                                               throws AccessDeniedException,
                                                                      ConflictException,
                                                                      ServiceQuotaExceededException,
                                                                      ThrottlingException,
                                                                      ValidationException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

deleteRescoreExecutionPlan

default DeleteRescoreExecutionPlanResponse deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest)
                                                               throws AccessDeniedException,
                                                                      ValidationException,
                                                                      ConflictException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

deleteRescoreExecutionPlan

default DeleteRescoreExecutionPlanResponse deleteRescoreExecutionPlan(Consumer<DeleteRescoreExecutionPlanRequest.Builder> deleteRescoreExecutionPlanRequest)
                                                               throws AccessDeniedException,
                                                                      ValidationException,
                                                                      ConflictException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

describeRescoreExecutionPlan

default DescribeRescoreExecutionPlanResponse describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest)
                                                                   throws ValidationException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          AccessDeniedException,
                                                                          InternalServerException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

describeRescoreExecutionPlan

default DescribeRescoreExecutionPlanResponse describeRescoreExecutionPlan(Consumer<DescribeRescoreExecutionPlanRequest.Builder> describeRescoreExecutionPlanRequest)
                                                                   throws ValidationException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          AccessDeniedException,
                                                                          InternalServerException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listRescoreExecutionPlans

default ListRescoreExecutionPlansResponse listRescoreExecutionPlans(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest)
                                                             throws ValidationException,
                                                                    AccessDeniedException,
                                                                    ThrottlingException,
                                                                    InternalServerException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listRescoreExecutionPlans

default ListRescoreExecutionPlansResponse listRescoreExecutionPlans(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest)
                                                             throws ValidationException,
                                                                    AccessDeniedException,
                                                                    ThrottlingException,
                                                                    InternalServerException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listRescoreExecutionPlansPaginator

default ListRescoreExecutionPlansIterable listRescoreExecutionPlansPaginator(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest)
                                                                      throws ValidationException,
                                                                             AccessDeniedException,
                                                                             ThrottlingException,
                                                                             InternalServerException,
                                                                             AwsServiceException,
                                                                             SdkClientException,
                                                                             KendraRankingException

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 variant of listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client
             .listRescoreExecutionPlansPaginator(request);
     for (software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listRescoreExecutionPlansPaginator

default ListRescoreExecutionPlansIterable listRescoreExecutionPlansPaginator(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest)
                                                                      throws ValidationException,
                                                                             AccessDeniedException,
                                                                             ThrottlingException,
                                                                             InternalServerException,
                                                                             AwsServiceException,
                                                                             SdkClientException,
                                                                             KendraRankingException

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 variant of listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client
             .listRescoreExecutionPlansPaginator(request);
     for (software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
                                                        ResourceUnavailableException,
                                                        ThrottlingException,
                                                        AccessDeniedException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
                                                        ResourceUnavailableException,
                                                        ThrottlingException,
                                                        AccessDeniedException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

rescore

default RescoreResponse rescore(RescoreRequest rescoreRequest)
                         throws ValidationException,
                                ConflictException,
                                AccessDeniedException,
                                ResourceNotFoundException,
                                ThrottlingException,
                                InternalServerException,
                                AwsServiceException,
                                SdkClientException,
                                KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

rescore

default RescoreResponse rescore(Consumer<RescoreRequest.Builder> rescoreRequest)
                         throws ValidationException,
                                ConflictException,
                                AccessDeniedException,
                                ResourceNotFoundException,
                                ThrottlingException,
                                InternalServerException,
                                AwsServiceException,
                                SdkClientException,
                                KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
                                        ResourceUnavailableException,
                                        ThrottlingException,
                                        AccessDeniedException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
                                        ResourceUnavailableException,
                                        ThrottlingException,
                                        AccessDeniedException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
                                            ResourceUnavailableException,
                                            ThrottlingException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
                                            ResourceUnavailableException,
                                            ThrottlingException,
                                            AccessDeniedException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

updateRescoreExecutionPlan

default UpdateRescoreExecutionPlanResponse updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest)
                                                               throws ValidationException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      AccessDeniedException,
                                                                      ServiceQuotaExceededException,
                                                                      ConflictException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KendraRankingException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

updateRescoreExecutionPlan

default UpdateRescoreExecutionPlanResponse updateRescoreExecutionPlan(Consumer<UpdateRescoreExecutionPlanRequest.Builder> updateRescoreExecutionPlanRequest)
                                                               throws ValidationException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      AccessDeniedException,
                                                                      ServiceQuotaExceededException,
                                                                      ConflictException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KendraRankingException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

create

static KendraRankingClient create()

Create a KendraRankingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static KendraRankingClientBuilder builder()

Create a builder that can be used to configure and create a KendraRankingClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default KendraRankingServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient