Amazon OpenSearch Service API Opensearch Collection API

The Opensearch Collection API from Amazon OpenSearch Service API — 5 operation(s) for opensearch collection.

GitHub OpenAPI

Operations 5

POST /#BatchGetCollection Batch Get Collection #
POST /#CreateCollection Create Collection #
POST /#UpdateCollection Update Collection #
POST /#DeleteCollection Delete Collection #
POST /#ListCollections List Collections #

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-collection-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-collection-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon OpenSearch Service Collection 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://aoss.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#BatchGetCollection:
    post:
      operationId: BatchGetCollection
      summary: Batch Get Collection
      description: Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards
        endpoint, and FIPS-compliant endpoints. For more information, see Creating and managing Amazon OpenSearch Serverless
        collections.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BatchGetCollectionResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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.BatchGetCollection
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchGetCollectionRequest'
      tags:
      - Collection
  /#CreateCollection:
    post:
      operationId: CreateCollection
      summary: Create Collection
      description: Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon
        OpenSearch Serverless collections.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateCollectionResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: OcuLimitExceededException; ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/OcuLimitExceededException'
        '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.CreateCollection
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateCollectionRequest'
      tags:
      - Collection
  /#UpdateCollection:
    post:
      operationId: UpdateCollection
      summary: Update Collection
      description: Updates an OpenSearch Serverless collection.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateCollectionResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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.UpdateCollection
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateCollectionRequest'
      tags:
      - Collection
  /#DeleteCollection:
    post:
      operationId: DeleteCollection
      summary: Delete Collection
      description: Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch
        Serverless collections.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteCollectionResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '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.DeleteCollection
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteCollectionRequest'
      tags:
      - Collection
  /#ListCollections:
    post:
      operationId: ListCollections
      summary: List Collections
      description: Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch
        Serverless collections. Make sure to include an empty request body {} if you don't include any collection filters
        in the request.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListCollectionsResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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.ListCollections
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListCollectionsRequest'
      tags:
      - Collection
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: aoss
  schemas:
    AossConflictException:
      type: object
      properties:
        message:
          type: string
    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
    BatchGetCollectionRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the
            collection endpoint. You can also retrieve it using the ListCollections API.
        names:
          type: array
          items:
            type: string
          description: A list of collection names. You can't provide names and IDs in the same request.
    BatchGetCollectionResponse:
      type: object
      properties:
        collectionDetails:
          type: array
          items:
            $ref: '#/components/schemas/CollectionDetail'
          description: Details about each collection.
        collectionErrorDetails:
          type: array
          items:
            $ref: '#/components/schemas/CollectionErrorDetail'
          description: Error information for the request.
    CollectionDetail:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the collection.
        name:
          type: string
          description: The name of the collection.
        status:
          type: string
          description: The current status of the collection.
        type:
          type: string
          description: The type of collection.
        description:
          type: string
          description: A description of the collection.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection.
        kmsKeyArn:
          type: string
          description: The ARN of the Amazon Web Services KMS key used to encrypt the collection.
        standbyReplicas:
          type: string
          description: Details about an OpenSearch Serverless collection.
        deletionProtection:
          type: string
          description: Indicates whether deletion protection is ENABLED or DISABLED for the collection.
        vectorOptions:
          $ref: '#/components/schemas/VectorOptions'
        createdDate:
          type: integer
          description: The Epoch time when the collection was created.
        lastModifiedDate:
          type: integer
          description: The date and time when the collection was last modified.
        collectionEndpoint:
          type: string
          description: Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch
            Serverless collection.
        dashboardEndpoint:
          type: string
          description: Collection-specific endpoint used to access OpenSearch Dashboards.
        fipsEndpoints:
          $ref: '#/components/schemas/FipsEndpoints'
        failureCode:
          type: string
          description: A failure code associated with the request.
        failureMessage:
          type: string
          description: A message associated with the failure code.
        collectionGroupName:
          type: string
          description: The name of the collection group that contains this collection.
    CollectionErrorDetail:
      type: object
      properties:
        id:
          type: string
          description: If the request contains collection IDs, the response includes the IDs provided in the request.
        name:
          type: string
          description: If the request contains collection names, the response includes the names provided in the request.
        errorMessage:
          type: string
          description: A description of the error. For example, The specified Collection is not found.
        errorCode:
          type: string
          description: The error code for the request. For example, NOT_FOUND.
    CollectionFilters:
      type: object
      properties:
        name:
          type: string
          description: The name of the collection.
        status:
          type: string
          description: The current status of the collection.
        collectionGroupName:
          type: string
          description: The name of the collection group to filter by.
    CollectionSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection.
        name:
          type: string
          description: The name of the collection.
        status:
          type: string
          description: The current status of the collection.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection.
        kmsKeyArn:
          type: string
          description: The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.
        collectionGroupName:
          type: string
          description: The name of the collection group that contains this collection.
    CreateCollectionDetail:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection.
        name:
          type: string
          description: The name of the collection.
        status:
          type: string
          description: The current status of the collection.
        type:
          type: string
          description: The type of collection.
        description:
          type: string
          description: A description of the collection.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
        standbyReplicas:
          type: string
          description: Creates details about an OpenSearch Serverless collection.
        deletionProtection:
          type: string
          description: Indicates whether deletion protection is ENABLED or DISABLED for the collection.
        vectorOptions:
          $ref: '#/components/schemas/VectorOptions'
        createdDate:
          type: integer
          description: The Epoch time when the collection was created.
        lastModifiedDate:
          type: integer
          description: The date and time when the collection was last modified.
        collectionGroupName:
          type: string
          description: The name of the collection group that contains this collection.
    CreateCollectionRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the collection.
        type:
          type: string
          description: The type of collection.
        description:
          type: string
          description: Description of the collection.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AossTag'
          description: An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
        standbyReplicas:
          type: string
          description: Indicates whether standby replicas should be used for a collection.
        vectorOptions:
          $ref: '#/components/schemas/VectorOptions'
        collectionGroupName:
          type: string
          description: The name of the collection group to associate with the collection.
        encryptionConfig:
          $ref: '#/components/schemas/EncryptionConfig'
        deletionProtection:
          type: string
          description: Indicates whether to enable deletion protection for the collection. When set to ENABLED, the collection
            cannot be deleted.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - name
    CreateCollectionResponse:
      type: object
      properties:
        createCollectionDetail:
          $ref: '#/components/schemas/CreateCollectionDetail'
    DeleteCollectionDetail:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection.
        name:
          type: string
          description: The name of the collection.
        status:
          type: string
          description: The current status of the collection.
        deletionProtection:
          type: string
          description: Indicates whether deletion protection is ENABLED or DISABLED for the collection.
    DeleteCollectionRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection
            endpoint. You can also retrieve it using the ListCollections API.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - id
    DeleteCollectionResponse:
      type: object
      properties:
        deleteCollectionDetail:
          $ref: '#/components/schemas/DeleteCollectionDetail'
    EncryptionConfig:
      type: object
      properties:
        aWSOwnedKey:
          type: boolean
          description: Indicates whether to use an Amazon Web Services-owned key for encryption.
        kmsKeyArn:
          type: string
          description: The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.
    FipsEndpoints:
      type: object
      properties:
        collectionEndpoint:
          type: string
          description: FIPS-compliant collection endpoint used to submit index, search, and data upload requests to an OpenSearch
            Serverless collection. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government
            workloads.
        dashboardEndpoint:
          type: string
          description: FIPS-compliant endpoint used to access OpenSearch Dashboards. This endpoint uses FIPS 140-3 validated
            cryptography and is required for federal government workloads that need dashboard visualization capabilities.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListCollectionsRequest:
      type: object
      properties:
        collectionFilters:
          $ref: '#/components/schemas/CollectionFilters'
        nextToken:
          type: string
          description: If your initial ListCollections operation returns a nextToken, you can include the returned nextToken
            in subsequent ListCollections operations, which returns results in the next page.
        maxResults:
          type: integer
          description: The maximum number of results to return. Default is 20. You can use nextToken to get the next page
            of results.
    ListCollectionsResponse:
      type: object
      properties:
        collectionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/CollectionSummary'
          description: Details about each collection.
        nextToken:
          type: string
          description: When nextToken is returned, there are more results available. The value of nextToken is a unique pagination
            token for each page. Make the call again using the returned token to retrieve the next page.
    OcuLimitExceededException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
      required:
      - message
    UpdateCollectionDetail:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection.
        name:
          type: string
          description: The name of the collection.
        status:
          type: string
          description: The current status of the collection.
        type:
          type: string
          description: The collection type.
        description:
          type: string
          description: The description of the collection.
        vectorOptions:
          $ref: '#/components/schemas/VectorOptions'
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (Amazon Web Services
            KMS) key used to encrypt the collection.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection.
        createdDate:
          type: integer
          description: The date and time when the collection was created.
        lastModifiedDate:
          type: integer
          description: The date and time when the collection was last modified.
        deletionProtection:
          type: string
          description: Indicates whether deletion protection is ENABLED or DISABLED for the collection.
    UpdateCollectionRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection.
        description:
          type: string
          description: A description of the collection.
        vectorOptions:
          $ref: '#/components/schemas/VectorOptions'
        deletionProtection:
          type: string
          description: Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED,
            the collection cannot be deleted.
        encryptionConfig:
          $ref: '#/components/schemas/EncryptionConfig'
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - id
    UpdateCollectionResponse:
      type: object
      properties:
        updateCollectionDetail:
          $ref: '#/components/schemas/UpdateCollectionDetail'
    VectorOptions:
      type: object
      properties:
        ServerlessVectorAcceleration:
          type: string
          description: Specifies whether serverless vector acceleration is enabled for the collection.
      required:
      - ServerlessVectorAcceleration
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)