(D - Z)
EbsBlockDevice
https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html
delete_on_termination
bool
[optional] [default to null]
encrypted
bool
[optional] [default to null]
iops
int
[optional] [default to null]
kms_key_id
str
[optional] [default to null]
outpost_arn
str
[optional] [default to null]
snapshot_id
str
[optional] [default to null]
throughput
int
[optional] [default to null]
volume_size
int
[optional] [default to null]
volume_type
str
[optional] [default to null]
HTTPValidationError
IamInstanceProfileSpecification
https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfileSpecification.html
arn
str
[optional] [default to null]
name
str
[optional] [default to null]
Job
id
str
Server assigned unique identifier.
[default to null]
ray_session_name
str
Name of the Session provided from Ray
[default to null]
ray_job_id
str
ID of the Job provided from Ray
[default to null]
name
str
Name of this Job.
[optional] [default to null]
created_at
datetime
Time at which this Job was created.
[default to null]
finished_at
datetime
Time at which this Job finished. If absent, this Job is still running.
[optional] [default to null]
cluster_id
str
ID of the Anyscale Cluster this Job is on.
[default to null]
namespace_id
str
ID of the Anyscale Namespace this Job is using.
[default to null]
runtime_environment_id
str
ID of the Anyscale Runtime Environment this Job is using.
[default to null]
project_id
str
ID of the Project this Job belongs to.
[optional] [default to null]
creator_id
str
ID of the user who created this Job.
[default to null]
JobListResponse
A list response form the API. Contains a field "results" which has the contents of the response.
JobResponse
A response from the API. Contains a field "result" which has the contents of the response.
JobStatus
An enumeration.
JobsLogs
The logs for this job
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]
JobsQuery
Query model used to filter Jobs.
name
Filters Jobs by name. If this field is absent, no filtering is done.
[optional] [default to null]
runtime_environment_id
str
Filters Jobs by runtime enviornment id. If this field is absent, no filtering is done.
[optional] [default to null]
cluster_id
str
Filters Jobs by cluster id. If this field is absent, no filtering is done.
[optional] [default to null]
creator_id
str
Filters Jobs by creator_id. If this field is absent, no filtering is done.
[optional] [default to null]
ray_job_id
str
Filters Jobs by ray_job_id. If this field is absent, no filtering is done. Note: the ray_job_id is only unique for one cluster.
[optional] [default to null]
project_id
str
Filters Jobs by project_id. If this field is absent, no filtering is done.
[optional] [default to null]
include_child_jobs
bool
Include jobs that have parents
[optional] [default to false]
state_filter
Filter Jobs by Job Status. If this field is an empty set, no filtering is done.
[optional] [default to []]
JobslogsResponse
A response from the API. Contains a field "result" which has the contents of the response.
ListResponseMetadata
Metadata for a ListResponse containing common info like pagination
total
int
[optional] [default to null]
next_paging_token
str
[optional] [default to null]
LogLevelTypes
The classification of a session event.
Namespace
Representation of a Ray Namespace that is used within an Anyscale Cluster.
id
str
Server assigned unique identifier.
[default to null]
cluster_id
str
ID of the Cluster that this Namespace exists within.
[default to null]
name
str
Optional name for this Namespace.
[optional] [default to null]
NamespaceResponse
A response from the API. Contains a field "result" which has the contents of the response.
NetworkInterface
Allows users to override network interface used by your instances. See https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#networkinterface
subnet_id
str
[default to null]
groups
List[str]
[default to null]
associate_public_ip_address
bool
[optional] [default to true]
ObjectStorageConfig
Field representing a object storage configuration for an organization in a region
ObjectStorageConfigS3
region
str
[default to null]
bucket
str
[default to null]
path
str
[default to null]
aws_access_key_id
str
[default to null]
aws_secret_access_key
str
[default to null]
aws_session_token
str
[default to null]
ObjectstorageconfigResponse
A response from the API. Contains a field "result" which has the contents of the response.
OperationError
The response of this operation in case of failure
message
str
Human readable message explaining why this operation failed.
[default to null]
OperationProgress
Provides detailed information about how this operation is progressing.
message
str
Human readable message about the progress of an operation.
[default to null]
OperationResult
The result of an Operation upon completion. Exactly one of error or data will be set.
data
object
The response of this operation in case of success. This is typically the resource that this operation acted on.
[optional] [default to null]
Organization
Fields representing an Organization
id
str
Server assigned unique identifier.
[default to null]
name
str
Organization's display name.
[default to null]
public_identifier
str
Organization's public identifier.
[default to null]
sso_required
bool
Require users to log in to your organization using single sign on (SSO).
[optional] [default to false]
OrganizationResponse
A response from the API. Contains a field "result" which has the contents of the response.
PageQuery
Query model for paginating results.
count
int
Number of elements to fetch. Defaults to 10.
[optional] [default to 10]
paging_token
str
Token used for pagination. If absent, server will return elements from the first page.
[optional] [default to null]
Project
Model used to read a Project.
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 to null]
description
str
Description of Project.
[optional] [default to null]
id
str
Server assigned unique identifier of the Project.
[default to null]
creator_id
str
Identifier of user who created the Project.
[default to null]
created_at
datetime
Time at which Project was created.
[default to null]
organization_id
str
Organization that the Project is associated with.
[default to null]
active_sessions
int
Read only. Number of active sessions for this project.
[default to null]
last_activity_at
datetime
Read only. The most recent activity for this project. This is based on the most recently created sessions
[default to null]
last_used_cloud_id
str
ID of the last cloud used in this project, or by the user if this is a new project.
[optional] [default to null]
ProjectListResponse
A list response form the API. Contains a field "results" which has the contents of the response.
ProjectResponse
A response from the API. Contains a field "result" which has the contents of the response.
ProjectsQuery
Query model used to filter Projects.
name
Filters Projects by name. If this field is absent, no filtering is done.
[optional] [default to null]
creator_id
Filters Projects by creator_id. If this field is absent, no filtering is done.
[optional] [default to null]
PythonModules
pip_packages
List[str]
List of pip packages that'll be included in the image.
[optional] [default to null]
conda_packages
List[str]
List of conda packages that'll be included in the image.
[optional] [default to null]
Resources
cpu
int
Number of CPUs in this node type. If left blank, Ray may automatically detect it for you; see https://docs.ray.io/en/master/cluster/config.html#cluster-configuration-resources-type for more.
[optional] [default to null]
gpu
int
Number of GPUs in this node type. If left blank, Ray may automatically detect it for you; see https://docs.ray.io/en/master/cluster/config.html#cluster-configuration-resources-type for more.
[optional] [default to null]
memory
int
Amount of memory to allocate to the Python worker. If left blank, Ray will choose an appropriate amount based on available resources; see https://docs.ray.io/en/master/cluster/config.html#cluster-configuration-resources-type for more.
[optional] [default to null]
object_store_memory
int
The amount of memory in bytes allocated for the Ray object store on this node. If left blank, Ray will choose an appropriate amount; see https://docs.ray.io/en/master/cluster/config.html#cluster-configuration-resources-type for more.
[optional] [default to null]
custom_resources
Dict(str, int)
Declare custom resources for this node to be used by Ray autoscaler.
[optional] [default to {}]
RuntimeEnvironment
Reusable runtime environment for Jobs and Actors running in Anyscale.
id
str
Server assigned unique Identifier
[default to null]
ray_env_hash
str
A hash of this Runtime Environment as provided by Ray
[default to null]
name
str
Name for this Runtime Environment.
[optional] [default to null]
working_dir
str
The working directory for this Runtime Environment.
[optional] [default to null]
py_modules
List[str]
Python modules included in this Runtime Environment.
[optional] [default to null]
pip_packages
str
Pip dependencies installed in this Runtime Environment.
[optional] [default to null]
conda_env_name
str
Name of the Conda environment this Runtime Environment is using.
[optional] [default to null]
env_variables
Dict(str, str)
Environment variables set for this Runtime Environment.
[optional] [default to null]
created_at
datetime
Time at which this Runtime Environment was created.
[default to null]
creator_id
str
ID of the User who created this Runtime Environment.
[default to null]
RuntimeenvironmentResponse
A response from the API. Contains a field "result" which has the contents of the response.
SSOConfig
Read model of an SSOConfig
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]
id
str
ID of this SSO Config.
[default to null]
created_at
datetime
Time at which this SSO Config was created.
[default to null]
creator_id
str
ID of the user who created this SSO Config.
[default to null]
SUPPORTEDBASEIMAGESENUM
An enumeration.
Session
Model used to read a Session.
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.
[default to null]
cluster_config
str
Cluster config that the session can later be started with.
[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]
id
str
Server assigned unique identifier.
[default to null]
pending_state
Pending state of the Session if a state transition has been requested.
[optional] [default to null]
state_data
Additional information about the current state
[optional] [default to null]
creator_id
str
Identifier of user who created the Session.
[default to null]
created_at
datetime
Time at which session was created.
[default to null]
webterminal_auth_url
str
URL to authenticate with the webterminalThis field will only be populated after the Session finishes starting.
[optional] [default to null]
metrics_dashboard_url
str
URL for Grafana (metrics) dashboard for this Session. This field will only be populated after the Session finishes starting.
[optional] [default to null]
connect_url
str
URL for Anyscale connect for this Session. This field will only be populated after the Session finishes starting.
[optional] [default to null]
jupyter_notebook_url
str
URL for Jupyter Lab for this Session. This field will only be populated after the Session finishes starting.
[optional] [default to null]
ray_dashboard_url
str
URL for Ray dashboard for this Session. This field will only be populated after the Session finishes starting.
[optional] [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 Session finishes starting.
[default to null]
service_proxy_url
str
Link to the web services proxy (e.g. jupyter, tensorboard, etc). This field will be populated when the web based services are available after the Session finishes starting.
[optional] [default to null]
tensorboard_available
bool
Represents whether Tensorboard is available.
[default to null]
cluster_config_last_modified_at
datetime
Time when the cluster config for the Session was last modified.
[default to null]
host_name
str
URL for the head node of the cluster. This field will be populated after the cluster finishes starting.
[optional] [default to null]
head_node_ip
str
Head IP of the Session. This field will be populated after the cluster finishes 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 session's servers.
[default to null]
anyscaled_config
str
Serialized AnyscaleD config that is general to head and worker nodes.
[optional] [default to null]
anyscaled_config_generated_at
datetime
Time when AnyscaleD config was generated at.
[optional] [default to null]
default_build_id
str
Default build id used for the session. Only not null when using default builds.
[optional] [default to null]
idle_timeout_last_activity_at
datetime
The time when this session started idling. If idle_timeout is enabled and this value is None, then this session is still active.
[optional] [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 was updated.
[optional] [default to null]
SessionCommand
Model used to create and execute a command on a Session.
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]
id
str
Server assigned unique identifier.
[default to null]
created_at
datetime
Timestamp of when this command was created.
[default to null]
finished_at
datetime
Timestamp of when this command completed its execution. This value will be absent if the command is still running.
[optional] [default to null]
status_code
int
Exit status of this command. This value will be absent if the command is still running.
[optional] [default to null]
killed_at
datetime
Timestamp of when this command was killed. This value will be absent if the command is still running or completed its execution normally.
[optional] [default to null]
web_terminal_tab_id
str
The id for the web terminal tab in which this command was executed.
[optional] [default to null]
SessionCommandTypes
An enumeration.
SessionEvent
Model of a session event item from the session event log.
event_type
str
The category of session event.
[default to null]
timestamp
datetime
The time at which the session event occurred.
[default to null]
description
str
A human readable description of the session event.
[default to null]
cause
The reason why the session event occurred. None indicates an unknown cause.
[optional] [default to null]
id
str
A unique identifier for the session event.
[default to null]
SessionEventCause
Model of a session event cause. Exactly one of cause_user or cause_system is non-None.
cause_user
str
The username of the user who caused the session event.
[optional] [default to null]
cause_system
str
The name of the internal anyscale system that caused the session event.
[optional] [default to null]
SessionEventTypes
The type of session event.
SessionListResponse
A list response form the API. Contains a field "results" which has the contents of the response.
SessionOperation
Describes a long running session operation that will eventually complete.
id
str
ID of this operation.
[default to null]
completed
bool
Boolean indicating if this operation is completed.
[default to null]
progress
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
The result of this operation after it has completed. This is always provided when the operation is complete.
[optional] [default to null]
session_id
str
ID of the Session that is being updated.
[default to null]
session_operation_type
The variety of operation being performed: start sets the session's goal state to Running, stop sets the session's goal state to Stopped, terminate sets the session's goal state to Terminated
[default to null]
SessionOperationType
The type of session operation.
SessionResponse
A response from the API. Contains a field "result" which has the contents of the response.
SessionStartingUpData
startup_progress
str
[optional] [default to null]
startup_error
str
[optional] [default to null]
SessionState
An enumeration.
SessionStateData
A way to support unions that gets around the code generator's lack of support for real unions.
SessionStoppingData
stop_progress
str
[optional] [default to null]
stop_error
str
[optional] [default to null]
SessioncommandListResponse
A list response form the API. Contains a field "results" which has the contents of the response.
SessioncommandResponse
A response from the API. Contains a field "result" which has the contents of the response.
SessioneventListResponse
A list response form the API. Contains a field "results" which has the contents of the response.
SessionoperationResponse
A response from the API. Contains a field "result" which has the contents of the response.
SessionsQuery
Query model used to filter Sessions.
name
Filters Sessions by name. If this field is absent, no filtering is done.
[optional] [default to null]
state_filter
Filter Sessions by Session State. If this field is an empty set, no filtering is done.
[optional] [default to []]
SsoconfigResponse
A response from the API. Contains a field "result" which has the contents of the response.
StartClusterOptions
Options to set when starting a Cluster.
cluster_environment_build_id
str
Cluster Environment Build used to start Cluster.
[optional] [default to null]
cluster_compute_id
str
Cluster Compute used to start the Cluster.
[optional] [default to null]
allow_public_internet_traffic
bool
Whether public internet traffic can access Serve endpoints or if an authentication token is required. Will not update current value if not provided.
[optional] [default to null]
StartSessionOptions
Options to set when starting a session.
cluster_config
str
New cluster config to apply to the Session.
[optional] [default to null]
build_id
str
Build ID to start the session with.
[optional] [default to null]
compute_template_id
str
Compute template ID to start the session with.
[optional] [default to null]
allow_public_internet_traffic
bool
Whether public internet traffic can access Serve endpoints or if an authentication token is required. Will not update current value if not provided.
[optional] [default to null]
StaticSSOConfig
idp_entity_id
str
Static configuration for the SAML 2.0 identity provider's entity id.
[default to null]
idp_sso_url
str
Static configuration for the SAML 2.0 identity provider's url.
[default to null]
idp_sso_binding
str
Static configuration for the SAML 2.0 identity provider's sso binding.
[default to null]
idp_x509cert
str
Static configuration for the SAML 2.0 identity provider's x509cert
[default to null]
TerminateClusterOptions
Options to set when terminating a Cluster.
take_snapshot
bool
Takes a snapshot to preserve the state of the Cluster before terminating. The state will be restored the next time the Cluster is started.
[optional] [default to true]
TerminateSessionOptions
Optional values to set when terminating a Session.
workers_only
bool
Only destroy the workers when terminating.
[optional] [default to false]
keep_min_workers
bool
Retain the minimal amount of workers specified in the config when terminating.
[optional] [default to false]
delete
bool
Delete the session after terminating.
[optional] [default to false]
take_snapshot
bool
Takes a snapshot to preserve the state of the session before terminating. The state will be restored the next time the session is started.
[optional] [default to true]
TextQuery
Query model to filter results based on Text properties (e.g. name, description). Exactly one field should be populated.
equals
str
Property is an exact match of this value.
[optional] [default to null]
not_equal
str
Property does not match of this value.
[optional] [default to null]
contains
str
Property contains this value as a substring. The value should not have opening and closing wildcard characters.
[optional] [default to null]
UpdateAppConfig
Updateable fields for an App Config The field will not be updated if its value is absent.
name
str
Name of the App Config.
[optional] [default to null]
UpdateCloud
Updateable fields for a Cloud. If a field is absent, it will not be updated.
UpdateCluster
Model used to update a Cluster. A field will not be updated if its value is absent.
name
str
Name of this Cluster.
[optional] [default to null]
idle_timeout_minutes
int
Idle timeout in minutes.
[optional] [default to null]
cluster_environment_build_id
str
Cluster Environment Build that this Cluster is using. This property may only be changed if the Cluster is in the Terminated state.Use the Start Cluster operation if you wish to change this for a non-Terminated Cluster.
[optional] [default to null]
cluster_compute_id
str
Cluster Compute that this Cluster is using. This property may only be changed if the Cluster is in the Terminated state. Use the Start Cluster operation if you wish to change this for a non-Terminated Cluster.
[optional] [default to null]
UpdateComputeTemplate
name
str
[optional] [default to null]
UpdateOrganization
Fields to update in the organization.
sso_required
bool
Require users to log in to your organization using single sign on (SSO). WARNING: It is dangerous to require SSO if you are not confident it is correctly configured. Once SSO is enabled, users may not log into Anyscale without using SSO. If you lock all users out of your organization by requiring incorrectly configured SSO, you may need to contact Anyscale for support.
[default to null]
UpdateProject
Model for updating a Project. A field will not be updated if its value is absent.
cluster_config
str
New cluster config to apply to the Project on update action.
[optional] [default to null]
description
str
New description to update in the Project.
[optional] [default to null]
UpdateSession
Model for updating a Session. A field will not be updated if its value is absent.
cluster_config
str
New cluster config to apply to the Session on update action.
[optional] [default to null]
idle_timeout
int
Idle timeout (in minutes)
[optional] [default to null]
ValidationError
loc
List[str]
[default to null]
msg
str
[default to null]
type
str
[default to null]
WorkerNodeType
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]
min_workers
int
The minimum number of nodes of this type that Anyscale should spin up.
[optional] [default to null]
max_workers
int
The maximum number of nodes of this type that Anyscale should spin up.
[optional] [default to null]
use_spot
bool
Whether or not to use spot instances for this node type.
[default to null]
Last updated
Was this helpful?