Amazon OpenSearch Service

Amazon OpenSearch Service Domains API

Operations for creating and managing OpenSearch domains

Documentation GitHub OpenAPI

Operations 5

POST /2021-01-01/opensearch/domain Amazon OpenSearch Service Create an OpenSearch Domain #

GET /2021-01-01/opensearch/domain/{domainName} Amazon OpenSearch Service Describe an OpenSearch Domain #

DELETE /2021-01-01/opensearch/domain/{domainName} Amazon OpenSearch Service Delete an OpenSearch Domain #

POST /2021-01-01/opensearch/domain-info Amazon OpenSearch Service Describe Multiple OpenSearch Domains #

GET /2021-01-01/opensearch/domains Amazon OpenSearch Service List All OpenSearch Domains #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-opensearch-service-domains-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon OpenSearch Service Domains API
  description: The Amazon OpenSearch Service API enables programmatic management of OpenSearch domains. You can create, configure, update, and delete domains, manage access policies, configure VPC endpoints, and monitor domain health through this management interface.
  version: '2021-01-01'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://es.{region}.amazonaws.com
  description: Amazon OpenSearch Service regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- sigv4: []
tags:
- name: Domains
  description: Operations for creating and managing OpenSearch domains
paths:
  /2021-01-01/opensearch/domain:
    post:
      operationId: CreateDomain
      summary: Amazon OpenSearch Service Create an OpenSearch Domain
      description: Creates an Amazon OpenSearch Service domain with the specified configuration.
      tags:
      - Domains
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainRequest'
      responses:
        '200':
          description: Domain creation initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainStatus'
              examples:
                CreateDomain200Example:
                  summary: Default CreateDomain 200 response
                  x-microcks-default: true
                  value:
                    DomainId: resource-abc123
                    DomainName: my-resource
                    ARN: arn:aws:service:us-east-1:123456789012:resource/example
                    Created: true
                    Deleted: true
                    Endpoint: example-string
                    EngineVersion: 1.0.0
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /2021-01-01/opensearch/domain/{domainName}:
    get:
      operationId: DescribeDomain
      summary: Amazon OpenSearch Service Describe an OpenSearch Domain
      description: Returns domain configuration details for the specified domain.
      tags:
      - Domains
      parameters:
      - name: domainName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Domain details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainStatus'
              examples:
                DescribeDomain200Example:
                  summary: Default DescribeDomain 200 response
                  x-microcks-default: true
                  value:
                    DomainId: resource-abc123
                    DomainName: my-resource
                    ARN: arn:aws:service:us-east-1:123456789012:resource/example
                    Created: true
                    Deleted: true
                    Endpoint: example-string
                    EngineVersion: 1.0.0
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: DeleteDomain
      summary: Amazon OpenSearch Service Delete an OpenSearch Domain
      description: Permanently deletes the specified domain and all of its data.
      tags:
      - Domains
      parameters:
      - name: domainName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Domain deletion initiated successfully
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /2021-01-01/opensearch/domain-info:
    post:
      operationId: DescribeDomains
      summary: Amazon OpenSearch Service Describe Multiple OpenSearch Domains
      description: Returns domain configuration details for the specified list of domains.
      tags:
      - Domains
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                DomainNames:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Domain details retrieved successfully
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /2021-01-01/opensearch/domains:
    get:
      operationId: ListDomainNames
      summary: Amazon OpenSearch Service List All OpenSearch Domains
      description: Returns the names of all OpenSearch domains owned by the current user.
      tags:
      - Domains
      responses:
        '200':
          description: Domain names listed successfully
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateDomainRequest:
      type: object
      required:
      - DomainName
      properties:
        DomainName:
          type: string
          description: Name of the OpenSearch domain to create
        EngineVersion:
          type: string
          description: Version of OpenSearch or Elasticsearch
        ClusterConfig:
          type: object
          description: Container for the cluster configuration
        EBSOptions:
          type: object
          description: Container for EBS-based storage options
        AccessPolicies:
          type: string
          description: IAM access policy as a JSON-formatted string
    DomainStatus:
      type: object
      properties:
        DomainId:
          type: string
        DomainName:
          type: string
        ARN:
          type: string
        Created:
          type: boolean
        Deleted:
          type: boolean
        Endpoint:
          type: string
        EngineVersion:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4

Amazon OpenSearch Service Domains API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources