Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DescribeDomainReplication

Describes the replication arrangement that a domain participates in, including the domain's role and the state of its relationship with each peer.

A domain that is not replicating is returned with an empty Peers list and no Role. Returns ResourceNotFoundException if the domain does not exist.

Request Syntax


GET /2021-01-01/opensearch/domain/DomainName/replication HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region.

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DomainArn": "string",
   "Peers": [ 
      { 
         "PeerDomainArn": "string",
         "PeerRole": "string",
         "Status": "string",
         "StatusMessage": "string"
      }
   ],
   "Role": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DomainArn

The Amazon Resource Name (ARN) of the domain described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

Peers

The domains that this domain replicates with. Each entry carries the state of that one relationship. Empty when the domain is not replicating.

Type: Array of ReplicationPeer objects

Role

The domain's role in the arrangement, either PRIMARY or SECONDARY. Absent when the domain is not replicating.

Type: String

Valid Values: PRIMARY | SECONDARY

Errors

For information about the errors that are common to all actions, see Common Error Types.

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeDomainReplication.

Sample Request



GET /2021-01-01/opensearch/domain/my-primary/replication HTTP/1.1
Host: es.us-east-1.amazonaws.com

Sample Response



HTTP/1.1 200 OK
Content-Type: application/json

{
  "DomainArn": "arn:aws:es:us-east-1:123456789012:domain/my-primary",
  "Role": "PRIMARY",
  "Peers": [
    {
      "PeerDomainArn": "arn:aws:es:us-west-2:123456789012:domain/my-secondary",
      "PeerRole": "SECONDARY",
      "Status": "ACTIVE"
    }
  ]
}