libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.Types.ScheduleConfig

Description

 
Synopsis

Documentation

data ScheduleConfig Source #

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

Instances details
Eq ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Read ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Show ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Generic ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Associated Types

type Rep ScheduleConfig :: Type -> Type #

NFData ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

Methods

rnf :: ScheduleConfig -> () #

Hashable ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

ToJSON ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

FromJSON ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

type Rep ScheduleConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.ScheduleConfig

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

newScheduleConfig Source #

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 Source #

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.