@aws-sdk/client-elasticsearch-service
Advanced tools
AWS SDK for JavaScript Elasticsearch Service Client for Node.js, Browser and React Native
The @aws-sdk/client-elasticsearch-service package is part of the AWS SDK for JavaScript. It allows developers to interact with the Amazon Elasticsearch Service, enabling them to create, configure, and manage Elasticsearch domains, as well as perform various operations related to Elasticsearch clusters.
Create Elasticsearch Domain
This feature allows you to create a new Elasticsearch domain with specified configurations such as domain name, Elasticsearch version, and cluster configuration.
const { ElasticsearchServiceClient, CreateElasticsearchDomainCommand } = require('@aws-sdk/client-elasticsearch-service');
const client = new ElasticsearchServiceClient({ region: 'us-west-2' });
const params = {
DomainName: 'my-domain',
ElasticsearchVersion: '7.10',
ElasticsearchClusterConfig: {
InstanceType: 'm5.large.elasticsearch',
InstanceCount: 2
}
};
const run = async () => {
try {
const data = await client.send(new CreateElasticsearchDomainCommand(params));
console.log('Domain created:', data);
} catch (err) {
console.error('Error creating domain:', err);
}
};
run();List Elasticsearch Domains
This feature allows you to list all the Elasticsearch domains in your account.
const { ElasticsearchServiceClient, ListDomainNamesCommand } = require('@aws-sdk/client-elasticsearch-service');
const client = new ElasticsearchServiceClient({ region: 'us-west-2' });
const run = async () => {
try {
const data = await client.send(new ListDomainNamesCommand({}));
console.log('Domains:', data.DomainNames);
} catch (err) {
console.error('Error listing domains:', err);
}
};
run();Delete Elasticsearch Domain
This feature allows you to delete an existing Elasticsearch domain by specifying its domain name.
const { ElasticsearchServiceClient, DeleteElasticsearchDomainCommand } = require('@aws-sdk/client-elasticsearch-service');
const client = new ElasticsearchServiceClient({ region: 'us-west-2' });
const params = {
DomainName: 'my-domain'
};
const run = async () => {
try {
const data = await client.send(new DeleteElasticsearchDomainCommand(params));
console.log('Domain deleted:', data);
} catch (err) {
console.error('Error deleting domain:', err);
}
};
run();The 'elasticsearch' package is an official Elasticsearch client for Node.js. It provides a more direct way to interact with Elasticsearch clusters, allowing for detailed control over queries and operations. Unlike @aws-sdk/client-elasticsearch-service, it does not provide AWS-specific management features like domain creation or configuration.
The '@elastic/elasticsearch' package is the official Elasticsearch client maintained by Elastic. It offers comprehensive support for Elasticsearch APIs and is designed to work with any Elasticsearch cluster, not just those managed by AWS. It focuses on providing a robust and flexible interface for interacting with Elasticsearch data and operations.
The 'aws-sdk' package is the older, monolithic AWS SDK for JavaScript. It includes support for a wide range of AWS services, including Elasticsearch Service. However, it is less modular and may include more dependencies than the newer, service-specific packages like @aws-sdk/client-elasticsearch-service.
AWS SDK for JavaScript ElasticsearchService Client for Node.js, Browser and React Native.
Amazon Elasticsearch Configuration Service
Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.
For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.
The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
To install this package, simply type add or install @aws-sdk/client-elasticsearch-service using your favorite package manager:
npm install @aws-sdk/client-elasticsearch-serviceyarn add @aws-sdk/client-elasticsearch-servicepnpm add @aws-sdk/client-elasticsearch-serviceThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ElasticsearchServiceClient and
the commands you need, for example ListDomainNamesCommand:
// ES5 example
const { ElasticsearchServiceClient, ListDomainNamesCommand } = require("@aws-sdk/client-elasticsearch-service");
// ES6+ example
import { ElasticsearchServiceClient, ListDomainNamesCommand } from "@aws-sdk/client-elasticsearch-service";
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 ElasticsearchServiceClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListDomainNamesCommand(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-elasticsearch-service";
const client = new AWS.ElasticsearchService({ region: "REGION" });
// async/await.
try {
const data = await client.listDomainNames(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listDomainNames(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listDomainNames(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-elasticsearch-service 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.806.0 (2025-05-08)
FAQs
AWS SDK for JavaScript Elasticsearch Service Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-elasticsearch-service receives a total of 129,132 weekly downloads. As such, @aws-sdk/client-elasticsearch-service popularity was classified as popular.
We found that @aws-sdk/client-elasticsearch-service demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 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.
Research
Security News
Malicious PyPI checkers validate stolen emails against TikTok and Instagram APIs, enabling targeted account attacks and dark web credential sales.
Security News
The Node.js TSC opted not to endorse a feature bounty program, citing concerns about incentives, governance, and project neutrality.
Research
Security News
A look at the top trends in how threat actors are weaponizing open source packages to deliver malware and persist across the software supply chain.