Python SDK Reference

Check your docs version

This version of the Anyscale docs is deprecated. Go to the latest version for up to date information.

note

Please note that only AnyscaleSDK and imports under anyscale.sdk are considered public.

AnyscaleSDK

The AnyscaleSDK class must be constructed in order to make calls to the SDK. This class allows you to create an authenticated client in which to use the SDK.

Param	Type	Description
auth_token	Optional String	Authentication token used to verify you have permissions to access Anyscale. If not provided, we will default to the credentials set for your current user. Credentials can be set by following the instructions on this page: https://console.anyscale.com/credentials

Example

from anyscale import AnyscaleSDK

sdk = AnyscaleSDK()

Utility Functions

build_cluster_environment

Creates a new Cluster Environment and waits for build to complete.

If a Cluster Environment with the same name already exists, this will create an updated build of that environment.

Returns the newly created ClusterEnvironmentBuild object.

Raises an Exception if building Cluster Environment fails or times out.

Param	Type	Description
create_cluster_environment	CreateClusterEnvironment	CreateClusterEnvironment object
poll_rate_seconds	Optional Integer	seconds to wait when polling build operation status; defaults to 15
timeout_seconds	Optional Integer	maximum number of seconds to wait for build operation to complete before timing out; defaults to no timeout

Example

from anyscale.sdk.anyscale_client.models.create_cluster_environment import (
    CreateClusterEnvironment,
)
from anyscale import AnyscaleSDK

sdk = AnyscaleSDK(auth_token="sss_YourAuthToken")

create_cluster_environment = CreateClusterEnvironment(
    name="my-cluster-environment",
    config_json={"base_image": "anyscale/ray:1.4.1-py37"}
)

cluster_environment_build = sdk.build_cluster_environment(
    create_cluster_environment=create_cluster_environment
)

print(f"Cluster Environment built successfully: {cluster_environment_build}")

fetch_actor_logs

Retrieves logs for an Actor.

This function may take several minutes if the Cluster this Actor ran on has been terminated.

Returns the log output as a string.

Raises an Exception if fetching logs fails.

Param	Type	Description
actor_id	String	ID of the Actor

Example

from anyscale.sdk.anyscale_client.models.create_cluster_environment import (
    CreateClusterEnvironment,
)
from anyscale import AnyscaleSDK

sdk = AnyscaleSDK(auth_token="sss_YourAuthToken")

actor_logs = sdk.fetch_actor_logs(actor_id="actor_id")

print(actor_logs)

fetch_job_logs

Retrieves logs for a Job.

This function may take several minutes if the Cluster this Job ran on has been terminated.

Returns the log output as a string.

Raises an Exception if fetching logs fails.

Param	Type	Description
job_id	String	ID of the Job

Example

from anyscale import AnyscaleSDK

sdk = AnyscaleSDK(auth_token="sss_YourAuthToken")

job_logs = sdk.fetch_job_logs(job_id="job_id")

print(job_logs)

fetch_production_job_logs

Retrieves logs for a Production Job.

This function may take several minutes if the Cluster this Production Job ran on has been terminated.

Returns the log output as a string.

Raises an Exception if fetching logs fails.

Param	Type	Description
job_id	String	ID of the Job

Example

from anyscale import AnyscaleSDK

sdk = AnyscaleSDK(auth_token="sss_YourAuthToken")

job_logs = sdk.fetch_production_job_logs(job_id="production_job_id")

print(job_logs)

launch_cluster

Starts a Cluster in the specified Project.

If a Cluster with the specified name already exists, we will update that Cluster. Otherwise, a new Cluster will be created.

Returns the started Cluster object.

Raises an Exception if starting Cluster fails or times out.

Param	Type	Description
project_id	String	ID of the Project the Cluster belongs to
cluster_name	String	Name of the Cluster
cluster_environment_build_id	String	ID of the Cluster Environment Build to start this Cluster with
cluster_compute_id	Optional String	ID of the Cluster Compute to start this Cluster with
cluster_compute_config	Optional Dict	One-off Cluster Compute that this Cluster will use, with same fields as ClusterComputeConfig
poll_rate_seconds	Optional Integer	seconds to wait when polling cluster operation status; defaults to 15
idle_timeout_minutes	Optional Integer	Idle timeout (in minutes), after which the Cluster is terminated; Defaults to 120 minutes.
timeout_seconds	Optional Integer	maximum number of seconds to wait for cluster operation to complete before timing out; defaults to no timeout

Example

from anyscale import AnyscaleSDK

sdk = AnyscaleSDK(auth_token="sss_YourAuthToken")

