OpenSearchService / Client / describe_domain_replication

describe_domain_replication

OpenSearchService.Client.describe_domain_replication(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_replication(
    DomainName='string'
)
Parameters:

DomainName (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DomainArn': 'string',
    'Role': 'PRIMARY'|'SECONDARY',
    'Peers': [
        {
            'PeerDomainArn': 'string',
            'PeerRole': 'PRIMARY'|'SECONDARY',
            'Status': 'PENDING_SETUP'|'ACTIVE'|'SWITCHING_OVER'|'FAILING_OVER'|'PENDING_REMOVAL'|'DETACHED'|'EJECTED'|'FAILED',
            'StatusMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • 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 (list) –

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

      • (dict) –

        A domain that another domain replicates with, and the state of that relationship.

        • PeerDomainArn (string) –

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

        • PeerRole (string) –

          The peer’s role in the relationship, either PRIMARY or SECONDARY.

        • Status (string) –

          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 relationship that is removed successfully no longer appears in Peers.

        • StatusMessage (string) –

          An explanation of why the relationship is in its current state, when more detail is available.

Exceptions