OpenSearchService / Client / delete_inbound_connection

delete_inbound_connection#

OpenSearchService.Client.delete_inbound_connection(**kwargs)#

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound 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_inbound_connection(
    ConnectionId='string'
)
Parameters:

ConnectionId (string) –

[REQUIRED]

The ID of the inbound connection 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',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        },
        'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
    }
}

Response Structure

  • (dict) –

    The results of a DeleteInboundConnection operation. Contains details about the deleted inbound 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) –

        The unique identifier of the connection.

      • ConnectionStatus (dict) –

        The current status of the connection.

        • StatusCode (string) –

          The status code for the connection. Can be one of the following:

          • PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.

          • APPROVED: Inbound connection is pending acceptance by the remote domain owner.

          • PROVISIONING: Inbound connection is being provisioned.

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

          • REJECTING: Inbound connection rejection is in process.

          • REJECTED: Inbound connection is rejected.

          • DELETING: Inbound connection deletion is in progress.

          • DELETED: Inbound connection is deleted and can no longer be used.

        • Message (string) –

          Information about the connection.

      • ConnectionMode (string) –

        The connection mode.

Exceptions

  • OpenSearchService.Client.exceptions.ResourceNotFoundException

  • OpenSearchService.Client.exceptions.DisabledOperationException