AWSkendra (AWS SDK for Java

All Known Subinterfaces:

AWSkendraAsync

All Known Implementing Classes:

AbstractAWSkendra, AbstractAWSkendraAsync, AWSkendraAsyncClient, AWSkendraClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSkendra
```
Interface for accessing kendra.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSkendra instead.

Amazon Kendra is a service for indexing large document sets.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchDeleteDocumentResult`	`batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)` Removes one or more documents from an index.
`BatchPutDocumentResult`	`batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)` Adds one or more documents to an index.
`CreateDataSourceResult`	`createDataSource(CreateDataSourceRequest createDataSourceRequest)` Creates a data source that you use to with an Amazon Kendra index.
`CreateFaqResult`	`createFaq(CreateFaqRequest createFaqRequest)` Creates an new set of frequently asked question (FAQ) questions and answers.
`CreateIndexResult`	`createIndex(CreateIndexRequest createIndexRequest)` Creates a new Amazon Kendra index.
`DeleteFaqResult`	`deleteFaq(DeleteFaqRequest deleteFaqRequest)` Removes an FAQ from an index.
`DeleteIndexResult`	`deleteIndex(DeleteIndexRequest deleteIndexRequest)` Deletes an existing Amazon Kendra index.
`DescribeDataSourceResult`	`describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)` Gets information about a Amazon Kendra data source.
`DescribeFaqResult`	`describeFaq(DescribeFaqRequest describeFaqRequest)` Gets information about an FAQ list.
`DescribeIndexResult`	`describeIndex(DescribeIndexRequest describeIndexRequest)` Describes an existing Amazon Kendra index
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest listDataSourcesRequest)` Lists the data sources that you have created.
`ListDataSourceSyncJobsResult`	`listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)` Gets statistics about synchronizing Amazon Kendra with a data source.
`ListFaqsResult`	`listFaqs(ListFaqsRequest listFaqsRequest)` Gets a list of FAQ lists associated with an index.
`ListIndicesResult`	`listIndices(ListIndicesRequest listIndicesRequest)` Lists the Amazon Kendra indexes that you have created.
`QueryResult`	`query(QueryRequest queryRequest)` Searches an active index.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDataSourceSyncJobResult`	`startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)` Starts a synchronization job for a data source.
`StopDataSourceSyncJobResult`	`stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)` Stops a running synchronization job.
`SubmitFeedbackResult`	`submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)` Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)` Updates an existing Amazon Kendra data source.
`UpdateIndexResult`	`updateIndex(UpdateIndexRequest updateIndexRequest)` Updates an existing Amazon Kendra index.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchDeleteDocument
```
BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
```
    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.
    
    Parameters:
    
    batchDeleteDocumentRequest -
    
    Returns:
    
    Result of the BatchDeleteDocument operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - batchPutDocument
```
BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
```
    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.
    
    Parameters:
    
    batchPutDocumentRequest -
    
    Returns:
    
    Result of the BatchPutDocument operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - createDataSource
```
CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest)
```
    Creates a data source that you use to with an Amazon Kendra index.
    
    You specify a name, connector type and description for your data source. You can choose between an S3 connector, a SharePoint Online connector, and a database connector.
    
    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.
    
    Parameters:
    
    createDataSourceRequest -
    
    Returns:
    
    Result of the CreateDataSource operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ResourceAlreadyExistException
    
    ServiceQuotaExceededException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - createFaq
```
CreateFaqResult createFaq(CreateFaqRequest createFaqRequest)
```
    Creates an new set of frequently asked question (FAQ) questions and answers.
    
    Parameters:
    
    createFaqRequest -
    
    Returns:
    
    Result of the CreateFaq operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    ServiceQuotaExceededException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - createIndex
```
CreateIndexResult createIndex(CreateIndexRequest createIndexRequest)
```
    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.
    
    Parameters:
    
    createIndexRequest -
    
    Returns:
    
    Result of the CreateIndex operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceAlreadyExistException
    
    ServiceQuotaExceededException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - deleteFaq
```
DeleteFaqResult deleteFaq(DeleteFaqRequest deleteFaqRequest)
```
    Removes an FAQ from an index.
    
    Parameters:
    
    deleteFaqRequest -
    
    Returns:
    
    Result of the DeleteFaq operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - deleteIndex
```
DeleteIndexResult deleteIndex(DeleteIndexRequest deleteIndexRequest)
```
    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.
    
    Parameters:
    
    deleteIndexRequest -
    
    Returns:
    
    Result of the DeleteIndex operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeDataSource
```
DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
```
    Gets information about a Amazon Kendra data source.
    
    Parameters:
    
    describeDataSourceRequest -
    
    Returns:
    
    Result of the DescribeDataSource operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeFaq
```
DescribeFaqResult describeFaq(DescribeFaqRequest describeFaqRequest)
```
    Gets information about an FAQ list.
    
    Parameters:
    
    describeFaqRequest -
    
    Returns:
    
    Result of the DescribeFaq operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeIndex
```
DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest)
```
    Describes an existing Amazon Kendra index
    
    Parameters:
    
    describeIndexRequest -
    
    Returns:
    
    Result of the DescribeIndex operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listDataSourceSyncJobs
```
ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
```
    Gets statistics about synchronizing Amazon Kendra with a data source.
    
    Parameters:
    
    listDataSourceSyncJobsRequest -
    
    Returns:
    
    Result of the ListDataSourceSyncJobs operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ConflictException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listDataSources
```
ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)
```
    Lists the data sources that you have created.
    
    Parameters:
    
    listDataSourcesRequest -
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ThrottlingException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listFaqs
```
ListFaqsResult listFaqs(ListFaqsRequest listFaqsRequest)
```
    Gets a list of FAQ lists associated with an index.
    
    Parameters:
    
    listFaqsRequest -
    
    Returns:
    
    Result of the ListFaqs operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listIndices
```
ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest)
```
    Lists the Amazon Kendra indexes that you have created.
    
    Parameters:
    
    listIndicesRequest -
    
    Returns:
    
    Result of the ListIndices operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - query
```
QueryResult query(QueryRequest queryRequest)
```
    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.
    Parameters:
    
    queryRequest -
    
    Returns:
    
    Result of the Query operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - startDataSourceSyncJob
```
StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
```
    Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
    
    Parameters:
    
    startDataSourceSyncJobRequest -
    
    Returns:
    
    Result of the StartDataSourceSyncJob operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ResourceInUseException
    
    ThrottlingException
    
    AccessDeniedException
    
    ConflictException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - stopDataSourceSyncJob
```
StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
```
    Stops a running synchronization job. You can't stop a scheduled synchronization job.
    
    Parameters:
    
    stopDataSourceSyncJobRequest -
    
    Returns:
    
    Result of the StopDataSourceSyncJob operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - submitFeedback
```
SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
```
    Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
    
    Parameters:
    
    submitFeedbackRequest -
    
    Returns:
    
    Result of the SubmitFeedback operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceUnavailableException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - updateDataSource
```
UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
```
    Updates an existing Amazon Kendra data source.
    
    Parameters:
    
    updateDataSourceRequest -
    
    Returns:
    
    Result of the UpdateDataSource operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - updateIndex
```
UpdateIndexResult updateIndex(UpdateIndexRequest updateIndexRequest)
```
    Updates an existing Amazon Kendra index.
    
    Parameters:
    
    updateIndexRequest -
    
    Returns:
    
    Result of the UpdateIndex operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSkendra

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchDeleteDocument

batchPutDocument

createDataSource

createFaq

createIndex

deleteFaq

deleteIndex

describeDataSource

describeFaq

describeIndex

listDataSourceSyncJobs

listDataSources

listFaqs

listIndices

query

startDataSourceSyncJob

stopDataSourceSyncJob

submitFeedback

updateDataSource

updateIndex

shutdown

getCachedResponseMetadata