(A - C)

AWSCredentials

Name	Type	Description	Notes
aws_access_key_id	str		[default to null]
aws_secret_access_key	str		[default to null]
aws_session_token	str		[default to null]

AWSNodeOptions

The specific subset of AWS API options we want to support. See https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.ServiceResource.create_instances

Name	Type	Description	Notes
block_device_mappings	List[BlockDeviceMapping]		[optional] [default to null]
iam_instance_profile	IamInstanceProfileSpecification		[optional] [default to null]
security_group_ids	List[str]		[optional] [default to null]
subnet_id	str		[optional] [default to null]
tag_specifications	List[AWSTagSpecification]		[optional] [default to null]
network_interfaces	List[NetworkInterface]	The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.	[optional] [default to null]

AWSTag

Name	Type	Description	Notes
key	str		[default to null]
value	str		[default to null]

AWSTagSpecification

Name	Type	Description	Notes
resource_type	str		[default to null]
tags	List[AWSTag]		[default to null]

Actor

Name	Type	Description	Notes
id	str		[default to null]
ray_actor_id	str		[default to null]
ray_replica_id	str		[optional] [default to null]
replica_deployment_version	str		[optional] [default to null]
name	str		[optional] [default to null]
status	ActorStatus		[default to null]
lifetime	ActorLifetime		[default to null]
class_name	str		[optional] [default to null]
task_name	str		[optional] [default to null]
job_id	str		[default to null]
created_at	datetime		[default to null]
finished_at	datetime		[optional] [default to null]
current_worker_id	str		[default to null]
ray_ip_address	str		[optional] [default to null]
ray_port	int		[optional] [default to null]
runtime_environment_id	str		[default to null]
serve_deployment_id	str		[optional] [default to null]

ActorLifetime

An enumeration.

ActorListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[Actor]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

ActorLogs

The logs for this actor

Name	Type	Description	Notes
logs	str	Logs of this entity	[default to null]
ready	bool	Indicates if underlying logs service is ready to use. If false, clients will need to request for logs until this field is True.	[default to null]

ActorResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	Actor		[default to null]

ActorStatus

An enumeration.

ActorlogsResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ActorLogs		[default to null]

ActorsQuery

Query model used to filter Actors.

Name	Type	Description	Notes
name	TextQuery	Filters Actors by name. If this field is absent, no filtering is done.	[optional] [default to null]
runtime_environment_id	str	Filters Actors by runtime environment id. If this field is absent, no filtering is done.	[optional] [default to null]
job_id	str	Filters Actors by job id. If this field is absent, no filtering is done.	[optional] [default to null]
cluster_id	str	Filters Actors by cluster_id. If this field is absent, no filtering is done.	[optional] [default to null]
serve_deployment_id	str	Filters Actors by serve_deployment_id. If this field is absent, no filtering is done.	[optional] [default to null]
only_replicas	bool	Filters for Actors that are replicas by filtering out ServeController / HTTPProxyActors. Must be used in conjunction with serve_deployment_id	[optional] [default to null]
paging	PageQuery	Pagination information.	[optional] [default to null]
state_filter	List[ActorStatus]	Filter Actors by Actor Status. If this field is an empty set, no filtering is done.	[optional] [default to []]

AnyscaledConfig

Name	Type	Description	Notes
config	str		[default to null]

AnyscaledDataplaneConfig

Name	Type	Description	Notes
config	str		[default to null]
head_node	bool		[default to null]

AnyscaledconfigResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	AnyscaledConfig		[default to null]

AnyscaleddataplaneconfigResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	AnyscaledDataplaneConfig		[default to null]

AppConfig

Name	Type	Description	Notes
id	str	Server assigned unique identifier.	[default to null]
name	str	Name of the App Config.	[default to null]
project_id	str	ID of the Project this App Config is for.	[optional] [default to null]
organization_id	str	ID of the Organization this App Config was created in.	[default to null]
creator_id	str	ID of the User that created this record.	[default to null]
created_at	datetime	Timestamp of when this record was created.	[default to null]
last_modified_at	datetime	Timestamp of when this record was last updated.	[default to null]
deleted_at	datetime	Timestamp of when this record was deleted.	[optional] [default to null]

