@aws-sdk/client-elasticsearch-service
TypeScript icon, indicating that this package has built-in type declarations

3.556.0 • Public • Published

@aws-sdk/client-elasticsearch-service

Description

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.

Installing

To install the this package, simply type add or install @aws-sdk/client-elasticsearch-service using your favorite package manager:

  • npm install @aws-sdk/client-elasticsearch-service
  • yarn add @aws-sdk/client-elasticsearch-service
  • pnpm add @aws-sdk/client-elasticsearch-service

Getting Started

Import

The 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";

Usage

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.
  • If you are using a custom http handler, you may call 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);

Async/await

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.

Promises

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.
  });

Callbacks

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.
});

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

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.
});

Troubleshooting

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;
   * }
   */
}

Getting Help

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.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

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.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

AcceptInboundCrossClusterSearchConnection

Command API Reference / Input / Output

AddTags

Command API Reference / Input / Output

AssociatePackage

Command API Reference / Input / Output

AuthorizeVpcEndpointAccess

Command API Reference / Input / Output

CancelDomainConfigChange

Command API Reference / Input / Output

CancelElasticsearchServiceSoftwareUpdate

Command API Reference / Input / Output

CreateElasticsearchDomain

Command API Reference / Input / Output

CreateOutboundCrossClusterSearchConnection

Command API Reference / Input / Output

CreatePackage

Command API Reference / Input / Output

CreateVpcEndpoint

Command API Reference / Input / Output

DeleteElasticsearchDomain

Command API Reference / Input / Output

DeleteElasticsearchServiceRole

Command API Reference / Input / Output

DeleteInboundCrossClusterSearchConnection

Command API Reference / Input / Output

DeleteOutboundCrossClusterSearchConnection

Command API Reference / Input / Output

DeletePackage

Command API Reference / Input / Output

DeleteVpcEndpoint

Command API Reference / Input / Output

DescribeDomainAutoTunes

Command API Reference / Input / Output

DescribeDomainChangeProgress

Command API Reference / Input / Output

DescribeElasticsearchDomain

Command API Reference / Input / Output

DescribeElasticsearchDomainConfig

Command API Reference / Input / Output

DescribeElasticsearchDomains

Command API Reference / Input / Output

DescribeElasticsearchInstanceTypeLimits

Command API Reference / Input / Output

DescribeInboundCrossClusterSearchConnections

Command API Reference / Input / Output

DescribeOutboundCrossClusterSearchConnections

Command API Reference / Input / Output

DescribePackages

Command API Reference / Input / Output

DescribeReservedElasticsearchInstanceOfferings

Command API Reference / Input / Output

DescribeReservedElasticsearchInstances

Command API Reference / Input / Output

DescribeVpcEndpoints

Command API Reference / Input / Output

DissociatePackage

Command API Reference / Input / Output

GetCompatibleElasticsearchVersions

Command API Reference / Input / Output

GetPackageVersionHistory

Command API Reference / Input / Output

GetUpgradeHistory

Command API Reference / Input / Output

GetUpgradeStatus

Command API Reference / Input / Output

ListDomainNames

Command API Reference / Input / Output

ListDomainsForPackage

Command API Reference / Input / Output

ListElasticsearchInstanceTypes

Command API Reference / Input / Output

ListElasticsearchVersions

Command API Reference / Input / Output

ListPackagesForDomain

Command API Reference / Input / Output

ListTags

Command API Reference / Input / Output

ListVpcEndpointAccess

Command API Reference / Input / Output

ListVpcEndpoints

Command API Reference / Input / Output

ListVpcEndpointsForDomain

Command API Reference / Input / Output

PurchaseReservedElasticsearchInstanceOffering

Command API Reference / Input / Output

RejectInboundCrossClusterSearchConnection

Command API Reference / Input / Output

RemoveTags

Command API Reference / Input / Output

RevokeVpcEndpointAccess

Command API Reference / Input / Output

StartElasticsearchServiceSoftwareUpdate

Command API Reference / Input / Output

UpdateElasticsearchDomainConfig

Command API Reference / Input / Output

UpdatePackage

Command API Reference / Input / Output

UpdateVpcEndpoint

Command API Reference / Input / Output

UpgradeElasticsearchDomain

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-elasticsearch-service

Weekly Downloads

119,897

Version

3.556.0

License

Apache-2.0

Unpacked Size

1.23 MB

Total Files

263

Last publish

Collaborators

  • mattsb42-aws
  • kuhe
  • amzn-oss
  • aws-sdk-bot
  • trivikr-aws