- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ElasticsearchServiceClient
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 .
Installation
npm install @aws-sdk/client-elasticsearch-serviceyarn add @aws-sdk/client-elasticsearch-servicepnpm add @aws-sdk/client-elasticsearch-serviceElasticsearchServiceClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| AcceptInboundCrossClusterSearchConnectionCommand | Allows the destination domain owner to accept an inbound cross-cluster search connection request. |
| AddTagsCommand | Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information. |
| AssociatePackageCommand | Associates a package with an Amazon ES domain. |
| AuthorizeVpcEndpointAccessCommand | Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. |
| CancelDomainConfigChangeCommand | Cancels a pending configuration change on an Amazon OpenSearch Service domain. |
| CancelElasticsearchServiceSoftwareUpdateCommand | Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the |
| CreateElasticsearchDomainCommand | Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide. |
| CreateOutboundCrossClusterSearchConnectionCommand | Creates a new cross-cluster search connection from a source domain to a destination domain. |
| CreatePackageCommand | Create a package for use with Amazon ES domains. |
| CreateVpcEndpointCommand | Creates an Amazon OpenSearch Service-managed VPC endpoint. |
| DeleteElasticsearchDomainCommand | Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. |
| DeleteElasticsearchServiceRoleCommand | Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains. |
| DeleteInboundCrossClusterSearchConnectionCommand | Allows the destination domain owner to delete an existing inbound cross-cluster search connection. |
| DeleteOutboundCrossClusterSearchConnectionCommand | Allows the source domain owner to delete an existing outbound cross-cluster search connection. |
| DeletePackageCommand | Delete the package. |
| DeleteVpcEndpointCommand | Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. |
| DescribeDomainAutoTunesCommand | Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date. |
| DescribeDomainChangeProgressCommand | Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages. |
| DescribeElasticsearchDomainCommand | Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN. |
| DescribeElasticsearchDomainConfigCommand | Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options. |
| DescribeElasticsearchDomainsCommand | Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN. |
| DescribeElasticsearchInstanceTypeLimitsCommand | Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the |
| DescribeInboundCrossClusterSearchConnectionsCommand | Lists all the inbound cross-cluster search connections for a destination domain. |
| DescribeOutboundCrossClusterSearchConnectionsCommand | Lists all the outbound cross-cluster search connections for a source domain. |
| DescribePackagesCommand | Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination. |
| DescribeReservedElasticsearchInstanceOfferingsCommand | Lists available reserved Elasticsearch instance offerings. |
| DescribeReservedElasticsearchInstancesCommand | Returns information about reserved Elasticsearch instances for this account. |
| DescribeVpcEndpointsCommand | Describes one or more Amazon OpenSearch Service-managed VPC endpoints. |
| DissociatePackageCommand | Dissociates a package from the Amazon ES domain. |
| GetCompatibleElasticsearchVersionsCommand | Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a |
| GetPackageVersionHistoryCommand | Returns a list of versions of the package, along with their creation time and commit message. |
| GetUpgradeHistoryCommand | Retrieves the complete history of the last 10 upgrades that were performed on the domain. |
| GetUpgradeStatusCommand | Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain. |
| ListDomainNamesCommand | Returns the name of all Elasticsearch domains owned by the current user's account. |
| ListDomainsForPackageCommand | Lists all Amazon ES domains associated with the package. |
| ListElasticsearchInstanceTypesCommand | List all Elasticsearch instance types that are supported for given ElasticsearchVersion |
| ListElasticsearchVersionsCommand | List all supported Elasticsearch versions |
| ListPackagesForDomainCommand | Lists all packages associated with the Amazon ES domain. |
| ListTagsCommand | Returns all tags for the given Elasticsearch domain. |
| ListVpcEndpointAccessCommand | Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint. |
| ListVpcEndpointsCommand | Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region. |
| ListVpcEndpointsForDomainCommand | Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain. |
| PurchaseReservedElasticsearchInstanceOfferingCommand | Allows you to purchase reserved Elasticsearch instances. |
| RejectInboundCrossClusterSearchConnectionCommand | Allows the destination domain owner to reject an inbound cross-cluster search connection request. |
| RemoveTagsCommand | Removes the specified set of tags from the specified Elasticsearch domain. |
| RevokeVpcEndpointAccessCommand | Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. |
| StartElasticsearchServiceSoftwareUpdateCommand | Schedules a service software update for an Amazon ES domain. |
| UpdateElasticsearchDomainConfigCommand | Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. |
| UpdatePackageCommand | Updates a package for use with Amazon ES domains. |
| UpdateVpcEndpointCommand | Modifies an Amazon OpenSearch Service-managed interface VPC endpoint. |
| UpgradeElasticsearchDomainCommand | Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version. |
ElasticsearchServiceClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ElasticsearchServiceClientConfig