Kendra

import { Kendra } from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";

class Kendra {

constructor(apiFactory: client.ApiFactory);

async associateEntitiesToExperience(params: AssociateEntitiesToExperienceRequest, opts?: client.RequestOptions): Promise<AssociateEntitiesToExperienceResponse>;

async associatePersonasToEntities(params: AssociatePersonasToEntitiesRequest, opts?: client.RequestOptions): Promise<AssociatePersonasToEntitiesResponse>;

async batchDeleteDocument(params: BatchDeleteDocumentRequest, opts?: client.RequestOptions): Promise<BatchDeleteDocumentResponse>;

async batchGetDocumentStatus(params: BatchGetDocumentStatusRequest, opts?: client.RequestOptions): Promise<BatchGetDocumentStatusResponse>;

async batchPutDocument(params: BatchPutDocumentRequest, opts?: client.RequestOptions): Promise<BatchPutDocumentResponse>;

async clearQuerySuggestions(params: ClearQuerySuggestionsRequest, opts?: client.RequestOptions): Promise<void>;

async createAccessControlConfiguration(params: CreateAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<CreateAccessControlConfigurationResponse>;

async createDataSource(params: CreateDataSourceRequest, opts?: client.RequestOptions): Promise<CreateDataSourceResponse>;

async createExperience(params: CreateExperienceRequest, opts?: client.RequestOptions): Promise<CreateExperienceResponse>;

async createFaq(params: CreateFaqRequest, opts?: client.RequestOptions): Promise<CreateFaqResponse>;

async createIndex(params: CreateIndexRequest, opts?: client.RequestOptions): Promise<CreateIndexResponse>;

async createQuerySuggestionsBlockList(params: CreateQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<CreateQuerySuggestionsBlockListResponse>;

async createThesaurus(params: CreateThesaurusRequest, opts?: client.RequestOptions): Promise<CreateThesaurusResponse>;

async deleteAccessControlConfiguration(params: DeleteAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteDataSource(params: DeleteDataSourceRequest, opts?: client.RequestOptions): Promise<void>;

async deleteExperience(params: DeleteExperienceRequest, opts?: client.RequestOptions): Promise<void>;

async deleteFaq(params: DeleteFaqRequest, opts?: client.RequestOptions): Promise<void>;

async deleteIndex(params: DeleteIndexRequest, opts?: client.RequestOptions): Promise<void>;

async deletePrincipalMapping(params: DeletePrincipalMappingRequest, opts?: client.RequestOptions): Promise<void>;

async deleteQuerySuggestionsBlockList(params: DeleteQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<void>;

async deleteThesaurus(params: DeleteThesaurusRequest, opts?: client.RequestOptions): Promise<void>;

async describeAccessControlConfiguration(params: DescribeAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeAccessControlConfigurationResponse>;

async describeDataSource(params: DescribeDataSourceRequest, opts?: client.RequestOptions): Promise<DescribeDataSourceResponse>;

async describeExperience(params: DescribeExperienceRequest, opts?: client.RequestOptions): Promise<DescribeExperienceResponse>;

async describeFaq(params: DescribeFaqRequest, opts?: client.RequestOptions): Promise<DescribeFaqResponse>;

async describeIndex(params: DescribeIndexRequest, opts?: client.RequestOptions): Promise<DescribeIndexResponse>;

async describePrincipalMapping(params: DescribePrincipalMappingRequest, opts?: client.RequestOptions): Promise<DescribePrincipalMappingResponse>;

async describeQuerySuggestionsBlockList(params: DescribeQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<DescribeQuerySuggestionsBlockListResponse>;

async describeQuerySuggestionsConfig(params: DescribeQuerySuggestionsConfigRequest, opts?: client.RequestOptions): Promise<DescribeQuerySuggestionsConfigResponse>;

async describeThesaurus(params: DescribeThesaurusRequest, opts?: client.RequestOptions): Promise<DescribeThesaurusResponse>;

async disassociateEntitiesFromExperience(params: DisassociateEntitiesFromExperienceRequest, opts?: client.RequestOptions): Promise<DisassociateEntitiesFromExperienceResponse>;

async disassociatePersonasFromEntities(params: DisassociatePersonasFromEntitiesRequest, opts?: client.RequestOptions): Promise<DisassociatePersonasFromEntitiesResponse>;

async getQuerySuggestions(params: GetQuerySuggestionsRequest, opts?: client.RequestOptions): Promise<GetQuerySuggestionsResponse>;

async getSnapshots(params: GetSnapshotsRequest, opts?: client.RequestOptions): Promise<GetSnapshotsResponse>;

async listAccessControlConfigurations(params: ListAccessControlConfigurationsRequest, opts?: client.RequestOptions): Promise<ListAccessControlConfigurationsResponse>;

async listDataSources(params: ListDataSourcesRequest, opts?: client.RequestOptions): Promise<ListDataSourcesResponse>;

async listDataSourceSyncJobs(params: ListDataSourceSyncJobsRequest, opts?: client.RequestOptions): Promise<ListDataSourceSyncJobsResponse>;

async listEntityPersonas(params: ListEntityPersonasRequest, opts?: client.RequestOptions): Promise<ListEntityPersonasResponse>;

async listExperienceEntities(params: ListExperienceEntitiesRequest, opts?: client.RequestOptions): Promise<ListExperienceEntitiesResponse>;

async listExperiences(params: ListExperiencesRequest, opts?: client.RequestOptions): Promise<ListExperiencesResponse>;

async listFaqs(params: ListFaqsRequest, opts?: client.RequestOptions): Promise<ListFaqsResponse>;

async listGroupsOlderThanOrderingId(params: ListGroupsOlderThanOrderingIdRequest, opts?: client.RequestOptions): Promise<ListGroupsOlderThanOrderingIdResponse>;

async listIndices(params?: ListIndicesRequest, opts?: client.RequestOptions): Promise<ListIndicesResponse>;

async listQuerySuggestionsBlockLists(params: ListQuerySuggestionsBlockListsRequest, opts?: client.RequestOptions): Promise<ListQuerySuggestionsBlockListsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listThesauri(params: ListThesauriRequest, opts?: client.RequestOptions): Promise<ListThesauriResponse>;

async putPrincipalMapping(params: PutPrincipalMappingRequest, opts?: client.RequestOptions): Promise<void>;

async query(params: QueryRequest, opts?: client.RequestOptions): Promise<QueryResult>;

async startDataSourceSyncJob(params: StartDataSourceSyncJobRequest, opts?: client.RequestOptions): Promise<StartDataSourceSyncJobResponse>;

async stopDataSourceSyncJob(params: StopDataSourceSyncJobRequest, opts?: client.RequestOptions): Promise<void>;

async submitFeedback(params: SubmitFeedbackRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAccessControlConfiguration(params: UpdateAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async updateDataSource(params: UpdateDataSourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateExperience(params: UpdateExperienceRequest, opts?: client.RequestOptions): Promise<void>;

async updateIndex(params: UpdateIndexRequest, opts?: client.RequestOptions): Promise<void>;

async updateQuerySuggestionsBlockList(params: UpdateQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<void>;

async updateQuerySuggestionsConfig(params: UpdateQuerySuggestionsConfigRequest, opts?: client.RequestOptions): Promise<void>;

async updateThesaurus(params: UpdateThesaurusRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Kendra(apiFactory: client.ApiFactory)

[src]

§Methods

associateEntitiesToExperience(params: AssociateEntitiesToExperienceRequest, opts?: client.RequestOptions): Promise<AssociateEntitiesToExperienceResponse>

[src]

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.

associatePersonasToEntities(params: AssociatePersonasToEntitiesRequest, opts?: client.RequestOptions): Promise<AssociatePersonasToEntitiesResponse>

[src]

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.

batchDeleteDocument(params: BatchDeleteDocumentRequest, opts?: client.RequestOptions): Promise<BatchDeleteDocumentResponse>

[src]

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

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

batchGetDocumentStatus(params: BatchGetDocumentStatusRequest, opts?: client.RequestOptions): Promise<BatchGetDocumentStatusResponse>

[src]

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.

batchPutDocument(params: BatchPutDocumentRequest, opts?: client.RequestOptions): Promise<BatchPutDocumentResponse>

[src]

Adds one or more documents to an index.

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

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

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

clearQuerySuggestions(params: ClearQuerySuggestionsRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

createAccessControlConfiguration(params: CreateAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<CreateAccessControlConfigurationResponse>

[src]

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.

createDataSource(params: CreateDataSourceRequest, opts?: client.RequestOptions): Promise<CreateDataSourceResponse>

[src]

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.

Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.

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.

createExperience(params: CreateExperienceRequest, opts?: client.RequestOptions): Promise<CreateExperienceResponse>

[src]

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.

createFaq(params: CreateFaqRequest, opts?: client.RequestOptions): Promise<CreateFaqResponse>

[src]

Creates an new set of frequently asked question (FAQ) questions and answers.

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.

createIndex(params: CreateIndexRequest, opts?: client.RequestOptions): Promise<CreateIndexResponse>

[src]

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.

createQuerySuggestionsBlockList(params: CreateQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<CreateQuerySuggestionsBlockListResponse>

[src]

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.

createThesaurus(params: CreateThesaurusRequest, opts?: client.RequestOptions): Promise<CreateThesaurusResponse>

[src]

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.

deleteAccessControlConfiguration(params: DeleteAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteDataSource(params: DeleteDataSourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteExperience(params: DeleteExperienceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteFaq(params: DeleteFaqRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes an FAQ from an index.

deleteIndex(params: DeleteIndexRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deletePrincipalMapping(params: DeletePrincipalMappingRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

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

deleteQuerySuggestionsBlockList(params: DeleteQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteThesaurus(params: DeleteThesaurusRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an existing Amazon Kendra thesaurus.

describeAccessControlConfiguration(params: DescribeAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeAccessControlConfigurationResponse>

[src]

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.

describeDataSource(params: DescribeDataSourceRequest, opts?: client.RequestOptions): Promise<DescribeDataSourceResponse>

[src]

Gets information about an Amazon Kendra data source connector.

describeExperience(params: DescribeExperienceRequest, opts?: client.RequestOptions): Promise<DescribeExperienceResponse>

[src]

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.

describeFaq(params: DescribeFaqRequest, opts?: client.RequestOptions): Promise<DescribeFaqResponse>

[src]

Gets information about an FAQ list.

describeIndex(params: DescribeIndexRequest, opts?: client.RequestOptions): Promise<DescribeIndexResponse>

[src]

Gets information about an existing Amazon Kendra index.

describePrincipalMapping(params: DescribePrincipalMappingRequest, opts?: client.RequestOptions): Promise<DescribePrincipalMappingResponse>

[src]

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.

describeQuerySuggestionsBlockList(params: DescribeQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<DescribeQuerySuggestionsBlockListResponse>

[src]

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.

describeQuerySuggestionsConfig(params: DescribeQuerySuggestionsConfigRequest, opts?: client.RequestOptions): Promise<DescribeQuerySuggestionsConfigResponse>

[src]

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.

describeThesaurus(params: DescribeThesaurusRequest, opts?: client.RequestOptions): Promise<DescribeThesaurusResponse>

[src]

Gets information about an existing Amazon Kendra thesaurus.

disassociateEntitiesFromExperience(params: DisassociateEntitiesFromExperienceRequest, opts?: client.RequestOptions): Promise<DisassociateEntitiesFromExperienceResponse>

[src]

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.

disassociatePersonasFromEntities(params: DisassociatePersonasFromEntitiesRequest, opts?: client.RequestOptions): Promise<DisassociatePersonasFromEntitiesResponse>

[src]

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.

getQuerySuggestions(params: GetQuerySuggestionsRequest, opts?: client.RequestOptions): Promise<GetQuerySuggestionsResponse>

[src]

Fetches the queries that are suggested to your users.

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

getSnapshots(params: GetSnapshotsRequest, opts?: client.RequestOptions): Promise<GetSnapshotsResponse>

[src]

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

listAccessControlConfigurations(params: ListAccessControlConfigurationsRequest, opts?: client.RequestOptions): Promise<ListAccessControlConfigurationsResponse>

[src]

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.

listDataSources(params: ListDataSourcesRequest, opts?: client.RequestOptions): Promise<ListDataSourcesResponse>

[src]

Lists the data source connectors that you have created.

listDataSourceSyncJobs(params: ListDataSourceSyncJobsRequest, opts?: client.RequestOptions): Promise<ListDataSourceSyncJobsResponse>

[src]

Gets statistics about synchronizing a data source connector.

listEntityPersonas(params: ListEntityPersonasRequest, opts?: client.RequestOptions): Promise<ListEntityPersonasResponse>

[src]

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

listExperienceEntities(params: ListExperienceEntitiesRequest, opts?: client.RequestOptions): Promise<ListExperienceEntitiesResponse>

[src]

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.

listExperiences(params: ListExperiencesRequest, opts?: client.RequestOptions): Promise<ListExperiencesResponse>

[src]

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.

listFaqs(params: ListFaqsRequest, opts?: client.RequestOptions): Promise<ListFaqsResponse>

[src]

Gets a list of FAQ lists associated with an index.

listGroupsOlderThanOrderingId(params: ListGroupsOlderThanOrderingIdRequest, opts?: client.RequestOptions): Promise<ListGroupsOlderThanOrderingIdResponse>

[src]

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.

listIndices(params?: ListIndicesRequest, opts?: client.RequestOptions): Promise<ListIndicesResponse>

[src]

Lists the Amazon Kendra indexes that you created.

listQuerySuggestionsBlockLists(params: ListQuerySuggestionsBlockListsRequest, opts?: client.RequestOptions): Promise<ListQuerySuggestionsBlockListsResponse>

[src]

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.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

listThesauri(params: ListThesauriRequest, opts?: client.RequestOptions): Promise<ListThesauriResponse>

[src]

Lists the thesauri for an index.

putPrincipalMapping(params: PutPrincipalMappingRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

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

query(params: QueryRequest, opts?: client.RequestOptions): Promise<QueryResult>

[src]

Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

Relevant passages
Matching FAQs
Relevant documents

You can specify that the query return only one type of result using the QueryResultTypeFilter parameter.

Each query returns the 100 most relevant results.

startDataSourceSyncJob(params: StartDataSourceSyncJobRequest, opts?: client.RequestOptions): Promise<StartDataSourceSyncJobResponse>

[src]

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

stopDataSourceSyncJob(params: StopDataSourceSyncJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

submitFeedback(params: SubmitFeedbackRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updateAccessControlConfiguration(params: UpdateAccessControlConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateDataSource(params: UpdateDataSourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates an existing Amazon Kendra data source connector.

updateExperience(params: UpdateExperienceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateIndex(params: UpdateIndexRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates an existing Amazon Kendra index.

updateQuerySuggestionsBlockList(params: UpdateQuerySuggestionsBlockListRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateQuerySuggestionsConfig(params: UpdateQuerySuggestionsConfigRequest, opts?: client.RequestOptions): Promise<void>

[src]

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 (i.e. 'happening'), 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.

updateThesaurus(params: UpdateThesaurusRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a thesaurus for an index.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]