ElasticsearchService / Client / delete_outbound_cross_cluster_search_connection

delete_outbound_cross_cluster_search_connection#

ElasticsearchService.Client.delete_outbound_cross_cluster_search_connection(**kwargs)#

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

See also: AWS API Documentation

Request Syntax

response = client.delete_outbound_cross_cluster_search_connection(
    CrossClusterSearchConnectionId='string'
)
Parameters:

CrossClusterSearchConnectionId (string) –

[REQUIRED]

The id of the outbound connection that you want to permanently delete.

Return type:

dict

Returns:

Response Syntax

{
    'CrossClusterSearchConnection': {
        'SourceDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'DestinationDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'CrossClusterSearchConnectionId': 'string',
        'ConnectionAlias': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

  • (dict) –

    The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection.

    • CrossClusterSearchConnection (dict) –

      Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

      • SourceDomainInfo (dict) –

        Specifies the DomainInformation for the source Elasticsearch domain.

        • OwnerId (string) –

        • DomainName (string) –

          The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • Region (string) –

      • DestinationDomainInfo (dict) –

        Specifies the DomainInformation for the destination Elasticsearch domain.

        • OwnerId (string) –

        • DomainName (string) –

          The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • Region (string) –

      • CrossClusterSearchConnectionId (string) –

        Specifies the connection id for the outbound cross-cluster search connection.

      • ConnectionAlias (string) –

        Specifies the connection alias for the outbound cross-cluster search connection.

      • ConnectionStatus (dict) –

        Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

        • StatusCode (string) –

          The state code for outbound connection. This can be one of the following:

          • VALIDATING: The outbound connection request is being validated.

          • VALIDATION_FAILED: Validation failed for the connection request.

          • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by destination domain owner.

          • PROVISIONING: Outbound connection request is in process.

          • ACTIVE: Outbound connection is active and ready to use.

          • REJECTED: Outbound connection request is rejected by destination domain owner.

          • DELETING: Outbound connection deletion is in progress.

          • DELETED: Outbound connection is deleted and cannot be used further.

        • Message (string) –

          Specifies verbose information for the outbound connection status.

Exceptions