Scaleway Serverless Jobs
@sntxrr/scaleway-serverless-jobsv2026.07.19.1
01README
Manage a Scaleway Serverless Jobs job definition — sync state, create, update, delete, and run it (starting job runs), plus discover job definitions in a region, via the Serverless Jobs API with X-Auth-Token auth.
02Models
@sntxrr/scaleway-serverless-jobsv2026.07.19.1scaleway_serverless_jobs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| secretKey | string | Scaleway API secret key. Wire with ${{ vault.get(scaleway, SCW_SECRET_KEY) }}. |
| projectId | string | Scaleway Project ID that owns the job definition. |
| region | string | Region, e.g. fr-par, nl-ams, pl-waw. |
| jobDefinitionId? | string | ID of the Serverless Jobs job definition this model manages. Optional — |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the job definition's current state (GetJobDefinition).
fn create(name: string, cpuLimit: number, memoryLimit: number, localStorageCapacity: number, imageUri: string, startupCommand?: array, args?: array, environmentVariables?: record, description?: string, jobTimeout?: string)
Provision a new job definition (CreateJobDefinition) and snapshot it.
| Argument | Type | Description |
|---|---|---|
| name | string | Name of the new job definition. |
| cpuLimit | number | CPU limit of the job (in mvCPU). |
| memoryLimit | number | Memory limit of the job (in MiB). |
| localStorageCapacity | number | Local storage capacity of the job (in MiB). |
| imageUri | string | Container image to run for the job, e.g. rg.fr-par.scw.cloud/ns/app:latest. |
| startupCommand? | array | Startup command (entrypoint) that overrides the image default. |
| args? | array | Arguments passed to the startup command at runtime. |
| environmentVariables? | record | Environment variables for the job. Sent to provision; never stored in a snapshot. |
| description? | string | Human-readable description of the job definition. |
| jobTimeout? | string | Timeout of the job in seconds, e.g. '3600s'. Optional. |
fn update(name?: string, cpuLimit?: number, memoryLimit?: number, localStorageCapacity?: number, imageUri?: string, startupCommand?: array, args?: array, environmentVariables?: record, description?: string, jobTimeout?: string)
Mutate a job definition's mutable fields (UpdateJobDefinition).
| Argument | Type | Description |
|---|---|---|
| name? | string | New name for the job definition. |
| cpuLimit? | number | New CPU limit (in mvCPU). |
| memoryLimit? | number | New memory limit (in MiB). |
| localStorageCapacity? | number | New local storage capacity (in MiB). |
| imageUri? | string | New container image to run. |
| startupCommand? | array | New startup command (entrypoint). |
| args? | array | New arguments passed to the startup command. |
| environmentVariables? | record | Replacement environment variables. Sent to update; never stored in a snapshot. |
| description? | string | New description. |
| jobTimeout? | string | New timeout of the job in seconds, e.g. '3600s'. |
fn delete()
Deprovision the job definition (DeleteJobDefinition).
fn action(startupCommand?: array, args?: array, environmentVariables?: record, replicas?: number)
Run the job definition, starting one or more job runs (StartJobDefinition).
| Argument | Type | Description |
|---|---|---|
| startupCommand? | array | Contextual startup command for this specific job run. |
| args? | array | Contextual arguments for this specific job run. |
| environmentVariables? | record | Contextual environment variables for this run. Sent to run; never stored in a snapshot. |
| replicas? | number | Number of parallel job runs to start. Optional; API default applies. |
fn list()
Discover all job definitions in the region (factory).
Resources
job-definition(infinite)— Snapshot of the Serverless Jobs job definition's state
job-run(infinite)— Snapshot of a job run started from the job definition
03Previous Versions
2026.07.18.1
04Stats
A
100 / 100
Downloads
0
Archive size
14.3 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
Repository
https://github.com/sntxrr/swamp-scaleway05Platforms
06Labels