AppConfigConfigSchema

Name	Type	Description	Notes
base_image	BASEIMAGESENUM	The base image used in the app config. It needs to be one of the base images that we ever supported (BASE_IMAGES_HISTORY).	[default to null]
env_vars	object	Environment varibles in the docker image that'll be used at runtime.	[optional] [default to null]
debian_packages	List[str]	List of debian packages that'll be included in the image.	[optional] [default to null]
python	PythonModules	Python related dependencies.	[optional] [default to null]
post_build_cmds	List[str]	List of post build commands that'll be included in the image.	[optional] [default to null]

AppconfigListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[AppConfig]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

AppconfigResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	AppConfig		[default to null]

AwscredentialsResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	AWSCredentials		[default to null]

BASEIMAGESENUM

An enumeration.

BaseJob

Name	Type	Description	Notes
id	str		[default to null]
ray_session_name	str		[default to null]
ray_job_id	str		[default to null]
name	str		[optional] [default to null]
status	BaseJobStatus		[default to null]
created_at	datetime		[default to null]
finished_at	datetime		[optional] [default to null]
is_background	bool		[optional] [default to false]
cluster_id	str		[default to null]
namespace_id	str		[default to null]
environment_id	str		[default to null]
project_id	str		[optional] [default to null]
creator_id	str		[default to null]

BaseJobStatus

An enumeration.

BasejobResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	BaseJob		[default to null]

BlockDeviceMapping

https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html

Name	Type	Description	Notes
device_name	str		[optional] [default to null]
ebs	EbsBlockDevice		[optional] [default to null]
no_device	str		[optional] [default to null]
virtual_name	str		[optional] [default to null]

Build

Model used to create a Build.

Name	Type	Description	Notes
application_template_id	str	ID of the App Config this Build belongs to.	[default to null]
config_json	AppConfigConfigSchema	Config JSON used to create this Build.	[default to null]
id	str	Server assigned unique identifier.	[default to null]
revision	int	Auto incrementing version number for this Build	[default to null]
creator_id	str	ID of the user who created this Build.	[default to null]
docker_image_name	str	The name of the docker image for this build.	[optional] [default to null]
error_message	str	Detailed error message. This will only be populated if the Build operation failed.	[optional] [default to null]
status	BuildStatus	Status of the Build. `pending` - Build operation is queued and has not started yet. `in_progress` - Build operation is in progress. `succeeded` - Build operation completed successfully. `failed` - Build operation completed unsuccessfully. `pending_cancellation` - Build operation is marked for cancellation. `cancelled` - Build operation was cancelled before it completed.	[default to null]
created_at	datetime	Timestamp of when this Build was created.	[default to null]
last_modified_at	datetime	Timestamp of when this Build was last updated.	[default to null]
deleted_at	datetime	Timestamp of when this Build was deleted.	[optional] [default to null]

BuildListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[Build]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

BuildLogResponse

Name	Type	Description	Notes
logs	str	Logs of the build.	[default to null]

BuildResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	Build		[default to null]

BuildStatus

An enumeration.

BuildlogresponseResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	BuildLogResponse		[default to null]

Cloud

Model used to create a Cloud.

Name	Type	Description	Notes
name	str	Name of this Cloud.	[default to null]
provider	CloudProviders	Provider of this Cloud (e.g. AWS).	[default to null]
region	str	Region this Cloud is operating in. This value needs to be supported by this Cloud's provider. (e.g. us-west-2)	[default to null]
credentials	str	Credentials needed to interact with this Cloud.	[default to null]
config	CloudConfig	Additional configurable properties of this Cloud.	[optional] [default to null]
is_k8s	bool	Whether this cloud is managed via K8s	[optional] [default to false]
is_aioa	bool	Whether this cloud is an AIOA cloud.	[optional] [default to false]
id	str	Server assigned unique identifier.	[default to null]
type	CloudTypes		[default to null]
creator_id	str	ID of the User who created this Cloud.	[default to null]
created_at	datetime	Time when this Cloud was created.	[default to null]

CloudConfig

