EC2 / Client / delete_local_gateway_virtual_interface_group

delete_local_gateway_virtual_interface_group

EC2.Client.delete_local_gateway_virtual_interface_group(**kwargs)

Delete the specified local gateway interface group.

See also: AWS API Documentation

Request Syntax

response = client.delete_local_gateway_virtual_interface_group(
    LocalGatewayVirtualInterfaceGroupId='string',
    DryRun=True|False
)
Parameters:

  • LocalGatewayVirtualInterfaceGroupId (string) –

    [REQUIRED]

    The ID of the local gateway virtual interface group 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

{
    'LocalGatewayVirtualInterfaceGroup': {
        'LocalGatewayVirtualInterfaceGroupId': 'string',
        'LocalGatewayVirtualInterfaceIds': [
            'string',
        ],
        'LocalGatewayId': 'string',
        'OwnerId': 'string',
        'LocalBgpAsn': 123,
        'LocalBgpAsnExtended': 123,
        'LocalGatewayVirtualInterfaceGroupArn': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted'
    }
}

Response Structure

  • (dict) –

    • LocalGatewayVirtualInterfaceGroup (dict) –

      Information about the deleted local gateway virtual interface group.

      • LocalGatewayVirtualInterfaceGroupId (string) –

        The ID of the virtual interface group.

      • LocalGatewayVirtualInterfaceIds (list) –

        The IDs of the virtual interfaces.

        • (string) –

      • LocalGatewayId (string) –

        The ID of the local gateway.

      • OwnerId (string) –

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

      • LocalBgpAsn (integer) –

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

      • LocalBgpAsnExtended (integer) –

        The extended 32-bit ASN for the local BGP configuration.

      • LocalGatewayVirtualInterfaceGroupArn (string) –

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

      • Tags (list) –

        The tags assigned to the virtual interface group.

        • (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 group.