Skip to content

delete_volume

Operation

delete_volume

delete_volume(request: DeleteVolumeInput | DeleteVolumeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteVolumeInputDict]) -> DeleteVolumeOutput

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume can remain in the deleting state for several minutes.

For more information, see Delete an Amazon EBS volume in the Amazon EBS User Guide.

Parameters:

Name Type Description Default
request DeleteVolumeInput | DeleteVolumeInputDict | 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[DeleteVolumeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteVolumeOutput

An instance of DeleteVolumeOutput.

delete_volume async

delete_volume(request: DeleteVolumeInput | DeleteVolumeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteVolumeInputDict]) -> DeleteVolumeOutput

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume can remain in the deleting state for several minutes.

For more information, see Delete an Amazon EBS volume in the Amazon EBS User Guide.

Parameters:

Name Type Description Default
request DeleteVolumeInput | DeleteVolumeInputDict | 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[DeleteVolumeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteVolumeOutput

An instance of DeleteVolumeOutput.

Input

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

DeleteVolumeInputDict

Bases: TypedDict

Dictionary form of DeleteVolumeInput.

Attributes

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.

volume_id instance-attribute
volume_id: Required[str]

The ID of the volume.

DeleteVolumeInput dataclass

Bases: _SerdeShape

Dataclass for DeleteVolumeInput structure.

Attributes

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.

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

The ID of the volume.

Output

DeleteVolumeOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteVolumeOutput 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.