Name	Type	Description	Notes
max_stopped_instances	int	Maximum number of instances that can be retained for reuse after a Cluster has terminated. This may help Clusters start up faster, but stopped instances will accrue some costs. Defaults to 0, which means no instances will be retained for reuse. A value of -1 means all instances will be retained.	[optional] [default to 0]

CloudListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[Cloud]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

CloudProviders

An enumeration.

CloudResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	Cloud		[default to null]

CloudTypes

An enumeration.

CloudsQuery

Query object used to search Clouds.

Name	Type	Description	Notes
paging	PageQuery	Pagination info.	[optional] [default to null]

Cluster

Read model for a Cluster.

Name	Type	Description	Notes
name	str	Name of this Cluster.	[default to null]
project_id	str	Project that this Cluster belongs to.	[default to null]
cluster_environment_build_id	str	Cluster Environment Build that this Cluster is using.	[default to null]
cluster_compute_id	str	Cluster Compute that this Cluster is using.	[default to null]
idle_timeout_minutes	int	Idle timeout (in minutes), after which the Cluster is terminated. Idle time is defined as the time during which a Cluster is not running a user command (through 'anyscale exec' or the Web UI), and does not have an attached driver. Time spent running Jupyter commands, or commands run through ssh, is still considered 'idle'.	[optional] [default to 120]
allow_public_internet_traffic	bool	Whether public internet traffic can access Serve endpoints or if an authentication token is required.	[optional] [default to false]
id	str	Server assigned unique identifier.	[default to null]
state	ClusterState	Current state of the Cluster.	[default to null]
goal_state	ClusterState	State that this Cluster will eventually transition to. This will not be populated if there are no pending transitions.	[optional] [default to null]
creator_id	str	User who created this Cluster.	[default to null]
created_at	datetime	Time at which this Cluster was created.	[default to null]
access_token	str	Access token for web based services (e.g. jupyter, tensorboard, etc). This field will be populated when the web based services are available after the Cluster finishes starting.	[default to null]
services_urls	ClusterServicesUrls	URLs for additional services running on this Cluster (e.g. Jupyter, Ray Dashboard, etc.).	[default to null]
head_node_info	ClusterHeadNodeInfo	Detailed information about this Cluster's head node. This will only be populated for Clusters that have finished starting.	[optional] [default to null]
ssh_authorized_keys	List[str]	Serialized SSH Public Keys to be placed in the machine's authorized_keys.	[default to null]
ssh_private_key	str	SSH Private key that can be used to access the Cluster's servers.	[default to null]
ray_version	str	The last known ray version running on this cluster.	[optional] [default to null]
ray_version_last_updated_at	datetime	The time in which the ray version of this cluster was updated.	[optional] [default to null]

ClusterCompute

Name	Type	Description	Notes
id	str		[default to null]
name	str		[default to null]
creator_id	str		[default to null]
organization_id	str		[default to null]
project_id	str		[optional] [default to null]
created_at	datetime		[default to null]
last_modified_at	datetime		[default to null]
deleted_at	datetime		[optional] [default to null]
config	ClusterComputeConfig		[default to null]

ClusterComputeConfig

Configuration of compute resources to use for launching a Cluster.

Name	Type	Description	Notes
cloud_id	str	The ID of the Anyscale cloud to use for launching Clusters.	[default to null]
max_workers	int	Desired limit on total running workers for this Cluster.	[optional] [default to null]
region	str	The region to launch Clusters in, e.g. "us-west-2".	[default to null]
allowed_azs	List[str]	The availability zones that clusters are allowed to be launched in, e.g. "us-west-2a". If not specified, any AZ may be used.	[optional] [default to null]
head_node_type	ComputeNodeType	Node configuration to use for the head node.	[default to null]
worker_node_types	List[WorkerNodeType]	A list of node types to use for worker nodes.	[default to null]
aws	AWSNodeOptions	Fields specific to AWS node types.	[optional] [default to null]
gcp	object	Fields specific to GCP node types.	[optional] [default to null]
azure	object	Fields specific to Azure node types.	[optional] [default to null]

ClusterComputesQuery

