Amazon OpenSearch Service API Opensearch Capability API

The Opensearch Capability API from Amazon OpenSearch Service API — 3 operation(s) for opensearch capability.

Documentation GitHub OpenAPI

Operations 3

DELETE /2021-01-01/opensearch/application/{applicationId}/capability/deregister/{capabilityName} Deregister Capability #

GET /2021-01-01/opensearch/application/{applicationId}/capability/{capabilityName} Get Capability #

POST /2021-01-01/opensearch/application/{applicationId}/capability/register Register Capability #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-opensearch/openapi/amazon-opensearch-capability-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-capability-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 Capability API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon OpenSearch Service. 3 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: Capability
paths:
  /2021-01-01/opensearch/application/{applicationId}/capability/deregister/{capabilityName}:
    delete:
      operationId: DeregisterCapability
      summary: Deregister Capability
      description: Deregisters a capability from an OpenSearch UI application. This operation removes the capability and its associated configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeregisterCapabilityResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; DisabledOperationException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeregisterCapabilityRequest'
      tags:
      - Capability
  /2021-01-01/opensearch/application/{applicationId}/capability/{capabilityName}:
    get:
      operationId: GetCapability
      summary: Get Capability
      description: Retrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCapabilityResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DisabledOperationException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCapabilityRequest'
      tags:
      - Capability
  /2021-01-01/opensearch/application/{applicationId}/capability/register:
    post:
      operationId: RegisterCapability
      summary: Register Capability
      description: Registers a capability for an OpenSearch UI application. Use this operation to enable specific capabilities, such as AI features, for a given application. The capability configuration defines the type and settings of the capability to register. For more information about the AI features, see Agentic AI for OpenSearch UI.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterCapabilityResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; DisabledOperationException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterCapabilityRequest'
      tags:
      - Capability
components:
  schemas:
    CapabilityFailure:
      type: object
      properties:
        reason:
          type: string
          enum:
          - KMS_KEY_INSUFFICIENT_PERMISSION
          description: 'The reason for the capability failure. Possible values: KMS_KEY_INSUFFICIENT_PERMISSION.'
        details:
          type: string
          description: Additional details about the capability failure.
    CapabilityExtendedResponseConfig:
      type: object
      properties:
        aiConfig:
          $ref: '#/components/schemas/AIConfig'
      description: Exactly one member is set.
    DeregisterCapabilityRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the OpenSearch UI application to deregister the capability from.
        capabilityName:
          type: string
          description: The name of the capability to deregister.
      required:
      - applicationId
      - capabilityName
    DisabledOperationException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    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.
    CapabilityBaseResponseConfig:
      type: object
      properties:
        aiConfig:
          $ref: '#/components/schemas/AIConfig'
      description: Exactly one member is set.
    DeregisterCapabilityResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - creating
          - create_failed
          - active
          - updating
          - update_failed
          - deleting
          - delete_failed
          description: The status of the deregistration operation. Returns deleting when the capability is being removed.
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    CapabilityBaseRequestConfig:
      type: object
      properties:
        aiConfig:
          $ref: '#/components/schemas/AIConfig'
      description: Exactly one member is set.
    GetCapabilityRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the OpenSearch UI application.
        capabilityName:
          type: string
          description: The name of the capability to retrieve information about.
      required:
      - applicationId
      - capabilityName
    RegisterCapabilityRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the OpenSearch UI application to register the capability for.
        capabilityName:
          type: string
          description: The name of the capability to register. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. This identifies the type of capability being enabled for the application. For registering AI Assistant capability, use ai-capability
        capabilityConfig:
          $ref: '#/components/schemas/CapabilityBaseRequestConfig'
      required:
      - applicationId
      - capabilityName
      - capabilityConfig
    RegisterCapabilityResponse:
      type: object
      properties:
        capabilityName:
          type: string
          description: The name of the registered capability.
        applicationId:
          type: string
          description: The unique identifier of the OpenSearch UI application.
        status:
          type: string
          enum:
          - creating
          - create_failed
          - active
          - updating
          - update_failed
          - deleting
          - delete_failed
          description: 'The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.'
        capabilityConfig:
          $ref: '#/components/schemas/CapabilityBaseResponseConfig'
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    AIConfig:
      type: object
      properties: {}
    GetCapabilityResponse:
      type: object
      properties:
        capabilityName:
          type: string
          description: The name of the capability.
        applicationId:
          type: string
          description: The unique identifier of the OpenSearch UI application.
        status:
          type: string
          enum:
          - creating
          - create_failed
          - active
          - updating
          - update_failed
          - deleting
          - delete_failed
          description: 'The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.'
        capabilityConfig:
          $ref: '#/components/schemas/CapabilityExtendedResponseConfig'
        failures:
          type: array
          items:
            $ref: '#/components/schemas/CapabilityFailure'
          description: A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
  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)