CreateCollectionRequest

AnalyticsAmazon Web ServicesElasticsearchSearch

Properties

Name Type Description
name string Name of the collection.
type string The type of collection.
description string Description of the collection.
tags array An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
standbyReplicas string Indicates whether standby replicas should be used for a collection.
vectorOptions object
collectionGroupName string The name of the collection group to associate with the collection.
encryptionConfig object
deletionProtection string Indicates whether to enable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.
clientToken string Unique, case-sensitive identifier to ensure idempotency of the request.
View JSON Schema on GitHub

JSON Schema

amazon-opensearch-create-collection-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-create-collection-request-schema.json",
  "title": "CreateCollectionRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-collection-api-openapi.yml#/components/schemas/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": "#/$defs/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": "#/$defs/VectorOptions"
    },
    "collectionGroupName": {
      "type": "string",
      "description": "The name of the collection group to associate with the collection."
    },
    "encryptionConfig": {
      "$ref": "#/$defs/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"
  ],
  "$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"
      ]
    },
    "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."
        }
      }
    },
    "VectorOptions": {
      "type": "object",
      "properties": {
        "ServerlessVectorAcceleration": {
          "type": "string",
          "description": "Specifies whether serverless vector acceleration is enabled for the collection."
        }
      },
      "required": [
        "ServerlessVectorAcceleration"
      ]
    }
  }
}

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-create-collection-request"
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.