scaleway.jobs.v1alpha1 package

Submodules

scaleway.jobs.v1alpha1.api module

class scaleway.jobs.v1alpha1.api.JobsV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Serverless Jobs.

create_job_definition(*, cpu_limit: int, memory_limit: int, image_uri: str, command: str, description: str, region: str | None = None, name: str | None = None, local_storage_capacity: int | None = None, project_id: str | None = None, environment_variables: Dict[str, str] | None = None, job_timeout: str | None = None, cron_schedule: CreateJobDefinitionRequestCronScheduleConfig | None = None) → JobDefinition

Create a new job definition in a specified Project. :param cpu_limit: CPU limit of the job. :param memory_limit: Memory limit of the job (in MiB). :param image_uri: Image to use for the job. :param command: Startup command. If empty or not defined, the image’s default command is used. :param description: Description of the job. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the job definition. :param local_storage_capacity: Local storage capacity of the job (in MiB). :param project_id: UUID of the Scaleway Project containing the job. :param environment_variables: Environment variables of the job. :param job_timeout: Timeout of the job in seconds. :param cron_schedule: Configure a cron for the job. :return: JobDefinition

Usage:

result = api.create_job_definition(
    cpu_limit=1,
    memory_limit=1,
    image_uri="example",
    command="example",
    description="example",
)

create_job_definition_secrets(*, job_definition_id: str, secrets: List[CreateJobDefinitionSecretsRequestSecretConfig], region: str | None = None) → CreateJobDefinitionSecretsResponse

Create a secret reference within a job definition. :param job_definition_id: UUID of the job definition. :param secrets: List of secrets to inject into the job. :param region: Region to target. If none is passed will use default region from the config. :return: CreateJobDefinitionSecretsResponse

Usage:

result = api.create_job_definition_secrets(
    job_definition_id="example",
    secrets=[],
)

delete_job_definition(*, job_definition_id: str, region: str | None = None) → None

Delete an exsisting job definition by its unique identifier. :param job_definition_id: UUID of the job definition to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_job_definition(
    job_definition_id="example",
)

delete_job_definition_secret(*, job_definition_id: str, secret_id: str, region: str | None = None) → None

Delete a secret reference within a job definition. :param job_definition_id: UUID of the job definition. :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_job_definition_secret(
    job_definition_id="example",
    secret_id="example",
)

get_job_definition(*, job_definition_id: str, region: str | None = None) → JobDefinition

Get a job definition by its unique identifier. :param job_definition_id: UUID of the job definition to get. :param region: Region to target. If none is passed will use default region from the config. :return: JobDefinition

Usage:

result = api.get_job_definition(
    job_definition_id="example",
)

get_job_definition_secret(*, job_definition_id: str, secret_id: str, region: str | None = None) → Secret

Get a secret references within a job definition. :param job_definition_id: UUID of the job definition. :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. :return: Secret

Usage:

result = api.get_job_definition_secret(
    job_definition_id="example",
    secret_id="example",
)

get_job_run(*, job_run_id: str, region: str | None = None) → JobRun

Get a job run by its unique identifier. :param job_run_id: UUID of the job run to get. :param region: Region to target. If none is passed will use default region from the config. :return: JobRun

Usage:

result = api.get_job_run(
    job_run_id="example",
)

get_jobs_limits(*, region: str | None = None) → JobsLimits

Get jobs limits for the console. :param region: Region to target. If none is passed will use default region from the config. :return: JobsLimits

Usage:

result = api.get_jobs_limits()

list_job_definition_secrets(*, job_definition_id: str, region: str | None = None) → ListJobDefinitionSecretsResponse

List secrets references within a job definition. :param job_definition_id: UUID of the job definition. :param region: Region to target. If none is passed will use default region from the config. :return: ListJobDefinitionSecretsResponse

Usage:

result = api.list_job_definition_secrets(
    job_definition_id="example",
)

List all your job definitions with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: ListJobDefinitionsResponse

Usage:

result = api.list_job_definitions()

List all your job definitions with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: List[JobDefinition]

Usage:

result = api.list_job_definitions_all()

List all job runs with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param job_definition_id: :param project_id: :param organization_id: :param state: :param states: :return: ListJobRunsResponse

Usage:

result = api.list_job_runs()

List all job runs with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param job_definition_id: :param project_id: :param organization_id: :param state: :param states: :return: List[JobRun]

Usage:

result = api.list_job_runs_all()

list_jobs_resources(*, region: str | None = None) → ListJobsResourcesResponse

List jobs resources for the console. :param region: Region to target. If none is passed will use default region from the config. :return: ListJobsResourcesResponse

Usage:

result = api.list_jobs_resources()

start_job_definition(*, job_definition_id: str, region: str | None = None, command: str | None = None, environment_variables: Dict[str, str] | None = None, replicas: int | None = None) → StartJobDefinitionResponse

