Amazon Opensearch Service

AWSOfficialPublished by AWS

Skill
Workflow
Cloud and DevOps
Apache-2.0
Low risk

From the author

Guides migration, provisioning, search, log-analytics, trace-analytics, and Agentic AI Assistant workflows for Amazon OpenSearch Service and Serverless across six capabilities — migration (Solr/ES/self-managed into AOS/AOSS, schema/query translation, sizing, cutover); provisioning (domain + AOSS lifecycle, upgrades, FGAC, monitoring); search (vector / semantic / hybrid / RAG with Bedrock); log-analytics (PPL, OSI, anomaly detection, Dashboards); trace-analytics (OTel spans, service maps, Data Prepper); ai-assistant (natural language data exploration, incident investigation, root cause analysis). Triggers on OpenSearch, AOS, AOSS, Elasticsearch, Solr, vector/k-NN/semantic/hybrid search, RAG, log analytics, PPL, trace analytics, ISM, FAISS, HNSW, Migration Assistant, UltraWarm, OR1, query my data, analyze logs, investigate errors, root cause analysis.

— the description by AWS

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a unified framework for interacting with Amazon OpenSearch Service (AOS) and OpenSearch Serverless (AOSS). It covers the full lifecycle of OpenSearch operations, including migration from legacy systems like Solr or Elasticsearch, infrastructure provisioning, advanced search implementation (including vector and RAG), and observability through log and trace analytics. It also features an Agentic AI Assistant for natural language data exploration and incident investigation, ensuring users can navigate complex cluster management and data analysis tasks without manual query crafting.

What it does

Guides migration workflows from Solr, Elasticsearch, or self-managed OpenSearch to AOS/AOSS.
Assists with provisioning, lifecycle management, and monitoring of domains and collections.
Facilitates implementation of vector, semantic, and hybrid search, including RAG with Bedrock.
Supports log and trace analytics using PPL, OpenTelemetry, and anomaly detection.
Provides an Agentic AI Assistant for natural language querying and automated incident root cause analysis.
Enforces operational best practices for sharding, storage tiering, and security configurations.

When to use it

When planning a migration from legacy search engines to Amazon OpenSearch Service.
When setting up or optimizing search capabilities, including vector search and RAG.
When troubleshooting cluster health, performance, or shard allocation issues.
When performing log or trace analysis to investigate system incidents.
When you need to generate optimized PPL or DSL queries using natural language.

Advantages

Centralizes complex operational knowledge across six distinct OpenSearch capabilities.
Reduces manual query complexity by leveraging the Agentic AI Assistant.
Provides clear, actionable guidance on production failure modes and migration blockers.
Standardizes interactions through consistent CLI and data-plane patterns.
Promotes architectural best practices for scaling and cost-effective storage tiering.

Usage examples

“How do I migrate my existing Solr index to Amazon OpenSearch Service?”: The agent identifies the migration capability, explains that Solr to OpenSearch is a refactor migration, and guides you through using the Migration Assistant for data backfill.
“Why is my cluster status yellow and how can I fix it?”: The agent uses the AI Assistant capability to analyze cluster health, check shard allocation, and provide specific commands or steps to resolve unassigned shards.
“Help me set up a RAG pipeline using Bedrock and my OpenSearch domain.”: The agent routes to the search capability, providing instructions on configuring Bedrock connectors and vector index mappings for semantic retrieval.
“Find the root cause of the 503 errors in my application logs from the last hour.”: The agent utilizes the AI Assistant to query logs, perform time-series analysis, and correlate findings to identify the likely root cause of the errors.

Install

Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/aws/amazon-opensearch-service/download

Unzip it into the cross-client skills folder of your project:

mkdir -p .agents/skills && unzip amazon-opensearch-service.zip -d .agents/skills

Documentation by AWS

Amazon OpenSearch Service — the unified skill

This skill answers anything about Amazon OpenSearch Service or Serverless across six capabilities. Step 0 below routes the question to ONE capability and points at that capability's entry-point reference. Everything else — when to dispatch, sub-references, capability-specific facts, cross-capability links — lives in the entry-point reference for that capability.

AWS MCP server is recommended, not required. Capability references show standard AWS CLI commands as the primary syntax (e.g., aws opensearch describe-domain, aws opensearchserverless create-collection). Where the AWS MCP server is available, its call_aws tool offers a streamlined alternative — but every operation in this skill MUST work via the AWS CLI alone. Data-plane HTTP calls against AOS / AOSS use awscurl for SigV4-signed requests; this works in both contexts.

