Interface KendraClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface KendraClient extends AwsClient
Service client for accessing kendra. This can be created using the staticbuilder()method.Amazon Kendra is a service for indexing large document sets.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AssociateEntitiesToExperienceResponseassociateEntitiesToExperience(Consumer<AssociateEntitiesToExperienceRequest.Builder> associateEntitiesToExperienceRequest)Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.default AssociateEntitiesToExperienceResponseassociateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.default AssociatePersonasToEntitiesResponseassociatePersonasToEntities(Consumer<AssociatePersonasToEntitiesRequest.Builder> associatePersonasToEntitiesRequest)Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience.default AssociatePersonasToEntitiesResponseassociatePersonasToEntities(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 BatchDeleteDocumentResponsebatchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)Removes one or more documents from an index.default BatchDeleteDocumentResponsebatchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)Removes one or more documents from an index.default BatchDeleteFeaturedResultsSetResponsebatchDeleteFeaturedResultsSet(Consumer<BatchDeleteFeaturedResultsSetRequest.Builder> batchDeleteFeaturedResultsSetRequest)Removes one or more sets of featured results.default BatchDeleteFeaturedResultsSetResponsebatchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest)Removes one or more sets of featured results.default BatchGetDocumentStatusResponsebatchGetDocumentStatus(Consumer<BatchGetDocumentStatusRequest.Builder> batchGetDocumentStatusRequest)Returns the indexing status for one or more documents submitted with the BatchPutDocument API.default BatchGetDocumentStatusResponsebatchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)Returns the indexing status for one or more documents submitted with the BatchPutDocument API.default BatchPutDocumentResponsebatchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)Adds one or more documents to an index.default BatchPutDocumentResponsebatchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)Adds one or more documents to an index.static KendraClientBuilderbuilder()Create a builder that can be used to configure and create aKendraClient.default ClearQuerySuggestionsResponseclearQuerySuggestions(Consumer<ClearQuerySuggestionsRequest.Builder> clearQuerySuggestionsRequest)Clears existing query suggestions from an index.default ClearQuerySuggestionsResponseclearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)Clears existing query suggestions from an index.static KendraClientcreate()Create aKendraClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAccessControlConfigurationResponsecreateAccessControlConfiguration(Consumer<CreateAccessControlConfigurationRequest.Builder> createAccessControlConfigurationRequest)Creates an access configuration for your documents.default CreateAccessControlConfigurationResponsecreateAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)Creates an access configuration for your documents.default CreateDataSourceResponsecreateDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)Creates a data source connector that you want to use with an Amazon Kendra index.default CreateDataSourceResponsecreateDataSource(CreateDataSourceRequest createDataSourceRequest)Creates a data source connector that you want to use with an Amazon Kendra index.default CreateExperienceResponsecreateExperience(Consumer<CreateExperienceRequest.Builder> createExperienceRequest)Creates an Amazon Kendra experience such as a search application.default CreateExperienceResponsecreateExperience(CreateExperienceRequest createExperienceRequest)Creates an Amazon Kendra experience such as a search application.default CreateFaqResponsecreateFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.default CreateFaqResponsecreateFaq(CreateFaqRequest createFaqRequest)Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.default CreateFeaturedResultsSetResponsecreateFeaturedResultsSet(Consumer<CreateFeaturedResultsSetRequest.Builder> createFeaturedResultsSetRequest)Creates a set of featured results to display at the top of the search results page.default CreateFeaturedResultsSetResponsecreateFeaturedResultsSet(CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest)Creates a set of featured results to display at the top of the search results page.default CreateIndexResponsecreateIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)Creates an Amazon Kendra index.default CreateIndexResponsecreateIndex(CreateIndexRequest createIndexRequest)Creates an Amazon Kendra index.default CreateQuerySuggestionsBlockListResponsecreateQuerySuggestionsBlockList(Consumer<CreateQuerySuggestionsBlockListRequest.Builder> createQuerySuggestionsBlockListRequest)Creates a block list to exlcude certain queries from suggestions.default CreateQuerySuggestionsBlockListResponsecreateQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)Creates a block list to exlcude certain queries from suggestions.default CreateThesaurusResponsecreateThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest)Creates a thesaurus for an index.default CreateThesaurusResponsecreateThesaurus(CreateThesaurusRequest createThesaurusRequest)Creates a thesaurus for an index.default DeleteAccessControlConfigurationResponsedeleteAccessControlConfiguration(Consumer<DeleteAccessControlConfigurationRequest.Builder> deleteAccessControlConfigurationRequest)Deletes an access control configuration that you created for your documents in an index.default DeleteAccessControlConfigurationResponsedeleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)Deletes an access control configuration that you created for your documents in an index.default DeleteDataSourceResponsedeleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)Deletes an Amazon Kendra data source connector.default DeleteDataSourceResponsedeleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)Deletes an Amazon Kendra data source connector.default DeleteExperienceResponsedeleteExperience(Consumer<DeleteExperienceRequest.Builder> deleteExperienceRequest)Deletes your Amazon Kendra experience such as a search application.default DeleteExperienceResponsedeleteExperience(DeleteExperienceRequest deleteExperienceRequest)Deletes your Amazon Kendra experience such as a search application.default DeleteFaqResponsedeleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)Removes an FAQ from an index.default DeleteFaqResponsedeleteFaq(DeleteFaqRequest deleteFaqRequest)Removes an FAQ from an index.default DeleteIndexResponsedeleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)Deletes an Amazon Kendra index.default DeleteIndexResponsedeleteIndex(DeleteIndexRequest deleteIndexRequest)Deletes an Amazon Kendra index.default DeletePrincipalMappingResponsedeletePrincipalMapping(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 DeletePrincipalMappingResponsedeletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.default DeleteQuerySuggestionsBlockListResponsedeleteQuerySuggestionsBlockList(Consumer<DeleteQuerySuggestionsBlockListRequest.Builder> deleteQuerySuggestionsBlockListRequest)Deletes a block list used for query suggestions for an index.default DeleteQuerySuggestionsBlockListResponsedeleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)Deletes a block list used for query suggestions for an index.default DeleteThesaurusResponsedeleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest)Deletes an Amazon Kendra thesaurus.default DeleteThesaurusResponsedeleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)Deletes an Amazon Kendra thesaurus.default DescribeAccessControlConfigurationResponsedescribeAccessControlConfiguration(Consumer<DescribeAccessControlConfigurationRequest.Builder> describeAccessControlConfigurationRequest)Gets information about an access control configuration that you created for your documents in an index.default DescribeAccessControlConfigurationResponsedescribeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)Gets information about an access control configuration that you created for your documents in an index.default DescribeDataSourceResponsedescribeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)Gets information about an Amazon Kendra data source connector.default DescribeDataSourceResponsedescribeDataSource(DescribeDataSourceRequest describeDataSourceRequest)Gets information about an Amazon Kendra data source connector.default DescribeExperienceResponsedescribeExperience(Consumer<DescribeExperienceRequest.Builder> describeExperienceRequest)Gets information about your Amazon Kendra experience such as a search application.default DescribeExperienceResponsedescribeExperience(DescribeExperienceRequest describeExperienceRequest)Gets information about your Amazon Kendra experience such as a search application.default DescribeFaqResponsedescribeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)Gets information about an FAQ list.default DescribeFaqResponsedescribeFaq(DescribeFaqRequest describeFaqRequest)Gets information about an FAQ list.default DescribeFeaturedResultsSetResponsedescribeFeaturedResultsSet(Consumer<DescribeFeaturedResultsSetRequest.Builder> describeFeaturedResultsSetRequest)Gets information about a set of featured results.default DescribeFeaturedResultsSetResponsedescribeFeaturedResultsSet(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest)Gets information about a set of featured results.default DescribeIndexResponsedescribeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)Gets information about an Amazon Kendra index.default DescribeIndexResponsedescribeIndex(DescribeIndexRequest describeIndexRequest)Gets information about an Amazon Kendra index.default DescribePrincipalMappingResponsedescribePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest)Describes the processing ofPUTandDELETEactions for mapping users to their groups.default DescribePrincipalMappingResponsedescribePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)Describes the processing ofPUTandDELETEactions for mapping users to their groups.default DescribeQuerySuggestionsBlockListResponsedescribeQuerySuggestionsBlockList(Consumer<DescribeQuerySuggestionsBlockListRequest.Builder> describeQuerySuggestionsBlockListRequest)Gets information about a block list used for query suggestions for an index.default DescribeQuerySuggestionsBlockListResponsedescribeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)Gets information about a block list used for query suggestions for an index.default DescribeQuerySuggestionsConfigResponsedescribeQuerySuggestionsConfig(Consumer<DescribeQuerySuggestionsConfigRequest.Builder> describeQuerySuggestionsConfigRequest)Gets information on the settings of query suggestions for an index.default DescribeQuerySuggestionsConfigResponsedescribeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)Gets information on the settings of query suggestions for an index.default DescribeThesaurusResponsedescribeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest)Gets information about an Amazon Kendra thesaurus.default DescribeThesaurusResponsedescribeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)Gets information about an Amazon Kendra thesaurus.default DisassociateEntitiesFromExperienceResponsedisassociateEntitiesFromExperience(Consumer<DisassociateEntitiesFromExperienceRequest.Builder> disassociateEntitiesFromExperienceRequest)Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience.default DisassociateEntitiesFromExperienceResponsedisassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience.default DisassociatePersonasFromEntitiesResponsedisassociatePersonasFromEntities(Consumer<DisassociatePersonasFromEntitiesRequest.Builder> disassociatePersonasFromEntitiesRequest)Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience.default DisassociatePersonasFromEntitiesResponsedisassociatePersonasFromEntities(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 GetQuerySuggestionsResponsegetQuerySuggestions(Consumer<GetQuerySuggestionsRequest.Builder> getQuerySuggestionsRequest)Fetches the queries that are suggested to your users.default GetQuerySuggestionsResponsegetQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)Fetches the queries that are suggested to your users.default GetSnapshotsResponsegetSnapshots(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)Retrieves search metrics data.default GetSnapshotsResponsegetSnapshots(GetSnapshotsRequest getSnapshotsRequest)Retrieves search metrics data.default GetSnapshotsIterablegetSnapshotsPaginator(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)This is a variant ofgetSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)operation.default GetSnapshotsIterablegetSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest)This is a variant ofgetSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)operation.default ListAccessControlConfigurationsResponselistAccessControlConfigurations(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)Lists one or more access control configurations for an index.default ListAccessControlConfigurationsResponselistAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)Lists one or more access control configurations for an index.default ListAccessControlConfigurationsIterablelistAccessControlConfigurationsPaginator(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)This is a variant oflistAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)operation.default ListAccessControlConfigurationsIterablelistAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)This is a variant oflistAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)operation.default ListDataSourcesResponselistDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)Lists the data source connectors that you have created.default ListDataSourcesResponselistDataSources(ListDataSourcesRequest listDataSourcesRequest)Lists the data source connectors that you have created.default ListDataSourcesIterablelistDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)This is a variant oflistDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)operation.default ListDataSourcesIterablelistDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)This is a variant oflistDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest)operation.default ListDataSourceSyncJobsResponselistDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)Gets statistics about synchronizing a data source connector.default ListDataSourceSyncJobsResponselistDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)Gets statistics about synchronizing a data source connector.default ListDataSourceSyncJobsIterablelistDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)operation.default ListDataSourceSyncJobsIterablelistDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)This is a variant oflistDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)operation.default ListEntityPersonasResponselistEntityPersonas(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)Lists specific permissions of users and groups with access to your Amazon Kendra experience.default ListEntityPersonasResponselistEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)Lists specific permissions of users and groups with access to your Amazon Kendra experience.default ListEntityPersonasIterablelistEntityPersonasPaginator(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)This is a variant oflistEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)operation.default ListEntityPersonasIterablelistEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest)This is a variant oflistEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)operation.default ListExperienceEntitiesResponselistExperienceEntities(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 ListExperienceEntitiesResponselistExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience.default ListExperienceEntitiesIterablelistExperienceEntitiesPaginator(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)This is a variant oflistExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)operation.default ListExperienceEntitiesIterablelistExperienceEntitiesPaginator(ListExperienceEntitiesRequest listExperienceEntitiesRequest)This is a variant oflistExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)operation.default ListExperiencesResponselistExperiences(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)Lists one or more Amazon Kendra experiences.default ListExperiencesResponselistExperiences(ListExperiencesRequest listExperiencesRequest)Lists one or more Amazon Kendra experiences.default ListExperiencesIterablelistExperiencesPaginator(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)This is a variant oflistExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)operation.default ListExperiencesIterablelistExperiencesPaginator(ListExperiencesRequest listExperiencesRequest)This is a variant oflistExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest)operation.default ListFaqsResponselistFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)Gets a list of FAQ lists associated with an index.default ListFaqsResponselistFaqs(ListFaqsRequest listFaqsRequest)Gets a list of FAQ lists associated with an index.default ListFaqsIterablelistFaqsPaginator(Consumer<ListFaqsRequest.Builder> listFaqsRequest)This is a variant oflistFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)operation.default ListFaqsIterablelistFaqsPaginator(ListFaqsRequest listFaqsRequest)This is a variant oflistFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest)operation.default ListFeaturedResultsSetsResponselistFeaturedResultsSets(Consumer<ListFeaturedResultsSetsRequest.Builder> listFeaturedResultsSetsRequest)Lists all your sets of featured results for a given index.default ListFeaturedResultsSetsResponselistFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest)Lists all your sets of featured results for a given index.default ListGroupsOlderThanOrderingIdResponselistGroupsOlderThanOrderingId(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.default ListGroupsOlderThanOrderingIdResponselistGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.default ListGroupsOlderThanOrderingIdIterablelistGroupsOlderThanOrderingIdPaginator(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)This is a variant oflistGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)operation.default ListGroupsOlderThanOrderingIdIterablelistGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)This is a variant oflistGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)operation.default ListIndicesResponselistIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)Lists the Amazon Kendra indexes that you created.default ListIndicesResponselistIndices(ListIndicesRequest listIndicesRequest)Lists the Amazon Kendra indexes that you created.default ListIndicesIterablelistIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)This is a variant oflistIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)operation.default ListIndicesIterablelistIndicesPaginator(ListIndicesRequest listIndicesRequest)This is a variant oflistIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)operation.default ListQuerySuggestionsBlockListsResponselistQuerySuggestionsBlockLists(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)Lists the block lists used for query suggestions for an index.default ListQuerySuggestionsBlockListsResponselistQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)Lists the block lists used for query suggestions for an index.default ListQuerySuggestionsBlockListsIterablelistQuerySuggestionsBlockListsPaginator(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)This is a variant oflistQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)operation.default ListQuerySuggestionsBlockListsIterablelistQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)This is a variant oflistQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Gets a list of tags associated with a specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Gets a list of tags associated with a specified resource.default ListThesauriResponselistThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest)Lists the thesauri for an index.default ListThesauriResponselistThesauri(ListThesauriRequest listThesauriRequest)Lists the thesauri for an index.default ListThesauriIterablelistThesauriPaginator(Consumer<ListThesauriRequest.Builder> listThesauriRequest)This is a variant oflistThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)operation.default ListThesauriIterablelistThesauriPaginator(ListThesauriRequest listThesauriRequest)This is a variant oflistThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)operation.default PutPrincipalMappingResponseputPrincipalMapping(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 PutPrincipalMappingResponseputPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)Maps users to their groups so that you only need to provide the user ID when you issue the query.default QueryResponsequery(Consumer<QueryRequest.Builder> queryRequest)Searches an index given an input query.default QueryResponsequery(QueryRequest queryRequest)Searches an index given an input query.default RetrieveResponseretrieve(Consumer<RetrieveRequest.Builder> retrieveRequest)Retrieves relevant passages or text excerpts given an input query.default RetrieveResponseretrieve(RetrieveRequest retrieveRequest)Retrieves relevant passages or text excerpts given an input query.default KendraServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartDataSourceSyncJobResponsestartDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)Starts a synchronization job for a data source connector.default StartDataSourceSyncJobResponsestartDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)Starts a synchronization job for a data source connector.default StopDataSourceSyncJobResponsestopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)Stops a synchronization job that is currently running.default StopDataSourceSyncJobResponsestopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)Stops a synchronization job that is currently running.default SubmitFeedbackResponsesubmitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)Enables you to provide feedback to Amazon Kendra to improve the performance of your index.default SubmitFeedbackResponsesubmitFeedback(SubmitFeedbackRequest submitFeedbackRequest)Enables you to provide feedback to Amazon Kendra to improve the performance of your index.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds the specified tag to the specified index, FAQ, or data source resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds the specified tag to the specified index, FAQ, or data source resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes a tag from an index, FAQ, or a data source.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes a tag from an index, FAQ, or a data source.default UpdateAccessControlConfigurationResponseupdateAccessControlConfiguration(Consumer<UpdateAccessControlConfigurationRequest.Builder> updateAccessControlConfigurationRequest)Updates an access control configuration for your documents in an index.default UpdateAccessControlConfigurationResponseupdateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)Updates an access control configuration for your documents in an index.default UpdateDataSourceResponseupdateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)Updates an Amazon Kendra data source connector.default UpdateDataSourceResponseupdateDataSource(UpdateDataSourceRequest updateDataSourceRequest)Updates an Amazon Kendra data source connector.default UpdateExperienceResponseupdateExperience(Consumer<UpdateExperienceRequest.Builder> updateExperienceRequest)Updates your Amazon Kendra experience such as a search application.default UpdateExperienceResponseupdateExperience(UpdateExperienceRequest updateExperienceRequest)Updates your Amazon Kendra experience such as a search application.default UpdateFeaturedResultsSetResponseupdateFeaturedResultsSet(Consumer<UpdateFeaturedResultsSetRequest.Builder> updateFeaturedResultsSetRequest)Updates a set of featured results.default UpdateFeaturedResultsSetResponseupdateFeaturedResultsSet(UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest)Updates a set of featured results.default UpdateIndexResponseupdateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)Updates an Amazon Kendra index.default UpdateIndexResponseupdateIndex(UpdateIndexRequest updateIndexRequest)Updates an Amazon Kendra index.default UpdateQuerySuggestionsBlockListResponseupdateQuerySuggestionsBlockList(Consumer<UpdateQuerySuggestionsBlockListRequest.Builder> updateQuerySuggestionsBlockListRequest)Updates a block list used for query suggestions for an index.default UpdateQuerySuggestionsBlockListResponseupdateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)Updates a block list used for query suggestions for an index.default UpdateQuerySuggestionsConfigResponseupdateQuerySuggestionsConfig(Consumer<UpdateQuerySuggestionsConfigRequest.Builder> updateQuerySuggestionsConfigRequest)Updates the settings of query suggestions for an index.default UpdateQuerySuggestionsConfigResponseupdateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)Updates the settings of query suggestions for an index.default UpdateThesaurusResponseupdateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest)Updates a thesaurus for an index.default UpdateThesaurusResponseupdateThesaurus(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAssociateEntitiesToExperienceRequest.builder()- Parameters:
associateEntitiesToExperienceRequest- AConsumerthat will call methods onAssociateEntitiesToExperienceRequest.Builderto create a request.- Returns:
- Result of the AssociateEntitiesToExperience operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAssociatePersonasToEntitiesRequest.builder()- Parameters:
associatePersonasToEntitiesRequest- AConsumerthat will call methods onAssociatePersonasToEntitiesRequest.Builderto create a request.- Returns:
- Result of the AssociatePersonasToEntities operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
BatchPutDocumentAPI.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
BatchGetDocumentStatusAPI to monitor the progress of deleting your documents.Deleting documents from an index using
BatchDeleteDocumentcould 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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
BatchPutDocumentAPI.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
BatchGetDocumentStatusAPI to monitor the progress of deleting your documents.Deleting documents from an index using
BatchDeleteDocumentcould 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.Builderavoiding the need to create one manually viaBatchDeleteDocumentRequest.builder()- Parameters:
batchDeleteDocumentRequest- AConsumerthat will call methods onBatchDeleteDocumentRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteDocument operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaBatchDeleteFeaturedResultsSetRequest.builder()- Parameters:
batchDeleteFeaturedResultsSetRequest- AConsumerthat will call methods onBatchDeleteFeaturedResultsSetRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteFeaturedResultsSet operation returned by the service.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
BatchPutDocumentAPI, documents are indexed asynchronously. You can use theBatchGetDocumentStatusAPI 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
BatchGetDocumentStatusAPI to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returnsNOT_FOUNDas the status.- Parameters:
batchGetDocumentStatusRequest-- Returns:
- Result of the BatchGetDocumentStatus operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
BatchPutDocumentAPI, documents are indexed asynchronously. You can use theBatchGetDocumentStatusAPI 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
BatchGetDocumentStatusAPI to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returnsNOT_FOUNDas the status.
This is a convenience which creates an instance of the
BatchGetDocumentStatusRequest.Builderavoiding the need to create one manually viaBatchGetDocumentStatusRequest.builder()- Parameters:
batchGetDocumentStatusRequest- AConsumerthat will call methods onBatchGetDocumentStatusRequest.Builderto create a request.- Returns:
- Result of the BatchGetDocumentStatus operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
BatchPutDocumentAPI 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
BatchGetDocumentStatusAPI 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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
BatchPutDocumentAPI 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
BatchGetDocumentStatusAPI 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.Builderavoiding the need to create one manually viaBatchPutDocumentRequest.builder()- Parameters:
batchPutDocumentRequest- AConsumerthat will call methods onBatchPutDocumentRequest.Builderto create a request.- Returns:
- Result of the BatchPutDocument operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
ClearQuerySuggestionsis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
clearQuerySuggestionsRequest-- Returns:
- Result of the ClearQuerySuggestions operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
ClearQuerySuggestionsis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
ClearQuerySuggestionsRequest.Builderavoiding the need to create one manually viaClearQuerySuggestionsRequest.builder()- Parameters:
clearQuerySuggestionsRequest- AConsumerthat will call methods onClearQuerySuggestionsRequest.Builderto create a request.- Returns:
- Result of the ClearQuerySuggestions operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
AccessControlConfigurationIdincluded in the Document object. If you use an S3 bucket as a data source, you update the.metadata.jsonwith theAccessControlConfigurationIdand synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocumentAPI.- Parameters:
createAccessControlConfigurationRequest-- Returns:
- Result of the CreateAccessControlConfiguration operation returned by the service.
- Throws:
ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
AccessControlConfigurationIdincluded in the Document object. If you use an S3 bucket as a data source, you update the.metadata.jsonwith theAccessControlConfigurationIdand synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocumentAPI.
This is a convenience which creates an instance of the
CreateAccessControlConfigurationRequest.Builderavoiding the need to create one manually viaCreateAccessControlConfigurationRequest.builder()- Parameters:
createAccessControlConfigurationRequest- AConsumerthat will call methods onCreateAccessControlConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateAccessControlConfiguration operation returned by the service.
- Throws:
ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
CreateDataSourceis 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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
CreateDataSourceis 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.Builderavoiding the need to create one manually viaCreateDataSourceRequest.builder()- Parameters:
createDataSourceRequest- AConsumerthat will call methods onCreateDataSourceRequest.Builderto create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateExperienceRequest.builder()- Parameters:
createExperienceRequest- AConsumerthat will call methods onCreateExperienceRequest.Builderto create a request.- Returns:
- Result of the CreateExperience operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateFaqRequest.builder()- Parameters:
createFaqRequest- AConsumerthat will call methods onCreateFaqRequest.Builderto create a request.- Returns:
- Result of the CreateFaq operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.FeaturedResultsConflictException- An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateFeaturedResultsSetRequest.builder()- Parameters:
createFeaturedResultsSetRequest- AConsumerthat will call methods onCreateFeaturedResultsSetRequest.Builderto create a request.- Returns:
- Result of the CreateFeaturedResultsSet operation returned by the service.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.FeaturedResultsConflictException- An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Statusfield returned from a call toDescribeIndex. TheStatusfield is set toACTIVEwhen the index is ready to use.Once the index is active, you can index your documents using the
BatchPutDocumentAPI 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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Statusfield returned from a call toDescribeIndex. TheStatusfield is set toACTIVEwhen the index is ready to use.Once the index is active, you can index your documents using the
BatchPutDocumentAPI 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.Builderavoiding the need to create one manually viaCreateIndexRequest.builder()- Parameters:
createIndexRequest- AConsumerthat will call methods onCreateIndexRequest.Builderto create a request.- Returns:
- Result of the CreateIndex operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceAlreadyExistException- The resource you want to use already exists. Please check you have provided the correct resource and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
CreateQuerySuggestionsBlockListis 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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
CreateQuerySuggestionsBlockListis 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.Builderavoiding the need to create one manually viaCreateQuerySuggestionsBlockListRequest.builder()- Parameters:
createQuerySuggestionsBlockListRequest- AConsumerthat will call methods onCreateQuerySuggestionsBlockListRequest.Builderto create a request.- Returns:
- Result of the CreateQuerySuggestionsBlockList operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateThesaurusRequest.builder()- Parameters:
createThesaurusRequest- AConsumerthat will call methods onCreateThesaurusRequest.Builderto create a request.- Returns:
- Result of the CreateThesaurus operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAccessControlConfigurationRequest.builder()- Parameters:
deleteAccessControlConfigurationRequest- AConsumerthat will call methods onDeleteAccessControlConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteAccessControlConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Statusfield returned by a call to theDescribeDataSourceAPI 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.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Statusfield returned by a call to theDescribeDataSourceAPI 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.Builderavoiding the need to create one manually viaDeleteDataSourceRequest.builder()- Parameters:
deleteDataSourceRequest- AConsumerthat will call methods onDeleteDataSourceRequest.Builderto create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteExperienceRequest.builder()- Parameters:
deleteExperienceRequest- AConsumerthat will call methods onDeleteExperienceRequest.Builderto create a request.- Returns:
- Result of the DeleteExperience operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteFaqRequest.builder()- Parameters:
deleteFaqRequest- AConsumerthat will call methods onDeleteFaqRequest.Builderto create a request.- Returns:
- Result of the DeleteFaq operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Statusfield returned by a call to theDescribeIndexAPI is set toDELETING.- Parameters:
deleteIndexRequest-- Returns:
- Result of the DeleteIndex operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Statusfield returned by a call to theDescribeIndexAPI is set toDELETING.
This is a convenience which creates an instance of the
DeleteIndexRequest.Builderavoiding the need to create one manually viaDeleteIndexRequest.builder()- Parameters:
deleteIndexRequest- AConsumerthat will call methods onDeleteIndexRequest.Builderto create a request.- Returns:
- Result of the DeleteIndex operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
PutPrincipalMappingoperation. 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.DeletePrincipalMappingis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
deletePrincipalMappingRequest-- Returns:
- Result of the DeletePrincipalMapping operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
PutPrincipalMappingoperation. 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.DeletePrincipalMappingis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
DeletePrincipalMappingRequest.Builderavoiding the need to create one manually viaDeletePrincipalMappingRequest.builder()- Parameters:
deletePrincipalMappingRequest- AConsumerthat will call methods onDeletePrincipalMappingRequest.Builderto create a request.- Returns:
- Result of the DeletePrincipalMapping operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
DeleteQuerySuggestionsBlockListis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
deleteQuerySuggestionsBlockListRequest-- Returns:
- Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
DeleteQuerySuggestionsBlockListis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
DeleteQuerySuggestionsBlockListRequest.Builderavoiding the need to create one manually viaDeleteQuerySuggestionsBlockListRequest.builder()- Parameters:
deleteQuerySuggestionsBlockListRequest- AConsumerthat will call methods onDeleteQuerySuggestionsBlockListRequest.Builderto create a request.- Returns:
- Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteThesaurusRequest.builder()- Parameters:
deleteThesaurusRequest- AConsumerthat will call methods onDeleteThesaurusRequest.Builderto create a request.- Returns:
- Result of the DeleteThesaurus operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeAccessControlConfigurationRequest.builder()- Parameters:
describeAccessControlConfigurationRequest- AConsumerthat will call methods onDescribeAccessControlConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeAccessControlConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeDataSourceRequest.builder()- Parameters:
describeDataSourceRequest- AConsumerthat will call methods onDescribeDataSourceRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSource operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeExperienceRequest.builder()- Parameters:
describeExperienceRequest- AConsumerthat will call methods onDescribeExperienceRequest.Builderto create a request.- Returns:
- Result of the DescribeExperience operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeFaqRequest.builder()- Parameters:
describeFaqRequest- AConsumerthat will call methods onDescribeFaqRequest.Builderto create a request.- Returns:
- Result of the DescribeFaq operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeFeaturedResultsSetRequest.builder()- Parameters:
describeFeaturedResultsSetRequest- AConsumerthat will call methods onDescribeFeaturedResultsSetRequest.Builderto create a request.- Returns:
- Result of the DescribeFeaturedResultsSet operation returned by the service.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeIndexRequest.builder()- Parameters:
describeIndexRequest- AConsumerthat will call methods onDescribeIndexRequest.Builderto create a request.- Returns:
- Result of the DescribeIndex operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePrincipalMapping
default DescribePrincipalMappingResponse describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Describes the processing of
PUTandDELETEactions 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.DescribePrincipalMappingis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
describePrincipalMappingRequest-- Returns:
- Result of the DescribePrincipalMapping operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePrincipalMapping
default DescribePrincipalMappingResponse describePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraException
Describes the processing of
PUTandDELETEactions 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.DescribePrincipalMappingis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
DescribePrincipalMappingRequest.Builderavoiding the need to create one manually viaDescribePrincipalMappingRequest.builder()- Parameters:
describePrincipalMappingRequest- AConsumerthat will call methods onDescribePrincipalMappingRequest.Builderto create a request.- Returns:
- Result of the DescribePrincipalMapping operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
DescribeQuerySuggestionsBlockListis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
describeQuerySuggestionsBlockListRequest-- Returns:
- Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
DescribeQuerySuggestionsBlockListis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
DescribeQuerySuggestionsBlockListRequest.Builderavoiding the need to create one manually viaDescribeQuerySuggestionsBlockListRequest.builder()- Parameters:
describeQuerySuggestionsBlockListRequest- AConsumerthat will call methods onDescribeQuerySuggestionsBlockListRequest.Builderto create a request.- Returns:
- Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
DescribeQuerySuggestionsConfigis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
describeQuerySuggestionsConfigRequest-- Returns:
- Result of the DescribeQuerySuggestionsConfig operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
DescribeQuerySuggestionsConfigis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
DescribeQuerySuggestionsConfigRequest.Builderavoiding the need to create one manually viaDescribeQuerySuggestionsConfigRequest.builder()- Parameters:
describeQuerySuggestionsConfigRequest- AConsumerthat will call methods onDescribeQuerySuggestionsConfigRequest.Builderto create a request.- Returns:
- Result of the DescribeQuerySuggestionsConfig operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeThesaurusRequest.builder()- Parameters:
describeThesaurusRequest- AConsumerthat will call methods onDescribeThesaurusRequest.Builderto create a request.- Returns:
- Result of the DescribeThesaurus operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDisassociateEntitiesFromExperienceRequest.builder()- Parameters:
disassociateEntitiesFromExperienceRequest- AConsumerthat will call methods onDisassociateEntitiesFromExperienceRequest.Builderto create a request.- Returns:
- Result of the DisassociateEntitiesFromExperience operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDisassociatePersonasFromEntitiesRequest.builder()- Parameters:
disassociatePersonasFromEntitiesRequest- AConsumerthat will call methods onDisassociatePersonasFromEntitiesRequest.Builderto create a request.- Returns:
- Result of the DisassociatePersonasFromEntities operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
GetQuerySuggestionsis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
getQuerySuggestionsRequest-- Returns:
- Result of the GetQuerySuggestions operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
GetQuerySuggestionsis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
GetQuerySuggestionsRequest.Builderavoiding the need to create one manually viaGetQuerySuggestionsRequest.builder()- Parameters:
getQuerySuggestionsRequest- AConsumerthat will call methods onGetQuerySuggestionsRequest.Builderto create a request.- Returns:
- Result of the GetQuerySuggestions operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidRequestException- The input to the request is not valid. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetSnapshotsRequest.builder()- Parameters:
getSnapshotsRequest- AConsumerthat will call methods onGetSnapshotsRequest.Builderto create a request.- Returns:
- Result of the GetSnapshots operation returned by the service.
- Throws:
InvalidRequestException- The input to the request is not valid. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
InvalidRequestException- The input to the request is not valid. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaGetSnapshotsRequest.builder()- Parameters:
getSnapshotsRequest- AConsumerthat will call methods onGetSnapshotsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException- The input to the request is not valid. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAccessControlConfigurationsRequest.builder()- Parameters:
listAccessControlConfigurationsRequest- AConsumerthat will call methods onListAccessControlConfigurationsRequest.Builderto create a request.- Returns:
- Result of the ListAccessControlConfigurations operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListAccessControlConfigurationsRequest.builder()- Parameters:
listAccessControlConfigurationsRequest- AConsumerthat will call methods onListAccessControlConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListDataSourceSyncJobsRequest.builder()- Parameters:
listDataSourceSyncJobsRequest- AConsumerthat will call methods onListDataSourceSyncJobsRequest.Builderto create a request.- Returns:
- Result of the ListDataSourceSyncJobs operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListDataSourceSyncJobsRequest.builder()- Parameters:
listDataSourceSyncJobsRequest- AConsumerthat will call methods onListDataSourceSyncJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListEntityPersonasRequest.builder()- Parameters:
listEntityPersonasRequest- AConsumerthat will call methods onListEntityPersonasRequest.Builderto create a request.- Returns:
- Result of the ListEntityPersonas operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListEntityPersonasRequest.builder()- Parameters:
listEntityPersonasRequest- AConsumerthat will call methods onListEntityPersonasRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListExperienceEntitiesRequest.builder()- Parameters:
listExperienceEntitiesRequest- AConsumerthat will call methods onListExperienceEntitiesRequest.Builderto create a request.- Returns:
- Result of the ListExperienceEntities operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListExperienceEntitiesRequest.builder()- Parameters:
listExperienceEntitiesRequest- AConsumerthat will call methods onListExperienceEntitiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListExperiencesRequest.builder()- Parameters:
listExperiencesRequest- AConsumerthat will call methods onListExperiencesRequest.Builderto create a request.- Returns:
- Result of the ListExperiences operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListExperiencesRequest.builder()- Parameters:
listExperiencesRequest- AConsumerthat will call methods onListExperiencesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListFaqsRequest.builder()- Parameters:
listFaqsRequest- AConsumerthat will call methods onListFaqsRequest.Builderto create a request.- Returns:
- Result of the ListFaqs operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListFaqsRequest.builder()- Parameters:
listFaqsRequest- AConsumerthat will call methods onListFaqsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListFeaturedResultsSetsRequest.builder()- Parameters:
listFeaturedResultsSetsRequest- AConsumerthat will call methods onListFeaturedResultsSetsRequest.Builderto create a request.- Returns:
- Result of the ListFeaturedResultsSets operation returned by the service.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
ListGroupsOlderThanOrderingIdis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
listGroupsOlderThanOrderingIdRequest-- Returns:
- Result of the ListGroupsOlderThanOrderingId operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
ListGroupsOlderThanOrderingIdis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
ListGroupsOlderThanOrderingIdRequest.Builderavoiding the need to create one manually viaListGroupsOlderThanOrderingIdRequest.builder()- Parameters:
listGroupsOlderThanOrderingIdRequest- AConsumerthat will call methods onListGroupsOlderThanOrderingIdRequest.Builderto create a request.- Returns:
- Result of the ListGroupsOlderThanOrderingId operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListGroupsOlderThanOrderingIdRequest.builder()- Parameters:
listGroupsOlderThanOrderingIdRequest- AConsumerthat will call methods onListGroupsOlderThanOrderingIdRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListIndicesRequest.builder()- Parameters:
listIndicesRequest- AConsumerthat will call methods onListIndicesRequest.Builderto create a request.- Returns:
- Result of the ListIndices operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListIndicesRequest.builder()- Parameters:
listIndicesRequest- AConsumerthat will call methods onListIndicesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
ListQuerySuggestionsBlockListsis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
listQuerySuggestionsBlockListsRequest-- Returns:
- Result of the ListQuerySuggestionsBlockLists operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
ListQuerySuggestionsBlockListsis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
ListQuerySuggestionsBlockListsRequest.Builderavoiding the need to create one manually viaListQuerySuggestionsBlockListsRequest.builder()- Parameters:
listQuerySuggestionsBlockListsRequest- AConsumerthat will call methods onListQuerySuggestionsBlockListsRequest.Builderto create a request.- Returns:
- Result of the ListQuerySuggestionsBlockLists operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListQuerySuggestionsBlockListsRequest.builder()- Parameters:
listQuerySuggestionsBlockListsRequest- AConsumerthat will call methods onListQuerySuggestionsBlockListsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListThesauriRequest.builder()- Parameters:
listThesauriRequest- AConsumerthat will call methods onListThesauriRequest.Builderto create a request.- Returns:
- Result of the ListThesauri operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaListThesauriRequest.builder()- Parameters:
listThesauriRequest- AConsumerthat will call methods onListThesauriRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
PUTactions for a group are currently processing, a validation exception is thrown.- Parameters:
putPrincipalMappingRequest-- Returns:
- Result of the PutPrincipalMapping operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
PUTactions for a group are currently processing, a validation exception is thrown.
This is a convenience which creates an instance of the
PutPrincipalMappingRequest.Builderavoiding the need to create one manually viaPutPrincipalMappingRequest.builder()- Parameters:
putPrincipalMappingRequest- AConsumerthat will call methods onPutPrincipalMappingRequest.Builderto create a request.- Returns:
- Result of the PutPrincipalMapping operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
RetrieveAPI instead of filing a service limit increase to increase theQueryAPI 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
QueryResultTypeFilterparameter. 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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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
RetrieveAPI instead of filing a service limit increase to increase theQueryAPI 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
QueryResultTypeFilterparameter. 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.Builderavoiding the need to create one manually viaQueryRequest.builder()- Parameters:
queryRequest- AConsumerthat will call methods onQueryRequest.Builderto create a request.- Returns:
- Result of the Query operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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
QueryAPI only returns excerpt passages of up to 100 token words. With theRetrieveAPI, 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 theRetrieveAPI, you can alternatively use theQueryAPI 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
RetrieveAPI 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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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
QueryAPI only returns excerpt passages of up to 100 token words. With theRetrieveAPI, 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 theRetrieveAPI, you can alternatively use theQueryAPI 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
RetrieveAPI 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.Builderavoiding the need to create one manually viaRetrieveRequest.builder()- Parameters:
retrieveRequest- AConsumerthat will call methods onRetrieveRequest.Builderto create a request.- Returns:
- Result of the Retrieve operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
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
ResourceInUseExceptionexception.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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceInUseException- The resource you want to use is currently in use. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
ResourceInUseExceptionexception.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.Builderavoiding the need to create one manually viaStartDataSourceSyncJobRequest.builder()- Parameters:
startDataSourceSyncJobRequest- AConsumerthat will call methods onStartDataSourceSyncJobRequest.Builderto create a request.- Returns:
- Result of the StartDataSourceSyncJob operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ResourceInUseException- The resource you want to use is currently in use. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStopDataSourceSyncJobRequest.builder()- Parameters:
stopDataSourceSyncJobRequest- AConsumerthat will call methods onStopDataSourceSyncJobRequest.Builderto create a request.- Returns:
- Result of the StopDataSourceSyncJob operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
SubmitFeedbackis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
submitFeedbackRequest-- Returns:
- Result of the SubmitFeedback operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
SubmitFeedbackis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
SubmitFeedbackRequest.Builderavoiding the need to create one manually viaSubmitFeedbackRequest.builder()- Parameters:
submitFeedbackRequest- AConsumerthat will call methods onSubmitFeedbackRequest.Builderto create a request.- Returns:
- Result of the SubmitFeedback operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceUnavailableException- The resource you want to use isn't available. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
AccessControlConfigurationIdincluded in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply theAccessControlConfigurationIdin the.metadata.jsonfile. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocumentAPI.- Parameters:
updateAccessControlConfigurationRequest-- Returns:
- Result of the UpdateAccessControlConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
AccessControlConfigurationIdincluded in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply theAccessControlConfigurationIdin the.metadata.jsonfile. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using theBatchPutDocumentAPI.
This is a convenience which creates an instance of the
UpdateAccessControlConfigurationRequest.Builderavoiding the need to create one manually viaUpdateAccessControlConfigurationRequest.builder()- Parameters:
updateAccessControlConfigurationRequest- AConsumerthat will call methods onUpdateAccessControlConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateAccessControlConfiguration operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateDataSourceRequest.builder()- Parameters:
updateDataSourceRequest- AConsumerthat will call methods onUpdateDataSourceRequest.Builderto create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateExperienceRequest.builder()- Parameters:
updateExperienceRequest- AConsumerthat will call methods onUpdateExperienceRequest.Builderto create a request.- Returns:
- Result of the UpdateExperience operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.FeaturedResultsConflictException- An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateFeaturedResultsSetRequest.builder()- Parameters:
updateFeaturedResultsSetRequest- AConsumerthat will call methods onUpdateFeaturedResultsSetRequest.Builderto create a request.- Returns:
- Result of the UpdateFeaturedResultsSet operation returned by the service.
- Throws:
ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.FeaturedResultsConflictException- An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateIndexRequest.builder()- Parameters:
updateIndexRequest- AConsumerthat will call methods onUpdateIndexRequest.Builderto create a request.- Returns:
- Result of the UpdateIndex operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ServiceQuotaExceededException- You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
UpdateQuerySuggestionsBlockListis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
updateQuerySuggestionsBlockListRequest-- Returns:
- Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
UpdateQuerySuggestionsBlockListis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
UpdateQuerySuggestionsBlockListRequest.Builderavoiding the need to create one manually viaUpdateQuerySuggestionsBlockListRequest.builder()- Parameters:
updateQuerySuggestionsBlockListRequest- AConsumerthat will call methods onUpdateQuerySuggestionsBlockListRequest.Builderto create a request.- Returns:
- Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
UpdateQuerySuggestionsConfigis currently not supported in the Amazon Web Services GovCloud (US-West) region.- Parameters:
updateQuerySuggestionsConfigRequest-- Returns:
- Result of the UpdateQuerySuggestionsConfig operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
UpdateQuerySuggestionsConfigis currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the
UpdateQuerySuggestionsConfigRequest.Builderavoiding the need to create one manually viaUpdateQuerySuggestionsConfigRequest.builder()- Parameters:
updateQuerySuggestionsConfigRequest- AConsumerthat will call methods onUpdateQuerySuggestionsConfigRequest.Builderto create a request.- Returns:
- Result of the UpdateQuerySuggestionsConfig operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateThesaurusRequest.builder()- Parameters:
updateThesaurusRequest- AConsumerthat will call methods onUpdateThesaurusRequest.Builderto create a request.- Returns:
- Result of the UpdateThesaurus operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.ResourceNotFoundException- The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.ThrottlingException- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException- You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.ConflictException- A conflict occurred with the request. Please fix any inconsistences with your resources and try again.InternalServerException- An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KendraException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static KendraClient create()
Create aKendraClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static KendraClientBuilder builder()
Create a builder that can be used to configure and create aKendraClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default KendraServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-