Skip to content

detach_network_interface

Operation

detach_network_interface

detach_network_interface(request: DetachNetworkInterfaceInput | DetachNetworkInterfaceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DetachNetworkInterfaceInputDict]) -> DetachNetworkInterfaceOutput

Detaches a network interface from an instance.

Parameters:

Name Type Description Default
request DetachNetworkInterfaceInput | DetachNetworkInterfaceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DetachNetworkInterfaceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DetachNetworkInterfaceOutput

An instance of DetachNetworkInterfaceOutput.

detach_network_interface async

detach_network_interface(request: DetachNetworkInterfaceInput | DetachNetworkInterfaceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DetachNetworkInterfaceInputDict]) -> DetachNetworkInterfaceOutput

Detaches a network interface from an instance.

Parameters:

Name Type Description Default
request DetachNetworkInterfaceInput | DetachNetworkInterfaceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DetachNetworkInterfaceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DetachNetworkInterfaceOutput

An instance of DetachNetworkInterfaceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DetachNetworkInterfaceInputDict

Bases: TypedDict

Dictionary form of DetachNetworkInterfaceInput.

Attributes

attachment_id instance-attribute
attachment_id: Required[str]

The ID of the attachment.

dry_run instance-attribute
dry_run: bool | 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.

force instance-attribute
force: bool | None

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.

DetachNetworkInterfaceInput dataclass

Bases: _SerdeShape

Contains the parameters for DetachNetworkInterface.

Attributes

attachment_id class-attribute instance-attribute
attachment_id: str | None = ...

The ID of the attachment.

dry_run class-attribute instance-attribute
dry_run: bool | 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.

force class-attribute instance-attribute
force: bool | None = ...

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.

Output

DetachNetworkInterfaceOutput dataclass

Bases: _SerdeShape

Dataclass for DetachNetworkInterfaceOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.