Struct ScheduleConfig

#[non_exhaustive]
pub struct ScheduleConfig {
    pub schedule_expression: Option<String>,
    pub data_analysis_start_time: Option<String>,
    pub data_analysis_end_time: Option<String>,
}

Configuration details about the monitoring schedule.

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.

schedule_expression: Option<String>

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

• If you want to set the job to start every hour, use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 \[00-23\] ? * * *)

• If you want to run the job one time, immediately, use the following keyword:

  NOW

For example, the following are valid cron expressions:

• Daily at noon UTC: cron(0 12 ? * * *)

• Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 \[00-23\]/\[01-24\] ? * * *)

For example, the following are valid cron expressions:

• Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

• Every two hours starting at midnight: cron(0 0/2 ? * * *)

• Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

• We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

data_analysis_start_time: Option<String>

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

data_analysis_end_time: Option<String>

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

Implementations

impl ScheduleConfig

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

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

• If you want to set the job to start every hour, use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 \[00-23\] ? * * *)

• If you want to run the job one time, immediately, use the following keyword:

  NOW

For example, the following are valid cron expressions:

• Daily at noon UTC: cron(0 12 ? * * *)

• Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 \[00-23\]/\[01-24\] ? * * *)

For example, the following are valid cron expressions:

• Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

• Every two hours starting at midnight: cron(0 0/2 ? * * *)

• Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

• We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

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

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

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

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

impl ScheduleConfig

pub fn builder() -> ScheduleConfigBuilder

Creates a new builder-style object to manufacture ScheduleConfig.

Trait Implementations

impl Clone for ScheduleConfig

fn clone(&self) -> ScheduleConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduleConfig

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

Formats the value using the given formatter.

impl PartialEq for ScheduleConfig

fn eq(&self, other: &ScheduleConfig) -> 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 StructuralPartialEq for ScheduleConfig