AWSkendraClient (AWS Java SDK for AWSKendraFrontend 1.12.118 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.
`BatchGetDocumentStatusResult`	`batchGetDocumentStatus(BatchGetDocumentStatusRequest request)` Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.
`BatchPutDocumentResult`	`batchPutDocument(BatchPutDocumentRequest request)` Adds one or more documents to an index.
`static AWSkendraClientBuilder`	`builder()`
`ClearQuerySuggestionsResult`	`clearQuerySuggestions(ClearQuerySuggestionsRequest request)` Clears existing query suggestions from an index.
`CreateDataSourceResult`	`createDataSource(CreateDataSourceRequest request)` Creates a data source that you want to use 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.
`CreateQuerySuggestionsBlockListResult`	`createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest request)` Creates a block list to exlcude certain queries from suggestions.
`CreateThesaurusResult`	`createThesaurus(CreateThesaurusRequest request)` Creates a thesaurus for an index.
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest request)` Deletes an Amazon Kendra data source.
`DeleteFaqResult`	`deleteFaq(DeleteFaqRequest request)` Removes an FAQ from an index.
`DeleteIndexResult`	`deleteIndex(DeleteIndexRequest request)` Deletes an existing Amazon Kendra index.
`DeletePrincipalMappingResult`	`deletePrincipalMapping(DeletePrincipalMappingRequest request)` Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
`DeleteQuerySuggestionsBlockListResult`	`deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest request)` Deletes a block list used for query suggestions for an index.
`DeleteThesaurusResult`	`deleteThesaurus(DeleteThesaurusRequest request)` Deletes an existing Amazon Kendra thesaurus.
`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
`DescribePrincipalMappingResult`	`describePrincipalMapping(DescribePrincipalMappingRequest request)` Describes the processing of `PUT` and `DELETE` actions for mapping users to their groups.
`DescribeQuerySuggestionsBlockListResult`	`describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest request)` Describes a block list used for query suggestions for an index.
`DescribeQuerySuggestionsConfigResult`	`describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest request)` Describes the settings of query suggestions for an index.
`DescribeThesaurusResult`	`describeThesaurus(DescribeThesaurusRequest request)` Describes an existing Amazon Kendra thesaurus.
`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.
`GetQuerySuggestionsResult`	`getQuerySuggestions(GetQuerySuggestionsRequest request)` Fetches the queries that are suggested to your users.
`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.
`ListGroupsOlderThanOrderingIdResult`	`listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest request)` Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
`ListIndicesResult`	`listIndices(ListIndicesRequest request)` Lists the Amazon Kendra indexes that you have created.
`ListQuerySuggestionsBlockListsResult`	`listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest request)` Lists the block lists used for query suggestions for an index.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Gets a list of tags associated with a specified resource.
`ListThesauriResult`	`listThesauri(ListThesauriRequest request)` Lists the Amazon Kendra thesauri associated with an index.
`PutPrincipalMappingResult`	`putPrincipalMapping(PutPrincipalMappingRequest request)` Maps users to their groups so that you only need to provide the user ID when you issue the query.
`QueryResult`	`query(QueryRequest request)` Searches an active index.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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 your index.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds the specified tag to the specified index, FAQ, or data source resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag from an index, FAQ, or a data source.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest request)` Updates an existing Amazon Kendra data source.
`UpdateIndexResult`	`updateIndex(UpdateIndexRequest request)` Updates an existing Amazon Kendra index.
`UpdateQuerySuggestionsBlockListResult`	`updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest request)` Updates a block list used for query suggestions for an index.
`UpdateQuerySuggestionsConfigResult`	`updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest request)` Updates the settings of query suggestions for an index.
`UpdateThesaurusResult`	`updateThesaurus(UpdateThesaurusRequest request)` Updates a thesaurus file associated with an 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, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

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

- 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 Amazon Web Services CloudWatch. Any error messages related 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
  - batchGetDocumentStatus
```
public BatchGetDocumentStatusResult batchGetDocumentStatus(BatchGetDocumentStatusRequest request)
```
    Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.
    
    When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.
    
    You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
    
    Specified by:
    
    batchGetDocumentStatus in interface AWSkendra
    
    Parameters:
    
    batchGetDocumentStatusRequest -
    
    Returns:
    
    Result of the BatchGetDocumentStatus 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 Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services 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
  - clearQuerySuggestions
```
public ClearQuerySuggestionsResult clearQuerySuggestions(ClearQuerySuggestionsRequest request)
```
    Clears existing query suggestions from an index.
    
    This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
    
    Specified by:
    
    clearQuerySuggestions in interface AWSkendra
    
    Parameters:
    
    clearQuerySuggestionsRequest -
    
    Returns:
    
    Result of the ClearQuerySuggestions operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    ConflictException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - createDataSource
```
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
```
    Creates a data source that you want to use with an Amazon Kendra index.
    
    You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
    
    CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
    
    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 DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
    
    Once the index is active you can index your documents using the BatchPutDocument 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
    
    ConflictException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - createQuerySuggestionsBlockList
```
public CreateQuerySuggestionsBlockListResult createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest request)
```
    Creates a block list to exlcude certain queries from suggestions.
    
    Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
    
    You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
    
    For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
    
    Specified by:
    
    createQuerySuggestionsBlockList in interface AWSkendra
    
    Parameters:
    
    createQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the CreateQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    ConflictException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - createThesaurus
```
public CreateThesaurusResult createThesaurus(CreateThesaurusRequest request)
```
    Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
    
    Specified by:
    
    createThesaurus in interface AWSkendra
    
    Parameters:
    
    createThesaurusRequest -
    
    Returns:
    
    Result of the CreateThesaurus operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    ServiceQuotaExceededException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - deleteDataSource
```
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
```
    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 DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources.
    
    Specified by:
    
    deleteDataSource in interface AWSkendra
    
    Parameters:
    
    deleteDataSourceRequest -
    
    Returns:
    
    Result of the DeleteDataSource operation returned by the service.
    
    Throws:
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    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
  - deletePrincipalMapping
```
public DeletePrincipalMappingResult deletePrincipalMapping(DeletePrincipalMappingRequest request)
```
    Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
    
    For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
    
    If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.
    
    Specified by:
    
    deletePrincipalMapping in interface AWSkendra
    
    Parameters:
    
    deletePrincipalMappingRequest -
    
    Returns:
    
    Result of the DeletePrincipalMapping operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - deleteQuerySuggestionsBlockList
```
public DeleteQuerySuggestionsBlockListResult deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest request)
```
    Deletes a block list used for query suggestions for an index.
    
    A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
    
    Specified by:
    
    deleteQuerySuggestionsBlockList in interface AWSkendra
    
    Parameters:
    
    deleteQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ConflictException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - deleteThesaurus
```
public DeleteThesaurusResult deleteThesaurus(DeleteThesaurusRequest request)
```
    Deletes an existing Amazon Kendra thesaurus.
    
    Specified by:
    
    deleteThesaurus in interface AWSkendra
    
    Parameters:
    
    deleteThesaurusRequest -
    
    Returns:
    
    Result of the DeleteThesaurus 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
  - describePrincipalMapping
```
public DescribePrincipalMappingResult describePrincipalMapping(DescribePrincipalMappingRequest request)
```
    Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.
    
    Specified by:
    
    describePrincipalMapping in interface AWSkendra
    
    Parameters:
    
    describePrincipalMappingRequest -
    
    Returns:
    
    Result of the DescribePrincipalMapping operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeQuerySuggestionsBlockList
```
public DescribeQuerySuggestionsBlockListResult describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest request)
```
    Describes a block list used for query suggestions for an index.
    
    This is used to check the current settings that are applied to a block list.
    
    Specified by:
    
    describeQuerySuggestionsBlockList in interface AWSkendra
    
    Parameters:
    
    describeQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeQuerySuggestionsConfig
```
public DescribeQuerySuggestionsConfigResult describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest request)
```
    Describes the settings of query suggestions for an index.
    
    This is used to check the current settings applied to query suggestions.
    
    Specified by:
    
    describeQuerySuggestionsConfig in interface AWSkendra
    
    Parameters:
    
    describeQuerySuggestionsConfigRequest -
    
    Returns:
    
    Result of the DescribeQuerySuggestionsConfig operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - describeThesaurus
```
public DescribeThesaurusResult describeThesaurus(DescribeThesaurusRequest request)
```
    Describes an existing Amazon Kendra thesaurus.
    
    Specified by:
    
    describeThesaurus in interface AWSkendra
    
    Parameters:
    
    describeThesaurusRequest -
    
    Returns:
    
    Result of the DescribeThesaurus operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - getQuerySuggestions
```
public GetQuerySuggestionsResult getQuerySuggestions(GetQuerySuggestionsRequest request)
```
    Fetches the queries that are suggested to your users.
    
    Specified by:
    
    getQuerySuggestions in interface AWSkendra
    
    Parameters:
    
    getQuerySuggestionsRequest -
    
    Returns:
    
    Result of the GetQuerySuggestions operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    ConflictException
    
    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
  - listGroupsOlderThanOrderingId
```
public ListGroupsOlderThanOrderingIdResult listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest request)
```
    Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
    
    Specified by:
    
    listGroupsOlderThanOrderingId in interface AWSkendra
    
    Parameters:
    
    listGroupsOlderThanOrderingIdRequest -
    
    Returns:
    
    Result of the ListGroupsOlderThanOrderingId operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ThrottlingException
    
    ConflictException
    
    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
  - listQuerySuggestionsBlockLists
```
public ListQuerySuggestionsBlockListsResult listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest request)
```
    Lists the block lists used for query suggestions for an index.
    
    For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
    
    Specified by:
    
    listQuerySuggestionsBlockLists in interface AWSkendra
    
    Parameters:
    
    listQuerySuggestionsBlockListsRequest -
    
    Returns:
    
    Result of the ListQuerySuggestionsBlockLists operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
    
    Specified by:
    
    listTagsForResource in interface AWSkendra
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceUnavailableException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - listThesauri
```
public ListThesauriResult listThesauri(ListThesauriRequest request)
```
    Lists the Amazon Kendra thesauri associated with an index.
    
    Specified by:
    
    listThesauri in interface AWSkendra
    
    Parameters:
    
    listThesauriRequest -
    
    Returns:
    
    Result of the ListThesauri operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - putPrincipalMapping
```
public PutPrincipalMappingResult putPrincipalMapping(PutPrincipalMappingRequest request)
```
    Maps users to their groups so that you only need to provide the user ID when you issue the query.
    
    You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
    
    You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.
    
    If more than five PUT actions for a group are currently processing, a validation exception is thrown.
    
    Specified by:
    
    putPrincipalMapping in interface AWSkendra
    
    Parameters:
    
    putPrincipalMappingRequest -
    
    Returns:
    
    Result of the PutPrincipalMapping operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    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.
    
    Each query returns the 100 most relevant results.
    Specified by:
    
    query in interface AWSkendra
    
    Parameters:
    
    queryRequest -
    
    Returns:
    
    Result of the Query operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    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 your index.
    
    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
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AWSkendra
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceUnavailableException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes a tag from an index, FAQ, or a data source.
    
    Specified by:
    
    untagResource in interface AWSkendra
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceUnavailableException
    
    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
    
    ServiceQuotaExceededException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - updateQuerySuggestionsBlockList
```
public UpdateQuerySuggestionsBlockListResult updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest request)
```
    Updates a block list used for query suggestions for an index.
    
    Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
    
    If a block list is updating, then you need to wait for the first update to finish before submitting another update.
    
    Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
    
    Specified by:
    
    updateQuerySuggestionsBlockList in interface AWSkendra
    
    Parameters:
    
    updateQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ConflictException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - updateQuerySuggestionsConfig
```
public UpdateQuerySuggestionsConfigResult updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest request)
```
    Updates the settings of query suggestions for an index.
    
    Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
    
    If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.
    
    Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
    
    You can still enable/disable query suggestions at any time.
    
    Specified by:
    
    updateQuerySuggestionsConfig in interface AWSkendra
    
    Parameters:
    
    updateQuerySuggestionsConfigRequest -
    
    Returns:
    
    Result of the UpdateQuerySuggestionsConfig operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - updateThesaurus
```
public UpdateThesaurusResult updateThesaurus(UpdateThesaurusRequest request)
```
    Updates a thesaurus file associated with an index.
    
    Specified by:
    
    updateThesaurus in interface AWSkendra
    
    Parameters:
    
    updateThesaurusRequest -
    
    Returns:
    
    Result of the UpdateThesaurus operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ResourceNotFoundException
    
    ThrottlingException
    
    AccessDeniedException
    
    ConflictException
    
    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.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSkendra
    
    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.
    
    Specified by:
    
    shutdown in interface AWSkendra
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

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

Field Detail

configFactory

Method Detail

builder

batchDeleteDocument

batchGetDocumentStatus

batchPutDocument

clearQuerySuggestions

createDataSource

createFaq

createIndex

createQuerySuggestionsBlockList

createThesaurus

deleteDataSource

deleteFaq

deleteIndex

deletePrincipalMapping

deleteQuerySuggestionsBlockList

deleteThesaurus

describeDataSource

describeFaq

describeIndex

describePrincipalMapping

describeQuerySuggestionsBlockList

describeQuerySuggestionsConfig

describeThesaurus

getQuerySuggestions

listDataSourceSyncJobs

listDataSources

listFaqs

listGroupsOlderThanOrderingId

listIndices

listQuerySuggestionsBlockLists

listTagsForResource

listThesauri

putPrincipalMapping

query

startDataSourceSyncJob

stopDataSourceSyncJob

submitFeedback

tagResource

untagResource

updateDataSource

updateIndex

updateQuerySuggestionsBlockList

updateQuerySuggestionsConfig

updateThesaurus

getCachedResponseMetadata

shutdown