Step 0: detect the capability — first thing you do

Pick one of the six capabilities below. State the detected capability in your first sentence (e.g., "Detected capability: SEARCH — semantic search setup with Bedrock embeddings."). Then load the entry-point reference; that file describes when to dispatch, indexes the rest of the capability's files, and routes you to the next step.

Capability	Entry-point reference
migration — Solr / Elasticsearch / self-managed OpenSearch into AOS or AOSS. Schema/query translation, sizing, cutover.	`references/assessment-workflow.md`
provisioning — Provisioning and managing AOS domains and AOSS collections. Lifecycle, upgrades, storage tiers, FGAC, monitoring.	`references/provisioning-reference.md`
search — Vector / semantic / hybrid / sparse / dense / RAG retrieval. Bedrock connectors, FAISS HNSW vs Lucene.	`references/search-semantic-search-guide.md`
log-analytics — Log search, observability, PPL, OSI ingestion, anomaly detection, OpenSearch Dashboards. Splunk/Datadog/ELK alternatives.	`references/log-analytics-guide.md`
trace-analytics — Distributed traces with OpenTelemetry. Span queries, service maps, Data Prepper.	`references/trace-analytics-trace-queries.md`
ai-assistant — Agentic AI Assistant: auto-discovers indices, generates optimized PPL/DSL queries, summarizes results, and investigates incidents end-to-end. No manual query crafting needed.	`references/ai-assistant.md`

If a prompt spans capabilities (e.g., "migrate from Solr AND set up RAG on the new domain"), pick the dominant capability for the response and close with a one-line handoff to the other capability's entry-point ref.

Universal rules (apply to ALL capabilities)

These rules apply to every response, regardless of capability. Capability-specific rules (sizing math, shape detection, Migration Assistant for Amazon OpenSearch Service capability matrix, k-NN engine selection) live in the entry-point references, not here.

Report header (every multi-section response). Begin every multi-section response with a single fenced metadata block: > Generated: <ISO 8601 timestamp> | Skill: amazon-opensearch-service v<N>. Get the time by calling the current_time tool (returns ISO 8601 in UTC). Read the skill version from this file's frontmatter version: field. For one-line answers (terse FOCUSED_OPERATIONAL replies, anti-pattern refusals) the header is optional; for any multi-section deliverable it is REQUIRED. Place it immediately after the report title and before the first ## heading.
No dollar estimates (HARD CONSTRAINT). Never produce $X/month, ~$1,500, or any dollar figure. Route every cost question to https://calculator.aws and stop. If a sub-reference contains dollar figures, treat them as informational context only and do NOT pass them through to the user.
No credential leakage (HARD CONSTRAINT). Never include master usernames, KMS key ARNs, VPC endpoint URLs, instance IPs, or account IDs in generated output.
Pick one for every A-vs-B decision. Name a primary recommendation in one line with a one-sentence reason. A "go with B if..." caveat is allowed AFTER the primary; never lead with conditional-only guidance.
Source restatement. The first 2–3 sentences must restate the source (engine + version + scale) when known, or restate the customer's question in concrete terms. The very first text the user sees must NOT be tool narration, meta-commentary, the report title, or simply restating the question verbatim.
No marketing tone. Do NOT use "seamless", "robust", "best-in-class", "production-hardened", "enterprise-grade", "world-class", "cleanly", "elegant". Do NOT stack 3+ vague hedges ("typically", "generally", "usually", "in most cases") in a single recommendation — be specific about when it does and does not apply.
Cross-capability handoff. When a user prompt spans capabilities (e.g., "migrate from Solr AND set up RAG on the new domain"), pick the dominant capability for the response, then close with a one-line handoff: "For <other capability>, see references/<other-capability>-<entry>.md."

Cross-cutting references (used across multiple capabilities)

These references are not capability-prefixed because they apply across capabilities. Capability entry-point references load them when relevant; SKILL.md never loads them directly.

