Interface KendraClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Kendra is a service for indexing large document sets.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateEntitiesToExperience
(Consumer<AssociateEntitiesToExperienceRequest.Builder> associateEntitiesToExperienceRequest) Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.associateEntitiesToExperience
(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest) Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.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.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 BatchDeleteDocumentResponse
batchDeleteDocument
(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest) Removes one or more documents from an index.default BatchDeleteDocumentResponse
batchDeleteDocument
(BatchDeleteDocumentRequest batchDeleteDocumentRequest) Removes one or more documents from an index.batchDeleteFeaturedResultsSet
(Consumer<BatchDeleteFeaturedResultsSetRequest.Builder> batchDeleteFeaturedResultsSetRequest) Removes one or more sets of featured results.batchDeleteFeaturedResultsSet
(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest) Removes one or more sets of featured results.default BatchGetDocumentStatusResponse
batchGetDocumentStatus
(Consumer<BatchGetDocumentStatusRequest.Builder> batchGetDocumentStatusRequest) Returns the indexing status for one or more documents submitted with the BatchPutDocument API.default BatchGetDocumentStatusResponse
batchGetDocumentStatus
(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest) Returns the indexing status for one or more documents submitted with the BatchPutDocument API.default BatchPutDocumentResponse
batchPutDocument
(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest) Adds one or more documents to an index.default BatchPutDocumentResponse
batchPutDocument
(BatchPutDocumentRequest batchPutDocumentRequest) Adds one or more documents to an index.static KendraClientBuilder
builder()
Create a builder that can be used to configure and create aKendraClient
.default ClearQuerySuggestionsResponse
clearQuerySuggestions
(Consumer<ClearQuerySuggestionsRequest.Builder> clearQuerySuggestionsRequest) Clears existing query suggestions from an index.default ClearQuerySuggestionsResponse
clearQuerySuggestions
(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest) Clears existing query suggestions from an index.static KendraClient
create()
Create aKendraClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAccessControlConfiguration
(Consumer<CreateAccessControlConfigurationRequest.Builder> createAccessControlConfigurationRequest) Creates an access configuration for your documents.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.createQuerySuggestionsBlockList
(Consumer<CreateQuerySuggestionsBlockListRequest.Builder> createQuerySuggestionsBlockListRequest) Creates a block list to exlcude certain queries from suggestions.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.deleteAccessControlConfiguration
(Consumer<DeleteAccessControlConfigurationRequest.Builder> deleteAccessControlConfigurationRequest) Deletes an access control configuration that you created for your documents in an index.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 Amazon Kendra index.default DeleteIndexResponse
deleteIndex
(DeleteIndexRequest deleteIndexRequest) Deletes an 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.deleteQuerySuggestionsBlockList
(Consumer<DeleteQuerySuggestionsBlockListRequest.Builder> deleteQuerySuggestionsBlockListRequest) Deletes a block list used for query suggestions for an index.deleteQuerySuggestionsBlockList
(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest) Deletes a block list used for query suggestions for an index.default DeleteThesaurusResponse
deleteThesaurus
(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest) Deletes an Amazon Kendra thesaurus.default DeleteThesaurusResponse
deleteThesaurus
(DeleteThesaurusRequest deleteThesaurusRequest) Deletes an Amazon Kendra thesaurus.describeAccessControlConfiguration
(Consumer<DescribeAccessControlConfigurationRequest.Builder> describeAccessControlConfigurationRequest) Gets information about an access control configuration that you created for your documents in an index.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.describeFeaturedResultsSet
(Consumer<DescribeFeaturedResultsSetRequest.Builder> describeFeaturedResultsSetRequest) Gets information about a set of featured results.describeFeaturedResultsSet
(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest) Gets information about a set of featured results.default DescribeIndexResponse
describeIndex
(Consumer<DescribeIndexRequest.Builder> describeIndexRequest) Gets information about an Amazon Kendra index.default DescribeIndexResponse
describeIndex
(DescribeIndexRequest describeIndexRequest) Gets information about an Amazon Kendra index.default DescribePrincipalMappingResponse
describePrincipalMapping
(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest) Describes the processing ofPUT
andDELETE
actions for mapping users to their groups.default DescribePrincipalMappingResponse
describePrincipalMapping
(DescribePrincipalMappingRequest describePrincipalMappingRequest) Describes the processing ofPUT
andDELETE
actions for mapping users to their groups.describeQuerySuggestionsBlockList
(Consumer<DescribeQuerySuggestionsBlockListRequest.Builder> describeQuerySuggestionsBlockListRequest) Gets information about a block list used for query suggestions for an index.describeQuerySuggestionsBlockList
(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest) Gets information about a block list used for query suggestions for an index.describeQuerySuggestionsConfig
(Consumer<DescribeQuerySuggestionsConfigRequest.Builder> describeQuerySuggestionsConfigRequest) Gets information on the settings of query suggestions for an index.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 Amazon Kendra thesaurus.default DescribeThesaurusResponse
describeThesaurus
(DescribeThesaurusRequest describeThesaurusRequest) Gets information about an Amazon Kendra thesaurus.disassociateEntitiesFromExperience
(Consumer<DisassociateEntitiesFromExperienceRequest.Builder> disassociateEntitiesFromExperienceRequest) Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience.disassociateEntitiesFromExperience
(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest) Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience.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.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) This is a variant ofgetSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)
operation.default GetSnapshotsIterable
getSnapshotsPaginator
(GetSnapshotsRequest getSnapshotsRequest) This is a variant ofgetSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)
operation.listAccessControlConfigurations
(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest) Lists one or more access control configurations for an index.listAccessControlConfigurations
(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest) Lists one or more access control configurations for an index.listAccessControlConfigurationsPaginator
(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest) This is a variant oflistAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation.listAccessControlConfigurationsPaginator
(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest) This is a variant oflistAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation.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) This is a variant oflistDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)
operation.default ListDataSourcesIterable
listDataSourcesPaginator
(ListDataSourcesRequest listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)
operation.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) This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.default ListDataSourceSyncJobsIterable
listDataSourceSyncJobsPaginator
(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.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) This is a variant oflistEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)
operation.default ListEntityPersonasIterable
listEntityPersonasPaginator
(ListEntityPersonasRequest listEntityPersonasRequest) This is a variant oflistEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)
operation.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) This is a variant oflistExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation.default ListExperienceEntitiesIterable
listExperienceEntitiesPaginator
(ListExperienceEntitiesRequest listExperienceEntitiesRequest) This is a variant oflistExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation.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) This is a variant oflistExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)
operation.default ListExperiencesIterable
listExperiencesPaginator
(ListExperiencesRequest listExperiencesRequest) This is a variant oflistExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)
operation.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) This is a variant oflistFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)
operation.default ListFaqsIterable
listFaqsPaginator
(ListFaqsRequest listFaqsRequest) This is a variant oflistFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)
operation.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.listGroupsOlderThanOrderingId
(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest) Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.listGroupsOlderThanOrderingId
(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest) Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.listGroupsOlderThanOrderingIdPaginator
(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest) This is a variant oflistGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation.listGroupsOlderThanOrderingIdPaginator
(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest) This is a variant oflistGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation.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) This is a variant oflistIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation.default ListIndicesIterable
listIndicesPaginator
(ListIndicesRequest listIndicesRequest) This is a variant oflistIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation.listQuerySuggestionsBlockLists
(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest) Lists the block lists used for query suggestions for an index.listQuerySuggestionsBlockLists
(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest) Lists the block lists used for query suggestions for an index.listQuerySuggestionsBlockListsPaginator
(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest) This is a variant oflistQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation.listQuerySuggestionsBlockListsPaginator
(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest) This is a variant oflistQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation.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) This is a variant oflistThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)
operation.default ListThesauriIterable
listThesauriPaginator
(ListThesauriRequest listThesauriRequest) This is a variant oflistThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)
operation.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
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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.updateAccessControlConfiguration
(Consumer<UpdateAccessControlConfigurationRequest.Builder> updateAccessControlConfigurationRequest) Updates an access control configuration for your documents in an index.updateAccessControlConfiguration
(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest) Updates an access control configuration for your documents in an index.default UpdateDataSourceResponse
updateDataSource
(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates an Amazon Kendra data source connector.default UpdateDataSourceResponse
updateDataSource
(UpdateDataSourceRequest updateDataSourceRequest) Updates an 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 Amazon Kendra index.default UpdateIndexResponse
updateIndex
(UpdateIndexRequest updateIndexRequest) Updates an Amazon Kendra index.updateQuerySuggestionsBlockList
(Consumer<UpdateQuerySuggestionsBlockListRequest.Builder> updateQuerySuggestionsBlockListRequest) Updates a block list used for query suggestions for an index.updateQuerySuggestionsBlockList
(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest) Updates a block list used for query suggestions for an index.updateQuerySuggestionsConfig
(Consumer<UpdateQuerySuggestionsConfigRequest.Builder> updateQuerySuggestionsConfigRequest) Updates the settings of query suggestions for an index.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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateEntitiesToExperience
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.
- Parameters:
associateEntitiesToExperienceRequest
-- Returns:
- Result of the AssociateEntitiesToExperience operation returned by the service.
- See Also:
-
associateEntitiesToExperience
default 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 viaAssociateEntitiesToExperienceRequest.builder()
- Parameters:
associateEntitiesToExperienceRequest
- AConsumer
that will call methods onAssociateEntitiesToExperienceRequest.Builder
to create a request.- Returns:
- Result of the AssociateEntitiesToExperience operation returned by the service.
- See Also:
-
associatePersonasToEntities
default 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.
- Parameters:
associatePersonasToEntitiesRequest
-- Returns:
- Result of the AssociatePersonasToEntities operation returned by the service.
- See Also:
-
associatePersonasToEntities
default 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 viaAssociatePersonasToEntitiesRequest.builder()
- Parameters:
associatePersonasToEntitiesRequest
- AConsumer
that will call methods onAssociatePersonasToEntitiesRequest.Builder
to create a request.- Returns:
- Result of the AssociatePersonasToEntities operation returned by the service.
- See Also:
-
batchDeleteDocument
default 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.- Parameters:
batchDeleteDocumentRequest
-- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- See Also:
-
batchDeleteDocument
default 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 viaBatchDeleteDocumentRequest.builder()
- Parameters:
batchDeleteDocumentRequest
- AConsumer
that will call methods onBatchDeleteDocumentRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- See Also:
-
batchDeleteFeaturedResultsSet
default 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.
- Parameters:
batchDeleteFeaturedResultsSetRequest
-- Returns:
- Result of the BatchDeleteFeaturedResultsSet operation returned by the service.
- See Also:
-
batchDeleteFeaturedResultsSet
default 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 viaBatchDeleteFeaturedResultsSetRequest.builder()
- Parameters:
batchDeleteFeaturedResultsSetRequest
- AConsumer
that will call methods onBatchDeleteFeaturedResultsSetRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteFeaturedResultsSet operation returned by the service.
- See Also:
-
batchGetDocumentStatus
default 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 theBatchGetDocumentStatus
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 returnsNOT_FOUND
as the status.- Parameters:
batchGetDocumentStatusRequest
-- Returns:
- Result of the BatchGetDocumentStatus operation returned by the service.
- See Also:
-
batchGetDocumentStatus
default 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 theBatchGetDocumentStatus
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 returnsNOT_FOUND
as the status.
This is a convenience which creates an instance of the
BatchGetDocumentStatusRequest.Builder
avoiding the need to create one manually viaBatchGetDocumentStatusRequest.builder()
- Parameters:
batchGetDocumentStatusRequest
- AConsumer
that will call methods onBatchGetDocumentStatusRequest.Builder
to create a request.- Returns:
- Result of the BatchGetDocumentStatus operation returned by the service.
- See Also:
-
batchPutDocument
default 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.
- Parameters:
batchPutDocumentRequest
-- Returns:
- Result of the BatchPutDocument operation returned by the service.
- See Also:
-
batchPutDocument
default 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 viaBatchPutDocumentRequest.builder()
- Parameters:
batchPutDocumentRequest
- AConsumer
that will call methods onBatchPutDocumentRequest.Builder
to create a request.- Returns:
- Result of the BatchPutDocument operation returned by the service.
- See Also:
-
clearQuerySuggestions
default 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.- Parameters:
clearQuerySuggestionsRequest
-- Returns:
- Result of the ClearQuerySuggestions operation returned by the service.
- See Also:
-
clearQuerySuggestions
default 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 viaClearQuerySuggestionsRequest.builder()
- Parameters:
clearQuerySuggestionsRequest
- AConsumer
that will call methods onClearQuerySuggestionsRequest.Builder
to create a request.- Returns:
- Result of the ClearQuerySuggestions operation returned by the service.
- See Also:
-
createAccessControlConfiguration
default 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 theAccessControlConfigurationId
and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocument
API.- Parameters:
createAccessControlConfigurationRequest
-- Returns:
- Result of the CreateAccessControlConfiguration operation returned by the service.
- See Also:
-
createAccessControlConfiguration
default 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 theAccessControlConfigurationId
and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocument
API.
This is a convenience which creates an instance of the
CreateAccessControlConfigurationRequest.Builder
avoiding the need to create one manually viaCreateAccessControlConfigurationRequest.builder()
- Parameters:
createAccessControlConfigurationRequest
- AConsumer
that will call methods onCreateAccessControlConfigurationRequest.Builder
to create a request.- Returns:
- Result of the CreateAccessControlConfiguration operation returned by the service.
- See Also:
-
createDataSource
default 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.
- Parameters:
createDataSourceRequest
-- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
-
createDataSource
default 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 viaCreateDataSourceRequest.builder()
- Parameters:
createDataSourceRequest
- AConsumer
that will call methods onCreateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
-
createExperience
default 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.
- Parameters:
createExperienceRequest
-- Returns:
- Result of the CreateExperience operation returned by the service.
- See Also:
-
createExperience
default 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 viaCreateExperienceRequest.builder()
- Parameters:
createExperienceRequest
- AConsumer
that will call methods onCreateExperienceRequest.Builder
to create a request.- Returns:
- Result of the CreateExperience operation returned by the service.
- See Also:
-
createFaq
default 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.
- Parameters:
createFaqRequest
-- Returns:
- Result of the CreateFaq operation returned by the service.
- See Also:
-
createFaq
default 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 viaCreateFaqRequest.builder()
- Parameters:
createFaqRequest
- AConsumer
that will call methods onCreateFaqRequest.Builder
to create a request.- Returns:
- Result of the CreateFaq operation returned by the service.
- See Also:
-
createFeaturedResultsSet
default 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.
- Parameters:
createFeaturedResultsSetRequest
-- Returns:
- Result of the CreateFeaturedResultsSet operation returned by the service.
- See Also:
-
createFeaturedResultsSet
default 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 viaCreateFeaturedResultsSetRequest.builder()
- Parameters:
createFeaturedResultsSetRequest
- AConsumer
that will call methods onCreateFeaturedResultsSetRequest.Builder
to create a request.- Returns:
- Result of the CreateFeaturedResultsSet operation returned by the service.
- See Also:
-
createIndex
default 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 toDescribeIndex
. TheStatus
field is set toACTIVE
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.
- Parameters:
createIndexRequest
-- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
createIndex
default 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 toDescribeIndex
. TheStatus
field is set toACTIVE
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 viaCreateIndexRequest.builder()
- Parameters:
createIndexRequest
- AConsumer
that will call methods onCreateIndexRequest.Builder
to create a request.- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
createQuerySuggestionsBlockList
default 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.
- Parameters:
createQuerySuggestionsBlockListRequest
-- Returns:
- Result of the CreateQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
createQuerySuggestionsBlockList
default 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 viaCreateQuerySuggestionsBlockListRequest.builder()
- Parameters:
createQuerySuggestionsBlockListRequest
- AConsumer
that will call methods onCreateQuerySuggestionsBlockListRequest.Builder
to create a request.- Returns:
- Result of the CreateQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
createThesaurus
default 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.
- Parameters:
createThesaurusRequest
-- Returns:
- Result of the CreateThesaurus operation returned by the service.
- See Also:
-
createThesaurus
default 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 viaCreateThesaurusRequest.builder()
- Parameters:
createThesaurusRequest
- AConsumer
that will call methods onCreateThesaurusRequest.Builder
to create a request.- Returns:
- Result of the CreateThesaurus operation returned by the service.
- See Also:
-
deleteAccessControlConfiguration
default 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.
- Parameters:
deleteAccessControlConfigurationRequest
-- Returns:
- Result of the DeleteAccessControlConfiguration operation returned by the service.
- See Also:
-
deleteAccessControlConfiguration
default 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 viaDeleteAccessControlConfigurationRequest.builder()
- Parameters:
deleteAccessControlConfigurationRequest
- AConsumer
that will call methods onDeleteAccessControlConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccessControlConfiguration operation returned by the service.
- See Also:
-
deleteDataSource
default 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 theDescribeDataSource
API is set toDELETING
. 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.
- Parameters:
deleteDataSourceRequest
-- Returns:
- Result of the DeleteDataSource operation returned by the service.
- See Also:
-
deleteDataSource
default 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 theDescribeDataSource
API is set toDELETING
. 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 viaDeleteDataSourceRequest.builder()
- Parameters:
deleteDataSourceRequest
- AConsumer
that will call methods onDeleteDataSourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- See Also:
-
deleteExperience
default 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.
- Parameters:
deleteExperienceRequest
-- Returns:
- Result of the DeleteExperience operation returned by the service.
- See Also:
-
deleteExperience
default 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 viaDeleteExperienceRequest.builder()
- Parameters:
deleteExperienceRequest
- AConsumer
that will call methods onDeleteExperienceRequest.Builder
to create a request.- Returns:
- Result of the DeleteExperience operation returned by the service.
- See Also:
-
deleteFaq
default DeleteFaqResponse deleteFaq(DeleteFaqRequest deleteFaqRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Removes an FAQ from an index.
- Parameters:
deleteFaqRequest
-- Returns:
- Result of the DeleteFaq operation returned by the service.
- See Also:
-
deleteFaq
default 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 viaDeleteFaqRequest.builder()
- Parameters:
deleteFaqRequest
- AConsumer
that will call methods onDeleteFaqRequest.Builder
to create a request.- Returns:
- Result of the DeleteFaq operation returned by the service.
- See Also:
-
deleteIndex
default DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Deletes an 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 theDescribeIndex
API is set toDELETING
.- Parameters:
deleteIndexRequest
-- Returns:
- Result of the DeleteIndex operation returned by the service.
- See Also:
-
deleteIndex
default DeleteIndexResponse deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Deletes an 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 theDescribeIndex
API is set toDELETING
.
This is a convenience which creates an instance of the
DeleteIndexRequest.Builder
avoiding the need to create one manually viaDeleteIndexRequest.builder()
- Parameters:
deleteIndexRequest
- AConsumer
that will call methods onDeleteIndexRequest.Builder
to create a request.- Returns:
- Result of the DeleteIndex operation returned by the service.
- See Also:
-
deletePrincipalMapping
default 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 callingPutPrincipalMapping
. You can update your internal list of users or sub groups and input this list when callingPutPrincipalMapping
.DeletePrincipalMapping
is currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
deletePrincipalMappingRequest
-- Returns:
- Result of the DeletePrincipalMapping operation returned by the service.
- See Also:
-
deletePrincipalMapping
default 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 callingPutPrincipalMapping
. You can update your internal list of users or sub groups and input this list when callingPutPrincipalMapping
.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 viaDeletePrincipalMappingRequest.builder()
- Parameters:
deletePrincipalMappingRequest
- AConsumer
that will call methods onDeletePrincipalMappingRequest.Builder
to create a request.- Returns:
- Result of the DeletePrincipalMapping operation returned by the service.
- See Also:
-
deleteQuerySuggestionsBlockList
default 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.- Parameters:
deleteQuerySuggestionsBlockListRequest
-- Returns:
- Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
deleteQuerySuggestionsBlockList
default 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 viaDeleteQuerySuggestionsBlockListRequest.builder()
- Parameters:
deleteQuerySuggestionsBlockListRequest
- AConsumer
that will call methods onDeleteQuerySuggestionsBlockListRequest.Builder
to create a request.- Returns:
- Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
deleteThesaurus
default DeleteThesaurusResponse deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Deletes an Amazon Kendra thesaurus.
- Parameters:
deleteThesaurusRequest
-- Returns:
- Result of the DeleteThesaurus operation returned by the service.
- See Also:
-
deleteThesaurus
default DeleteThesaurusResponse deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Deletes an Amazon Kendra thesaurus.
This is a convenience which creates an instance of the
DeleteThesaurusRequest.Builder
avoiding the need to create one manually viaDeleteThesaurusRequest.builder()
- Parameters:
deleteThesaurusRequest
- AConsumer
that will call methods onDeleteThesaurusRequest.Builder
to create a request.- Returns:
- Result of the DeleteThesaurus operation returned by the service.
- See Also:
-
describeAccessControlConfiguration
default 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.
- Parameters:
describeAccessControlConfigurationRequest
-- Returns:
- Result of the DescribeAccessControlConfiguration operation returned by the service.
- See Also:
-
describeAccessControlConfiguration
default 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 viaDescribeAccessControlConfigurationRequest.builder()
- Parameters:
describeAccessControlConfigurationRequest
- AConsumer
that will call methods onDescribeAccessControlConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccessControlConfiguration operation returned by the service.
- See Also:
-
describeDataSource
default DescribeDataSourceResponse describeDataSource(DescribeDataSourceRequest describeDataSourceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets information about an Amazon Kendra data source connector.
- Parameters:
describeDataSourceRequest
-- Returns:
- Result of the DescribeDataSource operation returned by the service.
- See Also:
-
describeDataSource
default 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 viaDescribeDataSourceRequest.builder()
- Parameters:
describeDataSourceRequest
- AConsumer
that will call methods onDescribeDataSourceRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataSource operation returned by the service.
- See Also:
-
describeExperience
default 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.
- Parameters:
describeExperienceRequest
-- Returns:
- Result of the DescribeExperience operation returned by the service.
- See Also:
-
describeExperience
default 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 viaDescribeExperienceRequest.builder()
- Parameters:
describeExperienceRequest
- AConsumer
that will call methods onDescribeExperienceRequest.Builder
to create a request.- Returns:
- Result of the DescribeExperience operation returned by the service.
- See Also:
-
describeFaq
default DescribeFaqResponse describeFaq(DescribeFaqRequest describeFaqRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets information about an FAQ list.
- Parameters:
describeFaqRequest
-- Returns:
- Result of the DescribeFaq operation returned by the service.
- See Also:
-
describeFaq
default 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 viaDescribeFaqRequest.builder()
- Parameters:
describeFaqRequest
- AConsumer
that will call methods onDescribeFaqRequest.Builder
to create a request.- Returns:
- Result of the DescribeFaq operation returned by the service.
- See Also:
-
describeFeaturedResultsSet
default 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.
- Parameters:
describeFeaturedResultsSetRequest
-- Returns:
- Result of the DescribeFeaturedResultsSet operation returned by the service.
- See Also:
-
describeFeaturedResultsSet
default 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 viaDescribeFeaturedResultsSetRequest.builder()
- Parameters:
describeFeaturedResultsSetRequest
- AConsumer
that will call methods onDescribeFeaturedResultsSetRequest.Builder
to create a request.- Returns:
- Result of the DescribeFeaturedResultsSet operation returned by the service.
- See Also:
-
describeIndex
default DescribeIndexResponse describeIndex(DescribeIndexRequest describeIndexRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets information about an Amazon Kendra index.
- Parameters:
describeIndexRequest
-- Returns:
- Result of the DescribeIndex operation returned by the service.
- See Also:
-
describeIndex
default DescribeIndexResponse describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets information about an Amazon Kendra index.
This is a convenience which creates an instance of the
DescribeIndexRequest.Builder
avoiding the need to create one manually viaDescribeIndexRequest.builder()
- Parameters:
describeIndexRequest
- AConsumer
that will call methods onDescribeIndexRequest.Builder
to create a request.- Returns:
- Result of the DescribeIndex operation returned by the service.
- See Also:
-
describePrincipalMapping
default DescribePrincipalMappingResponse describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Describes the processing of
PUT
andDELETE
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.- Parameters:
describePrincipalMappingRequest
-- Returns:
- Result of the DescribePrincipalMapping operation returned by the service.
- See Also:
-
describePrincipalMapping
default DescribePrincipalMappingResponse describePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Describes the processing of
PUT
andDELETE
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 viaDescribePrincipalMappingRequest.builder()
- Parameters:
describePrincipalMappingRequest
- AConsumer
that will call methods onDescribePrincipalMappingRequest.Builder
to create a request.- Returns:
- Result of the DescribePrincipalMapping operation returned by the service.
- See Also:
-
describeQuerySuggestionsBlockList
default 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.- Parameters:
describeQuerySuggestionsBlockListRequest
-- Returns:
- Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
describeQuerySuggestionsBlockList
default 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 viaDescribeQuerySuggestionsBlockListRequest.builder()
- Parameters:
describeQuerySuggestionsBlockListRequest
- AConsumer
that will call methods onDescribeQuerySuggestionsBlockListRequest.Builder
to create a request.- Returns:
- Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
describeQuerySuggestionsConfig
default 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.- Parameters:
describeQuerySuggestionsConfigRequest
-- Returns:
- Result of the DescribeQuerySuggestionsConfig operation returned by the service.
- See Also:
-
describeQuerySuggestionsConfig
default 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 viaDescribeQuerySuggestionsConfigRequest.builder()
- Parameters:
describeQuerySuggestionsConfigRequest
- AConsumer
that will call methods onDescribeQuerySuggestionsConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeQuerySuggestionsConfig operation returned by the service.
- See Also:
-
describeThesaurus
default DescribeThesaurusResponse describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets information about an Amazon Kendra thesaurus.
- Parameters:
describeThesaurusRequest
-- Returns:
- Result of the DescribeThesaurus operation returned by the service.
- See Also:
-
describeThesaurus
default DescribeThesaurusResponse describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets information about an Amazon Kendra thesaurus.
This is a convenience which creates an instance of the
DescribeThesaurusRequest.Builder
avoiding the need to create one manually viaDescribeThesaurusRequest.builder()
- Parameters:
describeThesaurusRequest
- AConsumer
that will call methods onDescribeThesaurusRequest.Builder
to create a request.- Returns:
- Result of the DescribeThesaurus operation returned by the service.
- See Also:
-
disassociateEntitiesFromExperience
default 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.
- Parameters:
disassociateEntitiesFromExperienceRequest
-- Returns:
- Result of the DisassociateEntitiesFromExperience operation returned by the service.
- See Also:
-
disassociateEntitiesFromExperience
default 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 viaDisassociateEntitiesFromExperienceRequest.builder()
- Parameters:
disassociateEntitiesFromExperienceRequest
- AConsumer
that will call methods onDisassociateEntitiesFromExperienceRequest.Builder
to create a request.- Returns:
- Result of the DisassociateEntitiesFromExperience operation returned by the service.
- See Also:
-
disassociatePersonasFromEntities
default 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.
- Parameters:
disassociatePersonasFromEntitiesRequest
-- Returns:
- Result of the DisassociatePersonasFromEntities operation returned by the service.
- See Also:
-
disassociatePersonasFromEntities
default 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 viaDisassociatePersonasFromEntitiesRequest.builder()
- Parameters:
disassociatePersonasFromEntitiesRequest
- AConsumer
that will call methods onDisassociatePersonasFromEntitiesRequest.Builder
to create a request.- Returns:
- Result of the DisassociatePersonasFromEntities operation returned by the service.
- See Also:
-
getQuerySuggestions
default 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.- Parameters:
getQuerySuggestionsRequest
-- Returns:
- Result of the GetQuerySuggestions operation returned by the service.
- See Also:
-
getQuerySuggestions
default 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 viaGetQuerySuggestionsRequest.builder()
- Parameters:
getQuerySuggestionsRequest
- AConsumer
that will call methods onGetQuerySuggestionsRequest.Builder
to create a request.- Returns:
- Result of the GetQuerySuggestions operation returned by the service.
- See Also:
-
getSnapshots
default 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.
- Parameters:
getSnapshotsRequest
-- Returns:
- Result of the GetSnapshots operation returned by the service.
- See Also:
-
getSnapshots
default 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 viaGetSnapshotsRequest.builder()
- Parameters:
getSnapshotsRequest
- AConsumer
that will call methods onGetSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the GetSnapshots operation returned by the service.
- See Also:
-
getSnapshotsPaginator
default GetSnapshotsIterable getSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest) throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getSnapshotsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSnapshotsPaginator
default GetSnapshotsIterable getSnapshotsPaginator(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest) throws InvalidRequestException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.GetSnapshotsIterable responses = client.getSnapshotsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetSnapshotsRequest.builder()
- Parameters:
getSnapshotsRequest
- AConsumer
that will call methods onGetSnapshotsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessControlConfigurations
default 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.
- Parameters:
listAccessControlConfigurationsRequest
-- Returns:
- Result of the ListAccessControlConfigurations operation returned by the service.
- See Also:
-
listAccessControlConfigurations
default 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 viaListAccessControlConfigurationsRequest.builder()
- Parameters:
listAccessControlConfigurationsRequest
- AConsumer
that will call methods onListAccessControlConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListAccessControlConfigurations operation returned by the service.
- See Also:
-
listAccessControlConfigurationsPaginator
default ListAccessControlConfigurationsIterable listAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listAccessControlConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccessControlConfigurationsPaginator
default ListAccessControlConfigurationsIterable listAccessControlConfigurationsPaginator(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest) throws ValidationException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsIterable responses = client.listAccessControlConfigurationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAccessControlConfigurationsRequest.builder()
- Parameters:
listAccessControlConfigurationsRequest
- AConsumer
that will call methods onListAccessControlConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSourceSyncJobs
default ListDataSourceSyncJobsResponse listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets statistics about synchronizing a data source connector.
- Parameters:
listDataSourceSyncJobsRequest
-- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- See Also:
-
listDataSourceSyncJobs
default 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 viaListDataSourceSyncJobsRequest.builder()
- Parameters:
listDataSourceSyncJobsRequest
- AConsumer
that will call methods onListDataSourceSyncJobsRequest.Builder
to create a request.- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- See Also:
-
listDataSourceSyncJobsPaginator
default ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDataSourceSyncJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSourceSyncJobsPaginator
default ListDataSourceSyncJobsIterable listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsIterable responses = client.listDataSourceSyncJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDataSourceSyncJobsRequest.builder()
- Parameters:
listDataSourceSyncJobsRequest
- AConsumer
that will call methods onListDataSourceSyncJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSources
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException Lists the data source connectors that you have created.
- Parameters:
listDataSourcesRequest
-- Returns:
- Result of the ListDataSources operation returned by the service.
- See Also:
-
listDataSources
default 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 viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- See Also:
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDataSourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntityPersonas
default 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.
- Parameters:
listEntityPersonasRequest
-- Returns:
- Result of the ListEntityPersonas operation returned by the service.
- See Also:
-
listEntityPersonas
default 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 viaListEntityPersonasRequest.builder()
- Parameters:
listEntityPersonasRequest
- AConsumer
that will call methods onListEntityPersonasRequest.Builder
to create a request.- Returns:
- Result of the ListEntityPersonas operation returned by the service.
- See Also:
-
listEntityPersonasPaginator
default ListEntityPersonasIterable listEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listEntityPersonasRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEntityPersonasPaginator
default ListEntityPersonasIterable listEntityPersonasPaginator(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListEntityPersonasIterable responses = client.listEntityPersonasPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListEntityPersonasRequest.builder()
- Parameters:
listEntityPersonasRequest
- AConsumer
that will call methods onListEntityPersonasRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExperienceEntities
default 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.
- Parameters:
listExperienceEntitiesRequest
-- Returns:
- Result of the ListExperienceEntities operation returned by the service.
- See Also:
-
listExperienceEntities
default 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 viaListExperienceEntitiesRequest.builder()
- Parameters:
listExperienceEntitiesRequest
- AConsumer
that will call methods onListExperienceEntitiesRequest.Builder
to create a request.- Returns:
- Result of the ListExperienceEntities operation returned by the service.
- See Also:
-
listExperienceEntitiesPaginator
default ListExperienceEntitiesIterable listExperienceEntitiesPaginator(ListExperienceEntitiesRequest listExperienceEntitiesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listExperienceEntitiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExperienceEntitiesPaginator
default ListExperienceEntitiesIterable listExperienceEntitiesPaginator(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesIterable responses = client.listExperienceEntitiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListExperienceEntitiesRequest.builder()
- Parameters:
listExperienceEntitiesRequest
- AConsumer
that will call methods onListExperienceEntitiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExperiences
default 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.
- Parameters:
listExperiencesRequest
-- Returns:
- Result of the ListExperiences operation returned by the service.
- See Also:
-
listExperiences
default 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 viaListExperiencesRequest.builder()
- Parameters:
listExperiencesRequest
- AConsumer
that will call methods onListExperiencesRequest.Builder
to create a request.- Returns:
- Result of the ListExperiences operation returned by the service.
- See Also:
-
listExperiencesPaginator
default ListExperiencesIterable listExperiencesPaginator(ListExperiencesRequest listExperiencesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listExperiencesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExperiencesPaginator
default ListExperiencesIterable listExperiencesPaginator(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListExperiencesIterable responses = client.listExperiencesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListExperiencesRequest.builder()
- Parameters:
listExperiencesRequest
- AConsumer
that will call methods onListExperiencesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFaqs
default ListFaqsResponse listFaqs(ListFaqsRequest listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Gets a list of FAQ lists associated with an index.
- Parameters:
listFaqsRequest
-- Returns:
- Result of the ListFaqs operation returned by the service.
- See Also:
-
listFaqs
default 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 viaListFaqsRequest.builder()
- Parameters:
listFaqsRequest
- AConsumer
that will call methods onListFaqsRequest.Builder
to create a request.- Returns:
- Result of the ListFaqs operation returned by the service.
- See Also:
-
listFaqsPaginator
default ListFaqsIterable listFaqsPaginator(ListFaqsRequest listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listFaqsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFaqsPaginator
default ListFaqsIterable listFaqsPaginator(Consumer<ListFaqsRequest.Builder> listFaqsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListFaqsIterable responses = client.listFaqsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListFaqsRequest.builder()
- Parameters:
listFaqsRequest
- AConsumer
that will call methods onListFaqsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFeaturedResultsSets
default 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.
- Parameters:
listFeaturedResultsSetsRequest
-- Returns:
- Result of the ListFeaturedResultsSets operation returned by the service.
- See Also:
-
listFeaturedResultsSets
default 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 viaListFeaturedResultsSetsRequest.builder()
- Parameters:
listFeaturedResultsSetsRequest
- AConsumer
that will call methods onListFeaturedResultsSetsRequest.Builder
to create a request.- Returns:
- Result of the ListFeaturedResultsSets operation returned by the service.
- See Also:
-
listGroupsOlderThanOrderingId
default 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.- Parameters:
listGroupsOlderThanOrderingIdRequest
-- Returns:
- Result of the ListGroupsOlderThanOrderingId operation returned by the service.
- See Also:
-
listGroupsOlderThanOrderingId
default 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 viaListGroupsOlderThanOrderingIdRequest.builder()
- Parameters:
listGroupsOlderThanOrderingIdRequest
- AConsumer
that will call methods onListGroupsOlderThanOrderingIdRequest.Builder
to create a request.- Returns:
- Result of the ListGroupsOlderThanOrderingId operation returned by the service.
- See Also:
-
listGroupsOlderThanOrderingIdPaginator
default ListGroupsOlderThanOrderingIdIterable listGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listGroupsOlderThanOrderingIdRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGroupsOlderThanOrderingIdPaginator
default ListGroupsOlderThanOrderingIdIterable listGroupsOlderThanOrderingIdPaginator(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest) throws ValidationException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdIterable responses = client.listGroupsOlderThanOrderingIdPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListGroupsOlderThanOrderingIdRequest.builder()
- Parameters:
listGroupsOlderThanOrderingIdRequest
- AConsumer
that will call methods onListGroupsOlderThanOrderingIdRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIndices
default ListIndicesResponse listIndices(ListIndicesRequest listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Lists the Amazon Kendra indexes that you created.
- Parameters:
listIndicesRequest
-- Returns:
- Result of the ListIndices operation returned by the service.
- See Also:
-
listIndices
default 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 viaListIndicesRequest.builder()
- Parameters:
listIndicesRequest
- AConsumer
that will call methods onListIndicesRequest.Builder
to create a request.- Returns:
- Result of the ListIndices operation returned by the service.
- See Also:
-
listIndicesPaginator
default ListIndicesIterable listIndicesPaginator(ListIndicesRequest listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listIndicesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIndicesPaginator
default ListIndicesIterable listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws ValidationException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListIndicesRequest.builder()
- Parameters:
listIndicesRequest
- AConsumer
that will call methods onListIndicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQuerySuggestionsBlockLists
default 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.- Parameters:
listQuerySuggestionsBlockListsRequest
-- Returns:
- Result of the ListQuerySuggestionsBlockLists operation returned by the service.
- See Also:
-
listQuerySuggestionsBlockLists
default 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 viaListQuerySuggestionsBlockListsRequest.builder()
- Parameters:
listQuerySuggestionsBlockListsRequest
- AConsumer
that will call methods onListQuerySuggestionsBlockListsRequest.Builder
to create a request.- Returns:
- Result of the ListQuerySuggestionsBlockLists operation returned by the service.
- See Also:
-
listQuerySuggestionsBlockListsPaginator
default ListQuerySuggestionsBlockListsIterable listQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listQuerySuggestionsBlockListsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQuerySuggestionsBlockListsPaginator
default ListQuerySuggestionsBlockListsIterable listQuerySuggestionsBlockListsPaginator(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsIterable responses = client.listQuerySuggestionsBlockListsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListQuerySuggestionsBlockListsRequest.builder()
- Parameters:
listQuerySuggestionsBlockListsRequest
- AConsumer
that will call methods onListQuerySuggestionsBlockListsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default 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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listThesauri
default ListThesauriResponse listThesauri(ListThesauriRequest listThesauriRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Lists the thesauri for an index.
- Parameters:
listThesauriRequest
-- Returns:
- Result of the ListThesauri operation returned by the service.
- See Also:
-
listThesauri
default 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 viaListThesauriRequest.builder()
- Parameters:
listThesauriRequest
- AConsumer
that will call methods onListThesauriRequest.Builder
to create a request.- Returns:
- Result of the ListThesauri operation returned by the service.
- See Also:
-
listThesauriPaginator
default ListThesauriIterable listThesauriPaginator(ListThesauriRequest listThesauriRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listThesauriRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listThesauriPaginator
default ListThesauriIterable listThesauriPaginator(Consumer<ListThesauriRequest.Builder> listThesauriRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException 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 Streamsoftware.amazon.awssdk.services.kendra.paginators.ListThesauriIterable responses = client.listThesauriPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListThesauriRequest.builder()
- Parameters:
listThesauriRequest
- AConsumer
that will call methods onListThesauriRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putPrincipalMapping
default 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.- Parameters:
putPrincipalMappingRequest
-- Returns:
- Result of the PutPrincipalMapping operation returned by the service.
- See Also:
-
putPrincipalMapping
default 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 viaPutPrincipalMappingRequest.builder()
- Parameters:
putPrincipalMappingRequest
- AConsumer
that will call methods onPutPrincipalMappingRequest.Builder
to create a request.- Returns:
- Result of the PutPrincipalMapping operation returned by the service.
- See Also:
-
query
default 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 theQuery
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.- Parameters:
queryRequest
-- Returns:
- Result of the Query operation returned by the service.
- See Also:
-
-
query
default 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 theQuery
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 viaQueryRequest.builder()
- Parameters:
queryRequest
- AConsumer
that will call methods onQueryRequest.Builder
to create a request.- Returns:
- Result of the Query operation returned by the service.
- See Also:
-
-
retrieve
default 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 theRetrieve
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 theRetrieve
API, you can alternatively use theQuery
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.- Parameters:
retrieveRequest
-- Returns:
- Result of the Retrieve operation returned by the service.
- See Also:
-
-
retrieve
default 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 theRetrieve
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 theRetrieve
API, you can alternatively use theQuery
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 viaRetrieveRequest.builder()
- Parameters:
retrieveRequest
- AConsumer
that will call methods onRetrieveRequest.Builder
to create a request.- Returns:
- Result of the Retrieve operation returned by the service.
- See Also:
-
-
startDataSourceSyncJob
default 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.
- Parameters:
startDataSourceSyncJobRequest
-- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- See Also:
-
startDataSourceSyncJob
default 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 viaStartDataSourceSyncJobRequest.builder()
- Parameters:
startDataSourceSyncJobRequest
- AConsumer
that will call methods onStartDataSourceSyncJobRequest.Builder
to create a request.- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- See Also:
-
stopDataSourceSyncJob
default 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.
- Parameters:
stopDataSourceSyncJobRequest
-- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- See Also:
-
stopDataSourceSyncJob
default 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 viaStopDataSourceSyncJobRequest.builder()
- Parameters:
stopDataSourceSyncJobRequest
- AConsumer
that will call methods onStopDataSourceSyncJobRequest.Builder
to create a request.- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- See Also:
-
submitFeedback
default 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.- Parameters:
submitFeedbackRequest
-- Returns:
- Result of the SubmitFeedback operation returned by the service.
- See Also:
-
submitFeedback
default 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 viaSubmitFeedbackRequest.builder()
- Parameters:
submitFeedbackRequest
- AConsumer
that will call methods onSubmitFeedbackRequest.Builder
to create a request.- Returns:
- Result of the SubmitFeedback operation returned by the service.
- See Also:
-
tagResource
default 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.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Removes a tag from an index, FAQ, or a data source.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAccessControlConfiguration
default 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 theAccessControlConfigurationId
in the.metadata.json
file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocument
API.- Parameters:
updateAccessControlConfigurationRequest
-- Returns:
- Result of the UpdateAccessControlConfiguration operation returned by the service.
- See Also:
-
updateAccessControlConfiguration
default 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 theAccessControlConfigurationId
in the.metadata.json
file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocument
API.
This is a convenience which creates an instance of the
UpdateAccessControlConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateAccessControlConfigurationRequest.builder()
- Parameters:
updateAccessControlConfigurationRequest
- AConsumer
that will call methods onUpdateAccessControlConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateAccessControlConfiguration operation returned by the service.
- See Also:
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Updates an Amazon Kendra data source connector.
- Parameters:
updateDataSourceRequest
-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException Updates an Amazon Kendra data source connector.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builder
avoiding the need to create one manually viaUpdateDataSourceRequest.builder()
- Parameters:
updateDataSourceRequest
- AConsumer
that will call methods onUpdateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
-
updateExperience
default 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.
- Parameters:
updateExperienceRequest
-- Returns:
- Result of the UpdateExperience operation returned by the service.
- See Also:
-
updateExperience
default 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 viaUpdateExperienceRequest.builder()
- Parameters:
updateExperienceRequest
- AConsumer
that will call methods onUpdateExperienceRequest.Builder
to create a request.- Returns:
- Result of the UpdateExperience operation returned by the service.
- See Also:
-
updateFeaturedResultsSet
default 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.
- Parameters:
updateFeaturedResultsSetRequest
-- Returns:
- Result of the UpdateFeaturedResultsSet operation returned by the service.
- See Also:
-
updateFeaturedResultsSet
default 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 viaUpdateFeaturedResultsSetRequest.builder()
- Parameters:
updateFeaturedResultsSetRequest
- AConsumer
that will call methods onUpdateFeaturedResultsSetRequest.Builder
to create a request.- Returns:
- Result of the UpdateFeaturedResultsSet operation returned by the service.
- See Also:
-
updateIndex
default UpdateIndexResponse updateIndex(UpdateIndexRequest updateIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException Updates an Amazon Kendra index.
- Parameters:
updateIndexRequest
-- Returns:
- Result of the UpdateIndex operation returned by the service.
- See Also:
-
updateIndex
default UpdateIndexResponse updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest) throws ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, InternalServerException, AwsServiceException, SdkClientException, KendraException Updates an Amazon Kendra index.
This is a convenience which creates an instance of the
UpdateIndexRequest.Builder
avoiding the need to create one manually viaUpdateIndexRequest.builder()
- Parameters:
updateIndexRequest
- AConsumer
that will call methods onUpdateIndexRequest.Builder
to create a request.- Returns:
- Result of the UpdateIndex operation returned by the service.
- See Also:
-
updateQuerySuggestionsBlockList
default 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.- Parameters:
updateQuerySuggestionsBlockListRequest
-- Returns:
- Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
updateQuerySuggestionsBlockList
default 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 viaUpdateQuerySuggestionsBlockListRequest.builder()
- Parameters:
updateQuerySuggestionsBlockListRequest
- AConsumer
that will call methods onUpdateQuerySuggestionsBlockListRequest.Builder
to create a request.- Returns:
- Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
- See Also:
-
updateQuerySuggestionsConfig
default 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.- Parameters:
updateQuerySuggestionsConfigRequest
-- Returns:
- Result of the UpdateQuerySuggestionsConfig operation returned by the service.
- See Also:
-
updateQuerySuggestionsConfig
default 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 viaUpdateQuerySuggestionsConfigRequest.builder()
- Parameters:
updateQuerySuggestionsConfigRequest
- AConsumer
that will call methods onUpdateQuerySuggestionsConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateQuerySuggestionsConfig operation returned by the service.
- See Also:
-
updateThesaurus
default UpdateThesaurusResponse updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraException Updates a thesaurus for an index.
- Parameters:
updateThesaurusRequest
-- Returns:
- Result of the UpdateThesaurus operation returned by the service.
- See Also:
-
updateThesaurus
default 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 viaUpdateThesaurusRequest.builder()
- Parameters:
updateThesaurusRequest
- AConsumer
that will call methods onUpdateThesaurusRequest.Builder
to create a request.- Returns:
- Result of the UpdateThesaurus operation returned by the service.
- See Also:
-
create
Create aKendraClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aKendraClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-