Run an existing job definition by its unique identifier. This will create a new job run. :param job_definition_id: UUID of the job definition to start. :param region: Region to target. If none is passed will use default region from the config. :param command: Contextual startup command for this specific job run. :param environment_variables: Contextual environment variables for this specific job run. :param replicas: Number of jobs to run. :return: StartJobDefinitionResponse

Usage:

result = api.start_job_definition(
    job_definition_id="example",
)

stop_job_run(*, job_run_id: str, region: str | None = None) → JobRun

Stop a job run by its unique identifier. :param job_run_id: UUID of the job run to stop. :param region: Region to target. If none is passed will use default region from the config. :return: JobRun

Usage:

result = api.stop_job_run(
    job_run_id="example",
)

Update an existing job definition associated with the specified unique identifier. :param job_definition_id: UUID of the job definition to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the job definition. :param cpu_limit: CPU limit of the job. :param memory_limit: Memory limit of the job (in MiB). :param local_storage_capacity: Local storage capacity of the job (in MiB). :param image_uri: Image to use for the job. :param command: Startup command. :param environment_variables: Environment variables of the job. :param description: Description of the job. :param job_timeout: Timeout of the job in seconds. :param cron_schedule: :return: JobDefinition

Usage:

result = api.update_job_definition(
    job_definition_id="example",
)

update_job_definition_secret(*, job_definition_id: str, secret_id: str, region: str | None = None, secret_manager_version: str | None = None, path: str | None = None, env_var_name: str | None = None) → Secret

Update a secret reference within a job definition. :param job_definition_id: UUID of the job definition. :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. :param secret_manager_version: Version of the secret in Secret Manager. :param path: Path of the secret to mount inside the job (either path or env_var_name must be set). One-Of (‘secret_config’): at most one of ‘path’, ‘env_var_name’ could be set. :param env_var_name: Environment variable name used to expose the secret inside the job (either path or env_var_name must be set). One-Of (‘secret_config’): at most one of ‘path’, ‘env_var_name’ could be set. :return: Secret

Usage:

result = api.update_job_definition_secret(
    job_definition_id="example",
    secret_id="example",
)

scaleway.jobs.v1alpha1.content module

scaleway.jobs.v1alpha1.content.JOB_RUN_TRANSIENT_STATUSES: List[JobRunState] = [<JobRunState.QUEUED: 'queued'>, <JobRunState.SCHEDULED: 'scheduled'>, <JobRunState.RUNNING: 'running'>]: Lists transient statutes of the enum JobRunState.

scaleway.jobs.v1alpha1.marshalling module