references/sizing.md — sizing math, instance family details, OR1 trade-offs, watermarks, JVM heap rules.
references/vector-knn.md — k-NN engines, memory math, RAG ingestion patterns, ELSER alternatives.
references/observability.md — log analytics patterns, ISM, UltraWarm/Cold tiering, Splunk/Datadog migration playbooks.
references/security.md — FGAC, encryption, VPC patterns, audit logs, compliance posture.
references/personas.md — communication style per persona.
references/assessment-gotchas.md — production gotcha catalog (cite by number in Migration specifics or Risks/blockers tables; each gotcha carries a Category: tag that determines its lane).
references/assessment-knowledge-retrieval.md — topic → tool → URL recipe for batched verification.

Assets (assets/): report templates for FULL_ASSESSMENT renderings (Solr-source, ES-source, executive summary).

What this skill does NOT do

Estimate dollar costs. Pricing changes monthly and account-specific (RI, Savings Plan, EDP) discount math is outside this skill's reliable scope. Use https://calculator.aws.
Move data. Use Migration Assistant for Amazon OpenSearch Service (Historical Data Migration for backfill, Live Traffic Migration for live cutover).
Build embedding models. Use Amazon Bedrock or SageMaker.
Replace Splunk SPL or Datadog APM 1:1. Some queries / detectors / dashboards need rewriting.
Tune relevance for a specific catalog. Use OpenSearch Benchmark big5 workload + your own judgment list.

Guardrail — where this skill's own files live (MCP vs local install)

This skill can be loaded two ways, and they resolve the skill's own bundled files from different places. Determine how the skill was loaded before reading a reference or running a script:

Loaded through the AWS MCP server's retrieve_skill tool: The skill is not installed on the local filesystem. You MUST fetch each reference or script via retrieve_skill with the file parameter (e.g. file="references/architecture.md" or file="scripts/deploy.py"), and run the script from the returned content. Do NOT file_read these paths locally — they do not exist on disk.
Installed locally (e.g. .kiro/skills/your-skill/ or ~/.claude/skills/your-skill/): Read and run files from the local skill directory using relative paths.

This distinction applies only to the skill's own packaged files. User data and session artifacts are always read from and written to the user's working directory. Never fetch or write customer data through retrieve_skill.

Files

ATTRIBUTION.mdAdded by AutoGineer930 B
LICENSELicence file added by AutoGineer9.9 KiB
NOTICELicence file added by AutoGineer67 B
SKILL.md9.2 KiB
assets/elasticsearch-gap-register.md5.1 KiB
assets/elasticsearch-index-template-skeleton.md4.2 KiB
assets/elasticsearch-report-template.md7.8 KiB
assets/executive-summary-template.md3.0 KiB
assets/report-template.md12.9 KiB
assets/solr-gap-register.md3.8 KiB
assets/solr-index-template-skeleton.md3.7 KiB
assets/solr-report-template.md5.9 KiB
assets/tech-deepdive-template.md6.2 KiB
references/ai-assistant.md18.0 KiB
references/assessment-gotchas.md17.1 KiB
references/assessment-knowledge-retrieval.md9.3 KiB
references/assessment-shape-anti-pattern-pushback.md10.4 KiB
references/assessment-shape-comparative-decision.md12.9 KiB
references/assessment-shape-focused-operational.md9.9 KiB
references/assessment-shape-full-assessment.md20.7 KiB
references/assessment-shape-overview.md12.1 KiB
references/assessment-shape-schema-conversion.md8.9 KiB
references/assessment-shape-sizing-only.md9.4 KiB
references/assessment-shape-translation.md12.3 KiB
references/assessment-workflow.md48.4 KiB
references/compatibility-rubric.md5.9 KiB
references/log-analytics-guide.md18.0 KiB
references/log-analytics-osi-pipelines.md8.6 KiB
references/log-analytics-troubleshooting.md1.6 KiB
references/observability-ppl-reference.md15.1 KiB
references/observability.md14.5 KiB
references/personas.md10.4 KiB
references/provisioning-agentic-setup.md4.8 KiB
references/provisioning-domain-deploy-search.md2.2 KiB
references/provisioning-domain-provision.md3.4 KiB
references/provisioning-monitoring.md3.4 KiB
references/provisioning-reference.md6.8 KiB
references/provisioning-serverless-agentic-setup.md14.9 KiB
references/provisioning-serverless-deploy-search.md6.7 KiB
references/provisioning-serverless-deprovision.md4.0 KiB
references/provisioning-serverless-provision.md8.8 KiB
references/provisioning-storage-tiers.md2.1 KiB
references/provisioning-troubleshooting.md8.0 KiB
references/provisioning-upgrades.md5.4 KiB
references/readiness-rubric.md3.4 KiB
references/search-bedrock-connectors.md3.8 KiB
references/search-dense-vector-models.md5.5 KiB
references/search-document-processing-guide.md7.7 KiB
references/search-evaluation-guide.md5.3 KiB
references/search-index-config.md2.4 KiB
references/search-recipes.md12.9 KiB
references/search-semantic-search-guide.md18.2 KiB
references/search-sparse-vector-models.md4.9 KiB
references/search-troubleshooting.md1.9 KiB
references/security.md9.3 KiB
references/sizing.md12.2 KiB
references/source-elasticsearch.md6.7 KiB
references/source-opensearch.md4.8 KiB
references/trace-analytics-trace-ingestion.md3.3 KiB
references/trace-analytics-trace-queries.md13.9 KiB
references/trace-analytics-troubleshooting.md1.6 KiB
references/vector-knn.md12.9 KiB

