Execution Profiles¶

Accessed via client.execution_profiles.

pyawe.client.ExecutionProfilesClient ¶

ExecutionProfilesClient(http: _HttpSession)

Methods for the /execution-profiles resource.

list ¶

list() -> builtins.list[ExecutionProfile]

Return all execution profiles.

Returns:

Type	Description
`list[ExecutionProfile]`	List of :class:`~pyawe.models.ExecutionProfile` objects.

Raises:

Type	Description
`AweAuthError`	If not authenticated.

create ¶

create(name: str, image: str, *, description: str | None = None, cpu_request: str | None = None, cpu_limit: str | None = None, memory_request: str | None = None, memory_limit: str | None = None, image_pull_policy: str | None = None, enable_buildkit_sidecar: bool | None = None, runner_pool: str | None = None) -> ExecutionProfile

Create a new execution profile.

The image must match the server's AWE_ALLOWED_IMAGES patterns.

Parameters:

Name	Type	Description	Default
`name`	`str`	Unique human-readable name shown in the UI.	required
`image`	`str`	Full OCI image reference, e.g. `"python:3.12-slim"`.	required
`description`	`str \| None`	Optional description.	`None`
`cpu_request`	`str \| None`	Kubernetes CPU request, e.g. `"100m"`.	`None`
`cpu_limit`	`str \| None`	Kubernetes CPU limit, e.g. `"1"`.	`None`
`memory_request`	`str \| None`	Kubernetes memory request, e.g. `"128Mi"`.	`None`
`memory_limit`	`str \| None`	Kubernetes memory limit, e.g. `"512Mi"`.	`None`
`image_pull_policy`	`str \| None`	Kubernetes `imagePullPolicy` (default `"IfNotPresent"`).	`None`
`enable_buildkit_sidecar`	`bool \| None`	Opt in to a rootless `buildkitd` native sidecar (default `False`).	`None`
`runner_pool`	`str \| None`	Which `awe-runner` pool dispatches this profile's tasks (default `"default"`).	`None`

Returns:

Type	Description
`ExecutionProfile`	The newly created :class:`~pyawe.models.ExecutionProfile`.

Raises:

Type	Description
`AweAuthError`	If not authenticated.
`AweValidationError`	On a 400 response.

get ¶

get(profile_id: UUID | str) -> ExecutionProfile

Fetch an execution profile.

Parameters:

Name	Type	Description	Default
`profile_id`	`UUID \| str`	UUID of the execution profile.	required

Returns:

Type	Description
`ExecutionProfile`	class:`~pyawe.models.ExecutionProfile`.

Raises:

Type	Description
`AweNotFoundError`	If the profile does not exist.
`AweAuthError`	If not authenticated.

update ¶

update(profile_id: UUID | str, *, name: str | None = None, image: str | None = None, description: str | None = None, cpu_request: str | None = None, cpu_limit: str | None = None, memory_request: str | None = None, memory_limit: str | None = None, image_pull_policy: str | None = None, enable_buildkit_sidecar: bool | None = None, runner_pool: str | None = None) -> ExecutionProfile

Update an execution profile; only supplied fields are changed.

Parameters:

Name	Type	Description	Default
`profile_id`	`UUID \| str`	UUID of the profile to update.	required
`name`	`str \| None`	New name.	`None`
`image`	`str \| None`	New OCI image reference.	`None`
`description`	`str \| None`	New description.	`None`
`cpu_request`	`str \| None`	New CPU request.	`None`
`cpu_limit`	`str \| None`	New CPU limit.	`None`
`memory_request`	`str \| None`	New memory request.	`None`
`memory_limit`	`str \| None`	New memory limit.	`None`
`image_pull_policy`	`str \| None`	New Kubernetes `imagePullPolicy`.	`None`
`enable_buildkit_sidecar`	`bool \| None`	Opt in to a rootless `buildkitd` native sidecar.	`None`
`runner_pool`	`str \| None`	New `awe-runner` pool.	`None`

Returns:

Type	Description
`ExecutionProfile`	The updated :class:`~pyawe.models.ExecutionProfile`.

Raises:

Type	Description
`AweNotFoundError`	If the profile does not exist.
`AweAuthError`	If not authenticated.

delete ¶

delete(profile_id: UUID | str) -> None

Delete an execution profile.

Parameters:

Name	Type	Description	Default
`profile_id`	`UUID \| str`	UUID of the profile to delete.	required

Raises:

Type	Description
`AweNotFoundError`	If the profile does not exist.
`AweAuthError`	If not authenticated.