AWSkendraClient (AWS Java SDK for AWSKendraFrontend 1.11.704 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.kendra.AWSkendraClient

All Implemented Interfaces:

AWSkendra

Direct Known Subclasses:

AWSkendraAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSkendraClient
extends AmazonWebServiceClient
implements AWSkendra
```
Client for accessing kendra. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Kendra is a service for indexing large document sets.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.kendra.AWSkendra
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchDeleteDocumentResult`	`batchDeleteDocument(BatchDeleteDocumentRequest request)` Removes one or more documents from an index.
`BatchPutDocumentResult`	`batchPutDocument(BatchPutDocumentRequest request)` Adds one or more documents to an index.
`static AWSkendraClientBuilder`	`builder()`
`CreateDataSourceResult`	`createDataSource(CreateDataSourceRequest request)` Creates a data source that you use to with an Amazon Kendra index.
`CreateFaqResult`	`createFaq(CreateFaqRequest request)` Creates an new set of frequently asked question (FAQ) questions and answers.
`CreateIndexResult`	`createIndex(CreateIndexRequest request)` Creates a new Amazon Kendra index.
`DeleteFaqResult`	`deleteFaq(DeleteFaqRequest request)` Removes an FAQ from an index.
`DeleteIndexResult`	`deleteIndex(DeleteIndexRequest request)` Deletes an existing Amazon Kendra index.
`DescribeDataSourceResult`	`describeDataSource(DescribeDataSourceRequest request)` Gets information about a Amazon Kendra data source.
`DescribeFaqResult`	`describeFaq(DescribeFaqRequest request)` Gets information about an FAQ list.
`DescribeIndexResult`	`describeIndex(DescribeIndexRequest request)` 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 request)` Lists the data sources that you have created.
`ListDataSourceSyncJobsResult`	`listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)` Gets statistics about synchronizing Amazon Kendra with a data source.
`ListFaqsResult`	`listFaqs(ListFaqsRequest request)` Gets a list of FAQ lists associated with an index.
`ListIndicesResult`	`listIndices(ListIndicesRequest request)` Lists the Amazon Kendra indexes that you have created.
`QueryResult`	`query(QueryRequest request)` Searches an active index.
`StartDataSourceSyncJobResult`	`startDataSourceSyncJob(StartDataSourceSyncJobRequest request)` Starts a synchronization job for a data source.
`StopDataSourceSyncJobResult`	`stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)` Stops a running synchronization job.
`SubmitFeedbackResult`	`submitFeedback(SubmitFeedbackRequest request)` Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest request)` Updates an existing Amazon Kendra data source.
`UpdateIndexResult`	`updateIndex(UpdateIndexRequest request)` Updates an existing Amazon Kendra index.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.kendra.AWSkendra
shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AWSkendraClientBuilder builder()
```
  - batchDeleteDocument
```
public BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest request)
```
    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.
    
    Specified by:
    
    batchDeleteDocument in interface AWSkendra
    
    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
```
public BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest request)
```
    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.
    
    Specified by:
    
    batchPutDocument in interface AWSkendra
    
    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
```
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
```
    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.
    
    Specified by:
    
    createDataSource in interface AWSkendra
    
    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
```
public CreateFaqResult createFaq(CreateFaqRequest request)
```
    Creates an new set of frequently asked question (FAQ) questions and answers.
    
    Specified by:
    
    createFaq in interface AWSkendra
    
    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
```
public CreateIndexResult createIndex(CreateIndexRequest request)
```
    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.
    
    Specified by:
    
    createIndex in interface AWSkendra
    
    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
```
public DeleteFaqResult deleteFaq(DeleteFaqRequest request)
```
    Removes an FAQ from an index.
    
    Specified by:
    
    deleteFaq in interface AWSkendra
    
    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
```
public DeleteIndexResult deleteIndex(DeleteIndexRequest request)
```
    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.
    
    Specified by:
    
    deleteIndex in interface AWSkendra
    
    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
```
public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
```
    Gets information about a Amazon Kendra data source.
    
    Specified by:
    
    describeDataSource in interface AWSkendra
    
    Parameters:
    
    describeDataSourceRequest -
    
    Returns:
    
    Result of the DescribeDataSource operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeFaq
```
public DescribeFaqResult describeFaq(DescribeFaqRequest request)
```
    Gets information about an FAQ list.
    
    Specified by:
    
    describeFaq in interface AWSkendra
    
    Parameters:
    
    describeFaqRequest -
    
    Returns:
    
    Result of the DescribeFaq operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeIndex
```
public DescribeIndexResult describeIndex(DescribeIndexRequest request)
```
    Describes an existing Amazon Kendra index
    
    Specified by:
    
    describeIndex in interface AWSkendra
    
    Parameters:
    
    describeIndexRequest -
    
    Returns:
    
    Result of the DescribeIndex operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listDataSourceSyncJobs
```
public ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
```
    Gets statistics about synchronizing Amazon Kendra with a data source.
    
    Specified by:
    
    listDataSourceSyncJobs in interface AWSkendra
    
    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
```
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
```
    Lists the data sources that you have created.
    
    Specified by:
    
    listDataSources in interface AWSkendra
    
    Parameters:
    
    listDataSourcesRequest -
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ThrottlingException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listFaqs
```
public ListFaqsResult listFaqs(ListFaqsRequest request)
```
    Gets a list of FAQ lists associated with an index.
    
    Specified by:
    
    listFaqs in interface AWSkendra
    
    Parameters:
    
    listFaqsRequest -
    
    Returns:
    
    Result of the ListFaqs operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listIndices
```
public ListIndicesResult listIndices(ListIndicesRequest request)
```
    Lists the Amazon Kendra indexes that you have created.
    
    Specified by:
    
    listIndices in interface AWSkendra
    
    Parameters:
    
    listIndicesRequest -
    
    Returns:
    
    Result of the ListIndices operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - query
```
public QueryResult query(QueryRequest request)
```
    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.
    Specified by:
    
    query in interface AWSkendra
    
    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
```
public StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
```
    Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
    
    Specified by:
    
    startDataSourceSyncJob in interface AWSkendra
    
    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
```
public StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
```
    Stops a running synchronization job. You can't stop a scheduled synchronization job.
    
    Specified by:
    
    stopDataSourceSyncJob in interface AWSkendra
    
    Parameters:
    
    stopDataSourceSyncJobRequest -
    
    Returns:
    
    Result of the StopDataSourceSyncJob operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - submitFeedback
```
public SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest request)
```
    Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
    
    Specified by:
    
    submitFeedback in interface AWSkendra
    
    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
```
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
```
    Updates an existing Amazon Kendra data source.
    
    Specified by:
    
    updateDataSource in interface AWSkendra
    
    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
```
public UpdateIndexResult updateIndex(UpdateIndexRequest request)
```
    Updates an existing Amazon Kendra index.
    
    Specified by:
    
    updateIndex in interface AWSkendra
    
    Parameters:
    
    updateIndexRequest -
    
    Returns:
    
    Result of the UpdateIndex operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSkendra
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AWSkendraClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.kendra.AWSkendra

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.kendra.AWSkendra

Field Detail

configFactory

Method Detail

builder

batchDeleteDocument

batchPutDocument

createDataSource

createFaq

createIndex

deleteFaq

deleteIndex

describeDataSource

describeFaq

describeIndex

listDataSourceSyncJobs

listDataSources

listFaqs

listIndices

query

startDataSourceSyncJob

stopDataSourceSyncJob

submitFeedback

updateDataSource

updateIndex

getCachedResponseMetadata