EC2 / Client / detach_network_interface

detach_network_interface#

EC2.Client.detach_network_interface(**kwargs)#

Detaches a network interface from an instance.

See also: AWS API Documentation

Request Syntax

response = client.detach_network_interface(
    DryRun=True|False,
    AttachmentId='string',
    Force=True|False
)
Parameters:

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

  • AttachmentId (string) –

    [REQUIRED]

    The ID of the attachment.

  • Force (boolean) –

    Specifies whether to force a detachment.

    Note

    • Use the Force parameter only as a last resort to detach a network interface from a failed instance.

    • If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

    • If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.

Returns:

None

Examples

This example detaches the specified network interface from its attached instance.

response = client.detach_network_interface(
    AttachmentId='eni-attach-66c4350a',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}