Skip to content

delete_local_gateway_virtual_interface_group

delete_local_gateway_virtual_interface_group(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    local_gateway_virtual_interface_group_id: Optional[
        LocalGatewayVirtualInterfaceGroupId
    ] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteLocalGatewayVirtualInterfaceGroupResult

Delete the specified local gateway interface group.

Parameters:

  • local_gateway_virtual_interface_group_id (Optional[LocalGatewayVirtualInterfaceGroupId], default: None ) –

    The ID of the local gateway virtual interface group to delete.

  • dry_run (Optional[Boolean], default: None ) –

    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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def delete_local_gateway_virtual_interface_group(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    local_gateway_virtual_interface_group_id: Optional[
        "capo_ec2.types.local_gateway_virtual_interface_group_id.LocalGatewayVirtualInterfaceGroupId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_local_gateway_virtual_interface_group_result.DeleteLocalGatewayVirtualInterfaceGroupResult":
    """<p>Delete the specified local gateway interface group.</p>

    Args:
        local_gateway_virtual_interface_group_id: <p>The ID of the local gateway virtual interface group to delete.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_local_gateway_virtual_interface_group_request.DeleteLocalGatewayVirtualInterfaceGroupRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_local_gateway_virtual_interface_group_result.DeleteLocalGatewayVirtualInterfaceGroupResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_local_gateway_virtual_interface_group

        output, http_response = (
            capo_ec2._operations.amazon_ec2.delete_local_gateway_virtual_interface_group.delete_local_gateway_virtual_interface_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteLocalGatewayVirtualInterfaceGroup"),
    )
    input_: capo_ec2.types.delete_local_gateway_virtual_interface_group_request.DeleteLocalGatewayVirtualInterfaceGroupRequest = {}
    if local_gateway_virtual_interface_group_id is not None:
        input_["local_gateway_virtual_interface_group_id"] = (
            local_gateway_virtual_interface_group_id
        )
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output