AWS Amazon OpenSearch CLI Commands

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.

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.

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

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.

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

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

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

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.

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

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

Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual me

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.

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

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Deletes a specified OpenSearch application.

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

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

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

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.

Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.

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.

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

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

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.

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.

Returns the configuration of an Amazon OpenSearch Service domain.

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

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

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

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.

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.

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

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.

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

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

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

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

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 Se

Dissociates multiple packages from a domain simultaneously.

Retrieves the configuration and status of an existing OpenSearch application.

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

Retrieves information about a direct query data source.

Gets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error.

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

The status of the maintenance action.

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

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.

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

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

Lists all OpenSearch applications under your account.

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.

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

A list of maintenance actions for the domain.

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

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

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

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

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.

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

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

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.

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

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

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Sets the default application to the application with the specified ARN. To remove the default application, use the GetDefaultApplicationSetting operation to get the current default and then call the PutDefaultApplicationSetting with the current applications ARN and the setAsDefault parameter set to

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

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.

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

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.

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

Updates the configuration and settings of an existing OpenSearch application.

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

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

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

Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.

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

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

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.

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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