delete_direct_connect_gateway

DirectConnect.Client.delete_direct_connect_gateway(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_direct_connect_gateway(
    directConnectGatewayId='string'
)

Parameters

directConnectGatewayId (string) --

[REQUIRED]

The ID of the Direct Connect gateway.

Return type

dict

Returns

Response Syntax

{
    'directConnectGateway': {
        'directConnectGatewayId': 'string',
        'directConnectGatewayName': 'string',
        'amazonSideAsn': 123,
        'ownerAccount': 'string',
        'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
        'stateChangeError': 'string'
    }
}

Response Structure

• (dict) --
  • directConnectGateway (dict) --

    The Direct Connect gateway.

    • directConnectGatewayId (string) --

      The ID of the Direct Connect gateway.

    • directConnectGatewayName (string) --

      The name of the Direct Connect gateway.

    • amazonSideAsn (integer) --

      The autonomous system number (ASN) for the Amazon side of the connection.

    • ownerAccount (string) --

      The ID of the Amazon Web Services account that owns the Direct Connect gateway.

    • directConnectGatewayState (string) --

      The state of the Direct Connect gateway. The following are the possible values:

      • pending : The initial state after calling CreateDirectConnectGateway.
      • available : The Direct Connect gateway is ready for use.
      • deleting : The initial state after calling DeleteDirectConnectGateway.
      • deleted : The Direct Connect gateway is deleted and cannot pass traffic.
    • stateChangeError (string) --

      The error message if the state of an object failed to advance.

Exceptions

• DirectConnect.Client.exceptions.DirectConnectServerException
• DirectConnect.Client.exceptions.DirectConnectClientException