Amazon OpenSearch Service API

Amazon OpenSearch Service API Opensearch Index API

The Opensearch Index API from Amazon OpenSearch Service API — 2 operation(s) for opensearch index.

GitHub OpenAPI

Operations 4

POST /2021-01-01/opensearch/domain/{DomainName}/index Create Index #
DELETE /2021-01-01/opensearch/domain/{DomainName}/index/{IndexName} Delete Index #
GET /2021-01-01/opensearch/domain/{DomainName}/index/{IndexName} Get Index #
PUT /2021-01-01/opensearch/domain/{DomainName}/index/{IndexName} Update Index #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-opensearch/openapi/amazon-opensearch-index-api-openapi.yml

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:amazon-opensearch-index-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

amazon-opensearch-index-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon OpenSearch Service Index API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon OpenSearch Service. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://es.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Index
paths:
  /2021-01-01/opensearch/domain/{DomainName}/index:
    post:
      operationId: CreateIndex
      summary: Create Index
      description: Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see Automatic semantic enrichment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIndexResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '424':
          description: DependencyFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailureException'
        '409':
          description: DisabledOperationException; ResourceAlreadyExistsException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIndexRequest'
      tags:
      - Index
  /2021-01-01/opensearch/domain/{DomainName}/index/{IndexName}:
    delete:
      operationId: DeleteIndex
      summary: Delete Index
      description: Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIndexResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '424':
          description: DependencyFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailureException'
        '409':
          description: DisabledOperationException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteIndexRequest'
      tags:
      - Index
    get:
      operationId: GetIndex
      summary: Get Index
      description: Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIndexResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '424':
          description: DependencyFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailureException'
        '409':
          description: DisabledOperationException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetIndexRequest'
      tags:
      - Index
    put:
      operationId: UpdateIndex
      summary: Update Index
      description: Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIndexResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '424':
          description: DependencyFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailureException'
        '409':
          description: DisabledOperationException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIndexRequest'
      tags:
      - Index
components:
  schemas:
    UpdateIndexRequest:
      type: object
      properties:
        DomainName:
          type: string
        IndexName:
          type: string
          description: The name of the index to update.
        IndexSchema:
          type: object
          description: The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration.
      required:
      - DomainName
      - IndexName
      - IndexSchema
    DependencyFailureException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    CreateIndexRequest:
      type: object
      properties:
        DomainName:
          type: string
        IndexName:
          type: string
          description: The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.
        IndexSchema:
          type: object
          description: The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.
      required:
      - DomainName
      - IndexName
      - IndexSchema
    DisabledOperationException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    CreateIndexResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - CREATED
          - UPDATED
          - DELETED
          description: The status of the index creation operation.
      required:
      - Status
    InternalException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    GetIndexResponse:
      type: object
      properties:
        IndexSchema:
          type: object
          description: The JSON schema of the index including mappings, settings, and semantic enrichment configuration.
      required:
      - IndexSchema
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    GetIndexRequest:
      type: object
      properties:
        DomainName:
          type: string
        IndexName:
          type: string
          description: The name of the index to retrieve information about.
      required:
      - DomainName
      - IndexName
    DeleteIndexResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - CREATED
          - UPDATED
          - DELETED
          description: The status of the index deletion operation.
      required:
      - Status
    UpdateIndexResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - CREATED
          - UPDATED
          - DELETED
          description: The status of the index update operation.
      required:
      - Status
    DeleteIndexRequest:
      type: object
      properties:
        DomainName:
          type: string
        IndexName:
          type: string
          description: The name of the index to delete.
      required:
      - DomainName
      - IndexName
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: es
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/opensearch/service/2021-01-01/opensearch-2021-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)