@aws-sdk/client-kendra
Advanced tools
AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native
@aws-sdk/client-kendra is an AWS SDK for JavaScript package that allows developers to interact with Amazon Kendra, a highly accurate and easy-to-use enterprise search service powered by machine learning. This package provides methods to create, manage, and query indexes, data sources, and other resources within Amazon Kendra.
Create Index
This feature allows you to create a new index in Amazon Kendra. The code sample demonstrates how to use the CreateIndexCommand to create an index with a specified name, role ARN, and edition.
const { KendraClient, CreateIndexCommand } = require('@aws-sdk/client-kendra');
const client = new KendraClient({ region: 'us-west-2' });
const params = {
Name: 'MyIndex',
RoleArn: 'arn:aws:iam::123456789012:role/service-role/AmazonKendra-role',
Edition: 'DEVELOPER_EDITION'
};
const run = async () => {
try {
const data = await client.send(new CreateIndexCommand(params));
console.log('Index created:', data);
} catch (err) {
console.error('Error creating index:', err);
}
};
run();Query Index
This feature allows you to query an existing index in Amazon Kendra. The code sample demonstrates how to use the QueryCommand to search an index using a specified query text.
const { KendraClient, QueryCommand } = require('@aws-sdk/client-kendra');
const client = new KendraClient({ region: 'us-west-2' });
const params = {
IndexId: 'index-id',
QueryText: 'search query'
};
const run = async () => {
try {
const data = await client.send(new QueryCommand(params));
console.log('Query results:', data);
} catch (err) {
console.error('Error querying index:', err);
}
};
run();List Data Sources
This feature allows you to list all data sources associated with a specific index in Amazon Kendra. The code sample demonstrates how to use the ListDataSourcesCommand to retrieve and display the data sources.
const { KendraClient, ListDataSourcesCommand } = require('@aws-sdk/client-kendra');
const client = new KendraClient({ region: 'us-west-2' });
const params = {
IndexId: 'index-id'
};
const run = async () => {
try {
const data = await client.send(new ListDataSourcesCommand(params));
console.log('Data sources:', data);
} catch (err) {
console.error('Error listing data sources:', err);
}
};
run();The 'elasticsearch' npm package is a client for Elasticsearch, a distributed, RESTful search and analytics engine. It provides similar functionalities for creating and managing indexes, querying data, and handling data sources. However, Elasticsearch is a self-managed service, whereas Amazon Kendra is a fully managed service provided by AWS.
The 'algoliasearch' npm package is a client for Algolia, a hosted search engine capable of delivering real-time results from the first keystroke. It offers functionalities for managing indexes and querying data similar to Amazon Kendra. Algolia is known for its speed and ease of integration, but it is a third-party service compared to the AWS-native Kendra.
The 'typesense' npm package is a client for Typesense, an open-source, typo-tolerant search engine optimized for instant search experiences. It provides similar functionalities for managing and querying indexes. Typesense is self-hosted and offers a different set of features and performance characteristics compared to the fully managed Amazon Kendra.
AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native.
Amazon Kendra is a service for indexing large document sets.
To install this package, simply type add or install @aws-sdk/client-kendra using your favorite package manager:
npm install @aws-sdk/client-kendrayarn add @aws-sdk/client-kendrapnpm add @aws-sdk/client-kendraThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the KendraClient and
the commands you need, for example ListIndicesCommand:
// ES5 example
const { KendraClient, ListIndicesCommand } = require("@aws-sdk/client-kendra");
// ES6+ example
import { KendraClient, ListIndicesCommand } from "@aws-sdk/client-kendra";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new KendraClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListIndicesCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-kendra";
const client = new AWS.Kendra({ region: "REGION" });
// async/await.
try {
const data = await client.listIndices(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listIndices(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listIndices(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-kendra package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.749.0 (2025-02-14)
FAQs
AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-kendra receives a total of 128,270 weekly downloads. As such, @aws-sdk/client-kendra popularity was classified as popular.
We found that @aws-sdk/client-kendra demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.