Amazon OpenSearch Service API · JSON Structure

Openapi Describe Elasticsearch Domains Request Structure

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

Type: object Properties: 1 Required: 1

AnalyticsElasticsearchSearch

DescribeElasticsearchDomainsRequest is a JSON Structure definition published by Amazon OpenSearch Service API, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DomainNames

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-structure/openapi-describe-elasticsearch-domains-request-structure.json",
  "name": "DescribeElasticsearchDomainsRequest",
  "description": "Container for the parameters to the <code><a>DescribeElasticsearchDomains</a></code> operation. By default, the API returns the status of all Elasticsearch domains.",
  "type": "object",
  "properties": {
    "DomainNames": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainNameList"
        },
        {
          "description": "The Elasticsearch domains for which you want information."
        }
      ]
    }
  },
  "required": [
    "DomainNames"
  ]
}