Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class DeleteDirectConnectGatewayCommandProtected

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.

Example

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

import { DirectConnectClient, DeleteDirectConnectGatewayCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, DeleteDirectConnectGatewayCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // DeleteDirectConnectGatewayRequest
directConnectGatewayId: "STRING_VALUE", // required
};
const command = new DeleteDirectConnectGatewayCommand(input);
const response = await client.send(command);
// { // DeleteDirectConnectGatewayResult
// directConnectGateway: { // DirectConnectGateway
// directConnectGatewayId: "STRING_VALUE",
// directConnectGatewayName: "STRING_VALUE",
// amazonSideAsn: Number("long"),
// ownerAccount: "STRING_VALUE",
// directConnectGatewayState: "pending" || "available" || "deleting" || "deleted",
// stateChangeError: "STRING_VALUE",
// },
// };

Param

DeleteDirectConnectGatewayCommandInput

Returns

DeleteDirectConnectGatewayCommandOutput

See

Throws

DirectConnectClientException (client fault)

One or more parameters are not valid.

Throws

DirectConnectServerException (server fault)

A server-side error occurred.

Throws

DirectConnectServiceException

Base exception class for all service exceptions from DirectConnect service.

Hierarchy

Constructors

Properties

Methods