Skip to content

restore_snapshot_from_recycle_bin

Operation

restore_snapshot_from_recycle_bin

restore_snapshot_from_recycle_bin(request: RestoreSnapshotFromRecycleBinInput | RestoreSnapshotFromRecycleBinInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreSnapshotFromRecycleBinInputDict]) -> RestoreSnapshotFromRecycleBinOutput

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

Parameters:

Name Type Description Default
request RestoreSnapshotFromRecycleBinInput | RestoreSnapshotFromRecycleBinInputDict | 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[RestoreSnapshotFromRecycleBinInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RestoreSnapshotFromRecycleBinOutput

An instance of RestoreSnapshotFromRecycleBinOutput.

restore_snapshot_from_recycle_bin async

restore_snapshot_from_recycle_bin(request: RestoreSnapshotFromRecycleBinInput | RestoreSnapshotFromRecycleBinInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreSnapshotFromRecycleBinInputDict]) -> RestoreSnapshotFromRecycleBinOutput

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

Parameters:

Name Type Description Default
request RestoreSnapshotFromRecycleBinInput | RestoreSnapshotFromRecycleBinInputDict | 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[RestoreSnapshotFromRecycleBinInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RestoreSnapshotFromRecycleBinOutput

An instance of RestoreSnapshotFromRecycleBinOutput.

Input

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

RestoreSnapshotFromRecycleBinInputDict

Bases: TypedDict

Dictionary form of RestoreSnapshotFromRecycleBinInput.

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.

snapshot_id instance-attribute
snapshot_id: Required[str]

The ID of the snapshot to restore.

RestoreSnapshotFromRecycleBinInput dataclass

Bases: _SerdeShape

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

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

The ID of the snapshot to restore.

Output

RestoreSnapshotFromRecycleBinOutput dataclass

Bases: _SerdeShape

Dataclass for RestoreSnapshotFromRecycleBinOutput structure.

Attributes

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

The description for the snapshot.

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

Indicates whether the snapshot is encrypted.

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

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

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

The ID of the Amazon Web Services account that owns the EBS snapshot.

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

The progress of the snapshot, as a percentage.

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.

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

The ID of the snapshot.

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

Reserved for future use.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The time stamp when the snapshot was initiated.

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

The state of the snapshot.

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

The ID of the volume that was used to create the snapshot.

volume_size class-attribute instance-attribute
volume_size: int | None = ...

The size of the volume, in GiB.