cluster = sdk.launch_cluster(
    project_id="project_id",
    cluster_name="my-cluster",
    cluster_environment_build_id="cluster_environment_build_id",
    cluster_compute_id="cluster_compute_id")

print(f"Cluster started successfully: {cluster}")

launch_cluster_with_new_cluster_environment

Builds a new Cluster Environment, then starts a Cluster in the specified Project with the new build.

If a Cluster with the specified name already exists, we will update that Cluster. Otherwise, a new Cluster will be created.

Returns the started Cluster object.

Raises an Exception if building Cluster Environment fails or starting the Cluster fails.

Param	Type	Description
project_id	String	ID of the Project the Cluster belongs to
cluster_name	String	Name of the Cluster
create_cluster_environment	CreateClusterEnvironment	CreateClusterEnvironment object
cluster_compute_id	Optional String	Cluster Compute to start this Cluster with
cluster_compute_config	Optional Dict	One-off Cluster Compute that this Cluster will use, with same fields as ClusterComputeConfig
poll_rate_seconds	Optional Integer	seconds to wait when polling operation status; defaults to 15
timeout_seconds	Optional Integer	maximum number of seconds to wait for operations to complete before timing out; defaults to no timeout

Example

from anyscale import AnyscaleSDK
from anyscale.sdk.anyscale_client.models.create_cluster_environment import (
    CreateClusterEnvironment,
)

sdk = AnyscaleSDK(auth_token="sss_YourAuthToken")

create_cluster_environment = CreateClusterEnvironment(
    name="my-cluster-environment",
    config_json={"base_image": "anyscale/ray:1.4.1-py37"}
)

cluster = sdk.launch_cluster_with_new_cluster_environment(
    project_id="project_id",
    cluster_name="my-cluster",
    create_cluster_environment=create_cluster_environment,
    cluster_compute_id="cluster_compute_id",
)

print(f"Cluster started successfully: {cluster}")

info

The OpenAPI schemas for types below can be found at the Anyscale OpenAPI Documentation

All of the following functions are synchronous by default. To make an asynchronous HTTP request, please pass async_req=True. The return value for the asynchronous calls is a thread.

thread = api.create_cloud(create_cloud, async_req=True)
result = thread.get()

Clouds

create_cloud

Creates a Cloud.

Parameters

Name	Type	Description	Notes
create_cloud	CreateCloud

Returns CloudResponse

delete_cloud

Deletes a Cloud. Will delete all clusters that are using this cloud. If any of those clusters are not terminated, this call will fail.

Parameters

Name	Type	Description	Notes
cloud_id	str	ID of the Cloud to delete.	Defaults to null

Returns void (empty response body)

get_cloud

Retrieves a Cloud.

Parameters

Name	Type	Description	Notes
cloud_id	str	ID of the Cloud to retrieve.	Defaults to null

Returns CloudResponse

get_default_cloud

Retrieves the default cloud for the logged in user. First prefers the default cloud set by the user's org, then the last used cloud.

Parameters This function does not have any parameters.

Returns CloudResponse

search_clouds

Searches for all accessible Clouds that satisfies the query.

Parameters

Name	Type	Description	Notes
clouds_query	CloudsQuery

Returns CloudListResponse

update_cloud

Updates a Cloud.

Parameters

Name	Type	Description	Notes
cloud_id	str	ID of the Cloud to update.	Defaults to null
update_cloud	UpdateCloud

Returns CloudResponse

Cluster Computes

create_cluster_compute

Creates a Cluster Compute. If the specified compute config is anonymous, returns an existing compute config if an anonymous one exists with the same config.

Parameters

Name	Type	Description	Notes
create_cluster_compute	CreateClusterCompute

Returns ClustercomputeResponse

delete_cluster_compute

Deletes a Cluster Compute.

Parameters

Name	Type	Description	Notes
cluster_compute_id	str	ID of the Cluster Compute to delete.	Defaults to null

Returns void (empty response body)

get_cluster_compute

Retrieves a Cluster Compute.

Parameters

Name	Type	Description	Notes
cluster_compute_id	str	ID of the Cluster Compute to retrieve.	Defaults to null

Returns ClustercomputeResponse

get_default_cluster_compute

Returns a default cluster compute that can be used with a given cloud.

Parameters

Name	Type	Description	Notes
cloud_id	optional str	The cloud id whose default cluster compute you want to fetch. If None, will use the default cloud.	Defaults to null

Returns ClustercomputeResponse

search_cluster_computes

Lists all Cluster Computes the user has access to, matching the input query.

Parameters

