Skip to content

EC2  >  Operations  >  restore_volume_from_recycle_bin

restore_volume_from_recycle_bin

Operation

restore_volume_from_recycle_bin async

restore_volume_from_recycle_bin(request: RestoreVolumeFromRecycleBinInput | RestoreVolumeFromRecycleBinInputDict, /, *, plugins: list[Plugin] | None = None) -> RestoreVolumeFromRecycleBinOutput
restore_volume_from_recycle_bin(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreVolumeFromRecycleBinInputDict]) -> RestoreVolumeFromRecycleBinOutput

Restores a volume from the Recycle Bin. For more information, see Restore volumes from the Recycle Bin in the Amazon EBS User Guide.

Parameters:

Name Type Description Default
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

Returns:

Type Description
RestoreVolumeFromRecycleBinOutput

An instance of RestoreVolumeFromRecycleBinOutput.

Input

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

Model

RestoreVolumeFromRecycleBinInput dataclass

Bases: _SerdeShape

Dataclass for RestoreVolumeFromRecycleBinInput 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 to restore.

Dictionaries

RestoreVolumeFromRecycleBinInputDict

Bases: TypedDict

Dictionary form of RestoreVolumeFromRecycleBinInput.

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 to restore.

Output

RestoreVolumeFromRecycleBinOutput dataclass

Bases: _SerdeShape

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

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

Returns true if the request succeeds; otherwise, it returns an error.