Skip to content

restore_image_from_recycle_bin async

restore_image_from_recycle_bin(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    image_id: Optional[ImageId] = None,
    dry_run: Optional[Boolean] = None,
) -> RestoreImageFromRecycleBinResult

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:

  • image_id (Optional[ImageId], default: None ) –

    The ID of the AMI to restore.

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def restore_image_from_recycle_bin(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    image_id: Optional["capo_ec2.types.image_id.ImageId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.restore_image_from_recycle_bin_result.RestoreImageFromRecycleBinResult":
    """<p>Restores an AMI from the Recycle Bin. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html">Recover deleted Amazon EBS snapshots and EBS-back AMIs with Recycle Bin</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        image_id: <p>The ID of the AMI to restore.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.restore_image_from_recycle_bin_request.RestoreImageFromRecycleBinRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.restore_image_from_recycle_bin_result.RestoreImageFromRecycleBinResult"
    ]:
        import capo_ec2._operations.amazon_ec2.restore_image_from_recycle_bin

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.restore_image_from_recycle_bin.async_restore_image_from_recycle_bin(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RestoreImageFromRecycleBin")
    )
    input_: capo_ec2.types.restore_image_from_recycle_bin_request.RestoreImageFromRecycleBinRequest = {}
    if image_id is not None:
        input_["image_id"] = image_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output