Amazonka.SageMaker.Types.ScheduleConfig

Documentation

data ScheduleConfig

Configuration details about the monitoring schedule.

See: newScheduleConfig smart constructor.

Constructors

ScheduleConfig'

Fields

• scheduleExpression :: Text

  A cron expression that describes details about the monitoring schedule.

  Currently the only supported cron expressions are:

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

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

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

  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.

Instances

FromJSON ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

parseJSON :: Value -> Parser ScheduleConfig

parseJSONList :: Value -> Parser [ScheduleConfig]

ToJSON ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

toJSON :: ScheduleConfig -> Value

toEncoding :: ScheduleConfig -> Encoding

toJSONList :: [ScheduleConfig] -> Value

toEncodingList :: [ScheduleConfig] -> Encoding

Generic ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Associated Types

type Rep ScheduleConfig :: Type -> Type

Methods

from :: ScheduleConfig -> Rep ScheduleConfig x

to :: Rep ScheduleConfig x -> ScheduleConfig

Read ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

readsPrec :: Int -> ReadS ScheduleConfig

readList :: ReadS [ScheduleConfig]

readPrec :: ReadPrec ScheduleConfig

readListPrec :: ReadPrec [ScheduleConfig]

Show ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

showsPrec :: Int -> ScheduleConfig -> ShowS

show :: ScheduleConfig -> String

showList :: [ScheduleConfig] -> ShowS

NFData ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

rnf :: ScheduleConfig -> ()

Eq ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

(==) :: ScheduleConfig -> ScheduleConfig -> Bool

(/=) :: ScheduleConfig -> ScheduleConfig -> Bool

Hashable ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

hashWithSalt :: Int -> ScheduleConfig -> Int

hash :: ScheduleConfig -> Int

type Rep ScheduleConfig

Defined in Amazonka.SageMaker.Types.ScheduleConfig

type Rep ScheduleConfig = D1 ('MetaData "ScheduleConfig" "Amazonka.SageMaker.Types.ScheduleConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ScheduleConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newScheduleConfig

Arguments

:: Text

$sel:scheduleExpression:ScheduleConfig'

-> ScheduleConfig

Create a value of ScheduleConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:scheduleExpression:ScheduleConfig', scheduleConfig_scheduleExpression - A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

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

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

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

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.

scheduleConfig_scheduleExpression :: Lens' ScheduleConfig Text

A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

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

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

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

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.