AWS SDK for JavaScript Opensearch Client for Node.js, Browser and React Native
npm install @aws-sdk/client-opensearchAWS SDK for JavaScript OpenSearch Client for Node.js, Browser and React Native.
Use the Amazon OpenSearch Service configuration API to create, configure, and manage
OpenSearch Service domains. 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
Amazon Web Services service endpoints.
npm install @aws-sdk/client-opensearchyarn add @aws-sdk/client-opensearchpnpm add @aws-sdk/client-opensearchThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the OpenSearchClient and
the commands you need, for example ListApplicationsCommand:
``js`
// ES5 example
const { OpenSearchClient, ListApplicationsCommand } = require("@aws-sdk/client-opensearch");
`ts`
// ES6+ example
import { OpenSearchClient, ListApplicationsCommand } from "@aws-sdk/client-opensearch";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new OpenSearchClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListApplicationsCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// 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.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
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
`ts
import * as AWS from "@aws-sdk/client-opensearch";
const client = new AWS.OpenSearch({ region: "REGION" });
// async/await.
try {
const data = await client.listApplications(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listApplications(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listApplications(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).
`js`
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.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
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-opensearch` 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.
AcceptInboundConnection
Command API Reference / Input / Output
AddDataSource
Command API Reference / Input / Output
AddDirectQueryDataSource
Command API Reference / Input / Output
AddTags
Command API Reference / Input / Output
AssociatePackage
Command API Reference / Input / Output
AssociatePackages
Command API Reference / Input / Output
AuthorizeVpcEndpointAccess
Command API Reference / Input / Output
CancelDomainConfigChange
Command API Reference / Input / Output
CancelServiceSoftwareUpdate
Command API Reference / Input / Output
CreateApplication
Command API Reference / Input / Output
CreateDomain
Command API Reference / Input / Output
CreateIndex
Command API Reference / Input / Output
CreateOutboundConnection
Command API Reference / Input / Output
CreatePackage
Command API Reference / Input / Output
CreateVpcEndpoint
Command API Reference / Input / Output
DeleteApplication
Command API Reference / Input / Output
DeleteDataSource
Command API Reference / Input / Output
DeleteDirectQueryDataSource
Command API Reference / Input / Output
DeleteDomain
Command API Reference / Input / Output
DeleteInboundConnection
Command API Reference / Input / Output
DeleteIndex
Command API Reference / Input / Output
DeleteOutboundConnection
Command API Reference / Input / Output
DeletePackage
Command API Reference / Input / Output
DeleteVpcEndpoint
Command API Reference / Input / Output
DescribeDomain
Command API Reference / Input / Output
DescribeDomainAutoTunes
Command API Reference / Input / Output
DescribeDomainChangeProgress
Command API Reference / Input / Output
DescribeDomainConfig
Command API Reference / Input / Output
DescribeDomainHealth
Command API Reference / Input / Output
DescribeDomainNodes
Command API Reference / Input / Output
DescribeDomains
Command API Reference / Input / Output
DescribeDryRunProgress
Command API Reference / Input / Output
DescribeInboundConnections
Command API Reference / Input / Output
DescribeInstanceTypeLimits
Command API Reference / Input / Output
DescribeOutboundConnections
Command API Reference / Input / Output
DescribePackages
Command API Reference / Input / Output
DescribeReservedInstanceOfferings
Command API Reference / Input / Output
DescribeReservedInstances
Command API Reference / Input / Output
DescribeVpcEndpoints
Command API Reference / Input / Output
DissociatePackage
Command API Reference / Input / Output
DissociatePackages
Command API Reference / Input / Output
GetApplication
Command API Reference / Input / Output
GetCompatibleVersions
Command API Reference / Input / Output
GetDataSource
Command API Reference / Input / Output
GetDefaultApplicationSetting
Command API Reference / Input / Output
GetDirectQueryDataSource
Command API Reference / Input / Output
GetDomainMaintenanceStatus
Command API Reference / Input / Output
GetIndex
Command API Reference / Input / Output
GetPackageVersionHistory
Command API Reference / Input / Output
GetUpgradeHistory
Command API Reference / Input / Output
GetUpgradeStatus
Command API Reference / Input / Output
ListApplications
Command API Reference / Input / Output
ListDataSources
Command API Reference / Input / Output
ListDirectQueryDataSources
Command API Reference / Input / Output
ListDomainMaintenances
Command API Reference / Input / Output
ListDomainNames
Command API Reference / Input / Output
ListDomainsForPackage
Command API Reference / Input / Output
ListInstanceTypeDetails
Command API Reference / Input / Output
ListPackagesForDomain
Command API Reference / Input / Output
ListScheduledActions
Command API Reference / Input / Output
ListTags
Command API Reference / Input / Output
ListVersions
Command API Reference / Input / Output
ListVpcEndpointAccess
Command API Reference / Input / Output
ListVpcEndpoints
Command API Reference / Input / Output
ListVpcEndpointsForDomain
Command API Reference / Input / Output
PurchaseReservedInstanceOffering
Command API Reference / Input / Output
PutDefaultApplicationSetting
Command API Reference / Input / Output
RejectInboundConnection
Command API Reference / Input / Output
RemoveTags
Command API Reference / Input / Output
RevokeVpcEndpointAccess
Command API Reference / Input / Output
StartDomainMaintenance
Command API Reference / Input / Output
StartServiceSoftwareUpdate
Command API Reference / Input / Output
UpdateApplication
Command API Reference / Input / Output
UpdateDataSource
Command API Reference / Input / Output
UpdateDirectQueryDataSource
Command API Reference / Input / Output
UpdateDomainConfig
Command API Reference / Input / Output
UpdateIndex
Command API Reference / Input / Output
UpdatePackage
Command API Reference / Input / Output
UpdatePackageScope
Command API Reference / Input / Output
UpdateScheduledAction
Command API Reference / Input / Output
UpdateVpcEndpoint
Command API Reference / Input / Output
UpgradeDomain