DeleteInboundConnectionCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { OpenSearchClient, DeleteInboundConnectionCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, DeleteInboundConnectionCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // DeleteInboundConnectionRequest
  ConnectionId: "STRING_VALUE", // required
};
const command = new DeleteInboundConnectionCommand(input);
const response = await client.send(command);
// { // DeleteInboundConnectionResponse
//   Connection: { // InboundConnection
//     LocalDomainInfo: { // DomainInformationContainer
//       AWSDomainInformation: { // AWSDomainInformation
//         OwnerId: "STRING_VALUE",
//         DomainName: "STRING_VALUE", // required
//         Region: "STRING_VALUE",
//       },
//     },
//     RemoteDomainInfo: {
//       AWSDomainInformation: {
//         OwnerId: "STRING_VALUE",
//         DomainName: "STRING_VALUE", // required
//         Region: "STRING_VALUE",
//       },
//     },
//     ConnectionId: "STRING_VALUE",
//     ConnectionStatus: { // InboundConnectionStatus
//       StatusCode: "PENDING_ACCEPTANCE" || "APPROVED" || "PROVISIONING" || "ACTIVE" || "REJECTING" || "REJECTED" || "DELETING" || "DELETED",
//       Message: "STRING_VALUE",
//     },
//     ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
//   },
// };

DeleteInboundConnectionCommand Input

See DeleteInboundConnectionCommandInput for more details

Parameter
Type
Description
ConnectionId
Required
string | undefined

The ID of the inbound connection to permanently delete.

DeleteInboundConnectionCommand Output

See DeleteInboundConnectionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Connection
InboundConnection | undefined

The deleted inbound connection.

Throws

Name
Fault
Details
DisabledOperationException
client

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

ResourceNotFoundException
client

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

OpenSearchServiceException
Base exception class for all service exceptions from OpenSearch service.