aws-opensearch

List all OpenSearch domains

$ aws opensearch list-domain-names

$ aws opensearch describe-domain --domain-name [domain_name]

$ aws opensearch describe-domain-config --domain-name [domain_name]

$ aws opensearch create-domain --domain-name [domain_name] --engine-version OpenSearch_2.11 --cluster-config InstanceType=t3.small.search,InstanceCount=1

$ aws opensearch update-domain-config --domain-name [domain_name] --cluster-config InstanceType=r6g.large.search

$ aws opensearch delete-domain --domain-name [domain_name]

$ aws opensearch list-versions

$ aws opensearch get-upgrade-history --domain-name [domain_name]

aws opensearch subcommand [options]

aws opensearch is a subcommand of the AWS CLI that manages Amazon OpenSearch Service, a managed search and analytics engine. It is the successor to Amazon Elasticsearch Service and is compatible with OpenSearch and legacy Elasticsearch APIs.
OpenSearch domains are clusters that run the OpenSearch engine. Each domain has a cluster configuration (instance types, counts), storage settings (EBS volumes), access policies, and optional features like fine-grained access control and encryption.
The service supports use cases including log analytics, full-text search, application monitoring, and SIEM. OpenSearch Dashboards provides visualization capabilities.

list-domain-names

List all domains in the account.

Get domain status and configuration.

Get detailed configuration settings.

Create a new OpenSearch domain.

Modify domain settings.

Remove a domain.

List available OpenSearch and Elasticsearch versions.

Initiate a version upgrade.

Check upgrade progress.

Name of the domain.

OpenSearch or Elasticsearch version.

Instance type, count, and zone awareness.

EBS volume configuration.

Resource-based access policy.

VPC configuration for private domains.

Enable encryption at rest.

Domain names must be lowercase and unique within a region. Configuration changes can take 15-30 minutes to apply. Domains in a VPC cannot be made public later. Version upgrades may require blue/green deployment. Fine-grained access control requires HTTPS and node-to-node encryption. Deleting a domain permanently removes all data.

Amazon Elasticsearch Service launched in October 2015 as a managed Elasticsearch offering. Following the Elasticsearch license change, AWS forked the project and rebranded the service as Amazon OpenSearch Service in September 2021, based on the open-source OpenSearch project. The service has added features like UltraWarm storage tiers, serverless collections, and vector search for AI applications.

aws(1), curl(1), aws-logs(1), aws-firehose(1)