DirectConnect / Client / delete_direct_connect_gateway_association

delete_direct_connect_gateway_association

DirectConnect.Client.delete_direct_connect_gateway_association(**kwargs)

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

See also: AWS API Documentation

Request Syntax

response = client.delete_direct_connect_gateway_association(
    associationId='string',
    directConnectGatewayId='string',
    virtualGatewayId='string'
)

Parameters:

• associationId (string) – The ID of the Direct Connect gateway association.

• directConnectGatewayId (string) – The ID of the Direct Connect gateway.

• virtualGatewayId (string) – The ID of the virtual private gateway.

Return type:

dict

Returns:

Response Syntax

{
    'directConnectGatewayAssociation': {
        'directConnectGatewayId': 'string',
        'directConnectGatewayOwnerAccount': 'string',
        'associationState': 'associating'|'associated'|'disassociating'|'disassociated'|'updating',
        'stateChangeError': 'string',
        'associatedGateway': {
            'id': 'string',
            'type': 'virtualPrivateGateway'|'transitGateway',
            'ownerAccount': 'string',
            'region': 'string'
        },
        'associationId': 'string',
        'allowedPrefixesToDirectConnectGateway': [
            {
                'cidr': 'string'
            },
        ],
        'virtualGatewayId': 'string',
        'virtualGatewayRegion': 'string',
        'virtualGatewayOwnerAccount': 'string'
    }
}

Response Structure

• (dict) –

  • directConnectGatewayAssociation (dict) –

    Information about the deleted association.

    • directConnectGatewayId (string) –

      The ID of the Direct Connect gateway.

    • directConnectGatewayOwnerAccount (string) –

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

    • associationState (string) –

      The state of the association. The following are the possible values:

      • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

      • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

      • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

      • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

      • updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.

    • stateChangeError (string) –

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

    • associatedGateway (dict) –

      Information about the associated gateway.

      • id (string) –

        The ID of the associated gateway.

      • type (string) –

        The type of associated gateway.

      • ownerAccount (string) –

        The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

      • region (string) –

        The Region where the associated gateway is located.

    • associationId (string) –

      The ID of the Direct Connect gateway association.

    • allowedPrefixesToDirectConnectGateway (list) –

      The Amazon VPC prefixes to advertise to the Direct Connect gateway.

      • (dict) –

        Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

        • cidr (string) –

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

    • virtualGatewayId (string) –

      The ID of the virtual private gateway. Applies only to private virtual interfaces.

    • virtualGatewayRegion (string) –

      The Amazon Web Services Region where the virtual private gateway is located.

    • virtualGatewayOwnerAccount (string) –

      The ID of the Amazon Web Services account that owns the virtual private gateway.

Exceptions

• DirectConnect.Client.exceptions.DirectConnectServerException

• DirectConnect.Client.exceptions.DirectConnectClientException