Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteOutboundConnection

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.

Request Syntax


DELETE /2021-01-01/opensearch/cc/outboundConnection/ConnectionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConnectionId

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

Length Constraints: Minimum length of 10. Maximum length of 256.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Connection": { 
      "ConnectionAlias": "string",
      "ConnectionId": "string",
      "ConnectionMode": "string",
      "ConnectionProperties": { 
         "CrossClusterSearch": { 
            "SkipUnavailable": "string"
         },
         "Endpoint": "string"
      },
      "ConnectionStatus": { 
         "Message": "string",
         "StatusCode": "string"
      },
      "LocalDomainInfo": { 
         "AWSDomainInformation": { 
            "DomainName": "string",
            "OwnerId": "string",
            "Region": "string"
         }
      },
      "RemoteDomainInfo": { 
         "AWSDomainInformation": { 
            "DomainName": "string",
            "OwnerId": "string",
            "Region": "string"
         }
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Connection

The deleted inbound connection.

Type: OutboundConnection object

Errors

For information about the errors that are common to all actions, see Common Errors.

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409