DETACHVOLUME()`¶

About DetachVolume¶

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 EBS User Guide.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_volumeid` `TYPE /AWS1/EC2VOLUMEIDWITHRESOLVER` `/AWS1/EC2VOLUMEIDWITHRESOLVER`¶

The ID of the volume.

Optional arguments:¶

`iv_device` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The device name.

`iv_force` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

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.

`iv_instanceid` `TYPE /AWS1/EC2INSTANCEIDFORRESOLVER` `/AWS1/EC2INSTANCEIDFORRESOLVER`¶

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

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2volumeattachment` `/AWS1/CL_EC2VOLUMEATTACHMENT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_ec2~detachvolume(
  iv_device = |string|
  iv_dryrun = ABAP_TRUE
  iv_force = ABAP_TRUE
  iv_instanceid = |string|
  iv_volumeid = |string|
).

This is an example of reading all possible response values

lv_boolean = lo_result->get_deleteontermination( ).
lv_string = lo_result->get_associatedresource( ).
lv_string = lo_result->get_instanceowningservice( ).
lv_string = lo_result->get_volumeid( ).
lv_string = lo_result->get_instanceid( ).
lv_string = lo_result->get_device( ).
lv_volumeattachmentstate = lo_result->get_state( ).
lv_datetime = lo_result->get_attachtime( ).

To detach a volume from an instance¶

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

DATA(lo_result) = lo_client->/aws1/if_ec2~detachvolume( iv_volumeid = |vol-1234567890abcdef0| ) .

/AWS1/CL_EC2=>DETACHVOLUME()¶