Class: Aws::SageMaker::Types::ScheduleConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Configuration details about the monitoring schedule.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_analysis_end_time ⇒ 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.

Returns:

  • (String) 


40361
40362
40363
40364
40365
40366
40367
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 40361

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :data_analysis_start_time,
  :data_analysis_end_time)
  SENSITIVE = []
  include Aws::Structure
end

#data_analysis_start_time ⇒ 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.

Returns:

  • (String) 


40361
40362
40363
40364
40365
40366
40367
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 40361

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :data_analysis_start_time,
  :data_analysis_end_time)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ 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 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.

Returns:

  • (String) 


40361
40362
40363
40364
40365
40366
40367
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 40361

class ScheduleConfig < Struct.new(
  :schedule_expression,
  :data_analysis_start_time,
  :data_analysis_end_time)
  SENSITIVE = []
  include Aws::Structure
end