Name	Type	Description	Notes
project_id	str	Filters Cluster Computes by project. If this field is absent, no filtering is done.	[optional] [default to null]
creator_id	str	Filters Compute Computes by creator. If this field is absent, no filtering is done.	[optional] [default to null]
name	TextQuery	Filters ComputeTemplates by name. If this field is absent, no filtering is done.	[optional] [default to null]
include_anonymous	bool	Whether to include anonymous compute templates in the search.	[optional] [default to false]
paging	PageQuery	Pagination information.	[optional] [default to null]

ClusterEnvironment

Name	Type	Description	Notes
id	str	Server assigned unique identifier.	[default to null]
name	str	Name of the Cluster Environment.	[default to null]
project_id	str	ID of the Project this Cluster Environment is for.	[optional] [default to null]
organization_id	str	ID of the Organization this Cluster Environment was created in.	[default to null]
creator_id	str	ID of the User that created this record.	[default to null]
created_at	datetime	Timestamp of when this record was created.	[default to null]
last_modified_at	datetime	Timestamp of when this record was last updated.	[default to null]
deleted_at	datetime	Timestamp of when this record was deleted.	[optional] [default to null]

ClusterEnvironmentBuild

Usable Cluster Environment Build to start a Cluster.

Name	Type	Description	Notes
cluster_environment_id	str	ID of the Cluster Environment this Build belongs to.	[default to null]
config_json	AppConfigConfigSchema	Config JSON used to create this Cluster Environment Build.	[default to null]
id	str	Server assigned unique identifier.	[default to null]
revision	int	Auto incrementing version number for this Build	[default to null]
creator_id	str	ID of the user who created this Build.	[default to null]
docker_image_name	str	The name of the docker image for this Build.	[optional] [default to null]
error_message	str	Detailed error message. This will only be populated if the Build operation failed.	[optional] [default to null]
status	ClusterEnvironmentBuildStatus	Status of the Build. `pending` - Build operation is queued and has not started yet. `in_progress` - Build operation is in progress. `succeeded` - Build operation completed successfully. `failed` - Build operation completed unsuccessfully. `pending_cancellation` - Build operation is marked for cancellation. `cancelled` - Build operation was cancelled before it completed.	[default to null]
created_at	datetime	Timestamp of when this Build was created.	[default to null]
last_modified_at	datetime	Timestamp of when this Build was last updated.	[default to null]
deleted_at	datetime	Timestamp of when this Build was deleted.	[optional] [default to null]

ClusterEnvironmentBuildLogResponse

Name	Type	Description	Notes
logs	str	Logs of the build.	[default to null]

ClusterEnvironmentBuildOperation

Describes a long running operation that will eventually complete. Consider this an abstract class. Specific kinds of operations should subclass this.

Name	Type	Description	Notes
id	str	ID of this operation.	[default to null]
completed	bool	Boolean indicating if this operation is completed.	[default to null]
progress	OperationProgress	Details about the progress of this operation at the time of the request. This will be absent for completed operations.	[optional] [default to null]
result	OperationResult	The result of this operation after it has completed. This is always provided when the operation is complete.	[optional] [default to null]
cluster_environment_build_id	str	ID of the Cluster Environment Build this operation is for.	[default to null]

ClusterEnvironmentBuildStatus

An enumeration.

ClusterEnvironmentsQuery

Name	Type	Description	Notes
project_id	str	Filters Cluster Environments by project id. If absent, no filtering is done.	[optional] [default to null]
creator_id	str	Filters Cluster Environments by creator id. If absent, no filtering is done.	[optional] [default to null]
name	TextQuery	Filters Cluster Environments by name. Currently only contains is supported.If absent, no filtering is done.	[optional] [default to null]
paging	PageQuery	Pagination information.	[optional] [default to null]

ClusterHeadNodeInfo

Details about the head node of a running Cluster.

Name	Type	Description	Notes
url	str	URL for the head node of this Cluster.	[default to null]
ip_address	str	IP address for the head node of this Cluster.	[default to null]

ClusterListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[Cluster]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

ClusterOperation

Describes a long running Cluster operation that will eventually complete.

