Skip to content

restore_snapshot_from_recycle_bin async

restore_snapshot_from_recycle_bin(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    snapshot_id: Optional[SnapshotId] = None,
    dry_run: Optional[Boolean] = None,
) -> RestoreSnapshotFromRecycleBinResult

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

Parameters:

  • snapshot_id (Optional[SnapshotId], default: None ) –

    The ID of the snapshot 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_snapshot_from_recycle_bin(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    snapshot_id: Optional["capo_ec2.types.snapshot_id.SnapshotId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.restore_snapshot_from_recycle_bin_result.RestoreSnapshotFromRecycleBinResult":
    """<p>Restores a snapshot from the Recycle Bin. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html#recycle-bin-restore-snaps">Restore snapshots from the Recycle Bin</a> in the <i>Amazon EBS User Guide</i>.</p>

    Args:
        snapshot_id: <p>The ID of the snapshot 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_snapshot_from_recycle_bin_request.RestoreSnapshotFromRecycleBinRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.restore_snapshot_from_recycle_bin_result.RestoreSnapshotFromRecycleBinResult"
    ]:
        import capo_ec2._operations.amazon_ec2.restore_snapshot_from_recycle_bin

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RestoreSnapshotFromRecycleBin")
    )
    input_: capo_ec2.types.restore_snapshot_from_recycle_bin_request.RestoreSnapshotFromRecycleBinRequest = {}
    if snapshot_id is not None:
        input_["snapshot_id"] = snapshot_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