@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSkendra
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateEntitiesToExperienceResult |
associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.
|
AssociatePersonasToEntitiesResult |
associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest)
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
BatchDeleteDocumentResult |
batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
BatchGetDocumentStatusResult |
batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
|
BatchPutDocumentResult |
batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
|
ClearQuerySuggestionsResult |
clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
|
CreateAccessControlConfigurationResult |
createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)
Creates an access configuration for your documents.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
|
CreateExperienceResult |
createExperience(CreateExperienceRequest createExperienceRequest)
Creates an Amazon Kendra experience such as a search application.
|
CreateFaqResult |
createFaq(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
|
CreateIndexResult |
createIndex(CreateIndexRequest createIndexRequest)
Creates an Amazon Kendra index.
|
CreateQuerySuggestionsBlockListResult |
createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
|
CreateThesaurusResult |
createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index.
|
DeleteAccessControlConfigurationResult |
deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector.
|
DeleteExperienceResult |
deleteExperience(DeleteExperienceRequest deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application.
|
DeleteFaqResult |
deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
|
DeleteIndexResult |
deleteIndex(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
DeletePrincipalMappingResult |
deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)
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 deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
|
DeleteThesaurusResult |
deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
DescribeAccessControlConfigurationResult |
describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index.
|
DescribeDataSourceResult |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
|
DescribeExperienceResult |
describeExperience(DescribeExperienceRequest describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application.
|
DescribeFaqResult |
describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
|
DescribeIndexResult |
describeIndex(DescribeIndexRequest describeIndexRequest)
Gets information about an existing Amazon Kendra index.
|
DescribePrincipalMappingResult |
describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)
Describes the processing of
PUT and DELETE actions for mapping users to their groups. |
DescribeQuerySuggestionsBlockListResult |
describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
|
DescribeQuerySuggestionsConfigResult |
describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
|
DescribeThesaurusResult |
describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
|
DisassociateEntitiesFromExperienceResult |
disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra
experience.
|
DisassociatePersonasFromEntitiesResult |
disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest)
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
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 getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
|
GetSnapshotsResult |
getSnapshots(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data.
|
ListAccessControlConfigurationsResult |
listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
|
ListDataSourceSyncJobsResult |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
ListEntityPersonasResult |
listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
ListExperienceEntitiesResult |
listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
ListExperiencesResult |
listExperiences(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
ListFaqsResult |
listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
ListGroupsOlderThanOrderingIdResult |
listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
ListIndicesResult |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
ListQuerySuggestionsBlockListsResult |
listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
ListThesauriResult |
listThesauri(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
|
PutPrincipalMappingResult |
putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
|
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 connector.
|
StopDataSourceSyncJobResult |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running.
|
SubmitFeedbackResult |
submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
UpdateAccessControlConfigurationResult |
updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
|
UpdateExperienceResult |
updateExperience(UpdateExperienceRequest updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application.
|
UpdateIndexResult |
updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
|
UpdateQuerySuggestionsBlockListResult |
updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
|
UpdateQuerySuggestionsConfigResult |
updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
|
UpdateThesaurusResult |
updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus for an index.
|
static final String ENDPOINT_PREFIX
AssociateEntitiesToExperienceResult associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
associateEntitiesToExperienceRequest - ValidationExceptionResourceNotFoundExceptionResourceAlreadyExistExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionAssociatePersonasToEntitiesResult associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest)
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
associatePersonasToEntitiesRequest - ValidationExceptionResourceNotFoundExceptionResourceAlreadyExistExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionBatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
batchDeleteDocumentRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionBatchGetDocumentStatusResult batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the
BatchGetDocumentStatus API to get the current status of a list of documents so that you can
determine if they have been successfully indexed.
You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API.
When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
batchGetDocumentStatusRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionBatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an
Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to
the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
batchPutDocumentRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionClearQuerySuggestionsResult clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
clearQuerySuggestionsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionConflictExceptionAccessDeniedExceptionInternalServerExceptionCreateAccessControlConfigurationResult createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)
Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you call the BatchPutDocument API with the
AccessControlConfigurationId included in the Document object. If you use an S3
bucket as a data source, you update the .metadata.json with the
AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports
access control configuration for S3 data sources and documents indexed using the BatchPutDocument
API.
createAccessControlConfigurationRequest - ServiceQuotaExceededExceptionValidationExceptionThrottlingExceptionConflictExceptionAccessDeniedExceptionResourceNotFoundExceptionInternalServerExceptionCreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
successfully created. Otherwise, an exception is raised.
Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
createDataSourceRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionCreateExperienceResult createExperience(CreateExperienceRequest createExperienceRequest)
Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
createExperienceRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionCreateFaqResult createFaq(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
Adding FAQs to an index is an asynchronous operation.
For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
createFaqRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionAccessDeniedExceptionInternalServerExceptionCreateIndexResult createIndex(CreateIndexRequest createIndexRequest)
Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has
completed, check the Status field returned from a call to DescribeIndex. The
Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the BatchPutDocument API or using one of
the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
createIndexRequest - ValidationExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionCreateQuerySuggestionsBlockListResult createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
createQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionConflictExceptionInternalServerExceptionCreateThesaurusResult createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
createThesaurusRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionAccessDeniedExceptionInternalServerExceptionDeleteAccessControlConfigurationResult deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
deleteAccessControlConfigurationRequest - ValidationExceptionThrottlingExceptionConflictExceptionResourceNotFoundExceptionAccessDeniedExceptionInternalServerExceptionDeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being
deleted. While the data source is being deleted, the Status field returned by a call to the
DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
deleteDataSourceRequest - AccessDeniedExceptionValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionInternalServerExceptionDeleteExperienceResult deleteExperience(DeleteExperienceRequest deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
deleteExperienceRequest - AccessDeniedExceptionValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionInternalServerExceptionDeleteFaqResult deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
deleteFaqRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDeleteIndexResult 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
API is set to DELETING.
deleteIndexRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDeletePrincipalMappingResult deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use the
PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the
engineering team and another user takes their place, you provide an updated list of users or sub groups that
belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal
list of users or sub groups and input this list when calling PutPrincipalMapping.
DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
deletePrincipalMappingRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDeleteQuerySuggestionsBlockListResult deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
deleteQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionDeleteThesaurusResult deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeAccessControlConfigurationResult describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
describeAccessControlConfigurationRequest - ValidationExceptionThrottlingExceptionResourceNotFoundExceptionAccessDeniedExceptionInternalServerExceptionDescribeDataSourceResult describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
describeDataSourceRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeExperienceResult describeExperience(DescribeExperienceRequest describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
describeExperienceRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeFaqResult describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
describeFaqRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest)
Gets information about an existing Amazon Kendra index.
describeIndexRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribePrincipalMappingResult describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)
Describes the processing of PUT and DELETE actions for mapping users to their groups.
This includes information on the status of actions currently processing or yet to be processed, when actions were
last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after
other actions, and useful error messages if an action could not be processed.
DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
describePrincipalMappingRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeQuerySuggestionsBlockListResult describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
This is used to check the current settings that are applied to a block list.
DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
describeQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeQuerySuggestionsConfigResult describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
describeQuerySuggestionsConfigRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeThesaurusResult describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
describeThesaurusRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDisassociateEntitiesFromExperienceResult disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
disassociateEntitiesFromExperienceRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDisassociatePersonasFromEntitiesResult disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest)
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
disassociatePersonasFromEntitiesRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionGetQuerySuggestionsResult getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
getQuerySuggestionsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionConflictExceptionInternalServerExceptionGetSnapshotsResult getSnapshots(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
getSnapshotsRequest - InvalidRequestException - The input to the request is not valid.ResourceNotFoundExceptionAccessDeniedExceptionInternalServerExceptionListAccessControlConfigurationsResult listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
listAccessControlConfigurationsRequest - ValidationExceptionThrottlingExceptionResourceNotFoundExceptionAccessDeniedExceptionInternalServerExceptionListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
listDataSourceSyncJobsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
listDataSourcesRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionListEntityPersonasResult listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
listEntityPersonasRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionListExperienceEntitiesResult listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
listExperienceEntitiesRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionListExperiencesResult listExperiences(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
listExperiencesRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionListFaqsResult listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
listFaqsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListGroupsOlderThanOrderingIdResult listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
listGroupsOlderThanOrderingIdRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionConflictExceptionInternalServerExceptionListIndicesResult listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
listIndicesRequest - ValidationExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListQuerySuggestionsBlockListsResult listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
listQuerySuggestionsBlockListsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceRequest - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListThesauriResult listThesauri(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
listThesauriRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionPutPrincipalMappingResult putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.
If more than five PUT actions for a group are currently processing, a validation exception is
thrown.
PutPrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.
putPrincipalMappingRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionQueryResult query(QueryRequest queryRequest)
Searches an active index. Use this API to search your documents using query. The Query API 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 - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionStartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
Kendra returns a ResourceInUseException exception.
startDataSourceSyncJobRequest - ValidationExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionStopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSubmitFeedbackResult submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
submitFeedbackRequest - ValidationExceptionResourceUnavailableExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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 - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUpdateAccessControlConfigurationResult updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the BatchPutDocument API to apply
the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3
bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId
in the .metadata.json file. Amazon Kendra currently only supports access control configuration for
S3 data sources and documents indexed using the BatchPutDocument API.
updateAccessControlConfigurationRequest - ValidationExceptionThrottlingExceptionConflictExceptionResourceNotFoundExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionUpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
updateDataSourceRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUpdateExperienceResult updateExperience(UpdateExperienceRequest updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
updateExperienceRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUpdateIndexResult updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
updateIndexRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionUpdateQuerySuggestionsBlockListResult updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
updateQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionUpdateQuerySuggestionsConfigResult updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
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.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
updateQuerySuggestionsConfigRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUpdateThesaurusResult updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus for an index.
updateThesaurusRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.