EC2 / Client / detach_volume

detach_volume#

EC2.Client.detach_volume(**kwargs)#

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can’t be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

You can’t detach or force detach volumes that are attached to Amazon ECS or Fargate tasks. Attempting to do this results in the UnsupportedOperationException exception with the Unable to detach volume attached to ECS tasks error message.

For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

Request Syntax

response = client.detach_volume(
    Device='string',
    Force=True|False,
    InstanceId='string',
    VolumeId='string',
    DryRun=True|False
)

Parameters:

Device (string) – The device name.
Force (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.
InstanceId (string) – The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
VolumeId (string) –
[REQUIRED]

The ID of the volume.
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.

Return type:

dict

Returns:

Response Syntax

{
    'AttachTime': datetime(2015, 1, 1),
    'Device': 'string',
    'InstanceId': 'string',
    'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
    'VolumeId': 'string',
    'DeleteOnTermination': True|False,
    'AssociatedResource': 'string',
    'InstanceOwningService': 'string'
}

Response Structure

(dict) –

Describes volume attachment details.
- AttachTime (datetime) –
  
  The time stamp when the attachment initiated.
- Device (string) –
  
  The device name.
  
  If the volume is attached to a Fargate task, this parameter returns null.
- InstanceId (string) –
  
  The ID of the instance.
  
  If the volume is attached to a Fargate task, this parameter returns null.
- State (string) –
  
  The attachment state of the volume.
- VolumeId (string) –
  
  The ID of the volume.
- DeleteOnTermination (boolean) –
  
  Indicates whether the EBS volume is deleted on instance termination.
- AssociatedResource (string) –
  
  The ARN of the Amazon ECS or Fargate task to which the volume is attached.
- InstanceOwningService (string) –
  
  The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.
  
  This parameter is returned only for volumes that are attached to Fargate tasks.

Examples

This example detaches the volume (vol-049df61146c4d7901) from the instance it is attached to.

response = client.detach_volume(
    VolumeId='vol-1234567890abcdef0',
)

print(response)

Expected Output:

{
    'AttachTime': datetime(2014, 2, 27, 19, 23, 6, 3, 58, 0),
    'Device': '/dev/sdb',
    'InstanceId': 'i-1234567890abcdef0',
    'State': 'detaching',
    'VolumeId': 'vol-049df61146c4d7901',
    'ResponseMetadata': {
        '...': '...',
    },
}