Name	Type	Description	Notes
id	str	ID of this operation.	[default to null]
completed	bool	Boolean indicating if this operation is completed.	[default to null]
progress	OperationProgress	Details about the progress of this operation at the time of the request. This will be absent for completed operations.	[optional] [default to null]
result	OperationResult	The result of this operation after it has completed. This is always provided when the operation is complete.	[optional] [default to null]
cluster_id	str	ID of the Cluster that is being updated.	[default to null]
cluster_operation_type	ClusterOperationType	The variety of operation being performed: start sets the Cluster's goal state to Running, terminate sets the Cluster's goal state to Terminated	[default to null]

ClusterOperationType

Type of Cluster operation.

ClusterResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	Cluster		[default to null]

ClusterServicesUrls

URLs for additional services running in the Cluster. (ex/ Jupyter, Ray Dashboard). This fields can only be populated after the Cluster has finished starting. An absent field indicates the service is not available.

Name	Type	Description	Notes
webterminal_auth_url	str	URL to authenticate with the webterminal	[optional] [default to null]
metrics_dashboard_url	str	URL for Grafana (metrics) dashboard.	[optional] [default to null]
connect_url	str	URL for Anyscale connect.	[optional] [default to null]
jupyter_notebook_url	str	URL for Jupyter Lab.	[optional] [default to null]
ray_dashboard_url	str	URL for Ray dashboard.	[optional] [default to null]
service_proxy_url	str	URL for web services proxy (e.g. jupyter, tensorboard, etc).	[optional] [default to null]

ClusterState

Possible States for a Cluster.

ClustercomputeListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[ClusterCompute]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

ClustercomputeResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ClusterCompute		[default to null]

ClusterenvironmentListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[ClusterEnvironment]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

ClusterenvironmentResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ClusterEnvironment		[default to null]

ClusterenvironmentbuildListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[ClusterEnvironmentBuild]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

ClusterenvironmentbuildResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ClusterEnvironmentBuild		[default to null]

ClusterenvironmentbuildlogresponseResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ClusterEnvironmentBuildLogResponse		[default to null]

ClusterenvironmentbuildoperationResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ClusterEnvironmentBuildOperation		[default to null]

ClusteroperationResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ClusterOperation		[default to null]

ClustersQuery

Query model used to filter Clusters.

Name	Type	Description	Notes
project_id	str	Filters Clusters belonging to a Project. If this field is absent, no filtering is done.	[optional] [default to null]
name	TextQuery	Filters Clusters by name. If this field is absent, no filtering is done.	[optional] [default to null]
paging	PageQuery	Pagination information.	[optional] [default to null]
state_filter	List[ClusterState]	Filter Sessions by Session State. If this field is an empty set, no filtering is done.	[optional] [default to []]

ComputeNodeType

Name	Type	Description	Notes
name	str	An arbitrary name for this node type, which will be registered with OSS available_node_types.	[default to null]
instance_type	str	The cloud provider instance type to use for this node.	[default to null]
resources	Resources	Declaration of node resources for Autoscaler.	[optional] [default to null]

ComputeTemplate

Name	Type	Description	Notes
id	str		[default to null]
name	str		[default to null]
creator_id	str		[default to null]
organization_id	str		[default to null]
project_id	str		[optional] [default to null]
created_at	datetime		[default to null]
last_modified_at	datetime		[default to null]
deleted_at	datetime		[optional] [default to null]
config	ComputeTemplateConfig		[default to null]

ComputeTemplateConfig

Configuration of compute resources to use for launching a session.

Name	Type	Description	Notes
cloud_id	str	The ID of the Anyscale cloud to use for launching sessions.	[default to null]
max_workers	int	Desired limit on total running workers for this session.	[optional] [default to null]
region	str	The region to launch sessions in, e.g. "us-west-2".	[default to null]
allowed_azs	List[str]	The availability zones that sessions are allowed to be launched in, e.g. "us-west-2a". If not specified, any AZ may be used.	[optional] [default to null]
head_node_type	ComputeNodeType	Node configuration to use for the head node.	[default to null]
worker_node_types	List[WorkerNodeType]	A list of node types to use for worker nodes.	[default to null]
aws	AWSNodeOptions	Fields specific to AWS node types.	[optional] [default to null]
gcp	object	Fields specific to GCP node types.	[optional] [default to null]
azure	object	Fields specific to Azure node types.	[optional] [default to null]

