Aws::kendra::KendraClient Class Reference

#include <KendraClient.h>

Inheritance diagram for Aws::kendra::KendraClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

 

typedef KendraClientConfiguration ClientConfigurationType

 

typedef KendraEndpointProvider EndpointProviderType

 

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSProtocolClient< JsonOutcome, Utils::Json::JsonValue > BASECLASS

 

Public Types inherited from Aws::Client::AWSProtocolClient< JsonOutcome, Utils::Json::JsonValue >

typedef AWSClient BASECLASS

 

Public Member Functions

 KendraClient (const Aws::kendra::KendraClientConfiguration &clientConfiguration=Aws::kendra::KendraClientConfiguration(), std::shared_ptr< KendraEndpointProviderBase > endpointProvider=nullptr)

 

 KendraClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< KendraEndpointProviderBase > endpointProvider=nullptr, const Aws::kendra::KendraClientConfiguration &clientConfiguration=Aws::kendra::KendraClientConfiguration())

 

 KendraClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< KendraEndpointProviderBase > endpointProvider=nullptr, const Aws::kendra::KendraClientConfiguration &clientConfiguration=Aws::kendra::KendraClientConfiguration())

 

 KendraClient (const Aws::Client::ClientConfiguration &clientConfiguration)

 

 KendraClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration)

 

 KendraClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration)

 

virtual ~KendraClient ()

 

virtual Model::AssociateEntitiesToExperienceOutcome AssociateEntitiesToExperience (const Model::AssociateEntitiesToExperienceRequest &request) const

 

template<typename AssociateEntitiesToExperienceRequestT = Model::AssociateEntitiesToExperienceRequest>

Model::AssociateEntitiesToExperienceOutcomeCallable AssociateEntitiesToExperienceCallable (const AssociateEntitiesToExperienceRequestT &request) const

 

template<typename AssociateEntitiesToExperienceRequestT = Model::AssociateEntitiesToExperienceRequest>

