aws_sdk_ec2/client/restore_snapshot_from_recycle_bin.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`RestoreSnapshotFromRecycleBin`](crate::operation::restore_snapshot_from_recycle_bin::builders::RestoreSnapshotFromRecycleBinFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`snapshot_id(impl Into<String>)`](crate::operation::restore_snapshot_from_recycle_bin::builders::RestoreSnapshotFromRecycleBinFluentBuilder::snapshot_id) / [`set_snapshot_id(Option<String>)`](crate::operation::restore_snapshot_from_recycle_bin::builders::RestoreSnapshotFromRecycleBinFluentBuilder::set_snapshot_id):<br>required: **true**<br><p>The ID of the snapshot to restore.</p><br>
7 /// - [`dry_run(bool)`](crate::operation::restore_snapshot_from_recycle_bin::builders::RestoreSnapshotFromRecycleBinFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::restore_snapshot_from_recycle_bin::builders::RestoreSnapshotFromRecycleBinFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
8 /// - On success, responds with [`RestoreSnapshotFromRecycleBinOutput`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput) with field(s):
9 /// - [`snapshot_id(Option<String>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::snapshot_id): <p>The ID of the snapshot.</p>
10 /// - [`outpost_arn(Option<String>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::outpost_arn): <p>The ARN of the Outpost on which the snapshot is stored. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html">Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EBS User Guide</i>.</p>
11 /// - [`description(Option<String>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::description): <p>The description for the snapshot.</p>
12 /// - [`encrypted(Option<bool>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::encrypted): <p>Indicates whether the snapshot is encrypted.</p>
13 /// - [`owner_id(Option<String>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::owner_id): <p>The ID of the Amazon Web Services account that owns the EBS snapshot.</p>
14 /// - [`progress(Option<String>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::progress): <p>The progress of the snapshot, as a percentage.</p>
15 /// - [`start_time(Option<DateTime>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::start_time): <p>The time stamp when the snapshot was initiated.</p>
16 /// - [`state(Option<SnapshotState>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::state): <p>The state of the snapshot.</p>
17 /// - [`volume_id(Option<String>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::volume_id): <p>The ID of the volume that was used to create the snapshot.</p>
18 /// - [`volume_size(Option<i32>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::volume_size): <p>The size of the volume, in GiB.</p>
19 /// - [`sse_type(Option<SseType>)`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinOutput::sse_type): <p>Reserved for future use.</p>
20 /// - On failure, responds with [`SdkError<RestoreSnapshotFromRecycleBinError>`](crate::operation::restore_snapshot_from_recycle_bin::RestoreSnapshotFromRecycleBinError)
21 pub fn restore_snapshot_from_recycle_bin(
22 &self,
23 ) -> crate::operation::restore_snapshot_from_recycle_bin::builders::RestoreSnapshotFromRecycleBinFluentBuilder {
24 crate::operation::restore_snapshot_from_recycle_bin::builders::RestoreSnapshotFromRecycleBinFluentBuilder::new(self.handle.clone())
25 }
26}