DescribeDomainReplicationResponse

AnalyticsAmazon Web ServicesElasticsearchSearch

Properties

Name Type Description
DomainArn string The Amazon Resource Name (ARN) of the domain described.
Role string The domain's role in the arrangement, either PRIMARY or SECONDARY. Absent when the domain is not replicating.
Peers array The domains that this domain replicates with. Each entry carries the state of that one relationship. Empty when the domain is not replicating.
View JSON Schema on GitHub

JSON Schema

amazon-opensearch-describe-domain-replication-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-describe-domain-replication-response-schema.json",
  "title": "DescribeDomainReplicationResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-replication-api-openapi.yml#/components/schemas/DescribeDomainReplicationResponse",
  "type": "object",
  "properties": {
    "DomainArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the domain described."
    },
    "Role": {
      "type": "string",
      "enum": [
        "PRIMARY",
        "SECONDARY"
      ],
      "description": "The domain's role in the arrangement, either PRIMARY or SECONDARY. Absent when the domain is not replicating."
    },
    "Peers": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ReplicationPeer"
      },
      "description": "The domains that this domain replicates with. Each entry carries the state of that one relationship. Empty when the domain is not replicating."
    }
  },
  "$defs": {
    "ReplicationPeer": {
      "type": "object",
      "properties": {
        "PeerDomainArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the peer domain."
        },
        "PeerRole": {
          "type": "string",
          "enum": [
            "PRIMARY",
            "SECONDARY"
          ],
          "description": "The peer's role in the relationship, either PRIMARY or SECONDARY."
        },
        "Status": {
          "type": "string",
          "enum": [
            "PENDING_SETUP",
            "ACTIVE",
            "SWITCHING_OVER",
            "FAILING_OVER",
            "PENDING_REMOVAL",
            "DETACHED",
            "EJECTED",
            "FAILED"
          ],
          "description": "The state of the relationship: PENDING_SETUP - replication is being established. ACTIVE - replication is running. SWITCHING_OVER - a planned promotion is in progress. FAILING_OVER - an unplanned promotion is in progress. PENDING_REMOVAL - replication is being stopped. DETACHED - the relationship has ended. EJECTED - a failover promoted the other domain. The former primary keeps the data it had when it was ejected and stays read-only until you remove the peer, or discard that data and pair again. FAILED - setup or teardown could not complete. You can still remove the relationship. A relationshi"
        },
        "StatusMessage": {
          "type": "string",
          "description": "An explanation of why the relationship is in its current state, when more detail is available."
        }
      }
    }
  }
}

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-describe-domain-replication-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.