AWS Amazon Elasticsearch Service

Name: Amazon Elasticsearch Service API
Brand: Amazon Elasticsearch Service
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureComputeapiKey50 EndpointsREST

For Agents

Provision and manage Amazon Elasticsearch (OpenSearch) domains, packages, and cross-cluster connections through a single API.

Install Jentic One Beta

Connect the Amazon Elasticsearch Service to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Amazon Elasticsearch Service, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Amazon Elasticsearch Service API.

Create Elasticsearch and OpenSearch domains with custom instance counts, storage, and VPC settings

Manage service software updates and cancel pending update windows

Associate and dissociate packages such as custom dictionaries with running domains

GET STARTED

Start building with Amazon Elasticsearch Service API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Amazon Elasticsearch Service, keeping it validated and agent-ready. The Amazon Elasticsearch (now OpenSearch) Configuration API creates and manages Elasticsearch domains, including instance configuration, storage, VPC settings, access policies, package associations, and cross-cluster connection setup. The API also covers service software updates, package management, and VPC endpoint authorisation. It is built for platform teams that need to provision and operate search and analytics clusters on AWS without console-driven workflows.

Use Cases

Patterns agents use Amazon Elasticsearch Service API for, with concrete tasks.

★ Search Domain Provisioning

Platform teams use the Amazon Elasticsearch API to provision search and log-analytics domains with VPC isolation, dedicated master nodes, and EBS storage. The API drives domain creation, configuration updates, and access policy management so that infrastructure pipelines can stand up search backends without console clicks. A typical three-node VPC domain provisions in fifteen to thirty minutes, returning a domain endpoint for application connection.

Create an Elasticsearch domain named search-prod with three r5.large.elasticsearch instances and 100 GiB of EBS storage in subnets subnet-a and subnet-b.

Cross-Cluster Search Setup

Data platform teams use cross-cluster connections to query indices that live in separate Elasticsearch domains, often for tenancy or region isolation. The API creates inbound and outbound connections, enabling federated queries without bulk data movement. This pattern keeps shard counts manageable per domain while preserving a single query surface for analysts.

Create an outbound cross-cluster connection from domain search-prod to remote domain search-eu and accept the matching inbound connection.

Service Software Update Coordination

Reliability teams use the API to monitor and time service software updates for Elasticsearch domains so that planned maintenance windows align with low-traffic periods. The API exposes start, schedule, and cancel actions for software updates and surfaces the engine version progress field so dashboards can track fleet-wide patch state. Coordinated updates limit availability impact on customer-facing search.

Cancel the pending service software update on domain search-prod and reschedule it for the next maintenance window.

Agent-Driven Search Cluster Operations via Jentic

AI agents use the Amazon Elasticsearch API through Jentic to manage domain lifecycle, package associations, and software updates as part of larger platform workflows. Jentic exposes Elasticsearch operations as discoverable tools so an agent can search by intent and execute the matching call. This lets a platform agent respond to capacity or version events without console interaction.

Search Jentic for create elasticsearch domain, load the CreateElasticsearchDomain schema, and execute it for a new staging domain with two t3.medium.elasticsearch nodes.

Key Endpoints

50 endpoints — jentic publishes the only available openapi specification for amazon elasticsearch service, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/2015-01-01/es/domain

Create a new Elasticsearch domain

POST

/2015-01-01/packages

Create a custom package such as a synonym list

POST

/2015-01-01/packages/associate/{PackageID}/{DomainName}

Associate a package with a domain

POST

/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess

Authorize VPC endpoint access

POST

/2015-01-01/es/serviceSoftwareUpdate/cancel

Cancel a pending service software update

POST

/2015-01-01/es/ccs/outboundConnection

Create an outbound cross-cluster connection

POST

/2015-01-01/tags

Add tags to a domain or package

POST

/2015-01-01/es/domain

Create a new Elasticsearch domain

POST

/2015-01-01/packages

Create a custom package such as a synonym list

POST

/2015-01-01/packages/associate/{PackageID}/{DomainName}

Associate a package with a domain

POST

/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess

Authorize VPC endpoint access

POST

/2015-01-01/es/serviceSoftwareUpdate/cancel

Cancel a pending service software update

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

AWS access keys for the Elasticsearch Configuration API are stored encrypted in the Jentic vault. Agents receive scoped, short-lived signing access — raw secret access keys never enter the agent context.

Intent-based discovery

Agents search by intent (for example create a search domain) and Jentic returns matching Elasticsearch operations with their input schemas, so the agent can call the right endpoint without browsing AWS docs.

Time to first call

Direct integration: 1-2 days for SigV4 signing, VPC config, and update polling. Through Jentic: under 30 minutes — search, load schema, execute.

FAQs

Specific to using Amazon Elasticsearch Service API through Jentic.

Why is there no official OpenAPI spec for Amazon Elasticsearch Service?

AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Amazon Elasticsearch Service via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Amazon Elasticsearch API use?

The Configuration API uses AWS Signature Version 4 request signing. Through Jentic, AWS access keys are stored encrypted in the vault and signing happens server-side, so the agent never sees the raw secret access key.

Can I create OpenSearch domains with this API?

Yes. POST /2015-01-01/es/domain creates Elasticsearch and OpenSearch domains; the EngineVersion field accepts both Elasticsearch_7.x and OpenSearch_x.y values to select the engine.

What are the rate limits for the Amazon Elasticsearch API?

AWS applies per-account, per-region throttling on the Configuration API. Mutating calls such as CreateElasticsearchDomain are throttled more aggressively than describe calls. Use exponential backoff on ThrottlingException responses; AWS does not publish exact TPS numbers in the spec.

How do I associate a custom synonyms package with a domain through Jentic?

Search Jentic for associate elasticsearch package, load the schema for POST /2015-01-01/packages/associate/{PackageID}/{DomainName}, and execute it with the package ID and domain name. Jentic returns the association status.

Does this API run search queries against indices?

No. This is the configuration API for managing domains. Index and search requests go to the per-domain endpoint URL using the standard Elasticsearch or OpenSearch query DSL.

AWS Amazon Elasticsearch Service

Connect the Amazon Elasticsearch Service to your agent

Capabilities

Start building with Amazon Elasticsearch Service API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs