Command reference
deployments schedule
Scheduled agent runs
| Command | Summary |
|---|---|
deployments schedule create | Create a schedule |
deployments schedule list | List schedules |
deployments schedule show | Show a schedule |
deployments schedule update | Update a schedule |
deployments schedule archive | Archive a schedule |
deployments schedule pause | Pause a schedule |
deployments schedule resume | Resume a schedule |
deployments schedule fires | List schedule fire history |
deployments schedule fire | Fire a schedule now |
deployments schedule create
Create a schedule.
deployments schedule create --name <name> --agent-deployment-id <agent-deployment-id> --expression <expression> --prompt <prompt>- Calls
POST /v1/schedules(SDKcreateSchedule). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--name | string | yes | Resource name | |
--agent-deployment-id | string | yes | Agent deployment ID | |
--expression | string | yes | EventBridge cron, rate, or at expression | |
--prompt | string | yes | Prompt for each scheduled run | |
--thread-id | string | Conversation thread for scheduled runs | ||
--timezone | string | IANA timezone | ||
--workspace-id | string | Workspace ID |
Also accepts the global flags.
deployments schedule list
List schedules.
deployments schedule list- Calls
GET /v1/schedules(SDKlistSchedules). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size |
Also accepts the global flags.
deployments schedule show
Show a schedule.
deployments schedule show <id>- Calls
GET /v1/schedules/{scheduleId}(SDKgetSchedule). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments schedule update
Update a schedule.
deployments schedule update <id>- Calls
PATCH /v1/schedules/{scheduleId}(SDKupdateSchedule). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--expression | string | EventBridge cron, rate, or at expression | ||
--name | string | Schedule name | ||
--prompt | string | Prompt for each scheduled run | ||
--clear-timezone | boolean | Clear the schedule timezone | ||
--timezone | string | IANA timezone |
Also accepts the global flags.
deployments schedule archive
Archive a schedule.
deployments schedule archive <id>- Calls
DELETE /v1/schedules/{scheduleId}(SDKarchiveSchedule). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments schedule pause
Pause a schedule.
deployments schedule pause <id>- Calls
POST /v1/schedules/{scheduleId}/pause(SDKpauseSchedule). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments schedule resume
Resume a schedule.
deployments schedule resume <id>- Calls
POST /v1/schedules/{scheduleId}/resume(SDKresumeSchedule). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments schedule fires
List schedule fire history.
deployments schedule fires <id>- Calls
GET /v1/schedules/{scheduleId}/fires(SDKlistScheduleFires). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments schedule fire
Fire a schedule now.
deployments schedule fire <id>- Calls
POST /v1/schedules/{scheduleId}/fire(SDKfireSchedule). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--fire-key | string | Stable fire key |
Also accepts the global flags.