scaleway.jobs.v1alpha1.marshalling.marshal_CreateJobDefinitionRequest(request: CreateJobDefinitionRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.marshal_CreateJobDefinitionRequestCronScheduleConfig(request: CreateJobDefinitionRequestCronScheduleConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.marshal_CreateJobDefinitionSecretsRequest(request: CreateJobDefinitionSecretsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.marshal_CreateJobDefinitionSecretsRequestSecretConfig(request: CreateJobDefinitionSecretsRequestSecretConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.marshal_StartJobDefinitionRequest(request: StartJobDefinitionRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.marshal_UpdateJobDefinitionRequest(request: UpdateJobDefinitionRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.marshal_UpdateJobDefinitionRequestCronScheduleConfig(request: UpdateJobDefinitionRequestCronScheduleConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.marshal_UpdateJobDefinitionSecretRequest(request: UpdateJobDefinitionSecretRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.jobs.v1alpha1.marshalling.unmarshal_CreateJobDefinitionSecretsResponse(data: Any) → CreateJobDefinitionSecretsResponse

scaleway.jobs.v1alpha1.marshalling.unmarshal_CronSchedule(data: Any) → CronSchedule

scaleway.jobs.v1alpha1.marshalling.unmarshal_JobDefinition(data: Any) → JobDefinition

scaleway.jobs.v1alpha1.marshalling.unmarshal_JobRun(data: Any) → JobRun

scaleway.jobs.v1alpha1.marshalling.unmarshal_JobsLimits(data: Any) → JobsLimits

scaleway.jobs.v1alpha1.marshalling.unmarshal_ListJobDefinitionSecretsResponse(data: Any) → ListJobDefinitionSecretsResponse

scaleway.jobs.v1alpha1.marshalling.unmarshal_ListJobDefinitionsResponse(data: Any) → ListJobDefinitionsResponse

scaleway.jobs.v1alpha1.marshalling.unmarshal_ListJobRunsResponse(data: Any) → ListJobRunsResponse

scaleway.jobs.v1alpha1.marshalling.unmarshal_ListJobsResourcesResponse(data: Any) → ListJobsResourcesResponse

scaleway.jobs.v1alpha1.marshalling.unmarshal_Resource(data: Any) → Resource

scaleway.jobs.v1alpha1.marshalling.unmarshal_Secret(data: Any) → Secret

scaleway.jobs.v1alpha1.marshalling.unmarshal_SecretEnvVar(data: Any) → SecretEnvVar

scaleway.jobs.v1alpha1.marshalling.unmarshal_SecretFile(data: Any) → SecretFile

scaleway.jobs.v1alpha1.marshalling.unmarshal_StartJobDefinitionResponse(data: Any) → StartJobDefinitionResponse

scaleway.jobs.v1alpha1.types module

class scaleway.jobs.v1alpha1.types.CreateJobDefinitionRequest(cpu_limit: 'int', memory_limit: 'int', image_uri: 'str', command: 'str', description: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, local_storage_capacity: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, environment_variables: 'Optional[Dict[str, str]]' = <factory>, job_timeout: 'Optional[str]' = None, cron_schedule: 'Optional[CreateJobDefinitionRequestCronScheduleConfig]' = None)

Bases: object

command: str: Startup command. If empty or not defined, the image’s default command is used.

cpu_limit: int: CPU limit of the job.

cron_schedule: CreateJobDefinitionRequestCronScheduleConfig | None = None: Configure a cron for the job.

description: str: Description of the job.

environment_variables: Dict[str, str] | None: Environment variables of the job.

image_uri: str: Image to use for the job.

job_timeout: str | None = None: Timeout of the job in seconds.

local_storage_capacity: int | None = 0: Local storage capacity of the job (in MiB).

memory_limit: int: Memory limit of the job (in MiB).

name: str | None = None: Name of the job definition.

project_id: str | None = None: UUID of the Scaleway Project containing the job.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.CreateJobDefinitionRequestCronScheduleConfig(schedule: 'str', timezone: 'str')

Bases: object

schedule: str

timezone: str

class scaleway.jobs.v1alpha1.types.CreateJobDefinitionSecretsRequest(job_definition_id: 'str', secrets: 'List[CreateJobDefinitionSecretsRequestSecretConfig]', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

secrets: List[CreateJobDefinitionSecretsRequestSecretConfig]: List of secrets to inject into the job.

class scaleway.jobs.v1alpha1.types.CreateJobDefinitionSecretsRequestSecretConfig(secret_manager_id: 'str', secret_manager_version: 'str', path: 'Optional[str]' = None, env_var_name: 'Optional[str]' = None)

Bases: object

env_var_name: str | None = None

path: str | None = None

secret_manager_id: str

secret_manager_version: str

class scaleway.jobs.v1alpha1.types.CreateJobDefinitionSecretsResponse(secrets: 'List[Secret]')

Bases: object

secrets: List[Secret]: List of secrets created.

class scaleway.jobs.v1alpha1.types.CronSchedule(schedule: 'str', timezone: 'str')

Bases: object

schedule: str: UNIX cron schedule to run job (e.g., ‘* * * * *’).

timezone: str: Timezone for the cron schedule, in tz database format (e.g., ‘Europe/Paris’).

class scaleway.jobs.v1alpha1.types.DeleteJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.DeleteJobDefinitionSecretRequest(job_definition_id: 'str', secret_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

secret_id: str: UUID of the secret reference within the job.

class scaleway.jobs.v1alpha1.types.GetJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.GetJobDefinitionSecretRequest(job_definition_id: 'str', secret_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

secret_id: str: UUID of the secret reference within the job.

class scaleway.jobs.v1alpha1.types.GetJobRunRequest(job_run_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_run_id: str: UUID of the job run to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.GetJobsLimitsRequest(region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.JobDefinition(id: 'str', name: 'str', cpu_limit: 'int', memory_limit: 'int', image_uri: 'str', command: 'str', project_id: 'str', environment_variables: 'Dict[str, str]', description: 'str', local_storage_capacity: 'int', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, job_timeout: 'Optional[str]' = None, cron_schedule: 'Optional[CronSchedule]' = None)

Bases: object

command: str

cpu_limit: int

created_at: datetime | None = None

cron_schedule: CronSchedule | None = None

description: str

environment_variables: Dict[str, str]

id: str

image_uri: str

job_timeout: str | None = None

local_storage_capacity: int

memory_limit: int

name: str

project_id: str

region: str: Region to target. If none is passed will use default region from the config.

updated_at: datetime | None = None

class scaleway.jobs.v1alpha1.types.JobRun(id: 'str', job_definition_id: 'str', state: 'JobRunState', error_message: 'str', cpu_limit: 'int', memory_limit: 'int', command: 'str', environment_variables: 'Dict[str, str]', local_storage_capacity: 'int', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, terminated_at: 'Optional[datetime]' = None, exit_code: 'Optional[int]' = None, run_duration: 'Optional[str]' = None, started_at: 'Optional[datetime]' = None)

Bases: object

command: str

cpu_limit: int

created_at: datetime | None = None

environment_variables: Dict[str, str]

error_message: str

exit_code: int | None = None

id: str

job_definition_id: str

local_storage_capacity: int

memory_limit: int

region: str: Region to target. If none is passed will use default region from the config.

run_duration: str | None = None

started_at: datetime | None = None

state: JobRunState

terminated_at: datetime | None = None

updated_at: datetime | None = None

class scaleway.jobs.v1alpha1.types.JobRunState(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CANCELED = 'canceled'

FAILED = 'failed'

INTERNAL_ERROR = 'internal_error'

QUEUED = 'queued'

RUNNING = 'running'

SCHEDULED = 'scheduled'

SUCCEEDED = 'succeeded'

UNKNOWN_STATE = 'unknown_state'

class scaleway.jobs.v1alpha1.types.JobsLimits(secrets_per_job_definition: 'int')

Bases: object

secrets_per_job_definition: int

class scaleway.jobs.v1alpha1.types.ListJobDefinitionSecretsRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.ListJobDefinitionSecretsResponse(secrets: 'List[Secret]', total_count: 'int')

Bases: object

secrets: List[Secret]: List of secret references within a job definition.

total_count: int: Total count of secret references within a job definition.

class scaleway.jobs.v1alpha1.types.ListJobDefinitionsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListJobDefinitionsRequestOrderBy]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None)

Bases: object

order_by: ListJobDefinitionsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.ListJobDefinitionsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.jobs.v1alpha1.types.ListJobDefinitionsResponse(job_definitions: 'List[JobDefinition]', total_count: 'int')

Bases: object

job_definitions: List[JobDefinition]

total_count: int

class scaleway.jobs.v1alpha1.types.ListJobRunsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListJobRunsRequestOrderBy]' = None, job_definition_id: 'Optional[str]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, state: 'Optional[JobRunState]' = None, states: 'Optional[List[JobRunState]]' = <factory>)

Bases: object

job_definition_id: str | None = None

order_by: ListJobRunsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

region: str | None = None: Region to target. If none is passed will use default region from the config.

state: JobRunState | None = None

states: List[JobRunState] | None

class scaleway.jobs.v1alpha1.types.ListJobRunsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.jobs.v1alpha1.types.ListJobRunsResponse(job_runs: 'List[JobRun]', total_count: 'int')

Bases: object

job_runs: List[JobRun]

total_count: int

class scaleway.jobs.v1alpha1.types.ListJobsResourcesRequest(region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.ListJobsResourcesResponse(resources: 'List[Resource]')

Bases: object

resources: List[Resource]

class scaleway.jobs.v1alpha1.types.Resource(cpu_limit: 'int', memory_limit: 'int')

Bases: object

cpu_limit: int

memory_limit: int

class scaleway.jobs.v1alpha1.types.Secret(secret_id: 'str', secret_manager_id: 'str', secret_manager_version: 'str', file: 'Optional[SecretFile]' = None, env_var: 'Optional[SecretEnvVar]' = None)

Bases: object

env_var: SecretEnvVar | None = None

file: SecretFile | None = None

secret_id: str: UUID of the secret reference within the job.

secret_manager_id: str: UUID of the secret in Secret Manager.

secret_manager_version: str: Version of the secret in Secret Manager.

class scaleway.jobs.v1alpha1.types.SecretEnvVar(name: 'str')

Bases: object

name: str

class scaleway.jobs.v1alpha1.types.SecretFile(path: 'str')

Bases: object

path: str

class scaleway.jobs.v1alpha1.types.StartJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None, command: 'Optional[str]' = None, environment_variables: 'Optional[Dict[str, str]]' = <factory>, replicas: 'Optional[int]' = 0)

Bases: object

command: str | None = None: Contextual startup command for this specific job run.

environment_variables: Dict[str, str] | None: Contextual environment variables for this specific job run.

job_definition_id: str: UUID of the job definition to start.

region: str | None = None: Region to target. If none is passed will use default region from the config.

replicas: int | None = 0: Number of jobs to run.

class scaleway.jobs.v1alpha1.types.StartJobDefinitionResponse(job_runs: 'List[JobRun]')

Bases: object

job_runs: List[JobRun]

class scaleway.jobs.v1alpha1.types.StopJobRunRequest(job_run_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_run_id: str: UUID of the job run to stop.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.UpdateJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, cpu_limit: 'Optional[int]' = 0, memory_limit: 'Optional[int]' = 0, local_storage_capacity: 'Optional[int]' = 0, image_uri: 'Optional[str]' = None, command: 'Optional[str]' = None, environment_variables: 'Optional[Dict[str, str]]' = <factory>, description: 'Optional[str]' = None, job_timeout: 'Optional[str]' = None, cron_schedule: 'Optional[UpdateJobDefinitionRequestCronScheduleConfig]' = None)

Bases: object

command: str | None = None: Startup command.

cpu_limit: int | None = 0: CPU limit of the job.

cron_schedule: UpdateJobDefinitionRequestCronScheduleConfig | None = None

description: str | None = None: Description of the job.

environment_variables: Dict[str, str] | None: Environment variables of the job.

image_uri: str | None = None: Image to use for the job.

job_definition_id: str: UUID of the job definition to update.

job_timeout: str | None = None: Timeout of the job in seconds.

local_storage_capacity: int | None = 0: Local storage capacity of the job (in MiB).

memory_limit: int | None = 0: Memory limit of the job (in MiB).

name: str | None = None: Name of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.types.UpdateJobDefinitionRequestCronScheduleConfig(schedule: 'Optional[str]' = None, timezone: 'Optional[str]' = None)

Bases: object

schedule: str | None = None

timezone: str | None = None

class scaleway.jobs.v1alpha1.types.UpdateJobDefinitionSecretRequest(job_definition_id: 'str', secret_id: 'str', region: 'Optional[ScwRegion]' = None, secret_manager_version: 'Optional[str]' = None, path: 'Optional[str]' = None, env_var_name: 'Optional[str]' = None)

Bases: object

env_var_name: str | None = None

job_definition_id: str: UUID of the job definition.

path: str | None = None

region: str | None = None: Region to target. If none is passed will use default region from the config.

secret_id: str: UUID of the secret reference within the job.

secret_manager_version: str | None = None: Version of the secret in Secret Manager.

Module contents

class scaleway.jobs.v1alpha1.CreateJobDefinitionRequest(cpu_limit: 'int', memory_limit: 'int', image_uri: 'str', command: 'str', description: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, local_storage_capacity: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, environment_variables: 'Optional[Dict[str, str]]' = <factory>, job_timeout: 'Optional[str]' = None, cron_schedule: 'Optional[CreateJobDefinitionRequestCronScheduleConfig]' = None)

Bases: object

command: str: Startup command. If empty or not defined, the image’s default command is used.

cpu_limit: int: CPU limit of the job.

cron_schedule: CreateJobDefinitionRequestCronScheduleConfig | None = None: Configure a cron for the job.

description: str: Description of the job.

environment_variables: Dict[str, str] | None: Environment variables of the job.

image_uri: str: Image to use for the job.

job_timeout: str | None = None: Timeout of the job in seconds.

local_storage_capacity: int | None = 0: Local storage capacity of the job (in MiB).

memory_limit: int: Memory limit of the job (in MiB).

name: str | None = None: Name of the job definition.

project_id: str | None = None: UUID of the Scaleway Project containing the job.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.CreateJobDefinitionRequestCronScheduleConfig(schedule: 'str', timezone: 'str')

Bases: object

schedule: str

timezone: str

class scaleway.jobs.v1alpha1.CreateJobDefinitionSecretsRequest(job_definition_id: 'str', secrets: 'List[CreateJobDefinitionSecretsRequestSecretConfig]', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

secrets: List[CreateJobDefinitionSecretsRequestSecretConfig]: List of secrets to inject into the job.

class scaleway.jobs.v1alpha1.CreateJobDefinitionSecretsRequestSecretConfig(secret_manager_id: 'str', secret_manager_version: 'str', path: 'Optional[str]' = None, env_var_name: 'Optional[str]' = None)

Bases: object

env_var_name: str | None = None

path: str | None = None

secret_manager_id: str

secret_manager_version: str

class scaleway.jobs.v1alpha1.CreateJobDefinitionSecretsResponse(secrets: 'List[Secret]')

Bases: object

secrets: List[Secret]: List of secrets created.

class scaleway.jobs.v1alpha1.CronSchedule(schedule: 'str', timezone: 'str')

Bases: object

schedule: str: UNIX cron schedule to run job (e.g., ‘* * * * *’).

timezone: str: Timezone for the cron schedule, in tz database format (e.g., ‘Europe/Paris’).

class scaleway.jobs.v1alpha1.DeleteJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.DeleteJobDefinitionSecretRequest(job_definition_id: 'str', secret_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

secret_id: str: UUID of the secret reference within the job.

class scaleway.jobs.v1alpha1.GetJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.GetJobDefinitionSecretRequest(job_definition_id: 'str', secret_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

secret_id: str: UUID of the secret reference within the job.

class scaleway.jobs.v1alpha1.GetJobRunRequest(job_run_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_run_id: str: UUID of the job run to get.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.GetJobsLimitsRequest(region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.JobDefinition(id: 'str', name: 'str', cpu_limit: 'int', memory_limit: 'int', image_uri: 'str', command: 'str', project_id: 'str', environment_variables: 'Dict[str, str]', description: 'str', local_storage_capacity: 'int', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, job_timeout: 'Optional[str]' = None, cron_schedule: 'Optional[CronSchedule]' = None)

Bases: object

command: str

cpu_limit: int

created_at: datetime | None = None

cron_schedule: CronSchedule | None = None

description: str

environment_variables: Dict[str, str]

id: str

image_uri: str

job_timeout: str | None = None

local_storage_capacity: int

memory_limit: int

name: str

project_id: str

region: str: Region to target. If none is passed will use default region from the config.

updated_at: datetime | None = None

class scaleway.jobs.v1alpha1.JobRun(id: 'str', job_definition_id: 'str', state: 'JobRunState', error_message: 'str', cpu_limit: 'int', memory_limit: 'int', command: 'str', environment_variables: 'Dict[str, str]', local_storage_capacity: 'int', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, terminated_at: 'Optional[datetime]' = None, exit_code: 'Optional[int]' = None, run_duration: 'Optional[str]' = None, started_at: 'Optional[datetime]' = None)

Bases: object

command: str

cpu_limit: int

created_at: datetime | None = None

environment_variables: Dict[str, str]

error_message: str

exit_code: int | None = None

id: str

job_definition_id: str

local_storage_capacity: int

memory_limit: int

region: str: Region to target. If none is passed will use default region from the config.

run_duration: str | None = None

started_at: datetime | None = None

state: JobRunState

terminated_at: datetime | None = None

updated_at: datetime | None = None

class scaleway.jobs.v1alpha1.JobRunState(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CANCELED = 'canceled'

FAILED = 'failed'

INTERNAL_ERROR = 'internal_error'

QUEUED = 'queued'

RUNNING = 'running'

SCHEDULED = 'scheduled'

SUCCEEDED = 'succeeded'

UNKNOWN_STATE = 'unknown_state'

class scaleway.jobs.v1alpha1.JobsLimits(secrets_per_job_definition: 'int')

Bases: object

secrets_per_job_definition: int

class scaleway.jobs.v1alpha1.JobsV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Serverless Jobs.

create_job_definition(*, cpu_limit: int, memory_limit: int, image_uri: str, command: str, description: str, region: str | None = None, name: str | None = None, local_storage_capacity: int | None = None, project_id: str | None = None, environment_variables: Dict[str, str] | None = None, job_timeout: str | None = None, cron_schedule: CreateJobDefinitionRequestCronScheduleConfig | None = None) → JobDefinition

Create a new job definition in a specified Project. :param cpu_limit: CPU limit of the job. :param memory_limit: Memory limit of the job (in MiB). :param image_uri: Image to use for the job. :param command: Startup command. If empty or not defined, the image’s default command is used. :param description: Description of the job. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the job definition. :param local_storage_capacity: Local storage capacity of the job (in MiB). :param project_id: UUID of the Scaleway Project containing the job. :param environment_variables: Environment variables of the job. :param job_timeout: Timeout of the job in seconds. :param cron_schedule: Configure a cron for the job. :return: JobDefinition

Usage:

result = api.create_job_definition(
    cpu_limit=1,
    memory_limit=1,
    image_uri="example",
    command="example",
    description="example",
)

create_job_definition_secrets(*, job_definition_id: str, secrets: List[CreateJobDefinitionSecretsRequestSecretConfig], region: str | None = None) → CreateJobDefinitionSecretsResponse

Create a secret reference within a job definition. :param job_definition_id: UUID of the job definition. :param secrets: List of secrets to inject into the job. :param region: Region to target. If none is passed will use default region from the config. :return: CreateJobDefinitionSecretsResponse

Usage:

result = api.create_job_definition_secrets(
    job_definition_id="example",
    secrets=[],
)

delete_job_definition(*, job_definition_id: str, region: str | None = None) → None

Delete an exsisting job definition by its unique identifier. :param job_definition_id: UUID of the job definition to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_job_definition(
    job_definition_id="example",
)

delete_job_definition_secret(*, job_definition_id: str, secret_id: str, region: str | None = None) → None

Delete a secret reference within a job definition. :param job_definition_id: UUID of the job definition. :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_job_definition_secret(
    job_definition_id="example",
    secret_id="example",
)

get_job_definition(*, job_definition_id: str, region: str | None = None) → JobDefinition

Get a job definition by its unique identifier. :param job_definition_id: UUID of the job definition to get. :param region: Region to target. If none is passed will use default region from the config. :return: JobDefinition

Usage:

result = api.get_job_definition(
    job_definition_id="example",
)

get_job_definition_secret(*, job_definition_id: str, secret_id: str, region: str | None = None) → Secret

Get a secret references within a job definition. :param job_definition_id: UUID of the job definition. :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. :return: Secret

Usage:

result = api.get_job_definition_secret(
    job_definition_id="example",
    secret_id="example",
)

get_job_run(*, job_run_id: str, region: str | None = None) → JobRun

Get a job run by its unique identifier. :param job_run_id: UUID of the job run to get. :param region: Region to target. If none is passed will use default region from the config. :return: JobRun

Usage:

result = api.get_job_run(
    job_run_id="example",
)

get_jobs_limits(*, region: str | None = None) → JobsLimits

Get jobs limits for the console. :param region: Region to target. If none is passed will use default region from the config. :return: JobsLimits

Usage:

result = api.get_jobs_limits()

list_job_definition_secrets(*, job_definition_id: str, region: str | None = None) → ListJobDefinitionSecretsResponse

List secrets references within a job definition. :param job_definition_id: UUID of the job definition. :param region: Region to target. If none is passed will use default region from the config. :return: ListJobDefinitionSecretsResponse

Usage:

result = api.list_job_definition_secrets(
    job_definition_id="example",
)

List all your job definitions with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: ListJobDefinitionsResponse

Usage:

result = api.list_job_definitions()

List all your job definitions with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param project_id: :param organization_id: :return: List[JobDefinition]

Usage:

result = api.list_job_definitions_all()

List all job runs with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param job_definition_id: :param project_id: :param organization_id: :param state: :param states: :return: ListJobRunsResponse

Usage:

result = api.list_job_runs()

List all job runs with filters. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param order_by: :param job_definition_id: :param project_id: :param organization_id: :param state: :param states: :return: List[JobRun]

Usage:

result = api.list_job_runs_all()

list_jobs_resources(*, region: str | None = None) → ListJobsResourcesResponse

List jobs resources for the console. :param region: Region to target. If none is passed will use default region from the config. :return: ListJobsResourcesResponse

Usage:

result = api.list_jobs_resources()

start_job_definition(*, job_definition_id: str, region: str | None = None, command: str | None = None, environment_variables: Dict[str, str] | None = None, replicas: int | None = None) → StartJobDefinitionResponse

Run an existing job definition by its unique identifier. This will create a new job run. :param job_definition_id: UUID of the job definition to start. :param region: Region to target. If none is passed will use default region from the config. :param command: Contextual startup command for this specific job run. :param environment_variables: Contextual environment variables for this specific job run. :param replicas: Number of jobs to run. :return: StartJobDefinitionResponse

Usage:

result = api.start_job_definition(
    job_definition_id="example",
)

stop_job_run(*, job_run_id: str, region: str | None = None) → JobRun

Stop a job run by its unique identifier. :param job_run_id: UUID of the job run to stop. :param region: Region to target. If none is passed will use default region from the config. :return: JobRun

Usage:

result = api.stop_job_run(
    job_run_id="example",
)

Update an existing job definition associated with the specified unique identifier. :param job_definition_id: UUID of the job definition to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the job definition. :param cpu_limit: CPU limit of the job. :param memory_limit: Memory limit of the job (in MiB). :param local_storage_capacity: Local storage capacity of the job (in MiB). :param image_uri: Image to use for the job. :param command: Startup command. :param environment_variables: Environment variables of the job. :param description: Description of the job. :param job_timeout: Timeout of the job in seconds. :param cron_schedule: :return: JobDefinition

Usage:

result = api.update_job_definition(
    job_definition_id="example",
)

update_job_definition_secret(*, job_definition_id: str, secret_id: str, region: str | None = None, secret_manager_version: str | None = None, path: str | None = None, env_var_name: str | None = None) → Secret

Update a secret reference within a job definition. :param job_definition_id: UUID of the job definition. :param secret_id: UUID of the secret reference within the job. :param region: Region to target. If none is passed will use default region from the config. :param secret_manager_version: Version of the secret in Secret Manager. :param path: Path of the secret to mount inside the job (either path or env_var_name must be set). One-Of (‘secret_config’): at most one of ‘path’, ‘env_var_name’ could be set. :param env_var_name: Environment variable name used to expose the secret inside the job (either path or env_var_name must be set). One-Of (‘secret_config’): at most one of ‘path’, ‘env_var_name’ could be set. :return: Secret

Usage:

result = api.update_job_definition_secret(
    job_definition_id="example",
    secret_id="example",
)

class scaleway.jobs.v1alpha1.ListJobDefinitionSecretsRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_definition_id: str: UUID of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.ListJobDefinitionSecretsResponse(secrets: 'List[Secret]', total_count: 'int')

Bases: object

secrets: List[Secret]: List of secret references within a job definition.

total_count: int: Total count of secret references within a job definition.

class scaleway.jobs.v1alpha1.ListJobDefinitionsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListJobDefinitionsRequestOrderBy]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None)

Bases: object

order_by: ListJobDefinitionsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.ListJobDefinitionsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.jobs.v1alpha1.ListJobDefinitionsResponse(job_definitions: 'List[JobDefinition]', total_count: 'int')

Bases: object

job_definitions: List[JobDefinition]

total_count: int

class scaleway.jobs.v1alpha1.ListJobRunsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = None, page_size: 'Optional[int]' = None, order_by: 'Optional[ListJobRunsRequestOrderBy]' = None, job_definition_id: 'Optional[str]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, state: 'Optional[JobRunState]' = None, states: 'Optional[List[JobRunState]]' = <factory>)

Bases: object

job_definition_id: str | None = None

order_by: ListJobRunsRequestOrderBy | None = None

organization_id: str | None = None

page: int | None = None

page_size: int | None = None

project_id: str | None = None

region: str | None = None: Region to target. If none is passed will use default region from the config.

state: JobRunState | None = None

states: List[JobRunState] | None

class scaleway.jobs.v1alpha1.ListJobRunsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.jobs.v1alpha1.ListJobRunsResponse(job_runs: 'List[JobRun]', total_count: 'int')

Bases: object

job_runs: List[JobRun]

total_count: int

class scaleway.jobs.v1alpha1.ListJobsResourcesRequest(region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.ListJobsResourcesResponse(resources: 'List[Resource]')

Bases: object

resources: List[Resource]

class scaleway.jobs.v1alpha1.Resource(cpu_limit: 'int', memory_limit: 'int')

Bases: object

cpu_limit: int

memory_limit: int

class scaleway.jobs.v1alpha1.Secret(secret_id: 'str', secret_manager_id: 'str', secret_manager_version: 'str', file: 'Optional[SecretFile]' = None, env_var: 'Optional[SecretEnvVar]' = None)

Bases: object

env_var: SecretEnvVar | None = None

file: SecretFile | None = None

secret_id: str: UUID of the secret reference within the job.

secret_manager_id: str: UUID of the secret in Secret Manager.

secret_manager_version: str: Version of the secret in Secret Manager.

class scaleway.jobs.v1alpha1.SecretEnvVar(name: 'str')

Bases: object

name: str

class scaleway.jobs.v1alpha1.SecretFile(path: 'str')

Bases: object

path: str

class scaleway.jobs.v1alpha1.StartJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None, command: 'Optional[str]' = None, environment_variables: 'Optional[Dict[str, str]]' = <factory>, replicas: 'Optional[int]' = 0)

Bases: object

command: str | None = None: Contextual startup command for this specific job run.

environment_variables: Dict[str, str] | None: Contextual environment variables for this specific job run.

job_definition_id: str: UUID of the job definition to start.

region: str | None = None: Region to target. If none is passed will use default region from the config.

replicas: int | None = 0: Number of jobs to run.

class scaleway.jobs.v1alpha1.StartJobDefinitionResponse(job_runs: 'List[JobRun]')

Bases: object

job_runs: List[JobRun]

class scaleway.jobs.v1alpha1.StopJobRunRequest(job_run_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

job_run_id: str: UUID of the job run to stop.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.UpdateJobDefinitionRequest(job_definition_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, cpu_limit: 'Optional[int]' = 0, memory_limit: 'Optional[int]' = 0, local_storage_capacity: 'Optional[int]' = 0, image_uri: 'Optional[str]' = None, command: 'Optional[str]' = None, environment_variables: 'Optional[Dict[str, str]]' = <factory>, description: 'Optional[str]' = None, job_timeout: 'Optional[str]' = None, cron_schedule: 'Optional[UpdateJobDefinitionRequestCronScheduleConfig]' = None)

Bases: object

command: str | None = None: Startup command.

cpu_limit: int | None = 0: CPU limit of the job.

cron_schedule: UpdateJobDefinitionRequestCronScheduleConfig | None = None

description: str | None = None: Description of the job.

environment_variables: Dict[str, str] | None: Environment variables of the job.

image_uri: str | None = None: Image to use for the job.

job_definition_id: str: UUID of the job definition to update.

job_timeout: str | None = None: Timeout of the job in seconds.

local_storage_capacity: int | None = 0: Local storage capacity of the job (in MiB).

memory_limit: int | None = 0: Memory limit of the job (in MiB).

name: str | None = None: Name of the job definition.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.jobs.v1alpha1.UpdateJobDefinitionRequestCronScheduleConfig(schedule: 'Optional[str]' = None, timezone: 'Optional[str]' = None)

Bases: object

schedule: str | None = None

timezone: str | None = None

class scaleway.jobs.v1alpha1.UpdateJobDefinitionSecretRequest(job_definition_id: 'str', secret_id: 'str', region: 'Optional[ScwRegion]' = None, secret_manager_version: 'Optional[str]' = None, path: 'Optional[str]' = None, env_var_name: 'Optional[str]' = None)

Bases: object

env_var_name: str | None = None

job_definition_id: str: UUID of the job definition.

path: str | None = None

region: str | None = None: Region to target. If none is passed will use default region from the config.

secret_id: str: UUID of the secret reference within the job.

secret_manager_version: str | None = None: Version of the secret in Secret Manager.