void AssociateEntitiesToExperienceAsync (const AssociateEntitiesToExperienceRequestT &request, const AssociateEntitiesToExperienceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::AssociatePersonasToEntitiesOutcome AssociatePersonasToEntities (const Model::AssociatePersonasToEntitiesRequest &request) const

 

template<typename AssociatePersonasToEntitiesRequestT = Model::AssociatePersonasToEntitiesRequest>

Model::AssociatePersonasToEntitiesOutcomeCallable AssociatePersonasToEntitiesCallable (const AssociatePersonasToEntitiesRequestT &request) const

 

template<typename AssociatePersonasToEntitiesRequestT = Model::AssociatePersonasToEntitiesRequest>

void AssociatePersonasToEntitiesAsync (const AssociatePersonasToEntitiesRequestT &request, const AssociatePersonasToEntitiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::BatchDeleteDocumentOutcome BatchDeleteDocument (const Model::BatchDeleteDocumentRequest &request) const

 

template<typename BatchDeleteDocumentRequestT = Model::BatchDeleteDocumentRequest>

Model::BatchDeleteDocumentOutcomeCallable BatchDeleteDocumentCallable (const BatchDeleteDocumentRequestT &request) const

 

template<typename BatchDeleteDocumentRequestT = Model::BatchDeleteDocumentRequest>

void BatchDeleteDocumentAsync (const BatchDeleteDocumentRequestT &request, const BatchDeleteDocumentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::BatchDeleteFeaturedResultsSetOutcome BatchDeleteFeaturedResultsSet (const Model::BatchDeleteFeaturedResultsSetRequest &request) const

 

template<typename BatchDeleteFeaturedResultsSetRequestT = Model::BatchDeleteFeaturedResultsSetRequest>

Model::BatchDeleteFeaturedResultsSetOutcomeCallable BatchDeleteFeaturedResultsSetCallable (const BatchDeleteFeaturedResultsSetRequestT &request) const

 

template<typename BatchDeleteFeaturedResultsSetRequestT = Model::BatchDeleteFeaturedResultsSetRequest>

void BatchDeleteFeaturedResultsSetAsync (const BatchDeleteFeaturedResultsSetRequestT &request, const BatchDeleteFeaturedResultsSetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::BatchGetDocumentStatusOutcome BatchGetDocumentStatus (const Model::BatchGetDocumentStatusRequest &request) const

 

template<typename BatchGetDocumentStatusRequestT = Model::BatchGetDocumentStatusRequest>

Model::BatchGetDocumentStatusOutcomeCallable BatchGetDocumentStatusCallable (const BatchGetDocumentStatusRequestT &request) const

 

template<typename BatchGetDocumentStatusRequestT = Model::BatchGetDocumentStatusRequest>

void BatchGetDocumentStatusAsync (const BatchGetDocumentStatusRequestT &request, const BatchGetDocumentStatusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::BatchPutDocumentOutcome BatchPutDocument (const Model::BatchPutDocumentRequest &request) const

 

template<typename BatchPutDocumentRequestT = Model::BatchPutDocumentRequest>

Model::BatchPutDocumentOutcomeCallable BatchPutDocumentCallable (const BatchPutDocumentRequestT &request) const

 

template<typename BatchPutDocumentRequestT = Model::BatchPutDocumentRequest>

void BatchPutDocumentAsync (const BatchPutDocumentRequestT &request, const BatchPutDocumentResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ClearQuerySuggestionsOutcome ClearQuerySuggestions (const Model::ClearQuerySuggestionsRequest &request) const

 

template<typename ClearQuerySuggestionsRequestT = Model::ClearQuerySuggestionsRequest>

Model::ClearQuerySuggestionsOutcomeCallable ClearQuerySuggestionsCallable (const ClearQuerySuggestionsRequestT &request) const

 

template<typename ClearQuerySuggestionsRequestT = Model::ClearQuerySuggestionsRequest>

void ClearQuerySuggestionsAsync (const ClearQuerySuggestionsRequestT &request, const ClearQuerySuggestionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateAccessControlConfigurationOutcome CreateAccessControlConfiguration (const Model::CreateAccessControlConfigurationRequest &request) const

 

template<typename CreateAccessControlConfigurationRequestT = Model::CreateAccessControlConfigurationRequest>

Model::CreateAccessControlConfigurationOutcomeCallable CreateAccessControlConfigurationCallable (const CreateAccessControlConfigurationRequestT &request) const

 

template<typename CreateAccessControlConfigurationRequestT = Model::CreateAccessControlConfigurationRequest>

void CreateAccessControlConfigurationAsync (const CreateAccessControlConfigurationRequestT &request, const CreateAccessControlConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateDataSourceOutcome CreateDataSource (const Model::CreateDataSourceRequest &request) const

 

template<typename CreateDataSourceRequestT = Model::CreateDataSourceRequest>

Model::CreateDataSourceOutcomeCallable CreateDataSourceCallable (const CreateDataSourceRequestT &request) const

 

template<typename CreateDataSourceRequestT = Model::CreateDataSourceRequest>

void CreateDataSourceAsync (const CreateDataSourceRequestT &request, const CreateDataSourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateExperienceOutcome CreateExperience (const Model::CreateExperienceRequest &request) const

 

template<typename CreateExperienceRequestT = Model::CreateExperienceRequest>

Model::CreateExperienceOutcomeCallable CreateExperienceCallable (const CreateExperienceRequestT &request) const

 

template<typename CreateExperienceRequestT = Model::CreateExperienceRequest>

void CreateExperienceAsync (const CreateExperienceRequestT &request, const CreateExperienceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateFaqOutcome CreateFaq (const Model::CreateFaqRequest &request) const

 

template<typename CreateFaqRequestT = Model::CreateFaqRequest>

Model::CreateFaqOutcomeCallable CreateFaqCallable (const CreateFaqRequestT &request) const

 

template<typename CreateFaqRequestT = Model::CreateFaqRequest>

void CreateFaqAsync (const CreateFaqRequestT &request, const CreateFaqResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateFeaturedResultsSetOutcome CreateFeaturedResultsSet (const Model::CreateFeaturedResultsSetRequest &request) const

 

template<typename CreateFeaturedResultsSetRequestT = Model::CreateFeaturedResultsSetRequest>

Model::CreateFeaturedResultsSetOutcomeCallable CreateFeaturedResultsSetCallable (const CreateFeaturedResultsSetRequestT &request) const

 

template<typename CreateFeaturedResultsSetRequestT = Model::CreateFeaturedResultsSetRequest>

void CreateFeaturedResultsSetAsync (const CreateFeaturedResultsSetRequestT &request, const CreateFeaturedResultsSetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateIndexOutcome CreateIndex (const Model::CreateIndexRequest &request) const

 

template<typename CreateIndexRequestT = Model::CreateIndexRequest>

Model::CreateIndexOutcomeCallable CreateIndexCallable (const CreateIndexRequestT &request) const

 

template<typename CreateIndexRequestT = Model::CreateIndexRequest>

void CreateIndexAsync (const CreateIndexRequestT &request, const CreateIndexResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateQuerySuggestionsBlockListOutcome CreateQuerySuggestionsBlockList (const Model::CreateQuerySuggestionsBlockListRequest &request) const

 

template<typename CreateQuerySuggestionsBlockListRequestT = Model::CreateQuerySuggestionsBlockListRequest>

Model::CreateQuerySuggestionsBlockListOutcomeCallable CreateQuerySuggestionsBlockListCallable (const CreateQuerySuggestionsBlockListRequestT &request) const

 

template<typename CreateQuerySuggestionsBlockListRequestT = Model::CreateQuerySuggestionsBlockListRequest>

void CreateQuerySuggestionsBlockListAsync (const CreateQuerySuggestionsBlockListRequestT &request, const CreateQuerySuggestionsBlockListResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateThesaurusOutcome CreateThesaurus (const Model::CreateThesaurusRequest &request) const

 

template<typename CreateThesaurusRequestT = Model::CreateThesaurusRequest>

Model::CreateThesaurusOutcomeCallable CreateThesaurusCallable (const CreateThesaurusRequestT &request) const

 

template<typename CreateThesaurusRequestT = Model::CreateThesaurusRequest>

void CreateThesaurusAsync (const CreateThesaurusRequestT &request, const CreateThesaurusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteAccessControlConfigurationOutcome DeleteAccessControlConfiguration (const Model::DeleteAccessControlConfigurationRequest &request) const

 

template<typename DeleteAccessControlConfigurationRequestT = Model::DeleteAccessControlConfigurationRequest>

Model::DeleteAccessControlConfigurationOutcomeCallable DeleteAccessControlConfigurationCallable (const DeleteAccessControlConfigurationRequestT &request) const

 

template<typename DeleteAccessControlConfigurationRequestT = Model::DeleteAccessControlConfigurationRequest>

void DeleteAccessControlConfigurationAsync (const DeleteAccessControlConfigurationRequestT &request, const DeleteAccessControlConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteDataSourceOutcome DeleteDataSource (const Model::DeleteDataSourceRequest &request) const

 

template<typename DeleteDataSourceRequestT = Model::DeleteDataSourceRequest>

Model::DeleteDataSourceOutcomeCallable DeleteDataSourceCallable (const DeleteDataSourceRequestT &request) const

 

template<typename DeleteDataSourceRequestT = Model::DeleteDataSourceRequest>

void DeleteDataSourceAsync (const DeleteDataSourceRequestT &request, const DeleteDataSourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteExperienceOutcome DeleteExperience (const Model::DeleteExperienceRequest &request) const

 

template<typename DeleteExperienceRequestT = Model::DeleteExperienceRequest>

Model::DeleteExperienceOutcomeCallable DeleteExperienceCallable (const DeleteExperienceRequestT &request) const

 

template<typename DeleteExperienceRequestT = Model::DeleteExperienceRequest>

void DeleteExperienceAsync (const DeleteExperienceRequestT &request, const DeleteExperienceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteFaqOutcome DeleteFaq (const Model::DeleteFaqRequest &request) const

 

template<typename DeleteFaqRequestT = Model::DeleteFaqRequest>

Model::DeleteFaqOutcomeCallable DeleteFaqCallable (const DeleteFaqRequestT &request) const

 

template<typename DeleteFaqRequestT = Model::DeleteFaqRequest>

void DeleteFaqAsync (const DeleteFaqRequestT &request, const DeleteFaqResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteIndexOutcome DeleteIndex (const Model::DeleteIndexRequest &request) const

 

template<typename DeleteIndexRequestT = Model::DeleteIndexRequest>

Model::DeleteIndexOutcomeCallable DeleteIndexCallable (const DeleteIndexRequestT &request) const

 

template<typename DeleteIndexRequestT = Model::DeleteIndexRequest>

void DeleteIndexAsync (const DeleteIndexRequestT &request, const DeleteIndexResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeletePrincipalMappingOutcome DeletePrincipalMapping (const Model::DeletePrincipalMappingRequest &request) const

 

template<typename DeletePrincipalMappingRequestT = Model::DeletePrincipalMappingRequest>

Model::DeletePrincipalMappingOutcomeCallable DeletePrincipalMappingCallable (const DeletePrincipalMappingRequestT &request) const

 

template<typename DeletePrincipalMappingRequestT = Model::DeletePrincipalMappingRequest>

void DeletePrincipalMappingAsync (const DeletePrincipalMappingRequestT &request, const DeletePrincipalMappingResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteQuerySuggestionsBlockListOutcome DeleteQuerySuggestionsBlockList (const Model::DeleteQuerySuggestionsBlockListRequest &request) const

 

template<typename DeleteQuerySuggestionsBlockListRequestT = Model::DeleteQuerySuggestionsBlockListRequest>

Model::DeleteQuerySuggestionsBlockListOutcomeCallable DeleteQuerySuggestionsBlockListCallable (const DeleteQuerySuggestionsBlockListRequestT &request) const

 

template<typename DeleteQuerySuggestionsBlockListRequestT = Model::DeleteQuerySuggestionsBlockListRequest>

void DeleteQuerySuggestionsBlockListAsync (const DeleteQuerySuggestionsBlockListRequestT &request, const DeleteQuerySuggestionsBlockListResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteThesaurusOutcome DeleteThesaurus (const Model::DeleteThesaurusRequest &request) const

 

template<typename DeleteThesaurusRequestT = Model::DeleteThesaurusRequest>

Model::DeleteThesaurusOutcomeCallable DeleteThesaurusCallable (const DeleteThesaurusRequestT &request) const

 

template<typename DeleteThesaurusRequestT = Model::DeleteThesaurusRequest>

void DeleteThesaurusAsync (const DeleteThesaurusRequestT &request, const DeleteThesaurusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeAccessControlConfigurationOutcome DescribeAccessControlConfiguration (const Model::DescribeAccessControlConfigurationRequest &request) const

 

template<typename DescribeAccessControlConfigurationRequestT = Model::DescribeAccessControlConfigurationRequest>

Model::DescribeAccessControlConfigurationOutcomeCallable DescribeAccessControlConfigurationCallable (const DescribeAccessControlConfigurationRequestT &request) const

 

template<typename DescribeAccessControlConfigurationRequestT = Model::DescribeAccessControlConfigurationRequest>

void DescribeAccessControlConfigurationAsync (const DescribeAccessControlConfigurationRequestT &request, const DescribeAccessControlConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeDataSourceOutcome DescribeDataSource (const Model::DescribeDataSourceRequest &request) const

 

template<typename DescribeDataSourceRequestT = Model::DescribeDataSourceRequest>

Model::DescribeDataSourceOutcomeCallable DescribeDataSourceCallable (const DescribeDataSourceRequestT &request) const

 

template<typename DescribeDataSourceRequestT = Model::DescribeDataSourceRequest>

void DescribeDataSourceAsync (const DescribeDataSourceRequestT &request, const DescribeDataSourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeExperienceOutcome DescribeExperience (const Model::DescribeExperienceRequest &request) const

 

template<typename DescribeExperienceRequestT = Model::DescribeExperienceRequest>

Model::DescribeExperienceOutcomeCallable DescribeExperienceCallable (const DescribeExperienceRequestT &request) const

 

template<typename DescribeExperienceRequestT = Model::DescribeExperienceRequest>

void DescribeExperienceAsync (const DescribeExperienceRequestT &request, const DescribeExperienceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeFaqOutcome DescribeFaq (const Model::DescribeFaqRequest &request) const

 

template<typename DescribeFaqRequestT = Model::DescribeFaqRequest>

Model::DescribeFaqOutcomeCallable DescribeFaqCallable (const DescribeFaqRequestT &request) const

 

template<typename DescribeFaqRequestT = Model::DescribeFaqRequest>

void DescribeFaqAsync (const DescribeFaqRequestT &request, const DescribeFaqResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeFeaturedResultsSetOutcome DescribeFeaturedResultsSet (const Model::DescribeFeaturedResultsSetRequest &request) const

 

template<typename DescribeFeaturedResultsSetRequestT = Model::DescribeFeaturedResultsSetRequest>

Model::DescribeFeaturedResultsSetOutcomeCallable DescribeFeaturedResultsSetCallable (const DescribeFeaturedResultsSetRequestT &request) const

 

template<typename DescribeFeaturedResultsSetRequestT = Model::DescribeFeaturedResultsSetRequest>

void DescribeFeaturedResultsSetAsync (const DescribeFeaturedResultsSetRequestT &request, const DescribeFeaturedResultsSetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeIndexOutcome DescribeIndex (const Model::DescribeIndexRequest &request) const

 

template<typename DescribeIndexRequestT = Model::DescribeIndexRequest>

Model::DescribeIndexOutcomeCallable DescribeIndexCallable (const DescribeIndexRequestT &request) const

 

template<typename DescribeIndexRequestT = Model::DescribeIndexRequest>

void DescribeIndexAsync (const DescribeIndexRequestT &request, const DescribeIndexResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribePrincipalMappingOutcome DescribePrincipalMapping (const Model::DescribePrincipalMappingRequest &request) const

 

template<typename DescribePrincipalMappingRequestT = Model::DescribePrincipalMappingRequest>

Model::DescribePrincipalMappingOutcomeCallable DescribePrincipalMappingCallable (const DescribePrincipalMappingRequestT &request) const

 

template<typename DescribePrincipalMappingRequestT = Model::DescribePrincipalMappingRequest>

void DescribePrincipalMappingAsync (const DescribePrincipalMappingRequestT &request, const DescribePrincipalMappingResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeQuerySuggestionsBlockListOutcome DescribeQuerySuggestionsBlockList (const Model::DescribeQuerySuggestionsBlockListRequest &request) const

 

template<typename DescribeQuerySuggestionsBlockListRequestT = Model::DescribeQuerySuggestionsBlockListRequest>

Model::DescribeQuerySuggestionsBlockListOutcomeCallable DescribeQuerySuggestionsBlockListCallable (const DescribeQuerySuggestionsBlockListRequestT &request) const

 

template<typename DescribeQuerySuggestionsBlockListRequestT = Model::DescribeQuerySuggestionsBlockListRequest>

void DescribeQuerySuggestionsBlockListAsync (const DescribeQuerySuggestionsBlockListRequestT &request, const DescribeQuerySuggestionsBlockListResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeQuerySuggestionsConfigOutcome DescribeQuerySuggestionsConfig (const Model::DescribeQuerySuggestionsConfigRequest &request) const

 

template<typename DescribeQuerySuggestionsConfigRequestT = Model::DescribeQuerySuggestionsConfigRequest>

Model::DescribeQuerySuggestionsConfigOutcomeCallable DescribeQuerySuggestionsConfigCallable (const DescribeQuerySuggestionsConfigRequestT &request) const

 

template<typename DescribeQuerySuggestionsConfigRequestT = Model::DescribeQuerySuggestionsConfigRequest>

void DescribeQuerySuggestionsConfigAsync (const DescribeQuerySuggestionsConfigRequestT &request, const DescribeQuerySuggestionsConfigResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DescribeThesaurusOutcome DescribeThesaurus (const Model::DescribeThesaurusRequest &request) const

 

template<typename DescribeThesaurusRequestT = Model::DescribeThesaurusRequest>

Model::DescribeThesaurusOutcomeCallable DescribeThesaurusCallable (const DescribeThesaurusRequestT &request) const

 

template<typename DescribeThesaurusRequestT = Model::DescribeThesaurusRequest>

void DescribeThesaurusAsync (const DescribeThesaurusRequestT &request, const DescribeThesaurusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DisassociateEntitiesFromExperienceOutcome DisassociateEntitiesFromExperience (const Model::DisassociateEntitiesFromExperienceRequest &request) const

 

template<typename DisassociateEntitiesFromExperienceRequestT = Model::DisassociateEntitiesFromExperienceRequest>

Model::DisassociateEntitiesFromExperienceOutcomeCallable DisassociateEntitiesFromExperienceCallable (const DisassociateEntitiesFromExperienceRequestT &request) const

 

template<typename DisassociateEntitiesFromExperienceRequestT = Model::DisassociateEntitiesFromExperienceRequest>

void DisassociateEntitiesFromExperienceAsync (const DisassociateEntitiesFromExperienceRequestT &request, const DisassociateEntitiesFromExperienceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DisassociatePersonasFromEntitiesOutcome DisassociatePersonasFromEntities (const Model::DisassociatePersonasFromEntitiesRequest &request) const

 

template<typename DisassociatePersonasFromEntitiesRequestT = Model::DisassociatePersonasFromEntitiesRequest>

Model::DisassociatePersonasFromEntitiesOutcomeCallable DisassociatePersonasFromEntitiesCallable (const DisassociatePersonasFromEntitiesRequestT &request) const

 

template<typename DisassociatePersonasFromEntitiesRequestT = Model::DisassociatePersonasFromEntitiesRequest>

void DisassociatePersonasFromEntitiesAsync (const DisassociatePersonasFromEntitiesRequestT &request, const DisassociatePersonasFromEntitiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetQuerySuggestionsOutcome GetQuerySuggestions (const Model::GetQuerySuggestionsRequest &request) const

 

template<typename GetQuerySuggestionsRequestT = Model::GetQuerySuggestionsRequest>

Model::GetQuerySuggestionsOutcomeCallable GetQuerySuggestionsCallable (const GetQuerySuggestionsRequestT &request) const

 

template<typename GetQuerySuggestionsRequestT = Model::GetQuerySuggestionsRequest>

void GetQuerySuggestionsAsync (const GetQuerySuggestionsRequestT &request, const GetQuerySuggestionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetSnapshotsOutcome GetSnapshots (const Model::GetSnapshotsRequest &request) const

 

template<typename GetSnapshotsRequestT = Model::GetSnapshotsRequest>

Model::GetSnapshotsOutcomeCallable GetSnapshotsCallable (const GetSnapshotsRequestT &request) const

 

template<typename GetSnapshotsRequestT = Model::GetSnapshotsRequest>

void GetSnapshotsAsync (const GetSnapshotsRequestT &request, const GetSnapshotsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListAccessControlConfigurationsOutcome ListAccessControlConfigurations (const Model::ListAccessControlConfigurationsRequest &request) const

 

template<typename ListAccessControlConfigurationsRequestT = Model::ListAccessControlConfigurationsRequest>

Model::ListAccessControlConfigurationsOutcomeCallable ListAccessControlConfigurationsCallable (const ListAccessControlConfigurationsRequestT &request) const

 

template<typename ListAccessControlConfigurationsRequestT = Model::ListAccessControlConfigurationsRequest>

void ListAccessControlConfigurationsAsync (const ListAccessControlConfigurationsRequestT &request, const ListAccessControlConfigurationsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListDataSourceSyncJobsOutcome ListDataSourceSyncJobs (const Model::ListDataSourceSyncJobsRequest &request) const

 

template<typename ListDataSourceSyncJobsRequestT = Model::ListDataSourceSyncJobsRequest>

Model::ListDataSourceSyncJobsOutcomeCallable ListDataSourceSyncJobsCallable (const ListDataSourceSyncJobsRequestT &request) const

 

template<typename ListDataSourceSyncJobsRequestT = Model::ListDataSourceSyncJobsRequest>

void ListDataSourceSyncJobsAsync (const ListDataSourceSyncJobsRequestT &request, const ListDataSourceSyncJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListDataSourcesOutcome ListDataSources (const Model::ListDataSourcesRequest &request) const

 

template<typename ListDataSourcesRequestT = Model::ListDataSourcesRequest>

Model::ListDataSourcesOutcomeCallable ListDataSourcesCallable (const ListDataSourcesRequestT &request) const

 

template<typename ListDataSourcesRequestT = Model::ListDataSourcesRequest>

void ListDataSourcesAsync (const ListDataSourcesRequestT &request, const ListDataSourcesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListEntityPersonasOutcome ListEntityPersonas (const Model::ListEntityPersonasRequest &request) const

 

template<typename ListEntityPersonasRequestT = Model::ListEntityPersonasRequest>

Model::ListEntityPersonasOutcomeCallable ListEntityPersonasCallable (const ListEntityPersonasRequestT &request) const

 

template<typename ListEntityPersonasRequestT = Model::ListEntityPersonasRequest>

void ListEntityPersonasAsync (const ListEntityPersonasRequestT &request, const ListEntityPersonasResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListExperienceEntitiesOutcome ListExperienceEntities (const Model::ListExperienceEntitiesRequest &request) const

 

template<typename ListExperienceEntitiesRequestT = Model::ListExperienceEntitiesRequest>

Model::ListExperienceEntitiesOutcomeCallable ListExperienceEntitiesCallable (const ListExperienceEntitiesRequestT &request) const

 

template<typename ListExperienceEntitiesRequestT = Model::ListExperienceEntitiesRequest>

void ListExperienceEntitiesAsync (const ListExperienceEntitiesRequestT &request, const ListExperienceEntitiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListExperiencesOutcome ListExperiences (const Model::ListExperiencesRequest &request) const

 

template<typename ListExperiencesRequestT = Model::ListExperiencesRequest>

Model::ListExperiencesOutcomeCallable ListExperiencesCallable (const ListExperiencesRequestT &request) const

 

template<typename ListExperiencesRequestT = Model::ListExperiencesRequest>

void ListExperiencesAsync (const ListExperiencesRequestT &request, const ListExperiencesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListFaqsOutcome ListFaqs (const Model::ListFaqsRequest &request) const

 

template<typename ListFaqsRequestT = Model::ListFaqsRequest>

Model::ListFaqsOutcomeCallable ListFaqsCallable (const ListFaqsRequestT &request) const

 

template<typename ListFaqsRequestT = Model::ListFaqsRequest>

void ListFaqsAsync (const ListFaqsRequestT &request, const ListFaqsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListFeaturedResultsSetsOutcome ListFeaturedResultsSets (const Model::ListFeaturedResultsSetsRequest &request) const

 

template<typename ListFeaturedResultsSetsRequestT = Model::ListFeaturedResultsSetsRequest>

Model::ListFeaturedResultsSetsOutcomeCallable ListFeaturedResultsSetsCallable (const ListFeaturedResultsSetsRequestT &request) const

 

template<typename ListFeaturedResultsSetsRequestT = Model::ListFeaturedResultsSetsRequest>

void ListFeaturedResultsSetsAsync (const ListFeaturedResultsSetsRequestT &request, const ListFeaturedResultsSetsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListGroupsOlderThanOrderingIdOutcome ListGroupsOlderThanOrderingId (const Model::ListGroupsOlderThanOrderingIdRequest &request) const

 

template<typename ListGroupsOlderThanOrderingIdRequestT = Model::ListGroupsOlderThanOrderingIdRequest>

Model::ListGroupsOlderThanOrderingIdOutcomeCallable ListGroupsOlderThanOrderingIdCallable (const ListGroupsOlderThanOrderingIdRequestT &request) const

 

template<typename ListGroupsOlderThanOrderingIdRequestT = Model::ListGroupsOlderThanOrderingIdRequest>

void ListGroupsOlderThanOrderingIdAsync (const ListGroupsOlderThanOrderingIdRequestT &request, const ListGroupsOlderThanOrderingIdResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListIndicesOutcome ListIndices (const Model::ListIndicesRequest &request={}) const

 

template<typename ListIndicesRequestT = Model::ListIndicesRequest>

Model::ListIndicesOutcomeCallable ListIndicesCallable (const ListIndicesRequestT &request={}) const

 

template<typename ListIndicesRequestT = Model::ListIndicesRequest>

void ListIndicesAsync (const ListIndicesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListIndicesRequestT &request={}) const

 

virtual Model::ListQuerySuggestionsBlockListsOutcome ListQuerySuggestionsBlockLists (const Model::ListQuerySuggestionsBlockListsRequest &request) const

 

template<typename ListQuerySuggestionsBlockListsRequestT = Model::ListQuerySuggestionsBlockListsRequest>

Model::ListQuerySuggestionsBlockListsOutcomeCallable ListQuerySuggestionsBlockListsCallable (const ListQuerySuggestionsBlockListsRequestT &request) const

 

template<typename ListQuerySuggestionsBlockListsRequestT = Model::ListQuerySuggestionsBlockListsRequest>

void ListQuerySuggestionsBlockListsAsync (const ListQuerySuggestionsBlockListsRequestT &request, const ListQuerySuggestionsBlockListsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const ListTagsForResourceRequestT &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void ListTagsForResourceAsync (const ListTagsForResourceRequestT &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListThesauriOutcome ListThesauri (const Model::ListThesauriRequest &request) const

 

template<typename ListThesauriRequestT = Model::ListThesauriRequest>

Model::ListThesauriOutcomeCallable ListThesauriCallable (const ListThesauriRequestT &request) const

 

template<typename ListThesauriRequestT = Model::ListThesauriRequest>

void ListThesauriAsync (const ListThesauriRequestT &request, const ListThesauriResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::PutPrincipalMappingOutcome PutPrincipalMapping (const Model::PutPrincipalMappingRequest &request) const

 

template<typename PutPrincipalMappingRequestT = Model::PutPrincipalMappingRequest>

Model::PutPrincipalMappingOutcomeCallable PutPrincipalMappingCallable (const PutPrincipalMappingRequestT &request) const

 

template<typename PutPrincipalMappingRequestT = Model::PutPrincipalMappingRequest>

void PutPrincipalMappingAsync (const PutPrincipalMappingRequestT &request, const PutPrincipalMappingResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::QueryOutcome Query (const Model::QueryRequest &request) const

 

template<typename QueryRequestT = Model::QueryRequest>

Model::QueryOutcomeCallable QueryCallable (const QueryRequestT &request) const

 

template<typename QueryRequestT = Model::QueryRequest>

void QueryAsync (const QueryRequestT &request, const QueryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::RetrieveOutcome Retrieve (const Model::RetrieveRequest &request) const

 

template<typename RetrieveRequestT = Model::RetrieveRequest>

Model::RetrieveOutcomeCallable RetrieveCallable (const RetrieveRequestT &request) const

 

template<typename RetrieveRequestT = Model::RetrieveRequest>

void RetrieveAsync (const RetrieveRequestT &request, const RetrieveResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StartDataSourceSyncJobOutcome StartDataSourceSyncJob (const Model::StartDataSourceSyncJobRequest &request) const

 

template<typename StartDataSourceSyncJobRequestT = Model::StartDataSourceSyncJobRequest>

Model::StartDataSourceSyncJobOutcomeCallable StartDataSourceSyncJobCallable (const StartDataSourceSyncJobRequestT &request) const

 

template<typename StartDataSourceSyncJobRequestT = Model::StartDataSourceSyncJobRequest>

void StartDataSourceSyncJobAsync (const StartDataSourceSyncJobRequestT &request, const StartDataSourceSyncJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::StopDataSourceSyncJobOutcome StopDataSourceSyncJob (const Model::StopDataSourceSyncJobRequest &request) const

 

template<typename StopDataSourceSyncJobRequestT = Model::StopDataSourceSyncJobRequest>

Model::StopDataSourceSyncJobOutcomeCallable StopDataSourceSyncJobCallable (const StopDataSourceSyncJobRequestT &request) const

 

template<typename StopDataSourceSyncJobRequestT = Model::StopDataSourceSyncJobRequest>

void StopDataSourceSyncJobAsync (const StopDataSourceSyncJobRequestT &request, const StopDataSourceSyncJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::SubmitFeedbackOutcome SubmitFeedback (const Model::SubmitFeedbackRequest &request) const

 

template<typename SubmitFeedbackRequestT = Model::SubmitFeedbackRequest>

Model::SubmitFeedbackOutcomeCallable SubmitFeedbackCallable (const SubmitFeedbackRequestT &request) const

 

template<typename SubmitFeedbackRequestT = Model::SubmitFeedbackRequest>

void SubmitFeedbackAsync (const SubmitFeedbackRequestT &request, const SubmitFeedbackResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable TagResourceCallable (const TagResourceRequestT &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

void TagResourceAsync (const TagResourceRequestT &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable UntagResourceCallable (const UntagResourceRequestT &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void UntagResourceAsync (const UntagResourceRequestT &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateAccessControlConfigurationOutcome UpdateAccessControlConfiguration (const Model::UpdateAccessControlConfigurationRequest &request) const

 

template<typename UpdateAccessControlConfigurationRequestT = Model::UpdateAccessControlConfigurationRequest>

Model::UpdateAccessControlConfigurationOutcomeCallable UpdateAccessControlConfigurationCallable (const UpdateAccessControlConfigurationRequestT &request) const

 

template<typename UpdateAccessControlConfigurationRequestT = Model::UpdateAccessControlConfigurationRequest>

void UpdateAccessControlConfigurationAsync (const UpdateAccessControlConfigurationRequestT &request, const UpdateAccessControlConfigurationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateDataSourceOutcome UpdateDataSource (const Model::UpdateDataSourceRequest &request) const

 

template<typename UpdateDataSourceRequestT = Model::UpdateDataSourceRequest>

Model::UpdateDataSourceOutcomeCallable UpdateDataSourceCallable (const UpdateDataSourceRequestT &request) const

 

template<typename UpdateDataSourceRequestT = Model::UpdateDataSourceRequest>

void UpdateDataSourceAsync (const UpdateDataSourceRequestT &request, const UpdateDataSourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateExperienceOutcome UpdateExperience (const Model::UpdateExperienceRequest &request) const

 

template<typename UpdateExperienceRequestT = Model::UpdateExperienceRequest>

Model::UpdateExperienceOutcomeCallable UpdateExperienceCallable (const UpdateExperienceRequestT &request) const

 

template<typename UpdateExperienceRequestT = Model::UpdateExperienceRequest>

void UpdateExperienceAsync (const UpdateExperienceRequestT &request, const UpdateExperienceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateFeaturedResultsSetOutcome UpdateFeaturedResultsSet (const Model::UpdateFeaturedResultsSetRequest &request) const

 

template<typename UpdateFeaturedResultsSetRequestT = Model::UpdateFeaturedResultsSetRequest>

Model::UpdateFeaturedResultsSetOutcomeCallable UpdateFeaturedResultsSetCallable (const UpdateFeaturedResultsSetRequestT &request) const

 

template<typename UpdateFeaturedResultsSetRequestT = Model::UpdateFeaturedResultsSetRequest>

void UpdateFeaturedResultsSetAsync (const UpdateFeaturedResultsSetRequestT &request, const UpdateFeaturedResultsSetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateIndexOutcome UpdateIndex (const Model::UpdateIndexRequest &request) const

 

template<typename UpdateIndexRequestT = Model::UpdateIndexRequest>

Model::UpdateIndexOutcomeCallable UpdateIndexCallable (const UpdateIndexRequestT &request) const

 

template<typename UpdateIndexRequestT = Model::UpdateIndexRequest>

void UpdateIndexAsync (const UpdateIndexRequestT &request, const UpdateIndexResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateQuerySuggestionsBlockListOutcome UpdateQuerySuggestionsBlockList (const Model::UpdateQuerySuggestionsBlockListRequest &request) const

 

template<typename UpdateQuerySuggestionsBlockListRequestT = Model::UpdateQuerySuggestionsBlockListRequest>

Model::UpdateQuerySuggestionsBlockListOutcomeCallable UpdateQuerySuggestionsBlockListCallable (const UpdateQuerySuggestionsBlockListRequestT &request) const

 

template<typename UpdateQuerySuggestionsBlockListRequestT = Model::UpdateQuerySuggestionsBlockListRequest>

void UpdateQuerySuggestionsBlockListAsync (const UpdateQuerySuggestionsBlockListRequestT &request, const UpdateQuerySuggestionsBlockListResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateQuerySuggestionsConfigOutcome UpdateQuerySuggestionsConfig (const Model::UpdateQuerySuggestionsConfigRequest &request) const

 

template<typename UpdateQuerySuggestionsConfigRequestT = Model::UpdateQuerySuggestionsConfigRequest>

Model::UpdateQuerySuggestionsConfigOutcomeCallable UpdateQuerySuggestionsConfigCallable (const UpdateQuerySuggestionsConfigRequestT &request) const

 

template<typename UpdateQuerySuggestionsConfigRequestT = Model::UpdateQuerySuggestionsConfigRequest>

void UpdateQuerySuggestionsConfigAsync (const UpdateQuerySuggestionsConfigRequestT &request, const UpdateQuerySuggestionsConfigResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateThesaurusOutcome UpdateThesaurus (const Model::UpdateThesaurusRequest &request) const

 

template<typename UpdateThesaurusRequestT = Model::UpdateThesaurusRequest>

Model::UpdateThesaurusOutcomeCallable UpdateThesaurusCallable (const UpdateThesaurusRequestT &request) const

 

template<typename UpdateThesaurusRequestT = Model::UpdateThesaurusRequest>

void UpdateThesaurusAsync (const UpdateThesaurusRequestT &request, const UpdateThesaurusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void OverrideEndpoint (const Aws::String &endpoint)

 

std::shared_ptr< KendraEndpointProviderBase > & accessEndpointProvider ()

 

Public Member Functions inherited from Aws::Client::AWSJsonClient

 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

virtual ~AWSJsonClient ()=default

 

Public Member Functions inherited from Aws::Client::AWSProtocolClient< JsonOutcome, Utils::Json::JsonValue >

 AWSProtocolClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

 AWSProtocolClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

virtual ~AWSProtocolClient ()=default

 

Public Member Functions inherited from Aws::Client::AWSClient

 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)

 

virtual ~AWSClient ()

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const

 

void DisableRequestProcessing ()

 

void EnableRequestProcessing ()

 

virtual const char * GetServiceClientName () const

 

virtual void SetServiceClientName (const Aws::String &name)

 

void AppendToUserAgent (const Aws::String &valueToAppend)

 

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< KendraClient >

 ClientWithAsyncTemplateMethods ()

 

 ClientWithAsyncTemplateMethods (const ClientWithAsyncTemplateMethods &other)

 

ClientWithAsyncTemplateMethods & operator= (const ClientWithAsyncTemplateMethods &other)

 

virtual ~ClientWithAsyncTemplateMethods ()

 

void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>

 

Static Public Member Functions

static const char * GetServiceName ()

 

static const char * GetAllocationTag ()

 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< KendraClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)

 

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< KendraClient >

 

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSProtocolClient< JsonOutcome, Utils::Json::JsonValue >

OutcomeType MakeRequest (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

OutcomeType MakeRequest (const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

OutcomeType MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

OutcomeType MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

OutcomeType MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

AWSError< CoreErrors > BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &httpResponse) const override

 

Protected Member Functions inherited from Aws::Client::AWSClient

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const

 

virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const

 

virtual void AddContentLengthToRequest (const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest, const std::shared_ptr< Aws::IOStream > &body, bool isChunked) const

 

const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const

 

Aws::Client::AWSAuthSigner * GetSignerByName (const char *name) const

 

std::shared_ptr< Auth::AWSCredentialsProvider > GetCredentialsProvider () const

 

std::shared_ptr< Aws::Http::HttpRequest > BuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const

 

std::shared_ptr< Aws::Http::HttpResponse > MakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)

 

static CoreErrors GuessBodylessErrorType (Aws::Http::HttpResponseCode responseCode)

 

static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)

 

Protected Attributes inherited from Aws::Client::AWSClient

Aws::String m_region

 

std::shared_ptr< smithy::components::tracing::TelemetryProvider > m_telemetryProvider

 

std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > m_signerProvider

 

Protected Attributes inherited from Aws::Client::ClientWithAsyncTemplateMethods< KendraClient >

std::atomic< bool > m_isInitialized

 

std::atomic< size_t > m_operationsProcessed

 

std::condition_variable m_shutdownSignal

 

std::mutex m_shutdownMutex

 

Detailed Description

Amazon Kendra is a service for indexing large document sets.

Definition at line 19 of file KendraClient.h.

Member Typedef Documentation

BASECLASS

typedef Aws::Client::AWSJsonClient Aws::kendra::KendraClient::BASECLASS

Definition at line 21 of file KendraClient.h.

ClientConfigurationType

typedef KendraClientConfiguration Aws::kendra::KendraClient::ClientConfigurationType

Definition at line 25 of file KendraClient.h.

EndpointProviderType

typedef KendraEndpointProvider Aws::kendra::KendraClient::EndpointProviderType

Definition at line 26 of file KendraClient.h.

Constructor & Destructor Documentation

KendraClient() [1/6]

Aws::kendra::KendraClient::KendraClient ( const Aws::kendra::KendraClientConfiguration &  clientConfiguration = Aws::kendra::KendraClientConfiguration(),

std::shared_ptr< KendraEndpointProviderBase >  endpointProvider = nullptr 

)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

KendraClient() [2/6]

Aws::kendra::KendraClient::KendraClient ( const Aws::Auth::AWSCredentials &  credentials,

std::shared_ptr< KendraEndpointProviderBase >  endpointProvider = nullptr,

const Aws::kendra::KendraClientConfiguration &  clientConfiguration = Aws::kendra::KendraClientConfiguration() 

)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

KendraClient() [3/6]

Aws::kendra::KendraClient::KendraClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

std::shared_ptr< KendraEndpointProviderBase >  endpointProvider = nullptr,

const Aws::kendra::KendraClientConfiguration &  clientConfiguration = Aws::kendra::KendraClientConfiguration() 

)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

KendraClient() [4/6]

Aws::kendra::KendraClient::KendraClient ( const Aws::Client::ClientConfiguration &  clientConfiguration)

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

KendraClient() [5/6]

Aws::kendra::KendraClient::KendraClient ( const Aws::Auth::AWSCredentials &  credentials,

const Aws::Client::ClientConfiguration &  clientConfiguration 

)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

KendraClient() [6/6]

Aws::kendra::KendraClient::KendraClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

const Aws::Client::ClientConfiguration &  clientConfiguration 

)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

~KendraClient()

virtual Aws::kendra::KendraClient::~KendraClient ( )

virtual

Member Function Documentation

accessEndpointProvider()

std::shared_ptr< KendraEndpointProviderBase > & Aws::kendra::KendraClient::accessEndpointProvider ( )

AssociateEntitiesToExperience()

virtual Model::AssociateEntitiesToExperienceOutcome Aws::kendra::KendraClient::AssociateEntitiesToExperience ( const Model::AssociateEntitiesToExperienceRequest &  request) const

virtual

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.

See Also:

AWS API Reference

AssociateEntitiesToExperienceAsync()

template<typename AssociateEntitiesToExperienceRequestT = Model::AssociateEntitiesToExperienceRequest>

void Aws::kendra::KendraClient::AssociateEntitiesToExperienceAsync ( const AssociateEntitiesToExperienceRequestT &  request,

const AssociateEntitiesToExperienceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for AssociateEntitiesToExperience that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 101 of file KendraClient.h.

AssociateEntitiesToExperienceCallable()

template<typename AssociateEntitiesToExperienceRequestT = Model::AssociateEntitiesToExperienceRequest>

Model::AssociateEntitiesToExperienceOutcomeCallable Aws::kendra::KendraClient::AssociateEntitiesToExperienceCallable ( const AssociateEntitiesToExperienceRequestT &  request) const

inline

A Callable wrapper for AssociateEntitiesToExperience that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 91 of file KendraClient.h.

AssociatePersonasToEntities()

virtual Model::AssociatePersonasToEntitiesOutcome Aws::kendra::KendraClient::AssociatePersonasToEntities ( const Model::AssociatePersonasToEntitiesRequest &  request) const

virtual

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.

See Also:

AWS API Reference

AssociatePersonasToEntitiesAsync()

template<typename AssociatePersonasToEntitiesRequestT = Model::AssociatePersonasToEntitiesRequest>

void Aws::kendra::KendraClient::AssociatePersonasToEntitiesAsync ( const AssociatePersonasToEntitiesRequestT &  request,

const AssociatePersonasToEntitiesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for AssociatePersonasToEntities that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 135 of file KendraClient.h.

AssociatePersonasToEntitiesCallable()

template<typename AssociatePersonasToEntitiesRequestT = Model::AssociatePersonasToEntitiesRequest>

Model::AssociatePersonasToEntitiesOutcomeCallable Aws::kendra::KendraClient::AssociatePersonasToEntitiesCallable ( const AssociatePersonasToEntitiesRequestT &  request) const

inline

A Callable wrapper for AssociatePersonasToEntities that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 125 of file KendraClient.h.

BatchDeleteDocument()

virtual Model::BatchDeleteDocumentOutcome Aws::kendra::KendraClient::BatchDeleteDocument ( const Model::BatchDeleteDocumentRequest &  request) const

virtual

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.

Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.

See Also:

AWS API Reference

BatchDeleteDocumentAsync()

template<typename BatchDeleteDocumentRequestT = Model::BatchDeleteDocumentRequest>

void Aws::kendra::KendraClient::BatchDeleteDocumentAsync ( const BatchDeleteDocumentRequestT &  request,

const BatchDeleteDocumentResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for BatchDeleteDocument that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 170 of file KendraClient.h.

BatchDeleteDocumentCallable()

template<typename BatchDeleteDocumentRequestT = Model::BatchDeleteDocumentRequest>

Model::BatchDeleteDocumentOutcomeCallable Aws::kendra::KendraClient::BatchDeleteDocumentCallable ( const BatchDeleteDocumentRequestT &  request) const

inline

A Callable wrapper for BatchDeleteDocument that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 161 of file KendraClient.h.

BatchDeleteFeaturedResultsSet()

virtual Model::BatchDeleteFeaturedResultsSetOutcome Aws::kendra::KendraClient::BatchDeleteFeaturedResultsSet ( const Model::BatchDeleteFeaturedResultsSetRequest &  request) const

virtual

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.

See Also:

AWS API Reference

BatchDeleteFeaturedResultsSetAsync()

template<typename BatchDeleteFeaturedResultsSetRequestT = Model::BatchDeleteFeaturedResultsSetRequest>

void Aws::kendra::KendraClient::BatchDeleteFeaturedResultsSetAsync ( const BatchDeleteFeaturedResultsSetRequestT &  request,

const BatchDeleteFeaturedResultsSetResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for BatchDeleteFeaturedResultsSet that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 201 of file KendraClient.h.

BatchDeleteFeaturedResultsSetCallable()

template<typename BatchDeleteFeaturedResultsSetRequestT = Model::BatchDeleteFeaturedResultsSetRequest>

Model::BatchDeleteFeaturedResultsSetOutcomeCallable Aws::kendra::KendraClient::BatchDeleteFeaturedResultsSetCallable ( const BatchDeleteFeaturedResultsSetRequestT &  request) const

inline

A Callable wrapper for BatchDeleteFeaturedResultsSet that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 191 of file KendraClient.h.

BatchGetDocumentStatus()

virtual Model::BatchGetDocumentStatusOutcome Aws::kendra::KendraClient::BatchGetDocumentStatus ( const Model::BatchGetDocumentStatusRequest &  request) const

virtual

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.

See Also:

AWS API Reference

BatchGetDocumentStatusAsync()

template<typename BatchGetDocumentStatusRequestT = Model::BatchGetDocumentStatusRequest>

void Aws::kendra::KendraClient::BatchGetDocumentStatusAsync ( const BatchGetDocumentStatusRequestT &  request,

const BatchGetDocumentStatusResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for BatchGetDocumentStatus that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 239 of file KendraClient.h.

BatchGetDocumentStatusCallable()

template<typename BatchGetDocumentStatusRequestT = Model::BatchGetDocumentStatusRequest>

Model::BatchGetDocumentStatusOutcomeCallable Aws::kendra::KendraClient::BatchGetDocumentStatusCallable ( const BatchGetDocumentStatusRequestT &  request) const

inline

A Callable wrapper for BatchGetDocumentStatus that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 230 of file KendraClient.h.

BatchPutDocument()

virtual Model::BatchPutDocumentOutcome Aws::kendra::KendraClient::BatchPutDocument ( const Model::BatchPutDocumentRequest &  request) const

virtual

Adds one or more documents to an index.

The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your documents.

For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.

See Also:

AWS API Reference

BatchPutDocumentAsync()

template<typename BatchPutDocumentRequestT = Model::BatchPutDocumentRequest>

void Aws::kendra::KendraClient::BatchPutDocumentAsync ( const BatchPutDocumentRequestT &  request,

const BatchPutDocumentResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for BatchPutDocument that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 278 of file KendraClient.h.

BatchPutDocumentCallable()

template<typename BatchPutDocumentRequestT = Model::BatchPutDocumentRequest>

Model::BatchPutDocumentOutcomeCallable Aws::kendra::KendraClient::BatchPutDocumentCallable ( const BatchPutDocumentRequestT &  request) const

inline

A Callable wrapper for BatchPutDocument that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 269 of file KendraClient.h.

ClearQuerySuggestions()

virtual Model::ClearQuerySuggestionsOutcome Aws::kendra::KendraClient::ClearQuerySuggestions ( const Model::ClearQuerySuggestionsRequest &  request) const

virtual

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.

See Also:

AWS API Reference

ClearQuerySuggestionsAsync()

template<typename ClearQuerySuggestionsRequestT = Model::ClearQuerySuggestionsRequest>

void Aws::kendra::KendraClient::ClearQuerySuggestionsAsync ( const ClearQuerySuggestionsRequestT &  request,

const ClearQuerySuggestionsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ClearQuerySuggestions that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 311 of file KendraClient.h.

ClearQuerySuggestionsCallable()

template<typename ClearQuerySuggestionsRequestT = Model::ClearQuerySuggestionsRequest>

Model::ClearQuerySuggestionsOutcomeCallable Aws::kendra::KendraClient::ClearQuerySuggestionsCallable ( const ClearQuerySuggestionsRequestT &  request) const

inline

A Callable wrapper for ClearQuerySuggestions that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 302 of file KendraClient.h.

CreateAccessControlConfiguration()

virtual Model::CreateAccessControlConfigurationOutcome Aws::kendra::KendraClient::CreateAccessControlConfiguration ( const Model::CreateAccessControlConfigurationRequest &  request) const

virtual

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.

You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.

See Also:

AWS API Reference

CreateAccessControlConfigurationAsync()

template<typename CreateAccessControlConfigurationRequestT = Model::CreateAccessControlConfigurationRequest>

void Aws::kendra::KendraClient::CreateAccessControlConfigurationAsync ( const CreateAccessControlConfigurationRequestT &  request,

const CreateAccessControlConfigurationResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateAccessControlConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 366 of file KendraClient.h.

CreateAccessControlConfigurationCallable()

template<typename CreateAccessControlConfigurationRequestT = Model::CreateAccessControlConfigurationRequest>

Model::CreateAccessControlConfigurationOutcomeCallable Aws::kendra::KendraClient::CreateAccessControlConfigurationCallable ( const CreateAccessControlConfigurationRequestT &  request) const

inline

A Callable wrapper for CreateAccessControlConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 356 of file KendraClient.h.

CreateDataSource()

virtual Model::CreateDataSourceOutcome Aws::kendra::KendraClient::CreateDataSource ( const Model::CreateDataSourceRequest &  request) const

virtual

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.

See Also:

AWS API Reference

CreateDataSourceAsync()

template<typename CreateDataSourceRequestT = Model::CreateDataSourceRequest>

void Aws::kendra::KendraClient::CreateDataSourceAsync ( const CreateDataSourceRequestT &  request,

const CreateDataSourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateDataSource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 404 of file KendraClient.h.

CreateDataSourceCallable()

template<typename CreateDataSourceRequestT = Model::CreateDataSourceRequest>

Model::CreateDataSourceOutcomeCallable Aws::kendra::KendraClient::CreateDataSourceCallable ( const CreateDataSourceRequestT &  request) const

inline

A Callable wrapper for CreateDataSource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 395 of file KendraClient.h.

CreateExperience()

virtual Model::CreateExperienceOutcome Aws::kendra::KendraClient::CreateExperience ( const Model::CreateExperienceRequest &  request) const

virtual

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.

See Also:

AWS API Reference

CreateExperienceAsync()

template<typename CreateExperienceRequestT = Model::CreateExperienceRequest>

void Aws::kendra::KendraClient::CreateExperienceAsync ( const CreateExperienceRequestT &  request,

const CreateExperienceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateExperience that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 434 of file KendraClient.h.

CreateExperienceCallable()

template<typename CreateExperienceRequestT = Model::CreateExperienceRequest>

Model::CreateExperienceOutcomeCallable Aws::kendra::KendraClient::CreateExperienceCallable ( const CreateExperienceRequestT &  request) const

inline

A Callable wrapper for CreateExperience that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 425 of file KendraClient.h.

CreateFaq()

virtual Model::CreateFaqOutcome Aws::kendra::KendraClient::CreateFaq ( const Model::CreateFaqRequest &  request) const

virtual

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.

See Also:

AWS API Reference

CreateFaqAsync()

template<typename CreateFaqRequestT = Model::CreateFaqRequest>

void Aws::kendra::KendraClient::CreateFaqAsync ( const CreateFaqRequestT &  request,

const CreateFaqResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateFaq that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 464 of file KendraClient.h.

CreateFaqCallable()

template<typename CreateFaqRequestT = Model::CreateFaqRequest>

Model::CreateFaqOutcomeCallable Aws::kendra::KendraClient::CreateFaqCallable ( const CreateFaqRequestT &  request) const

inline

A Callable wrapper for CreateFaq that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 455 of file KendraClient.h.

CreateFeaturedResultsSet()

virtual Model::CreateFeaturedResultsSetOutcome Aws::kendra::KendraClient::CreateFeaturedResultsSet ( const Model::CreateFeaturedResultsSetRequest &  request) const

virtual

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.

See Also:

AWS API Reference

CreateFeaturedResultsSetAsync()

template<typename CreateFeaturedResultsSetRequestT = Model::CreateFeaturedResultsSetRequest>

void Aws::kendra::KendraClient::CreateFeaturedResultsSetAsync ( const CreateFeaturedResultsSetRequestT &  request,

const CreateFeaturedResultsSetResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateFeaturedResultsSet that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 497 of file KendraClient.h.

CreateFeaturedResultsSetCallable()

template<typename CreateFeaturedResultsSetRequestT = Model::CreateFeaturedResultsSetRequest>

Model::CreateFeaturedResultsSetOutcomeCallable Aws::kendra::KendraClient::CreateFeaturedResultsSetCallable ( const CreateFeaturedResultsSetRequestT &  request) const

inline

A Callable wrapper for CreateFeaturedResultsSet that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 488 of file KendraClient.h.

CreateIndex()

virtual Model::CreateIndexOutcome Aws::kendra::KendraClient::CreateIndex ( const Model::CreateIndexRequest &  request) const

virtual

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.

See Also:

AWS API Reference

CreateIndexAsync()

template<typename CreateIndexRequestT = Model::CreateIndexRequest>

void Aws::kendra::KendraClient::CreateIndexAsync ( const CreateIndexRequestT &  request,

const CreateIndexResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateIndex that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 536 of file KendraClient.h.

CreateIndexCallable()

template<typename CreateIndexRequestT = Model::CreateIndexRequest>

Model::CreateIndexOutcomeCallable Aws::kendra::KendraClient::CreateIndexCallable ( const CreateIndexRequestT &  request) const

inline

A Callable wrapper for CreateIndex that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 527 of file KendraClient.h.

CreateQuerySuggestionsBlockList()

virtual Model::CreateQuerySuggestionsBlockListOutcome Aws::kendra::KendraClient::CreateQuerySuggestionsBlockList ( const Model::CreateQuerySuggestionsBlockListRequest &  request) const

virtual

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.

See Also:

AWS API Reference

CreateQuerySuggestionsBlockListAsync()

template<typename CreateQuerySuggestionsBlockListRequestT = Model::CreateQuerySuggestionsBlockListRequest>

void Aws::kendra::KendraClient::CreateQuerySuggestionsBlockListAsync ( const CreateQuerySuggestionsBlockListRequestT &  request,

const CreateQuerySuggestionsBlockListResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateQuerySuggestionsBlockList that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 576 of file KendraClient.h.

CreateQuerySuggestionsBlockListCallable()

template<typename CreateQuerySuggestionsBlockListRequestT = Model::CreateQuerySuggestionsBlockListRequest>

Model::CreateQuerySuggestionsBlockListOutcomeCallable Aws::kendra::KendraClient::CreateQuerySuggestionsBlockListCallable ( const CreateQuerySuggestionsBlockListRequestT &  request) const

inline

A Callable wrapper for CreateQuerySuggestionsBlockList that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 566 of file KendraClient.h.

CreateThesaurus()

virtual Model::CreateThesaurusOutcome Aws::kendra::KendraClient::CreateThesaurus ( const Model::CreateThesaurusRequest &  request) const

virtual

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.

See Also:

AWS API Reference

CreateThesaurusAsync()

template<typename CreateThesaurusRequestT = Model::CreateThesaurusRequest>

void Aws::kendra::KendraClient::CreateThesaurusAsync ( const CreateThesaurusRequestT &  request,

const CreateThesaurusResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateThesaurus that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 606 of file KendraClient.h.

CreateThesaurusCallable()

template<typename CreateThesaurusRequestT = Model::CreateThesaurusRequest>

Model::CreateThesaurusOutcomeCallable Aws::kendra::KendraClient::CreateThesaurusCallable ( const CreateThesaurusRequestT &  request) const

inline

A Callable wrapper for CreateThesaurus that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 597 of file KendraClient.h.

DeleteAccessControlConfiguration()

virtual Model::DeleteAccessControlConfigurationOutcome Aws::kendra::KendraClient::DeleteAccessControlConfiguration ( const Model::DeleteAccessControlConfigurationRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DeleteAccessControlConfigurationAsync()

template<typename DeleteAccessControlConfigurationRequestT = Model::DeleteAccessControlConfigurationRequest>

void Aws::kendra::KendraClient::DeleteAccessControlConfigurationAsync ( const DeleteAccessControlConfigurationRequestT &  request,

const DeleteAccessControlConfigurationResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteAccessControlConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 638 of file KendraClient.h.

DeleteAccessControlConfigurationCallable()

template<typename DeleteAccessControlConfigurationRequestT = Model::DeleteAccessControlConfigurationRequest>

Model::DeleteAccessControlConfigurationOutcomeCallable Aws::kendra::KendraClient::DeleteAccessControlConfigurationCallable ( const DeleteAccessControlConfigurationRequestT &  request) const

inline

A Callable wrapper for DeleteAccessControlConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 628 of file KendraClient.h.

DeleteDataSource()

virtual Model::DeleteDataSourceOutcome Aws::kendra::KendraClient::DeleteDataSource ( const Model::DeleteDataSourceRequest &  request) const

virtual

Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.

Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.

See Also:

AWS API Reference

DeleteDataSourceAsync()

template<typename DeleteDataSourceRequestT = Model::DeleteDataSourceRequest>

void Aws::kendra::KendraClient::DeleteDataSourceAsync ( const DeleteDataSourceRequestT &  request,

const DeleteDataSourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteDataSource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 674 of file KendraClient.h.

DeleteDataSourceCallable()

template<typename DeleteDataSourceRequestT = Model::DeleteDataSourceRequest>

Model::DeleteDataSourceOutcomeCallable Aws::kendra::KendraClient::DeleteDataSourceCallable ( const DeleteDataSourceRequestT &  request) const

inline

A Callable wrapper for DeleteDataSource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 665 of file KendraClient.h.

DeleteExperience()

virtual Model::DeleteExperienceOutcome Aws::kendra::KendraClient::DeleteExperience ( const Model::DeleteExperienceRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DeleteExperienceAsync()

template<typename DeleteExperienceRequestT = Model::DeleteExperienceRequest>

void Aws::kendra::KendraClient::DeleteExperienceAsync ( const DeleteExperienceRequestT &  request,

const DeleteExperienceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteExperience that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 703 of file KendraClient.h.

DeleteExperienceCallable()

template<typename DeleteExperienceRequestT = Model::DeleteExperienceRequest>

Model::DeleteExperienceOutcomeCallable Aws::kendra::KendraClient::DeleteExperienceCallable ( const DeleteExperienceRequestT &  request) const

inline

A Callable wrapper for DeleteExperience that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 694 of file KendraClient.h.

DeleteFaq()

virtual Model::DeleteFaqOutcome Aws::kendra::KendraClient::DeleteFaq ( const Model::DeleteFaqRequest &  request) const

virtual

Removes a FAQ from an index.

See Also:

AWS API Reference

DeleteFaqAsync()

template<typename DeleteFaqRequestT = Model::DeleteFaqRequest>

void Aws::kendra::KendraClient::DeleteFaqAsync ( const DeleteFaqRequestT &  request,

const DeleteFaqResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteFaq that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 728 of file KendraClient.h.

DeleteFaqCallable()

template<typename DeleteFaqRequestT = Model::DeleteFaqRequest>

Model::DeleteFaqOutcomeCallable Aws::kendra::KendraClient::DeleteFaqCallable ( const DeleteFaqRequestT &  request) const

inline

A Callable wrapper for DeleteFaq that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 719 of file KendraClient.h.

DeleteIndex()

virtual Model::DeleteIndexOutcome Aws::kendra::KendraClient::DeleteIndex ( const Model::DeleteIndexRequest &  request) const

virtual

Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.

See Also:

AWS API Reference

DeleteIndexAsync()

template<typename DeleteIndexRequestT = Model::DeleteIndexRequest>

void Aws::kendra::KendraClient::DeleteIndexAsync ( const DeleteIndexRequestT &  request,

const DeleteIndexResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteIndex that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 756 of file KendraClient.h.

DeleteIndexCallable()

template<typename DeleteIndexRequestT = Model::DeleteIndexRequest>

Model::DeleteIndexOutcomeCallable Aws::kendra::KendraClient::DeleteIndexCallable ( const DeleteIndexRequestT &  request) const

inline

A Callable wrapper for DeleteIndex that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 747 of file KendraClient.h.

DeletePrincipalMapping()

virtual Model::DeletePrincipalMappingOutcome Aws::kendra::KendraClient::DeletePrincipalMapping ( const Model::DeletePrincipalMappingRequest &  request) const

virtual

Deletes a group so that all users 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.

See Also:

AWS API Reference

DeletePrincipalMappingAsync()

template<typename DeletePrincipalMappingRequestT = Model::DeletePrincipalMappingRequest>

void Aws::kendra::KendraClient::DeletePrincipalMappingAsync ( const DeletePrincipalMappingRequestT &  request,

const DeletePrincipalMappingResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeletePrincipalMapping that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 794 of file KendraClient.h.

DeletePrincipalMappingCallable()

template<typename DeletePrincipalMappingRequestT = Model::DeletePrincipalMappingRequest>

Model::DeletePrincipalMappingOutcomeCallable Aws::kendra::KendraClient::DeletePrincipalMappingCallable ( const DeletePrincipalMappingRequestT &  request) const

inline

A Callable wrapper for DeletePrincipalMapping that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 785 of file KendraClient.h.

DeleteQuerySuggestionsBlockList()

virtual Model::DeleteQuerySuggestionsBlockListOutcome Aws::kendra::KendraClient::DeleteQuerySuggestionsBlockList ( const Model::DeleteQuerySuggestionsBlockListRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DeleteQuerySuggestionsBlockListAsync()

template<typename DeleteQuerySuggestionsBlockListRequestT = Model::DeleteQuerySuggestionsBlockListRequest>

void Aws::kendra::KendraClient::DeleteQuerySuggestionsBlockListAsync ( const DeleteQuerySuggestionsBlockListRequestT &  request,

const DeleteQuerySuggestionsBlockListResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteQuerySuggestionsBlockList that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 828 of file KendraClient.h.

DeleteQuerySuggestionsBlockListCallable()

template<typename DeleteQuerySuggestionsBlockListRequestT = Model::DeleteQuerySuggestionsBlockListRequest>

Model::DeleteQuerySuggestionsBlockListOutcomeCallable Aws::kendra::KendraClient::DeleteQuerySuggestionsBlockListCallable ( const DeleteQuerySuggestionsBlockListRequestT &  request) const

inline

A Callable wrapper for DeleteQuerySuggestionsBlockList that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 818 of file KendraClient.h.

DeleteThesaurus()

virtual Model::DeleteThesaurusOutcome Aws::kendra::KendraClient::DeleteThesaurus ( const Model::DeleteThesaurusRequest &  request) const

virtual

Deletes an Amazon Kendra thesaurus.

See Also:

AWS API Reference

DeleteThesaurusAsync()

template<typename DeleteThesaurusRequestT = Model::DeleteThesaurusRequest>

void Aws::kendra::KendraClient::DeleteThesaurusAsync ( const DeleteThesaurusRequestT &  request,

const DeleteThesaurusResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteThesaurus that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 854 of file KendraClient.h.

DeleteThesaurusCallable()

template<typename DeleteThesaurusRequestT = Model::DeleteThesaurusRequest>

Model::DeleteThesaurusOutcomeCallable Aws::kendra::KendraClient::DeleteThesaurusCallable ( const DeleteThesaurusRequestT &  request) const

inline

A Callable wrapper for DeleteThesaurus that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 845 of file KendraClient.h.

DescribeAccessControlConfiguration()

virtual Model::DescribeAccessControlConfigurationOutcome Aws::kendra::KendraClient::DescribeAccessControlConfiguration ( const Model::DescribeAccessControlConfigurationRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DescribeAccessControlConfigurationAsync()

template<typename DescribeAccessControlConfigurationRequestT = Model::DescribeAccessControlConfigurationRequest>

void Aws::kendra::KendraClient::DescribeAccessControlConfigurationAsync ( const DescribeAccessControlConfigurationRequestT &  request,

const DescribeAccessControlConfigurationResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeAccessControlConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 886 of file KendraClient.h.

DescribeAccessControlConfigurationCallable()

template<typename DescribeAccessControlConfigurationRequestT = Model::DescribeAccessControlConfigurationRequest>

Model::DescribeAccessControlConfigurationOutcomeCallable Aws::kendra::KendraClient::DescribeAccessControlConfigurationCallable ( const DescribeAccessControlConfigurationRequestT &  request) const

inline

A Callable wrapper for DescribeAccessControlConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 876 of file KendraClient.h.

DescribeDataSource()

virtual Model::DescribeDataSourceOutcome Aws::kendra::KendraClient::DescribeDataSource ( const Model::DescribeDataSourceRequest &  request) const

virtual

Gets information about an Amazon Kendra data source connector.

See Also:

AWS API Reference

DescribeDataSourceAsync()

template<typename DescribeDataSourceRequestT = Model::DescribeDataSourceRequest>

void Aws::kendra::KendraClient::DescribeDataSourceAsync ( const DescribeDataSourceRequestT &  request,

const DescribeDataSourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeDataSource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 914 of file KendraClient.h.

DescribeDataSourceCallable()

template<typename DescribeDataSourceRequestT = Model::DescribeDataSourceRequest>

Model::DescribeDataSourceOutcomeCallable Aws::kendra::KendraClient::DescribeDataSourceCallable ( const DescribeDataSourceRequestT &  request) const

inline

A Callable wrapper for DescribeDataSource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 905 of file KendraClient.h.

DescribeExperience()

virtual Model::DescribeExperienceOutcome Aws::kendra::KendraClient::DescribeExperience ( const Model::DescribeExperienceRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DescribeExperienceAsync()

template<typename DescribeExperienceRequestT = Model::DescribeExperienceRequest>

void Aws::kendra::KendraClient::DescribeExperienceAsync ( const DescribeExperienceRequestT &  request,

const DescribeExperienceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeExperience that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 944 of file KendraClient.h.

DescribeExperienceCallable()

template<typename DescribeExperienceRequestT = Model::DescribeExperienceRequest>

Model::DescribeExperienceOutcomeCallable Aws::kendra::KendraClient::DescribeExperienceCallable ( const DescribeExperienceRequestT &  request) const

inline

A Callable wrapper for DescribeExperience that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 935 of file KendraClient.h.

DescribeFaq()

virtual Model::DescribeFaqOutcome Aws::kendra::KendraClient::DescribeFaq ( const Model::DescribeFaqRequest &  request) const

virtual

Gets information about a FAQ.

See Also:

AWS API Reference

DescribeFaqAsync()

template<typename DescribeFaqRequestT = Model::DescribeFaqRequest>

void Aws::kendra::KendraClient::DescribeFaqAsync ( const DescribeFaqRequestT &  request,

const DescribeFaqResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeFaq that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 969 of file KendraClient.h.

DescribeFaqCallable()

template<typename DescribeFaqRequestT = Model::DescribeFaqRequest>

Model::DescribeFaqOutcomeCallable Aws::kendra::KendraClient::DescribeFaqCallable ( const DescribeFaqRequestT &  request) const

inline

A Callable wrapper for DescribeFaq that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 960 of file KendraClient.h.

DescribeFeaturedResultsSet()

virtual Model::DescribeFeaturedResultsSetOutcome Aws::kendra::KendraClient::DescribeFeaturedResultsSet ( const Model::DescribeFeaturedResultsSetRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DescribeFeaturedResultsSetAsync()

template<typename DescribeFeaturedResultsSetRequestT = Model::DescribeFeaturedResultsSetRequest>

void Aws::kendra::KendraClient::DescribeFeaturedResultsSetAsync ( const DescribeFeaturedResultsSetRequestT &  request,

const DescribeFeaturedResultsSetResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeFeaturedResultsSet that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1000 of file KendraClient.h.

DescribeFeaturedResultsSetCallable()

template<typename DescribeFeaturedResultsSetRequestT = Model::DescribeFeaturedResultsSetRequest>

Model::DescribeFeaturedResultsSetOutcomeCallable Aws::kendra::KendraClient::DescribeFeaturedResultsSetCallable ( const DescribeFeaturedResultsSetRequestT &  request) const

inline

A Callable wrapper for DescribeFeaturedResultsSet that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 990 of file KendraClient.h.

DescribeIndex()

virtual Model::DescribeIndexOutcome Aws::kendra::KendraClient::DescribeIndex ( const Model::DescribeIndexRequest &  request) const

virtual

Gets information about an Amazon Kendra index.

See Also:

AWS API Reference

DescribeIndexAsync()

template<typename DescribeIndexRequestT = Model::DescribeIndexRequest>

void Aws::kendra::KendraClient::DescribeIndexAsync ( const DescribeIndexRequestT &  request,

const DescribeIndexResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeIndex that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1026 of file KendraClient.h.

DescribeIndexCallable()

template<typename DescribeIndexRequestT = Model::DescribeIndexRequest>

Model::DescribeIndexOutcomeCallable Aws::kendra::KendraClient::DescribeIndexCallable ( const DescribeIndexRequestT &  request) const

inline

A Callable wrapper for DescribeIndex that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1017 of file KendraClient.h.

DescribePrincipalMapping()

virtual Model::DescribePrincipalMappingOutcome Aws::kendra::KendraClient::DescribePrincipalMapping ( const Model::DescribePrincipalMappingRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DescribePrincipalMappingAsync()

template<typename DescribePrincipalMappingRequestT = Model::DescribePrincipalMappingRequest>

void Aws::kendra::KendraClient::DescribePrincipalMappingAsync ( const DescribePrincipalMappingRequestT &  request,

const DescribePrincipalMappingResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribePrincipalMapping that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1059 of file KendraClient.h.

DescribePrincipalMappingCallable()

template<typename DescribePrincipalMappingRequestT = Model::DescribePrincipalMappingRequest>

Model::DescribePrincipalMappingOutcomeCallable Aws::kendra::KendraClient::DescribePrincipalMappingCallable ( const DescribePrincipalMappingRequestT &  request) const

inline

A Callable wrapper for DescribePrincipalMapping that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1050 of file KendraClient.h.

DescribeQuerySuggestionsBlockList()

virtual Model::DescribeQuerySuggestionsBlockListOutcome Aws::kendra::KendraClient::DescribeQuerySuggestionsBlockList ( const Model::DescribeQuerySuggestionsBlockListRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DescribeQuerySuggestionsBlockListAsync()

template<typename DescribeQuerySuggestionsBlockListRequestT = Model::DescribeQuerySuggestionsBlockListRequest>

void Aws::kendra::KendraClient::DescribeQuerySuggestionsBlockListAsync ( const DescribeQuerySuggestionsBlockListRequestT &  request,

const DescribeQuerySuggestionsBlockListResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeQuerySuggestionsBlockList that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1092 of file KendraClient.h.

DescribeQuerySuggestionsBlockListCallable()

template<typename DescribeQuerySuggestionsBlockListRequestT = Model::DescribeQuerySuggestionsBlockListRequest>

Model::DescribeQuerySuggestionsBlockListOutcomeCallable Aws::kendra::KendraClient::DescribeQuerySuggestionsBlockListCallable ( const DescribeQuerySuggestionsBlockListRequestT &  request) const

inline

A Callable wrapper for DescribeQuerySuggestionsBlockList that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1082 of file KendraClient.h.

DescribeQuerySuggestionsConfig()

virtual Model::DescribeQuerySuggestionsConfigOutcome Aws::kendra::KendraClient::DescribeQuerySuggestionsConfig ( const Model::DescribeQuerySuggestionsConfigRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DescribeQuerySuggestionsConfigAsync()

template<typename DescribeQuerySuggestionsConfigRequestT = Model::DescribeQuerySuggestionsConfigRequest>

void Aws::kendra::KendraClient::DescribeQuerySuggestionsConfigAsync ( const DescribeQuerySuggestionsConfigRequestT &  request,

const DescribeQuerySuggestionsConfigResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeQuerySuggestionsConfig that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1124 of file KendraClient.h.

DescribeQuerySuggestionsConfigCallable()

template<typename DescribeQuerySuggestionsConfigRequestT = Model::DescribeQuerySuggestionsConfigRequest>

Model::DescribeQuerySuggestionsConfigOutcomeCallable Aws::kendra::KendraClient::DescribeQuerySuggestionsConfigCallable ( const DescribeQuerySuggestionsConfigRequestT &  request) const

inline

A Callable wrapper for DescribeQuerySuggestionsConfig that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1114 of file KendraClient.h.

DescribeThesaurus()

virtual Model::DescribeThesaurusOutcome Aws::kendra::KendraClient::DescribeThesaurus ( const Model::DescribeThesaurusRequest &  request) const

virtual

Gets information about an Amazon Kendra thesaurus.

See Also:

AWS API Reference

DescribeThesaurusAsync()

template<typename DescribeThesaurusRequestT = Model::DescribeThesaurusRequest>

void Aws::kendra::KendraClient::DescribeThesaurusAsync ( const DescribeThesaurusRequestT &  request,

const DescribeThesaurusResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DescribeThesaurus that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1152 of file KendraClient.h.

DescribeThesaurusCallable()

template<typename DescribeThesaurusRequestT = Model::DescribeThesaurusRequest>

Model::DescribeThesaurusOutcomeCallable Aws::kendra::KendraClient::DescribeThesaurusCallable ( const DescribeThesaurusRequestT &  request) const

inline

A Callable wrapper for DescribeThesaurus that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1143 of file KendraClient.h.

DisassociateEntitiesFromExperience()

virtual Model::DisassociateEntitiesFromExperienceOutcome Aws::kendra::KendraClient::DisassociateEntitiesFromExperience ( const Model::DisassociateEntitiesFromExperienceRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DisassociateEntitiesFromExperienceAsync()

template<typename DisassociateEntitiesFromExperienceRequestT = Model::DisassociateEntitiesFromExperienceRequest>

void Aws::kendra::KendraClient::DisassociateEntitiesFromExperienceAsync ( const DisassociateEntitiesFromExperienceRequestT &  request,

const DisassociateEntitiesFromExperienceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DisassociateEntitiesFromExperience that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1185 of file KendraClient.h.

DisassociateEntitiesFromExperienceCallable()

template<typename DisassociateEntitiesFromExperienceRequestT = Model::DisassociateEntitiesFromExperienceRequest>

Model::DisassociateEntitiesFromExperienceOutcomeCallable Aws::kendra::KendraClient::DisassociateEntitiesFromExperienceCallable ( const DisassociateEntitiesFromExperienceRequestT &  request) const

inline

A Callable wrapper for DisassociateEntitiesFromExperience that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1175 of file KendraClient.h.

DisassociatePersonasFromEntities()

virtual Model::DisassociatePersonasFromEntitiesOutcome Aws::kendra::KendraClient::DisassociatePersonasFromEntities ( const Model::DisassociatePersonasFromEntitiesRequest &  request) const

virtual

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.

See Also:

AWS API Reference

DisassociatePersonasFromEntitiesAsync()

template<typename DisassociatePersonasFromEntitiesRequestT = Model::DisassociatePersonasFromEntitiesRequest>

void Aws::kendra::KendraClient::DisassociatePersonasFromEntitiesAsync ( const DisassociatePersonasFromEntitiesRequestT &  request,

const DisassociatePersonasFromEntitiesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DisassociatePersonasFromEntities that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1219 of file KendraClient.h.

DisassociatePersonasFromEntitiesCallable()

template<typename DisassociatePersonasFromEntitiesRequestT = Model::DisassociatePersonasFromEntitiesRequest>

Model::DisassociatePersonasFromEntitiesOutcomeCallable Aws::kendra::KendraClient::DisassociatePersonasFromEntitiesCallable ( const DisassociatePersonasFromEntitiesRequestT &  request) const

inline

A Callable wrapper for DisassociatePersonasFromEntities that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1209 of file KendraClient.h.

GetAllocationTag()

static const char * Aws::kendra::KendraClient::GetAllocationTag ( )

static

GetQuerySuggestions()

virtual Model::GetQuerySuggestionsOutcome Aws::kendra::KendraClient::GetQuerySuggestions ( const Model::GetQuerySuggestionsRequest &  request) const

virtual

Fetches the queries that are suggested to your users.

GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

See Also:

AWS API Reference

GetQuerySuggestionsAsync()

template<typename GetQuerySuggestionsRequestT = Model::GetQuerySuggestionsRequest>

void Aws::kendra::KendraClient::GetQuerySuggestionsAsync ( const GetQuerySuggestionsRequestT &  request,

const GetQuerySuggestionsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetQuerySuggestions that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1248 of file KendraClient.h.

GetQuerySuggestionsCallable()

template<typename GetQuerySuggestionsRequestT = Model::GetQuerySuggestionsRequest>

Model::GetQuerySuggestionsOutcomeCallable Aws::kendra::KendraClient::GetQuerySuggestionsCallable ( const GetQuerySuggestionsRequestT &  request) const

inline

A Callable wrapper for GetQuerySuggestions that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1239 of file KendraClient.h.

GetServiceName()

static const char * Aws::kendra::KendraClient::GetServiceName ( )

static

GetSnapshots()

virtual Model::GetSnapshotsOutcome Aws::kendra::KendraClient::GetSnapshots ( const Model::GetSnapshotsRequest &  request) const

virtual

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

See Also:

AWS API Reference

GetSnapshotsAsync()

template<typename GetSnapshotsRequestT = Model::GetSnapshotsRequest>

void Aws::kendra::KendraClient::GetSnapshotsAsync ( const GetSnapshotsRequestT &  request,

const GetSnapshotsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetSnapshots that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1275 of file KendraClient.h.

GetSnapshotsCallable()

template<typename GetSnapshotsRequestT = Model::GetSnapshotsRequest>

Model::GetSnapshotsOutcomeCallable Aws::kendra::KendraClient::GetSnapshotsCallable ( const GetSnapshotsRequestT &  request) const

inline

A Callable wrapper for GetSnapshots that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1266 of file KendraClient.h.

ListAccessControlConfigurations()

virtual Model::ListAccessControlConfigurationsOutcome Aws::kendra::KendraClient::ListAccessControlConfigurations ( const Model::ListAccessControlConfigurationsRequest &  request) const

virtual

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.

See Also:

AWS API Reference

ListAccessControlConfigurationsAsync()

template<typename ListAccessControlConfigurationsRequestT = Model::ListAccessControlConfigurationsRequest>

void Aws::kendra::KendraClient::ListAccessControlConfigurationsAsync ( const ListAccessControlConfigurationsRequestT &  request,

const ListAccessControlConfigurationsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListAccessControlConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1306 of file KendraClient.h.

ListAccessControlConfigurationsCallable()

template<typename ListAccessControlConfigurationsRequestT = Model::ListAccessControlConfigurationsRequest>

Model::ListAccessControlConfigurationsOutcomeCallable Aws::kendra::KendraClient::ListAccessControlConfigurationsCallable ( const ListAccessControlConfigurationsRequestT &  request) const

inline

A Callable wrapper for ListAccessControlConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1296 of file KendraClient.h.

ListDataSources()

virtual Model::ListDataSourcesOutcome Aws::kendra::KendraClient::ListDataSources ( const Model::ListDataSourcesRequest &  request) const

virtual

Lists the data source connectors that you have created.

See Also:

AWS API Reference

ListDataSourcesAsync()

template<typename ListDataSourcesRequestT = Model::ListDataSourcesRequest>

void Aws::kendra::KendraClient::ListDataSourcesAsync ( const ListDataSourcesRequestT &  request,

const ListDataSourcesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListDataSources that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1361 of file KendraClient.h.

ListDataSourcesCallable()

template<typename ListDataSourcesRequestT = Model::ListDataSourcesRequest>

Model::ListDataSourcesOutcomeCallable Aws::kendra::KendraClient::ListDataSourcesCallable ( const ListDataSourcesRequestT &  request) const

inline

A Callable wrapper for ListDataSources that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1352 of file KendraClient.h.

ListDataSourceSyncJobs()

virtual Model::ListDataSourceSyncJobsOutcome Aws::kendra::KendraClient::ListDataSourceSyncJobs ( const Model::ListDataSourceSyncJobsRequest &  request) const

virtual

Gets statistics about synchronizing a data source connector.

See Also:

AWS API Reference

ListDataSourceSyncJobsAsync()

template<typename ListDataSourceSyncJobsRequestT = Model::ListDataSourceSyncJobsRequest>

void Aws::kendra::KendraClient::ListDataSourceSyncJobsAsync ( const ListDataSourceSyncJobsRequestT &  request,

const ListDataSourceSyncJobsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListDataSourceSyncJobs that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1334 of file KendraClient.h.

ListDataSourceSyncJobsCallable()

template<typename ListDataSourceSyncJobsRequestT = Model::ListDataSourceSyncJobsRequest>

Model::ListDataSourceSyncJobsOutcomeCallable Aws::kendra::KendraClient::ListDataSourceSyncJobsCallable ( const ListDataSourceSyncJobsRequestT &  request) const

inline

A Callable wrapper for ListDataSourceSyncJobs that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1325 of file KendraClient.h.

ListEntityPersonas()

virtual Model::ListEntityPersonasOutcome Aws::kendra::KendraClient::ListEntityPersonas ( const Model::ListEntityPersonasRequest &  request) const

virtual

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

See Also:

AWS API Reference

ListEntityPersonasAsync()

template<typename ListEntityPersonasRequestT = Model::ListEntityPersonasRequest>

void Aws::kendra::KendraClient::ListEntityPersonasAsync ( const ListEntityPersonasRequestT &  request,

const ListEntityPersonasResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListEntityPersonas that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1388 of file KendraClient.h.

ListEntityPersonasCallable()

template<typename ListEntityPersonasRequestT = Model::ListEntityPersonasRequest>

Model::ListEntityPersonasOutcomeCallable Aws::kendra::KendraClient::ListEntityPersonasCallable ( const ListEntityPersonasRequestT &  request) const

inline

A Callable wrapper for ListEntityPersonas that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1379 of file KendraClient.h.

ListExperienceEntities()

virtual Model::ListExperienceEntitiesOutcome Aws::kendra::KendraClient::ListExperienceEntities ( const Model::ListExperienceEntitiesRequest &  request) const

virtual

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.

See Also:

AWS API Reference

ListExperienceEntitiesAsync()

template<typename ListExperienceEntitiesRequestT = Model::ListExperienceEntitiesRequest>

void Aws::kendra::KendraClient::ListExperienceEntitiesAsync ( const ListExperienceEntitiesRequestT &  request,

const ListExperienceEntitiesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListExperienceEntities that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1419 of file KendraClient.h.

ListExperienceEntitiesCallable()

template<typename ListExperienceEntitiesRequestT = Model::ListExperienceEntitiesRequest>

Model::ListExperienceEntitiesOutcomeCallable Aws::kendra::KendraClient::ListExperienceEntitiesCallable ( const ListExperienceEntitiesRequestT &  request) const

inline

A Callable wrapper for ListExperienceEntities that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1410 of file KendraClient.h.

ListExperiences()

virtual Model::ListExperiencesOutcome Aws::kendra::KendraClient::ListExperiences ( const Model::ListExperiencesRequest &  request) const

virtual

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.

See Also:

AWS API Reference

ListExperiencesAsync()

template<typename ListExperiencesRequestT = Model::ListExperiencesRequest>

void Aws::kendra::KendraClient::ListExperiencesAsync ( const ListExperiencesRequestT &  request,

const ListExperiencesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListExperiences that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1449 of file KendraClient.h.

ListExperiencesCallable()

template<typename ListExperiencesRequestT = Model::ListExperiencesRequest>

Model::ListExperiencesOutcomeCallable Aws::kendra::KendraClient::ListExperiencesCallable ( const ListExperiencesRequestT &  request) const

inline

A Callable wrapper for ListExperiences that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1440 of file KendraClient.h.

ListFaqs()

virtual Model::ListFaqsOutcome Aws::kendra::KendraClient::ListFaqs ( const Model::ListFaqsRequest &  request) const

virtual

Gets a list of FAQs associated with an index.

See Also:

AWS API Reference

ListFaqsAsync()

template<typename ListFaqsRequestT = Model::ListFaqsRequest>

void Aws::kendra::KendraClient::ListFaqsAsync ( const ListFaqsRequestT &  request,

const ListFaqsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListFaqs that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1474 of file KendraClient.h.

ListFaqsCallable()

template<typename ListFaqsRequestT = Model::ListFaqsRequest>

Model::ListFaqsOutcomeCallable Aws::kendra::KendraClient::ListFaqsCallable ( const ListFaqsRequestT &  request) const

inline

A Callable wrapper for ListFaqs that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1465 of file KendraClient.h.

ListFeaturedResultsSets()

virtual Model::ListFeaturedResultsSetsOutcome Aws::kendra::KendraClient::ListFeaturedResultsSets ( const Model::ListFeaturedResultsSetsRequest &  request) const

virtual

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.

See Also:

AWS API Reference

ListFeaturedResultsSetsAsync()

template<typename ListFeaturedResultsSetsRequestT = Model::ListFeaturedResultsSetsRequest>

void Aws::kendra::KendraClient::ListFeaturedResultsSetsAsync ( const ListFeaturedResultsSetsRequestT &  request,

const ListFeaturedResultsSetsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListFeaturedResultsSets that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1503 of file KendraClient.h.

ListFeaturedResultsSetsCallable()

template<typename ListFeaturedResultsSetsRequestT = Model::ListFeaturedResultsSetsRequest>

Model::ListFeaturedResultsSetsOutcomeCallable Aws::kendra::KendraClient::ListFeaturedResultsSetsCallable ( const ListFeaturedResultsSetsRequestT &  request) const

inline

A Callable wrapper for ListFeaturedResultsSets that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1494 of file KendraClient.h.

ListGroupsOlderThanOrderingId()

virtual Model::ListGroupsOlderThanOrderingIdOutcome Aws::kendra::KendraClient::ListGroupsOlderThanOrderingId ( const Model::ListGroupsOlderThanOrderingIdRequest &  request) const

virtual

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.

See Also:

AWS API Reference

ListGroupsOlderThanOrderingIdAsync()

template<typename ListGroupsOlderThanOrderingIdRequestT = Model::ListGroupsOlderThanOrderingIdRequest>

void Aws::kendra::KendraClient::ListGroupsOlderThanOrderingIdAsync ( const ListGroupsOlderThanOrderingIdRequestT &  request,

const ListGroupsOlderThanOrderingIdResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListGroupsOlderThanOrderingId that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1535 of file KendraClient.h.

ListGroupsOlderThanOrderingIdCallable()

template<typename ListGroupsOlderThanOrderingIdRequestT = Model::ListGroupsOlderThanOrderingIdRequest>

Model::ListGroupsOlderThanOrderingIdOutcomeCallable Aws::kendra::KendraClient::ListGroupsOlderThanOrderingIdCallable ( const ListGroupsOlderThanOrderingIdRequestT &  request) const

inline

A Callable wrapper for ListGroupsOlderThanOrderingId that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1525 of file KendraClient.h.

ListIndices()

virtual Model::ListIndicesOutcome Aws::kendra::KendraClient::ListIndices ( const Model::ListIndicesRequest &  request = {}) const

virtual

Lists the Amazon Kendra indexes that you created.

See Also:

AWS API Reference

ListIndicesAsync()

template<typename ListIndicesRequestT = Model::ListIndicesRequest>

void Aws::kendra::KendraClient::ListIndicesAsync ( const ListIndicesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListIndicesRequestT &  request = {} 

) const

inline

An Async wrapper for ListIndices that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1562 of file KendraClient.h.

ListIndicesCallable()

template<typename ListIndicesRequestT = Model::ListIndicesRequest>

Model::ListIndicesOutcomeCallable Aws::kendra::KendraClient::ListIndicesCallable ( const ListIndicesRequestT &  request = {}) const

inline

A Callable wrapper for ListIndices that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1553 of file KendraClient.h.

ListQuerySuggestionsBlockLists()

virtual Model::ListQuerySuggestionsBlockListsOutcome Aws::kendra::KendraClient::ListQuerySuggestionsBlockLists ( const Model::ListQuerySuggestionsBlockListsRequest &  request) const

virtual

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.

See Also:

AWS API Reference

ListQuerySuggestionsBlockListsAsync()

template<typename ListQuerySuggestionsBlockListsRequestT = Model::ListQuerySuggestionsBlockListsRequest>

void Aws::kendra::KendraClient::ListQuerySuggestionsBlockListsAsync ( const ListQuerySuggestionsBlockListsRequestT &  request,

const ListQuerySuggestionsBlockListsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListQuerySuggestionsBlockLists that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1596 of file KendraClient.h.

ListQuerySuggestionsBlockListsCallable()

template<typename ListQuerySuggestionsBlockListsRequestT = Model::ListQuerySuggestionsBlockListsRequest>

Model::ListQuerySuggestionsBlockListsOutcomeCallable Aws::kendra::KendraClient::ListQuerySuggestionsBlockListsCallable ( const ListQuerySuggestionsBlockListsRequestT &  request) const

inline

A Callable wrapper for ListQuerySuggestionsBlockLists that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1586 of file KendraClient.h.

ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::kendra::KendraClient::ListTagsForResource ( const Model::ListTagsForResourceRequest &  request) const

virtual

Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.

See Also:

AWS API Reference

ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::kendra::KendraClient::ListTagsForResourceAsync ( const ListTagsForResourceRequestT &  request,

const ListTagsForResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1625 of file KendraClient.h.

ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::kendra::KendraClient::ListTagsForResourceCallable ( const ListTagsForResourceRequestT &  request) const

inline

A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1616 of file KendraClient.h.

ListThesauri()

virtual Model::ListThesauriOutcome Aws::kendra::KendraClient::ListThesauri ( const Model::ListThesauriRequest &  request) const

virtual

Lists the thesauri for an index.

See Also:

AWS API Reference

ListThesauriAsync()

template<typename ListThesauriRequestT = Model::ListThesauriRequest>

void Aws::kendra::KendraClient::ListThesauriAsync ( const ListThesauriRequestT &  request,

const ListThesauriResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListThesauri that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1650 of file KendraClient.h.

ListThesauriCallable()

template<typename ListThesauriRequestT = Model::ListThesauriRequest>

Model::ListThesauriOutcomeCallable Aws::kendra::KendraClient::ListThesauriCallable ( const ListThesauriRequestT &  request) const

inline

A Callable wrapper for ListThesauri that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1641 of file KendraClient.h.

OverrideEndpoint()

void Aws::kendra::KendraClient::OverrideEndpoint ( const Aws::String &  endpoint)

PutPrincipalMapping()

virtual Model::PutPrincipalMappingOutcome Aws::kendra::KendraClient::PutPrincipalMapping ( const Model::PutPrincipalMappingRequest &  request) const

virtual

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.

See Also:

AWS API Reference

PutPrincipalMappingAsync()

template<typename PutPrincipalMappingRequestT = Model::PutPrincipalMappingRequest>

void Aws::kendra::KendraClient::PutPrincipalMappingAsync ( const PutPrincipalMappingRequestT &  request,

const PutPrincipalMappingResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for PutPrincipalMapping that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1688 of file KendraClient.h.

PutPrincipalMappingCallable()

template<typename PutPrincipalMappingRequestT = Model::PutPrincipalMappingRequest>

Model::PutPrincipalMappingOutcomeCallable Aws::kendra::KendraClient::PutPrincipalMappingCallable ( const PutPrincipalMappingRequestT &  request) const

inline

A Callable wrapper for PutPrincipalMapping that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1679 of file KendraClient.h.

Query()

virtual Model::QueryOutcome Aws::kendra::KendraClient::Query ( const Model::QueryRequest &  request) const

virtual

Searches an index given an input query.

If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length.

You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.

A query response contains three types of results.

• Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.

• Matching FAQs or questions-answer from your FAQ file.

• Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.

You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

See Also:

AWS API Reference

QueryAsync()

template<typename QueryRequestT = Model::QueryRequest>

void Aws::kendra::KendraClient::QueryAsync ( const QueryRequestT &  request,

const QueryResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for Query that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1739 of file KendraClient.h.

QueryCallable()

template<typename QueryRequestT = Model::QueryRequest>

Model::QueryOutcomeCallable Aws::kendra::KendraClient::QueryCallable ( const QueryRequestT &  request) const

inline

A Callable wrapper for Query that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1731 of file KendraClient.h.

Retrieve()

virtual Model::RetrieveOutcome Aws::kendra::KendraClient::Retrieve ( const Model::RetrieveRequest &  request) const

virtual

Retrieves relevant passages or text excerpts given an input query.

This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses.

You can also do the following:

• Override boosting at the index level

• Filter based on document fields or attributes

• Filter based on the user or their group access to documents

• View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

  Confidence score buckets are currently available only for English.

You can also include certain fields in the response that might provide useful additional information.

The Retrieve API shares the number of query capacity units that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

See Also:

AWS API Reference

RetrieveAsync()

template<typename RetrieveRequestT = Model::RetrieveRequest>

void Aws::kendra::KendraClient::RetrieveAsync ( const RetrieveRequestT &  request,

const RetrieveResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for Retrieve that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1795 of file KendraClient.h.

RetrieveCallable()

template<typename RetrieveRequestT = Model::RetrieveRequest>

Model::RetrieveOutcomeCallable Aws::kendra::KendraClient::RetrieveCallable ( const RetrieveRequestT &  request) const

inline

A Callable wrapper for Retrieve that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1786 of file KendraClient.h.

StartDataSourceSyncJob()

virtual Model::StartDataSourceSyncJobOutcome Aws::kendra::KendraClient::StartDataSourceSyncJob ( const Model::StartDataSourceSyncJobRequest &  request) const

virtual

Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.

See Also:

AWS API Reference

StartDataSourceSyncJobAsync()

template<typename StartDataSourceSyncJobRequestT = Model::StartDataSourceSyncJobRequest>

void Aws::kendra::KendraClient::StartDataSourceSyncJobAsync ( const StartDataSourceSyncJobRequestT &  request,

const StartDataSourceSyncJobResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StartDataSourceSyncJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1826 of file KendraClient.h.

StartDataSourceSyncJobCallable()

template<typename StartDataSourceSyncJobRequestT = Model::StartDataSourceSyncJobRequest>

Model::StartDataSourceSyncJobOutcomeCallable Aws::kendra::KendraClient::StartDataSourceSyncJobCallable ( const StartDataSourceSyncJobRequestT &  request) const

inline

A Callable wrapper for StartDataSourceSyncJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1817 of file KendraClient.h.

StopDataSourceSyncJob()

virtual Model::StopDataSourceSyncJobOutcome Aws::kendra::KendraClient::StopDataSourceSyncJob ( const Model::StopDataSourceSyncJobRequest &  request) const

virtual

Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.

See Also:

AWS API Reference

StopDataSourceSyncJobAsync()

template<typename StopDataSourceSyncJobRequestT = Model::StopDataSourceSyncJobRequest>

void Aws::kendra::KendraClient::StopDataSourceSyncJobAsync ( const StopDataSourceSyncJobRequestT &  request,

const StopDataSourceSyncJobResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for StopDataSourceSyncJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1854 of file KendraClient.h.

StopDataSourceSyncJobCallable()

template<typename StopDataSourceSyncJobRequestT = Model::StopDataSourceSyncJobRequest>

Model::StopDataSourceSyncJobOutcomeCallable Aws::kendra::KendraClient::StopDataSourceSyncJobCallable ( const StopDataSourceSyncJobRequestT &  request) const

inline

A Callable wrapper for StopDataSourceSyncJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1845 of file KendraClient.h.

SubmitFeedback()

virtual Model::SubmitFeedbackOutcome Aws::kendra::KendraClient::SubmitFeedback ( const Model::SubmitFeedbackRequest &  request) const

virtual

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.

See Also:

AWS API Reference

SubmitFeedbackAsync()

template<typename SubmitFeedbackRequestT = Model::SubmitFeedbackRequest>

void Aws::kendra::KendraClient::SubmitFeedbackAsync ( const SubmitFeedbackRequestT &  request,

const SubmitFeedbackResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for SubmitFeedback that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1881 of file KendraClient.h.

SubmitFeedbackCallable()

template<typename SubmitFeedbackRequestT = Model::SubmitFeedbackRequest>

Model::SubmitFeedbackOutcomeCallable Aws::kendra::KendraClient::SubmitFeedbackCallable ( const SubmitFeedbackRequestT &  request) const

inline

A Callable wrapper for SubmitFeedback that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1872 of file KendraClient.h.

TagResource()

virtual Model::TagResourceOutcome Aws::kendra::KendraClient::TagResource ( const Model::TagResourceRequest &  request) const

virtual

Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.

See Also:

AWS API Reference

TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::kendra::KendraClient::TagResourceAsync ( const TagResourceRequestT &  request,

const TagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1908 of file KendraClient.h.

TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::kendra::KendraClient::TagResourceCallable ( const TagResourceRequestT &  request) const

inline

A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1899 of file KendraClient.h.

UntagResource()

virtual Model::UntagResourceOutcome Aws::kendra::KendraClient::UntagResource ( const Model::UntagResourceRequest &  request) const

virtual

Removes a tag from an index, FAQ, data source, or other resource.

See Also:

AWS API Reference

UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::kendra::KendraClient::UntagResourceAsync ( const UntagResourceRequestT &  request,

const UntagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1934 of file KendraClient.h.

UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::kendra::KendraClient::UntagResourceCallable ( const UntagResourceRequestT &  request) const

inline

A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1925 of file KendraClient.h.

UpdateAccessControlConfiguration()

virtual Model::UpdateAccessControlConfigurationOutcome Aws::kendra::KendraClient::UpdateAccessControlConfiguration ( const Model::UpdateAccessControlConfigurationRequest &  request) const

virtual

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.

You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.

See Also:

AWS API Reference

UpdateAccessControlConfigurationAsync()

template<typename UpdateAccessControlConfigurationRequestT = Model::UpdateAccessControlConfigurationRequest>

void Aws::kendra::KendraClient::UpdateAccessControlConfigurationAsync ( const UpdateAccessControlConfigurationRequestT &  request,

const UpdateAccessControlConfigurationResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateAccessControlConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 1988 of file KendraClient.h.

UpdateAccessControlConfigurationCallable()

template<typename UpdateAccessControlConfigurationRequestT = Model::UpdateAccessControlConfigurationRequest>

Model::UpdateAccessControlConfigurationOutcomeCallable Aws::kendra::KendraClient::UpdateAccessControlConfigurationCallable ( const UpdateAccessControlConfigurationRequestT &  request) const

inline

A Callable wrapper for UpdateAccessControlConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 1978 of file KendraClient.h.

UpdateDataSource()

virtual Model::UpdateDataSourceOutcome Aws::kendra::KendraClient::UpdateDataSource ( const Model::UpdateDataSourceRequest &  request) const

virtual

Updates an Amazon Kendra data source connector.

See Also:

AWS API Reference

UpdateDataSourceAsync()

template<typename UpdateDataSourceRequestT = Model::UpdateDataSourceRequest>

void Aws::kendra::KendraClient::UpdateDataSourceAsync ( const UpdateDataSourceRequestT &  request,

const UpdateDataSourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateDataSource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 2015 of file KendraClient.h.

UpdateDataSourceCallable()

template<typename UpdateDataSourceRequestT = Model::UpdateDataSourceRequest>

Model::UpdateDataSourceOutcomeCallable Aws::kendra::KendraClient::UpdateDataSourceCallable ( const UpdateDataSourceRequestT &  request) const

inline

A Callable wrapper for UpdateDataSource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 2006 of file KendraClient.h.

UpdateExperience()

virtual Model::UpdateExperienceOutcome Aws::kendra::KendraClient::UpdateExperience ( const Model::UpdateExperienceRequest &  request) const

virtual

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.

See Also:

AWS API Reference

UpdateExperienceAsync()

template<typename UpdateExperienceRequestT = Model::UpdateExperienceRequest>

void Aws::kendra::KendraClient::UpdateExperienceAsync ( const UpdateExperienceRequestT &  request,

const UpdateExperienceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateExperience that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 2044 of file KendraClient.h.

UpdateExperienceCallable()

template<typename UpdateExperienceRequestT = Model::UpdateExperienceRequest>

Model::UpdateExperienceOutcomeCallable Aws::kendra::KendraClient::UpdateExperienceCallable ( const UpdateExperienceRequestT &  request) const

inline

A Callable wrapper for UpdateExperience that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 2035 of file KendraClient.h.

UpdateFeaturedResultsSet()

virtual Model::UpdateFeaturedResultsSetOutcome Aws::kendra::KendraClient::UpdateFeaturedResultsSet ( const Model::UpdateFeaturedResultsSetRequest &  request) const

virtual

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.

See Also:

AWS API Reference

UpdateFeaturedResultsSetAsync()

template<typename UpdateFeaturedResultsSetRequestT = Model::UpdateFeaturedResultsSetRequest>

void Aws::kendra::KendraClient::UpdateFeaturedResultsSetAsync ( const UpdateFeaturedResultsSetRequestT &  request,

const UpdateFeaturedResultsSetResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateFeaturedResultsSet that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 2074 of file KendraClient.h.

UpdateFeaturedResultsSetCallable()

template<typename UpdateFeaturedResultsSetRequestT = Model::UpdateFeaturedResultsSetRequest>

Model::UpdateFeaturedResultsSetOutcomeCallable Aws::kendra::KendraClient::UpdateFeaturedResultsSetCallable ( const UpdateFeaturedResultsSetRequestT &  request) const

inline

A Callable wrapper for UpdateFeaturedResultsSet that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 2065 of file KendraClient.h.

UpdateIndex()

virtual Model::UpdateIndexOutcome Aws::kendra::KendraClient::UpdateIndex ( const Model::UpdateIndexRequest &  request) const

virtual

Updates an Amazon Kendra index.

See Also:

AWS API Reference

UpdateIndexAsync()

template<typename UpdateIndexRequestT = Model::UpdateIndexRequest>

void Aws::kendra::KendraClient::UpdateIndexAsync ( const UpdateIndexRequestT &  request,

const UpdateIndexResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateIndex that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 2100 of file KendraClient.h.

UpdateIndexCallable()

template<typename UpdateIndexRequestT = Model::UpdateIndexRequest>

Model::UpdateIndexOutcomeCallable Aws::kendra::KendraClient::UpdateIndexCallable ( const UpdateIndexRequestT &  request) const

inline

A Callable wrapper for UpdateIndex that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 2091 of file KendraClient.h.

UpdateQuerySuggestionsBlockList()

virtual Model::UpdateQuerySuggestionsBlockListOutcome Aws::kendra::KendraClient::UpdateQuerySuggestionsBlockList ( const Model::UpdateQuerySuggestionsBlockListRequest &  request) const

virtual

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.

See Also:

AWS API Reference

UpdateQuerySuggestionsBlockListAsync()

template<typename UpdateQuerySuggestionsBlockListRequestT = Model::UpdateQuerySuggestionsBlockListRequest>

void Aws::kendra::KendraClient::UpdateQuerySuggestionsBlockListAsync ( const UpdateQuerySuggestionsBlockListRequestT &  request,

const UpdateQuerySuggestionsBlockListResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateQuerySuggestionsBlockList that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 2136 of file KendraClient.h.

UpdateQuerySuggestionsBlockListCallable()

template<typename UpdateQuerySuggestionsBlockListRequestT = Model::UpdateQuerySuggestionsBlockListRequest>

Model::UpdateQuerySuggestionsBlockListOutcomeCallable Aws::kendra::KendraClient::UpdateQuerySuggestionsBlockListCallable ( const UpdateQuerySuggestionsBlockListRequestT &  request) const

inline

A Callable wrapper for UpdateQuerySuggestionsBlockList that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 2126 of file KendraClient.h.

UpdateQuerySuggestionsConfig()

virtual Model::UpdateQuerySuggestionsConfigOutcome Aws::kendra::KendraClient::UpdateQuerySuggestionsConfig ( const Model::UpdateQuerySuggestionsConfigRequest &  request) const

virtual

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.

See Also:

AWS API Reference

UpdateQuerySuggestionsConfigAsync()

template<typename UpdateQuerySuggestionsConfigRequestT = Model::UpdateQuerySuggestionsConfigRequest>

void Aws::kendra::KendraClient::UpdateQuerySuggestionsConfigAsync ( const UpdateQuerySuggestionsConfigRequestT &  request,

const UpdateQuerySuggestionsConfigResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateQuerySuggestionsConfig that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 2174 of file KendraClient.h.

UpdateQuerySuggestionsConfigCallable()

template<typename UpdateQuerySuggestionsConfigRequestT = Model::UpdateQuerySuggestionsConfigRequest>

Model::UpdateQuerySuggestionsConfigOutcomeCallable Aws::kendra::KendraClient::UpdateQuerySuggestionsConfigCallable ( const UpdateQuerySuggestionsConfigRequestT &  request) const

inline

A Callable wrapper for UpdateQuerySuggestionsConfig that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 2164 of file KendraClient.h.

UpdateThesaurus()

virtual Model::UpdateThesaurusOutcome Aws::kendra::KendraClient::UpdateThesaurus ( const Model::UpdateThesaurusRequest &  request) const

virtual

Updates a thesaurus for an index.

See Also:

AWS API Reference

UpdateThesaurusAsync()

template<typename UpdateThesaurusRequestT = Model::UpdateThesaurusRequest>

void Aws::kendra::KendraClient::UpdateThesaurusAsync ( const UpdateThesaurusRequestT &  request,

const UpdateThesaurusResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateThesaurus that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 2200 of file KendraClient.h.

UpdateThesaurusCallable()

template<typename UpdateThesaurusRequestT = Model::UpdateThesaurusRequest>

Model::UpdateThesaurusOutcomeCallable Aws::kendra::KendraClient::UpdateThesaurusCallable ( const UpdateThesaurusRequestT &  request) const

inline

A Callable wrapper for UpdateThesaurus that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 2191 of file KendraClient.h.

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< KendraClient >

friend class Aws::Client::ClientWithAsyncTemplateMethods< KendraClient >

friend

Definition at line 2206 of file KendraClient.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-kendra/include/aws/kendra/KendraClient.h