ComputeTemplateQuery

Name	Type	Description	Notes
orgwide	bool		[optional] [default to false]
project_id	str		[optional] [default to null]
creator_id	str	Filters Compute Templates by creator. This is only supported when `orgwide` is True.	[optional] [default to null]
name	TextQuery	Filters ComputeTemplates by name. If this field is absent, no filtering is done. For now, only equals match is supported when `orgwide` is False.	[optional] [default to null]
include_anonymous	bool	Whether to include anonymous compute templates in the search. Anonymous compute templates are usually not shown in list views.	[optional] [default to false]

ComputetemplateListResponse

A list response form the API. Contains a field "results" which has the contents of the response.

Name	Type	Description	Notes
results	List[ComputeTemplate]		[default to null]
metadata	ListResponseMetadata		[optional] [default to null]

ComputetemplateResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ComputeTemplate		[default to null]

ComputetemplateconfigResponse

A response from the API. Contains a field "result" which has the contents of the response.

Name	Type	Description	Notes
result	ComputeTemplateConfig		[default to null]

CreateAppConfig

Model used to create an App Config.

Name	Type	Description	Notes
name	str	Name of the App Template.	[default to null]
project_id	str	ID of the Project this App Config is for.	[optional] [default to null]
config_json	CreateAppConfigConfigurationSchema	Config JSON to use to create a new App Config.	[default to null]

CreateAppConfigConfigurationSchema

Name	Type	Description	Notes
base_image	SUPPORTEDBASEIMAGESENUM	The base image to use to create a new app config. It needs to be one of the images that we currently support (SupportedBaseImages).	[default to null]
env_vars	object	Environment varibles in the docker image that'll be used at runtime.	[optional] [default to null]
debian_packages	List[str]	List of debian packages that'll be included in the image.	[optional] [default to null]
python	PythonModules	Python related dependencies.	[optional] [default to null]
post_build_cmds	List[str]	List of post build commands that'll be included in the image.	[optional] [default to null]

CreateBuild

Model used to create a Build.

Name	Type	Description	Notes
application_template_id	str	ID of the App Config this Build belongs to.	[default to null]
config_json	CreateAppConfigConfigurationSchema	Config JSON to use to create a new Build.	[default to null]

CreateCloud

Model used to create a Cloud.

Name	Type	Description	Notes
name	str	Name of this Cloud.	[default to null]
provider	CloudProviders	Provider of this Cloud (e.g. AWS).	[default to null]
region	str	Region this Cloud is operating in. This value needs to be supported by this Cloud's provider. (e.g. us-west-2)	[default to null]
credentials	str	Credentials needed to interact with this Cloud.	[default to null]
config	CloudConfig	Additional configurable properties of this Cloud.	[optional] [default to null]
is_k8s	bool	Whether this cloud is managed via K8s	[optional] [default to false]
is_aioa	bool	Whether this cloud is an AIOA cloud.	[optional] [default to false]

CreateCluster

Model used to create a new Cluster.

Name	Type	Description	Notes
name	str	Name of this Cluster.	[default to null]
project_id	str	Project that this Cluster belongs to.	[default to null]
cluster_environment_build_id	str	Cluster Environment Build that this Cluster is using.	[default to null]
cluster_compute_id	str	Cluster Compute that this Cluster is using.	[default to null]
idle_timeout_minutes	int	Idle timeout (in minutes), after which the Cluster is terminated. Idle time is defined as the time during which a Cluster is not running a user command (through 'anyscale exec' or the Web UI), and does not have an attached driver. Time spent running Jupyter commands, or commands run through ssh, is still considered 'idle'.	[optional] [default to 120]
allow_public_internet_traffic	bool	Whether public internet traffic can access Serve endpoints or if an authentication token is required.	[optional] [default to false]

CreateClusterCompute

Name	Type	Description	Notes
name	str		[optional] [default to null]
project_id	str		[optional] [default to null]
config	ClusterComputeConfig		[default to null]
anonymous	bool	An anonymous Cluster Compute does not show up in the list of cluster configs. They can still have a name so they can be easily identified.	[optional] [default to false]

