// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`GetSchedule`](crate::operation::get_schedule::builders::GetScheduleFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::operation::get_schedule::builders::GetScheduleFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_schedule::builders::GetScheduleFluentBuilder::set_name): <p>The name of the schedule to retrieve.</p>
/// - [`group_name(impl Into<String>)`](crate::operation::get_schedule::builders::GetScheduleFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::get_schedule::builders::GetScheduleFluentBuilder::set_group_name): <p>The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.</p>
/// - On success, responds with [`GetScheduleOutput`](crate::operation::get_schedule::GetScheduleOutput) with field(s):
/// - [`arn(Option<String>)`](crate::operation::get_schedule::GetScheduleOutput::arn): <p>The Amazon Resource Name (ARN) of the schedule.</p>
/// - [`group_name(Option<String>)`](crate::operation::get_schedule::GetScheduleOutput::group_name): <p>The name of the schedule group associated with this schedule.</p>
/// - [`name(Option<String>)`](crate::operation::get_schedule::GetScheduleOutput::name): <p>The name of the schedule.</p>
/// - [`schedule_expression(Option<String>)`](crate::operation::get_schedule::GetScheduleOutput::schedule_expression): <p> The expression that defines when the schedule runs. The following formats are supported. </p> <ul> <li> <p> <code>at</code> expression - <code>at(yyyy-mm-ddThh:mm:ss)</code> </p> </li> <li> <p> <code>rate</code> expression - <code>rate(unit value)</code> </p> </li> <li> <p> <code>cron</code> expression - <code>cron(fields)</code> </p> </li> </ul> <p> You can use <code>at</code> expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use <code>rate</code> and <code>cron</code> expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. </p> <p> A <code>cron</code> expression consists of six fields separated by white spaces: <code>(minutes hours day_of_month month day_of_week year)</code>. </p> <p> A <code>rate</code> expression consists of a <i>value</i> as a positive integer, and a <i>unit</i> with the following options: <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code> </p> <p> For more information and examples, see <a href="https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>. </p>
/// - [`start_date(Option<DateTime>)`](crate::operation::get_schedule::GetScheduleOutput::start_date): <p>The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the <code>StartDate</code> you specify. EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>
/// - [`end_date(Option<DateTime>)`](crate::operation::get_schedule::GetScheduleOutput::end_date): <p>The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the <code>EndDate</code> you specify. EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>
/// - [`description(Option<String>)`](crate::operation::get_schedule::GetScheduleOutput::description): <p>The description of the schedule.</p>
/// - [`schedule_expression_timezone(Option<String>)`](crate::operation::get_schedule::GetScheduleOutput::schedule_expression_timezone): <p>The timezone in which the scheduling expression is evaluated.</p>
/// - [`state(Option<ScheduleState>)`](crate::operation::get_schedule::GetScheduleOutput::state): <p>Specifies whether the schedule is enabled or disabled.</p>
/// - [`creation_date(Option<DateTime>)`](crate::operation::get_schedule::GetScheduleOutput::creation_date): <p>The time at which the schedule was created.</p>
/// - [`last_modification_date(Option<DateTime>)`](crate::operation::get_schedule::GetScheduleOutput::last_modification_date): <p>The time at which the schedule was last modified.</p>
/// - [`kms_key_arn(Option<String>)`](crate::operation::get_schedule::GetScheduleOutput::kms_key_arn): <p>The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.</p>
/// - [`target(Option<Target>)`](crate::operation::get_schedule::GetScheduleOutput::target): <p>The schedule target.</p>
/// - [`flexible_time_window(Option<FlexibleTimeWindow>)`](crate::operation::get_schedule::GetScheduleOutput::flexible_time_window): <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
/// - On failure, responds with [`SdkError<GetScheduleError>`](crate::operation::get_schedule::GetScheduleError)
pub fn get_schedule(&self) -> crate::operation::get_schedule::builders::GetScheduleFluentBuilder {
crate::operation::get_schedule::builders::GetScheduleFluentBuilder::new(self.handle.clone())
}
}