Skip to content

delete_network_interface

delete_network_interface(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    network_interface_id: Optional[NetworkInterfaceId] = None,
) -> None

Deletes the specified network interface. You must detach the network interface before you can delete it.

Parameters:

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

  • network_interface_id (Optional[NetworkInterfaceId], default: None ) –

    The ID of the network interface.

Raises:

Examples:

To delete a network interface This example deletes the specified network interface.

>>> client.delete_network_interface(network_interface_id='eni-e5aa89a3')
Source code in docs_src/capo_ec2/_services/ec2.py
def delete_network_interface(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    network_interface_id: Optional[
        "capo_ec2.types.network_interface_id.NetworkInterfaceId"
    ] = None,
) -> None:
    """<p>Deletes the specified network interface. You must detach the network interface before you can delete it.</p>

    Args:
        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>
        network_interface_id: <p>The ID of the network interface.</p>

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

    Examples:
        To delete a network interface
        This example deletes the specified network interface.

        >>> client.delete_network_interface(network_interface_id='eni-e5aa89a3')
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_network_interface_request.DeleteNetworkInterfaceRequest]",
    ) -> OperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.delete_network_interface

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteNetworkInterface")
    )
    input_: capo_ec2.types.delete_network_interface_request.DeleteNetworkInterfaceRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if network_interface_id is not None:
        input_["network_interface_id"] = network_interface_id

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