OpenSearchClient

Suggest an Edit

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 .

Installation

NPM
npm install @aws-sdk/client-opensearch
Yarn
yarn add @aws-sdk/client-opensearch
pnpm
pnpm add @aws-sdk/client-opensearch

OpenSearchClient Operations

Command
Summary
AcceptInboundConnectionCommand

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service .

AddDataSourceCommand

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3 .

AddDirectQueryDataSourceCommand

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.

AddTagsCommand

Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application.

Tags are a set of case-sensitive key-value pairs. A domain, data source, or application can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service resources .

AssociatePackageCommand

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service .

AssociatePackagesCommand

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

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.

CancelServiceSoftwareUpdateCommand

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service .

CreateApplicationCommand

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service .

CreateDomainCommand

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains .

CreateOutboundConnectionCommand

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service .

CreatePackageCommand

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service .

CreateVpcEndpointCommand

Creates an Amazon OpenSearch Service-managed VPC endpoint.

DeleteApplicationCommand

Deletes a specified OpenSearch application.

DeleteDataSourceCommand

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3 .

DeleteDirectQueryDataSourceCommand

Deletes a previously configured direct query data source from Amazon OpenSearch Service.

DeleteDomainCommand

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

DeleteInboundConnectionCommand

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service .

DeleteOutboundConnectionCommand

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service .

DeletePackageCommand

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service .

DeleteVpcEndpointCommand

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

DescribeDomainAutoTunesCommand

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service .

DescribeDomainChangeProgressCommand

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service .

DescribeDomainCommand

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

DescribeDomainConfigCommand

Returns the configuration of an Amazon OpenSearch Service domain.

DescribeDomainHealthCommand

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

DescribeDomainNodesCommand

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

DescribeDomainsCommand

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

DescribeDryRunProgressCommand

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment .

DescribeInboundConnectionsCommand

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service .

DescribeInstanceTypeLimitsCommand

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

DescribeOutboundConnectionsCommand

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service .

DescribePackagesCommand

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service .

DescribeReservedInstanceOfferingsCommand

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service .

DescribeReservedInstancesCommand

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service .

DescribeVpcEndpointsCommand

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

DissociatePackageCommand

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service .

DissociatePackagesCommand

Dissociates multiple packages from a domain simulatneously.

GetApplicationCommand

Retrieves the configuration and status of an existing OpenSearch application.

GetCompatibleVersionsCommand

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

GetDataSourceCommand

Retrieves information about a direct query data source.

GetDirectQueryDataSourceCommand

Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.

GetDomainMaintenanceStatusCommand

The status of the maintenance action.

GetPackageVersionHistoryCommand

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service .

GetUpgradeHistoryCommand

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

GetUpgradeStatusCommand

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

ListApplicationsCommand

Lists all OpenSearch applications under your account.

ListDataSourcesCommand

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3 .

ListDirectQueryDataSourcesCommand

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

ListDomainMaintenancesCommand

A list of maintenance actions for the domain.

ListDomainNamesCommand

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

ListDomainsForPackageCommand

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service .

ListInstanceTypeDetailsCommand

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

ListPackagesForDomainCommand

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service .

ListScheduledActionsCommand

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates  or blue/green Auto-Tune enhancements .

ListTagsCommand

Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources .

ListVersionsCommand

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

ListVpcEndpointAccessCommand

Retrieves information about each Amazon Web Services 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 Amazon Web Services account and Region.

ListVpcEndpointsForDomainCommand

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

PurchaseReservedInstanceOfferingCommand

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

RejectInboundConnectionCommand

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

RemoveTagsCommand

Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources .

RevokeVpcEndpointAccessCommand

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

StartDomainMaintenanceCommand

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

StartServiceSoftwareUpdateCommand

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service .

UpdateApplicationCommand

Updates the configuration and settings of an existing OpenSearch application.

UpdateDataSourceCommand

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3 .

UpdateDirectQueryDataSourceCommand

Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.

UpdateDomainConfigCommand

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

UpdatePackageCommand

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service .

UpdatePackageScopeCommand

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

UpdateScheduledActionCommand

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update  or a blue/green Auto-Tune enhancement .

UpdateVpcEndpointCommand

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

UpgradeDomainCommand

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

OpenSearchClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
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.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: OpenSearchClientConfig