Name	Type	Description	Notes
cluster_computes_query	ClusterComputesQuery

Returns ClustercomputeListResponse

Cluster Environment Build Operations

get_cluster_environment_build_operation

Retrieves a Cluster Environment Build Operation.

Parameters

Name	Type	Description	Notes
cluster_environment_build_operation_id	str	ID of the Cluster Environment Build Operation to retrieve.	Defaults to null

Returns ClusterenvironmentbuildoperationResponse

Cluster Environment Builds

create_byod_cluster_environment_build

Creates and starts a BYOD Cluster Environment Build.

Parameters

Name	Type	Description	Notes
create_byod_cluster_environment_build	CreateBYODClusterEnvironmentBuild

Returns ClusterenvironmentbuildoperationResponse

create_cluster_environment_build

Creates and starts a Cluster Environment Build. This is a long running operation.

Parameters

Name	Type	Description	Notes
create_cluster_environment_build	CreateClusterEnvironmentBuild

Returns ClusterenvironmentbuildoperationResponse

find_cluster_environment_build_by_identifier

Looks for a cluster environment build given a cluster environment identifier. Identifiers are in the format my-cluster-env:1

Parameters

Name	Type	Description	Notes
identifier	str	Identifier of the cluster env to look for. Identifiers are in the format my-cluster-env:1	Defaults to null

Returns ClusterenvironmentbuildResponse

get_cluster_environment_build

Retrieves a Cluster Environment Build.

Parameters

Name	Type	Description	Notes
cluster_environment_build_id	str	ID of the Cluster Environment Build to retrieve.	Defaults to null

Returns ClusterenvironmentbuildResponse

get_cluster_environment_build_logs

Retrieves logs for a Cluster Environment Build.

Parameters

Name	Type	Description	Notes
cluster_environment_build_id	str	ID of the Cluster Environment Build to retrieve logs for.	Defaults to null

Returns ClusterenvironmentbuildlogresponseResponse

get_default_cluster_environment_build

Retrieves a default cluster environment with the preferred attributes.

Parameters

Name	Type	Description	Notes
python_version	PythonVersion	Python version for the cluster environment	Defaults to null
ray_version	str	Ray version to use for this cluster environment. Should match a version string found in the ray version history on pypi. See here for full list: https://pypi.org/project/ray/#history	Defaults to null

Returns ClusterenvironmentbuildResponse

list_cluster_environment_builds

Lists all Cluster Environment Builds belonging to an Cluster Environment.

Parameters

Name	Type	Description	Notes
cluster_environment_id	str	ID of the Cluster Environment to list builds for.	Defaults to null
desc	optional bool	Orders the list of builds from latest to oldest.	Defaults to false
paging_token	optional str		Defaults to null
count	optional int		Defaults to 10

Returns ClusterenvironmentbuildListResponse

Cluster Environments

create_byod_cluster_environment

Creates a BYOD Cluster Environment.

Parameters

Name	Type	Description	Notes
create_byod_cluster_environment	CreateBYODClusterEnvironment

Returns ClusterenvironmentResponse

create_cluster_environment

Creates a Cluster Environment.

Parameters

Name	Type	Description	Notes
create_cluster_environment	CreateClusterEnvironment

Returns ClusterenvironmentResponse

delete_cluster_environment

Deletes a Cluster Environment.

Parameters

Name	Type	Description	Notes
cluster_config_id	str	ID of the Cluster Environment to delete.	Defaults to null

Returns void (empty response body)

get_cluster_environment

Retrieves a Cluster Environment.

Parameters

Name	Type	Description	Notes
cluster_environment_id	str	ID of the Cluster Environment to retrieve.	Defaults to null

Returns ClusterenvironmentResponse

search_cluster_environments

Lists all Cluster Environments that the logged in user has permissions to access.

Parameters

Name	Type	Description	Notes
cluster_environments_query	ClusterEnvironmentsQuery

Returns ClusterenvironmentListResponse

Cluster Operations

get_cluster_operation

Retrieves a Cluster Operation.

Parameters

Name	Type	Description	Notes
cluster_operation_id	str	ID of the Cluster Operation to retrieve.	Defaults to null

Returns ClusteroperationResponse

Clusters

archive_cluster

Archives the cluster. It is a no-op if the cluster is already archived.

Parameters

Name	Type	Description	Notes
cluster_id	str		Defaults to null

Returns void (empty response body)

create_cluster

Creates a Cluster.

Parameters

Name	Type	Description	Notes
create_cluster	CreateCluster

Returns ClusterResponse

delete_cluster

Deletes a Cluster.

