(D - Z)

Jobs

get_job

Retrives a Job by ID.

Parameters

Name	Type	Description	Notes
job_id	str	ID of the Job to retrieve.	Defaults to null

Returns JobResponse

get_job_logs

Retrives a Job's logs.

Parameters

Name	Type	Description	Notes
job_id	str	ID of the Job to fetch logs for.	Defaults to null

Returns JobslogsResponse

kill_job

Kill a background job. Note: this API can only kill jobs started through anyscale.background.run, or anyscale run.

Parameters

Name	Type	Description	Notes
job_id	str		Defaults to null

Returns BasejobResponse

search_jobs

Lists all Jobs that the logged in user has access to, matching the input query.

Parameters

Name	Type	Description	Notes
jobs_query	JobsQuery

Returns JobListResponse

Namespaces

get_namespace

Retrieves a Namespace.

Parameters

Name	Type	Description	Notes
namespace_id	str	ID of the Namespace to retrieve.	Defaults to null

Returns NamespaceResponse

Organizations

get_organization_temporary_credentials

Retrieves temporary AWS credentials scoped to an organization.

Parameters

Name	Type	Description	Notes
organization_id	str		Defaults to null

Returns AwscredentialsResponse

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

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_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

Session Commands

create_session_command

Creates and executes a shell command on a session.This API makes no assumption about the details of the shell command.

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

kill_session_command

Kills a session command. Returns the updated session command.

Parameters

Name	Type	Description	Notes
session_command_id	str	ID of the Session Command to kill.	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