@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface KendraAsyncClient extends AwsClient
builder() method.
Amazon Kendra is a service for indexing large document sets.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateEntitiesToExperienceResponse> |
associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.
|
default CompletableFuture<AssociateEntitiesToExperienceResponse> |
associateEntitiesToExperience(Consumer<AssociateEntitiesToExperienceRequest.Builder> associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.
|
default CompletableFuture<AssociatePersonasToEntitiesResponse> |
associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest)
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
default CompletableFuture<AssociatePersonasToEntitiesResponse> |
associatePersonasToEntities(Consumer<AssociatePersonasToEntitiesRequest.Builder> associatePersonasToEntitiesRequest)
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
default CompletableFuture<BatchDeleteDocumentResponse> |
batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default CompletableFuture<BatchDeleteDocumentResponse> |
batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default CompletableFuture<BatchDeleteFeaturedResultsSetResponse> |
batchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest)
Removes one or more sets of featured results.
|
default CompletableFuture<BatchDeleteFeaturedResultsSetResponse> |
batchDeleteFeaturedResultsSet(Consumer<BatchDeleteFeaturedResultsSetRequest.Builder> batchDeleteFeaturedResultsSetRequest)
Removes one or more sets of featured results.
|
default CompletableFuture<BatchGetDocumentStatusResponse> |
batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
|
default CompletableFuture<BatchGetDocumentStatusResponse> |
batchGetDocumentStatus(Consumer<BatchGetDocumentStatusRequest.Builder> batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
|
default CompletableFuture<BatchPutDocumentResponse> |
batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
|
default CompletableFuture<BatchPutDocumentResponse> |
batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)
Adds one or more documents to an index.
|
static KendraAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
KendraAsyncClient. |
default CompletableFuture<ClearQuerySuggestionsResponse> |
clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
|
default CompletableFuture<ClearQuerySuggestionsResponse> |
clearQuerySuggestions(Consumer<ClearQuerySuggestionsRequest.Builder> clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
|
static KendraAsyncClient |
create()
Create a
KendraAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAccessControlConfigurationResponse> |
createAccessControlConfiguration(Consumer<CreateAccessControlConfigurationRequest.Builder> createAccessControlConfigurationRequest)
Creates an access configuration for your documents.
|
default CompletableFuture<CreateAccessControlConfigurationResponse> |
createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)
Creates an access configuration for your documents.
|
default CompletableFuture<CreateDataSourceResponse> |
createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
|
default CompletableFuture<CreateDataSourceResponse> |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
|
default CompletableFuture<CreateExperienceResponse> |
createExperience(Consumer<CreateExperienceRequest.Builder> createExperienceRequest)
Creates an Amazon Kendra experience such as a search application.
|
default CompletableFuture<CreateExperienceResponse> |
createExperience(CreateExperienceRequest createExperienceRequest)
Creates an Amazon Kendra experience such as a search application.
|
default CompletableFuture<CreateFaqResponse> |
createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
|
default CompletableFuture<CreateFaqResponse> |
createFaq(CreateFaqRequest createFaqRequest)
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
|
default CompletableFuture<CreateFeaturedResultsSetResponse> |
createFeaturedResultsSet(Consumer<CreateFeaturedResultsSetRequest.Builder> createFeaturedResultsSetRequest)
Creates a set of featured results to display at the top of the search results page.
|
default CompletableFuture<CreateFeaturedResultsSetResponse> |
createFeaturedResultsSet(CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest)
Creates a set of featured results to display at the top of the search results page.
|
default CompletableFuture<CreateIndexResponse> |
createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)
Creates an Amazon Kendra index.
|
default CompletableFuture<CreateIndexResponse> |
createIndex(CreateIndexRequest createIndexRequest)
Creates an Amazon Kendra index.
|
default CompletableFuture<CreateQuerySuggestionsBlockListResponse> |
createQuerySuggestionsBlockList(Consumer<CreateQuerySuggestionsBlockListRequest.Builder> createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
|
default CompletableFuture<CreateQuerySuggestionsBlockListResponse> |
createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
|
default CompletableFuture<CreateThesaurusResponse> |
createThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest)
Creates a thesaurus for an index.
|
default CompletableFuture<CreateThesaurusResponse> |
createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index.
|
default CompletableFuture<DeleteAccessControlConfigurationResponse> |
deleteAccessControlConfiguration(Consumer<DeleteAccessControlConfigurationRequest.Builder> deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index.
|
default CompletableFuture<DeleteAccessControlConfigurationResponse> |
deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index.
|
default CompletableFuture<DeleteDataSourceResponse> |
deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector.
|
default CompletableFuture<DeleteDataSourceResponse> |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector.
|
default CompletableFuture<DeleteExperienceResponse> |
deleteExperience(Consumer<DeleteExperienceRequest.Builder> deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application.
|
default CompletableFuture<DeleteExperienceResponse> |
deleteExperience(DeleteExperienceRequest deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application.
|
default CompletableFuture<DeleteFaqResponse> |
deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)
Removes an FAQ from an index.
|
default CompletableFuture<DeleteFaqResponse> |
deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
|
default CompletableFuture<DeleteIndexResponse> |
deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default CompletableFuture<DeleteIndexResponse> |
deleteIndex(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default CompletableFuture<DeletePrincipalMappingResponse> |
deletePrincipalMapping(Consumer<DeletePrincipalMappingRequest.Builder> deletePrincipalMappingRequest)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
available to that group.
|
default CompletableFuture<DeletePrincipalMappingResponse> |
deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
available to that group.
|
default CompletableFuture<DeleteQuerySuggestionsBlockListResponse> |
deleteQuerySuggestionsBlockList(Consumer<DeleteQuerySuggestionsBlockListRequest.Builder> deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
|
default CompletableFuture<DeleteQuerySuggestionsBlockListResponse> |
deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
|
default CompletableFuture<DeleteThesaurusResponse> |
deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
default CompletableFuture<DeleteThesaurusResponse> |
deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
default CompletableFuture<DescribeAccessControlConfigurationResponse> |
describeAccessControlConfiguration(Consumer<DescribeAccessControlConfigurationRequest.Builder> describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index.
|
default CompletableFuture<DescribeAccessControlConfigurationResponse> |
describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index.
|
default CompletableFuture<DescribeDataSourceResponse> |
describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
|
default CompletableFuture<DescribeDataSourceResponse> |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
|
default CompletableFuture<DescribeExperienceResponse> |
describeExperience(Consumer<DescribeExperienceRequest.Builder> describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application.
|
default CompletableFuture<DescribeExperienceResponse> |
describeExperience(DescribeExperienceRequest describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application.
|
default CompletableFuture<DescribeFaqResponse> |
describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)
Gets information about an FAQ list.
|
default CompletableFuture<DescribeFaqResponse> |
describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
|
default CompletableFuture<DescribeFeaturedResultsSetResponse> |
describeFeaturedResultsSet(Consumer<DescribeFeaturedResultsSetRequest.Builder> describeFeaturedResultsSetRequest)
Gets information about a set of featured results.
|
default CompletableFuture<DescribeFeaturedResultsSetResponse> |
describeFeaturedResultsSet(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest)
Gets information about a set of featured results.
|
default CompletableFuture<DescribeIndexResponse> |
describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)
Gets information about an existing Amazon Kendra index.
|
default CompletableFuture<DescribeIndexResponse> |
describeIndex(DescribeIndexRequest describeIndexRequest)
Gets information about an existing Amazon Kendra index.
|
default CompletableFuture<DescribePrincipalMappingResponse> |
describePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest)
Describes the processing of
PUT and DELETE actions for mapping users to their groups. |
default CompletableFuture<DescribePrincipalMappingResponse> |
describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)
Describes the processing of
PUT and DELETE actions for mapping users to their groups. |
default CompletableFuture<DescribeQuerySuggestionsBlockListResponse> |
describeQuerySuggestionsBlockList(Consumer<DescribeQuerySuggestionsBlockListRequest.Builder> describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
|
default CompletableFuture<DescribeQuerySuggestionsBlockListResponse> |
describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
|
default CompletableFuture<DescribeQuerySuggestionsConfigResponse> |
describeQuerySuggestionsConfig(Consumer<DescribeQuerySuggestionsConfigRequest.Builder> describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
|
default CompletableFuture<DescribeQuerySuggestionsConfigResponse> |
describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
|
default CompletableFuture<DescribeThesaurusResponse> |
describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
|
default CompletableFuture<DescribeThesaurusResponse> |
describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
|
default CompletableFuture<DisassociateEntitiesFromExperienceResponse> |
disassociateEntitiesFromExperience(Consumer<DisassociateEntitiesFromExperienceRequest.Builder> disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra
experience.
|
default CompletableFuture<DisassociateEntitiesFromExperienceResponse> |
disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra
experience.
|
default CompletableFuture<DisassociatePersonasFromEntitiesResponse> |
disassociatePersonasFromEntities(Consumer<DisassociatePersonasFromEntitiesRequest.Builder> disassociatePersonasFromEntitiesRequest)
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
default CompletableFuture<DisassociatePersonasFromEntitiesResponse> |
disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest)
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to
your Amazon Kendra experience.
|
default CompletableFuture<GetQuerySuggestionsResponse> |
getQuerySuggestions(Consumer<GetQuerySuggestionsRequest.Builder> getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
|
default CompletableFuture<GetQuerySuggestionsResponse> |
getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
|
default CompletableFuture<GetSnapshotsResponse> |
getSnapshots(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)
Retrieves search metrics data.
|
default CompletableFuture<GetSnapshotsResponse> |
getSnapshots(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data.
|
default GetSnapshotsPublisher |
getSnapshotsPaginator(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)
Retrieves search metrics data.
|
default GetSnapshotsPublisher |
getSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data.
|
default CompletableFuture<ListAccessControlConfigurationsResponse> |
listAccessControlConfigurations(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default CompletableFuture<ListAccessControlConfigurationsResponse> |
listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default ListAccessControlConfigurationsPublisher |
listAccessControlConfigurationsPaginator(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default ListAccessControlConfigurationsPublisher |
listAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index.
|
default CompletableFuture<ListDataSourcesResponse> |
listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default CompletableFuture<ListDataSourcesResponse> |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default ListDataSourcesPublisher |
listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default ListDataSourcesPublisher |
listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
|
default CompletableFuture<ListDataSourceSyncJobsResponse> |
listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default CompletableFuture<ListDataSourceSyncJobsResponse> |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default ListDataSourceSyncJobsPublisher |
listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default ListDataSourceSyncJobsPublisher |
listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
|
default CompletableFuture<ListEntityPersonasResponse> |
listEntityPersonas(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default CompletableFuture<ListEntityPersonasResponse> |
listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default ListEntityPersonasPublisher |
listEntityPersonasPaginator(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default ListEntityPersonasPublisher |
listEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
|
default CompletableFuture<ListExperienceEntitiesResponse> |
listExperienceEntities(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default CompletableFuture<ListExperienceEntitiesResponse> |
listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default ListExperienceEntitiesPublisher |
listExperienceEntitiesPaginator(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default ListExperienceEntitiesPublisher |
listExperienceEntitiesPaginator(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra
experience.
|
default CompletableFuture<ListExperiencesResponse> |
listExperiences(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default CompletableFuture<ListExperiencesResponse> |
listExperiences(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default ListExperiencesPublisher |
listExperiencesPaginator(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default ListExperiencesPublisher |
listExperiencesPaginator(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences.
|
default CompletableFuture<ListFaqsResponse> |
listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default CompletableFuture<ListFaqsResponse> |
listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListFaqsPublisher |
listFaqsPaginator(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default ListFaqsPublisher |
listFaqsPaginator(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default CompletableFuture<ListFeaturedResultsSetsResponse> |
listFeaturedResultsSets(Consumer<ListFeaturedResultsSetsRequest.Builder> listFeaturedResultsSetsRequest)
Lists all your sets of featured results for a given index.
|
default CompletableFuture<ListFeaturedResultsSetsResponse> |
listFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest)
Lists all your sets of featured results for a given index.
|
default CompletableFuture<ListGroupsOlderThanOrderingIdResponse> |
listGroupsOlderThanOrderingId(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default CompletableFuture<ListGroupsOlderThanOrderingIdResponse> |
listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default ListGroupsOlderThanOrderingIdPublisher |
listGroupsOlderThanOrderingIdPaginator(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default ListGroupsOlderThanOrderingIdPublisher |
listGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
default CompletableFuture<ListIndicesResponse> |
listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default CompletableFuture<ListIndicesResponse> |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default ListIndicesPublisher |
listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default ListIndicesPublisher |
listIndicesPaginator(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
|
default CompletableFuture<ListQuerySuggestionsBlockListsResponse> |
listQuerySuggestionsBlockLists(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default CompletableFuture<ListQuerySuggestionsBlockListsResponse> |
listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default ListQuerySuggestionsBlockListsPublisher |
listQuerySuggestionsBlockListsPaginator(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default ListQuerySuggestionsBlockListsPublisher |
listQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default CompletableFuture<ListThesauriResponse> |
listThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the thesauri for an index.
|
default CompletableFuture<ListThesauriResponse> |
listThesauri(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
|
default ListThesauriPublisher |
listThesauriPaginator(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the thesauri for an index.
|
default ListThesauriPublisher |
listThesauriPaginator(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
|
default CompletableFuture<PutPrincipalMappingResponse> |
putPrincipalMapping(Consumer<PutPrincipalMappingRequest.Builder> putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
|
default CompletableFuture<PutPrincipalMappingResponse> |
putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
|
default CompletableFuture<QueryResponse> |
query(Consumer<QueryRequest.Builder> queryRequest)
Searches an active index.
|
default CompletableFuture<QueryResponse> |
query(QueryRequest queryRequest)
Searches an active index.
|
default KendraServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartDataSourceSyncJobResponse> |
startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)
Starts a synchronization job for a data source connector.
|
default CompletableFuture<StartDataSourceSyncJobResponse> |
startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source connector.
|
default CompletableFuture<StopDataSourceSyncJobResponse> |
stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running.
|
default CompletableFuture<StopDataSourceSyncJobResponse> |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running.
|
default CompletableFuture<SubmitFeedbackResponse> |
submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
|
default CompletableFuture<SubmitFeedbackResponse> |
submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default CompletableFuture<UpdateAccessControlConfigurationResponse> |
updateAccessControlConfiguration(Consumer<UpdateAccessControlConfigurationRequest.Builder> updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index.
|
default CompletableFuture<UpdateAccessControlConfigurationResponse> |
updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index.
|
default CompletableFuture<UpdateDataSourceResponse> |
updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
|
default CompletableFuture<UpdateDataSourceResponse> |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
|
default CompletableFuture<UpdateExperienceResponse> |
updateExperience(Consumer<UpdateExperienceRequest.Builder> updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application.
|
default CompletableFuture<UpdateExperienceResponse> |
updateExperience(UpdateExperienceRequest updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application.
|
default CompletableFuture<UpdateFeaturedResultsSetResponse> |
updateFeaturedResultsSet(Consumer<UpdateFeaturedResultsSetRequest.Builder> updateFeaturedResultsSetRequest)
Updates a set of featured results.
|
default CompletableFuture<UpdateFeaturedResultsSetResponse> |
updateFeaturedResultsSet(UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest)
Updates a set of featured results.
|
default CompletableFuture<UpdateIndexResponse> |
updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)
Updates an existing Amazon Kendra index.
|
default CompletableFuture<UpdateIndexResponse> |
updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
|
default CompletableFuture<UpdateQuerySuggestionsBlockListResponse> |
updateQuerySuggestionsBlockList(Consumer<UpdateQuerySuggestionsBlockListRequest.Builder> updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
|
default CompletableFuture<UpdateQuerySuggestionsBlockListResponse> |
updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
|
default CompletableFuture<UpdateQuerySuggestionsConfigResponse> |
updateQuerySuggestionsConfig(Consumer<UpdateQuerySuggestionsConfigRequest.Builder> updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
|
default CompletableFuture<UpdateQuerySuggestionsConfigResponse> |
updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
|
default CompletableFuture<UpdateThesaurusResponse> |
updateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest)
Updates a thesaurus for an index.
|
default CompletableFuture<UpdateThesaurusResponse> |
updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus for an index.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AssociateEntitiesToExperienceResponse> associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
associateEntitiesToExperienceRequest - default CompletableFuture<AssociateEntitiesToExperienceResponse> associateEntitiesToExperience(Consumer<AssociateEntitiesToExperienceRequest.Builder> associateEntitiesToExperienceRequest)
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the AssociateEntitiesToExperienceRequest.Builder
avoiding the need to create one manually via AssociateEntitiesToExperienceRequest.builder()
associateEntitiesToExperienceRequest - A Consumer that will call methods on AssociateEntitiesToExperienceRequest.Builder to
create a request.default CompletableFuture<AssociatePersonasToEntitiesResponse> associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest)
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
associatePersonasToEntitiesRequest - default CompletableFuture<AssociatePersonasToEntitiesResponse> associatePersonasToEntities(Consumer<AssociatePersonasToEntitiesRequest.Builder> associatePersonasToEntitiesRequest)
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the AssociatePersonasToEntitiesRequest.Builder
avoiding the need to create one manually via AssociatePersonasToEntitiesRequest.builder()
associatePersonasToEntitiesRequest - A Consumer that will call methods on AssociatePersonasToEntitiesRequest.Builder to create
a request.default CompletableFuture<BatchDeleteDocumentResponse> batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
batchDeleteDocumentRequest - default CompletableFuture<BatchDeleteDocumentResponse> batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
This is a convenience which creates an instance of the BatchDeleteDocumentRequest.Builder avoiding the
need to create one manually via BatchDeleteDocumentRequest.builder()
batchDeleteDocumentRequest - A Consumer that will call methods on BatchDeleteDocumentRequest.Builder to create a
request.default CompletableFuture<BatchDeleteFeaturedResultsSetResponse> batchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest)
Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
batchDeleteFeaturedResultsSetRequest - default CompletableFuture<BatchDeleteFeaturedResultsSetResponse> batchDeleteFeaturedResultsSet(Consumer<BatchDeleteFeaturedResultsSetRequest.Builder> batchDeleteFeaturedResultsSetRequest)
Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the BatchDeleteFeaturedResultsSetRequest.Builder
avoiding the need to create one manually via BatchDeleteFeaturedResultsSetRequest.builder()
batchDeleteFeaturedResultsSetRequest - A Consumer that will call methods on BatchDeleteFeaturedResultsSetRequest.Builder to
create a request.default CompletableFuture<BatchGetDocumentStatusResponse> batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the
BatchGetDocumentStatus API to get the current status of a list of documents so that you can
determine if they have been successfully indexed.
You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API.
When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
batchGetDocumentStatusRequest - default CompletableFuture<BatchGetDocumentStatusResponse> batchGetDocumentStatus(Consumer<BatchGetDocumentStatusRequest.Builder> batchGetDocumentStatusRequest)
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the
BatchGetDocumentStatus API to get the current status of a list of documents so that you can
determine if they have been successfully indexed.
You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API.
When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
This is a convenience which creates an instance of the BatchGetDocumentStatusRequest.Builder avoiding the
need to create one manually via BatchGetDocumentStatusRequest.builder()
batchGetDocumentStatusRequest - A Consumer that will call methods on BatchGetDocumentStatusRequest.Builder to create a
request.default CompletableFuture<BatchPutDocumentResponse> batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an
Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to
the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
batchPutDocumentRequest - default CompletableFuture<BatchPutDocumentResponse> batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)
Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an
Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to
the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
This is a convenience which creates an instance of the BatchPutDocumentRequest.Builder avoiding the need
to create one manually via BatchPutDocumentRequest.builder()
batchPutDocumentRequest - A Consumer that will call methods on BatchPutDocumentRequest.Builder to create a request.default CompletableFuture<ClearQuerySuggestionsResponse> clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
clearQuerySuggestionsRequest - default CompletableFuture<ClearQuerySuggestionsResponse> clearQuerySuggestions(Consumer<ClearQuerySuggestionsRequest.Builder> clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
This is a convenience which creates an instance of the ClearQuerySuggestionsRequest.Builder avoiding the
need to create one manually via ClearQuerySuggestionsRequest.builder()
clearQuerySuggestionsRequest - A Consumer that will call methods on ClearQuerySuggestionsRequest.Builder to create a
request.default CompletableFuture<CreateAccessControlConfigurationResponse> createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)
Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you call the BatchPutDocument API with the
AccessControlConfigurationId included in the Document object. If you use an S3
bucket as a data source, you update the .metadata.json with the
AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports
access control configuration for S3 data sources and documents indexed using the BatchPutDocument
API.
createAccessControlConfigurationRequest - default CompletableFuture<CreateAccessControlConfigurationResponse> createAccessControlConfiguration(Consumer<CreateAccessControlConfigurationRequest.Builder> createAccessControlConfigurationRequest)
Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you call the BatchPutDocument API with the
AccessControlConfigurationId included in the Document object. If you use an S3
bucket as a data source, you update the .metadata.json with the
AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports
access control configuration for S3 data sources and documents indexed using the BatchPutDocument
API.
This is a convenience which creates an instance of the CreateAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via CreateAccessControlConfigurationRequest.builder()
createAccessControlConfigurationRequest - A Consumer that will call methods on CreateAccessControlConfigurationRequest.Builder to
create a request.default CompletableFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
successfully created. Otherwise, an exception is raised.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
createDataSourceRequest - default CompletableFuture<CreateDataSourceResponse> createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
Creates a data source connector that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
successfully created. Otherwise, an exception is raised.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
This is a convenience which creates an instance of the CreateDataSourceRequest.Builder avoiding the need
to create one manually via CreateDataSourceRequest.builder()
createDataSourceRequest - A Consumer that will call methods on CreateDataSourceRequest.Builder to create a request.default CompletableFuture<CreateExperienceResponse> createExperience(CreateExperienceRequest createExperienceRequest)
Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
createExperienceRequest - default CompletableFuture<CreateExperienceResponse> createExperience(Consumer<CreateExperienceRequest.Builder> createExperienceRequest)
Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
This is a convenience which creates an instance of the CreateExperienceRequest.Builder avoiding the need
to create one manually via CreateExperienceRequest.builder()
createExperienceRequest - A Consumer that will call methods on CreateExperienceRequest.Builder to create a request.default CompletableFuture<CreateFaqResponse> createFaq(CreateFaqRequest createFaqRequest)
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
Adding FAQs to an index is an asynchronous operation.
For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
createFaqRequest - default CompletableFuture<CreateFaqResponse> createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
Adding FAQs to an index is an asynchronous operation.
For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
This is a convenience which creates an instance of the CreateFaqRequest.Builder avoiding the need to
create one manually via CreateFaqRequest.builder()
createFaqRequest - A Consumer that will call methods on CreateFaqRequest.Builder to create a request.default CompletableFuture<CreateFeaturedResultsSetResponse> createFeaturedResultsSet(CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest)
Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.
You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
createFeaturedResultsSetRequest - default CompletableFuture<CreateFeaturedResultsSetResponse> createFeaturedResultsSet(Consumer<CreateFeaturedResultsSetRequest.Builder> createFeaturedResultsSetRequest)
Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.
You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
This is a convenience which creates an instance of the CreateFeaturedResultsSetRequest.Builder avoiding
the need to create one manually via CreateFeaturedResultsSetRequest.builder()
createFeaturedResultsSetRequest - A Consumer that will call methods on CreateFeaturedResultsSetRequest.Builder to create a
request.default CompletableFuture<CreateIndexResponse> createIndex(CreateIndexRequest createIndexRequest)
Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has
completed, check the Status field returned from a call to DescribeIndex. The
Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the BatchPutDocument API or using one of
the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
createIndexRequest - default CompletableFuture<CreateIndexResponse> createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)
Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has
completed, check the Status field returned from a call to DescribeIndex. The
Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the BatchPutDocument API or using one of
the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
This is a convenience which creates an instance of the CreateIndexRequest.Builder avoiding the need to
create one manually via CreateIndexRequest.builder()
createIndexRequest - A Consumer that will call methods on CreateIndexRequest.Builder to create a request.default CompletableFuture<CreateQuerySuggestionsBlockListResponse> createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
createQuerySuggestionsBlockListRequest - default CompletableFuture<CreateQuerySuggestionsBlockListResponse> createQuerySuggestionsBlockList(Consumer<CreateQuerySuggestionsBlockListRequest.Builder> createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
This is a convenience which creates an instance of the CreateQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via CreateQuerySuggestionsBlockListRequest.builder()
createQuerySuggestionsBlockListRequest - A Consumer that will call methods on CreateQuerySuggestionsBlockListRequest.Builder to
create a request.default CompletableFuture<CreateThesaurusResponse> createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
createThesaurusRequest - default CompletableFuture<CreateThesaurusResponse> createThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
This is a convenience which creates an instance of the CreateThesaurusRequest.Builder avoiding the need
to create one manually via CreateThesaurusRequest.builder()
createThesaurusRequest - A Consumer that will call methods on CreateThesaurusRequest.Builder to create a request.default CompletableFuture<DeleteAccessControlConfigurationResponse> deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
deleteAccessControlConfigurationRequest - default CompletableFuture<DeleteAccessControlConfigurationResponse> deleteAccessControlConfiguration(Consumer<DeleteAccessControlConfigurationRequest.Builder> deleteAccessControlConfigurationRequest)
Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
This is a convenience which creates an instance of the DeleteAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via DeleteAccessControlConfigurationRequest.builder()
deleteAccessControlConfigurationRequest - A Consumer that will call methods on DeleteAccessControlConfigurationRequest.Builder to
create a request.default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being
deleted. While the data source is being deleted, the Status field returned by a call to the
DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
deleteDataSourceRequest - default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being
deleted. While the data source is being deleted, the Status field returned by a call to the
DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
This is a convenience which creates an instance of the DeleteDataSourceRequest.Builder avoiding the need
to create one manually via DeleteDataSourceRequest.builder()
deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.default CompletableFuture<DeleteExperienceResponse> deleteExperience(DeleteExperienceRequest deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
deleteExperienceRequest - default CompletableFuture<DeleteExperienceResponse> deleteExperience(Consumer<DeleteExperienceRequest.Builder> deleteExperienceRequest)
Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the DeleteExperienceRequest.Builder avoiding the need
to create one manually via DeleteExperienceRequest.builder()
deleteExperienceRequest - A Consumer that will call methods on DeleteExperienceRequest.Builder to create a request.default CompletableFuture<DeleteFaqResponse> deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
deleteFaqRequest - default CompletableFuture<DeleteFaqResponse> deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)
Removes an FAQ from an index.
This is a convenience which creates an instance of the DeleteFaqRequest.Builder avoiding the need to
create one manually via DeleteFaqRequest.builder()
deleteFaqRequest - A Consumer that will call methods on DeleteFaqRequest.Builder to create a request.default CompletableFuture<DeleteIndexResponse> deleteIndex(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status field returned by a call to the DescribeIndex
API is set to DELETING.
deleteIndexRequest - default CompletableFuture<DeleteIndexResponse> deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status field returned by a call to the DescribeIndex
API is set to DELETING.
This is a convenience which creates an instance of the DeleteIndexRequest.Builder avoiding the need to
create one manually via DeleteIndexRequest.builder()
deleteIndexRequest - A Consumer that will call methods on DeleteIndexRequest.Builder to create a request.default CompletableFuture<DeletePrincipalMappingResponse> deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use the
PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the
engineering team and another user takes their place, you provide an updated list of users or sub groups that
belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal
list of users or sub groups and input this list when calling PutPrincipalMapping.
DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
deletePrincipalMappingRequest - default CompletableFuture<DeletePrincipalMappingResponse> deletePrincipalMapping(Consumer<DeletePrincipalMappingRequest.Builder> deletePrincipalMappingRequest)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use the
PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the
engineering team and another user takes their place, you provide an updated list of users or sub groups that
belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal
list of users or sub groups and input this list when calling PutPrincipalMapping.
DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
This is a convenience which creates an instance of the DeletePrincipalMappingRequest.Builder avoiding the
need to create one manually via DeletePrincipalMappingRequest.builder()
deletePrincipalMappingRequest - A Consumer that will call methods on DeletePrincipalMappingRequest.Builder to create a
request.default CompletableFuture<DeleteQuerySuggestionsBlockListResponse> deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
deleteQuerySuggestionsBlockListRequest - default CompletableFuture<DeleteQuerySuggestionsBlockListResponse> deleteQuerySuggestionsBlockList(Consumer<DeleteQuerySuggestionsBlockListRequest.Builder> deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a convenience which creates an instance of the DeleteQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via DeleteQuerySuggestionsBlockListRequest.builder()
deleteQuerySuggestionsBlockListRequest - A Consumer that will call methods on DeleteQuerySuggestionsBlockListRequest.Builder to
create a request.default CompletableFuture<DeleteThesaurusResponse> deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusRequest - default CompletableFuture<DeleteThesaurusResponse> deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
This is a convenience which creates an instance of the DeleteThesaurusRequest.Builder avoiding the need
to create one manually via DeleteThesaurusRequest.builder()
deleteThesaurusRequest - A Consumer that will call methods on DeleteThesaurusRequest.Builder to create a request.default CompletableFuture<DescribeAccessControlConfigurationResponse> describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
describeAccessControlConfigurationRequest - default CompletableFuture<DescribeAccessControlConfigurationResponse> describeAccessControlConfiguration(Consumer<DescribeAccessControlConfigurationRequest.Builder> describeAccessControlConfigurationRequest)
Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
This is a convenience which creates an instance of the DescribeAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via DescribeAccessControlConfigurationRequest.builder()
describeAccessControlConfigurationRequest - A Consumer that will call methods on DescribeAccessControlConfigurationRequest.Builder to
create a request.default CompletableFuture<DescribeDataSourceResponse> describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
describeDataSourceRequest - default CompletableFuture<DescribeDataSourceResponse> describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Gets information about an Amazon Kendra data source connector.
This is a convenience which creates an instance of the DescribeDataSourceRequest.Builder avoiding the
need to create one manually via DescribeDataSourceRequest.builder()
describeDataSourceRequest - A Consumer that will call methods on DescribeDataSourceRequest.Builder to create a
request.default CompletableFuture<DescribeExperienceResponse> describeExperience(DescribeExperienceRequest describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
describeExperienceRequest - default CompletableFuture<DescribeExperienceResponse> describeExperience(Consumer<DescribeExperienceRequest.Builder> describeExperienceRequest)
Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the DescribeExperienceRequest.Builder avoiding the
need to create one manually via DescribeExperienceRequest.builder()
describeExperienceRequest - A Consumer that will call methods on DescribeExperienceRequest.Builder to create a
request.default CompletableFuture<DescribeFaqResponse> describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
describeFaqRequest - default CompletableFuture<DescribeFaqResponse> describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)
Gets information about an FAQ list.
This is a convenience which creates an instance of the DescribeFaqRequest.Builder avoiding the need to
create one manually via DescribeFaqRequest.builder()
describeFaqRequest - A Consumer that will call methods on DescribeFaqRequest.Builder to create a request.default CompletableFuture<DescribeFeaturedResultsSetResponse> describeFeaturedResultsSet(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest)
Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
describeFeaturedResultsSetRequest - default CompletableFuture<DescribeFeaturedResultsSetResponse> describeFeaturedResultsSet(Consumer<DescribeFeaturedResultsSetRequest.Builder> describeFeaturedResultsSetRequest)
Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the DescribeFeaturedResultsSetRequest.Builder avoiding
the need to create one manually via DescribeFeaturedResultsSetRequest.builder()
describeFeaturedResultsSetRequest - A Consumer that will call methods on DescribeFeaturedResultsSetRequest.Builder to create a
request.default CompletableFuture<DescribeIndexResponse> describeIndex(DescribeIndexRequest describeIndexRequest)
Gets information about an existing Amazon Kendra index.
describeIndexRequest - default CompletableFuture<DescribeIndexResponse> describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)
Gets information about an existing Amazon Kendra index.
This is a convenience which creates an instance of the DescribeIndexRequest.Builder avoiding the need to
create one manually via DescribeIndexRequest.builder()
describeIndexRequest - A Consumer that will call methods on DescribeIndexRequest.Builder to create a request.default CompletableFuture<DescribePrincipalMappingResponse> describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)
Describes the processing of PUT and DELETE actions for mapping users to their groups.
This includes information on the status of actions currently processing or yet to be processed, when actions were
last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after
other actions, and useful error messages if an action could not be processed.
DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
describePrincipalMappingRequest - default CompletableFuture<DescribePrincipalMappingResponse> describePrincipalMapping(Consumer<DescribePrincipalMappingRequest.Builder> describePrincipalMappingRequest)
Describes the processing of PUT and DELETE actions for mapping users to their groups.
This includes information on the status of actions currently processing or yet to be processed, when actions were
last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after
other actions, and useful error messages if an action could not be processed.
DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West)
region.
This is a convenience which creates an instance of the DescribePrincipalMappingRequest.Builder avoiding
the need to create one manually via DescribePrincipalMappingRequest.builder()
describePrincipalMappingRequest - A Consumer that will call methods on DescribePrincipalMappingRequest.Builder to create a
request.default CompletableFuture<DescribeQuerySuggestionsBlockListResponse> describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
This is used to check the current settings that are applied to a block list.
DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
describeQuerySuggestionsBlockListRequest - default CompletableFuture<DescribeQuerySuggestionsBlockListResponse> describeQuerySuggestionsBlockList(Consumer<DescribeQuerySuggestionsBlockListRequest.Builder> describeQuerySuggestionsBlockListRequest)
Gets information about a block list used for query suggestions for an index.
This is used to check the current settings that are applied to a block list.
DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a convenience which creates an instance of the DescribeQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via DescribeQuerySuggestionsBlockListRequest.builder()
describeQuerySuggestionsBlockListRequest - A Consumer that will call methods on DescribeQuerySuggestionsBlockListRequest.Builder to
create a request.default CompletableFuture<DescribeQuerySuggestionsConfigResponse> describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
describeQuerySuggestionsConfigRequest - default CompletableFuture<DescribeQuerySuggestionsConfigResponse> describeQuerySuggestionsConfig(Consumer<DescribeQuerySuggestionsConfigRequest.Builder> describeQuerySuggestionsConfigRequest)
Gets information on the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a convenience which creates an instance of the DescribeQuerySuggestionsConfigRequest.Builder
avoiding the need to create one manually via DescribeQuerySuggestionsConfigRequest.builder()
describeQuerySuggestionsConfigRequest - A Consumer that will call methods on DescribeQuerySuggestionsConfigRequest.Builder to
create a request.default CompletableFuture<DescribeThesaurusResponse> describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
describeThesaurusRequest - default CompletableFuture<DescribeThesaurusResponse> describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest)
Gets information about an existing Amazon Kendra thesaurus.
This is a convenience which creates an instance of the DescribeThesaurusRequest.Builder avoiding the need
to create one manually via DescribeThesaurusRequest.builder()
describeThesaurusRequest - A Consumer that will call methods on DescribeThesaurusRequest.Builder to create a request.default CompletableFuture<DisassociateEntitiesFromExperienceResponse> disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
disassociateEntitiesFromExperienceRequest - default CompletableFuture<DisassociateEntitiesFromExperienceResponse> disassociateEntitiesFromExperience(Consumer<DisassociateEntitiesFromExperienceRequest.Builder> disassociateEntitiesFromExperienceRequest)
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the DisassociateEntitiesFromExperienceRequest.Builder
avoiding the need to create one manually via DisassociateEntitiesFromExperienceRequest.builder()
disassociateEntitiesFromExperienceRequest - A Consumer that will call methods on DisassociateEntitiesFromExperienceRequest.Builder to
create a request.default CompletableFuture<DisassociatePersonasFromEntitiesResponse> disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest)
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
disassociatePersonasFromEntitiesRequest - default CompletableFuture<DisassociatePersonasFromEntitiesResponse> disassociatePersonasFromEntities(Consumer<DisassociatePersonasFromEntitiesRequest.Builder> disassociatePersonasFromEntitiesRequest)
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the DisassociatePersonasFromEntitiesRequest.Builder
avoiding the need to create one manually via DisassociatePersonasFromEntitiesRequest.builder()
disassociatePersonasFromEntitiesRequest - A Consumer that will call methods on DisassociatePersonasFromEntitiesRequest.Builder to
create a request.default CompletableFuture<GetQuerySuggestionsResponse> getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
getQuerySuggestionsRequest - default CompletableFuture<GetQuerySuggestionsResponse> getQuerySuggestions(Consumer<GetQuerySuggestionsRequest.Builder> getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the GetQuerySuggestionsRequest.Builder avoiding the
need to create one manually via GetQuerySuggestionsRequest.builder()
getQuerySuggestionsRequest - A Consumer that will call methods on GetQuerySuggestionsRequest.Builder to create a
request.default CompletableFuture<GetSnapshotsResponse> getSnapshots(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
getSnapshotsRequest - default CompletableFuture<GetSnapshotsResponse> getSnapshots(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
This is a convenience which creates an instance of the GetSnapshotsRequest.Builder avoiding the need to
create one manually via GetSnapshotsRequest.builder()
getSnapshotsRequest - A Consumer that will call methods on GetSnapshotsRequest.Builder to create a request.default GetSnapshotsPublisher getSnapshotsPaginator(GetSnapshotsRequest getSnapshotsRequest)
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
This is a variant of getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) operation.
getSnapshotsRequest - default GetSnapshotsPublisher getSnapshotsPaginator(Consumer<GetSnapshotsRequest.Builder> getSnapshotsRequest)
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
This is a variant of getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.GetSnapshotsPublisher publisher = client.getSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.GetSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSnapshots(software.amazon.awssdk.services.kendra.model.GetSnapshotsRequest) operation.
This is a convenience which creates an instance of the GetSnapshotsRequest.Builder avoiding the need to
create one manually via GetSnapshotsRequest.builder()
getSnapshotsRequest - A Consumer that will call methods on GetSnapshotsRequest.Builder to create a request.default CompletableFuture<ListAccessControlConfigurationsResponse> listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
listAccessControlConfigurationsRequest - default CompletableFuture<ListAccessControlConfigurationsResponse> listAccessControlConfigurations(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
This is a convenience which creates an instance of the ListAccessControlConfigurationsRequest.Builder
avoiding the need to create one manually via ListAccessControlConfigurationsRequest.builder()
listAccessControlConfigurationsRequest - A Consumer that will call methods on ListAccessControlConfigurationsRequest.Builder to
create a request.default ListAccessControlConfigurationsPublisher listAccessControlConfigurationsPaginator(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
This is a variant of
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation.
listAccessControlConfigurationsRequest - default ListAccessControlConfigurationsPublisher listAccessControlConfigurationsPaginator(Consumer<ListAccessControlConfigurationsRequest.Builder> listAccessControlConfigurationsRequest)
Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
This is a variant of
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListAccessControlConfigurationsPublisher publisher = client.listAccessControlConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessControlConfigurations(software.amazon.awssdk.services.kendra.model.ListAccessControlConfigurationsRequest)
operation.
This is a convenience which creates an instance of the ListAccessControlConfigurationsRequest.Builder
avoiding the need to create one manually via ListAccessControlConfigurationsRequest.builder()
listAccessControlConfigurationsRequest - A Consumer that will call methods on ListAccessControlConfigurationsRequest.Builder to
create a request.default CompletableFuture<ListDataSourceSyncJobsResponse> listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
listDataSourceSyncJobsRequest - default CompletableFuture<ListDataSourceSyncJobsResponse> listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a
request.default ListDataSourceSyncJobsPublisher listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
listDataSourceSyncJobsRequest - default ListDataSourceSyncJobsPublisher listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing a data source connector.
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a
request.default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
listDataSourcesRequest - default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data source connectors that you have created.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.default ListDataSourcesPublisher listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists the data source connectors that you have created.
This is a variant of
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
listDataSourcesRequest - default ListDataSourcesPublisher listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data source connectors that you have created.
This is a variant of
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.default CompletableFuture<ListEntityPersonasResponse> listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
listEntityPersonasRequest - default CompletableFuture<ListEntityPersonasResponse> listEntityPersonas(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
This is a convenience which creates an instance of the ListEntityPersonasRequest.Builder avoiding the
need to create one manually via ListEntityPersonasRequest.builder()
listEntityPersonasRequest - A Consumer that will call methods on ListEntityPersonasRequest.Builder to create a
request.default ListEntityPersonasPublisher listEntityPersonasPaginator(ListEntityPersonasRequest listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
This is a variant of
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)
operation.
listEntityPersonasRequest - default ListEntityPersonasPublisher listEntityPersonasPaginator(Consumer<ListEntityPersonasRequest.Builder> listEntityPersonasRequest)
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
This is a variant of
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListEntityPersonasPublisher publisher = client.listEntityPersonasPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListEntityPersonasResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEntityPersonas(software.amazon.awssdk.services.kendra.model.ListEntityPersonasRequest)
operation.
This is a convenience which creates an instance of the ListEntityPersonasRequest.Builder avoiding the
need to create one manually via ListEntityPersonasRequest.builder()
listEntityPersonasRequest - A Consumer that will call methods on ListEntityPersonasRequest.Builder to create a
request.default CompletableFuture<ListExperienceEntitiesResponse> listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
listExperienceEntitiesRequest - default CompletableFuture<ListExperienceEntitiesResponse> listExperienceEntities(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the ListExperienceEntitiesRequest.Builder avoiding the
need to create one manually via ListExperienceEntitiesRequest.builder()
listExperienceEntitiesRequest - A Consumer that will call methods on ListExperienceEntitiesRequest.Builder to create a
request.default ListExperienceEntitiesPublisher listExperienceEntitiesPaginator(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a variant of
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation.
listExperienceEntitiesRequest - default ListExperienceEntitiesPublisher listExperienceEntitiesPaginator(Consumer<ListExperienceEntitiesRequest.Builder> listExperienceEntitiesRequest)
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a variant of
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListExperienceEntitiesPublisher publisher = client.listExperienceEntitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperienceEntities(software.amazon.awssdk.services.kendra.model.ListExperienceEntitiesRequest)
operation.
This is a convenience which creates an instance of the ListExperienceEntitiesRequest.Builder avoiding the
need to create one manually via ListExperienceEntitiesRequest.builder()
listExperienceEntitiesRequest - A Consumer that will call methods on ListExperienceEntitiesRequest.Builder to create a
request.default CompletableFuture<ListExperiencesResponse> listExperiences(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
listExperiencesRequest - default CompletableFuture<ListExperiencesResponse> listExperiences(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the ListExperiencesRequest.Builder avoiding the need
to create one manually via ListExperiencesRequest.builder()
listExperiencesRequest - A Consumer that will call methods on ListExperiencesRequest.Builder to create a request.default ListExperiencesPublisher listExperiencesPaginator(ListExperiencesRequest listExperiencesRequest)
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a variant of
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperiencesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListExperiencesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation.
listExperiencesRequest - default ListExperiencesPublisher listExperiencesPaginator(Consumer<ListExperiencesRequest.Builder> listExperiencesRequest)
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a variant of
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListExperiencesPublisher publisher = client.listExperiencesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListExperiencesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListExperiencesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExperiences(software.amazon.awssdk.services.kendra.model.ListExperiencesRequest) operation.
This is a convenience which creates an instance of the ListExperiencesRequest.Builder avoiding the need
to create one manually via ListExperiencesRequest.builder()
listExperiencesRequest - A Consumer that will call methods on ListExperiencesRequest.Builder to create a request.default CompletableFuture<ListFaqsResponse> listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
listFaqsRequest - default CompletableFuture<ListFaqsResponse> listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
This is a convenience which creates an instance of the ListFaqsRequest.Builder avoiding the need to
create one manually via ListFaqsRequest.builder()
listFaqsRequest - A Consumer that will call methods on ListFaqsRequest.Builder to create a request.default ListFaqsPublisher listFaqsPaginator(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
This is a variant of listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListFaqsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListFaqsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
listFaqsRequest - default ListFaqsPublisher listFaqsPaginator(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
This is a variant of listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListFaqsPublisher publisher = client.listFaqsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListFaqsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListFaqsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFaqs(software.amazon.awssdk.services.kendra.model.ListFaqsRequest) operation.
This is a convenience which creates an instance of the ListFaqsRequest.Builder avoiding the need to
create one manually via ListFaqsRequest.builder()
listFaqsRequest - A Consumer that will call methods on ListFaqsRequest.Builder to create a request.default CompletableFuture<ListFeaturedResultsSetsResponse> listFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest)
Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
listFeaturedResultsSetsRequest - default CompletableFuture<ListFeaturedResultsSetsResponse> listFeaturedResultsSets(Consumer<ListFeaturedResultsSetsRequest.Builder> listFeaturedResultsSetsRequest)
Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the ListFeaturedResultsSetsRequest.Builder avoiding
the need to create one manually via ListFeaturedResultsSetsRequest.builder()
listFeaturedResultsSetsRequest - A Consumer that will call methods on ListFeaturedResultsSetsRequest.Builder to create a
request.default CompletableFuture<ListGroupsOlderThanOrderingIdResponse> listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
listGroupsOlderThanOrderingIdRequest - default CompletableFuture<ListGroupsOlderThanOrderingIdResponse> listGroupsOlderThanOrderingId(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a convenience which creates an instance of the ListGroupsOlderThanOrderingIdRequest.Builder
avoiding the need to create one manually via ListGroupsOlderThanOrderingIdRequest.builder()
listGroupsOlderThanOrderingIdRequest - A Consumer that will call methods on ListGroupsOlderThanOrderingIdRequest.Builder to
create a request.default ListGroupsOlderThanOrderingIdPublisher listGroupsOlderThanOrderingIdPaginator(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a variant of
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation.
listGroupsOlderThanOrderingIdRequest - default ListGroupsOlderThanOrderingIdPublisher listGroupsOlderThanOrderingIdPaginator(Consumer<ListGroupsOlderThanOrderingIdRequest.Builder> listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a variant of
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListGroupsOlderThanOrderingIdPublisher publisher = client.listGroupsOlderThanOrderingIdPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupsOlderThanOrderingId(software.amazon.awssdk.services.kendra.model.ListGroupsOlderThanOrderingIdRequest)
operation.
This is a convenience which creates an instance of the ListGroupsOlderThanOrderingIdRequest.Builder
avoiding the need to create one manually via ListGroupsOlderThanOrderingIdRequest.builder()
listGroupsOlderThanOrderingIdRequest - A Consumer that will call methods on ListGroupsOlderThanOrderingIdRequest.Builder to
create a request.default CompletableFuture<ListIndicesResponse> listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
listIndicesRequest - default CompletableFuture<ListIndicesResponse> listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.default ListIndicesPublisher listIndicesPaginator(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
This is a variant of listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListIndicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListIndicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
listIndicesRequest - default ListIndicesPublisher listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you created.
This is a variant of listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListIndicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListIndicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.default CompletableFuture<ListQuerySuggestionsBlockListsResponse> listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
listQuerySuggestionsBlockListsRequest - default CompletableFuture<ListQuerySuggestionsBlockListsResponse> listQuerySuggestionsBlockLists(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a convenience which creates an instance of the ListQuerySuggestionsBlockListsRequest.Builder
avoiding the need to create one manually via ListQuerySuggestionsBlockListsRequest.builder()
listQuerySuggestionsBlockListsRequest - A Consumer that will call methods on ListQuerySuggestionsBlockListsRequest.Builder to
create a request.default ListQuerySuggestionsBlockListsPublisher listQuerySuggestionsBlockListsPaginator(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a variant of
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation.
listQuerySuggestionsBlockListsRequest - default ListQuerySuggestionsBlockListsPublisher listQuerySuggestionsBlockListsPaginator(Consumer<ListQuerySuggestionsBlockListsRequest.Builder> listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a variant of
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListQuerySuggestionsBlockListsPublisher publisher = client.listQuerySuggestionsBlockListsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuerySuggestionsBlockLists(software.amazon.awssdk.services.kendra.model.ListQuerySuggestionsBlockListsRequest)
operation.
This is a convenience which creates an instance of the ListQuerySuggestionsBlockListsRequest.Builder
avoiding the need to create one manually via ListQuerySuggestionsBlockListsRequest.builder()
listQuerySuggestionsBlockListsRequest - A Consumer that will call methods on ListQuerySuggestionsBlockListsRequest.Builder to
create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListThesauriResponse> listThesauri(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
listThesauriRequest - default CompletableFuture<ListThesauriResponse> listThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the thesauri for an index.
This is a convenience which creates an instance of the ListThesauriRequest.Builder avoiding the need to
create one manually via ListThesauriRequest.builder()
listThesauriRequest - A Consumer that will call methods on ListThesauriRequest.Builder to create a request.default ListThesauriPublisher listThesauriPaginator(ListThesauriRequest listThesauriRequest)
Lists the thesauri for an index.
This is a variant of listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListThesauriResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListThesauriResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) operation.
listThesauriRequest - default ListThesauriPublisher listThesauriPaginator(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the thesauri for an index.
This is a variant of listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListThesauriPublisher publisher = client.listThesauriPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListThesauriResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListThesauriResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThesauri(software.amazon.awssdk.services.kendra.model.ListThesauriRequest) operation.
This is a convenience which creates an instance of the ListThesauriRequest.Builder avoiding the need to
create one manually via ListThesauriRequest.builder()
listThesauriRequest - A Consumer that will call methods on ListThesauriRequest.Builder to create a request.default CompletableFuture<PutPrincipalMappingResponse> putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.
If more than five PUT actions for a group are currently processing, a validation exception is
thrown.
putPrincipalMappingRequest - default CompletableFuture<PutPrincipalMappingResponse> putPrincipalMapping(Consumer<PutPrincipalMappingRequest.Builder> putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.
If more than five PUT actions for a group are currently processing, a validation exception is
thrown.
This is a convenience which creates an instance of the PutPrincipalMappingRequest.Builder avoiding the
need to create one manually via PutPrincipalMappingRequest.builder()
putPrincipalMappingRequest - A Consumer that will call methods on PutPrincipalMappingRequest.Builder to create a
request.default CompletableFuture<QueryResponse> query(QueryRequest queryRequest)
Searches an active index. Use this API to search your documents using query. The Query API enables
to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeFilter
parameter.
Each query returns the 100 most relevant results.
queryRequest - default CompletableFuture<QueryResponse> query(Consumer<QueryRequest.Builder> queryRequest)
Searches an active index. Use this API to search your documents using query. The Query API enables
to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeFilter
parameter.
Each query returns the 100 most relevant results.
This is a convenience which creates an instance of the QueryRequest.Builder avoiding the need to create
one manually via QueryRequest.builder()
queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request.default CompletableFuture<StartDataSourceSyncJobResponse> startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
Kendra returns a ResourceInUseException exception.
startDataSourceSyncJobRequest - default CompletableFuture<StartDataSourceSyncJobResponse> startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)
Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
Kendra returns a ResourceInUseException exception.
This is a convenience which creates an instance of the StartDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StartDataSourceSyncJobRequest.builder()
startDataSourceSyncJobRequest - A Consumer that will call methods on StartDataSourceSyncJobRequest.Builder to create a
request.default CompletableFuture<StopDataSourceSyncJobResponse> stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - default CompletableFuture<StopDataSourceSyncJobResponse> stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
This is a convenience which creates an instance of the StopDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StopDataSourceSyncJobRequest.builder()
stopDataSourceSyncJobRequest - A Consumer that will call methods on StopDataSourceSyncJobRequest.Builder to create a
request.default CompletableFuture<SubmitFeedbackResponse> submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
submitFeedbackRequest - default CompletableFuture<SubmitFeedbackResponse> submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
This is a convenience which creates an instance of the SubmitFeedbackRequest.Builder avoiding the need to
create one manually via SubmitFeedbackRequest.builder()
submitFeedbackRequest - A Consumer that will call methods on SubmitFeedbackRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateAccessControlConfigurationResponse> updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the BatchPutDocument API to apply
the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3
bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId
in the .metadata.json file. Amazon Kendra currently only supports access control configuration for
S3 data sources and documents indexed using the BatchPutDocument API.
updateAccessControlConfigurationRequest - default CompletableFuture<UpdateAccessControlConfigurationResponse> updateAccessControlConfiguration(Consumer<UpdateAccessControlConfigurationRequest.Builder> updateAccessControlConfigurationRequest)
Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the BatchPutDocument API to apply
the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3
bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId
in the .metadata.json file. Amazon Kendra currently only supports access control configuration for
S3 data sources and documents indexed using the BatchPutDocument API.
This is a convenience which creates an instance of the UpdateAccessControlConfigurationRequest.Builder
avoiding the need to create one manually via UpdateAccessControlConfigurationRequest.builder()
updateAccessControlConfigurationRequest - A Consumer that will call methods on UpdateAccessControlConfigurationRequest.Builder to
create a request.default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
updateDataSourceRequest - default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates an existing Amazon Kendra data source connector.
This is a convenience which creates an instance of the UpdateDataSourceRequest.Builder avoiding the need
to create one manually via UpdateDataSourceRequest.builder()
updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request.default CompletableFuture<UpdateExperienceResponse> updateExperience(UpdateExperienceRequest updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
updateExperienceRequest - default CompletableFuture<UpdateExperienceResponse> updateExperience(Consumer<UpdateExperienceRequest.Builder> updateExperienceRequest)
Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
This is a convenience which creates an instance of the UpdateExperienceRequest.Builder avoiding the need
to create one manually via UpdateExperienceRequest.builder()
updateExperienceRequest - A Consumer that will call methods on UpdateExperienceRequest.Builder to create a request.default CompletableFuture<UpdateFeaturedResultsSetResponse> updateFeaturedResultsSet(UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest)
Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
updateFeaturedResultsSetRequest - default CompletableFuture<UpdateFeaturedResultsSetResponse> updateFeaturedResultsSet(Consumer<UpdateFeaturedResultsSetRequest.Builder> updateFeaturedResultsSetRequest)
Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
This is a convenience which creates an instance of the UpdateFeaturedResultsSetRequest.Builder avoiding
the need to create one manually via UpdateFeaturedResultsSetRequest.builder()
updateFeaturedResultsSetRequest - A Consumer that will call methods on UpdateFeaturedResultsSetRequest.Builder to create a
request.default CompletableFuture<UpdateIndexResponse> updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
updateIndexRequest - default CompletableFuture<UpdateIndexResponse> updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)
Updates an existing Amazon Kendra index.
This is a convenience which creates an instance of the UpdateIndexRequest.Builder avoiding the need to
create one manually via UpdateIndexRequest.builder()
updateIndexRequest - A Consumer that will call methods on UpdateIndexRequest.Builder to create a request.default CompletableFuture<UpdateQuerySuggestionsBlockListResponse> updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
updateQuerySuggestionsBlockListRequest - default CompletableFuture<UpdateQuerySuggestionsBlockListResponse> updateQuerySuggestionsBlockList(Consumer<UpdateQuerySuggestionsBlockListRequest.Builder> updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a convenience which creates an instance of the UpdateQuerySuggestionsBlockListRequest.Builder
avoiding the need to create one manually via UpdateQuerySuggestionsBlockListRequest.builder()
updateQuerySuggestionsBlockListRequest - A Consumer that will call methods on UpdateQuerySuggestionsBlockListRequest.Builder to
create a request.default CompletableFuture<UpdateQuerySuggestionsConfigResponse> updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing, you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
updateQuerySuggestionsConfigRequest - default CompletableFuture<UpdateQuerySuggestionsConfigResponse> updateQuerySuggestionsConfig(Consumer<UpdateQuerySuggestionsConfigRequest.Builder> updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing, you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
This is a convenience which creates an instance of the UpdateQuerySuggestionsConfigRequest.Builder
avoiding the need to create one manually via UpdateQuerySuggestionsConfigRequest.builder()
updateQuerySuggestionsConfigRequest - A Consumer that will call methods on UpdateQuerySuggestionsConfigRequest.Builder to create
a request.default CompletableFuture<UpdateThesaurusResponse> updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus for an index.
updateThesaurusRequest - default CompletableFuture<UpdateThesaurusResponse> updateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest)
Updates a thesaurus for an index.
This is a convenience which creates an instance of the UpdateThesaurusRequest.Builder avoiding the need
to create one manually via UpdateThesaurusRequest.builder()
updateThesaurusRequest - A Consumer that will call methods on UpdateThesaurusRequest.Builder to create a request.default KendraServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic KendraAsyncClient create()
KendraAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KendraAsyncClientBuilder builder()
KendraAsyncClient.Copyright © 2023. All rights reserved.