Parameters

Name	Type	Description	Notes
cluster_id	str	ID of the Cluster to delete.	Defaults to null

Returns void (empty response body)

get_cluster

Retrieves a Cluster.

Parameters

Name	Type	Description	Notes
cluster_id	str	ID of the Cluster to retreive.	Defaults to null

Returns ClusterResponse

search_clusters

Searches for all Clusters the user has access to that satisfies the query.

Parameters

Name	Type	Description	Notes
clusters_query	ClustersQuery

Returns ClusterListResponse

start_cluster

Initializes workflow to transition the Cluster into the Running state. This is a long running operation. Clients will need to poll the operation's status to determine completion. The options parameter is DEPRECATED.

Parameters

Name	Type	Description	Notes
cluster_id	str	ID of the Cluster to start.	Defaults to null
start_cluster_options	StartClusterOptions

Returns ClusteroperationResponse

terminate_cluster

Initializes workflow to transition the Cluster into the Terminated state. This is a long running operation. Clients will need to poll the operation's status to determine completion.

Parameters

Name	Type	Description	Notes
cluster_id	str	ID of the Cluster to terminate.	Defaults to null
terminate_cluster_options	TerminateClusterOptions

Returns ClusteroperationResponse

update_cluster

Updates a Cluster.

Parameters

Name	Type	Description	Notes
cluster_id	str	ID of the Cluster to update.	Defaults to null
update_cluster	UpdateCluster

Returns ClusterResponse

Jobs

search_jobs

DEPRECATED: This API is now deprecated. Use list_production_jobs instead.

Parameters

Name	Type	Description	Notes
jobs_query	JobsQuery

Returns JobListResponse

Logs

get_job_logs_download

Parameters

Name	Type	Description	Notes
job_id	str		Defaults to null
all_logs	optional bool	Whether to grab all logs.	Defaults to true

Returns LogdownloadresultResponse

get_job_logs_stream

Parameters

Name	Type	Description	Notes
job_id	str		Defaults to null

Returns LogstreamResponse

Organizations

get_organization_temporary_object_storage_credentials

Retrieves temporary object storage config and credentials scoped to an organization and region.

Parameters

Name	Type	Description	Notes
organization_id	str		Defaults to null
region	str		Defaults to null

Returns ObjectstorageconfigResponse

partial_update_organization

Update an organization's requirement for Single Sign On (SSO). If SSO is required for an organization, SSO will be the only way to log in to it.

Parameters

Name	Type	Description	Notes
organization_id	str	ID of the Organization to update.	Defaults to null
update_organization	UpdateOrganization

Returns OrganizationResponse

Production Jobs

create_job

Create an Production Job

Parameters

Name	Type	Description	Notes
create_production_job	CreateProductionJob

Returns ProductionjobResponse

get_production_job

Get an Production Job

Parameters

Name	Type	Description	Notes
production_job_id	str		Defaults to null

Returns ProductionjobResponse

get_session_for_job

Get Session for Production Job

Parameters

Name	Type	Description	Notes
production_job_id	str		Defaults to null

Returns SessionResponse

list_production_jobs

Parameters

Name	Type	Description	Notes
project_id	optional str	project_id to filter by	Defaults to null
name	optional str	name to filter by	Defaults to null
state_filter	List[HaJobStates]	A list of session states to filter by	Defaults to []
creator_id	optional str	filter by creator id	Defaults to null
paging_token	optional str		Defaults to null
count	optional int		Defaults to null

Returns ProductionjobListResponse

terminate_job

Terminate an Production Job

Parameters

Name	Type	Description	Notes
production_job_id	str		Defaults to null

Returns ProductionjobResponse

Projects

create_project

Creates a Project.

Parameters

Name	Type	Description	Notes
create_project	CreateProject

Returns ProjectResponse

delete_project

Deletes a Project.

Parameters

Name	Type	Description	Notes
project_id	str	ID of the Project to delete.	Defaults to null

Returns void (empty response body)

get_default_project

Retrieves the default project.

Parameters

Name	Type	Description	Notes
parent_cloud_id	optional str	Cloud to fetch this default project for. This is only required if cloud isolation is enabled.	Defaults to null

Returns ProjectResponse

get_project

Retrieves a Project.

Parameters

Name	Type	Description	Notes
project_id	str	ID of the Project to retrieve.	Defaults to null

Returns ProjectResponse

search_projects

Searches for all Projects the user has access to that satisfies the query.

Parameters

Name	Type	Description	Notes
projects_query	ProjectsQuery

Returns ProjectListResponse

update_project

