@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface KendraClient extends AwsClient
builder() method.
Amazon Kendra is a service for indexing large document sets.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateEntitiesToExperienceResponse |
associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.
|
default AssociateEntitiesToExperienceResponse |
associateEntitiesToExperience(Consumer<AssociateEntitiesToExperienceRequest.Builder> associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.
|
default AssociatePersonasToEntitiesResponse |
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.
|
default AssociatePersonasToEntitiesResponse |
associatePersonasToEntities(Consumer<AssociatePersonasToEntitiesRequest.Builder> associatePersonasToEntitiesRequest)
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
default BatchDeleteDocumentResponse |
batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default BatchDeleteDocumentResponse |
batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default BatchDeleteFeaturedResultsSetResponse |
batchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest)
Removes one or more sets of featured results.
|
default BatchDeleteFeaturedResultsSetResponse |
batchDeleteFeaturedResultsSet(Consumer<BatchDeleteFeaturedResultsSetRequest.Builder> batchDeleteFeaturedResultsSetRequest)
Removes one or more sets of featured results.
|
default BatchGetDocumentStatusResponse |
batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
|
default BatchGetDocumentStatusResponse |
batchGetDocumentStatus(Consumer<BatchGetDocumentStatusRequest.Builder> batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
|
default BatchPutDocumentResponse |
batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
|
default BatchPutDocumentResponse |
batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)
Adds one or more documents to an index.
|
static KendraClientBuilder |
builder()
Create a builder that can be used to configure and create a
KendraClient. |
default ClearQuerySuggestionsResponse |
clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
|
default ClearQuerySuggestionsResponse |
clearQuerySuggestions(Consumer<ClearQuerySuggestionsRequest.Builder> clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
|
static KendraClient |
create()
Create a
KendraClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAccessControlConfigurationResponse |
createAccessControlConfiguration(Consumer<CreateAccessControlConfigurationRequest.Builder> createAccessControlConfigurationRequest)
Creates an access configuration for your documents.
|
default CreateAccessControlConfigurationResponse |
createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)
Creates an access configuration for your documents.
|
default CreateDataSourceResponse |
createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
|
default CreateDataSourceResponse |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
|
default CreateExperienceResponse |
createExperience(Consumer<CreateExperienceRequest.Builder> createExperienceRequest)
Creates an Amazon Kendra experience such as a search application.
|
default CreateExperienceResponse |
createExperience(CreateExperienceRequest createExperienceRequest)
Creates an Amazon Kendra experience such as a search application.
|
default CreateFaqResponse |
createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
|
default CreateFaqResponse |
createFaq(CreateFaqRequest createFaqRequest)
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
|
default CreateFeaturedResultsSetResponse |
createFeaturedResultsSet(Consumer<CreateFeaturedResultsSetRequest.Builder> createFeaturedResultsSetRequest)
Creates a set of featured results to display at the top of the search results page.
|
default CreateFeaturedResultsSetResponse |
createFeaturedResultsSet(CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest)
Creates a set of featured results to display at the top of the search results page.
|
default CreateIndexResponse |
createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)
Creates an Amazon Kendra index.
|
default CreateIndexResponse |
createIndex(CreateIndexRequest createIndexRequest)
Creates an Amazon Kendra index.
|
default CreateQuerySuggestionsBlockListResponse |
createQuerySuggestionsBlockList(Consumer<CreateQuerySuggestionsBlockListRequest.Builder> createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
|
default CreateQuerySuggestionsBlockListResponse |
createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
|
default CreateThesaurusResponse |
createThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest)
Creates a thesaurus for an index.
|
default CreateThesaurusResponse |
createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index.
|
default DeleteAccessControlConfigurationResponse |
deleteAccessControlConfiguration(Consumer<DeleteAccessControlConfigurationRequest.Builder> deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index.
|
default DeleteAccessControlConfigurationResponse |
deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index.
|
default DeleteDataSourceResponse |
deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector.
|
default DeleteDataSourceResponse |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector.
|
default DeleteExperienceResponse |
deleteExperience(Consumer<DeleteExperienceRequest.Builder> deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application.
|
default DeleteExperienceResponse |
deleteExperience(DeleteExperienceRequest deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application.
|
default DeleteFaqResponse |
deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)
Removes an FAQ from an index.
|
default DeleteFaqResponse |
deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
|
default DeleteIndexResponse |
deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default DeleteIndexResponse |
deleteIndex(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default DeletePrincipalMappingResponse |
deletePrincipalMapping(Consumer<DeletePrincipalMappingRequest.Builder> 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.
|
default DeletePrincipalMappingResponse |
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.
|
default DeleteQuerySuggestionsBlockListResponse |
deleteQuerySuggestionsBlockList(Consumer<DeleteQuerySuggestionsBlockListRequest.Builder> deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
|
default DeleteQuerySuggestionsBlockListResponse |
deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
|
default DeleteThesaurusResponse |
deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
default DeleteThesaurusResponse |
deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
default DescribeAccessControlConfigurationResponse |
describeAccessControlConfiguration(Consumer<DescribeAccessControlConfigurationRequest.Builder> describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index.
|
default DescribeAccessControlConfigurationResponse |
describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index.
|
default DescribeDataSourceResponse |
describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
|
default DescribeDataSourceResponse |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
|
default DescribeExperienceResponse |
describeExperience(Consumer<DescribeExperienceRequest.Builder> describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application.
|
default DescribeExperienceResponse |
describeExperience(DescribeExperienceRequest describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application.
|
default DescribeFaqResponse |
describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)
Gets information about an FAQ list.
|
default DescribeFaqResponse |
describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
|
default DescribeFeaturedResultsSetResponse |
describeFeaturedResultsSet(Consumer<DescribeFeaturedResultsSetRequest.Builder> describeFeaturedResultsSetRequest)
Gets information about a set of featured results.
|
default DescribeFeaturedResultsSetResponse |
describeFeaturedResultsSet(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest)
Gets information about a set of featured results.
|
default DescribeIndexResponse |
describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)
Gets information about an existing Amazon Kendra index.
|
default DescribeIndexResponse |
describeIndex(DescribeIndexRequest describeIndexRequest)
Gets information about an existing Amazon Kendra index.
|
default DescribePrincipalMappingResponse |
describePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest)
Describes the processing of
PUT and DELETE actions for mapping users to their groups. |
default DescribePrincipalMappingResponse |
describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)
Describes the processing of
PUT and DELETE actions for mapping users to their groups. |
default DescribeQuerySuggestionsBlockListResponse |
describeQuerySuggestionsBlockList(Consumer<DescribeQuerySuggestionsBlockListRequest.Builder> describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
|
default DescribeQuerySuggestionsBlockListResponse |
describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
|
default DescribeQuerySuggestionsConfigResponse |
describeQuerySuggestionsConfig(Consumer<DescribeQuerySuggestionsConfigRequest.Builder> describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
|
default DescribeQuerySuggestionsConfigResponse |
describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
|
default DescribeThesaurusResponse |
describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
|
default DescribeThesaurusResponse |
describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
|
default DisassociateEntitiesFromExperienceResponse |
disassociateEntitiesFromExperience(Consumer<DisassociateEntitiesFromExperienceRequest.Builder> disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra
experience.
|
default DisassociateEntitiesFromExperienceResponse |
disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra
experience.
|
default DisassociatePersonasFromEntitiesResponse |
disassociatePersonasFromEntities(Consumer<DisassociatePersonasFromEntitiesRequest.Builder> disassociatePersonasFromEntitiesRequest)
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
default DisassociatePersonasFromEntitiesResponse |
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.
|
default GetQuerySuggestionsResponse |
getQuerySuggestions(Consumer<GetQuerySuggestionsRequest.Builder> getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
|
default GetQuerySuggestionsResponse |
getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
|
default GetSnapshotsResponse |
getSnapshots(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)
Retrieves search metrics data.
|
default GetSnapshotsResponse |
getSnapshots(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data.
|
default GetSnapshotsIterable |
getSnapshotsPaginator(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)
Retrieves search metrics data.
|
default GetSnapshotsIterable |
getSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data.
|
default ListAccessControlConfigurationsResponse |
listAccessControlConfigurations(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default ListAccessControlConfigurationsResponse |
listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default ListAccessControlConfigurationsIterable |
listAccessControlConfigurationsPaginator(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default ListAccessControlConfigurationsIterable |
listAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default ListDataSourcesResponse |
listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default ListDataSourcesResponse |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default ListDataSourcesIterable |
listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default ListDataSourceSyncJobsResponse |
listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default ListDataSourceSyncJobsResponse |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default ListDataSourceSyncJobsIterable |
listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default ListDataSourceSyncJobsIterable |
listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default ListEntityPersonasResponse |
listEntityPersonas(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default ListEntityPersonasResponse |
listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default ListEntityPersonasIterable |
listEntityPersonasPaginator(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default ListEntityPersonasIterable |
listEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default ListExperienceEntitiesResponse |
listExperienceEntities(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default ListExperienceEntitiesResponse |
listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default ListExperienceEntitiesIterable |
listExperienceEntitiesPaginator(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default ListExperienceEntitiesIterable |
listExperienceEntitiesPaginator(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default ListExperiencesResponse |
listExperiences(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default ListExperiencesResponse |
listExperiences(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default ListExperiencesIterable |
listExperiencesPaginator(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default ListExperiencesIterable |
listExperiencesPaginator(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default ListFaqsResponse |
listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListFaqsResponse |
listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListFaqsIterable |
listFaqsPaginator(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListFaqsIterable |
listFaqsPaginator(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListFeaturedResultsSetsResponse |
listFeaturedResultsSets(Consumer<ListFeaturedResultsSetsRequest.Builder> listFeaturedResultsSetsRequest)
Lists all your sets of featured results for a given index.
|
default ListFeaturedResultsSetsResponse |
listFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest)
Lists all your sets of featured results for a given index.
|
default ListGroupsOlderThanOrderingIdResponse |
listGroupsOlderThanOrderingId(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default ListGroupsOlderThanOrderingIdResponse |
listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default ListGroupsOlderThanOrderingIdIterable |
listGroupsOlderThanOrderingIdPaginator(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default ListGroupsOlderThanOrderingIdIterable |
listGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default ListIndicesResponse |
listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default ListIndicesResponse |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default ListIndicesIterable |
listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default ListIndicesIterable |
listIndicesPaginator(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default ListQuerySuggestionsBlockListsResponse |
listQuerySuggestionsBlockLists(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default ListQuerySuggestionsBlockListsResponse |
listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default ListQuerySuggestionsBlockListsIterable |
listQuerySuggestionsBlockListsPaginator(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default ListQuerySuggestionsBlockListsIterable |
listQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default ListThesauriResponse |
listThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the thesauri for an index.
|
default ListThesauriResponse |
listThesauri(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
|
default ListThesauriIterable |
listThesauriPaginator(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the thesauri for an index.
|
default ListThesauriIterable |
listThesauriPaginator(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
|
default PutPrincipalMappingResponse |
putPrincipalMapping(Consumer<PutPrincipalMappingRequest.Builder> putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
|
default PutPrincipalMappingResponse |
putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
|
default QueryResponse |
query(Consumer<QueryRequest.Builder> queryRequest)
Searches an index given an input query.
|
default QueryResponse |
query(QueryRequest queryRequest)
Searches an index given an input query.
|
default RetrieveResponse |
retrieve(Consumer<RetrieveRequest.Builder> retrieveRequest)
Retrieves relevant passages or text excerpts given an input query.
|
default RetrieveResponse |
retrieve(RetrieveRequest retrieveRequest)
Retrieves relevant passages or text excerpts given an input query.
|
default KendraServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartDataSourceSyncJobResponse |
startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)
Starts a synchronization job for a data source connector.
|
default StartDataSourceSyncJobResponse |
startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source connector.
|
default StopDataSourceSyncJobResponse |
stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running.
|
default StopDataSourceSyncJobResponse |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running.
|
default SubmitFeedbackResponse |
submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
|
default SubmitFeedbackResponse |
submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default UpdateAccessControlConfigurationResponse |
updateAccessControlConfiguration(Consumer<UpdateAccessControlConfigurationRequest.Builder> updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index.
|
default UpdateAccessControlConfigurationResponse |
updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index.
|
default UpdateDataSourceResponse |
updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
|
default UpdateDataSourceResponse |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
|
default UpdateExperienceResponse |
updateExperience(Consumer<UpdateExperienceRequest.Builder> updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application.
|
default UpdateExperienceResponse |
updateExperience(UpdateExperienceRequest updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application.
|
default UpdateFeaturedResultsSetResponse |
updateFeaturedResultsSet(Consumer<UpdateFeaturedResultsSetRequest.Builder> updateFeaturedResultsSetRequest)
Updates a set of featured results.
|
default UpdateFeaturedResultsSetResponse |
updateFeaturedResultsSet(UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest)
Updates a set of featured results.
|
default UpdateIndexResponse |
updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)
Updates an existing Amazon Kendra index.
|
default UpdateIndexResponse |
updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
|
default UpdateQuerySuggestionsBlockListResponse |
updateQuerySuggestionsBlockList(Consumer<UpdateQuerySuggestionsBlockListRequest.Builder> updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
|
default UpdateQuerySuggestionsBlockListResponse |
updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
|
default UpdateQuerySuggestionsConfigResponse |
updateQuerySuggestionsConfig(Consumer<UpdateQuerySuggestionsConfigRequest.Builder> updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
|
default UpdateQuerySuggestionsConfigResponse |
updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
|
default UpdateThesaurusResponse |
updateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest)
Updates a thesaurus for an index.
|
default UpdateThesaurusResponse |
updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus for an index.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AssociateEntitiesToExperienceResponse associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest) throws ValidationException, ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateEntitiesToExperienceResponse associateEntitiesToExperience(Consumer<AssociateEntitiesToExperienceRequest.Builder> associateEntitiesToExperienceRequest) throws ValidationException, ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the AssociateEntitiesToExperienceRequest.Builder
avoiding the need to create one manually via AssociateEntitiesToExperienceRequest.builder()
associateEntitiesToExperienceRequest - A Consumer that will call methods on
AssociateEntitiesToExperienceRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociatePersonasToEntitiesResponse associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest) throws ValidationException, ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociatePersonasToEntitiesResponse associatePersonasToEntities(Consumer<AssociatePersonasToEntitiesRequest.Builder> associatePersonasToEntitiesRequest) throws ValidationException, ResourceNotFoundException, ResourceAlreadyExistException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the AssociatePersonasToEntitiesRequest.Builder
avoiding the need to create one manually via AssociatePersonasToEntitiesRequest.builder()
associatePersonasToEntitiesRequest - A Consumer that will call methods on
AssociatePersonasToEntitiesRequest.Builder to create
a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeleteDocumentResponse batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument 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 your Amazon Web Services
CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting
your documents.
Deleting documents from an index using BatchDeleteDocument could take up to an hour or more,
depending on the number of documents you want to delete.
batchDeleteDocumentRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeleteDocumentResponse batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument 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 your Amazon Web Services
CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting
your documents.
Deleting documents from an index using BatchDeleteDocument could take up to an hour or more,
depending on the number of documents you want to delete.
This is a convenience which creates an instance of the BatchDeleteDocumentRequest.Builder avoiding the
need to create one manually via BatchDeleteDocumentRequest.builder()
batchDeleteDocumentRequest - A Consumer that will call methods on
BatchDeleteDocumentRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeleteFeaturedResultsSetResponse batchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
batchDeleteFeaturedResultsSetRequest - ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeleteFeaturedResultsSetResponse batchDeleteFeaturedResultsSet(Consumer<BatchDeleteFeaturedResultsSetRequest.Builder> batchDeleteFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the BatchDeleteFeaturedResultsSetRequest.Builder
avoiding the need to create one manually via BatchDeleteFeaturedResultsSetRequest.builder()
batchDeleteFeaturedResultsSetRequest - A Consumer that will call methods on
BatchDeleteFeaturedResultsSetRequest.Builder to
create a request.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetDocumentStatusResponse batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetDocumentStatusResponse batchGetDocumentStatus(Consumer<BatchGetDocumentStatusRequest.Builder> batchGetDocumentStatusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the BatchGetDocumentStatusRequest.Builder avoiding the
need to create one manually via BatchGetDocumentStatusRequest.builder()
batchGetDocumentStatusRequest - A Consumer that will call methods on
BatchGetDocumentStatusRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchPutDocumentResponse batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Adds one or more documents to an index.
The BatchPutDocument 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. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your
documents.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
batchPutDocumentRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchPutDocumentResponse batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Adds one or more documents to an index.
The BatchPutDocument 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. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your
documents.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
This is a convenience which creates an instance of the BatchPutDocumentRequest.Builder avoiding the need
to create one manually via BatchPutDocumentRequest.builder()
batchPutDocumentRequest - A Consumer that will call methods on
BatchPutDocumentRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ClearQuerySuggestionsResponse clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ClearQuerySuggestionsResponse clearQuerySuggestions(Consumer<ClearQuerySuggestionsRequest.Builder> clearQuerySuggestionsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the ClearQuerySuggestionsRequest.Builder avoiding the
need to create one manually via ClearQuerySuggestionsRequest.builder()
clearQuerySuggestionsRequest - A Consumer that will call methods on
ClearQuerySuggestionsRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccessControlConfigurationResponse createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, ConflictException, AccessDeniedException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccessControlConfigurationResponse createAccessControlConfiguration(Consumer<CreateAccessControlConfigurationRequest.Builder> createAccessControlConfigurationRequest) throws ServiceQuotaExceededException, ValidationException, ThrottlingException, ConflictException, AccessDeniedException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the CreateAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via CreateAccessControlConfigurationRequest.builder()
createAccessControlConfigurationRequest - A Consumer that will call methods on
CreateAccessControlConfigurationRequest.Builder to
create a request.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a data source 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.
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a data source 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.
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.
This is a convenience which creates an instance of the CreateDataSourceRequest.Builder avoiding the need
to create one manually via CreateDataSourceRequest.builder()
createDataSourceRequest - A Consumer that will call methods on
CreateDataSourceRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExperienceResponse createExperience(CreateExperienceRequest createExperienceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExperienceResponse createExperience(Consumer<CreateExperienceRequest.Builder> createExperienceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the CreateExperienceRequest.Builder avoiding the need
to create one manually via CreateExperienceRequest.builder()
createExperienceRequest - A Consumer that will call methods on
CreateExperienceRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFaqResponse createFaq(CreateFaqRequest createFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFaqResponse createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
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.
This is a convenience which creates an instance of the CreateFaqRequest.Builder avoiding the need to
create one manually via CreateFaqRequest.builder()
createFaqRequest - A Consumer that will call methods on
CreateFaqRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFeaturedResultsSetResponse createFeaturedResultsSet(CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.
You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
createFeaturedResultsSetRequest - ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.FeaturedResultsConflictException - An error message with a list of conflicting queries used across different sets of featured results. This
occurred with the request for a new featured results set. Check that the queries you specified for
featured results are unique per featured results set for each index.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFeaturedResultsSetResponse createFeaturedResultsSet(Consumer<CreateFeaturedResultsSetRequest.Builder> createFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.
You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
This is a convenience which creates an instance of the CreateFeaturedResultsSetRequest.Builder avoiding
the need to create one manually via CreateFeaturedResultsSetRequest.builder()
createFeaturedResultsSetRequest - A Consumer that will call methods on
CreateFeaturedResultsSetRequest.Builder to create a
request.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.FeaturedResultsConflictException - An error message with a list of conflicting queries used across different sets of featured results. This
occurred with the request for a new featured results set. Check that the queries you specified for
featured results are unique per featured results set for each index.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws ValidationException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates 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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateIndexResponse createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest) throws ValidationException, ResourceAlreadyExistException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Creates 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.
This is a convenience which creates an instance of the CreateIndexRequest.Builder avoiding the need to
create one manually via CreateIndexRequest.builder()
createIndexRequest - A Consumer that will call methods on
CreateIndexRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try
again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateQuerySuggestionsBlockListResponse createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateQuerySuggestionsBlockListResponse createQuerySuggestionsBlockList(Consumer<CreateQuerySuggestionsBlockListRequest.Builder> createQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the CreateQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via CreateQuerySuggestionsBlockListRequest.builder()
createQuerySuggestionsBlockListRequest - A Consumer that will call methods on
CreateQuerySuggestionsBlockListRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateThesaurusResponse createThesaurus(CreateThesaurusRequest createThesaurusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateThesaurusResponse createThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, ServiceQuotaExceededException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the CreateThesaurusRequest.Builder avoiding the need
to create one manually via CreateThesaurusRequest.builder()
createThesaurusRequest - A Consumer that will call methods on
CreateThesaurusRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessControlConfigurationResponse deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest) throws ValidationException, ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccessControlConfigurationResponse deleteAccessControlConfiguration(Consumer<DeleteAccessControlConfigurationRequest.Builder> deleteAccessControlConfigurationRequest) throws ValidationException, ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DeleteAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via DeleteAccessControlConfigurationRequest.builder()
deleteAccessControlConfigurationRequest - A Consumer that will call methods on
DeleteAccessControlConfigurationRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an Amazon Kendra data source 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.
Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.
deleteDataSourceRequest - AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an Amazon Kendra data source 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.
Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.
This is a convenience which creates an instance of the DeleteDataSourceRequest.Builder avoiding the need
to create one manually via DeleteDataSourceRequest.builder()
deleteDataSourceRequest - A Consumer that will call methods on
DeleteDataSourceRequest.Builder to create a request.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteExperienceResponse deleteExperience(DeleteExperienceRequest deleteExperienceRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteExperienceResponse deleteExperience(Consumer<DeleteExperienceRequest.Builder> deleteExperienceRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DeleteExperienceRequest.Builder avoiding the need
to create one manually via DeleteExperienceRequest.builder()
deleteExperienceRequest - A Consumer that will call methods on
DeleteExperienceRequest.Builder to create a request.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFaqResponse deleteFaq(DeleteFaqRequest deleteFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes an FAQ from an index.
deleteFaqRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFaqResponse deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes an FAQ from an index.
This is a convenience which creates an instance of the DeleteFaqRequest.Builder avoiding the need to
create one manually via DeleteFaqRequest.builder()
deleteFaqRequest - A Consumer that will call methods on
DeleteFaqRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status field returned by a call to the DescribeIndex
API is set to DELETING.
deleteIndexRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIndexResponse deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status field returned by a call to the DescribeIndex
API is set to DELETING.
This is a convenience which creates an instance of the DeleteIndexRequest.Builder avoiding the need to
create one manually via DeleteIndexRequest.builder()
deleteIndexRequest - A Consumer that will call methods on
DeleteIndexRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePrincipalMappingResponse deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePrincipalMappingResponse deletePrincipalMapping(Consumer<DeletePrincipalMappingRequest.Builder> deletePrincipalMappingRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DeletePrincipalMappingRequest.Builder avoiding the
need to create one manually via DeletePrincipalMappingRequest.builder()
deletePrincipalMappingRequest - A Consumer that will call methods on
DeletePrincipalMappingRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteQuerySuggestionsBlockListResponse deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteQuerySuggestionsBlockListResponse deleteQuerySuggestionsBlockList(Consumer<DeleteQuerySuggestionsBlockListRequest.Builder> deleteQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DeleteQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via DeleteQuerySuggestionsBlockListRequest.builder()
deleteQuerySuggestionsBlockListRequest - A Consumer that will call methods on
DeleteQuerySuggestionsBlockListRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteThesaurusResponse deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteThesaurusResponse deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Deletes an existing Amazon Kendra thesaurus.
This is a convenience which creates an instance of the DeleteThesaurusRequest.Builder avoiding the need
to create one manually via DeleteThesaurusRequest.builder()
deleteThesaurusRequest - A Consumer that will call methods on
DeleteThesaurusRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccessControlConfigurationResponse describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccessControlConfigurationResponse describeAccessControlConfiguration(Consumer<DescribeAccessControlConfigurationRequest.Builder> describeAccessControlConfigurationRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DescribeAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via DescribeAccessControlConfigurationRequest.builder()
describeAccessControlConfigurationRequest - A Consumer that will call methods on
DescribeAccessControlConfigurationRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSourceResponse describeDataSource(DescribeDataSourceRequest describeDataSourceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an Amazon Kendra data source connector.
describeDataSourceRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataSourceResponse describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an Amazon Kendra data source connector.
This is a convenience which creates an instance of the DescribeDataSourceRequest.Builder avoiding the
need to create one manually via DescribeDataSourceRequest.builder()
describeDataSourceRequest - A Consumer that will call methods on
DescribeDataSourceRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExperienceResponse describeExperience(DescribeExperienceRequest describeExperienceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExperienceResponse describeExperience(Consumer<DescribeExperienceRequest.Builder> describeExperienceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DescribeExperienceRequest.Builder avoiding the
need to create one manually via DescribeExperienceRequest.builder()
describeExperienceRequest - A Consumer that will call methods on
DescribeExperienceRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFaqResponse describeFaq(DescribeFaqRequest describeFaqRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an FAQ list.
describeFaqRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFaqResponse describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an FAQ list.
This is a convenience which creates an instance of the DescribeFaqRequest.Builder avoiding the need to
create one manually via DescribeFaqRequest.builder()
describeFaqRequest - A Consumer that will call methods on
DescribeFaqRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFeaturedResultsSetResponse describeFeaturedResultsSet(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
describeFeaturedResultsSetRequest - ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFeaturedResultsSetResponse describeFeaturedResultsSet(Consumer<DescribeFeaturedResultsSetRequest.Builder> describeFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the DescribeFeaturedResultsSetRequest.Builder avoiding
the need to create one manually via DescribeFeaturedResultsSetRequest.builder()
describeFeaturedResultsSetRequest - A Consumer that will call methods on
DescribeFeaturedResultsSetRequest.Builder to create a
request.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeIndexResponse describeIndex(DescribeIndexRequest describeIndexRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an existing Amazon Kendra index.
describeIndexRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeIndexResponse describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an existing Amazon Kendra index.
This is a convenience which creates an instance of the DescribeIndexRequest.Builder avoiding the need to
create one manually via DescribeIndexRequest.builder()
describeIndexRequest - A Consumer that will call methods on
DescribeIndexRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePrincipalMappingResponse describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePrincipalMappingResponse describePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DescribePrincipalMappingRequest.Builder avoiding
the need to create one manually via DescribePrincipalMappingRequest.builder()
describePrincipalMappingRequest - A Consumer that will call methods on
DescribePrincipalMappingRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQuerySuggestionsBlockListResponse describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQuerySuggestionsBlockListResponse describeQuerySuggestionsBlockList(Consumer<DescribeQuerySuggestionsBlockListRequest.Builder> describeQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DescribeQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via DescribeQuerySuggestionsBlockListRequest.builder()
describeQuerySuggestionsBlockListRequest - A Consumer that will call methods on
DescribeQuerySuggestionsBlockListRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQuerySuggestionsConfigResponse describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQuerySuggestionsConfigResponse describeQuerySuggestionsConfig(Consumer<DescribeQuerySuggestionsConfigRequest.Builder> describeQuerySuggestionsConfigRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DescribeQuerySuggestionsConfigRequest.Builder
avoiding the need to create one manually via DescribeQuerySuggestionsConfigRequest.builder()
describeQuerySuggestionsConfigRequest - A Consumer that will call methods on
DescribeQuerySuggestionsConfigRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeThesaurusResponse describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an existing Amazon Kendra thesaurus.
describeThesaurusRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeThesaurusResponse describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets information about an existing Amazon Kendra thesaurus.
This is a convenience which creates an instance of the DescribeThesaurusRequest.Builder avoiding the need
to create one manually via DescribeThesaurusRequest.builder()
describeThesaurusRequest - A Consumer that will call methods on
DescribeThesaurusRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateEntitiesFromExperienceResponse disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateEntitiesFromExperienceResponse disassociateEntitiesFromExperience(Consumer<DisassociateEntitiesFromExperienceRequest.Builder> disassociateEntitiesFromExperienceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DisassociateEntitiesFromExperienceRequest.Builder
avoiding the need to create one manually via DisassociateEntitiesFromExperienceRequest.builder()
disassociateEntitiesFromExperienceRequest - A Consumer that will call methods on
DisassociateEntitiesFromExperienceRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociatePersonasFromEntitiesResponse disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociatePersonasFromEntitiesResponse disassociatePersonasFromEntities(Consumer<DisassociatePersonasFromEntitiesRequest.Builder> disassociatePersonasFromEntitiesRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the DisassociatePersonasFromEntitiesRequest.Builder
avoiding the need to create one manually via DisassociatePersonasFromEntitiesRequest.builder()
disassociatePersonasFromEntitiesRequest - A Consumer that will call methods on
DisassociatePersonasFromEntitiesRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQuerySuggestionsResponse getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
getQuerySuggestionsRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQuerySuggestionsResponse getQuerySuggestions(Consumer<GetQuerySuggestionsRequest.Builder> getQuerySuggestionsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the GetQuerySuggestionsRequest.Builder avoiding the
need to create one manually via GetQuerySuggestionsRequest.builder()
getQuerySuggestionsRequest - A Consumer that will call methods on
GetQuerySuggestionsRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSnapshotsResponse getSnapshots(GetSnapshotsRequest getSnapshotsRequest) throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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. Please provide the correct input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSnapshotsResponse getSnapshots(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest) throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
This is a convenience which creates an instance of the GetSnapshotsRequest.Builder avoiding the need to
create one manually via GetSnapshotsRequest.builder()
getSnapshotsRequest - A Consumer that will call methods on
GetSnapshotsRequest.Builder to create a request.InvalidRequestException - The input to the request is not valid. Please provide the correct input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSnapshotsIterable getSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest) throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
This is a variant of getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) operation.
getSnapshotsRequest - InvalidRequestException - The input to the request is not valid. Please provide the correct input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSnapshotsIterable getSnapshotsPaginator(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest) throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
This is a variant of getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) operation.
This is a convenience which creates an instance of the GetSnapshotsRequest.Builder avoiding the need to
create one manually via GetSnapshotsRequest.builder()
getSnapshotsRequest - A Consumer that will call methods on
GetSnapshotsRequest.Builder to create a request.InvalidRequestException - The input to the request is not valid. Please provide the correct input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessControlConfigurationsResponse listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessControlConfigurationsResponse listAccessControlConfigurations(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the ListAccessControlConfigurationsRequest.Builder
avoiding the need to create one manually via ListAccessControlConfigurationsRequest.builder()
listAccessControlConfigurationsRequest - A Consumer that will call methods on
ListAccessControlConfigurationsRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessControlConfigurationsIterable listAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client
.listAccessControlConfigurationsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation.
listAccessControlConfigurationsRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessControlConfigurationsIterable listAccessControlConfigurationsPaginator(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client
.listAccessControlConfigurationsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation.
This is a convenience which creates an instance of the ListAccessControlConfigurationsRequest.Builder
avoiding the need to create one manually via ListAccessControlConfigurationsRequest.builder()
listAccessControlConfigurationsRequest - A Consumer that will call methods on
ListAccessControlConfigurationsRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsResponse listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing a data source connector.
listDataSourceSyncJobsRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsResponse listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing a data source connector.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on
ListDataSourceSyncJobsRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing a data source connector.
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client
.listDataSourceSyncJobsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
listDataSourceSyncJobsRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets statistics about synchronizing a data source connector.
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client
.listDataSourceSyncJobsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on
ListDataSourceSyncJobsRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data source connectors that you have created.
listDataSourcesRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data source connectors that you have created.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on
ListDataSourcesRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data source connectors that you have created.
This is a variant of
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client
.listDataSourcesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
listDataSourcesRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the data source connectors that you have created.
This is a variant of
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client
.listDataSourcesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on
ListDataSourcesRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEntityPersonasResponse listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
listEntityPersonasRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEntityPersonasResponse listEntityPersonas(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
This is a convenience which creates an instance of the ListEntityPersonasRequest.Builder avoiding the
need to create one manually via ListEntityPersonasRequest.builder()
listEntityPersonasRequest - A Consumer that will call methods on
ListEntityPersonasRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEntityPersonasIterable listEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
This is a variant of
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client
.listEntityPersonasPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)
operation.
listEntityPersonasRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEntityPersonasIterable listEntityPersonasPaginator(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
This is a variant of
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client
.listEntityPersonasPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)
operation.
This is a convenience which creates an instance of the ListEntityPersonasRequest.Builder avoiding the
need to create one manually via ListEntityPersonasRequest.builder()
listEntityPersonasRequest - A Consumer that will call methods on
ListEntityPersonasRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperienceEntitiesResponse listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperienceEntitiesResponse listExperienceEntities(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the ListExperienceEntitiesRequest.Builder avoiding the
need to create one manually via ListExperienceEntitiesRequest.builder()
listExperienceEntitiesRequest - A Consumer that will call methods on
ListExperienceEntitiesRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperienceEntitiesIterable listExperienceEntitiesPaginator(ListExperienceEntitiesRequest listExperienceEntitiesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client
.listExperienceEntitiesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation.
listExperienceEntitiesRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperienceEntitiesIterable listExperienceEntitiesPaginator(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client
.listExperienceEntitiesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation.
This is a convenience which creates an instance of the ListExperienceEntitiesRequest.Builder avoiding the
need to create one manually via ListExperienceEntitiesRequest.builder()
listExperienceEntitiesRequest - A Consumer that will call methods on
ListExperienceEntitiesRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperiencesResponse listExperiences(ListExperiencesRequest listExperiencesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperiencesResponse listExperiences(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the ListExperiencesRequest.Builder avoiding the need
to create one manually via ListExperiencesRequest.builder()
listExperiencesRequest - A Consumer that will call methods on
ListExperiencesRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperiencesIterable listExperiencesPaginator(ListExperiencesRequest listExperiencesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client
.listExperiencesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListExperiencesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation.
listExperiencesRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExperiencesIterable listExperiencesPaginator(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client
.listExperiencesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListExperiencesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation.
This is a convenience which creates an instance of the ListExperiencesRequest.Builder avoiding the need
to create one manually via ListExperiencesRequest.builder()
listExperiencesRequest - A Consumer that will call methods on
ListExperiencesRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFaqsResponse listFaqs(ListFaqsRequest listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of FAQ lists associated with an index.
listFaqsRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFaqsResponse listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of FAQ lists associated with an index.
This is a convenience which creates an instance of the ListFaqsRequest.Builder avoiding the need to
create one manually via ListFaqsRequest.builder()
listFaqsRequest - A Consumer that will call methods on
ListFaqsRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFaqsIterable listFaqsPaginator(ListFaqsRequest listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of FAQ lists associated with an index.
This is a variant of listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListFaqsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
listFaqsRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFaqsIterable listFaqsPaginator(Consumer<ListFaqsRequest.Builder> listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of FAQ lists associated with an index.
This is a variant of listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListFaqsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
This is a convenience which creates an instance of the ListFaqsRequest.Builder avoiding the need to
create one manually via ListFaqsRequest.builder()
listFaqsRequest - A Consumer that will call methods on
ListFaqsRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFeaturedResultsSetsResponse listFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
listFeaturedResultsSetsRequest - ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFeaturedResultsSetsResponse listFeaturedResultsSets(Consumer<ListFeaturedResultsSetsRequest.Builder> listFeaturedResultsSetsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the ListFeaturedResultsSetsRequest.Builder avoiding
the need to create one manually via ListFeaturedResultsSetsRequest.builder()
listFeaturedResultsSetsRequest - A Consumer that will call methods on
ListFeaturedResultsSetsRequest.Builder to create a
request.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsOlderThanOrderingIdResponse listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsOlderThanOrderingIdResponse listGroupsOlderThanOrderingId(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the ListGroupsOlderThanOrderingIdRequest.Builder
avoiding the need to create one manually via ListGroupsOlderThanOrderingIdRequest.builder()
listGroupsOlderThanOrderingIdRequest - A Consumer that will call methods on
ListGroupsOlderThanOrderingIdRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsOlderThanOrderingIdIterable listGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client
.listGroupsOlderThanOrderingIdPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation.
listGroupsOlderThanOrderingIdRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGroupsOlderThanOrderingIdIterable listGroupsOlderThanOrderingIdPaginator(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client
.listGroupsOlderThanOrderingIdPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation.
This is a convenience which creates an instance of the ListGroupsOlderThanOrderingIdRequest.Builder
avoiding the need to create one manually via ListGroupsOlderThanOrderingIdRequest.builder()
listGroupsOlderThanOrderingIdRequest - A Consumer that will call methods on
ListGroupsOlderThanOrderingIdRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesResponse listIndices(ListIndicesRequest listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you created.
listIndicesRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesResponse listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you created.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on
ListIndicesRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesIterable listIndicesPaginator(ListIndicesRequest listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you created.
This is a variant of listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListIndicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
listIndicesRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListIndicesIterable listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the Amazon Kendra indexes that you created.
This is a variant of listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListIndicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on
ListIndicesRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQuerySuggestionsBlockListsResponse listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQuerySuggestionsBlockListsResponse listQuerySuggestionsBlockLists(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the ListQuerySuggestionsBlockListsRequest.Builder
avoiding the need to create one manually via ListQuerySuggestionsBlockListsRequest.builder()
listQuerySuggestionsBlockListsRequest - A Consumer that will call methods on
ListQuerySuggestionsBlockListsRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQuerySuggestionsBlockListsIterable listQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client
.listQuerySuggestionsBlockListsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation.
listQuerySuggestionsBlockListsRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQuerySuggestionsBlockListsIterable listQuerySuggestionsBlockListsPaginator(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a variant of
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client
.listQuerySuggestionsBlockListsPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation.
This is a convenience which creates an instance of the ListQuerySuggestionsBlockListsRequest.Builder
avoiding the need to create one manually via ListQuerySuggestionsBlockListsRequest.builder()
listQuerySuggestionsBlockListsRequest - A Consumer that will call methods on
ListQuerySuggestionsBlockListsRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListThesauriResponse listThesauri(ListThesauriRequest listThesauriRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the thesauri for an index.
listThesauriRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListThesauriResponse listThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the thesauri for an index.
This is a convenience which creates an instance of the ListThesauriRequest.Builder avoiding the need to
create one manually via ListThesauriRequest.builder()
listThesauriRequest - A Consumer that will call methods on
ListThesauriRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListThesauriIterable listThesauriPaginator(ListThesauriRequest listThesauriRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the thesauri for an index.
This is a variant of listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListThesauriResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) operation.
listThesauriRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListThesauriIterable listThesauriPaginator(Consumer<ListThesauriRequest.Builder> listThesauriRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Lists the thesauri for an index.
This is a variant of listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
for (software.amazon.awssdk.services.kendra.model.ListThesauriResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) operation.
This is a convenience which creates an instance of the ListThesauriRequest.Builder avoiding the need to
create one manually via ListThesauriRequest.builder()
listThesauriRequest - A Consumer that will call methods on
ListThesauriRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPrincipalMappingResponse putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
putPrincipalMappingRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPrincipalMappingResponse putPrincipalMapping(Consumer<PutPrincipalMappingRequest.Builder> putPrincipalMappingRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the PutPrincipalMappingRequest.Builder avoiding the
need to create one manually via PutPrincipalMappingRequest.builder()
putPrincipalMappingRequest - A Consumer that will call methods on
PutPrincipalMappingRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault QueryResponse query(QueryRequest queryRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Searches an index given an input query.
If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG)
systems, you can use Amazon Kendra's Retrieve API, which can
return longer semantically relevant passages. We recommend using the Retrieve API instead of filing
a service limit increase to increase the Query API document excerpt length.
You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.
A query response contains three types of results.
Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.
Matching FAQs or questions-answer from your FAQ file.
Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.
You can specify that the query return only one type of result using the QueryResultTypeFilter
parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers,
a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are
returned.
queryRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault QueryResponse query(Consumer<QueryRequest.Builder> queryRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Searches an index given an input query.
If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG)
systems, you can use Amazon Kendra's Retrieve API, which can
return longer semantically relevant passages. We recommend using the Retrieve API instead of filing
a service limit increase to increase the Query API document excerpt length.
You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.
A query response contains three types of results.
Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.
Matching FAQs or questions-answer from your FAQ file.
Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.
You can specify that the query return only one type of result using the QueryResultTypeFilter
parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers,
a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are
returned.
This is a convenience which creates an instance of the QueryRequest.Builder avoiding the need to create
one manually via QueryRequest.builder()
queryRequest - A Consumer that will call methods on
QueryRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetrieveResponse retrieve(RetrieveRequest retrieveRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Retrieves relevant passages or text excerpts given an input query.
This API is similar to the Query API. However, by default,
the Query API only returns excerpt passages of up to 100 token words. With the Retrieve
API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This
doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be
semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your
documents produce zero passages using the Retrieve API, you can alternatively use the
Query API and its types of responses.
You can also do the following:
Override boosting at the index level
Filter based on document fields or attributes
Filter based on the user or their group access to documents
View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
Confidence score buckets are currently available only for English.
You can also include certain fields in the response that might provide useful additional information.
The Retrieve API shares the number of query capacity
units that you set for your index. For more information on what's included in a single capacity unit and the
default base capacity for an index, see Adjusting capacity.
retrieveRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetrieveResponse retrieve(Consumer<RetrieveRequest.Builder> retrieveRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Retrieves relevant passages or text excerpts given an input query.
This API is similar to the Query API. However, by default,
the Query API only returns excerpt passages of up to 100 token words. With the Retrieve
API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This
doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be
semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your
documents produce zero passages using the Retrieve API, you can alternatively use the
Query API and its types of responses.
You can also do the following:
Override boosting at the index level
Filter based on document fields or attributes
Filter based on the user or their group access to documents
View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
Confidence score buckets are currently available only for English.
You can also include certain fields in the response that might provide useful additional information.
The Retrieve API shares the number of query capacity
units that you set for your index. For more information on what's included in a single capacity unit and the
default base capacity for an index, see Adjusting capacity.
This is a convenience which creates an instance of the RetrieveRequest.Builder avoiding the need to
create one manually via RetrieveRequest.builder()
retrieveRequest - A Consumer that will call methods on
RetrieveRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartDataSourceSyncJobResponse startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
Kendra returns a ResourceInUseException exception.
Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
startDataSourceSyncJobRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceInUseException - The resource you want to use is currently in use. Please check you have provided the correct resource and
try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartDataSourceSyncJobResponse startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ResourceInUseException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
Kendra returns a ResourceInUseException exception.
Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
This is a convenience which creates an instance of the StartDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StartDataSourceSyncJobRequest.builder()
startDataSourceSyncJobRequest - A Consumer that will call methods on
StartDataSourceSyncJobRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ResourceInUseException - The resource you want to use is currently in use. Please check you have provided the correct resource and
try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopDataSourceSyncJobResponse stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopDataSourceSyncJobResponse stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
This is a convenience which creates an instance of the StopDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StopDataSourceSyncJobRequest.builder()
stopDataSourceSyncJobRequest - A Consumer that will call methods on
StopDataSourceSyncJobRequest.Builder to create a
request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SubmitFeedbackResponse submitFeedback(SubmitFeedbackRequest submitFeedbackRequest) throws ValidationException, ResourceUnavailableException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
submitFeedbackRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SubmitFeedbackResponse submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest) throws ValidationException, ResourceUnavailableException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the SubmitFeedbackRequest.Builder avoiding the need to
create one manually via SubmitFeedbackRequest.builder()
submitFeedbackRequest - A Consumer that will call methods on
SubmitFeedbackRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
tagResourceRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Removes a tag from an index, FAQ, or a data source.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccessControlConfigurationResponse updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest) throws ValidationException, ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccessControlConfigurationResponse updateAccessControlConfiguration(Consumer<UpdateAccessControlConfigurationRequest.Builder> updateAccessControlConfigurationRequest) throws ValidationException, ThrottlingException, ConflictException, ResourceNotFoundException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the UpdateAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via UpdateAccessControlConfigurationRequest.builder()
updateAccessControlConfigurationRequest - A Consumer that will call methods on
UpdateAccessControlConfigurationRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra data source connector.
updateDataSourceRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra data source connector.
This is a convenience which creates an instance of the UpdateDataSourceRequest.Builder avoiding the need
to create one manually via UpdateDataSourceRequest.builder()
updateDataSourceRequest - A Consumer that will call methods on
UpdateDataSourceRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateExperienceResponse updateExperience(UpdateExperienceRequest updateExperienceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateExperienceResponse updateExperience(Consumer<UpdateExperienceRequest.Builder> updateExperienceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the UpdateExperienceRequest.Builder avoiding the need
to create one manually via UpdateExperienceRequest.builder()
updateExperienceRequest - A Consumer that will call methods on
UpdateExperienceRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFeaturedResultsSetResponse updateFeaturedResultsSet(UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
updateFeaturedResultsSetRequest - ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.FeaturedResultsConflictException - An error message with a list of conflicting queries used across different sets of featured results. This
occurred with the request for a new featured results set. Check that the queries you specified for
featured results are unique per featured results set for each index.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFeaturedResultsSetResponse updateFeaturedResultsSet(Consumer<UpdateFeaturedResultsSetRequest.Builder> updateFeaturedResultsSetRequest) throws ResourceNotFoundException, AccessDeniedException, FeaturedResultsConflictException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the UpdateFeaturedResultsSetRequest.Builder avoiding
the need to create one manually via UpdateFeaturedResultsSetRequest.builder()
updateFeaturedResultsSetRequest - A Consumer that will call methods on
UpdateFeaturedResultsSetRequest.Builder to create a
request.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.FeaturedResultsConflictException - An error message with a list of conflicting queries used across different sets of featured results. This
occurred with the request for a new featured results set. Check that the queries you specified for
featured results are unique per featured results set for each index.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIndexResponse updateIndex(UpdateIndexRequest updateIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra index.
updateIndexRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIndexResponse updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates an existing Amazon Kendra index.
This is a convenience which creates an instance of the UpdateIndexRequest.Builder avoiding the need to
create one manually via UpdateIndexRequest.builder()
updateIndexRequest - A Consumer that will call methods on
UpdateIndexRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateQuerySuggestionsBlockListResponse updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateQuerySuggestionsBlockListResponse updateQuerySuggestionsBlockList(Consumer<UpdateQuerySuggestionsBlockListRequest.Builder> updateQuerySuggestionsBlockListRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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.
This is a convenience which creates an instance of the UpdateQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via UpdateQuerySuggestionsBlockListRequest.builder()
updateQuerySuggestionsBlockListRequest - A Consumer that will call methods on
UpdateQuerySuggestionsBlockListRequest.Builder to
create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateQuerySuggestionsConfigResponse updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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, 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 - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateQuerySuggestionsConfigResponse updateQuerySuggestionsConfig(Consumer<UpdateQuerySuggestionsConfigRequest.Builder> updateQuerySuggestionsConfigRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
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, 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.
This is a convenience which creates an instance of the UpdateQuerySuggestionsConfigRequest.Builder
avoiding the need to create one manually via UpdateQuerySuggestionsConfigRequest.builder()
updateQuerySuggestionsConfigRequest - A Consumer that will call methods on
UpdateQuerySuggestionsConfigRequest.Builder to create
a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateThesaurusResponse updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates a thesaurus for an index.
updateThesaurusRequest - ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateThesaurusResponse updateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Updates a thesaurus for an index.
This is a convenience which creates an instance of the UpdateThesaurusRequest.Builder avoiding the need
to create one manually via UpdateThesaurusRequest.builder()
updateThesaurusRequest - A Consumer that will call methods on
UpdateThesaurusRequest.Builder to create a request.ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
input and try again.ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
again.ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException - You don't have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException - An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes
and try again, or contact Support for help.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic KendraClient create()
KendraClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KendraClientBuilder builder()
KendraClient.static ServiceMetadata serviceMetadata()
default KendraServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.