BatchGetCollectionGroupResponse

AnalyticsAmazon Web ServicesElasticsearchSearch

Properties

Name Type Description
collectionGroupDetails array Details about each collection group.
collectionGroupErrorDetails array Error information for the request.
View JSON Schema on GitHub

JSON Schema

amazon-opensearch-batch-get-collection-group-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-batch-get-collection-group-response-schema.json",
  "title": "BatchGetCollectionGroupResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-collection-group-api-openapi.yml#/components/schemas/BatchGetCollectionGroupResponse",
  "type": "object",
  "properties": {
    "collectionGroupDetails": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CollectionGroupDetail"
      },
      "description": "Details about each collection group."
    },
    "collectionGroupErrorDetails": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CollectionGroupErrorDetail"
      },
      "description": "Error information for the request."
    }
  },
  "$defs": {
    "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"
      ]
    },
    "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": "#/$defs/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": "#/$defs/CollectionGroupCapacityLimits"
        },
        "currentCapacity": {
          "$ref": "#/$defs/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."
        }
      }
    },
    "CurrentCapacity": {
      "type": "object",
      "properties": {
        "search": {
          "$ref": "#/$defs/CapacityDetails"
        },
        "indexing": {
          "$ref": "#/$defs/CapacityDetails"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-batch-get-collection-group-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.