Skip to content

EC2  >  Operations  >  restore_image_from_recycle_bin

restore_image_from_recycle_bin

Operation

restore_image_from_recycle_bin async

restore_image_from_recycle_bin(request: RestoreImageFromRecycleBinInput | RestoreImageFromRecycleBinInputDict, /, *, plugins: list[Plugin] | None = None) -> RestoreImageFromRecycleBinOutput
restore_image_from_recycle_bin(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreImageFromRecycleBinInputDict]) -> RestoreImageFromRecycleBinOutput

Restores an AMI from the Recycle Bin. For more information, see Recover deleted Amazon EBS snapshots and EBS-back AMIs with Recycle Bin in the Amazon EC2 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
RestoreImageFromRecycleBinOutput

An instance of RestoreImageFromRecycleBinOutput.

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

RestoreImageFromRecycleBinInput dataclass

Bases: _SerdeShape

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

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

The ID of the AMI to restore.

Dictionaries

RestoreImageFromRecycleBinInputDict

Bases: TypedDict

Dictionary form of RestoreImageFromRecycleBinInput.

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.

image_id instance-attribute
image_id: Required[str]

The ID of the AMI to restore.

Output

RestoreImageFromRecycleBinOutput dataclass

Bases: _SerdeShape

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