aws_sdk_storagegateway/client/

describe_maintenance_start_time.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeMaintenanceStartTime`](crate::operation::describe_maintenance_start_time::builders::DescribeMaintenanceStartTimeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`gateway_arn(impl Into<String>)`](crate::operation::describe_maintenance_start_time::builders::DescribeMaintenanceStartTimeFluentBuilder::gateway_arn) / [`set_gateway_arn(Option<String>)`](crate::operation::describe_maintenance_start_time::builders::DescribeMaintenanceStartTimeFluentBuilder::set_gateway_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p><br>
    /// - On success, responds with [`DescribeMaintenanceStartTimeOutput`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput) with field(s):
    ///   - [`gateway_arn(Option<String>)`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput::gateway_arn): <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>
    ///   - [`hour_of_day(Option<i32>)`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput::hour_of_day): <p>The hour component of the maintenance start time 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>
    ///   - [`minute_of_hour(Option<i32>)`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput::minute_of_hour): <p>The minute component of the maintenance start time represented as <i>mm</i>, where <i>mm</i> is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.</p>
    ///   - [`day_of_week(Option<i32>)`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput::day_of_week): <p>An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.</p>
    ///   - [`day_of_month(Option<i32>)`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput::day_of_month): <p>The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.</p>
    ///   - [`timezone(Option<String>)`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput::timezone): <p>A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.</p>
    ///   - [`software_update_preferences(Option<SoftwareUpdatePreferences>)`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeOutput::software_update_preferences): <p>A set of variables indicating the software update preferences for the gateway.</p> <p>Includes <code>AutomaticUpdatePolicy</code> parameter with the following inputs:</p> <p><code>ALL_VERSIONS</code> - Enables regular gateway maintenance updates.</p> <p><code>EMERGENCY_VERSIONS_ONLY</code> - Disables regular gateway maintenance updates. The gateway will still receive emergency version updates on rare occasions if necessary to remedy highly critical security or durability issues. You will be notified before an emergency version update is applied. These updates are applied during your gateway's scheduled maintenance window.</p>
    /// - On failure, responds with [`SdkError<DescribeMaintenanceStartTimeError>`](crate::operation::describe_maintenance_start_time::DescribeMaintenanceStartTimeError)
    pub fn describe_maintenance_start_time(
        &self,
    ) -> crate::operation::describe_maintenance_start_time::builders::DescribeMaintenanceStartTimeFluentBuilder {
        crate::operation::describe_maintenance_start_time::builders::DescribeMaintenanceStartTimeFluentBuilder::new(self.handle.clone())
    }
}