software.amazon.awssdk.services.kendra.KendraClient Maven / Gradle / Ivy
Show all versions of kendra Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.kendra;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.kendra.model.AccessDeniedException;
import software.amazon.awssdk.services.kendra.model.AssociateEntitiesToExperienceRequest;
import software.amazon.awssdk.services.kendra.model.AssociateEntitiesToExperienceResponse;
import software.amazon.awssdk.services.kendra.model.AssociatePersonasToEntitiesRequest;
import software.amazon.awssdk.services.kendra.model.AssociatePersonasToEntitiesResponse;
import software.amazon.awssdk.services.kendra.model.BatchDeleteDocumentRequest;
import software.amazon.awssdk.services.kendra.model.BatchDeleteDocumentResponse;
import software.amazon.awssdk.services.kendra.model.BatchDeleteFeaturedResultsSetRequest;
import software.amazon.awssdk.services.kendra.model.BatchDeleteFeaturedResultsSetResponse;
import software.amazon.awssdk.services.kendra.model.BatchGetDocumentStatusRequest;
import software.amazon.awssdk.services.kendra.model.BatchGetDocumentStatusResponse;
import software.amazon.awssdk.services.kendra.model.BatchPutDocumentRequest;
import software.amazon.awssdk.services.kendra.model.BatchPutDocumentResponse;
import software.amazon.awssdk.services.kendra.model.ClearQuerySuggestionsRequest;
import software.amazon.awssdk.services.kendra.model.ClearQuerySuggestionsResponse;
import software.amazon.awssdk.services.kendra.model.ConflictException;
import software.amazon.awssdk.services.kendra.model.CreateAccessControlConfigurationRequest;
import software.amazon.awssdk.services.kendra.model.CreateAccessControlConfigurationResponse;
import software.amazon.awssdk.services.kendra.model.CreateDataSourceRequest;
import software.amazon.awssdk.services.kendra.model.CreateDataSourceResponse;
import software.amazon.awssdk.services.kendra.model.CreateExperienceRequest;
import software.amazon.awssdk.services.kendra.model.CreateExperienceResponse;
import software.amazon.awssdk.services.kendra.model.CreateFaqRequest;
import software.amazon.awssdk.services.kendra.model.CreateFaqResponse;
import software.amazon.awssdk.services.kendra.model.CreateFeaturedResultsSetRequest;
import software.amazon.awssdk.services.kendra.model.CreateFeaturedResultsSetResponse;
import software.amazon.awssdk.services.kendra.model.CreateIndexRequest;
import software.amazon.awssdk.services.kendra.model.CreateIndexResponse;
import software.amazon.awssdk.services.kendra.model.CreateQuerySuggestionsBlockListRequest;
import software.amazon.awssdk.services.kendra.model.CreateQuerySuggestionsBlockListResponse;
import software.amazon.awssdk.services.kendra.model.CreateThesaurusRequest;
import software.amazon.awssdk.services.kendra.model.CreateThesaurusResponse;
import software.amazon.awssdk.services.kendra.model.DeleteAccessControlConfigurationRequest;
import software.amazon.awssdk.services.kendra.model.DeleteAccessControlConfigurationResponse;
import software.amazon.awssdk.services.kendra.model.DeleteDataSourceRequest;
import software.amazon.awssdk.services.kendra.model.DeleteDataSourceResponse;
import software.amazon.awssdk.services.kendra.model.DeleteExperienceRequest;
import software.amazon.awssdk.services.kendra.model.DeleteExperienceResponse;
import software.amazon.awssdk.services.kendra.model.DeleteFaqRequest;
import software.amazon.awssdk.services.kendra.model.DeleteFaqResponse;
import software.amazon.awssdk.services.kendra.model.DeleteIndexRequest;
import software.amazon.awssdk.services.kendra.model.DeleteIndexResponse;
import software.amazon.awssdk.services.kendra.model.DeletePrincipalMappingRequest;
import software.amazon.awssdk.services.kendra.model.DeletePrincipalMappingResponse;
import software.amazon.awssdk.services.kendra.model.DeleteQuerySuggestionsBlockListRequest;
import software.amazon.awssdk.services.kendra.model.DeleteQuerySuggestionsBlockListResponse;
import software.amazon.awssdk.services.kendra.model.DeleteThesaurusRequest;
import software.amazon.awssdk.services.kendra.model.DeleteThesaurusResponse;
import software.amazon.awssdk.services.kendra.model.DescribeAccessControlConfigurationRequest;
import software.amazon.awssdk.services.kendra.model.DescribeAccessControlConfigurationResponse;
import software.amazon.awssdk.services.kendra.model.DescribeDataSourceRequest;
import software.amazon.awssdk.services.kendra.model.DescribeDataSourceResponse;
import software.amazon.awssdk.services.kendra.model.DescribeExperienceRequest;
import software.amazon.awssdk.services.kendra.model.DescribeExperienceResponse;
import software.amazon.awssdk.services.kendra.model.DescribeFaqRequest;
import software.amazon.awssdk.services.kendra.model.DescribeFaqResponse;
import software.amazon.awssdk.services.kendra.model.DescribeFeaturedResultsSetRequest;
import software.amazon.awssdk.services.kendra.model.DescribeFeaturedResultsSetResponse;
import software.amazon.awssdk.services.kendra.model.DescribeIndexRequest;
import software.amazon.awssdk.services.kendra.model.DescribeIndexResponse;
import software.amazon.awssdk.services.kendra.model.DescribePrincipalMappingRequest;
import software.amazon.awssdk.services.kendra.model.DescribePrincipalMappingResponse;
import software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsBlockListRequest;
import software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsBlockListResponse;
import software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsConfigRequest;
import software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsConfigResponse;
import software.amazon.awssdk.services.kendra.model.DescribeThesaurusRequest;
import software.amazon.awssdk.services.kendra.model.DescribeThesaurusResponse;
import software.amazon.awssdk.services.kendra.model.DisassociateEntitiesFromExperienceRequest;
import software.amazon.awssdk.services.kendra.model.DisassociateEntitiesFromExperienceResponse;
import software.amazon.awssdk.services.kendra.model.DisassociatePersonasFromEntitiesRequest;
import software.amazon.awssdk.services.kendra.model.DisassociatePersonasFromEntitiesResponse;
import software.amazon.awssdk.services.kendra.model.FeaturedResultsConflictException;
import software.amazon.awssdk.services.kendra.model.GetQuerySuggestionsRequest;
import software.amazon.awssdk.services.kendra.model.GetQuerySuggestionsResponse;
import software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest;
import software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse;
import software.amazon.awssdk.services.kendra.model.InternalServerException;
import software.amazon.awssdk.services.kendra.model.InvalidRequestException;
import software.amazon.awssdk.services.kendra.model.KendraException;
import software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest;
import software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse;
import software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest;
import software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse;
import software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest;
import software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse;
import software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest;
import software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse;
import software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest;
import software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse;
import software.amazon.awssdk.services.kendra.model.ListExperiencesRequest;
import software.amazon.awssdk.services.kendra.model.ListExperiencesResponse;
import software.amazon.awssdk.services.kendra.model.ListFaqsRequest;
import software.amazon.awssdk.services.kendra.model.ListFaqsResponse;
import software.amazon.awssdk.services.kendra.model.ListFeaturedResultsSetsRequest;
import software.amazon.awssdk.services.kendra.model.ListFeaturedResultsSetsResponse;
import software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest;
import software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse;
import software.amazon.awssdk.services.kendra.model.ListIndicesRequest;
import software.amazon.awssdk.services.kendra.model.ListIndicesResponse;
import software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest;
import software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse;
import software.amazon.awssdk.services.kendra.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.kendra.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.kendra.model.ListThesauriRequest;
import software.amazon.awssdk.services.kendra.model.ListThesauriResponse;
import software.amazon.awssdk.services.kendra.model.PutPrincipalMappingRequest;
import software.amazon.awssdk.services.kendra.model.PutPrincipalMappingResponse;
import software.amazon.awssdk.services.kendra.model.QueryRequest;
import software.amazon.awssdk.services.kendra.model.QueryResponse;
import software.amazon.awssdk.services.kendra.model.ResourceAlreadyExistException;
import software.amazon.awssdk.services.kendra.model.ResourceInUseException;
import software.amazon.awssdk.services.kendra.model.ResourceNotFoundException;
import software.amazon.awssdk.services.kendra.model.ResourceUnavailableException;
import software.amazon.awssdk.services.kendra.model.RetrieveRequest;
import software.amazon.awssdk.services.kendra.model.RetrieveResponse;
import software.amazon.awssdk.services.kendra.model.ServiceQuotaExceededException;
import software.amazon.awssdk.services.kendra.model.StartDataSourceSyncJobRequest;
import software.amazon.awssdk.services.kendra.model.StartDataSourceSyncJobResponse;
import software.amazon.awssdk.services.kendra.model.StopDataSourceSyncJobRequest;
import software.amazon.awssdk.services.kendra.model.StopDataSourceSyncJobResponse;
import software.amazon.awssdk.services.kendra.model.SubmitFeedbackRequest;
import software.amazon.awssdk.services.kendra.model.SubmitFeedbackResponse;
import software.amazon.awssdk.services.kendra.model.TagResourceRequest;
import software.amazon.awssdk.services.kendra.model.TagResourceResponse;
import software.amazon.awssdk.services.kendra.model.ThrottlingException;
import software.amazon.awssdk.services.kendra.model.UntagResourceRequest;
import software.amazon.awssdk.services.kendra.model.UntagResourceResponse;
import software.amazon.awssdk.services.kendra.model.UpdateAccessControlConfigurationRequest;
import software.amazon.awssdk.services.kendra.model.UpdateAccessControlConfigurationResponse;
import software.amazon.awssdk.services.kendra.model.UpdateDataSourceRequest;
import software.amazon.awssdk.services.kendra.model.UpdateDataSourceResponse;
import software.amazon.awssdk.services.kendra.model.UpdateExperienceRequest;
import software.amazon.awssdk.services.kendra.model.UpdateExperienceResponse;
import software.amazon.awssdk.services.kendra.model.UpdateFeaturedResultsSetRequest;
import software.amazon.awssdk.services.kendra.model.UpdateFeaturedResultsSetResponse;
import software.amazon.awssdk.services.kendra.model.UpdateIndexRequest;
import software.amazon.awssdk.services.kendra.model.UpdateIndexResponse;
import software.amazon.awssdk.services.kendra.model.UpdateQuerySuggestionsBlockListRequest;
import software.amazon.awssdk.services.kendra.model.UpdateQuerySuggestionsBlockListResponse;
import software.amazon.awssdk.services.kendra.model.UpdateQuerySuggestionsConfigRequest;
import software.amazon.awssdk.services.kendra.model.UpdateQuerySuggestionsConfigResponse;
import software.amazon.awssdk.services.kendra.model.UpdateThesaurusRequest;
import software.amazon.awssdk.services.kendra.model.UpdateThesaurusResponse;
import software.amazon.awssdk.services.kendra.model.ValidationException;
import software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable;
import software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable;
import software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable;
import software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable;
import software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable;
import software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable;
import software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable;
import software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable;
import software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable;
import software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable;
import software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable;
import software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable;
/**
* Service client for accessing kendra. This can be created using the static {@link #builder()} method.
*
*
* Amazon Kendra is a service for indexing large document sets.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface KendraClient extends AwsClient {
String SERVICE_NAME = "kendra";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "kendra";
/**
*
* Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You
* can create an Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, see Building a search
* experience with no code.
*
*
* @param associateEntitiesToExperienceRequest
* @return Result of the AssociateEntitiesToExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.AssociateEntitiesToExperience
* @see AWS API Documentation
*/
default AssociateEntitiesToExperienceResponse associateEntitiesToExperience(
AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest) throws ValidationException,
ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You
* can create an Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateEntitiesToExperienceRequest.Builder}
* avoiding the need to create one manually via {@link AssociateEntitiesToExperienceRequest#builder()}
*
*
* @param associateEntitiesToExperienceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.AssociateEntitiesToExperienceRequest.Builder} to
* create a request.
* @return Result of the AssociateEntitiesToExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.AssociateEntitiesToExperience
* @see AWS API Documentation
*/
default AssociateEntitiesToExperienceResponse associateEntitiesToExperience(
Consumer associateEntitiesToExperienceRequest)
throws ValidationException, ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException,
AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return associateEntitiesToExperience(AssociateEntitiesToExperienceRequest.builder()
.applyMutation(associateEntitiesToExperienceRequest).build());
}
/**
*
* Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to
* your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more
* information on creating a search application experience, see Building a search
* experience with no code.
*
*
* @param associatePersonasToEntitiesRequest
* @return Result of the AssociatePersonasToEntities operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.AssociatePersonasToEntities
* @see AWS API Documentation
*/
default AssociatePersonasToEntitiesResponse associatePersonasToEntities(
AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest) throws ValidationException,
ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to
* your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more
* information on creating a search application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link AssociatePersonasToEntitiesRequest.Builder}
* avoiding the need to create one manually via {@link AssociatePersonasToEntitiesRequest#builder()}
*
*
* @param associatePersonasToEntitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.AssociatePersonasToEntitiesRequest.Builder} to create
* a request.
* @return Result of the AssociatePersonasToEntities operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.AssociatePersonasToEntities
* @see AWS API Documentation
*/
default AssociatePersonasToEntitiesResponse associatePersonasToEntities(
Consumer associatePersonasToEntitiesRequest) throws ValidationException,
ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return associatePersonasToEntities(AssociatePersonasToEntitiesRequest.builder()
.applyMutation(associatePersonasToEntitiesRequest).build());
}
/**
*
* Removes one or more documents from an index. The documents must have been added with the
* BatchPutDocument API.
*
*
* The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services
* CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services
* CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting
* your documents.
*
*
* Deleting documents from an index using BatchDeleteDocument could take up to an hour or more,
* depending on the number of documents you want to delete.
*
*
* @param batchDeleteDocumentRequest
* @return Result of the BatchDeleteDocument operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchDeleteDocument
* @see AWS
* API Documentation
*/
default BatchDeleteDocumentResponse batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more documents from an index. The documents must have been added with the
* BatchPutDocument API.
*
*
* The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services
* CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services
* CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting
* your documents.
*
*
* Deleting documents from an index using BatchDeleteDocument could take up to an hour or more,
* depending on the number of documents you want to delete.
*
*
*
* This is a convenience which creates an instance of the {@link BatchDeleteDocumentRequest.Builder} avoiding the
* need to create one manually via {@link BatchDeleteDocumentRequest#builder()}
*
*
* @param batchDeleteDocumentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.BatchDeleteDocumentRequest.Builder} to create a
* request.
* @return Result of the BatchDeleteDocument operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchDeleteDocument
* @see AWS
* API Documentation
*/
default BatchDeleteDocumentResponse batchDeleteDocument(
Consumer batchDeleteDocumentRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return batchDeleteDocument(BatchDeleteDocumentRequest.builder().applyMutation(batchDeleteDocumentRequest).build());
}
/**
*
* Removes one or more sets of featured results. Features results are placed above all other results for certain
* queries. If there's an exact match of a query, then one or more specific documents are featured in the search
* results.
*
*
* @param batchDeleteFeaturedResultsSetRequest
* @return Result of the BatchDeleteFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchDeleteFeaturedResultsSet
* @see AWS API Documentation
*/
default BatchDeleteFeaturedResultsSetResponse batchDeleteFeaturedResultsSet(
BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more sets of featured results. Features results are placed above all other results for certain
* queries. If there's an exact match of a query, then one or more specific documents are featured in the search
* results.
*
*
*
* This is a convenience which creates an instance of the {@link BatchDeleteFeaturedResultsSetRequest.Builder}
* avoiding the need to create one manually via {@link BatchDeleteFeaturedResultsSetRequest#builder()}
*
*
* @param batchDeleteFeaturedResultsSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.BatchDeleteFeaturedResultsSetRequest.Builder} to
* create a request.
* @return Result of the BatchDeleteFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchDeleteFeaturedResultsSet
* @see AWS API Documentation
*/
default BatchDeleteFeaturedResultsSetResponse batchDeleteFeaturedResultsSet(
Consumer batchDeleteFeaturedResultsSetRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return batchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest.builder()
.applyMutation(batchDeleteFeaturedResultsSetRequest).build());
}
/**
*
* Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
*
*
* When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the
* BatchGetDocumentStatus API to get the current status of a list of documents so that you can
* determine if they have been successfully indexed.
*
*
* You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API.
* When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
*
*
* @param batchGetDocumentStatusRequest
* @return Result of the BatchGetDocumentStatus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchGetDocumentStatus
* @see AWS
* API Documentation
*/
default BatchGetDocumentStatusResponse batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
*
*
* When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the
* BatchGetDocumentStatus API to get the current status of a list of documents so that you can
* determine if they have been successfully indexed.
*
*
* You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API.
* When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetDocumentStatusRequest.Builder} avoiding the
* need to create one manually via {@link BatchGetDocumentStatusRequest#builder()}
*
*
* @param batchGetDocumentStatusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.BatchGetDocumentStatusRequest.Builder} to create a
* request.
* @return Result of the BatchGetDocumentStatus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchGetDocumentStatus
* @see AWS
* API Documentation
*/
default BatchGetDocumentStatusResponse batchGetDocumentStatus(
Consumer batchGetDocumentStatusRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return batchGetDocumentStatus(BatchGetDocumentStatusRequest.builder().applyMutation(batchGetDocumentStatusRequest)
.build());
}
/**
*
* Adds one or more documents to an index.
*
*
* The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an
* Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to
* the documents, and to attach an access control list to the documents added to the index.
*
*
* The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services
* CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch
* log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your
* documents.
*
*
* For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an
* index.
*
*
* @param batchPutDocumentRequest
* @return Result of the BatchPutDocument operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchPutDocument
* @see AWS API
* Documentation
*/
default BatchPutDocumentResponse batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Adds one or more documents to an index.
*
*
* The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an
* Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to
* the documents, and to attach an access control list to the documents added to the index.
*
*
* The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services
* CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch
* log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your
* documents.
*
*
* For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an
* index.
*
*
*
* This is a convenience which creates an instance of the {@link BatchPutDocumentRequest.Builder} avoiding the need
* to create one manually via {@link BatchPutDocumentRequest#builder()}
*
*
* @param batchPutDocumentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.BatchPutDocumentRequest.Builder} to create a request.
* @return Result of the BatchPutDocument operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.BatchPutDocument
* @see AWS API
* Documentation
*/
default BatchPutDocumentResponse batchPutDocument(Consumer batchPutDocumentRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return batchPutDocument(BatchPutDocumentRequest.builder().applyMutation(batchPutDocumentRequest).build());
}
/**
*
* Clears existing query suggestions from an index.
*
*
* This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon
* Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions.
* If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new
* suggestions.
*
*
* ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West)
* region.
*
*
* @param clearQuerySuggestionsRequest
* @return Result of the ClearQuerySuggestions operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ClearQuerySuggestions
* @see AWS
* API Documentation
*/
default ClearQuerySuggestionsResponse clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, ConflictException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Clears existing query suggestions from an index.
*
*
* This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon
* Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions.
* If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new
* suggestions.
*
*
* ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West)
* region.
*
*
*
* This is a convenience which creates an instance of the {@link ClearQuerySuggestionsRequest.Builder} avoiding the
* need to create one manually via {@link ClearQuerySuggestionsRequest#builder()}
*
*
* @param clearQuerySuggestionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ClearQuerySuggestionsRequest.Builder} to create a
* request.
* @return Result of the ClearQuerySuggestions operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ClearQuerySuggestions
* @see AWS
* API Documentation
*/
default ClearQuerySuggestionsResponse clearQuerySuggestions(
Consumer clearQuerySuggestionsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, ConflictException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return clearQuerySuggestions(ClearQuerySuggestionsRequest.builder().applyMutation(clearQuerySuggestionsRequest).build());
}
/**
*
* Creates an access configuration for your documents. This includes user and group access information for your
* documents. This is useful for user context filtering, where search results are filtered based on the user or
* their group access to documents.
*
*
* You can use this to re-configure your existing document level access control without indexing all of your
* documents again. For example, your index contains top-secret company documents that only certain employees or
* users should access. One of these users leaves the company or switches to a team that should be blocked from
* accessing top-secret documents. The user still has access to top-secret documents because the user had access
* when your documents were previously indexed. You can create a specific access control configuration for the user
* with deny access. You can later update the access control configuration to allow access if the user returns to
* the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as
* circumstances change.
*
*
* To apply your access control configuration to certain documents, you call the BatchPutDocument API with the
* AccessControlConfigurationId included in the Document object. If you use an S3
* bucket as a data source, you update the .metadata.json with the
* AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports
* access control configuration for S3 data sources and documents indexed using the BatchPutDocument
* API.
*
*
* @param createAccessControlConfigurationRequest
* @return Result of the CreateAccessControlConfiguration operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateAccessControlConfiguration
* @see AWS API Documentation
*/
default CreateAccessControlConfigurationResponse createAccessControlConfiguration(
CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)
throws ServiceQuotaExceededException, ValidationException, ThrottlingException, ConflictException,
AccessDeniedException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates an access configuration for your documents. This includes user and group access information for your
* documents. This is useful for user context filtering, where search results are filtered based on the user or
* their group access to documents.
*
*
* You can use this to re-configure your existing document level access control without indexing all of your
* documents again. For example, your index contains top-secret company documents that only certain employees or
* users should access. One of these users leaves the company or switches to a team that should be blocked from
* accessing top-secret documents. The user still has access to top-secret documents because the user had access
* when your documents were previously indexed. You can create a specific access control configuration for the user
* with deny access. You can later update the access control configuration to allow access if the user returns to
* the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as
* circumstances change.
*
*
* To apply your access control configuration to certain documents, you call the BatchPutDocument API with the
* AccessControlConfigurationId included in the Document object. If you use an S3
* bucket as a data source, you update the .metadata.json with the
* AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports
* access control configuration for S3 data sources and documents indexed using the BatchPutDocument
* API.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAccessControlConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link CreateAccessControlConfigurationRequest#builder()}
*
*
* @param createAccessControlConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateAccessControlConfigurationRequest.Builder} to
* create a request.
* @return Result of the CreateAccessControlConfiguration operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateAccessControlConfiguration
* @see AWS API Documentation
*/
default CreateAccessControlConfigurationResponse createAccessControlConfiguration(
Consumer createAccessControlConfigurationRequest)
throws ServiceQuotaExceededException, ValidationException, ThrottlingException, ConflictException,
AccessDeniedException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
return createAccessControlConfiguration(CreateAccessControlConfigurationRequest.builder()
.applyMutation(createAccessControlConfigurationRequest).build());
}
/**
*
* Creates a data source connector that you want to use with an Amazon Kendra index.
*
*
* You specify a name, data source connector type and description for your data source. You also specify
* configuration information for the data source connector.
*
*
* CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
* successfully created. Otherwise, an exception is raised.
*
*
* For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an
* example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
*
*
* @param createDataSourceRequest
* @return Result of the CreateDataSource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateDataSource
* @see AWS API
* Documentation
*/
default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistException,
ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a data source connector that you want to use with an Amazon Kendra index.
*
*
* You specify a name, data source connector type and description for your data source. You also specify
* configuration information for the data source connector.
*
*
* CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
* successfully created. Otherwise, an exception is raised.
*
*
* For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an
* example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDataSourceRequest.Builder} avoiding the need
* to create one manually via {@link CreateDataSourceRequest#builder()}
*
*
* @param createDataSourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateDataSourceRequest.Builder} to create a request.
* @return Result of the CreateDataSource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateDataSource
* @see AWS API
* Documentation
*/
default CreateDataSourceResponse createDataSource(Consumer createDataSourceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistException,
ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return createDataSource(CreateDataSourceRequest.builder().applyMutation(createDataSourceRequest).build());
}
/**
*
* Creates an Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, including using the Python and Java SDKs, see Building a search
* experience with no code.
*
*
* @param createExperienceRequest
* @return Result of the CreateExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateExperience
* @see AWS API
* Documentation
*/
default CreateExperienceResponse createExperience(CreateExperienceRequest createExperienceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException,
ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates an Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, including using the Python and Java SDKs, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link CreateExperienceRequest.Builder} avoiding the need
* to create one manually via {@link CreateExperienceRequest#builder()}
*
*
* @param createExperienceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateExperienceRequest.Builder} to create a request.
* @return Result of the CreateExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateExperience
* @see AWS API
* Documentation
*/
default CreateExperienceResponse createExperience(Consumer createExperienceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException,
ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
return createExperience(CreateExperienceRequest.builder().applyMutation(createExperienceRequest).build());
}
/**
*
* Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
*
*
* Adding FAQs to an index is an asynchronous operation.
*
*
* For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
*
*
* @param createFaqRequest
* @return Result of the CreateFaq operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateFaq
* @see AWS API
* Documentation
*/
default CreateFaqResponse createFaq(CreateFaqRequest createFaqRequest) throws ValidationException, ConflictException,
ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
*
*
* Adding FAQs to an index is an asynchronous operation.
*
*
* For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
*
*
*
* This is a convenience which creates an instance of the {@link CreateFaqRequest.Builder} avoiding the need to
* create one manually via {@link CreateFaqRequest#builder()}
*
*
* @param createFaqRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateFaqRequest.Builder} to create a request.
* @return Result of the CreateFaq operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateFaq
* @see AWS API
* Documentation
*/
default CreateFaqResponse createFaq(Consumer createFaqRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException,
AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return createFaq(CreateFaqRequest.builder().applyMutation(createFaqRequest).build());
}
/**
*
* Creates a set of featured results to display at the top of the search results page. Featured results are placed
* above all other results for certain queries. You map specific queries to specific documents for featuring in the
* results. If a query contains an exact match, then one or more specific documents are featured in the search
* results.
*
*
* You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting
* Support.
*
*
* @param createFeaturedResultsSetRequest
* @return Result of the CreateFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws FeaturedResultsConflictException
* An error message with a list of conflicting queries used across different sets of featured results. This
* occurred with the request for a new featured results set. Check that the queries you specified for
* featured results are unique per featured results set for each index.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateFeaturedResultsSet
* @see AWS API Documentation
*/
default CreateFeaturedResultsSetResponse createFeaturedResultsSet(
CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest) throws ResourceNotFoundException,
AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a set of featured results to display at the top of the search results page. Featured results are placed
* above all other results for certain queries. You map specific queries to specific documents for featuring in the
* results. If a query contains an exact match, then one or more specific documents are featured in the search
* results.
*
*
* You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting
* Support.
*
*
*
* This is a convenience which creates an instance of the {@link CreateFeaturedResultsSetRequest.Builder} avoiding
* the need to create one manually via {@link CreateFeaturedResultsSetRequest#builder()}
*
*
* @param createFeaturedResultsSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateFeaturedResultsSetRequest.Builder} to create a
* request.
* @return Result of the CreateFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws FeaturedResultsConflictException
* An error message with a list of conflicting queries used across different sets of featured results. This
* occurred with the request for a new featured results set. Check that the queries you specified for
* featured results are unique per featured results set for each index.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateFeaturedResultsSet
* @see AWS API Documentation
*/
default CreateFeaturedResultsSetResponse createFeaturedResultsSet(
Consumer createFeaturedResultsSetRequest) throws ResourceNotFoundException,
AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return createFeaturedResultsSet(CreateFeaturedResultsSetRequest.builder().applyMutation(createFeaturedResultsSetRequest)
.build());
}
/**
*
* Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has
* completed, check the Status field returned from a call to DescribeIndex. The
* Status field is set to ACTIVE when the index is ready to use.
*
*
* Once the index is active, you can index your documents using the BatchPutDocument API or using one
* of the supported data sources.
*
*
* For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an
* example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
*
*
* @param createIndexRequest
* @return Result of the CreateIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateIndex
* @see AWS API
* Documentation
*/
default CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws ValidationException,
ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException,
ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has
* completed, check the Status field returned from a call to DescribeIndex. The
* Status field is set to ACTIVE when the index is ready to use.
*
*
* Once the index is active, you can index your documents using the BatchPutDocument API or using one
* of the supported data sources.
*
*
* For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an
* example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
*
*
*
* This is a convenience which creates an instance of the {@link CreateIndexRequest.Builder} avoiding the need to
* create one manually via {@link CreateIndexRequest#builder()}
*
*
* @param createIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateIndexRequest.Builder} to create a request.
* @return Result of the CreateIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateIndex
* @see AWS API
* Documentation
*/
default CreateIndexResponse createIndex(Consumer createIndexRequest) throws ValidationException,
ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException,
ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return createIndex(CreateIndexRequest.builder().applyMutation(createIndexRequest).build());
}
/**
*
* Creates a block list to exlcude certain queries from suggestions.
*
*
* Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown
* as a suggestion.
*
*
* You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter
* each block word or phrase on a separate line.
*
*
* For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
*
*
* CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* For an example of creating a block list for query suggestions using the Python SDK, see Query
* suggestions block list.
*
*
* @param createQuerySuggestionsBlockListRequest
* @return Result of the CreateQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default CreateQuerySuggestionsBlockListResponse createQuerySuggestionsBlockList(
CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException,
ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a block list to exlcude certain queries from suggestions.
*
*
* Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown
* as a suggestion.
*
*
* You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter
* each block word or phrase on a separate line.
*
*
* For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
*
*
* CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* For an example of creating a block list for query suggestions using the Python SDK, see Query
* suggestions block list.
*
*
*
* This is a convenience which creates an instance of the {@link CreateQuerySuggestionsBlockListRequest.Builder}
* avoiding the need to create one manually via {@link CreateQuerySuggestionsBlockListRequest#builder()}
*
*
* @param createQuerySuggestionsBlockListRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateQuerySuggestionsBlockListRequest.Builder} to
* create a request.
* @return Result of the CreateQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default CreateQuerySuggestionsBlockListResponse createQuerySuggestionsBlockList(
Consumer createQuerySuggestionsBlockListRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
return createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest.builder()
.applyMutation(createQuerySuggestionsBlockListRequest).build());
}
/**
*
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
*
*
* For an example of adding a thesaurus file to an index, see Adding custom
* synonyms to an index.
*
*
* @param createThesaurusRequest
* @return Result of the CreateThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateThesaurus
* @see AWS API
* Documentation
*/
default CreateThesaurusResponse createThesaurus(CreateThesaurusRequest createThesaurusRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException,
AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
*
*
* For an example of adding a thesaurus file to an index, see Adding custom
* synonyms to an index.
*
*
*
* This is a convenience which creates an instance of the {@link CreateThesaurusRequest.Builder} avoiding the need
* to create one manually via {@link CreateThesaurusRequest#builder()}
*
*
* @param createThesaurusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.CreateThesaurusRequest.Builder} to create a request.
* @return Result of the CreateThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.CreateThesaurus
* @see AWS API
* Documentation
*/
default CreateThesaurusResponse createThesaurus(Consumer createThesaurusRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException,
ServiceQuotaExceededException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return createThesaurus(CreateThesaurusRequest.builder().applyMutation(createThesaurusRequest).build());
}
/**
*
* Deletes an access control configuration that you created for your documents in an index. This includes user and
* group access information for your documents. This is useful for user context filtering, where search results are
* filtered based on the user or their group access to documents.
*
*
* @param deleteAccessControlConfigurationRequest
* @return Result of the DeleteAccessControlConfiguration operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteAccessControlConfiguration
* @see AWS API Documentation
*/
default DeleteAccessControlConfigurationResponse deleteAccessControlConfiguration(
DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest) throws ValidationException,
ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an access control configuration that you created for your documents in an index. This includes user and
* group access information for your documents. This is useful for user context filtering, where search results are
* filtered based on the user or their group access to documents.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAccessControlConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteAccessControlConfigurationRequest#builder()}
*
*
* @param deleteAccessControlConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeleteAccessControlConfigurationRequest.Builder} to
* create a request.
* @return Result of the DeleteAccessControlConfiguration operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteAccessControlConfiguration
* @see AWS API Documentation
*/
default DeleteAccessControlConfigurationResponse deleteAccessControlConfiguration(
Consumer deleteAccessControlConfigurationRequest)
throws ValidationException, ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest.builder()
.applyMutation(deleteAccessControlConfigurationRequest).build());
}
/**
*
* Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being
* deleted. While the data source is being deleted, the Status field returned by a call to the
* DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
*
*
* Deleting an entire data source or re-syncing your index after deleting specific documents from a data source
* could take up to an hour or more, depending on the number of documents you want to delete.
*
*
* @param deleteDataSourceRequest
* @return Result of the DeleteDataSource 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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteDataSource
* @see AWS API
* Documentation
*/
default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being
* deleted. While the data source is being deleted, the Status field returned by a call to the
* DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
*
*
* Deleting an entire data source or re-syncing your index after deleting specific documents from a data source
* could take up to an hour or more, depending on the number of documents you want to delete.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDataSourceRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDataSourceRequest#builder()}
*
*
* @param deleteDataSourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeleteDataSourceRequest.Builder} to create a request.
* @return Result of the DeleteDataSource 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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteDataSource
* @see AWS API
* Documentation
*/
default DeleteDataSourceResponse deleteDataSource(Consumer deleteDataSourceRequest)
throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return deleteDataSource(DeleteDataSourceRequest.builder().applyMutation(deleteDataSourceRequest).build());
}
/**
*
* Deletes your Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, see Building a search
* experience with no code.
*
*
* @param deleteExperienceRequest
* @return Result of the DeleteExperience 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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteExperience
* @see AWS API
* Documentation
*/
default DeleteExperienceResponse deleteExperience(DeleteExperienceRequest deleteExperienceRequest)
throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes your Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteExperienceRequest.Builder} avoiding the need
* to create one manually via {@link DeleteExperienceRequest#builder()}
*
*
* @param deleteExperienceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeleteExperienceRequest.Builder} to create a request.
* @return Result of the DeleteExperience 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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteExperience
* @see AWS API
* Documentation
*/
default DeleteExperienceResponse deleteExperience(Consumer deleteExperienceRequest)
throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return deleteExperience(DeleteExperienceRequest.builder().applyMutation(deleteExperienceRequest).build());
}
/**
*
* Removes an FAQ from an index.
*
*
* @param deleteFaqRequest
* @return Result of the DeleteFaq operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteFaq
* @see AWS API
* Documentation
*/
default DeleteFaqResponse deleteFaq(DeleteFaqRequest deleteFaqRequest) throws ValidationException, ConflictException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Removes an FAQ from an index.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteFaqRequest.Builder} avoiding the need to
* create one manually via {@link DeleteFaqRequest#builder()}
*
*
* @param deleteFaqRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeleteFaqRequest.Builder} to create a request.
* @return Result of the DeleteFaq operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteFaq
* @see AWS API
* Documentation
*/
default DeleteFaqResponse deleteFaq(Consumer deleteFaqRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return deleteFaq(DeleteFaqRequest.builder().applyMutation(deleteFaqRequest).build());
}
/**
*
* Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index
* is being deleted, the Status field returned by a call to the DescribeIndex API is set
* to DELETING.
*
*
* @param deleteIndexRequest
* @return Result of the DeleteIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteIndex
* @see AWS API
* Documentation
*/
default DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws ValidationException, ConflictException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index
* is being deleted, the Status field returned by a call to the DescribeIndex API is set
* to DELETING.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteIndexRequest.Builder} avoiding the need to
* create one manually via {@link DeleteIndexRequest#builder()}
*
*
* @param deleteIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeleteIndexRequest.Builder} to create a request.
* @return Result of the DeleteIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteIndex
* @see AWS API
* Documentation
*/
default DeleteIndexResponse deleteIndex(Consumer deleteIndexRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return deleteIndex(DeleteIndexRequest.builder().applyMutation(deleteIndexRequest).build());
}
/**
*
* Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
* available to that group.
*
*
* For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see
* intern-only documents in their search results.
*
*
* If you want to delete or replace users or sub groups of a group, you need to use the
* PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the
* engineering team and another user takes their place, you provide an updated list of users or sub groups that
* belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal
* list of users or sub groups and input this list when calling PutPrincipalMapping.
*
*
* DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
* region.
*
*
* @param deletePrincipalMappingRequest
* @return Result of the DeletePrincipalMapping operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeletePrincipalMapping
* @see AWS
* API Documentation
*/
default DeletePrincipalMappingResponse deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
* available to that group.
*
*
* For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see
* intern-only documents in their search results.
*
*
* If you want to delete or replace users or sub groups of a group, you need to use the
* PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the
* engineering team and another user takes their place, you provide an updated list of users or sub groups that
* belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal
* list of users or sub groups and input this list when calling PutPrincipalMapping.
*
*
* DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
* region.
*
*
*
* This is a convenience which creates an instance of the {@link DeletePrincipalMappingRequest.Builder} avoiding the
* need to create one manually via {@link DeletePrincipalMappingRequest#builder()}
*
*
* @param deletePrincipalMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeletePrincipalMappingRequest.Builder} to create a
* request.
* @return Result of the DeletePrincipalMapping operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeletePrincipalMapping
* @see AWS
* API Documentation
*/
default DeletePrincipalMappingResponse deletePrincipalMapping(
Consumer deletePrincipalMappingRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return deletePrincipalMapping(DeletePrincipalMappingRequest.builder().applyMutation(deletePrincipalMappingRequest)
.build());
}
/**
*
* Deletes a block list used for query suggestions for an index.
*
*
* A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list
* to add back the queries that were previously blocked.
*
*
* DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param deleteQuerySuggestionsBlockListRequest
* @return Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default DeleteQuerySuggestionsBlockListResponse deleteQuerySuggestionsBlockList(
DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a block list used for query suggestions for an index.
*
*
* A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list
* to add back the queries that were previously blocked.
*
*
* DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteQuerySuggestionsBlockListRequest.Builder}
* avoiding the need to create one manually via {@link DeleteQuerySuggestionsBlockListRequest#builder()}
*
*
* @param deleteQuerySuggestionsBlockListRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeleteQuerySuggestionsBlockListRequest.Builder} to
* create a request.
* @return Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default DeleteQuerySuggestionsBlockListResponse deleteQuerySuggestionsBlockList(
Consumer deleteQuerySuggestionsBlockListRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest.builder()
.applyMutation(deleteQuerySuggestionsBlockListRequest).build());
}
/**
*
* Deletes an Amazon Kendra thesaurus.
*
*
* @param deleteThesaurusRequest
* @return Result of the DeleteThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteThesaurus
* @see AWS API
* Documentation
*/
default DeleteThesaurusResponse deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Amazon Kendra thesaurus.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteThesaurusRequest.Builder} avoiding the need
* to create one manually via {@link DeleteThesaurusRequest#builder()}
*
*
* @param deleteThesaurusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DeleteThesaurusRequest.Builder} to create a request.
* @return Result of the DeleteThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DeleteThesaurus
* @see AWS API
* Documentation
*/
default DeleteThesaurusResponse deleteThesaurus(Consumer deleteThesaurusRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return deleteThesaurus(DeleteThesaurusRequest.builder().applyMutation(deleteThesaurusRequest).build());
}
/**
*
* Gets information about an access control configuration that you created for your documents in an index. This
* includes user and group access information for your documents. This is useful for user context filtering, where
* search results are filtered based on the user or their group access to documents.
*
*
* @param describeAccessControlConfigurationRequest
* @return Result of the DescribeAccessControlConfiguration operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeAccessControlConfiguration
* @see AWS API Documentation
*/
default DescribeAccessControlConfigurationResponse describeAccessControlConfiguration(
DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest) throws ValidationException,
ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about an access control configuration that you created for your documents in an index. This
* includes user and group access information for your documents. This is useful for user context filtering, where
* search results are filtered based on the user or their group access to documents.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAccessControlConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DescribeAccessControlConfigurationRequest#builder()}
*
*
* @param describeAccessControlConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeAccessControlConfigurationRequest.Builder} to
* create a request.
* @return Result of the DescribeAccessControlConfiguration operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeAccessControlConfiguration
* @see AWS API Documentation
*/
default DescribeAccessControlConfigurationResponse describeAccessControlConfiguration(
Consumer describeAccessControlConfigurationRequest)
throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest.builder()
.applyMutation(describeAccessControlConfigurationRequest).build());
}
/**
*
* Gets information about an Amazon Kendra data source connector.
*
*
* @param describeDataSourceRequest
* @return Result of the DescribeDataSource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeDataSource
* @see AWS API
* Documentation
*/
default DescribeDataSourceResponse describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about an Amazon Kendra data source connector.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDataSourceRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDataSourceRequest#builder()}
*
*
* @param describeDataSourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeDataSourceRequest.Builder} to create a
* request.
* @return Result of the DescribeDataSource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeDataSource
* @see AWS API
* Documentation
*/
default DescribeDataSourceResponse describeDataSource(Consumer describeDataSourceRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeDataSource(DescribeDataSourceRequest.builder().applyMutation(describeDataSourceRequest).build());
}
/**
*
* Gets information about your Amazon Kendra experience such as a search application. For more information on
* creating a search application experience, see Building a search
* experience with no code.
*
*
* @param describeExperienceRequest
* @return Result of the DescribeExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeExperience
* @see AWS API
* Documentation
*/
default DescribeExperienceResponse describeExperience(DescribeExperienceRequest describeExperienceRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about your Amazon Kendra experience such as a search application. For more information on
* creating a search application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeExperienceRequest.Builder} avoiding the
* need to create one manually via {@link DescribeExperienceRequest#builder()}
*
*
* @param describeExperienceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeExperienceRequest.Builder} to create a
* request.
* @return Result of the DescribeExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeExperience
* @see AWS API
* Documentation
*/
default DescribeExperienceResponse describeExperience(Consumer describeExperienceRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeExperience(DescribeExperienceRequest.builder().applyMutation(describeExperienceRequest).build());
}
/**
*
* Gets information about an FAQ list.
*
*
* @param describeFaqRequest
* @return Result of the DescribeFaq operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeFaq
* @see AWS API
* Documentation
*/
default DescribeFaqResponse describeFaq(DescribeFaqRequest describeFaqRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about an FAQ list.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeFaqRequest.Builder} avoiding the need to
* create one manually via {@link DescribeFaqRequest#builder()}
*
*
* @param describeFaqRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeFaqRequest.Builder} to create a request.
* @return Result of the DescribeFaq operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeFaq
* @see AWS API
* Documentation
*/
default DescribeFaqResponse describeFaq(Consumer describeFaqRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return describeFaq(DescribeFaqRequest.builder().applyMutation(describeFaqRequest).build());
}
/**
*
* Gets information about a set of featured results. Features results are placed above all other results for certain
* queries. If there's an exact match of a query, then one or more specific documents are featured in the search
* results.
*
*
* @param describeFeaturedResultsSetRequest
* @return Result of the DescribeFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeFeaturedResultsSet
* @see AWS API Documentation
*/
default DescribeFeaturedResultsSetResponse describeFeaturedResultsSet(
DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a set of featured results. Features results are placed above all other results for certain
* queries. If there's an exact match of a query, then one or more specific documents are featured in the search
* results.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeFeaturedResultsSetRequest.Builder} avoiding
* the need to create one manually via {@link DescribeFeaturedResultsSetRequest#builder()}
*
*
* @param describeFeaturedResultsSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeFeaturedResultsSetRequest.Builder} to create a
* request.
* @return Result of the DescribeFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeFeaturedResultsSet
* @see AWS API Documentation
*/
default DescribeFeaturedResultsSetResponse describeFeaturedResultsSet(
Consumer describeFeaturedResultsSetRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeFeaturedResultsSet(DescribeFeaturedResultsSetRequest.builder()
.applyMutation(describeFeaturedResultsSetRequest).build());
}
/**
*
* Gets information about an Amazon Kendra index.
*
*
* @param describeIndexRequest
* @return Result of the DescribeIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeIndex
* @see AWS API
* Documentation
*/
default DescribeIndexResponse describeIndex(DescribeIndexRequest describeIndexRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about an Amazon Kendra index.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeIndexRequest.Builder} avoiding the need to
* create one manually via {@link DescribeIndexRequest#builder()}
*
*
* @param describeIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeIndexRequest.Builder} to create a request.
* @return Result of the DescribeIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeIndex
* @see AWS API
* Documentation
*/
default DescribeIndexResponse describeIndex(Consumer describeIndexRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeIndex(DescribeIndexRequest.builder().applyMutation(describeIndexRequest).build());
}
/**
*
* Describes the processing of PUT and DELETE actions for mapping users to their groups.
* This includes information on the status of actions currently processing or yet to be processed, when actions were
* last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after
* other actions, and useful error messages if an action could not be processed.
*
*
* DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
* region.
*
*
* @param describePrincipalMappingRequest
* @return Result of the DescribePrincipalMapping operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribePrincipalMapping
* @see AWS API Documentation
*/
default DescribePrincipalMappingResponse describePrincipalMapping(
DescribePrincipalMappingRequest describePrincipalMappingRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Describes the processing of PUT and DELETE actions for mapping users to their groups.
* This includes information on the status of actions currently processing or yet to be processed, when actions were
* last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after
* other actions, and useful error messages if an action could not be processed.
*
*
* DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
* region.
*
*
*
* This is a convenience which creates an instance of the {@link DescribePrincipalMappingRequest.Builder} avoiding
* the need to create one manually via {@link DescribePrincipalMappingRequest#builder()}
*
*
* @param describePrincipalMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribePrincipalMappingRequest.Builder} to create a
* request.
* @return Result of the DescribePrincipalMapping operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribePrincipalMapping
* @see AWS API Documentation
*/
default DescribePrincipalMappingResponse describePrincipalMapping(
Consumer describePrincipalMappingRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return describePrincipalMapping(DescribePrincipalMappingRequest.builder().applyMutation(describePrincipalMappingRequest)
.build());
}
/**
*
* Gets information about a block list used for query suggestions for an index.
*
*
* This is used to check the current settings that are applied to a block list.
*
*
* DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param describeQuerySuggestionsBlockListRequest
* @return Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default DescribeQuerySuggestionsBlockListResponse describeQuerySuggestionsBlockList(
DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a block list used for query suggestions for an index.
*
*
* This is used to check the current settings that are applied to a block list.
*
*
* DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeQuerySuggestionsBlockListRequest.Builder}
* avoiding the need to create one manually via {@link DescribeQuerySuggestionsBlockListRequest#builder()}
*
*
* @param describeQuerySuggestionsBlockListRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsBlockListRequest.Builder} to
* create a request.
* @return Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default DescribeQuerySuggestionsBlockListResponse describeQuerySuggestionsBlockList(
Consumer describeQuerySuggestionsBlockListRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest.builder()
.applyMutation(describeQuerySuggestionsBlockListRequest).build());
}
/**
*
* Gets information on the settings of query suggestions for an index.
*
*
* This is used to check the current settings applied to query suggestions.
*
*
* DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param describeQuerySuggestionsConfigRequest
* @return Result of the DescribeQuerySuggestionsConfig operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeQuerySuggestionsConfig
* @see AWS API Documentation
*/
default DescribeQuerySuggestionsConfigResponse describeQuerySuggestionsConfig(
DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information on the settings of query suggestions for an index.
*
*
* This is used to check the current settings applied to query suggestions.
*
*
* DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeQuerySuggestionsConfigRequest.Builder}
* avoiding the need to create one manually via {@link DescribeQuerySuggestionsConfigRequest#builder()}
*
*
* @param describeQuerySuggestionsConfigRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsConfigRequest.Builder} to
* create a request.
* @return Result of the DescribeQuerySuggestionsConfig operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeQuerySuggestionsConfig
* @see AWS API Documentation
*/
default DescribeQuerySuggestionsConfigResponse describeQuerySuggestionsConfig(
Consumer describeQuerySuggestionsConfigRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest.builder()
.applyMutation(describeQuerySuggestionsConfigRequest).build());
}
/**
*
* Gets information about an Amazon Kendra thesaurus.
*
*
* @param describeThesaurusRequest
* @return Result of the DescribeThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeThesaurus
* @see AWS API
* Documentation
*/
default DescribeThesaurusResponse describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about an Amazon Kendra thesaurus.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeThesaurusRequest.Builder} avoiding the need
* to create one manually via {@link DescribeThesaurusRequest#builder()}
*
*
* @param describeThesaurusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DescribeThesaurusRequest.Builder} to create a request.
* @return Result of the DescribeThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DescribeThesaurus
* @see AWS API
* Documentation
*/
default DescribeThesaurusResponse describeThesaurus(Consumer describeThesaurusRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return describeThesaurus(DescribeThesaurusRequest.builder().applyMutation(describeThesaurusRequest).build());
}
/**
*
* Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra
* experience. You can create an Amazon Kendra experience such as a search application. For more information on
* creating a search application experience, see Building a search
* experience with no code.
*
*
* @param disassociateEntitiesFromExperienceRequest
* @return Result of the DisassociateEntitiesFromExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DisassociateEntitiesFromExperience
* @see AWS API Documentation
*/
default DisassociateEntitiesFromExperienceResponse disassociateEntitiesFromExperience(
DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra
* experience. You can create an Amazon Kendra experience such as a search application. For more information on
* creating a search application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateEntitiesFromExperienceRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateEntitiesFromExperienceRequest#builder()}
*
*
* @param disassociateEntitiesFromExperienceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DisassociateEntitiesFromExperienceRequest.Builder} to
* create a request.
* @return Result of the DisassociateEntitiesFromExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DisassociateEntitiesFromExperience
* @see AWS API Documentation
*/
default DisassociateEntitiesFromExperienceResponse disassociateEntitiesFromExperience(
Consumer disassociateEntitiesFromExperienceRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest.builder()
.applyMutation(disassociateEntitiesFromExperienceRequest).build());
}
/**
*
* Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to
* your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more
* information on creating a search application experience, see Building a search
* experience with no code.
*
*
* @param disassociatePersonasFromEntitiesRequest
* @return Result of the DisassociatePersonasFromEntities operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DisassociatePersonasFromEntities
* @see AWS API Documentation
*/
default DisassociatePersonasFromEntitiesResponse disassociatePersonasFromEntities(
DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to
* your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more
* information on creating a search application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociatePersonasFromEntitiesRequest.Builder}
* avoiding the need to create one manually via {@link DisassociatePersonasFromEntitiesRequest#builder()}
*
*
* @param disassociatePersonasFromEntitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.DisassociatePersonasFromEntitiesRequest.Builder} to
* create a request.
* @return Result of the DisassociatePersonasFromEntities operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.DisassociatePersonasFromEntities
* @see AWS API Documentation
*/
default DisassociatePersonasFromEntitiesResponse disassociatePersonasFromEntities(
Consumer disassociatePersonasFromEntitiesRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest.builder()
.applyMutation(disassociatePersonasFromEntitiesRequest).build());
}
/**
*
* Fetches the queries that are suggested to your users.
*
*
* GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
*
*
* @param getQuerySuggestionsRequest
* @return Result of the GetQuerySuggestions operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.GetQuerySuggestions
* @see AWS
* API Documentation
*/
default GetQuerySuggestionsResponse getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Fetches the queries that are suggested to your users.
*
*
* GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link GetQuerySuggestionsRequest.Builder} avoiding the
* need to create one manually via {@link GetQuerySuggestionsRequest#builder()}
*
*
* @param getQuerySuggestionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.GetQuerySuggestionsRequest.Builder} to create a
* request.
* @return Result of the GetQuerySuggestions operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.GetQuerySuggestions
* @see AWS
* API Documentation
*/
default GetQuerySuggestionsResponse getQuerySuggestions(
Consumer getQuerySuggestionsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException,
ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return getQuerySuggestions(GetQuerySuggestionsRequest.builder().applyMutation(getQuerySuggestionsRequest).build());
}
/**
*
* Retrieves search metrics data. The data provides a snapshot of how your users interact with your search
* application and how effective the application is.
*
*
* @param getSnapshotsRequest
* @return Result of the GetSnapshots operation returned by the service.
* @throws InvalidRequestException
* The input to the request is not valid. Please provide the correct input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.GetSnapshots
* @see AWS API
* Documentation
*/
default GetSnapshotsResponse getSnapshots(GetSnapshotsRequest getSnapshotsRequest) throws InvalidRequestException,
ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves search metrics data. The data provides a snapshot of how your users interact with your search
* application and how effective the application is.
*
*
*
* This is a convenience which creates an instance of the {@link GetSnapshotsRequest.Builder} avoiding the need to
* create one manually via {@link GetSnapshotsRequest#builder()}
*
*
* @param getSnapshotsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest.Builder} to create a request.
* @return Result of the GetSnapshots operation returned by the service.
* @throws InvalidRequestException
* The input to the request is not valid. Please provide the correct input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.GetSnapshots
* @see AWS API
* Documentation
*/
default GetSnapshotsResponse getSnapshots(Consumer getSnapshotsRequest)
throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return getSnapshots(GetSnapshotsRequest.builder().applyMutation(getSnapshotsRequest).build());
}
/**
*
* This is a variant of {@link #getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(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
* {@link #getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)} operation.
*
*
* @param getSnapshotsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidRequestException
* The input to the request is not valid. Please provide the correct input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.GetSnapshots
* @see AWS API
* Documentation
*/
default GetSnapshotsIterable getSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest) throws InvalidRequestException,
ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
return new GetSnapshotsIterable(this, getSnapshotsRequest);
}
/**
*
* This is a variant of {@link #getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(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
* {@link #getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetSnapshotsRequest.Builder} avoiding the need to
* create one manually via {@link GetSnapshotsRequest#builder()}
*
*
* @param getSnapshotsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidRequestException
* The input to the request is not valid. Please provide the correct input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.GetSnapshots
* @see AWS API
* Documentation
*/
default GetSnapshotsIterable getSnapshotsPaginator(Consumer getSnapshotsRequest)
throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return getSnapshotsPaginator(GetSnapshotsRequest.builder().applyMutation(getSnapshotsRequest).build());
}
/**
*
* Lists one or more access control configurations for an index. This includes user and group access information for
* your documents. This is useful for user context filtering, where search results are filtered based on the user or
* their group access to documents.
*
*
* @param listAccessControlConfigurationsRequest
* @return Result of the ListAccessControlConfigurations operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListAccessControlConfigurations
* @see AWS API Documentation
*/
default ListAccessControlConfigurationsResponse listAccessControlConfigurations(
ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest) throws ValidationException,
ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists one or more access control configurations for an index. This includes user and group access information for
* your documents. This is useful for user context filtering, where search results are filtered based on the user or
* their group access to documents.
*
*
*
* This is a convenience which creates an instance of the {@link ListAccessControlConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListAccessControlConfigurationsRequest#builder()}
*
*
* @param listAccessControlConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest.Builder} to
* create a request.
* @return Result of the ListAccessControlConfigurations operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListAccessControlConfigurations
* @see AWS API Documentation
*/
default ListAccessControlConfigurationsResponse listAccessControlConfigurations(
Consumer listAccessControlConfigurationsRequest)
throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listAccessControlConfigurations(ListAccessControlConfigurationsRequest.builder()
.applyMutation(listAccessControlConfigurationsRequest).build());
}
/**
*
* This is a variant of
* {@link #listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client
* .listAccessControlConfigurationsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(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
* {@link #listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)}
* operation.
*
*
* @param listAccessControlConfigurationsRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListAccessControlConfigurations
* @see AWS API Documentation
*/
default ListAccessControlConfigurationsIterable listAccessControlConfigurationsPaginator(
ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest) throws ValidationException,
ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return new ListAccessControlConfigurationsIterable(this, listAccessControlConfigurationsRequest);
}
/**
*
* This is a variant of
* {@link #listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client
* .listAccessControlConfigurationsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(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
* {@link #listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListAccessControlConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListAccessControlConfigurationsRequest#builder()}
*
*
* @param listAccessControlConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest.Builder} to
* create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListAccessControlConfigurations
* @see AWS API Documentation
*/
default ListAccessControlConfigurationsIterable listAccessControlConfigurationsPaginator(
Consumer listAccessControlConfigurationsRequest)
throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest.builder()
.applyMutation(listAccessControlConfigurationsRequest).build());
}
/**
*
* Gets statistics about synchronizing a data source connector.
*
*
* @param listDataSourceSyncJobsRequest
* @return Result of the ListDataSourceSyncJobs operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSourceSyncJobs
* @see AWS
* API Documentation
*/
default ListDataSourceSyncJobsResponse listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets statistics about synchronizing a data source connector.
*
*
*
* This is a convenience which creates an instance of the {@link ListDataSourceSyncJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDataSourceSyncJobsRequest#builder()}
*
*
* @param listDataSourceSyncJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest.Builder} to create a
* request.
* @return Result of the ListDataSourceSyncJobs operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSourceSyncJobs
* @see AWS
* API Documentation
*/
default ListDataSourceSyncJobsResponse listDataSourceSyncJobs(
Consumer listDataSourceSyncJobsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return listDataSourceSyncJobs(ListDataSourceSyncJobsRequest.builder().applyMutation(listDataSourceSyncJobsRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client
* .listDataSourceSyncJobsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(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
* {@link #listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)}
* operation.
*
*
* @param listDataSourceSyncJobsRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSourceSyncJobs
* @see AWS
* API Documentation
*/
default ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(
ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException,
ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return new ListDataSourceSyncJobsIterable(this, listDataSourceSyncJobsRequest);
}
/**
*
* This is a variant of
* {@link #listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client
* .listDataSourceSyncJobsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(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
* {@link #listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDataSourceSyncJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDataSourceSyncJobsRequest#builder()}
*
*
* @param listDataSourceSyncJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest.Builder} to create a
* request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSourceSyncJobs
* @see AWS
* API Documentation
*/
default ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(
Consumer listDataSourceSyncJobsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest.builder()
.applyMutation(listDataSourceSyncJobsRequest).build());
}
/**
*
* Lists the data source connectors that you have created.
*
*
* @param listDataSourcesRequest
* @return Result of the ListDataSources operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSources
* @see AWS API
* Documentation
*/
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws ValidationException,
ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the data source connectors that you have created.
*
*
*
* This is a convenience which creates an instance of the {@link ListDataSourcesRequest.Builder} avoiding the need
* to create one manually via {@link ListDataSourcesRequest#builder()}
*
*
* @param listDataSourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest.Builder} to create a request.
* @return Result of the ListDataSources operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSources
* @see AWS API
* Documentation
*/
default ListDataSourcesResponse listDataSources(Consumer listDataSourcesRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listDataSources(ListDataSourcesRequest.builder().applyMutation(listDataSourcesRequest).build());
}
/**
*
* This is a variant of
* {@link #listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client
* .listDataSourcesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(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
* {@link #listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)} operation.
*
*
* @param listDataSourcesRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSources
* @see AWS API
* Documentation
*/
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return new ListDataSourcesIterable(this, listDataSourcesRequest);
}
/**
*
* This is a variant of
* {@link #listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client
* .listDataSourcesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(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
* {@link #listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDataSourcesRequest.Builder} avoiding the need
* to create one manually via {@link ListDataSourcesRequest#builder()}
*
*
* @param listDataSourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest.Builder} to create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListDataSources
* @see AWS API
* Documentation
*/
default ListDataSourcesIterable listDataSourcesPaginator(Consumer listDataSourcesRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listDataSourcesPaginator(ListDataSourcesRequest.builder().applyMutation(listDataSourcesRequest).build());
}
/**
*
* Lists specific permissions of users and groups with access to your Amazon Kendra experience.
*
*
* @param listEntityPersonasRequest
* @return Result of the ListEntityPersonas operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListEntityPersonas
* @see AWS API
* Documentation
*/
default ListEntityPersonasResponse listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists specific permissions of users and groups with access to your Amazon Kendra experience.
*
*
*
* This is a convenience which creates an instance of the {@link ListEntityPersonasRequest.Builder} avoiding the
* need to create one manually via {@link ListEntityPersonasRequest#builder()}
*
*
* @param listEntityPersonasRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest.Builder} to create a
* request.
* @return Result of the ListEntityPersonas operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListEntityPersonas
* @see AWS API
* Documentation
*/
default ListEntityPersonasResponse listEntityPersonas(Consumer listEntityPersonasRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listEntityPersonas(ListEntityPersonasRequest.builder().applyMutation(listEntityPersonasRequest).build());
}
/**
*
* This is a variant of
* {@link #listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client
* .listEntityPersonasPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(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
* {@link #listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)}
* operation.
*
*
* @param listEntityPersonasRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListEntityPersonas
* @see AWS API
* Documentation
*/
default ListEntityPersonasIterable listEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return new ListEntityPersonasIterable(this, listEntityPersonasRequest);
}
/**
*
* This is a variant of
* {@link #listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client
* .listEntityPersonasPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(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
* {@link #listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListEntityPersonasRequest.Builder} avoiding the
* need to create one manually via {@link ListEntityPersonasRequest#builder()}
*
*
* @param listEntityPersonasRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest.Builder} to create a
* request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListEntityPersonas
* @see AWS API
* Documentation
*/
default ListEntityPersonasIterable listEntityPersonasPaginator(
Consumer listEntityPersonasRequest) throws ValidationException,
ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return listEntityPersonasPaginator(ListEntityPersonasRequest.builder().applyMutation(listEntityPersonasRequest).build());
}
/**
*
* Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
* experience. You can create an Amazon Kendra experience such as a search application. For more information on
* creating a search application experience, see Building a search
* experience with no code.
*
*
* @param listExperienceEntitiesRequest
* @return Result of the ListExperienceEntities operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperienceEntities
* @see AWS
* API Documentation
*/
default ListExperienceEntitiesResponse listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
* experience. You can create an Amazon Kendra experience such as a search application. For more information on
* creating a search application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link ListExperienceEntitiesRequest.Builder} avoiding the
* need to create one manually via {@link ListExperienceEntitiesRequest#builder()}
*
*
* @param listExperienceEntitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest.Builder} to create a
* request.
* @return Result of the ListExperienceEntities operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperienceEntities
* @see AWS
* API Documentation
*/
default ListExperienceEntitiesResponse listExperienceEntities(
Consumer listExperienceEntitiesRequest) throws ValidationException,
ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return listExperienceEntities(ListExperienceEntitiesRequest.builder().applyMutation(listExperienceEntitiesRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client
* .listExperienceEntitiesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of null 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
* {@link #listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)}
* operation.
*
*
* @param listExperienceEntitiesRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperienceEntities
* @see AWS
* API Documentation
*/
default ListExperienceEntitiesIterable listExperienceEntitiesPaginator(
ListExperienceEntitiesRequest listExperienceEntitiesRequest) throws ValidationException, ResourceNotFoundException,
AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
return new ListExperienceEntitiesIterable(this, listExperienceEntitiesRequest);
}
/**
*
* This is a variant of
* {@link #listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client
* .listExperienceEntitiesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of null 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
* {@link #listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListExperienceEntitiesRequest.Builder} avoiding the
* need to create one manually via {@link ListExperienceEntitiesRequest#builder()}
*
*
* @param listExperienceEntitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest.Builder} to create a
* request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperienceEntities
* @see AWS
* API Documentation
*/
default ListExperienceEntitiesIterable listExperienceEntitiesPaginator(
Consumer listExperienceEntitiesRequest) throws ValidationException,
ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return listExperienceEntitiesPaginator(ListExperienceEntitiesRequest.builder()
.applyMutation(listExperienceEntitiesRequest).build());
}
/**
*
* Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search
* application. For more information on creating a search application experience, see Building a search
* experience with no code.
*
*
* @param listExperiencesRequest
* @return Result of the ListExperiences operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperiences
* @see AWS API
* Documentation
*/
default ListExperiencesResponse listExperiences(ListExperiencesRequest listExperiencesRequest) throws ValidationException,
ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search
* application. For more information on creating a search application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link ListExperiencesRequest.Builder} avoiding the need
* to create one manually via {@link ListExperiencesRequest#builder()}
*
*
* @param listExperiencesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListExperiencesRequest.Builder} to create a request.
* @return Result of the ListExperiences operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperiences
* @see AWS API
* Documentation
*/
default ListExperiencesResponse listExperiences(Consumer listExperiencesRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listExperiences(ListExperiencesRequest.builder().applyMutation(listExperiencesRequest).build());
}
/**
*
* This is a variant of
* {@link #listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client
* .listExperiencesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListExperiencesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(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
* {@link #listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)} operation.
*
*
* @param listExperiencesRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperiences
* @see AWS API
* Documentation
*/
default ListExperiencesIterable listExperiencesPaginator(ListExperiencesRequest listExperiencesRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return new ListExperiencesIterable(this, listExperiencesRequest);
}
/**
*
* This is a variant of
* {@link #listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client
* .listExperiencesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListExperiencesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(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
* {@link #listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListExperiencesRequest.Builder} avoiding the need
* to create one manually via {@link ListExperiencesRequest#builder()}
*
*
* @param listExperiencesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListExperiencesRequest.Builder} to create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListExperiences
* @see AWS API
* Documentation
*/
default ListExperiencesIterable listExperiencesPaginator(Consumer listExperiencesRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listExperiencesPaginator(ListExperiencesRequest.builder().applyMutation(listExperiencesRequest).build());
}
/**
*
* Gets a list of FAQ lists associated with an index.
*
*
* @param listFaqsRequest
* @return Result of the ListFaqs operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListFaqs
* @see AWS API
* Documentation
*/
default ListFaqsResponse listFaqs(ListFaqsRequest listFaqsRequest) throws ValidationException, ResourceNotFoundException,
ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of FAQ lists associated with an index.
*
*
*
* This is a convenience which creates an instance of the {@link ListFaqsRequest.Builder} avoiding the need to
* create one manually via {@link ListFaqsRequest#builder()}
*
*
* @param listFaqsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListFaqsRequest.Builder} to create a request.
* @return Result of the ListFaqs operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListFaqs
* @see AWS API
* Documentation
*/
default ListFaqsResponse listFaqs(Consumer listFaqsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return listFaqs(ListFaqsRequest.builder().applyMutation(listFaqsRequest).build());
}
/**
*
* This is a variant of {@link #listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListFaqsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(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
* {@link #listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)} operation.
*
*
* @param listFaqsRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListFaqs
* @see AWS API
* Documentation
*/
default ListFaqsIterable listFaqsPaginator(ListFaqsRequest listFaqsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return new ListFaqsIterable(this, listFaqsRequest);
}
/**
*
* This is a variant of {@link #listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListFaqsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(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
* {@link #listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListFaqsRequest.Builder} avoiding the need to
* create one manually via {@link ListFaqsRequest#builder()}
*
*
* @param listFaqsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListFaqsRequest.Builder} to create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListFaqs
* @see AWS API
* Documentation
*/
default ListFaqsIterable listFaqsPaginator(Consumer listFaqsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return listFaqsPaginator(ListFaqsRequest.builder().applyMutation(listFaqsRequest).build());
}
/**
*
* Lists all your sets of featured results for a given index. Features results are placed above all other results
* for certain queries. If there's an exact match of a query, then one or more specific documents are featured in
* the search results.
*
*
* @param listFeaturedResultsSetsRequest
* @return Result of the ListFeaturedResultsSets operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListFeaturedResultsSets
* @see AWS API Documentation
*/
default ListFeaturedResultsSetsResponse listFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists all your sets of featured results for a given index. Features results are placed above all other results
* for certain queries. If there's an exact match of a query, then one or more specific documents are featured in
* the search results.
*
*
*
* This is a convenience which creates an instance of the {@link ListFeaturedResultsSetsRequest.Builder} avoiding
* the need to create one manually via {@link ListFeaturedResultsSetsRequest#builder()}
*
*
* @param listFeaturedResultsSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListFeaturedResultsSetsRequest.Builder} to create a
* request.
* @return Result of the ListFeaturedResultsSets operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListFeaturedResultsSets
* @see AWS API Documentation
*/
default ListFeaturedResultsSetsResponse listFeaturedResultsSets(
Consumer listFeaturedResultsSetsRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return listFeaturedResultsSets(ListFeaturedResultsSetsRequest.builder().applyMutation(listFeaturedResultsSetsRequest)
.build());
}
/**
*
* Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
*
*
* ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param listGroupsOlderThanOrderingIdRequest
* @return Result of the ListGroupsOlderThanOrderingId operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListGroupsOlderThanOrderingId
* @see AWS API Documentation
*/
default ListGroupsOlderThanOrderingIdResponse listGroupsOlderThanOrderingId(
ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest) throws ValidationException,
ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
*
*
* ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupsOlderThanOrderingIdRequest.Builder}
* avoiding the need to create one manually via {@link ListGroupsOlderThanOrderingIdRequest#builder()}
*
*
* @param listGroupsOlderThanOrderingIdRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest.Builder} to
* create a request.
* @return Result of the ListGroupsOlderThanOrderingId operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListGroupsOlderThanOrderingId
* @see AWS API Documentation
*/
default ListGroupsOlderThanOrderingIdResponse listGroupsOlderThanOrderingId(
Consumer listGroupsOlderThanOrderingIdRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest.builder()
.applyMutation(listGroupsOlderThanOrderingIdRequest).build());
}
/**
*
* This is a variant of
* {@link #listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client
* .listGroupsOlderThanOrderingIdPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(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
* {@link #listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)}
* operation.
*
*
* @param listGroupsOlderThanOrderingIdRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListGroupsOlderThanOrderingId
* @see AWS API Documentation
*/
default ListGroupsOlderThanOrderingIdIterable listGroupsOlderThanOrderingIdPaginator(
ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest) throws ValidationException,
ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return new ListGroupsOlderThanOrderingIdIterable(this, listGroupsOlderThanOrderingIdRequest);
}
/**
*
* This is a variant of
* {@link #listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client
* .listGroupsOlderThanOrderingIdPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(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
* {@link #listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListGroupsOlderThanOrderingIdRequest.Builder}
* avoiding the need to create one manually via {@link ListGroupsOlderThanOrderingIdRequest#builder()}
*
*
* @param listGroupsOlderThanOrderingIdRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest.Builder} to
* create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListGroupsOlderThanOrderingId
* @see AWS API Documentation
*/
default ListGroupsOlderThanOrderingIdIterable listGroupsOlderThanOrderingIdPaginator(
Consumer listGroupsOlderThanOrderingIdRequest)
throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest.builder()
.applyMutation(listGroupsOlderThanOrderingIdRequest).build());
}
/**
*
* Lists the Amazon Kendra indexes that you created.
*
*
* @param listIndicesRequest
* @return Result of the ListIndices operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListIndices
* @see AWS API
* Documentation
*/
default ListIndicesResponse listIndices(ListIndicesRequest listIndicesRequest) throws ValidationException,
ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the Amazon Kendra indexes that you created.
*
*
*
* This is a convenience which creates an instance of the {@link ListIndicesRequest.Builder} avoiding the need to
* create one manually via {@link ListIndicesRequest#builder()}
*
*
* @param listIndicesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListIndicesRequest.Builder} to create a request.
* @return Result of the ListIndices operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListIndices
* @see AWS API
* Documentation
*/
default ListIndicesResponse listIndices(Consumer listIndicesRequest) throws ValidationException,
ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
return listIndices(ListIndicesRequest.builder().applyMutation(listIndicesRequest).build());
}
/**
*
* This is a variant of {@link #listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListIndicesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(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
* {@link #listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)} operation.
*
*
* @param listIndicesRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListIndices
* @see AWS API
* Documentation
*/
default ListIndicesIterable listIndicesPaginator(ListIndicesRequest listIndicesRequest) throws ValidationException,
ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
return new ListIndicesIterable(this, listIndicesRequest);
}
/**
*
* This is a variant of {@link #listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListIndicesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(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
* {@link #listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListIndicesRequest.Builder} avoiding the need to
* create one manually via {@link ListIndicesRequest#builder()}
*
*
* @param listIndicesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListIndicesRequest.Builder} to create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListIndices
* @see AWS API
* Documentation
*/
default ListIndicesIterable listIndicesPaginator(Consumer listIndicesRequest)
throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return listIndicesPaginator(ListIndicesRequest.builder().applyMutation(listIndicesRequest).build());
}
/**
*
* Lists the block lists used for query suggestions for an index.
*
*
* For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
*
*
* ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param listQuerySuggestionsBlockListsRequest
* @return Result of the ListQuerySuggestionsBlockLists operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListQuerySuggestionsBlockLists
* @see AWS API Documentation
*/
default ListQuerySuggestionsBlockListsResponse listQuerySuggestionsBlockLists(
ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the block lists used for query suggestions for an index.
*
*
* For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
*
*
* ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link ListQuerySuggestionsBlockListsRequest.Builder}
* avoiding the need to create one manually via {@link ListQuerySuggestionsBlockListsRequest#builder()}
*
*
* @param listQuerySuggestionsBlockListsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest.Builder} to
* create a request.
* @return Result of the ListQuerySuggestionsBlockLists operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListQuerySuggestionsBlockLists
* @see AWS API Documentation
*/
default ListQuerySuggestionsBlockListsResponse listQuerySuggestionsBlockLists(
Consumer listQuerySuggestionsBlockListsRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest.builder()
.applyMutation(listQuerySuggestionsBlockListsRequest).build());
}
/**
*
* This is a variant of
* {@link #listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client
* .listQuerySuggestionsBlockListsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(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
* {@link #listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)}
* operation.
*
*
* @param listQuerySuggestionsBlockListsRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListQuerySuggestionsBlockLists
* @see AWS API Documentation
*/
default ListQuerySuggestionsBlockListsIterable listQuerySuggestionsBlockListsPaginator(
ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return new ListQuerySuggestionsBlockListsIterable(this, listQuerySuggestionsBlockListsRequest);
}
/**
*
* This is a variant of
* {@link #listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client
* .listQuerySuggestionsBlockListsPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(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
* {@link #listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListQuerySuggestionsBlockListsRequest.Builder}
* avoiding the need to create one manually via {@link ListQuerySuggestionsBlockListsRequest#builder()}
*
*
* @param listQuerySuggestionsBlockListsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest.Builder} to
* create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListQuerySuggestionsBlockLists
* @see AWS API Documentation
*/
default ListQuerySuggestionsBlockListsIterable listQuerySuggestionsBlockListsPaginator(
Consumer listQuerySuggestionsBlockListsRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest.builder()
.applyMutation(listQuerySuggestionsBlockListsRequest).build());
}
/**
*
* Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags
* associated with them.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags
* associated with them.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws ValidationException,
ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Lists the thesauri for an index.
*
*
* @param listThesauriRequest
* @return Result of the ListThesauri operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListThesauri
* @see AWS API
* Documentation
*/
default ListThesauriResponse listThesauri(ListThesauriRequest listThesauriRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the thesauri for an index.
*
*
*
* This is a convenience which creates an instance of the {@link ListThesauriRequest.Builder} avoiding the need to
* create one manually via {@link ListThesauriRequest#builder()}
*
*
* @param listThesauriRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListThesauriRequest.Builder} to create a request.
* @return Result of the ListThesauri operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListThesauri
* @see AWS API
* Documentation
*/
default ListThesauriResponse listThesauri(Consumer listThesauriRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listThesauri(ListThesauriRequest.builder().applyMutation(listThesauriRequest).build());
}
/**
*
* This is a variant of {@link #listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListThesauriResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(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
* {@link #listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)} operation.
*
*
* @param listThesauriRequest
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListThesauri
* @see AWS API
* Documentation
*/
default ListThesauriIterable listThesauriPaginator(ListThesauriRequest listThesauriRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return new ListThesauriIterable(this, listThesauriRequest);
}
/**
*
* This is a variant of {@link #listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
* for (software.amazon.awssdk.services.kendra.model.ListThesauriResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(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
* {@link #listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListThesauriRequest.Builder} avoiding the need to
* create one manually via {@link ListThesauriRequest#builder()}
*
*
* @param listThesauriRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.ListThesauriRequest.Builder} to create a request.
* @return 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 service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.ListThesauri
* @see AWS API
* Documentation
*/
default ListThesauriIterable listThesauriPaginator(Consumer listThesauriRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return listThesauriPaginator(ListThesauriRequest.builder().applyMutation(listThesauriRequest).build());
}
/**
*
* Maps users to their groups so that you only need to provide the user ID when you issue the query.
*
*
* You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub
* groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these
* teams. Only users who work in research and engineering, and therefore belong in the intellectual property group,
* can see top-secret company documents in their search results.
*
*
* This is useful for user context filtering, where search results are filtered based on the user or their group
* access to documents. For more information, see Filtering on user context.
*
*
* If more than five PUT actions for a group are currently processing, a validation exception is
* thrown.
*
*
* @param putPrincipalMappingRequest
* @return Result of the PutPrincipalMapping operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.PutPrincipalMapping
* @see AWS
* API Documentation
*/
default PutPrincipalMappingResponse putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Maps users to their groups so that you only need to provide the user ID when you issue the query.
*
*
* You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub
* groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these
* teams. Only users who work in research and engineering, and therefore belong in the intellectual property group,
* can see top-secret company documents in their search results.
*
*
* This is useful for user context filtering, where search results are filtered based on the user or their group
* access to documents. For more information, see Filtering on user context.
*
*
* If more than five PUT actions for a group are currently processing, a validation exception is
* thrown.
*
*
*
* This is a convenience which creates an instance of the {@link PutPrincipalMappingRequest.Builder} avoiding the
* need to create one manually via {@link PutPrincipalMappingRequest#builder()}
*
*
* @param putPrincipalMappingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.PutPrincipalMappingRequest.Builder} to create a
* request.
* @return Result of the PutPrincipalMapping operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.PutPrincipalMapping
* @see AWS
* API Documentation
*/
default PutPrincipalMappingResponse putPrincipalMapping(
Consumer putPrincipalMappingRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return putPrincipalMapping(PutPrincipalMappingRequest.builder().applyMutation(putPrincipalMappingRequest).build());
}
/**
*
* Searches an index given an input query.
*
*
*
* If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG)
* systems, you can use Amazon Kendra's Retrieve API, which can
* return longer semantically relevant passages. We recommend using the Retrieve API instead of filing
* a service limit increase to increase the Query API document excerpt length.
*
*
*
* You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter
* based on document fields/attributes and faceted search, and filter based on the user or their group access to
* documents. You can also include certain fields in the response that might provide useful additional information.
*
*
* A query response contains three types of results.
*
*
* -
*
* Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be
* highlighted in the excerpt.
*
*
* -
*
* Matching FAQs or questions-answer from your FAQ file.
*
*
* -
*
* Relevant documents. This result type includes an excerpt of the document with the document title. The searched
* terms can be highlighted in the excerpt.
*
*
*
*
* You can specify that the query return only one type of result using the QueryResultTypeFilter
* parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers,
* a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are
* returned.
*
*
* @param queryRequest
* @return Result of the Query operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.Query
* @see AWS API
* Documentation
*/
default QueryResponse query(QueryRequest queryRequest) throws ValidationException, ConflictException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Searches an index given an input query.
*
*
*
* If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG)
* systems, you can use Amazon Kendra's Retrieve API, which can
* return longer semantically relevant passages. We recommend using the Retrieve API instead of filing
* a service limit increase to increase the Query API document excerpt length.
*
*
*
* You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter
* based on document fields/attributes and faceted search, and filter based on the user or their group access to
* documents. You can also include certain fields in the response that might provide useful additional information.
*
*
* A query response contains three types of results.
*
*
* -
*
* Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be
* highlighted in the excerpt.
*
*
* -
*
* Matching FAQs or questions-answer from your FAQ file.
*
*
* -
*
* Relevant documents. This result type includes an excerpt of the document with the document title. The searched
* terms can be highlighted in the excerpt.
*
*
*
*
* You can specify that the query return only one type of result using the QueryResultTypeFilter
* parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers,
* a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are
* returned.
*
*
*
* This is a convenience which creates an instance of the {@link QueryRequest.Builder} avoiding the need to create
* one manually via {@link QueryRequest#builder()}
*
*
* @param queryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.QueryRequest.Builder} to create a request.
* @return Result of the Query operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.Query
* @see AWS API
* Documentation
*/
default QueryResponse query(Consumer queryRequest) throws ValidationException, ConflictException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return query(QueryRequest.builder().applyMutation(queryRequest).build());
}
/**
*
* Retrieves relevant passages or text excerpts given an input query.
*
*
* This API is similar to the Query API. However, by default,
* the Query API only returns excerpt passages of up to 100 token words. With the Retrieve
* API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This
* doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be
* semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your
* documents produce zero passages using the Retrieve API, you can alternatively use the
* Query API and its types of responses.
*
*
* You can also do the following:
*
*
* -
*
* Override boosting at the index level
*
*
* -
*
* Filter based on document fields or attributes
*
*
* -
*
* Filter based on the user or their group access to documents
*
*
* -
*
* View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative
* ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
*
*
*
* Confidence score buckets are currently available only for English.
*
*
*
*
* You can also include certain fields in the response that might provide useful additional information.
*
*
* The Retrieve API shares the number of query capacity
* units that you set for your index. For more information on what's included in a single capacity unit and the
* default base capacity for an index, see Adjusting capacity.
*
*
* @param retrieveRequest
* @return Result of the Retrieve operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.Retrieve
* @see AWS API
* Documentation
*/
default RetrieveResponse retrieve(RetrieveRequest retrieveRequest) throws ValidationException, ConflictException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves relevant passages or text excerpts given an input query.
*
*
* This API is similar to the Query API. However, by default,
* the Query API only returns excerpt passages of up to 100 token words. With the Retrieve
* API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This
* doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be
* semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your
* documents produce zero passages using the Retrieve API, you can alternatively use the
* Query API and its types of responses.
*
*
* You can also do the following:
*
*
* -
*
* Override boosting at the index level
*
*
* -
*
* Filter based on document fields or attributes
*
*
* -
*
* Filter based on the user or their group access to documents
*
*
* -
*
* View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative
* ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
*
*
*
* Confidence score buckets are currently available only for English.
*
*
*
*
* You can also include certain fields in the response that might provide useful additional information.
*
*
* The Retrieve API shares the number of query capacity
* units that you set for your index. For more information on what's included in a single capacity unit and the
* default base capacity for an index, see Adjusting capacity.
*
*
*
* This is a convenience which creates an instance of the {@link RetrieveRequest.Builder} avoiding the need to
* create one manually via {@link RetrieveRequest#builder()}
*
*
* @param retrieveRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.RetrieveRequest.Builder} to create a request.
* @return Result of the Retrieve operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.Retrieve
* @see AWS API
* Documentation
*/
default RetrieveResponse retrieve(Consumer retrieveRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return retrieve(RetrieveRequest.builder().applyMutation(retrieveRequest).build());
}
/**
*
* Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
* Kendra returns a ResourceInUseException exception.
*
*
* Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source
* respository could take up to an hour or more, depending on the number of documents to sync.
*
*
* @param startDataSourceSyncJobRequest
* @return Result of the StartDataSourceSyncJob operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceInUseException
* The resource you want to use is currently in use. Please check you have provided the correct resource and
* try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.StartDataSourceSyncJob
* @see AWS
* API Documentation
*/
default StartDataSourceSyncJobResponse startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
throws ValidationException, ResourceNotFoundException, ResourceInUseException, ThrottlingException,
AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException,
KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
* Kendra returns a ResourceInUseException exception.
*
*
* Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source
* respository could take up to an hour or more, depending on the number of documents to sync.
*
*
*
* This is a convenience which creates an instance of the {@link StartDataSourceSyncJobRequest.Builder} avoiding the
* need to create one manually via {@link StartDataSourceSyncJobRequest#builder()}
*
*
* @param startDataSourceSyncJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.StartDataSourceSyncJobRequest.Builder} to create a
* request.
* @return Result of the StartDataSourceSyncJob operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceInUseException
* The resource you want to use is currently in use. Please check you have provided the correct resource and
* try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.StartDataSourceSyncJob
* @see AWS
* API Documentation
*/
default StartDataSourceSyncJobResponse startDataSourceSyncJob(
Consumer startDataSourceSyncJobRequest) throws ValidationException,
ResourceNotFoundException, ResourceInUseException, ThrottlingException, AccessDeniedException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return startDataSourceSyncJob(StartDataSourceSyncJobRequest.builder().applyMutation(startDataSourceSyncJobRequest)
.build());
}
/**
*
* Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
*
*
* @param stopDataSourceSyncJobRequest
* @return Result of the StopDataSourceSyncJob operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.StopDataSourceSyncJob
* @see AWS
* API Documentation
*/
default StopDataSourceSyncJobResponse stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
*
*
*
* This is a convenience which creates an instance of the {@link StopDataSourceSyncJobRequest.Builder} avoiding the
* need to create one manually via {@link StopDataSourceSyncJobRequest#builder()}
*
*
* @param stopDataSourceSyncJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.StopDataSourceSyncJobRequest.Builder} to create a
* request.
* @return Result of the StopDataSourceSyncJob operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.StopDataSourceSyncJob
* @see AWS
* API Documentation
*/
default StopDataSourceSyncJobResponse stopDataSourceSyncJob(
Consumer stopDataSourceSyncJobRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException,
SdkClientException, KendraException {
return stopDataSourceSyncJob(StopDataSourceSyncJobRequest.builder().applyMutation(stopDataSourceSyncJobRequest).build());
}
/**
*
* Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
*
*
* SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
*
*
* @param submitFeedbackRequest
* @return Result of the SubmitFeedback operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.SubmitFeedback
* @see AWS API
* Documentation
*/
default SubmitFeedbackResponse submitFeedback(SubmitFeedbackRequest submitFeedbackRequest) throws ValidationException,
ResourceUnavailableException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
*
*
* SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link SubmitFeedbackRequest.Builder} avoiding the need to
* create one manually via {@link SubmitFeedbackRequest#builder()}
*
*
* @param submitFeedbackRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.SubmitFeedbackRequest.Builder} to create a request.
* @return Result of the SubmitFeedback operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.SubmitFeedback
* @see AWS API
* Documentation
*/
default SubmitFeedbackResponse submitFeedback(Consumer submitFeedbackRequest)
throws ValidationException, ResourceUnavailableException, ResourceNotFoundException, ThrottlingException,
AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return submitFeedback(SubmitFeedbackRequest.builder().applyMutation(submitFeedbackRequest).build());
}
/**
*
* Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the
* existing value is replaced with the new value.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException,
ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the
* existing value is replaced with the new value.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest) throws ValidationException,
ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes a tag from an index, FAQ, or a data source.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException,
ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Removes a tag from an index, FAQ, or a data source.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates an access control configuration for your documents in an index. This includes user and group access
* information for your documents. This is useful for user context filtering, where search results are filtered
* based on the user or their group access to documents.
*
*
* You can update an access control configuration you created without indexing all of your documents again. For
* example, your index contains top-secret company documents that only certain employees or users should access. You
* created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching
* from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team
* and should no longer have access to top secret documents. You can update the access control configuration to
* re-configure access control for your documents as circumstances change.
*
*
* You call the BatchPutDocument API to apply
* the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3
* bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId
* in the .metadata.json file. Amazon Kendra currently only supports access control configuration for
* S3 data sources and documents indexed using the BatchPutDocument API.
*
*
* @param updateAccessControlConfigurationRequest
* @return Result of the UpdateAccessControlConfiguration operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateAccessControlConfiguration
* @see AWS API Documentation
*/
default UpdateAccessControlConfigurationResponse updateAccessControlConfiguration(
UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest) throws ValidationException,
ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an access control configuration for your documents in an index. This includes user and group access
* information for your documents. This is useful for user context filtering, where search results are filtered
* based on the user or their group access to documents.
*
*
* You can update an access control configuration you created without indexing all of your documents again. For
* example, your index contains top-secret company documents that only certain employees or users should access. You
* created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching
* from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team
* and should no longer have access to top secret documents. You can update the access control configuration to
* re-configure access control for your documents as circumstances change.
*
*
* You call the BatchPutDocument API to apply
* the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3
* bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId
* in the .metadata.json file. Amazon Kendra currently only supports access control configuration for
* S3 data sources and documents indexed using the BatchPutDocument API.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAccessControlConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link UpdateAccessControlConfigurationRequest#builder()}
*
*
* @param updateAccessControlConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateAccessControlConfigurationRequest.Builder} to
* create a request.
* @return Result of the UpdateAccessControlConfiguration operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateAccessControlConfiguration
* @see AWS API Documentation
*/
default UpdateAccessControlConfigurationResponse updateAccessControlConfiguration(
Consumer updateAccessControlConfigurationRequest)
throws ValidationException, ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest.builder()
.applyMutation(updateAccessControlConfigurationRequest).build());
}
/**
*
* Updates an Amazon Kendra data source connector.
*
*
* @param updateDataSourceRequest
* @return Result of the UpdateDataSource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateDataSource
* @see AWS API
* Documentation
*/
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an Amazon Kendra data source connector.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDataSourceRequest.Builder} avoiding the need
* to create one manually via {@link UpdateDataSourceRequest#builder()}
*
*
* @param updateDataSourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateDataSourceRequest.Builder} to create a request.
* @return Result of the UpdateDataSource operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateDataSource
* @see AWS API
* Documentation
*/
default UpdateDataSourceResponse updateDataSource(Consumer updateDataSourceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateDataSource(UpdateDataSourceRequest.builder().applyMutation(updateDataSourceRequest).build());
}
/**
*
* Updates your Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, see Building a search
* experience with no code.
*
*
* @param updateExperienceRequest
* @return Result of the UpdateExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateExperience
* @see AWS API
* Documentation
*/
default UpdateExperienceResponse updateExperience(UpdateExperienceRequest updateExperienceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates your Amazon Kendra experience such as a search application. For more information on creating a search
* application experience, see Building a search
* experience with no code.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateExperienceRequest.Builder} avoiding the need
* to create one manually via {@link UpdateExperienceRequest#builder()}
*
*
* @param updateExperienceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateExperienceRequest.Builder} to create a request.
* @return Result of the UpdateExperience operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateExperience
* @see AWS API
* Documentation
*/
default UpdateExperienceResponse updateExperience(Consumer updateExperienceRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateExperience(UpdateExperienceRequest.builder().applyMutation(updateExperienceRequest).build());
}
/**
*
* Updates a set of featured results. Features results are placed above all other results for certain queries. You
* map specific queries to specific documents for featuring in the results. If a query contains an exact match of a
* query, then one or more specific documents are featured in the search results.
*
*
* @param updateFeaturedResultsSetRequest
* @return Result of the UpdateFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws FeaturedResultsConflictException
* An error message with a list of conflicting queries used across different sets of featured results. This
* occurred with the request for a new featured results set. Check that the queries you specified for
* featured results are unique per featured results set for each index.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateFeaturedResultsSet
* @see AWS API Documentation
*/
default UpdateFeaturedResultsSetResponse updateFeaturedResultsSet(
UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest) throws ResourceNotFoundException,
AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a set of featured results. Features results are placed above all other results for certain queries. You
* map specific queries to specific documents for featuring in the results. If a query contains an exact match of a
* query, then one or more specific documents are featured in the search results.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateFeaturedResultsSetRequest.Builder} avoiding
* the need to create one manually via {@link UpdateFeaturedResultsSetRequest#builder()}
*
*
* @param updateFeaturedResultsSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateFeaturedResultsSetRequest.Builder} to create a
* request.
* @return Result of the UpdateFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws FeaturedResultsConflictException
* An error message with a list of conflicting queries used across different sets of featured results. This
* occurred with the request for a new featured results set. Check that the queries you specified for
* featured results are unique per featured results set for each index.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateFeaturedResultsSet
* @see AWS API Documentation
*/
default UpdateFeaturedResultsSetResponse updateFeaturedResultsSet(
Consumer updateFeaturedResultsSetRequest) throws ResourceNotFoundException,
AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateFeaturedResultsSet(UpdateFeaturedResultsSetRequest.builder().applyMutation(updateFeaturedResultsSetRequest)
.build());
}
/**
*
* Updates an Amazon Kendra index.
*
*
* @param updateIndexRequest
* @return Result of the UpdateIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateIndex
* @see AWS API
* Documentation
*/
default UpdateIndexResponse updateIndex(UpdateIndexRequest updateIndexRequest) throws ValidationException, ConflictException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an Amazon Kendra index.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateIndexRequest.Builder} avoiding the need to
* create one manually via {@link UpdateIndexRequest#builder()}
*
*
* @param updateIndexRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateIndexRequest.Builder} to create a request.
* @return Result of the UpdateIndex operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateIndex
* @see AWS API
* Documentation
*/
default UpdateIndexResponse updateIndex(Consumer updateIndexRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateIndex(UpdateIndexRequest.builder().applyMutation(updateIndexRequest).build());
}
/**
*
* Updates a block list used for query suggestions for an index.
*
*
* Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions
* list to apply any updates to the block list. Other changes not related to the block list apply immediately.
*
*
* If a block list is updating, then you need to wait for the first update to finish before submitting another
* update.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param updateQuerySuggestionsBlockListRequest
* @return Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default UpdateQuerySuggestionsBlockListResponse updateQuerySuggestionsBlockList(
UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a block list used for query suggestions for an index.
*
*
* Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions
* list to apply any updates to the block list. Other changes not related to the block list apply immediately.
*
*
* If a block list is updating, then you need to wait for the first update to finish before submitting another
* update.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateQuerySuggestionsBlockListRequest.Builder}
* avoiding the need to create one manually via {@link UpdateQuerySuggestionsBlockListRequest#builder()}
*
*
* @param updateQuerySuggestionsBlockListRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateQuerySuggestionsBlockListRequest.Builder} to
* create a request.
* @return Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
default UpdateQuerySuggestionsBlockListResponse updateQuerySuggestionsBlockList(
Consumer updateQuerySuggestionsBlockListRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest.builder()
.applyMutation(updateQuerySuggestionsBlockListRequest).build());
}
/**
*
* Updates the settings of query suggestions for an index.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* If an update is currently processing, you need to wait for the update to finish before making another update.
*
*
* Updates to query suggestions settings might not take effect right away. The time for your updated settings to
* take effect depends on the updates made and the number of search queries in your index.
*
*
* You can still enable/disable query suggestions at any time.
*
*
* UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param updateQuerySuggestionsConfigRequest
* @return Result of the UpdateQuerySuggestionsConfig operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateQuerySuggestionsConfig
* @see AWS API Documentation
*/
default UpdateQuerySuggestionsConfigResponse updateQuerySuggestionsConfig(
UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest) throws ValidationException,
ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the settings of query suggestions for an index.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* If an update is currently processing, you need to wait for the update to finish before making another update.
*
*
* Updates to query suggestions settings might not take effect right away. The time for your updated settings to
* take effect depends on the updates made and the number of search queries in your index.
*
*
* You can still enable/disable query suggestions at any time.
*
*
* UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateQuerySuggestionsConfigRequest.Builder}
* avoiding the need to create one manually via {@link UpdateQuerySuggestionsConfigRequest#builder()}
*
*
* @param updateQuerySuggestionsConfigRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateQuerySuggestionsConfigRequest.Builder} to create
* a request.
* @return Result of the UpdateQuerySuggestionsConfig operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateQuerySuggestionsConfig
* @see AWS API Documentation
*/
default UpdateQuerySuggestionsConfigResponse updateQuerySuggestionsConfig(
Consumer updateQuerySuggestionsConfigRequest)
throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest.builder()
.applyMutation(updateQuerySuggestionsConfigRequest).build());
}
/**
*
* Updates a thesaurus for an index.
*
*
* @param updateThesaurusRequest
* @return Result of the UpdateThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateThesaurus
* @see AWS API
* Documentation
*/
default UpdateThesaurusResponse updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest) throws ValidationException,
ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException,
AwsServiceException, SdkClientException, KendraException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a thesaurus for an index.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateThesaurusRequest.Builder} avoiding the need
* to create one manually via {@link UpdateThesaurusRequest#builder()}
*
*
* @param updateThesaurusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kendra.model.UpdateThesaurusRequest.Builder} to create a request.
* @return Result of the UpdateThesaurus operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws InternalServerException
* An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
* and try again, or contact Support for help.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws KendraException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample KendraClient.UpdateThesaurus
* @see AWS API
* Documentation
*/
default UpdateThesaurusResponse updateThesaurus(Consumer updateThesaurusRequest)
throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException,
InternalServerException, AwsServiceException, SdkClientException, KendraException {
return updateThesaurus(UpdateThesaurusRequest.builder().applyMutation(updateThesaurusRequest).build());
}
/**
* Create a {@link KendraClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static KendraClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link KendraClient}.
*/
static KendraClientBuilder builder() {
return new DefaultKendraClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default KendraServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}