delete_outbound_connection

OpenSearchService.Client.delete_outbound_connection(**kwargs)

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

response = client.delete_outbound_connection(
    ConnectionId='string'
)

Parameters

ConnectionId (string) --

[REQUIRED]

The ID of the outbound connection you want to permanently delete.

Return type

dict

Returns

Response Syntax

{
    'Connection': {
        'LocalDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'RemoteDomainInfo': {
            'AWSDomainInformation': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            }
        },
        'ConnectionId': 'string',
        'ConnectionAlias': 'string',
        'ConnectionStatus': {
            'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        },
        'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
        'ConnectionProperties': {
            'Endpoint': 'string'
        }
    }
}

Response Structure

• (dict) --

  Details about the deleted outbound connection.

  • Connection (dict) --

    The deleted inbound connection.

    • LocalDomainInfo (dict) --

      Information about the source (local) domain.

      • AWSDomainInformation (dict) --

        Information about an Amazon OpenSearch Service domain.

        • OwnerId (string) --

          The Amazon Web Services account ID of the domain owner.

        • DomainName (string) --

          Name of the domain.

        • Region (string) --

          The Amazon Web Services Region in which the domain is located.

    • RemoteDomainInfo (dict) --

      Information about the destination (remote) domain.

      • AWSDomainInformation (dict) --

        Information about an Amazon OpenSearch Service domain.

        • OwnerId (string) --

          The Amazon Web Services account ID of the domain owner.

        • DomainName (string) --

          Name of the domain.

        • Region (string) --

          The Amazon Web Services Region in which the domain is located.

    • ConnectionId (string) --

      Unique identifier of the connection.

    • ConnectionAlias (string) --

      Name of the connection.

    • ConnectionStatus (dict) --

      Status of the connection.

      • StatusCode (string) --

        The status code for the outbound connection. 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 the remote domain owner.
        • APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
        • PROVISIONING - Outbound connection request is in process.
        • ACTIVE - Outbound connection is active and ready to use.
        • REJECTING - Outbound connection rejection by remote domain owner is in progress.
        • REJECTED - Outbound connection request is rejected by remote domain owner.
        • DELETING - Outbound connection deletion is in progress.
        • DELETED - Outbound connection is deleted and can no longer be used.
      • Message (string) --

        Verbose information for the outbound connection.

    • ConnectionMode (string) --

      The connection mode.

    • ConnectionProperties (dict) --

      Properties for the outbound connection.

      • Endpoint (string) --

        The endpoint of the remote domain.

Exceptions

• OpenSearchService.Client.exceptions.ResourceNotFoundException
• OpenSearchService.Client.exceptions.DisabledOperationException