Amazon OpenSearch Samples on AWS

This repository provides sample code and reference architectures for building production-ready solutions with Amazon OpenSearch Service. Samples cover ingestion, search relevance, vector search, observability, operational tooling, and integration patterns — each one self-contained with its own README, deployment steps, and security guidance.

🗒️ Table of Contents

• Samples
• How samples are organized
• AWS Blogs
• Contributing
• Security
• License

📑 Samples

Sample	Description
ingestion	Load and reload data into Amazon OpenSearch Service using OpenSearch Ingestion (OSI) pipelines. Includes a full AWS CDK stack with VPC, OpenSearch domain, OSI pipeline, S3 buckets, and SSM-accessible jumphost.
tools/index-compare	Compare two OpenSearch indices and identify document IDs present in the source but missing from the target. Supports Amazon OpenSearch Service managed domains and Serverless collections via SigV4, plus HTTP basic auth, with an optional local Docker Compose setup for testing.
operations/cloudwatch-alarms	Deploy AWS-recommended CloudWatch alarms for an Amazon OpenSearch Service domain in minutes. Includes a CloudFormation template (23 alarms + SNS topic) and an interactive deployment script that auto-detects your domain configuration.

More samples coming soon — vector search patterns, search relevance tuning, and operational tooling.

📂 How samples are organized

Each sample lives in its own top-level directory and is fully self-contained:

• Its own README.md with prerequisites, deployment, and cleanup steps
• Its own infrastructure code (CDK, CloudFormation, or Terraform) where applicable
• Its own THREAT_MODEL.md for samples that provision AWS resources
• Its own dependency manifest (requirements.txt, package.json, etc.)

You can clone the whole repo and work on one sample without building the others.

sample-opensearch-on-aws/
├── README.md                 # This file — index of all samples
├── LICENSE                   # MIT-0
├── NOTICE
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── ingestion/                # Data ingestion via OSI pipelines
│   ├── README.md
│   ├── THREAT_MODEL.md
│   └── ...
├── operations/
│   └── cloudwatch-alarms/    # Recommended CloudWatch alarms
│       ├── README.md
│       ├── OpenSearch_cloudwatch_alarms.yaml
│       └── deploy.sh
└── tools/
    └── index-compare/        # Index comparison tool
        ├── README.md
        └── ...

💡 AWS Blogs

Links to related AWS blog posts will be added as samples are published.

🙌 Contributing

Contributions are welcome. See CONTRIBUTING.md for guidelines on proposing new samples, reporting issues, and submitting pull requests.

🔒 Security

See CONTRIBUTING for more information on reporting security issues.

📄 License

This library is licensed under the MIT-0 License. See the LICENSE file.