OpenSearchService / Client / remove_replication_peer

remove_replication_peer

OpenSearchService.Client.remove_replication_peer(**kwargs)

Stops replicating a domain to its peer. Replication ends for both domains, and each domain keeps the data it holds at that point. Neither domain is deleted.

See also: AWS API Documentation

Request Syntax

response = client.remove_replication_peer(
    DomainName='string',
    PeerDomainArn='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.

  • PeerDomainArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the peer to stop replicating with. Both domains are named so that the request identifies exactly one replication relationship.

Return type:

dict

Returns:

Response Syntax

{
    'DomainArn': 'string',
    'Status': 'PENDING_SETUP'|'ACTIVE'|'SWITCHING_OVER'|'FAILING_OVER'|'PENDING_REMOVAL'|'DETACHED'|'EJECTED'|'FAILED'
}

Response Structure

  • (dict) –

    • DomainArn (string) –

      The Amazon Resource Name (ARN) of the domain that is no longer replicating.

    • Status (string) –

      The state of the replication relationship. This is PENDING_REMOVAL while replication is being stopped.

Exceptions