Updates a Project.

Parameters

Name	Type	Description	Notes
project_id	str	ID of the Project to update.	Defaults to null
update_project	UpdateProject

Returns ProjectResponse

Runtime Environments

get_runtime_environment

Retrieves a Runtime Environment.

Parameters

Name	Type	Description	Notes
runtime_environment_id	str	ID of the Runtime Environment to retrieve.	Defaults to null

Returns RuntimeenvironmentResponse

Schedules

create_or_update_schedule

Create or update a Schedule

Parameters

Name	Type	Description	Notes
create_schedule	CreateSchedule

Returns ScheduleapimodelResponse

get_schedule

Get Schedules

Parameters

Name	Type	Description	Notes
schedule_id	str		Defaults to null

Returns ScheduleapimodelResponse

list_schedules

List Schedules

Parameters

Name	Type	Description	Notes
project_id	optional str	project_id to filter by	Defaults to null
name	optional str	name to filter by	Defaults to null
creator_id	optional str	filter by creator id	Defaults to null

Returns ScheduleapimodelListResponse

pause_schedule

Pause a Schedule

Parameters

Name	Type	Description	Notes
schedule_id	str		Defaults to null
pause_schedule	PauseSchedule

Returns ScheduleapimodelResponse

run_schedule

Run a Schedule manually

Parameters

Name	Type	Description	Notes
schedule_id	str		Defaults to null

Returns ProductionjobResponse

Services

get_service

Get a Service

Parameters

Name	Type	Description	Notes
service_id	str		Defaults to null

Returns ServicemodelResponse

list_services

Parameters

Name	Type	Description	Notes
project_id	optional str	project_id to filter by	Defaults to null
name	optional str	name to filter by	Defaults to null
state_filter	List[ServiceEventCurrentState]	A list of Service states to filter by	Defaults to []
creator_id	optional str	creator_id to filter by	Defaults to null
cloud_id	optional str	cloud_id to filter by	Defaults to null
sort_field	ServiceSortField	If absent, the default sorting order is 1. status (active first).2. Last updated at (desc). 3. Name (asc).	Defaults to null
sort_order	SortOrder	If sort_field is absent, this field is ignored.If absent, this field defaults to ascending.	Defaults to null
paging_token	optional str		Defaults to null
count	optional int		Defaults to null

Returns ServicemodelListResponse

rollback_service

Rollback a Service

Parameters

Name	Type	Description	Notes
service_id	str		Defaults to null
rollback_service_model	RollbackServiceModel

Returns ServicemodelResponse

rollout_service

Rollout a service

Parameters

Name	Type	Description	Notes
apply_service_model	ApplyServiceModel

Returns ServicemodelResponse

terminate_service

Terminate a Service

Parameters

Name	Type	Description	Notes
service_id	str		Defaults to null

Returns ServicemodelResponse

Session Commands

create_session_command

DEPRECATED: This API is now deprecated and will not be supported in Anyscale 2.0

Parameters

Name	Type	Description	Notes
create_session_command	CreateSessionCommand

Returns SessioncommandResponse

get_session_command

Retrieves a session command with ID.

Parameters

Name	Type	Description	Notes
session_command_id	str	ID of the Session Command to retrieve.	Defaults to null

Returns SessioncommandResponse

list_session_commands

Retrieves a list of commands that were created on the Session.

Parameters

Name	Type	Description	Notes
session_id	str	ID of the Session to list Commands for.	Defaults to null
paging_token	optional str		Defaults to null
count	optional int		Defaults to 10

Returns SessioncommandListResponse

Session Events

get_session_event_log

Retrieves a session's event log.

Parameters

Name	Type	Description	Notes
session_id	str	ID of the Session to retrieve event logs for.	Defaults to null
before	optional datetime	Filters events occurring before this datetime.	Defaults to null
after	optional datetime	Filters events occurring after this datetime.	Defaults to null
event_types	List[SessionEventTypes]	Filters events to these types.	Defaults to null
log_level_types	List[LogLevelTypes]	Filters logs to these leves.	Defaults to null
paging_token	optional str		Defaults to null
count	optional int		Defaults to 20

Returns SessioneventListResponse

Sso Configs

upsert_sso_config

Create or update the single sign on (SSO) configuration for your organization.

Parameters

Name	Type	Description	Notes
create_sso_config	CreateSSOConfig

Returns SsoconfigResponse

upsert_test_sso_config

Create or update the test single sign on (SSO) configuration for your organization.

Parameters

Name	Type	Description	Notes
create_sso_config	CreateSSOConfig

Returns SsoconfigResponse