Skip to content

DetachVolumeRequest

Source code in docs_src/capo_ec2/types/detach_volume_request.py
class DetachVolumeRequest(TypedDict, closed=True):
    device: NotRequired["capo_ec2.types.string.String"]
    """<p>The device name.</p>"""
    force: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.</p>"""
    instance_id: NotRequired[
        "capo_ec2.types.instance_id_for_resolver.InstanceIdForResolver"
    ]
    """<p>The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.</p>"""
    volume_id: NotRequired[
        "capo_ec2.types.volume_id_with_resolver.VolumeIdWithResolver"
    ]
    """<p>The ID of the volume.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<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>"""

device instance-attribute

device: NotRequired[String]

The device name.

dry_run instance-attribute

dry_run: NotRequired[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.

force instance-attribute

force: NotRequired[Boolean]

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

instance_id instance-attribute

instance_id: NotRequired[InstanceIdForResolver]

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

volume_id instance-attribute

volume_id: NotRequired[VolumeIdWithResolver]

The ID of the volume.