DeleteConnectPeerCommand

Suggest an Edit

Deletes a Connect peer.

Example Syntax

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

import { NetworkManagerClient, DeleteConnectPeerCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import
// const { NetworkManagerClient, DeleteConnectPeerCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import
const client = new NetworkManagerClient(config);
const input = { // DeleteConnectPeerRequest
  ConnectPeerId: "STRING_VALUE", // required
};
const command = new DeleteConnectPeerCommand(input);
const response = await client.send(command);
// { // DeleteConnectPeerResponse
//   ConnectPeer: { // ConnectPeer
//     CoreNetworkId: "STRING_VALUE",
//     ConnectAttachmentId: "STRING_VALUE",
//     ConnectPeerId: "STRING_VALUE",
//     EdgeLocation: "STRING_VALUE",
//     State: "CREATING" || "FAILED" || "AVAILABLE" || "DELETING",
//     CreatedAt: new Date("TIMESTAMP"),
//     Configuration: { // ConnectPeerConfiguration
//       CoreNetworkAddress: "STRING_VALUE",
//       PeerAddress: "STRING_VALUE",
//       InsideCidrBlocks: [ // ConstrainedStringList
//         "STRING_VALUE",
//       ],
//       Protocol: "GRE" || "NO_ENCAP",
//       BgpConfigurations: [ // ConnectPeerBgpConfigurationList
//         { // ConnectPeerBgpConfiguration
//           CoreNetworkAsn: Number("long"),
//           PeerAsn: Number("long"),
//           CoreNetworkAddress: "STRING_VALUE",
//           PeerAddress: "STRING_VALUE",
//         },
//       ],
//     },
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     SubnetArn: "STRING_VALUE",
//     LastModificationErrors: [ // ConnectPeerErrorList
//       { // ConnectPeerError
//         Code: "EDGE_LOCATION_NO_FREE_IPS" || "EDGE_LOCATION_PEER_DUPLICATE" || "SUBNET_NOT_FOUND" || "IP_OUTSIDE_SUBNET_CIDR_RANGE" || "INVALID_INSIDE_CIDR_BLOCK" || "NO_ASSOCIATED_CIDR_BLOCK",
//         Message: "STRING_VALUE",
//         ResourceArn: "STRING_VALUE",
//         RequestId: "STRING_VALUE",
//       },
//     ],
//   },
// };

DeleteConnectPeerCommand Input

See DeleteConnectPeerCommandInput for more details

Parameter
Type
Description
ConnectPeerId
Required
string | undefined

The ID of the deleted Connect peer.

DeleteConnectPeerCommand Output

See DeleteConnectPeerCommandOutput for details

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

Information about the deleted Connect peer.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

InternalServerException
server

The request has failed due to an internal error.

ResourceNotFoundException
client

The specified resource could not be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints.

NetworkManagerServiceException
Base exception class for all service exceptions from NetworkManager service.