Amazon OpenSearch Service API Tags API

The Tags API from Amazon OpenSearch Service API — 2 operation(s) for tags.

GitHub OpenAPI

Operations 5

POST /2021-01-01/tags Add Tags #
GET /2021-01-01/tags List Tags #
POST /#ListTagsForResource List Tags For Resource #
POST /2015-01-01/tags Add Tags #
GET /2015-01-01/tags List Tags #

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-tags-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.

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

OpenAPI Specification

amazon-opensearch-tags-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon OpenSearch Service Tags 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: []
paths:
  /2021-01-01/tags:
    post:
      operationId: AddTags
      summary: Add Tags
      description: Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application. Tags are a
        set of case-sensitive key-value pairs. A domain, data source, or application can have up to 10 tags. For more information,
        see Tagging Amazon OpenSearch Service resources.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '409':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddTagsRequest'
      tags:
      - Tags
    get:
      operationId: ListTags
      summary: List Tags
      description: Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more
        information, see Tagging Amazon OpenSearch Service resources.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTagsResponse'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '409':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTagsRequest'
      tags:
      - Tags
  /#ListTagsForResource:
    post:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch
        Serverless collections.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.ListTagsForResource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListTagsForResourceRequest'
      tags:
      - Tags
      servers:
      - url: https://aoss.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_aoss: []
  /2015-01-01/tags:
    post:
      operationId: AddTags
      summary: Add Tags
      description: Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An
        Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '409':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EsAddTagsRequest'
      tags:
      - Tags
      servers:
      - url: https://es.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    get:
      operationId: ListTags
      summary: List Tags
      description: Returns all tags for the given Elasticsearch domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EsListTagsResponse'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '409':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EsListTagsRequest'
      tags:
      - Tags
      servers:
      - url: https://es.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
components:
  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
    sigv4_aoss:
      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: aoss
  schemas:
    AddTagsRequest:
      type: object
      properties:
        ARN:
          type: string
          description: Amazon Resource Name (ARN) for the OpenSearch Service domain, data source, or application to which
            you want to attach resource tags.
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: List of resource tags.
      required:
      - ARN
      - TagList
    AossResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    AossTag:
      type: object
      properties:
        key:
          type: string
          description: The key to use in the tag.
        value:
          type: string
          description: The value of the tag.
      required:
      - key
      - value
    AossValidationException:
      type: object
      properties:
        message:
          type: string
    BaseException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    EsAddTagsRequest:
      type: object
      properties:
        ARN:
          type: string
          description: Specify the ARN for which you want to add the tags.
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/EsTag'
          description: List of Tag that need to be added for the Elasticsearch domain.
      required:
      - ARN
      - TagList
    EsListTagsRequest:
      type: object
      properties:
        ARN:
          type: string
          description: Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.
      required:
      - ARN
    EsListTagsResponse:
      type: object
      properties:
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/EsTag'
          description: List of Tag for the requested Elasticsearch domain.
    EsTag:
      type: object
      properties:
        Key:
          type: string
          description: Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to
            which they are attached.
        Value:
          type: string
          description: 'Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and
            do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity
            and cost-center : Trinity'
      required:
      - Key
      - Value
    InternalException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    ListTagsForResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state),
            and must be owned by the account ID included in the request.
      required:
      - resourceArn
    ListTagsForResourceResponse:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AossTag'
          description: The tags associated with the resource.
    ListTagsRequest:
      type: object
      properties:
        ARN:
          type: string
          description: Amazon Resource Name (ARN) for the domain, data source, or application to view tags for.
      required:
      - ARN
    ListTagsResponse:
      type: object
      properties:
        TagList:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: List of resource tags associated with the specified domain, data source, or application.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key. Tag keys must be unique for the domain to which they are attached.
        Value:
          type: string
          description: 'The value assigned to the corresponding tag key. Tag values can be null and don''t have to be unique
            in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity'
      required:
      - Key
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/opensearch/service/2021-01-01/opensearch-2021-01-01.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/elasticsearch-service/service/2015-01-01/elasticsearch-service-2015-01-01.json