aws_sdk_storagegateway/client/
describe_snapshot_schedule.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 [`DescribeSnapshotSchedule`](crate::operation::describe_snapshot_schedule::builders::DescribeSnapshotScheduleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`volume_arn(impl Into<String>)`](crate::operation::describe_snapshot_schedule::builders::DescribeSnapshotScheduleFluentBuilder::volume_arn) / [`set_volume_arn(Option<String>)`](crate::operation::describe_snapshot_schedule::builders::DescribeSnapshotScheduleFluentBuilder::set_volume_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the volume. Use the <code>ListVolumes</code> operation to return a list of gateway volumes.</p><br>
7    /// - On success, responds with [`DescribeSnapshotScheduleOutput`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleOutput) with field(s):
8    ///   - [`volume_arn(Option<String>)`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleOutput::volume_arn): <p>The Amazon Resource Name (ARN) of the volume that was specified in the request.</p>
9    ///   - [`start_at(Option<i32>)`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleOutput::start_at): <p>The hour of the day at which the snapshot schedule begins represented as <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway.</p>
10    ///   - [`recurrence_in_hours(Option<i32>)`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleOutput::recurrence_in_hours): <p>The number of hours between snapshots.</p>
11    ///   - [`description(Option<String>)`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleOutput::description): <p>The snapshot description.</p>
12    ///   - [`timezone(Option<String>)`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleOutput::timezone): <p>A value that indicates the time zone of the gateway.</p>
13    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleOutput::tags): <p>A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the <code>ListTagsForResource</code> API operation.</p>
14    /// - On failure, responds with [`SdkError<DescribeSnapshotScheduleError>`](crate::operation::describe_snapshot_schedule::DescribeSnapshotScheduleError)
15    pub fn describe_snapshot_schedule(&self) -> crate::operation::describe_snapshot_schedule::builders::DescribeSnapshotScheduleFluentBuilder {
16        crate::operation::describe_snapshot_schedule::builders::DescribeSnapshotScheduleFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_storagegateway/client/describe_snapshot_schedule.rs

aws_sdk_storagegateway/client/
describe_snapshot_schedule.rs
