Struct aws_sdk_scheduler::operation::get_schedule::GetScheduleOutput

#[non_exhaustive]
pub struct GetScheduleOutput {

    pub arn: Option<String>,
    pub group_name: Option<String>,
    pub name: Option<String>,
    pub schedule_expression: Option<String>,
    pub start_date: Option<DateTime>,
    pub end_date: Option<DateTime>,
    pub description: Option<String>,
    pub schedule_expression_timezone: Option<String>,
    pub state: Option<ScheduleState>,
    pub creation_date: Option<DateTime>,
    pub last_modification_date: Option<DateTime>,
    pub kms_key_arn: Option<String>,
    pub target: Option<Target>,
    pub flexible_time_window: Option<FlexibleTimeWindow>,
    pub action_after_completion: Option<ActionAfterCompletion>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

The Amazon Resource Name (ARN) of the schedule.

group_name: Option<String>

The name of the schedule group associated with this schedule.

name: Option<String>

The name of the schedule.

schedule_expression: Option<String>

The expression that defines when the schedule runs. The following formats are supported.

• at expression - at(yyyy-mm-ddThh:mm:ss)

• rate expression - rate(value unit)

• cron expression - cron(fields)

You can use at 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 rate and cron 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.

A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

start_date: Option<DateTime>

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 StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

end_date: Option<DateTime>

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 EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

description: Option<String>

The description of the schedule.

schedule_expression_timezone: Option<String>

The timezone in which the scheduling expression is evaluated.

state: Option<ScheduleState>

Specifies whether the schedule is enabled or disabled.

creation_date: Option<DateTime>

The time at which the schedule was created.

last_modification_date: Option<DateTime>

The time at which the schedule was last modified.

kms_key_arn: Option<String>

The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

target: Option<Target>

The schedule target.

flexible_time_window: Option<FlexibleTimeWindow>

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

action_after_completion: Option<ActionAfterCompletion>

Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

Implementations

impl GetScheduleOutput

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the schedule.

pub fn group_name(&self) -> Option<&str>

The name of the schedule group associated with this schedule.

pub fn name(&self) -> Option<&str>

The name of the schedule.

pub fn schedule_expression(&self) -> Option<&str>

The expression that defines when the schedule runs. The following formats are supported.

• at expression - at(yyyy-mm-ddThh:mm:ss)

• rate expression - rate(value unit)

• cron expression - cron(fields)

You can use at 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 rate and cron 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.

A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

pub fn start_date(&self) -> Option<&DateTime>

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 StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

pub fn end_date(&self) -> Option<&DateTime>

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 EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

pub fn description(&self) -> Option<&str>

The description of the schedule.

pub fn schedule_expression_timezone(&self) -> Option<&str>

The timezone in which the scheduling expression is evaluated.

pub fn state(&self) -> Option<&ScheduleState>

Specifies whether the schedule is enabled or disabled.

pub fn creation_date(&self) -> Option<&DateTime>

The time at which the schedule was created.

pub fn last_modification_date(&self) -> Option<&DateTime>

The time at which the schedule was last modified.

pub fn kms_key_arn(&self) -> Option<&str>

The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

pub fn target(&self) -> Option<&Target>

The schedule target.

pub fn flexible_time_window(&self) -> Option<&FlexibleTimeWindow>

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

pub fn action_after_completion(&self) -> Option<&ActionAfterCompletion>

Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

impl GetScheduleOutput

pub fn builder() -> GetScheduleOutputBuilder

Creates a new builder-style object to manufacture GetScheduleOutput.

Trait Implementations

impl Clone for GetScheduleOutput

fn clone(&self) -> GetScheduleOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetScheduleOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetScheduleOutput

fn eq(&self, other: &GetScheduleOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetScheduleOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetScheduleOutput