CreatePackageRequest

AnalyticsAmazon Web ServicesElasticsearchSearch

Properties

Name Type Description
PackageName string Unique name for the package.
PackageType string The type of package.
PackageDescription string Description of the package.
PackageSource object
PackageConfiguration object
EngineVersion string The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN
PackageVendingOptions object
PackageEncryptionOptions object
View JSON Schema on GitHub

JSON Schema

amazon-opensearch-create-package-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-package-request-schema.json",
  "title": "CreatePackageRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-packages-api-openapi.yml#/components/schemas/CreatePackageRequest",
  "type": "object",
  "properties": {
    "PackageName": {
      "type": "string",
      "description": "Unique name for the package."
    },
    "PackageType": {
      "type": "string",
      "enum": [
        "TXT-DICTIONARY",
        "ZIP-PLUGIN",
        "PACKAGE-LICENSE",
        "PACKAGE-CONFIG"
      ],
      "description": "The type of package."
    },
    "PackageDescription": {
      "type": "string",
      "description": "Description of the package."
    },
    "PackageSource": {
      "$ref": "#/$defs/PackageSource"
    },
    "PackageConfiguration": {
      "$ref": "#/$defs/PackageConfiguration"
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN"
    },
    "PackageVendingOptions": {
      "$ref": "#/$defs/PackageVendingOptions"
    },
    "PackageEncryptionOptions": {
      "$ref": "#/$defs/PackageEncryptionOptions"
    }
  },
  "required": [
    "PackageName",
    "PackageType",
    "PackageSource"
  ],
  "$defs": {
    "PackageConfiguration": {
      "type": "object",
      "properties": {
        "LicenseRequirement": {
          "type": "string",
          "enum": [
            "REQUIRED",
            "OPTIONAL",
            "NONE"
          ],
          "description": "The license requirements for the package."
        },
        "LicenseFilepath": {
          "type": "string",
          "description": "The relative file path for the license associated with the package."
        },
        "ConfigurationRequirement": {
          "type": "string",
          "enum": [
            "REQUIRED",
            "OPTIONAL",
            "NONE"
          ],
          "description": "The configuration requirements for the package."
        },
        "RequiresRestartForConfigurationUpdate": {
          "type": "boolean",
          "description": "This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for."
        }
      },
      "required": [
        "LicenseRequirement",
        "ConfigurationRequirement"
      ]
    },
    "PackageEncryptionOptions": {
      "type": "object",
      "properties": {
        "KmsKeyIdentifier": {
          "type": "string",
          "description": "KMS key ID for encrypting the package."
        },
        "EncryptionEnabled": {
          "type": "boolean",
          "description": "Whether encryption is enabled for the package."
        }
      },
      "required": [
        "EncryptionEnabled"
      ]
    },
    "PackageSource": {
      "type": "object",
      "properties": {
        "S3BucketName": {
          "type": "string",
          "description": "The name of the Amazon S3 bucket containing the package."
        },
        "S3Key": {
          "type": "string",
          "description": "Key (file name) of the package."
        }
      }
    },
    "PackageVendingOptions": {
      "type": "object",
      "properties": {
        "VendingEnabled": {
          "type": "boolean",
          "description": "Indicates whether the package vending feature is enabled, allowing the package to be used by other users."
        }
      },
      "required": [
        "VendingEnabled"
      ]
    }
  }
}

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