assets/elasticsearch-report-template.md

Elasticsearch / OpenSearch Migration Report Template

You MUST use this structure exactly when emitting the final Elasticsearch-to-OpenSearch (or OpenSearch-upgrade) migration report. It mirrors solr-report-template.md section-for-section so both source families produce the same detailed shape — only the source-specific columns differ. Draft every section from the embedded tables in source-elasticsearch.md / source-opensearch.md; tag version-volatile values [verify] and resolve them in the Step 8 batch.

Required sections

# Elasticsearch → Amazon OpenSearch Migration Assessment

**Generated:** <ISO 8601 timestamp>
**Source:** Elasticsearch <version>, <distribution: Elastic | OSS>, <license: ELv2/SSPL flag>, <node count> nodes, <index count> indexes
**Target:** Amazon OpenSearch Service in <region>
**Stakeholder:** <Search Relevance Engineer | DevOps / Platform Engineer | Business Stakeholder>

## 1. Executive Summary

- Migration complexity: **Low | Medium | High** (with one-line justification)
- Top 3 items to flag: <bulleted, one line each — frame items with a known remediation as **migration specifics** (the path already handles them); reserve **risk** framing for items with no clean fix, capacity-plan implications, or target-choice constraints>
- Recommended target: <OpenSearch Service | OpenSearch Serverless NextGen> — one-sentence reason
- Recommended path: <from the ES version-family table in source-elasticsearch.md>

## 2. Schema / Mapping

| ES field | ES type | OpenSearch field | OpenSearch type | Notes |
|---|---|---|---|---|

You MUST include the full OpenSearch index template (mappings + settings) as a code block — use [elasticsearch-index-template-skeleton.md](elasticsearch-index-template-skeleton.md).
You MUST call out any `_type`/multi-type flattening, `fielddata:true` strip, `dense_vector`→`knn_vector`, `flattened`→`flat_object`, runtime-field pre-compute, or `_source:false` index that required action.

## 3. Query / API Translation

For each representative query or API call the user provided (or a representative set you inferred):

