Amazon OpenSearch Service API Opensearch Collection Group API

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

GitHub OpenAPI

Operations 5

POST /#BatchGetCollectionGroup Batch Get Collection Group #
POST /#CreateCollectionGroup Create Collection Group #
POST /#UpdateCollectionGroup Update Collection Group #
POST /#DeleteCollectionGroup Delete Collection Group #
POST /#ListCollectionGroups List Collection Groups #

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-group-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-group-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon OpenSearch Service Collection Group 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:
  /#BatchGetCollectionGroup:
    post:
      operationId: BatchGetCollectionGroup
      summary: Batch Get Collection Group
      description: Returns attributes for one or more collection groups, including capacity limits and the number of collections
        in each group. 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/BatchGetCollectionGroupResponse'
        '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.BatchGetCollectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/BatchGetCollectionGroupRequest'
      tags:
      - Collection Group
  /#CreateCollectionGroup:
    post:
      operationId: CreateCollectionGroup
      summary: Create Collection Group
      description: Creates a collection group within OpenSearch Serverless. Collection groups let you manage OpenSearch Compute
        Units (OCUs) at a group level, with multiple collections sharing the group's capacity limits. For more information,
        see Managing collection groups.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateCollectionGroupResponse'
        '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: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossServiceQuotaExceededException'
        '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.CreateCollectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateCollectionGroupRequest'
      tags:
      - Collection Group
  /#UpdateCollectionGroup:
    post:
      operationId: UpdateCollectionGroup
      summary: Update Collection Group
      description: Updates the description and capacity limits of a collection group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateCollectionGroupResponse'
        '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: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossServiceQuotaExceededException'
        '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.UpdateCollectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateCollectionGroupRequest'
      tags:
      - Collection Group
  /#DeleteCollectionGroup:
    post:
      operationId: DeleteCollectionGroup
      summary: Delete Collection Group
      description: Deletes a collection group. You can only delete empty collection groups that contain no collections. 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/DeleteCollectionGroupResponse'
        '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.DeleteCollectionGroup
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteCollectionGroupRequest'
      tags:
      - Collection Group
  /#ListCollectionGroups:
    post:
      operationId: ListCollectionGroups
      summary: List Collection Groups
      description: Returns a list of collection groups. 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/ListCollectionGroupsResponse'
        '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.ListCollectionGroups
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListCollectionGroupsRequest'
      tags:
      - Collection Group
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
    AossServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
        serviceCode:
          type: string
          description: Service Quotas requirement to identify originating service.
        quotaCode:
          type: string
          description: Service Quotas requirement to identify originating quota.
      required:
      - message
      - serviceCode
    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
    BatchGetCollectionGroupRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: A list of collection group IDs. You can't provide names and IDs in the same request.
        names:
          type: array
          items:
            type: string
          description: A list of collection group names. You can't provide names and IDs in the same request.
    BatchGetCollectionGroupResponse:
      type: object
      properties:
        collectionGroupDetails:
          type: array
          items:
            $ref: '#/components/schemas/CollectionGroupDetail'
          description: Details about each collection group.
        collectionGroupErrorDetails:
          type: array
          items:
            $ref: '#/components/schemas/CollectionGroupErrorDetail'
          description: Error information for the request.
    CapacityDetails:
      type: object
      properties:
        capacityInOcu:
          type: number
          description: The current capacity in OpenSearch Compute Units (OCUs).
        autoscalingStatus:
          type: string
          description: The current autoscaling status for the collection group.
    CollectionGroupCapacityLimits:
      type: object
      properties:
        maxIndexingCapacityInOCU:
          type: number
          description: The maximum indexing capacity for collections in the group.
        maxSearchCapacityInOCU:
          type: number
          description: The maximum search capacity for collections in the group.
        minIndexingCapacityInOCU:
          type: number
          description: The minimum indexing capacity for collections in the group.
        minSearchCapacityInOCU:
          type: number
          description: The minimum search capacity for collections in the group.
    CollectionGroupDetail:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection group.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection group.
        name:
          type: string
          description: The name of the collection group.
        standbyReplicas:
          type: string
          description: Indicates whether standby replicas are used for the collection group.
        description:
          type: string
          description: The description of the collection group.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AossTag'
          description: A map of key-value pairs associated with the collection group.
        createdDate:
          type: integer
          description: The Epoch time when the collection group was created.
        capacityLimits:
          $ref: '#/components/schemas/CollectionGroupCapacityLimits'
        currentCapacity:
          $ref: '#/components/schemas/CurrentCapacity'
        numberOfCollections:
          type: integer
          description: The number of collections associated with the collection group.
        generation:
          type: string
          description: The generation of Amazon OpenSearch Serverless for the collection group.
    CollectionGroupErrorDetail:
      type: object
      properties:
        id:
          type: string
          description: If the request contains collection group IDs, the response includes the IDs provided in the request.
        name:
          type: string
          description: If the request contains collection group names, the response includes the names provided in the request.
        errorMessage:
          type: string
          description: A description of the error. For example, The specified Collection Group is not found.
        errorCode:
          type: string
          description: The error code for the request. For example, NOT_FOUND.
    CollectionGroupSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection group.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection group.
        name:
          type: string
          description: The name of the collection group.
        numberOfCollections:
          type: integer
          description: The number of collections within the collection group.
        createdDate:
          type: integer
          description: The Epoch time when the collection group was created.
        capacityLimits:
          $ref: '#/components/schemas/CollectionGroupCapacityLimits'
        generation:
          type: string
          description: The generation of Amazon OpenSearch Serverless for the collection group.
    CreateCollectionGroupDetail:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection group.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection group.
        name:
          type: string
          description: The name of the collection group.
        standbyReplicas:
          type: string
          description: Indicates whether standby replicas are used for the collection group.
        description:
          type: string
          description: The description of the collection group.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AossTag'
          description: A map of key-value pairs associated with the collection group.
        createdDate:
          type: integer
          description: The Epoch time when the collection group was created.
        capacityLimits:
          $ref: '#/components/schemas/CollectionGroupCapacityLimits'
        generation:
          type: string
          description: The generation of Amazon OpenSearch Serverless for the collection group.
    CreateCollectionGroupRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the collection group.
        standbyReplicas:
          type: string
          description: Indicates whether standby replicas should be used for a collection group.
        description:
          type: string
          description: A description of the collection group.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AossTag'
          description: An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.
        capacityLimits:
          $ref: '#/components/schemas/CollectionGroupCapacityLimits'
        generation:
          type: string
          description: The generation of Amazon OpenSearch Serverless for the collection group. Valid values are CLASSIC and
            NEXTGEN.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - name
      - standbyReplicas
    CreateCollectionGroupResponse:
      type: object
      properties:
        createCollectionGroupDetail:
          $ref: '#/components/schemas/CreateCollectionGroupDetail'
    CurrentCapacity:
      type: object
      properties:
        search:
          $ref: '#/components/schemas/CapacityDetails'
        indexing:
          $ref: '#/components/schemas/CapacityDetails'
    DeleteCollectionGroupRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection group to delete.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - id
    DeleteCollectionGroupResponse:
      type: object
      properties: {}
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListCollectionGroupsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: If your initial ListCollectionGroups operation returns a nextToken, you can include the returned nextToken
            in subsequent ListCollectionGroups 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.
    ListCollectionGroupsResponse:
      type: object
      properties:
        collectionGroupSummaries:
          type: array
          items:
            $ref: '#/components/schemas/CollectionGroupSummary'
          description: Details about each collection group.
        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.
    UpdateCollectionGroupDetail:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection group.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the collection group.
        name:
          type: string
          description: The name of the collection group.
        description:
          type: string
          description: The description of the collection group.
        capacityLimits:
          $ref: '#/components/schemas/CollectionGroupCapacityLimits'
        createdDate:
          type: integer
          description: The Epoch time when the collection group was created.
        lastModifiedDate:
          type: integer
          description: The date and time when the collection group was last modified.
        generation:
          type: string
          description: The generation of Amazon OpenSearch Serverless for the collection group.
    UpdateCollectionGroupRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the collection group to update.
        description:
          type: string
          description: A new description for the collection group.
        capacityLimits:
          $ref: '#/components/schemas/CollectionGroupCapacityLimits'
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - id
    UpdateCollectionGroupResponse:
      type: object
      properties:
        updateCollectionGroupDetail:
          $ref: '#/components/schemas/UpdateCollectionGroupDetail'
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)