EC2 / Client / delete_local_gateway_virtual_interface

delete_local_gateway_virtual_interface

EC2.Client.delete_local_gateway_virtual_interface(**kwargs)

Deletes the specified local gateway virtual interface.

See also: AWS API Documentation

Request Syntax

response = client.delete_local_gateway_virtual_interface(
    LocalGatewayVirtualInterfaceId='string',
    DryRun=True|False
)
Parameters:

  • LocalGatewayVirtualInterfaceId (string) –

    [REQUIRED]

    The ID of the local virtual interface to delete.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'LocalGatewayVirtualInterface': {
        'LocalGatewayVirtualInterfaceId': 'string',
        'LocalGatewayId': 'string',
        'LocalGatewayVirtualInterfaceGroupId': 'string',
        'LocalGatewayVirtualInterfaceArn': 'string',
        'OutpostLagId': 'string',
        'Vlan': 123,
        'LocalAddress': 'string',
        'PeerAddress': 'string',
        'LocalBgpAsn': 123,
        'PeerBgpAsn': 123,
        'PeerBgpAsnExtended': 123,
        'OwnerId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
    }
}

Response Structure

  • (dict) –

    • LocalGatewayVirtualInterface (dict) –

      Information about the deleted local gateway virtual interface.

      • LocalGatewayVirtualInterfaceId (string) –

        The ID of the virtual interface.

      • LocalGatewayId (string) –

        The ID of the local gateway.

      • LocalGatewayVirtualInterfaceGroupId (string) –

        The ID of the local gateway virtual interface group.

      • LocalGatewayVirtualInterfaceArn (string) –

        The Amazon Resource Number (ARN) of the local gateway virtual interface.

      • OutpostLagId (string) –

        The Outpost LAG ID.

      • Vlan (integer) –

        The ID of the VLAN.

      • LocalAddress (string) –

        The local address.

      • PeerAddress (string) –

        The peer address.

      • LocalBgpAsn (integer) –

        The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

      • PeerBgpAsn (integer) –

        The peer BGP ASN.

      • PeerBgpAsnExtended (integer) –

        The extended 32-bit ASN of the BGP peer for use with larger ASN values.

      • OwnerId (string) –

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

      • Tags (list) –

        The tags assigned to the virtual interface.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • ConfigurationState (string) –

        The current state of the local gateway virtual interface.