### Q<n>: <one-line description>
- **Elasticsearch:** `<original query / API>`
- **OpenSearch:**
  ```json
  { ... }

Notes: ES Query DSL is largely identical in OpenSearch; flag the deltas — retriever/rrf → hybrid query + normalization-processor, ELSER text_expansion → neural_sparse, scripted/runtime fields, _type in endpoints, X-Pack-only query clauses.

4. Plugins, Auth & Operations

Plugins: map _cat/plugins output (Open Distro opendistro-* → opensearch-* rename cheat-sheet in compatibility-rubric.md §4). Supported-plugin list on managed AOS is [verify].
ILM → ISM (rewrite policies — HIGH); Watcher → Alerting (rebuild monitors — HIGH).
Auth backends (basic / SAML / OIDC / Kerberos / LDAP / IAM-SigV4 / mTLS): map roles + role-mappings to OpenSearch Security.

5. Sizing Recommendation

Tier	Instance type	Count	Storage	Notes
Hot
UltraWarm				(omit if not used)
Cold				(omit if not used)

Primary shards: <n> (from the shard-sizing formula in sizing.md)
Replicas: <n>
JVM heap: Amazon OpenSearch Service auto-sets heap by instance class — record the service-managed value; [verify] the per-instance recommendation
Index management policy: <ISM JSON or summary>

6. Feature Gap Register

You MUST use the canonical 8-column shape from elasticsearch-gap-register.md:

#	Feature	Elasticsearch behavior	OpenSearch alternative	Severity	Lane	Effort	Owner action

Required entries: every ES feature you flagged in steps 3, 4, and 6. Severity values come from compatibility-rubric.md.

7. Security Configuration

See references/security.md for the canonical recommendations (FGAC, encryption, VPC patterns, audit logs, compliance posture). You MUST confirm in the report that each control is in place. You MUST NOT duplicate the full text here.

8. Migration Plan

Use phasing as a sequencing concept (assess → provision → PoC → schema/query rebuild → reindex → dual-write → cutover → decommission); do NOT include calendar duration, engineer-week effort, or owner-role columns as required outputs. Timeline and resourcing are intentionally excluded from the suite.

Phase	Goal	Tooling	Exit criterion
Assess	Confirm gaps and finalize target topology	this report	sign-off
Provision	Stand up domain + IaC + security + tooling	CloudFormation / Migration Assistant for Amazon OpenSearch Service on EKS	target reachable
PoC + spike	Prove the weakest readiness dimension (required if YELLOW)	sample restore	approach confirmed
Schema + query rebuild	Audit Migration Assistant for Amazon OpenSearch Service mappings; rebuild ILM→ISM / Watcher→Alerting / runtime fields	Migration Assistant for Amazon OpenSearch Service metadata + OpenSearch DSL	top-N parity ≥ 95%
Reindex	Move data	<Snapshot/Restore if ES ≤ 7.10.2; else Migration Assistant for Amazon OpenSearch Service Historical Data Migration; OpenSearch source: in-place blue/green or snapshot>	parity sample passes
Dual-write / Replay	Validate live traffic on both	<Migration Assistant for Amazon OpenSearch Service Live Traffic Migration for zero-downtime; else dual-write>	error rate within SLO
Cutover	Flip read traffic	client config	rollback rehearsed
Decommission	Retire source	—	data retained per policy

Commitment: readiness-tier gated — GREEN = committable; YELLOW = after the PoC/spike; RED = spike duration only.

9. Sizing Inputs for AWS Pricing Calculator

Compute inputs: <instance type, count, region — plug into https://calculator.aws>
Storage inputs: <total GB, storage type (gp3 / OR1 / UltraWarm / Cold)>
Cost-saving levers: <UltraWarm threshold, ISM rollover, instance right-sizing, RI/Serverless NextGen>

You MUST plug these values into the AWS Pricing Calculator for an authoritative dollar figure that reflects your account's RI / Savings Plan / EDP discounts. This skill MUST NOT estimate dollars because pricing changes monthly and account-specific discount math is unverifiable by an LLM.

10. Open Questions

You MUST confirm these items with the user before locking the plan.

11. References / Citations

The single canonical provenance record. List every [verify]-resolved claim's source URL with a retrieval timestamp, plus the reference files consulted for stable-core facts. For the retrieval recipe see knowledge-retrieval.md.


## Constraints

- You MUST emit every section above, in order.
- You MUST omit a section's body only if explicitly inapplicable (e.g. no UltraWarm tier). You MUST keep the heading and write "Not applicable: <reason>".
- You MUST save the file as `elasticsearch-to-opensearch-migration-report.md` (or `opensearch-upgrade-migration-report.md` for OS sources) unless the user specifies a different name.
- You MUST NOT invent numbers because fabricated figures mislead sizing and cost decisions. Every cost or sizing figure MUST trace to inputs from the user or to a cited reference.
- For OpenSearch-upgrade sources, retitle to "OpenSearch <from> → <to> Upgrade Assessment", drive section 2/3 from [source-opensearch.md](../references/source-opensearch.md) breaking-changes, and make section 8 the in-place blue/green sequence (stepping-stone via OS 2.19 for 1.x→3.x).

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs an MCP server

Security

What our scanner noticed· Low risk

Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by

AWS

Publisher

AWS (Official)

Source

aws/agent-toolkit-for-aws · plugins/aws-data-analytics/skills/amazon-opensearch-service · commit 0a218f8

Licence

Apache License 2.0 (redistribution allowed)

LICENSE (added by AutoGineer from LICENSE)
NOTICE (added by AutoGineer from NOTICE)
ATTRIBUTION.md (written by AutoGineer)

Synced

2026-11-08

Also distributed in

aws/agent-toolkit-for-aws

AutoGineer is not affiliated with or endorsed by AWS.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download amazon-opensearch-service.zip