@Generated(value="software.amazon.awssdk:codegen") public interface KendraClient extends SdkClient
builder() method.
Amazon Kendra is a service for indexing large document sets.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchDeleteDocumentResponse |
batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default BatchDeleteDocumentResponse |
batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default BatchPutDocumentResponse |
batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
|
default BatchPutDocumentResponse |
batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)
Adds one or more documents to an index.
|
static KendraClientBuilder |
builder()
Create a builder that can be used to configure and create a
KendraClient. |
static KendraClient |
create()
Create a
KendraClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDataSourceResponse |
createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
Creates a data source that you use to with an Amazon Kendra index.
|
default CreateDataSourceResponse |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source that you use to with an Amazon Kendra index.
|
default CreateFaqResponse |
createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
|
default CreateFaqResponse |
createFaq(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
|
default CreateIndexResponse |
createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)
Creates a new Amazon Kendra index.
|
default CreateIndexResponse |
createIndex(CreateIndexRequest createIndexRequest)
Creates a new Amazon Kendra index.
|
default DeleteDataSourceResponse |
deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes an Amazon Kendra data source.
|
default DeleteDataSourceResponse |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source.
|
default DeleteFaqResponse |
deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)
Removes an FAQ from an index.
|
default DeleteFaqResponse |
deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
|
default DeleteIndexResponse |
deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default DeleteIndexResponse |
deleteIndex(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default DescribeDataSourceResponse |
describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
|
default DescribeDataSourceResponse |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
|
default DescribeFaqResponse |
describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)
Gets information about an FAQ list.
|
default DescribeFaqResponse |
describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
|
default DescribeIndexResponse |
describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)
Describes an existing Amazon Kendra index
|
default DescribeIndexResponse |
describeIndex(DescribeIndexRequest describeIndexRequest)
Describes an existing Amazon Kendra index
|
default ListDataSourcesResponse |
listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data sources that you have created.
|
default ListDataSourcesResponse |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data sources that you have created.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
|
default ListDataSourceSyncJobsResponse |
listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default ListDataSourceSyncJobsResponse |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default ListDataSourceSyncJobsIterable |
listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default ListDataSourceSyncJobsIterable |
listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default ListFaqsResponse |
listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListFaqsResponse |
listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListIndicesResponse |
listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default ListIndicesResponse |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default ListIndicesIterable |
listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default ListIndicesIterable |
listIndicesPaginator(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default QueryResponse |
query(Consumer<QueryRequest.Builder> queryRequest)
Searches an active index.
|
default QueryResponse |
query(QueryRequest queryRequest)
Searches an active index.
|
static ServiceMetadata |
serviceMetadata() |
default StartDataSourceSyncJobResponse |
startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)
Starts a synchronization job for a data source.
|
default StartDataSourceSyncJobResponse |
startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source.
|
default StopDataSourceSyncJobResponse |
stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)
Stops a running synchronization job.
|
default StopDataSourceSyncJobResponse |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a running synchronization job.
|
default SubmitFeedbackResponse |
submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
|
default SubmitFeedbackResponse |
submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default UpdateDataSourceResponse |
updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
|
default UpdateDataSourceResponse |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
|
default UpdateIndexResponse |
updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)
Updates an existing Amazon Kendra index.
|
default UpdateIndexResponse |
updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
|
serviceNameclosestatic final String SERVICE_NAME
static KendraClient create()
KendraClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KendraClientBuilder builder()
KendraClient.default BatchDeleteDocumentResponse batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.
The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages releated to the processing of the batch are sent to you CloudWatch log.
batchDeleteDocumentRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeleteDocumentResponse batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.
The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages releated to the processing of the batch are sent to you CloudWatch log.
This is a convenience which creates an instance of the BatchDeleteDocumentRequest.Builder avoiding the
need to create one manually via BatchDeleteDocumentRequest.builder()
batchDeleteDocumentRequest - A Consumer that will call methods on BatchDeleteDocumentRequest.Builder to create a
request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchPutDocumentResponse batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Adds one or more documents to an index.
The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored
in an Amazon S3 bucket. Use this operation 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 AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.
batchPutDocumentRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchPutDocumentResponse batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Adds one or more documents to an index.
The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored
in an Amazon S3 bucket. Use this operation 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 AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.
This is a convenience which creates an instance of the BatchPutDocumentRequest.Builder avoiding the need
to create one manually via BatchPutDocumentRequest.builder()
batchPutDocumentRequest - A Consumer that will call methods on BatchPutDocumentRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a data source that you use to with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
successfully created. Otherwise, an exception is raised.
createDataSourceRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a data source that you use to with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
successfully created. Otherwise, an exception is raised.
This is a convenience which creates an instance of the CreateDataSourceRequest.Builder avoiding the need
to create one manually via CreateDataSourceRequest.builder()
createDataSourceRequest - A Consumer that will call methods on CreateDataSourceRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFaqResponse createFaq(CreateFaqRequest createFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaqRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFaqResponse createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates an new set of frequently asked question (FAQ) questions and answers.
This is a convenience which creates an instance of the CreateFaqRequest.Builder avoiding the need to
create one manually via CreateFaqRequest.builder()
createFaqRequest - A Consumer that will call methods on CreateFaqRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws ValidationException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation
has completed, check the Status field returned from a call to . 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 operation or using one of the supported data sources.
createIndexRequest - ValidationExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateIndexResponse createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest) throws ValidationException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation
has completed, check the Status field returned from a call to . 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 operation or using one of the supported data sources.
This is a convenience which creates an instance of the CreateIndexRequest.Builder avoiding the need to
create one manually via CreateIndexRequest.builder()
createIndexRequest - A Consumer that will call methods on CreateIndexRequest.Builder to create a request.ValidationExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an Amazon Kendra data source. 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 operation is set
to DELETING. For more information, see Deleting Data Sources.
deleteDataSourceRequest - AccessDeniedExceptionValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an Amazon Kendra data source. 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 operation is set
to DELETING. For more information, see Deleting Data Sources.
This is a convenience which creates an instance of the DeleteDataSourceRequest.Builder avoiding the need
to create one manually via DeleteDataSourceRequest.builder()
deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.AccessDeniedExceptionValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFaqResponse deleteFaq(DeleteFaqRequest deleteFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes an FAQ from an index.
deleteFaqRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFaqResponse deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes an FAQ from an index.
This is a convenience which creates an instance of the DeleteFaqRequest.Builder avoiding the need to
create one manually via DeleteFaqRequest.builder()
deleteFaqRequest - A Consumer that will call methods on DeleteFaqRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an existing 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
operation is set to DELETING.
deleteIndexRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIndexResponse deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an existing 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
operation is set to DELETING.
This is a convenience which creates an instance of the DeleteIndexRequest.Builder avoiding the need to
create one manually via DeleteIndexRequest.builder()
deleteIndexRequest - A Consumer that will call methods on DeleteIndexRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSourceResponse describeDataSource(DescribeDataSourceRequest describeDataSourceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about a Amazon Kendra data source.
describeDataSourceRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSourceResponse describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about a Amazon Kendra data source.
This is a convenience which creates an instance of the DescribeDataSourceRequest.Builder avoiding the
need to create one manually via DescribeDataSourceRequest.builder()
describeDataSourceRequest - A Consumer that will call methods on DescribeDataSourceRequest.Builder to create a
request.ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFaqResponse describeFaq(DescribeFaqRequest describeFaqRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an FAQ list.
describeFaqRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFaqResponse describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an FAQ list.
This is a convenience which creates an instance of the DescribeFaqRequest.Builder avoiding the need to
create one manually via DescribeFaqRequest.builder()
describeFaqRequest - A Consumer that will call methods on DescribeFaqRequest.Builder to create a request.ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeIndexResponse describeIndex(DescribeIndexRequest describeIndexRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Describes an existing Amazon Kendra index
describeIndexRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeIndexResponse describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Describes an existing Amazon Kendra index
This is a convenience which creates an instance of the DescribeIndexRequest.Builder avoiding the need to
create one manually via DescribeIndexRequest.builder()
describeIndexRequest - A Consumer that will call methods on DescribeIndexRequest.Builder to create a request.ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsResponse listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsResponse listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing Amazon Kendra with a data source.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a
request.ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing Amazon Kendra with a data source.
This is a variant of
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
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
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
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
listDataSourceSyncJobsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing Amazon Kendra with a data source.
This is a variant of
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
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
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
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a
request.ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data sources that you have created.
listDataSourcesRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data sources that you have created.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data sources that you have created.
This is a variant of
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
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
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
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
listDataSourcesRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data sources that you have created.
This is a variant of
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
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
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
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFaqsResponse listFaqs(ListFaqsRequest listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of FAQ lists associated with an index.
listFaqsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFaqsResponse listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of FAQ lists associated with an index.
This is a convenience which creates an instance of the ListFaqsRequest.Builder avoiding the need to
create one manually via ListFaqsRequest.builder()
listFaqsRequest - A Consumer that will call methods on ListFaqsRequest.Builder to create a request.ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesResponse listIndices(ListIndicesRequest listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you have created.
listIndicesRequest - ValidationExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesResponse listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you have created.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.ValidationExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesIterable listIndicesPaginator(ListIndicesRequest listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you have created.
This is a variant of 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
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
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
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
listIndicesRequest - ValidationExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesIterable listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you have created.
This is a variant of 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
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
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
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.ValidationExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceRequest - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault QueryResponse query(QueryRequest queryRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Searches an active index. Use this API to search your documents using query. The Query operation
enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig
parameter.
Each query returns the 100 most relevant results.
queryRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault QueryResponse query(Consumer<QueryRequest.Builder> queryRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Searches an active index. Use this API to search your documents using query. The Query operation
enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig
parameter.
Each query returns the 100 most relevant results.
This is a convenience which creates an instance of the QueryRequest.Builder avoiding the need to create
one manually via QueryRequest.builder()
queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartDataSourceSyncJobResponse startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException exception.
startDataSourceSyncJobRequest - ValidationExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartDataSourceSyncJobResponse startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException exception.
This is a convenience which creates an instance of the StartDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StartDataSourceSyncJobRequest.builder()
startDataSourceSyncJobRequest - A Consumer that will call methods on StartDataSourceSyncJobRequest.Builder to create a
request.ValidationExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopDataSourceSyncJobResponse stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopDataSourceSyncJobResponse stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Stops a running synchronization job. You can't stop a scheduled synchronization job.
This is a convenience which creates an instance of the StopDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StopDataSourceSyncJobRequest.builder()
stopDataSourceSyncJobRequest - A Consumer that will call methods on StopDataSourceSyncJobRequest.Builder to create a
request.ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SubmitFeedbackResponse submitFeedback(SubmitFeedbackRequest submitFeedbackRequest) throws ValidationException, ResourceUnavailableException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
submitFeedbackRequest - ValidationExceptionResourceUnavailableExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SubmitFeedbackResponse submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest) throws ValidationException, ResourceUnavailableException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
This is a convenience which creates an instance of the SubmitFeedbackRequest.Builder avoiding the need to
create one manually via SubmitFeedbackRequest.builder()
submitFeedbackRequest - A Consumer that will call methods on SubmitFeedbackRequest.Builder to create a request.ValidationExceptionResourceUnavailableExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
tagResourceRequest - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes a tag from an index, FAQ, or a data source.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra data source.
updateDataSourceRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra data source.
This is a convenience which creates an instance of the UpdateDataSourceRequest.Builder avoiding the need
to create one manually via UpdateDataSourceRequest.builder()
updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIndexResponse updateIndex(UpdateIndexRequest updateIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra index.
updateIndexRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIndexResponse updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra index.
This is a convenience which creates an instance of the UpdateIndexRequest.Builder avoiding the need to
create one manually via UpdateIndexRequest.builder()
updateIndexRequest - A Consumer that will call methods on UpdateIndexRequest.Builder to create a request.ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.