Amazon OpenSearch Service API

Amazon OpenSearch Service API Data Source API

The Data Source API from Amazon OpenSearch Service API — 2 operation(s) for data source.

Documentation GitHub OpenAPI

Operations 5

POST /2021-01-01/opensearch/domain/{DomainName}/dataSource Add Data Source #

GET /2021-01-01/opensearch/domain/{DomainName}/dataSource List Data Sources #

DELETE /2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name} Delete Data Source #

GET /2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name} Get Data Source #

PUT /2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name} Update Data Source #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-opensearch/openapi/amazon-opensearch-data-source-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-data-source-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

openapi: 3.2.0
info:
  title: Amazon OpenSearch Service Datasource Data Source API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon OpenSearch Service. 5 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: Data Source
paths:
  /2021-01-01/opensearch/domain/{DomainName}/dataSource:
    post:
      operationId: AddDataSource
      summary: Add Data Source
      description: Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddDataSourceResponse'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '424':
          description: DependencyFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailureException'
        '409':
          description: DisabledOperationException; LimitExceededException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDataSourceRequest'
      tags:
      - Data Source
    get:
      operationId: ListDataSources
      summary: List Data Sources
      description: Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataSourcesResponse'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDataSourcesRequest'
      tags:
      - Data Source
  /2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}:
    delete:
      operationId: DeleteDataSource
      summary: Delete Data Source
      description: Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataSourceResponse'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDataSourceRequest'
      tags:
      - Data Source
    get:
      operationId: GetDataSource
      summary: Get Data Source
      description: Retrieves information about a direct query data source.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataSourceResponse'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDataSourceRequest'
      tags:
      - Data Source
    put:
      operationId: UpdateDataSource
      summary: Update Data Source
      description: Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDataSourceResponse'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataSourceRequest'
      tags:
      - Data Source
components:
  schemas:
    DependencyFailureException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    DataSourceType:
      type: object
      properties:
        S3GlueDataCatalog:
          $ref: '#/components/schemas/S3GlueDataCatalog'
      description: Exactly one member is set.
    ListDataSourcesResponse:
      type: object
      properties:
        DataSources:
          type: array
          items:
            $ref: '#/components/schemas/DataSourceDetails'
          description: A list of data sources associated with specified domain.
    DataSourceDetails:
      type: object
      properties:
        DataSourceType:
          $ref: '#/components/schemas/DataSourceType'
        Name:
          type: string
          description: The name of the data source.
        Description:
          type: string
          description: A description of the data source.
        Status:
          type: string
          enum:
          - ACTIVE
          - DISABLED
          description: The status of the data source.
    DisabledOperationException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    ListDataSourcesRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The name of the domain.
      required:
      - DomainName
    GetDataSourceRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The name of the domain.
        Name:
          type: string
          description: The name of the data source to get information about.
      required:
      - DomainName
      - Name
    InternalException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    GetDataSourceResponse:
      type: object
      properties:
        DataSourceType:
          $ref: '#/components/schemas/DataSourceType'
        Name:
          type: string
          description: The name of the data source.
        Description:
          type: string
          description: A description of the data source.
        Status:
          type: string
          enum:
          - ACTIVE
          - DISABLED
          description: The status of the data source.
    AddDataSourceRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The name of the domain to add the data source to.
        Name:
          type: string
          description: A name for the data source.
        DataSourceType:
          $ref: '#/components/schemas/DataSourceType'
        Description:
          type: string
          description: A description of the data source.
      required:
      - DomainName
      - Name
      - DataSourceType
    DeleteDataSourceResponse:
      type: object
      properties:
        Message:
          type: string
          description: A message associated with deletion of the data source.
    BaseException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    UpdateDataSourceRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The name of the domain.
        Name:
          type: string
          description: The name of the data source to modify.
        DataSourceType:
          $ref: '#/components/schemas/DataSourceType'
        Description:
          type: string
          description: A new description of the data source.
        Status:
          type: string
          enum:
          - ACTIVE
          - DISABLED
          description: The status of the data source update.
      required:
      - DomainName
      - Name
      - DataSourceType
    DeleteDataSourceRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The name of the domain.
        Name:
          type: string
          description: The name of the data source to delete.
      required:
      - DomainName
      - Name
    UpdateDataSourceResponse:
      type: object
      properties:
        Message:
          type: string
          description: A message associated with the updated data source.
    S3GlueDataCatalog:
      type: object
      properties:
        RoleArn:
          type: string
          description: '>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.'
    AddDataSourceResponse:
      type: object
      properties:
        Message:
          type: string
          description: A message associated with creation of the data source.
  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)