CreateClusterEnvironment

Model used to create an Cluster Environment.

Name	Type	Description	Notes
name	str	Name of the Cluster Environment.	[default to null]
project_id	str	ID of the Project this Cluster Environment is for.	[optional] [default to null]
config_json	CreateClusterEnvironmentConfigurationSchema	Config JSON to use to create a new Cluster Environment.	[default to null]

CreateClusterEnvironmentBuild

Model used to create a Cluster Environment Build.

Name	Type	Description	Notes
cluster_environment_id	str	ID of the Cluster Environment this Build belongs to.	[default to null]
config_json	CreateAppConfigConfigurationSchema	Config JSON to use to create a new Build.	[default to null]

CreateClusterEnvironmentConfigurationSchema

Name	Type	Description	Notes
base_image	SUPPORTEDBASEIMAGESENUM	The base image to use to create a new Cluster Environment. It needs to be one of the images that we currently support (SupportedBaseImages).	[default to null]
env_vars	object	Environment varibles in the docker image that'll be used at runtime.	[optional] [default to null]
debian_packages	List[str]	List of debian packages that'll be included in the image.	[optional] [default to null]
python	PythonModules	Python related dependencies.	[optional] [default to null]
post_build_cmds	List[str]	List of post build commands that'll be included in the image.	[optional] [default to null]

CreateComputeTemplate

Name	Type	Description	Notes
name	str		[optional] [default to null]
project_id	str		[optional] [default to null]
config	ComputeTemplateConfig		[default to null]
anonymous	bool	An anonymous cluster compute does not show up in the list of cluster configs. They can still have a name so they can be easily identified.	[optional] [default to false]

CreateProject

Model used to create a Project.

Name	Type	Description	Notes
name	str	Name of the Project to be created.	[default to null]
cluster_config	str	Cluster config associated with the Project. This can later be used to start a Session. Default will be used if not provided.	[optional] [default to null]
description	str	Description of Project.	[optional] [default to null]

CreateResponse

Common response that all create methods should return.

Name	Type	Description	Notes
id	str	ID of the newly created entity	[default to null]

CreateSSOConfig

Model used to create an SSOConfig. Must contain at least one of idp_metadata_url or static_config.

Name	Type	Description	Notes
idp_metadata_url	str	Identity provider (IdP) metadata url. If given along with the other static identity provider fields, Anyscale will first attempt metadata exchange to get IdP attributes. If Anyscale can't reach the metadata endpoint or if the metadata url isn't given, Anyscale will use static_idp_config as a backup. Either idp_metadata_url or static_idp_config is required.	[optional] [default to null]
static_idp_config	StaticSSOConfig	Static identity provider configuration.	[optional] [default to null]

CreateSession

Model used to create a Session. If uses_app_config is set, build_id and compute_template_id must be passed. Otherwise, cluster_config and cloud_id must be passed.

Name	Type	Description	Notes
name	str	Name of the session to be created.	[default to null]
project_id	str	Project that the session will be created in.	[default to null]
cloud_id	str	Cloud that the session will use.	[optional] [default to null]
cluster_config	str	Cluster config that the session can later be started with.	[optional] [default to null]
build_id	str	ID of the Build that this session was started with.	[optional] [default to null]
compute_template_id	str	ID of the compute template that this session was started with.	[optional] [default to null]
idle_timeout	int	Idle timeout (in minutes), after which the session is stopped. Idle time is defined as the time during which a session is not running a user command (through 'anyscale exec' or the Web UI), and does not have an attached driver. Time spent running Jupyter commands, or commands run through ssh, is still considered 'idle'.	[optional] [default to 120]
uses_app_config	bool	Whether or not the session uses app config. If true, it means this is not a legacy session started with cluster yaml.	[optional] [default to false]
allow_public_internet_traffic	bool	Whether public internet traffic can access Serve endpoints or if an authentication token is required.	[optional] [default to false]

CreateSessionCommand

Model used to create and execute a command on a Session.

Name	Type	Description	Notes
session_id	str	ID of the Session to execute this command on.	[default to null]
shell_command	str	Shell command string that will be executed.	[default to null]