​
Run Scheduled Jobs

Use the @schedule decorator to define a scheduled job.

from beam import schedule


@schedule(when="@weekly", name="weekly-task")
def task():
    print("Hi, from your weekly scheduled task!")

To schedule it, run beam deploy:

beam deploy app.py:task

You’ll see the upcoming jobs listed in the console.

=> Deployed 🎉
=> Schedule details
Schedule: @hourly
Upcoming:
  1. 2024-08-30 18:00:00 UTC (2024-08-30 14:00:00 EDT)
  2. 2024-08-30 19:00:00 UTC (2024-08-30 15:00:00 EDT)
  3. 2024-08-30 20:00:00 UTC (2024-08-30 16:00:00 EDT)

​
Scheduling Options

The following predefined schedules can be used in the when parameter:

Predefined ScheduleDescriptionCron Expression
@yearly (or @annually)Run once a year at midnight on January 1st0 0 1 1 *
@monthlyRun once a month at midnight on the first day of the month0 0 1 * *
@weeklyRun once a week at midnight on Sunday0 0 * * 0
@daily (or @midnight)Run once a day at midnight0 0 * * *
@hourlyRun once an hour at the beginning of the hour0 * * * *

​
Stopping Scheduled Jobs

You can stop a scheduled job from running by using the beam deployment stop CLI command.

First, list the upcoming jobs with beam deployment list:

  ID                       Name                   Active   Version   Created At      Updated At      Stub Name                 Workspace Name
 ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
  10c192b6-6489-42c9-a3…   schedule               Yes            2   9 minutes ago   9 minutes ago   schedule/deployment/ap…   f6fa28

Then reference the Deployment ID to stop a job:

$ beam deployment stop 10c192b6-6489-42c9-a3

Stopped 10c192b6-6489-42c9-a3bf-75c52ad1816b

​
Gotchas

If you deploy a new version of your scheduled job, the previous schedule will be disabled.

Was this page helpful?

Run any Python RemotelyScaling out