ext.v0.openapi.fixed.json

{"openapi": "3.0.2", "info": {"title": "Anyscale API", "version": "0.1.0"}, "servers": [{"url": "/ext"}], "paths": {"/ext/v0/builds/": {"get": {"summary": "List Builds", "description": "DEPRECATED: Use Cluster Environment Builds API instead. Lists all Builds belonging to an App Config.", "operationId": "list_builds", "parameters": [{"required": true, "schema": {"title": "Application Template Id", "type": "string"}, "name": "application_template_id", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer", "default": 10}, "name": "count", "in": "query"}], "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BuildListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "post": {"summary": "Create Build", "description": "DEPRECATED: Use Cluster Environment Builds API instead. Creates and starts a Build. This is a long running operation.", "operationId": "create_build", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBuild"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BuildResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/builds/{build_id}": {"get": {"summary": "Get Build", "description": "DEPRECATED: Use Cluster Environment Builds API instead. Retrieves a Build.", "operationId": "get_build", "parameters": [{"required": true, "schema": {"title": "Build Id", "type": "string"}, "name": "build_id", "in": "path"}], "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BuildResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "delete": {"summary": "Delete Build", "description": "DEPRECATED: Use Cluster Environment Builds API instead. Deletes a Build.", "operationId": "delete_build", "parameters": [{"required": true, "schema": {"title": "Build Id", "type": "string"}, "name": "build_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/builds/{build_id}/logs": {"get": {"summary": "Get Build Logs", "description": "DEPRECATED: Use Cluster Environment Builds API instead. Retrieves logs for a Build.", "operationId": "get_build_logs", "parameters": [{"required": true, "schema": {"title": "Build Id", "type": "string"}, "name": "build_id", "in": "path"}], "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BuildlogresponseResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/builds/{build_id}/cancel": {"post": {"summary": "Cancel Build", "description": "DEPRECATED: Use Cluster Environment Builds API instead. Cancels a Build that is still in progress. This is a long running operation.", "operationId": "cancel_build", "parameters": [{"required": true, "schema": {"title": "Build Id", "type": "string"}, "name": "build_id", "in": "path"}], "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/compute_templates/": {"post": {"summary": "Create Compute Template", "description": "DEPRECATED: Use Cluster Computes API instead. Creates a compute template.", "operationId": "create_compute_template", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateComputeTemplate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ComputetemplateResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/compute_templates/{template_id}": {"get": {"summary": "Get Compute Template", "description": "DEPRECATED: Use Cluster Computes API instead. Retrieves a compute template.", "operationId": "get_compute_template", "parameters": [{"required": true, "schema": {"title": "Template Id", "type": "string"}, "name": "template_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ComputetemplateResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "put": {"summary": "Update Compute Template", "description": "Updates a compute template. DEPRECATED: Compute templates will be immutable. Please create a new one instead of updating existing ones.", "operationId": "update_compute_template", "parameters": [{"required": true, "schema": {"title": "Template Id", "type": "string"}, "name": "template_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateComputeTemplate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ComputetemplateResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "delete": {"summary": "Delete Compute Template", "description": "DEPRECATED: Use Cluster Computes API instead. Deletes a compute template.", "operationId": "delete_compute_template", "parameters": [{"required": true, "schema": {"title": "Template Id", "type": "string"}, "name": "template_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/compute_templates/search": {"post": {"summary": "Search Compute Templates", "description": "DEPRECATED: Use Cluster Computes API instead. List all compute templates matching the search parameters. If no parameters are specified, lists all templates created by the user.", "operationId": "search_compute_templates", "parameters": [{"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer", "default": 10}, "name": "count", "in": "query"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ComputeTemplateQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ComputetemplateListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/compute_templates/default/{cloud_id}": {"get": {"summary": "Get Default Compute Config", "description": "DEPRECATED: Use Cluster Computes API instead. Return a default compute configuration for this cloud.", "operationId": "get_default_compute_config", "parameters": [{"required": true, "schema": {"title": "Cloud Id", "type": "string"}, "name": "cloud_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ComputetemplateconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/sessions/{session_id}": {"get": {"summary": "Get Session", "description": "DEPRECATED: Use Clusters API instead. Retrieves a Session.", "operationId": "get_session", "parameters": [{"required": true, "schema": {"title": "Session Id", "type": "string"}, "name": "session_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "put": {"summary": "Update Session", "description": "DEPRECATED: Use Clusters API instead. Updates a Session.", "operationId": "update_session", "parameters": [{"required": true, "schema": {"title": "Session Id", "type": "string"}, "name": "session_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateSession"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "delete": {"summary": "Delete Session", "description": "DEPRECATED: Use Clusters API instead. Deletes a session.", "operationId": "delete_session", "parameters": [{"required": true, "schema": {"title": "Session Id", "type": "string"}, "name": "session_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/sessions/": {"get": {"summary": "List Sessions", "description": "DEPRECATED: Use Clusters API instead. Lists all Sessions belonging to the Project.", "operationId": "list_sessions", "parameters": [{"required": true, "schema": {"title": "Project Id", "type": "string"}, "name": "project_id", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer", "default": 10}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "post": {"summary": "Create Session", "description": "DEPRECATED: Use Clusters API instead. Creates a Session.", "operationId": "create_session", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSession"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/sessions/{project_id}/search": {"post": {"summary": "Search Sessions", "description": "DEPRECATED: Use Clusters API instead. Searches for all Sessions the user has access to that satisfies the query.", "operationId": "search_sessions", "parameters": [{"required": true, "schema": {"title": "Project Id", "type": "string"}, "name": "project_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionsQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/sessions/{session_id}/start": {"post": {"summary": "Start Session", "description": "\n    DEPRECATED: Use Clusters API instead.\n    Initializes workflow to transition the Session into the Running state.\n\n    The session's cluster config will be updated if it is provided in the options.\n\n    This is a long running operation.\n    Clients will need to poll the opertation's status to determine completion.\n    ", "operationId": "start_session", "parameters": [{"required": true, "schema": {"title": "Session Id", "type": "string"}, "name": "session_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/StartSessionOptions"}}}, "required": true}, "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionoperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/sessions/{session_id}/terminate": {"post": {"summary": "Terminate Session", "description": "\n    DEPRECATED: Use Clusters API instead.\n    Initializes workflow to transition the Session into the Terminated state.\n\n    This is a long running operation.\n    Clients will need to poll the opertation's status to determine completion.\n    ", "operationId": "terminate_session", "parameters": [{"required": true, "schema": {"title": "Session Id", "type": "string"}, "name": "session_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/TerminateSessionOptions"}}}, "required": true}, "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionoperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/session_commands/": {"get": {"summary": "List Session Commands", "description": "Retrieves a list of commands that were created on the Session.", "operationId": "list_session_commands", "parameters": [{"description": "ID of the Session to list Commands for.", "required": true, "schema": {"title": "Session Id", "type": "string", "description": "ID of the Session to list Commands for."}, "name": "session_id", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer", "default": 10}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessioncommandListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "post": {"summary": "Create Session Command", "description": "Creates and executes a shell command on a session.This API makes no assumption about the details of the shell command.", "operationId": "create_session_command", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSessionCommand"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessioncommandResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/session_commands/{session_command_id}": {"get": {"summary": "Get Session Command", "description": "Retrieves a session command with ID.", "operationId": "get_session_command", "parameters": [{"description": "ID of the Session Command to retrieve.", "required": true, "schema": {"title": "Session Command Id", "type": "string", "description": "ID of the Session Command to retrieve."}, "name": "session_command_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessioncommandResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/session_commands/{session_command_id}/kill": {"post": {"summary": "Kill Session Command", "description": "Kills a session command. Returns the updated session command.", "operationId": "kill_session_command", "parameters": [{"description": "ID of the Session Command to kill.", "required": true, "schema": {"title": "Session Command Id", "type": "string", "description": "ID of the Session Command to kill."}, "name": "session_command_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessioncommandResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/projects/": {"get": {"summary": "List Projects", "description": "Lists all Projects the user has access to. DEPRECATED: Use the /search endpoint instead", "operationId": "list_projects", "parameters": [{"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer", "default": 10}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "post": {"summary": "Create Project", "description": "Creates a Project.", "operationId": "create_project", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateProject"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/projects/default_project": {"get": {"summary": "Get Default Project", "description": "Retrieves the default project.", "operationId": "get_default_project", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectResponse"}}}}}}}, "/ext/v0/projects/{project_id}": {"get": {"summary": "Get Project", "description": "Retrieves a Project.", "operationId": "get_project", "parameters": [{"description": "ID of the Project to retrieve.", "required": true, "schema": {"title": "Project Id", "type": "string", "description": "ID of the Project to retrieve."}, "name": "project_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "put": {"summary": "Update Project", "description": "Updates a Project.", "operationId": "update_project", "parameters": [{"description": "ID of the Project to update.", "required": true, "schema": {"title": "Project Id", "type": "string", "description": "ID of the Project to update."}, "name": "project_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateProject"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"summary": "Delete Project", "description": "Deletes a Project.", "operationId": "delete_project", "parameters": [{"description": "ID of the Project to delete.", "required": true, "schema": {"title": "Project Id", "type": "string", "description": "ID of the Project to delete."}, "name": "project_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/projects/search": {"post": {"summary": "Search Projects", "description": "Searches for all Projects the user has access to that satisfies the query.", "operationId": "search_projects", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectsQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/app_configs/": {"get": {"summary": "List App Configs", "description": "DEPRECATED: Use Cluster Environments API instead. Lists all App Configs that satisfies the query parameters. If none are provided, we show all App Configs within your orgranization.", "operationId": "list_app_configs", "parameters": [{"required": false, "schema": {"title": "Project Id", "type": "string"}, "name": "project_id", "in": "query"}, {"required": false, "schema": {"title": "Creator Id", "type": "string"}, "name": "creator_id", "in": "query"}, {"required": false, "schema": {"title": "Name Contains", "type": "string"}, "name": "name_contains", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 1000.0, "minimum": 0.0, "type": "integer", "default": 100}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AppconfigListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "post": {"summary": "Create App Config", "description": "DEPRECATED: Use Cluster Environments API instead. Creates an App Config.", "operationId": "create_app_config", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateAppConfig"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AppconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/app_configs/{app_config_id}": {"get": {"summary": "Get App Config", "description": "DEPRECATED: Use Cluster Environments API instead. Retrieves an App Config.", "operationId": "get_app_config", "parameters": [{"required": true, "schema": {"title": "App Config Id", "type": "string"}, "name": "app_config_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AppconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "put": {"summary": "Update App Configs", "description": "DEPRECATED: Renaming an App Config will no longer be supported moving forward. Updates an App Config.", "operationId": "update_app_configs", "parameters": [{"required": true, "schema": {"title": "App Config Id", "type": "string"}, "name": "app_config_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateAppConfig"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AppconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}, "delete": {"summary": "Delete App Configs", "description": "DEPRECATED: Use Cluster Environments API instead. Deletes an App Config.", "operationId": "delete_app_configs", "parameters": [{"required": true, "schema": {"title": "App Config Id", "type": "string"}, "name": "app_config_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/organizations/{organization_id}/temporary_credentials": {"get": {"summary": "Get Organization Temporary Credentials", "description": "Retrieves temporary AWS credentials scoped to an organization.", "operationId": "get_organization_temporary_credentials", "parameters": [{"required": true, "schema": {"title": "Organization Id", "type": "string"}, "name": "organization_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AwscredentialsResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/organizations/{organization_id}/{region}/temporary_object_storage_config": {"get": {"summary": "Get Organization Temporary Object Storage Credentials", "description": "Retrieves temporary object storage config and credentials scoped to an organization and region.", "operationId": "get_organization_temporary_object_storage_credentials", "parameters": [{"required": true, "schema": {"title": "Organization Id", "type": "string"}, "name": "organization_id", "in": "path"}, {"required": true, "schema": {"title": "Region", "type": "string"}, "name": "region", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ObjectstorageconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/organizations/{organization_id}": {"put": {"summary": "Partial Update Organization", "description": "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.", "operationId": "partial_update_organization", "parameters": [{"description": "ID of the Organization to update.", "required": true, "schema": {"title": "Organization Id", "type": "string", "description": "ID of the Organization to update."}, "name": "organization_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateOrganization"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OrganizationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/anyscaled/config": {"get": {"summary": "Get Anyscaled Config", "description": "Retrieves a anyscaled agent config.", "operationId": "get_anyscaled_config", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AnyscaledconfigResponse"}}}}}, "deprecated": true}}, "/ext/v0/anyscaled/{instance_id}/dataplane_config": {"get": {"summary": "Get Anyscaled Dataplane Config", "description": "Retrieves a anyscaled dataplane config.", "operationId": "get_anyscaled_dataplane_config", "parameters": [{"required": true, "schema": {"title": "Instance Id", "type": "string"}, "name": "instance_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AnyscaleddataplaneconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/session_operations/{session_operation_id}": {"get": {"summary": "Get Session Operation", "description": "\n    DEPRECATED: use /cluster_operations.\n    Get the status of a session operation for the given session.\n    ", "operationId": "get_session_operation", "parameters": [{"required": true, "schema": {"title": "Session Operation Id", "type": "string"}, "name": "session_operation_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessionoperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/ext/v0/session_events/": {"get": {"summary": "Get Session Event Log", "description": "Retrieves a session's event log.", "operationId": "get_session_event_log", "parameters": [{"description": "ID of the Session to retrieve event logs for.", "required": true, "schema": {"title": "Session Id", "type": "string", "description": "ID of the Session to retrieve event logs for."}, "name": "session_id", "in": "query"}, {"description": "Filters events occurring before this datetime.", "required": false, "schema": {"title": "Before", "type": "string", "description": "Filters events occurring before this datetime.", "format": "date-time"}, "name": "before", "in": "query"}, {"description": "Filters events occurring after this datetime.", "required": false, "schema": {"title": "After", "type": "string", "description": "Filters events occurring after this datetime.", "format": "date-time"}, "name": "after", "in": "query"}, {"description": "Filters events to these types.", "required": false, "schema": {"type": "array", "items": {"$ref": "#/components/schemas/SessionEventTypes"}, "description": "Filters events to these types."}, "name": "event_types", "in": "query"}, {"description": "Filters logs to these leves.", "required": false, "schema": {"type": "array", "items": {"$ref": "#/components/schemas/LogLevelTypes"}, "description": "Filters logs to these leves."}, "name": "log_level_types", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 1000.0, "minimum": 0.0, "type": "integer", "default": 20}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SessioneventListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clouds/": {"post": {"summary": "Create Cloud", "description": "Creates a Cloud.", "operationId": "create_cloud", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateCloud"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloudResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clouds/default": {"get": {"summary": "Get Default Cloud", "description": "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.", "operationId": "get_default_cloud", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloudResponse"}}}}}}}, "/ext/v0/clouds/{cloud_id}": {"get": {"summary": "Get Cloud", "description": "Retrieves a Cloud.", "operationId": "get_cloud", "parameters": [{"description": "ID of the Cloud to retrieve.", "required": true, "schema": {"title": "Cloud Id", "type": "string", "description": "ID of the Cloud to retrieve."}, "name": "cloud_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloudResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "put": {"summary": "Update Cloud", "description": "Updates a Cloud.", "operationId": "update_cloud", "parameters": [{"description": "ID of the Cloud to update.", "required": true, "schema": {"title": "Cloud Id", "type": "string", "description": "ID of the Cloud to update."}, "name": "cloud_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateCloud"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloudResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"summary": "Delete Cloud", "description": "Deletes a Cloud. Will delete all clusters that are using this cloud. If any of those clusters are not terminated, this call will fail.", "operationId": "delete_cloud", "parameters": [{"description": "ID of the Cloud to delete.", "required": true, "schema": {"title": "Cloud Id", "type": "string", "description": "ID of the Cloud to delete."}, "name": "cloud_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clouds/search": {"post": {"summary": "Search Clouds", "description": "Searches for all accessible Clouds that satisfies the query.", "operationId": "search_clouds", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloudsQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloudListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environments/": {"post": {"summary": "Create Cluster Environment", "description": "Creates a Cluster Environment.", "operationId": "create_cluster_environment", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateClusterEnvironment"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environments/{cluster_environment_id}": {"get": {"summary": "Get Cluster Environment", "description": "Retrieves a Cluster Environment.", "operationId": "get_cluster_environment", "parameters": [{"description": "ID of the Cluster Environment to retrieve.", "required": true, "schema": {"title": "Cluster Environment Id", "type": "string", "description": "ID of the Cluster Environment to retrieve."}, "name": "cluster_environment_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environments/search": {"post": {"summary": "Search Cluster Environments", "description": "Lists all Cluster Environments that the logged in user has permissions to access.", "operationId": "search_cluster_environments", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterEnvironmentsQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environments/{cluster_config_id}": {"delete": {"summary": "Delete Cluster Environment", "description": "Deletes a Cluster Environment.", "operationId": "delete_cluster_environment", "parameters": [{"description": "ID of the Cluster Environment to delete.", "required": true, "schema": {"title": "Cluster Config Id", "type": "string", "description": "ID of the Cluster Environment to delete."}, "name": "cluster_config_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environment_builds/": {"get": {"summary": "List Cluster Environment Builds", "description": "Lists all Cluster Environment Builds belonging to an Cluster Environment.", "operationId": "list_cluster_environment_builds", "parameters": [{"description": "ID of the Cluster Environment to list builds for.", "required": true, "schema": {"title": "Cluster Environment Id", "type": "string", "description": "ID of the Cluster Environment to list builds for."}, "name": "cluster_environment_id", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer", "default": 10}, "name": "count", "in": "query"}], "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentbuildListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "post": {"summary": "Create Cluster Environment Build", "description": "Creates and starts a Cluster Environment Build. This is a long running operation.", "operationId": "create_cluster_environment_build", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateClusterEnvironmentBuild"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentbuildoperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environment_builds/default": {"get": {"summary": "Get Default Cluster Environment Build", "description": "Retrieves a default cluster environment with the preferred attributes.", "operationId": "get_default_cluster_environment_build", "parameters": [{"description": "Python version for the cluster environment", "required": true, "schema": {"allOf": [{"$ref": "#/components/schemas/PythonVersion"}], "description": "Python version for the cluster environment"}, "name": "python_version", "in": "query"}, {"description": "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", "required": true, "schema": {"title": "Ray Version", "type": "string", "description": "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"}, "name": "ray_version", "in": "query"}], "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentbuildResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environment_builds/{cluster_environment_build_id}": {"get": {"summary": "Get Cluster Environment Build", "description": "Retrieves a Cluster Environment Build.", "operationId": "get_cluster_environment_build", "parameters": [{"description": "ID of the Cluster Environment Build to retrieve.", "required": true, "schema": {"title": "Cluster Environment Build Id", "type": "string", "description": "ID of the Cluster Environment Build to retrieve."}, "name": "cluster_environment_build_id", "in": "path"}], "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentbuildResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"summary": "Delete Cluster Environment Build", "description": "Deletes a Cluster Environment Build.", "operationId": "delete_cluster_environment_build", "parameters": [{"description": "ID of the Cluster Environment Build to delete.", "required": true, "schema": {"title": "Cluster Environment Build Id", "type": "string", "description": "ID of the Cluster Environment Build to delete."}, "name": "cluster_environment_build_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environment_builds/{cluster_environment_build_id}/logs": {"get": {"summary": "Get Cluster Environment Build Logs", "description": "Retrieves logs for a Cluster Environment Build.", "operationId": "get_cluster_environment_build_logs", "parameters": [{"description": "ID of the Cluster Environment Build to retrieve logs for.", "required": true, "schema": {"title": "Cluster Environment Build Id", "type": "string", "description": "ID of the Cluster Environment Build to retrieve logs for."}, "name": "cluster_environment_build_id", "in": "path"}], "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentbuildlogresponseResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environment_builds/{cluster_environment_build_id}/cancel": {"post": {"summary": "Cancel Cluster Environment Build", "description": "Cancels a Cluster Environment Build that is still in progress. This is a long running operation.", "operationId": "cancel_cluster_environment_build", "parameters": [{"description": "ID of the Cluster Environment Build to cancel.", "required": true, "schema": {"title": "Cluster Environment Build Id", "type": "string", "description": "ID of the Cluster Environment Build to cancel."}, "name": "cluster_environment_build_id", "in": "path"}], "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentbuildoperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_environment_build_operations/{cluster_environment_build_operation_id}": {"get": {"summary": "Get Cluster Environment Build Operation", "description": "Retrieves a Cluster Environment Build Operation.", "operationId": "get_cluster_environment_build_operation", "parameters": [{"description": "ID of the Cluster Environment Build Operation to retrieve.", "required": true, "schema": {"title": "Cluster Environment Build Operation Id", "type": "string", "description": "ID of the Cluster Environment Build Operation to retrieve."}, "name": "cluster_environment_build_operation_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterenvironmentbuildoperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_computes/": {"post": {"summary": "Create Cluster Compute", "description": "Creates a Cluster Compute.", "operationId": "create_cluster_compute", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateClusterCompute"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClustercomputeResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_computes/default": {"get": {"summary": "Get Default Cluster Compute", "description": "Returns a default cluster compute that can be used with a given cloud.", "operationId": "get_default_cluster_compute", "parameters": [{"description": "The cloud id whose default cluster compute you want to fetch. If None, will use the default cloud.", "required": false, "schema": {"title": "Cloud Id", "type": "string", "description": "The cloud id whose default cluster compute you want to fetch. If None, will use the default cloud."}, "name": "cloud_id", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClustercomputeResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_computes/{cluster_compute_id}": {"get": {"summary": "Get Cluster Compute", "description": "Retrieves a Cluster Compute.", "operationId": "get_cluster_compute", "parameters": [{"description": "ID of the Cluster Compute to retrieve.", "required": true, "schema": {"title": "Cluster Compute Id", "type": "string", "description": "ID of the Cluster Compute to retrieve."}, "name": "cluster_compute_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClustercomputeResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"summary": "Delete Cluster Compute", "description": "Deletes a Cluster Compute.", "operationId": "delete_cluster_compute", "parameters": [{"description": "ID of the Cluster Compute to delete.", "required": true, "schema": {"title": "Cluster Compute Id", "type": "string", "description": "ID of the Cluster Compute to delete."}, "name": "cluster_compute_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_computes/search": {"post": {"summary": "Search Cluster Computes", "description": "Lists all Cluster Computes the user has access to, matching the input query.", "operationId": "search_cluster_computes", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterComputesQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClustercomputeListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/actors/{actor_id}": {"get": {"summary": "Get Actor", "description": "Gets an Actor by ID.", "operationId": "get_actor", "parameters": [{"description": "ID of the Actor to retrieve.", "required": true, "schema": {"title": "Actor Id", "type": "string", "description": "ID of the Actor to retrieve."}, "name": "actor_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ActorResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/actors/search": {"post": {"summary": "Search Actors", "description": "Lists all Actors the user has access to, matching the input query.", "operationId": "search_actors", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ActorsQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ActorListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/actors/{actor_id}/logs": {"get": {"summary": "Get Actor Logs", "description": "Gets an Actor's logs.", "operationId": "get_actor_logs", "parameters": [{"description": "ID of the Actor to get logs for.", "required": true, "schema": {"title": "Actor Id", "type": "string", "description": "ID of the Actor to get logs for."}, "name": "actor_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ActorlogsResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/jobs/{job_id}": {"get": {"summary": "Get Job", "description": "Retrieves a Job by ID.", "operationId": "get_job", "parameters": [{"description": "ID of the Job to retrieve.", "required": true, "schema": {"title": "Job Id", "type": "string", "description": "ID of the Job to retrieve."}, "name": "job_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/JobResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/jobs/search": {"post": {"summary": "Search Jobs", "description": "Lists all Jobs that the logged in user has access to, matching the input query.", "operationId": "search_jobs", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/JobsQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/JobListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/jobs/{job_id}/logs": {"get": {"summary": "Get Job Logs", "description": "Retrieves a Job's logs.", "operationId": "get_job_logs", "parameters": [{"description": "ID of the Job to fetch logs for.", "required": true, "schema": {"title": "Job Id", "type": "string", "description": "ID of the Job to fetch logs for."}, "name": "job_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/JobslogsResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/production_jobs/": {"get": {"summary": "List Production Jobs", "operationId": "list_production_jobs", "parameters": [{"description": "project_id to filter by", "required": false, "schema": {"title": "Project Id", "type": "string", "description": "project_id to filter by"}, "name": "project_id", "in": "query"}, {"description": "name to filter by", "required": false, "schema": {"title": "Name", "type": "string", "description": "name to filter by"}, "name": "name", "in": "query"}, {"description": "A list of session states to filter by", "required": false, "schema": {"uniqueItems": true, "type": "array", "items": {"$ref": "#/components/schemas/HaJobStates"}, "description": "A list of session states to filter by", "default": []}, "name": "state_filter", "in": "query"}, {"description": "filter by creator id", "required": false, "schema": {"title": "Creator Id", "type": "string", "description": "filter by creator id"}, "name": "creator_id", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer"}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionjobListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "post": {"summary": "Create Job", "description": "Create an Production Job", "operationId": "create_job", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateProductionJob"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionjobResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/production_jobs/{production_job_id}/terminate": {"post": {"summary": "Terminate Job", "description": "Terminate an Production Job", "operationId": "terminate_job", "parameters": [{"required": true, "schema": {"title": "Production Job Id", "type": "string"}, "name": "production_job_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionjobResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/production_jobs/{production_job_id}": {"get": {"summary": "Get Production Job", "description": "Get an Production Job", "operationId": "get_production_job", "parameters": [{"required": true, "schema": {"title": "Production Job Id", "type": "string"}, "name": "production_job_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionjobResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/services/": {"get": {"summary": "List Services", "description": "**EXPERIMENTAL FEATURE**:\nList Services", "operationId": "list_services", "parameters": [{"description": "project_id to filter by", "required": false, "schema": {"title": "Project Id", "type": "string", "description": "project_id to filter by"}, "name": "project_id", "in": "query"}, {"description": "name to filter by", "required": false, "schema": {"title": "Name", "type": "string", "description": "name to filter by"}, "name": "name", "in": "query"}, {"description": "A list of session states to filter by", "required": false, "schema": {"uniqueItems": true, "type": "array", "items": {"$ref": "#/components/schemas/HaJobStates"}, "description": "A list of session states to filter by", "default": []}, "name": "state_filter", "in": "query"}, {"description": "filter by creator id", "required": false, "schema": {"title": "Creator Id", "type": "string", "description": "filter by creator id"}, "name": "creator_id", "in": "query"}, {"required": false, "schema": {"title": "Paging Token", "type": "string"}, "name": "paging_token", "in": "query"}, {"required": false, "schema": {"title": "Count", "maximum": 50.0, "minimum": 0.0, "type": "integer"}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionserviceListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "post": {"summary": "Create Service", "description": "Create a service", "operationId": "create_service", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateProductionService"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionserviceResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/services/{service_id}/terminate": {"post": {"summary": "Terminate Service", "description": "**EXPERIMENTAL FEATURE**:\nTerminate an Service", "operationId": "terminate_service", "parameters": [{"required": true, "schema": {"title": "Service Id", "type": "string"}, "name": "service_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionserviceResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/services/{service_id}": {"get": {"summary": "Get Service", "description": "**EXPERIMENTAL FEATURE**:\nGet a Service", "operationId": "get_service", "parameters": [{"required": true, "schema": {"title": "Service Id", "type": "string"}, "name": "service_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProductionserviceResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clusters/{cluster_id}": {"get": {"summary": "Get Cluster", "description": "Retrieves a Cluster.", "operationId": "get_cluster", "parameters": [{"description": "ID of the Cluster to retreive.", "required": true, "schema": {"title": "Cluster Id", "type": "string", "description": "ID of the Cluster to retreive."}, "name": "cluster_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "put": {"summary": "Update Cluster", "description": "Updates a Cluster.", "operationId": "update_cluster", "parameters": [{"description": "ID of the Cluster to update.", "required": true, "schema": {"title": "Cluster Id", "type": "string", "description": "ID of the Cluster to update."}, "name": "cluster_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateCluster"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"summary": "Delete Cluster", "description": "Deletes a Cluster.", "operationId": "delete_cluster", "parameters": [{"description": "ID of the Cluster to delete.", "required": true, "schema": {"title": "Cluster Id", "type": "string", "description": "ID of the Cluster to delete."}, "name": "cluster_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clusters/search": {"post": {"summary": "Search Clusters", "description": "Searches for all Clusters the user has access to that satisfies the query.", "operationId": "search_clusters", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClustersQuery"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterListResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clusters/": {"post": {"summary": "Create Cluster", "description": "Creates a Cluster.", "operationId": "create_cluster", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateCluster"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusterResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clusters/{cluster_id}/start": {"post": {"summary": "Start Cluster", "description": "Initializes workflow to transition the Cluster into the Running state. The Cluster will be updated if Cluster Environment Build or Cluster Compute is provided in the options. This is a long running operation. Clients will need to poll the operation's status to determine completion.", "operationId": "start_cluster", "parameters": [{"description": "ID of the Cluster to start.", "required": true, "schema": {"title": "Cluster Id", "type": "string", "description": "ID of the Cluster to start."}, "name": "cluster_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/StartClusterOptions"}}}, "required": true}, "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusteroperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/clusters/{cluster_id}/terminate": {"post": {"summary": "Terminate Cluster", "description": "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.", "operationId": "terminate_cluster", "parameters": [{"description": "ID of the Cluster to terminate.", "required": true, "schema": {"title": "Cluster Id", "type": "string", "description": "ID of the Cluster to terminate."}, "name": "cluster_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/TerminateClusterOptions"}}}, "required": true}, "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusteroperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/cluster_operations/{cluster_operation_id}": {"get": {"summary": "Get Cluster Operation", "description": "Retrieves a Cluster Operation.", "operationId": "get_cluster_operation", "parameters": [{"description": "ID of the Cluster Operation to retrieve.", "required": true, "schema": {"title": "Cluster Operation Id", "type": "string", "description": "ID of the Cluster Operation to retrieve."}, "name": "cluster_operation_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClusteroperationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/namespaces/{namespace_id}": {"get": {"summary": "Get Namespace", "description": "Retrieves a Namespace.", "operationId": "get_namespace", "parameters": [{"description": "ID of the Namespace to retrieve.", "required": true, "schema": {"title": "Namespace Id", "type": "string", "description": "ID of the Namespace to retrieve."}, "name": "namespace_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NamespaceResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/runtime_environments/{runtime_environment_id}": {"get": {"summary": "Get Runtime Environment", "description": "Retrieves a Runtime Environment.", "operationId": "get_runtime_environment", "parameters": [{"description": "ID of the Runtime Environment to retrieve.", "required": true, "schema": {"title": "Runtime Environment Id", "type": "string", "description": "ID of the Runtime Environment to retrieve."}, "name": "runtime_environment_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RuntimeenvironmentResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/sso_configs/": {"post": {"summary": "Upsert Sso Config", "description": "Create or update the single sign on (SSO) configuration for your organization.", "operationId": "upsert_sso_config", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSSOConfig"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SsoconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ext/v0/sso_configs/test": {"post": {"summary": "Upsert Test Sso Config", "description": "Create or update the test single sign on (SSO) configuration for your organization.", "operationId": "upsert_test_sso_config", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSSOConfig"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SsoconfigResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}}, "components": {"schemas": {"AWSCredentials": {"title": "AWSCredentials", "required": ["AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN"], "type": "object", "properties": {"AWS_ACCESS_KEY_ID": {"type": "string"}, "AWS_SECRET_ACCESS_KEY": {"type": "string"}, "AWS_SESSION_TOKEN": {"type": "string"}}, "additionalProperties": false}, "AWSNodeOptions": {"title": "AWSNodeOptions", "type": "object", "properties": {"BlockDeviceMappings": {"type": "array", "items": {"$ref": "#/components/schemas/BlockDeviceMapping"}}, "IamInstanceProfile": {"$ref": "#/components/schemas/IamInstanceProfileSpecification"}, "SecurityGroupIds": {"type": "array", "items": {"type": "string"}}, "SubnetId": {"type": "string"}, "TagSpecifications": {"type": "array", "items": {"$ref": "#/components/schemas/AWSTagSpecification"}}, "NetworkInterfaces": {"type": "array", "items": {"$ref": "#/components/schemas/NetworkInterface"}, "description": "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."}}, "additionalProperties": false, "description": "The specific subset of AWS API options we want to support.\n\nSee https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.ServiceResource.create_instances"}, "AWSTag": {"title": "AWSTag", "required": ["Key", "Value"], "type": "object", "properties": {"Key": {"type": "string"}, "Value": {"type": "string"}}, "additionalProperties": false}, "AWSTagSpecification": {"title": "AWSTagSpecification", "required": ["ResourceType", "Tags"], "type": "object", "properties": {"ResourceType": {"type": "string"}, "Tags": {"type": "array", "items": {"$ref": "#/components/schemas/AWSTag"}}}, "additionalProperties": false}, "Actor": {"title": "Actor", "required": ["id", "ray_actor_id", "status", "lifetime", "job_id", "created_at", "current_worker_id", "runtime_environment_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string"}, "ray_actor_id": {"title": "Ray Actor Id", "type": "string"}, "ray_replica_id": {"title": "Ray Replica Id", "type": "string"}, "replica_deployment_version": {"title": "Replica Deployment Version", "type": "string"}, "name": {"title": "Name", "type": "string"}, "status": {"$ref": "#/components/schemas/ActorStatus"}, "lifetime": {"$ref": "#/components/schemas/ActorLifetime"}, "class_name": {"title": "Class Name", "type": "string"}, "task_name": {"title": "Task Name", "type": "string"}, "job_id": {"title": "Job Id", "type": "string"}, "created_at": {"title": "Created At", "type": "string", "format": "date-time"}, "finished_at": {"title": "Finished At", "type": "string", "format": "date-time"}, "current_worker_id": {"title": "Current Worker Id", "type": "string"}, "ray_ip_address": {"title": "Ray Ip Address", "type": "string"}, "ray_port": {"title": "Ray Port", "type": "integer"}, "runtime_environment_id": {"title": "Runtime Environment Id", "type": "string"}, "serve_deployment_id": {"title": "Serve Deployment Id", "type": "string"}}}, "ActorLifetime": {"title": "ActorLifetime", "enum": ["DETACHED", "NORMAL"], "description": "An enumeration."}, "ActorListResponse": {"title": "ActorListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Actor"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ActorLogs": {"title": "ActorLogs", "required": ["logs", "ready"], "type": "object", "properties": {"logs": {"title": "Logs", "type": "string", "description": "Logs of this entity"}, "ready": {"title": "Ready", "type": "boolean", "description": "\n            Indicates if underlying logs service is ready to use.\n            If false, clients will need to request for logs until this field is True.\n        "}}, "description": "The logs for this actor"}, "ActorResponse": {"title": "ActorResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Actor"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ActorStatus": {"title": "ActorStatus", "enum": ["RUNNING", "COMPLETED"], "description": "An enumeration."}, "ActorlogsResponse": {"title": "ActorlogsResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ActorLogs"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ActorsQuery": {"title": "ActorsQuery", "type": "object", "properties": {"name": {"title": "Name", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters Actors by name. If this field is absent, no filtering is done."}, "runtime_environment_id": {"title": "Runtime Environment Id", "type": "string", "description": "Filters Actors by runtime environment id. If this field is absent, no filtering is done."}, "job_id": {"title": "Job Id", "type": "string", "description": "Filters Actors by job id. If this field is absent, no filtering is done."}, "cluster_id": {"title": "Cluster Id", "type": "string", "description": "Filters Actors by cluster_id. If this field is absent, no filtering is done."}, "serve_deployment_id": {"title": "Serve Deployment Id", "type": "string", "description": "Filters Actors by serve_deployment_id. If this field is absent, no filtering is done."}, "only_replicas": {"title": "Only Replicas", "type": "boolean", "description": "Filters for Actors that are replicas by filtering out ServeController / HTTPProxyActors. Must be used in conjunction with serve_deployment_id"}, "paging": {"title": "Paging", "allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination information.", "default": {"count": 10}}, "state_filter": {"uniqueItems": true, "type": "array", "items": {"$ref": "#/components/schemas/ActorStatus"}, "description": "Filter Actors by Actor Status. If this field is an empty set, no filtering is done.", "default": []}}, "description": "Query model used to filter Actors."}, "AnyscaledConfig": {"title": "AnyscaledConfig", "required": ["config"], "type": "object", "properties": {"config": {"title": "Config", "type": "string"}}}, "AnyscaledDataplaneConfig": {"title": "AnyscaledDataplaneConfig", "required": ["config", "head_node"], "type": "object", "properties": {"config": {"title": "Config", "type": "string"}, "head_node": {"title": "Head Node", "type": "boolean"}}}, "AnyscaledconfigResponse": {"title": "AnyscaledconfigResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/AnyscaledConfig"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "AnyscaleddataplaneconfigResponse": {"title": "AnyscaleddataplaneconfigResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/AnyscaledDataplaneConfig"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "AppConfig": {"title": "AppConfig", "required": ["id", "name", "organization_id", "creator_id", "created_at", "last_modified_at"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "name": {"title": "Name", "type": "string", "description": "Name of the App Config."}, "project_id": {"title": "Project Id", "type": "string", "description": "ID of the Project this App Config is for."}, "organization_id": {"title": "Organization Id", "type": "string", "description": "ID of the Organization this App Config was created in."}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the User that created this record."}, "created_at": {"title": "Created At", "type": "string", "description": "Timestamp of when this record was created.", "format": "date-time"}, "last_modified_at": {"title": "Last Modified At", "type": "string", "description": "Timestamp of when this record was last updated.", "format": "date-time"}, "deleted_at": {"title": "Deleted At", "type": "string", "description": "Timestamp of when this record was deleted.", "format": "date-time"}, "is_default": {"title": "Is Default", "type": "boolean", "description": "True if this App Config is created and managed by anyscale", "default": false}}}, "AppConfigConfigSchema": {"title": "AppConfigConfigSchema", "required": ["base_image"], "type": "object", "properties": {"base_image": {"allOf": [{"$ref": "#/components/schemas/BASE_IMAGES_ENUM"}], "description": "The base image used in the app config. It needs to be one of the base images that we ever supported (BASE_IMAGES_HISTORY)."}, "env_vars": {"title": "Env Vars", "type": "object", "description": "Environment varibles in the docker image that'll be used at runtime."}, "debian_packages": {"title": "Debian Packages", "type": "array", "items": {"type": "string"}, "description": "List of debian packages that'll be included in the image."}, "python": {"title": "Python", "allOf": [{"$ref": "#/components/schemas/PythonModules"}], "description": "Python related dependencies."}, "post_build_cmds": {"title": "Post Build Cmds", "type": "array", "items": {"type": "string"}, "description": "List of post build commands that'll be included in the image."}}}, "AppconfigListResponse": {"title": "AppconfigListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/AppConfig"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "AppconfigResponse": {"title": "AppconfigResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/AppConfig"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "AwscredentialsResponse": {"title": "AwscredentialsResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/AWSCredentials"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "AzureNodeOptions": {"title": "AzureNodeOptions", "type": "object", "properties": {}, "additionalProperties": false, "description": "Azure is not a supported cloud yet?"}, "BASE_IMAGES_ENUM": {"title": "BASE_IMAGES_ENUM", "enum": ["anyscale/ray-ml:1.1.0", "anyscale/ray-ml:1.1.0-gpu", "anyscale/ray-ml:1.10.0-py36-gpu", "anyscale/ray-ml:1.10.0-py37-gpu", "anyscale/ray-ml:1.10.0-py38-gpu", "anyscale/ray-ml:1.10.0rc0-py36-gpu", "anyscale/ray-ml:1.10.0rc0-py37-gpu", "anyscale/ray-ml:1.10.0rc0-py38-gpu", "anyscale/ray-ml:1.2.0", "anyscale/ray-ml:1.2.0-gpu", "anyscale/ray-ml:1.3.0", "anyscale/ray-ml:1.3.0-gpu", "anyscale/ray-ml:1.3.0-py36", "anyscale/ray-ml:1.3.0-py36-gpu", "anyscale/ray-ml:1.3.0-py37", "anyscale/ray-ml:1.3.0-py37-gpu", "anyscale/ray-ml:1.3.0-py38", "anyscale/ray-ml:1.3.0-py38-gpu", "anyscale/ray-ml:1.4-rc0", "anyscale/ray-ml:1.4-rc0-gpu", "anyscale/ray-ml:1.4-rc0-py36", "anyscale/ray-ml:1.4-rc0-py36-gpu", "anyscale/ray-ml:1.4-rc0-py37", "anyscale/ray-ml:1.4-rc0-py37-gpu", "anyscale/ray-ml:1.4-rc0-py38", "anyscale/ray-ml:1.4-rc0-py38-gpu", "anyscale/ray-ml:1.4-rc1", "anyscale/ray-ml:1.4-rc1-gpu", "anyscale/ray-ml:1.4-rc1-py36", "anyscale/ray-ml:1.4-rc1-py36-gpu", "anyscale/ray-ml:1.4-rc1-py37", "anyscale/ray-ml:1.4-rc1-py37-gpu", "anyscale/ray-ml:1.4-rc1-py38", "anyscale/ray-ml:1.4-rc1-py38-gpu", "anyscale/ray-ml:1.4-rc2", "anyscale/ray-ml:1.4-rc2-gpu", "anyscale/ray-ml:1.4-rc2-py36", "anyscale/ray-ml:1.4-rc2-py36-gpu", "anyscale/ray-ml:1.4-rc2-py37", "anyscale/ray-ml:1.4-rc2-py37-gpu", "anyscale/ray-ml:1.4-rc2-py38", "anyscale/ray-ml:1.4-rc2-py38-gpu", "anyscale/ray-ml:1.4.0", "anyscale/ray-ml:1.4.0-gpu", "anyscale/ray-ml:1.4.0-py36", "anyscale/ray-ml:1.4.0-py36-gpu", "anyscale/ray-ml:1.4.0-py37", "anyscale/ray-ml:1.4.0-py37-gpu", "anyscale/ray-ml:1.4.0-py38", "anyscale/ray-ml:1.4.0-py38-gpu", "anyscale/ray-ml:1.4.1", "anyscale/ray-ml:1.4.1-gpu", "anyscale/ray-ml:1.4.1-py36", "anyscale/ray-ml:1.4.1-py36-gpu", "anyscale/ray-ml:1.4.1-py37", "anyscale/ray-ml:1.4.1-py37-gpu", "anyscale/ray-ml:1.4.1-py38", "anyscale/ray-ml:1.4.1-py38-gpu", "anyscale/ray-ml:1.5.0", "anyscale/ray-ml:1.5.0-gpu", "anyscale/ray-ml:1.5.0-py36", "anyscale/ray-ml:1.5.0-py36-gpu", "anyscale/ray-ml:1.5.0-py37", "anyscale/ray-ml:1.5.0-py37-gpu", "anyscale/ray-ml:1.5.0-py38", "anyscale/ray-ml:1.5.0-py38-gpu", "anyscale/ray-ml:1.5.2", "anyscale/ray-ml:1.5.2-gpu", "anyscale/ray-ml:1.5.2-py36", "anyscale/ray-ml:1.5.2-py36-gpu", "anyscale/ray-ml:1.5.2-py37", "anyscale/ray-ml:1.5.2-py37-gpu", "anyscale/ray-ml:1.5.2-py38", "anyscale/ray-ml:1.5.2-py38-gpu", "anyscale/ray-ml:1.6.0", "anyscale/ray-ml:1.6.0-gpu", "anyscale/ray-ml:1.6.0-py36", "anyscale/ray-ml:1.6.0-py36-gpu", "anyscale/ray-ml:1.6.0-py37", "anyscale/ray-ml:1.6.0-py37-gpu", "anyscale/ray-ml:1.6.0-py38", "anyscale/ray-ml:1.6.0-py38-gpu", "anyscale/ray-ml:1.7.0", "anyscale/ray-ml:1.7.0-gpu", "anyscale/ray-ml:1.7.0-py36", "anyscale/ray-ml:1.7.0-py36-gpu", "anyscale/ray-ml:1.7.0-py37", "anyscale/ray-ml:1.7.0-py37-gpu", "anyscale/ray-ml:1.7.0-py38", "anyscale/ray-ml:1.7.0-py38-gpu", "anyscale/ray-ml:1.7.0rc0", "anyscale/ray-ml:1.7.0rc0-gpu", "anyscale/ray-ml:1.7.0rc0-py36", "anyscale/ray-ml:1.7.0rc0-py36-gpu", "anyscale/ray-ml:1.7.0rc0-py37", "anyscale/ray-ml:1.7.0rc0-py37-gpu", "anyscale/ray-ml:1.7.0rc0-py38", "anyscale/ray-ml:1.7.0rc0-py38-gpu", "anyscale/ray-ml:1.7.1", "anyscale/ray-ml:1.7.1-gpu", "anyscale/ray-ml:1.7.1-py36", "anyscale/ray-ml:1.7.1-py36-gpu", "anyscale/ray-ml:1.7.1-py37", "anyscale/ray-ml:1.7.1-py37-gpu", "anyscale/ray-ml:1.7.1-py38", "anyscale/ray-ml:1.7.1-py38-gpu", "anyscale/ray-ml:1.8.0", "anyscale/ray-ml:1.8.0-gpu", "anyscale/ray-ml:1.8.0-py36", "anyscale/ray-ml:1.8.0-py36-gpu", "anyscale/ray-ml:1.8.0-py37", "anyscale/ray-ml:1.8.0-py37-gpu", "anyscale/ray-ml:1.8.0-py38", "anyscale/ray-ml:1.8.0-py38-gpu", "anyscale/ray-ml:1.9.0-py36-gpu", "anyscale/ray-ml:1.9.0-py37-gpu", "anyscale/ray-ml:1.9.0-py38-gpu", "anyscale/ray-ml:1.9.0rc1-py36-gpu", "anyscale/ray-ml:1.9.0rc1-py37-gpu", "anyscale/ray-ml:1.9.0rc1-py38-gpu", "anyscale/ray-ml:1.9.0rc2-py36-gpu", "anyscale/ray-ml:1.9.0rc2-py37-gpu", "anyscale/ray-ml:1.9.0rc2-py38-gpu", "anyscale/ray-ml:1.9.1-py36-gpu", "anyscale/ray-ml:1.9.1-py37-gpu", "anyscale/ray-ml:1.9.1-py38-gpu", "anyscale/ray-ml:1.9.1rc0-py36-gpu", "anyscale/ray-ml:1.9.1rc0-py37-gpu", "anyscale/ray-ml:1.9.1rc0-py38-gpu", "anyscale/ray-ml:1.9.2-py36-gpu", "anyscale/ray-ml:1.9.2-py37-gpu", "anyscale/ray-ml:1.9.2-py38-gpu", "anyscale/ray-ml:latest", "anyscale/ray-ml:nightly", "anyscale/ray-ml:nightly-gpu", "anyscale/ray-ml:nightly-py36-gpu", "anyscale/ray-ml:nightly-py37-gpu", "anyscale/ray-ml:nightly-py38-gpu", "anyscale/ray-ml:pinned-nightly", "anyscale/ray-ml:pinned-nightly-gpu", "anyscale/ray-ml:pinned-nightly-py36", "anyscale/ray-ml:pinned-nightly-py36-gpu", "anyscale/ray-ml:pinned-nightly-py37", "anyscale/ray-ml:pinned-nightly-py37-gpu", "anyscale/ray-ml:pinned-nightly-py38", "anyscale/ray-ml:pinned-nightly-py38-gpu", "anyscale/ray:1.1.0", "anyscale/ray:1.1.0-gpu", "anyscale/ray:1.10.0-py36", "anyscale/ray:1.10.0-py36-cu101", "anyscale/ray:1.10.0-py36-cu102", "anyscale/ray:1.10.0-py36-cu110", "anyscale/ray:1.10.0-py36-cu111", "anyscale/ray:1.10.0-py36-cu112", "anyscale/ray:1.10.0-py37", "anyscale/ray:1.10.0-py37-cu101", "anyscale/ray:1.10.0-py37-cu102", "anyscale/ray:1.10.0-py37-cu110", "anyscale/ray:1.10.0-py37-cu111", "anyscale/ray:1.10.0-py37-cu112", "anyscale/ray:1.10.0-py38", "anyscale/ray:1.10.0-py38-cu101", "anyscale/ray:1.10.0-py38-cu102", "anyscale/ray:1.10.0-py38-cu110", "anyscale/ray:1.10.0-py38-cu111", "anyscale/ray:1.10.0-py38-cu112", "anyscale/ray:1.10.0rc0-py36", "anyscale/ray:1.10.0rc0-py36-cu101", "anyscale/ray:1.10.0rc0-py36-cu102", "anyscale/ray:1.10.0rc0-py36-cu110", "anyscale/ray:1.10.0rc0-py36-cu111", "anyscale/ray:1.10.0rc0-py36-cu112", "anyscale/ray:1.10.0rc0-py37", "anyscale/ray:1.10.0rc0-py37-cu101", "anyscale/ray:1.10.0rc0-py37-cu102", "anyscale/ray:1.10.0rc0-py37-cu110", "anyscale/ray:1.10.0rc0-py37-cu111", "anyscale/ray:1.10.0rc0-py37-cu112", "anyscale/ray:1.10.0rc0-py38", "anyscale/ray:1.10.0rc0-py38-cu101", "anyscale/ray:1.10.0rc0-py38-cu102", "anyscale/ray:1.10.0rc0-py38-cu110", "anyscale/ray:1.10.0rc0-py38-cu111", "anyscale/ray:1.10.0rc0-py38-cu112", "anyscale/ray:1.2.0", "anyscale/ray:1.2.0-gpu", "anyscale/ray:1.3.0", "anyscale/ray:1.3.0-gpu", "anyscale/ray:1.3.0-py36", "anyscale/ray:1.3.0-py36-gpu", "anyscale/ray:1.3.0-py37", "anyscale/ray:1.3.0-py37-gpu", "anyscale/ray:1.3.0-py38", "anyscale/ray:1.3.0-py38-gpu", "anyscale/ray:1.4-rc0", "anyscale/ray:1.4-rc0-gpu", "anyscale/ray:1.4-rc0-py36", "anyscale/ray:1.4-rc0-py36-gpu", "anyscale/ray:1.4-rc0-py37", "anyscale/ray:1.4-rc0-py37-gpu", "anyscale/ray:1.4-rc0-py38", "anyscale/ray:1.4-rc0-py38-gpu", "anyscale/ray:1.4-rc1", "anyscale/ray:1.4-rc1-gpu", "anyscale/ray:1.4-rc1-py36", "anyscale/ray:1.4-rc1-py36-gpu", "anyscale/ray:1.4-rc1-py37", "anyscale/ray:1.4-rc1-py37-gpu", "anyscale/ray:1.4-rc1-py38", "anyscale/ray:1.4-rc1-py38-gpu", "anyscale/ray:1.4-rc2", "anyscale/ray:1.4-rc2-gpu", "anyscale/ray:1.4-rc2-py36", "anyscale/ray:1.4-rc2-py36-gpu", "anyscale/ray:1.4-rc2-py37", "anyscale/ray:1.4-rc2-py37-gpu", "anyscale/ray:1.4-rc2-py38", "anyscale/ray:1.4-rc2-py38-gpu", "anyscale/ray:1.4.0", "anyscale/ray:1.4.0-gpu", "anyscale/ray:1.4.0-py36", "anyscale/ray:1.4.0-py36-gpu", "anyscale/ray:1.4.0-py37", "anyscale/ray:1.4.0-py37-gpu", "anyscale/ray:1.4.0-py38", "anyscale/ray:1.4.0-py38-gpu", "anyscale/ray:1.4.1", "anyscale/ray:1.4.1-gpu", "anyscale/ray:1.4.1-py36", "anyscale/ray:1.4.1-py36-gpu", "anyscale/ray:1.4.1-py37", "anyscale/ray:1.4.1-py37-gpu", "anyscale/ray:1.4.1-py38", "anyscale/ray:1.4.1-py38-gpu", "anyscale/ray:1.5.0", "anyscale/ray:1.5.0-gpu", "anyscale/ray:1.5.0-py36", "anyscale/ray:1.5.0-py36-gpu", "anyscale/ray:1.5.0-py37", "anyscale/ray:1.5.0-py37-gpu", "anyscale/ray:1.5.0-py38", "anyscale/ray:1.5.0-py38-gpu", "anyscale/ray:1.5.2", "anyscale/ray:1.5.2-gpu", "anyscale/ray:1.5.2-py36", "anyscale/ray:1.5.2-py36-gpu", "anyscale/ray:1.5.2-py37", "anyscale/ray:1.5.2-py37-gpu", "anyscale/ray:1.5.2-py38", "anyscale/ray:1.5.2-py38-gpu", "anyscale/ray:1.6.0", "anyscale/ray:1.6.0-gpu", "anyscale/ray:1.6.0-py36", "anyscale/ray:1.6.0-py36-gpu", "anyscale/ray:1.6.0-py37", "anyscale/ray:1.6.0-py37-gpu", "anyscale/ray:1.6.0-py38", "anyscale/ray:1.6.0-py38-gpu", "anyscale/ray:1.7.0", "anyscale/ray:1.7.0-gpu", "anyscale/ray:1.7.0-py36", "anyscale/ray:1.7.0-py36-gpu", "anyscale/ray:1.7.0-py37", "anyscale/ray:1.7.0-py37-gpu", "anyscale/ray:1.7.0-py38", "anyscale/ray:1.7.0-py38-gpu", "anyscale/ray:1.7.0rc0", "anyscale/ray:1.7.0rc0-gpu", "anyscale/ray:1.7.0rc0-py36", "anyscale/ray:1.7.0rc0-py36-gpu", "anyscale/ray:1.7.0rc0-py37", "anyscale/ray:1.7.0rc0-py37-gpu", "anyscale/ray:1.7.0rc0-py38", "anyscale/ray:1.7.0rc0-py38-gpu", "anyscale/ray:1.7.1", "anyscale/ray:1.7.1-gpu", "anyscale/ray:1.7.1-py36", "anyscale/ray:1.7.1-py36-gpu", "anyscale/ray:1.7.1-py37", "anyscale/ray:1.7.1-py37-gpu", "anyscale/ray:1.7.1-py38", "anyscale/ray:1.7.1-py38-gpu", "anyscale/ray:1.8.0", "anyscale/ray:1.8.0-gpu", "anyscale/ray:1.8.0-py36", "anyscale/ray:1.8.0-py36-gpu", "anyscale/ray:1.8.0-py37", "anyscale/ray:1.8.0-py37-gpu", "anyscale/ray:1.8.0-py38", "anyscale/ray:1.8.0-py38-gpu", "anyscale/ray:1.9.0-py36", "anyscale/ray:1.9.0-py36-cu101", "anyscale/ray:1.9.0-py36-cu102", "anyscale/ray:1.9.0-py36-cu110", "anyscale/ray:1.9.0-py36-cu111", "anyscale/ray:1.9.0-py36-cu112", "anyscale/ray:1.9.0-py37", "anyscale/ray:1.9.0-py37-cu101", "anyscale/ray:1.9.0-py37-cu102", "anyscale/ray:1.9.0-py37-cu110", "anyscale/ray:1.9.0-py37-cu111", "anyscale/ray:1.9.0-py37-cu112", "anyscale/ray:1.9.0-py38", "anyscale/ray:1.9.0-py38-cu101", "anyscale/ray:1.9.0-py38-cu102", "anyscale/ray:1.9.0-py38-cu110", "anyscale/ray:1.9.0-py38-cu111", "anyscale/ray:1.9.0-py38-cu112", "anyscale/ray:1.9.0rc1-py36", "anyscale/ray:1.9.0rc1-py36-cu101", "anyscale/ray:1.9.0rc1-py36-cu102", "anyscale/ray:1.9.0rc1-py36-cu110", "anyscale/ray:1.9.0rc1-py36-cu111", "anyscale/ray:1.9.0rc1-py36-cu112", "anyscale/ray:1.9.0rc1-py37", "anyscale/ray:1.9.0rc1-py37-cu101", "anyscale/ray:1.9.0rc1-py37-cu102", "anyscale/ray:1.9.0rc1-py37-cu110", "anyscale/ray:1.9.0rc1-py37-cu111", "anyscale/ray:1.9.0rc1-py37-cu112", "anyscale/ray:1.9.0rc1-py38", "anyscale/ray:1.9.0rc1-py38-cu101", "anyscale/ray:1.9.0rc1-py38-cu102", "anyscale/ray:1.9.0rc1-py38-cu110", "anyscale/ray:1.9.0rc1-py38-cu111", "anyscale/ray:1.9.0rc1-py38-cu112", "anyscale/ray:1.9.0rc2-py36", "anyscale/ray:1.9.0rc2-py36-cu101", "anyscale/ray:1.9.0rc2-py36-cu102", "anyscale/ray:1.9.0rc2-py36-cu110", "anyscale/ray:1.9.0rc2-py36-cu111", "anyscale/ray:1.9.0rc2-py36-cu112", "anyscale/ray:1.9.0rc2-py37", "anyscale/ray:1.9.0rc2-py37-cu101", "anyscale/ray:1.9.0rc2-py37-cu102", "anyscale/ray:1.9.0rc2-py37-cu110", "anyscale/ray:1.9.0rc2-py37-cu111", "anyscale/ray:1.9.0rc2-py37-cu112", "anyscale/ray:1.9.0rc2-py38", "anyscale/ray:1.9.0rc2-py38-cu101", "anyscale/ray:1.9.0rc2-py38-cu102", "anyscale/ray:1.9.0rc2-py38-cu110", "anyscale/ray:1.9.0rc2-py38-cu111", "anyscale/ray:1.9.0rc2-py38-cu112", "anyscale/ray:1.9.1-py36", "anyscale/ray:1.9.1-py36-cu101", "anyscale/ray:1.9.1-py36-cu102", "anyscale/ray:1.9.1-py36-cu110", "anyscale/ray:1.9.1-py36-cu111", "anyscale/ray:1.9.1-py36-cu112", "anyscale/ray:1.9.1-py37", "anyscale/ray:1.9.1-py37-cu101", "anyscale/ray:1.9.1-py37-cu102", "anyscale/ray:1.9.1-py37-cu110", "anyscale/ray:1.9.1-py37-cu111", "anyscale/ray:1.9.1-py37-cu112", "anyscale/ray:1.9.1-py38", "anyscale/ray:1.9.1-py38-cu101", "anyscale/ray:1.9.1-py38-cu102", "anyscale/ray:1.9.1-py38-cu110", "anyscale/ray:1.9.1-py38-cu111", "anyscale/ray:1.9.1-py38-cu112", "anyscale/ray:1.9.1rc0-py36", "anyscale/ray:1.9.1rc0-py36-cu101", "anyscale/ray:1.9.1rc0-py36-cu102", "anyscale/ray:1.9.1rc0-py36-cu110", "anyscale/ray:1.9.1rc0-py36-cu111", "anyscale/ray:1.9.1rc0-py36-cu112", "anyscale/ray:1.9.1rc0-py37", "anyscale/ray:1.9.1rc0-py37-cu101", "anyscale/ray:1.9.1rc0-py37-cu102", "anyscale/ray:1.9.1rc0-py37-cu110", "anyscale/ray:1.9.1rc0-py37-cu111", "anyscale/ray:1.9.1rc0-py37-cu112", "anyscale/ray:1.9.1rc0-py38", "anyscale/ray:1.9.1rc0-py38-cu101", "anyscale/ray:1.9.1rc0-py38-cu102", "anyscale/ray:1.9.1rc0-py38-cu110", "anyscale/ray:1.9.1rc0-py38-cu111", "anyscale/ray:1.9.1rc0-py38-cu112", "anyscale/ray:1.9.2-py36", "anyscale/ray:1.9.2-py36-cu101", "anyscale/ray:1.9.2-py36-cu102", "anyscale/ray:1.9.2-py36-cu110", "anyscale/ray:1.9.2-py36-cu111", "anyscale/ray:1.9.2-py36-cu112", "anyscale/ray:1.9.2-py37", "anyscale/ray:1.9.2-py37-cu101", "anyscale/ray:1.9.2-py37-cu102", "anyscale/ray:1.9.2-py37-cu110", "anyscale/ray:1.9.2-py37-cu111", "anyscale/ray:1.9.2-py37-cu112", "anyscale/ray:1.9.2-py38", "anyscale/ray:1.9.2-py38-cu101", "anyscale/ray:1.9.2-py38-cu102", "anyscale/ray:1.9.2-py38-cu110", "anyscale/ray:1.9.2-py38-cu111", "anyscale/ray:1.9.2-py38-cu112", "anyscale/ray:latest", "anyscale/ray:nightly", "anyscale/ray:nightly-gpu", "anyscale/ray:nightly-py36", "anyscale/ray:nightly-py36-cu101", "anyscale/ray:nightly-py36-cu102", "anyscale/ray:nightly-py36-cu110", "anyscale/ray:nightly-py36-cu111", "anyscale/ray:nightly-py36-cu112", "anyscale/ray:nightly-py37", "anyscale/ray:nightly-py37-cu101", "anyscale/ray:nightly-py37-cu102", "anyscale/ray:nightly-py37-cu110", "anyscale/ray:nightly-py37-cu111", "anyscale/ray:nightly-py37-cu112", "anyscale/ray:nightly-py38", "anyscale/ray:nightly-py38-cu101", "anyscale/ray:nightly-py38-cu102", "anyscale/ray:nightly-py38-cu110", "anyscale/ray:nightly-py38-cu111", "anyscale/ray:nightly-py38-cu112", "unknown"], "description": "An enumeration."}, "BaseJobStatus": {"title": "BaseJobStatus", "enum": ["RUNNING", "COMPLETED", "PENDING", "STOPPED", "SUCCEEDED", "FAILED", "UNKNOWN"], "type": "string", "description": "An enumeration."}, "BlockDeviceMapping": {"title": "BlockDeviceMapping", "type": "object", "properties": {"DeviceName": {"type": "string"}, "Ebs": {"$ref": "#/components/schemas/EbsBlockDevice"}, "NoDevice": {"type": "string"}, "VirtualName": {"type": "string"}}, "additionalProperties": false, "description": "https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html"}, "Build": {"title": "Build", "required": ["application_template_id", "config_json", "id", "revision", "creator_id", "status", "created_at", "last_modified_at"], "type": "object", "properties": {"application_template_id": {"title": "Application Template Id", "type": "string", "description": "ID of the App Config this Build belongs to."}, "config_json": {"title": "Config Json", "allOf": [{"$ref": "#/components/schemas/AppConfigConfigSchema"}], "description": "Config JSON used to create this Build."}, "id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "revision": {"title": "Revision", "type": "integer", "description": "Auto incrementing version number for this Build"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the user who created this Build."}, "docker_image_name": {"title": "Docker Image Name", "type": "string", "description": "The name of the docker image for this build."}, "error_message": {"title": "Error Message", "type": "string", "description": "Detailed error message. This will only be populated if the Build operation failed."}, "status": {"allOf": [{"$ref": "#/components/schemas/BuildStatus"}], "description": "\n    Status of the Build.\n\n    `pending` - Build operation is queued and has not started yet.\n    `in_progress` - Build operation is in progress.\n    `succeeded` - Build operation completed successfully.\n    `failed` - Build operation completed unsuccessfully.\n    `pending_cancellation` - Build operation is marked for cancellation.\n    `cancelled` - Build operation was cancelled before it completed.\n    "}, "created_at": {"title": "Created At", "type": "string", "description": "Timestamp of when this Build was created.", "format": "date-time"}, "last_modified_at": {"title": "Last Modified At", "type": "string", "description": "Timestamp of when this Build was last updated.", "format": "date-time"}, "deleted_at": {"title": "Deleted At", "type": "string", "description": "Timestamp of when this Build was deleted.", "format": "date-time"}}, "description": "Model used to create a Build."}, "BuildListResponse": {"title": "BuildListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Build"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "BuildLogResponse": {"title": "BuildLogResponse", "required": ["logs"], "type": "object", "properties": {"logs": {"title": "Logs", "type": "string", "description": "Logs of the build."}}}, "BuildResponse": {"title": "BuildResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Build"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "BuildStatus": {"title": "BuildStatus", "enum": ["pending", "in_progress", "succeeded", "failed", "pending_cancellation", "canceled"], "type": "string", "description": "An enumeration."}, "BuildlogresponseResponse": {"title": "BuildlogresponseResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/BuildLogResponse"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "Cloud": {"title": "Cloud", "required": ["name", "provider", "region", "credentials", "id", "type", "creator_id", "created_at"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of this Cloud."}, "provider": {"allOf": [{"$ref": "#/components/schemas/CloudProviders"}], "description": "Provider of this Cloud (e.g. AWS)."}, "region": {"title": "Region", "type": "string", "description": "Region this Cloud is operating in. This value needs to be supported by this Cloud's provider. (e.g. us-west-2)"}, "credentials": {"title": "Credentials", "type": "string", "description": "Credentials needed to interact with this Cloud."}, "config": {"title": "Config", "allOf": [{"$ref": "#/components/schemas/CloudConfig"}], "description": "Additional configurable properties of this Cloud.", "default": {"max_stopped_instances": 0}}, "is_k8s": {"title": "Is K8S", "type": "boolean", "description": "Whether this cloud is managed via K8s", "default": false}, "is_aioa": {"title": "Is Aioa", "type": "boolean", "description": "Whether this cloud is an AIOA cloud.", "default": false}, "id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "type": {"$ref": "#/components/schemas/CloudTypes"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the User who created this Cloud."}, "created_at": {"title": "Created At", "type": "string", "description": "Time when this Cloud was created.", "format": "date-time"}}, "description": "Model used to create a Cloud."}, "CloudConfig": {"title": "CloudConfig", "type": "object", "properties": {"max_stopped_instances": {"title": "Max Stopped Instances", "type": "integer", "description": "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.", "default": 0}, "vpc_peering_ip_range": {"title": "Vpc Peering Ip Range", "type": "string", "description": "VPC IP range for this Cloud."}, "vpc_peering_target_project_id": {"title": "Vpc Peering Target Project Id", "type": "string", "description": "Project ID of the VPC to peer with."}, "vpc_peering_target_vpc_id": {"title": "Vpc Peering Target Vpc Id", "type": "string", "description": "ID of the VPC to peer with."}}}, "CloudListResponse": {"title": "CloudListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Cloud"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "CloudProviders": {"title": "CloudProviders", "enum": ["AWS", "GCP", "CLOUDGATEWAY"], "type": "string", "description": "An enumeration."}, "CloudResponse": {"title": "CloudResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Cloud"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "CloudTypes": {"title": "CloudTypes", "enum": ["PUBLIC", "INTERNAL"], "type": "string", "description": "An enumeration."}, "CloudsQuery": {"title": "CloudsQuery", "type": "object", "properties": {"name": {"title": "Name", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters ComputeTemplates by name. If this field is absent, no filtering is done."}, "paging": {"title": "Paging", "allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination info.", "default": {"count": 10}}}, "description": "Query object used to search Clouds."}, "Cluster": {"title": "Cluster", "required": ["name", "cluster_environment_build_id", "cluster_compute_id", "id", "state", "creator_id", "created_at", "access_token", "services_urls", "ssh_authorized_keys", "ssh_private_key"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of this Cluster."}, "project_id": {"title": "Project Id", "type": "string", "description": "Project that this Cluster belongs to. If none, this Cluster will use the default Project."}, "cluster_environment_build_id": {"title": "Cluster Environment Build Id", "type": "string", "description": "Cluster Environment Build that this Cluster is using."}, "cluster_compute_id": {"title": "Cluster Compute Id", "type": "string", "description": "Cluster Compute that this Cluster is using."}, "idle_timeout_minutes": {"title": "Idle Timeout Minutes", "type": "integer", "description": "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'.", "default": 120}, "allow_public_internet_traffic": {"title": "Allow Public Internet Traffic", "type": "boolean", "description": "Whether public internet traffic can access Serve endpoints or if an authentication token is required.", "default": false}, "id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "state": {"allOf": [{"$ref": "#/components/schemas/ClusterState"}], "description": "Current state of the Cluster."}, "goal_state": {"allOf": [{"$ref": "#/components/schemas/ClusterState"}], "description": "State that this Cluster will eventually transition to. This will not be populated if there are no pending transitions."}, "creator_id": {"title": "Creator Id", "type": "string", "description": "User who created this Cluster."}, "created_at": {"title": "Created At", "type": "string", "description": "Time at which this Cluster was created.", "format": "date-time"}, "access_token": {"title": "Access Token", "type": "string", "description": "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."}, "services_urls": {"title": "Services Urls", "allOf": [{"$ref": "#/components/schemas/ClusterServicesUrls"}], "description": "URLs for additional services running on this Cluster (e.g. Jupyter, Ray Dashboard, etc.)."}, "head_node_info": {"title": "Head Node Info", "allOf": [{"$ref": "#/components/schemas/ClusterHeadNodeInfo"}], "description": "Detailed information about this Cluster's head node. This will only be populated for Clusters that have finished starting."}, "ssh_authorized_keys": {"title": "Ssh Authorized Keys", "type": "array", "items": {"type": "string"}, "description": "Serialized SSH Public Keys to be placed in the machine's authorized_keys."}, "ssh_private_key": {"title": "Ssh Private Key", "type": "string", "description": "SSH Private key that can be used to access the Cluster's servers."}, "ray_version": {"title": "Ray Version", "type": "string", "description": "The last known ray version running on this cluster."}, "ray_version_last_updated_at": {"title": "Ray Version Last Updated At", "type": "string", "description": "The time in which the ray version of this cluster was updated.", "format": "date-time"}}, "description": "Read model for a Cluster."}, "ClusterCompute": {"title": "ClusterCompute", "required": ["id", "name", "creator_id", "organization_id", "created_at", "last_modified_at", "config"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "creator_id": {"type": "string"}, "organization_id": {"type": "string"}, "project_id": {"type": "string"}, "created_at": {"type": "string", "format": "date-time"}, "last_modified_at": {"type": "string", "format": "date-time"}, "deleted_at": {"type": "string", "format": "date-time"}, "config": {"$ref": "#/components/schemas/ClusterComputeConfig"}}, "additionalProperties": false}, "ClusterComputeConfig": {"title": "ClusterComputeConfig", "required": ["cloud_id", "region", "head_node_type", "worker_node_types"], "type": "object", "properties": {"cloud_id": {"type": "string", "description": "The ID of the Anyscale cloud to use for launching Clusters."}, "max_workers": {"type": "integer", "description": "Desired limit on total running workers for this Cluster."}, "region": {"type": "string", "description": "The region to launch Clusters in, e.g. \"us-west-2\"."}, "allowed_azs": {"type": "array", "items": {"type": "string"}, "description": "The availability zones that clusters are allowed to be launched in, e.g. \"us-west-2a\". If not specified, any AZ may be used."}, "head_node_type": {"allOf": [{"$ref": "#/components/schemas/ComputeNodeType"}], "description": "Node configuration to use for the head node. "}, "worker_node_types": {"type": "array", "items": {"$ref": "#/components/schemas/WorkerNodeType"}, "description": "A list of node types to use for worker nodes. "}, "aws": {"allOf": [{"$ref": "#/components/schemas/AWSNodeOptions"}], "description": "Fields specific to AWS node types."}, "gcp": {"allOf": [{"$ref": "#/components/schemas/GCPNodeOptions"}], "description": "Fields specific to GCP node types."}, "azure": {"allOf": [{"$ref": "#/components/schemas/AzureNodeOptions"}], "description": "Fields specific to Azure node types."}}, "additionalProperties": false, "description": "Configuration of compute resources to use for launching a Cluster.\n    "}, "ClusterComputesQuery": {"title": "ClusterComputesQuery", "type": "object", "properties": {"project_id": {"type": "string", "description": "Filters Cluster Computes by project. If this field is absent, no filtering is done."}, "creator_id": {"type": "string", "description": "Filters Compute Computes by creator. If this field is absent, no filtering is done."}, "name": {"allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters ComputeTemplates by name. If this field is absent, no filtering is done."}, "include_anonymous": {"type": "boolean", "description": "Whether to include anonymous compute templates in the search.", "default": false}, "paging": {"allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination information.", "default": {"count": 10}}}, "additionalProperties": false}, "ClusterEnvironment": {"title": "ClusterEnvironment", "required": ["id", "name", "organization_id", "creator_id", "created_at", "last_modified_at"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "name": {"title": "Name", "type": "string", "description": "Name of the Cluster Environment."}, "project_id": {"title": "Project Id", "type": "string", "description": "ID of the Project this Cluster Environment is for."}, "organization_id": {"title": "Organization Id", "type": "string", "description": "ID of the Organization this Cluster Environment was created in."}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the User that created this record."}, "created_at": {"title": "Created At", "type": "string", "description": "Timestamp of when this record was created.", "format": "date-time"}, "last_modified_at": {"title": "Last Modified At", "type": "string", "description": "Timestamp of when this record was last updated.", "format": "date-time"}, "deleted_at": {"title": "Deleted At", "type": "string", "description": "Timestamp of when this record was deleted.", "format": "date-time"}}}, "ClusterEnvironmentBuild": {"title": "ClusterEnvironmentBuild", "required": ["cluster_environment_id", "config_json", "id", "revision", "creator_id", "status", "created_at", "last_modified_at"], "type": "object", "properties": {"cluster_environment_id": {"title": "Cluster Environment Id", "type": "string", "description": "ID of the Cluster Environment this Build belongs to."}, "config_json": {"title": "Config Json", "allOf": [{"$ref": "#/components/schemas/AppConfigConfigSchema"}], "description": "Config JSON used to create this Cluster Environment Build."}, "id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "revision": {"title": "Revision", "type": "integer", "description": "Auto incrementing version number for this Build"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the user who created this Build."}, "docker_image_name": {"title": "Docker Image Name", "type": "string", "description": "The name of the docker image for this Build."}, "error_message": {"title": "Error Message", "type": "string", "description": "Detailed error message. This will only be populated if the Build operation failed."}, "status": {"allOf": [{"$ref": "#/components/schemas/ClusterEnvironmentBuildStatus"}], "description": "\n    Status of the Build.\n\n    `pending` - Build operation is queued and has not started yet.\n    `in_progress` - Build operation is in progress.\n    `succeeded` - Build operation completed successfully.\n    `failed` - Build operation completed unsuccessfully.\n    `pending_cancellation` - Build operation is marked for cancellation.\n    `cancelled` - Build operation was cancelled before it completed.\n    "}, "created_at": {"title": "Created At", "type": "string", "description": "Timestamp of when this Build was created.", "format": "date-time"}, "last_modified_at": {"title": "Last Modified At", "type": "string", "description": "Timestamp of when this Build was last updated.", "format": "date-time"}, "deleted_at": {"title": "Deleted At", "type": "string", "description": "Timestamp of when this Build was deleted.", "format": "date-time"}}, "description": "Usable Cluster Environment Build to start a Cluster."}, "ClusterEnvironmentBuildLogResponse": {"title": "ClusterEnvironmentBuildLogResponse", "required": ["logs"], "type": "object", "properties": {"logs": {"title": "Logs", "type": "string", "description": "Logs of the build."}}}, "ClusterEnvironmentBuildOperation": {"title": "ClusterEnvironmentBuildOperation", "required": ["id", "completed", "cluster_environment_build_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "ID of this operation."}, "completed": {"title": "Completed", "type": "boolean", "description": "Boolean indicating if this operation is completed."}, "progress": {"title": "Progress", "allOf": [{"$ref": "#/components/schemas/OperationProgress"}], "description": "Details about the progress of this operation at the time of the request.             This will be absent for completed operations."}, "result": {"title": "Result", "allOf": [{"$ref": "#/components/schemas/OperationResult"}], "description": "The result of this operation after it has completed.             This is always provided when the operation is complete."}, "cluster_environment_build_id": {"title": "Cluster Environment Build Id", "type": "string", "description": "ID of the Cluster Environment Build this operation is for."}}, "description": "Describes a long running operation that will eventually complete.\nConsider this an abstract class. Specific kinds of operations should subclass this."}, "ClusterEnvironmentBuildStatus": {"title": "ClusterEnvironmentBuildStatus", "enum": ["pending", "in_progress", "succeeded", "failed", "pending_cancellation", "canceled"], "type": "string", "description": "An enumeration."}, "ClusterEnvironmentsQuery": {"title": "ClusterEnvironmentsQuery", "type": "object", "properties": {"project_id": {"title": "Project Id", "type": "string", "description": "Filters Cluster Environments by project id. If absent, no filtering is done."}, "creator_id": {"title": "Creator Id", "type": "string", "description": "Filters Cluster Environments by creator id. If absent, no filtering is done."}, "name": {"title": "Name", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters Cluster Environments by name. Currently only contains is supported.If absent, no filtering is done."}, "paging": {"title": "Paging", "allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination information.", "default": {"count": 50}}}}, "ClusterHeadNodeInfo": {"title": "ClusterHeadNodeInfo", "required": ["url", "ip_address"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "description": "URL for the head node of this Cluster."}, "ip_address": {"title": "Ip Address", "type": "string", "description": "IP address for the head node of this Cluster."}}, "description": "Details about the head node of a running Cluster."}, "ClusterListResponse": {"title": "ClusterListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Cluster"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ClusterOperation": {"title": "ClusterOperation", "required": ["id", "completed", "cluster_id", "cluster_operation_type"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "ID of this operation."}, "completed": {"title": "Completed", "type": "boolean", "description": "Boolean indicating if this operation is completed."}, "progress": {"title": "Progress", "allOf": [{"$ref": "#/components/schemas/OperationProgress"}], "description": "Details about the progress of this operation at the time of the request.             This will be absent for completed operations."}, "result": {"title": "Result", "allOf": [{"$ref": "#/components/schemas/OperationResult"}], "description": "The result of this operation after it has completed.             This is always provided when the operation is complete."}, "cluster_id": {"title": "Cluster Id", "type": "string", "description": "ID of the Cluster that is being updated."}, "cluster_operation_type": {"allOf": [{"$ref": "#/components/schemas/ClusterOperationType"}], "description": "The variety of operation being performed:             start sets the Cluster's goal state to Running,             terminate sets the Cluster's goal state to Terminated"}}, "description": "Describes a long running Cluster operation that will eventually complete."}, "ClusterOperationType": {"title": "ClusterOperationType", "enum": ["start", "terminate", "unknown"], "type": "string", "description": "Type of Cluster operation."}, "ClusterResponse": {"title": "ClusterResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Cluster"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ClusterServicesUrls": {"title": "ClusterServicesUrls", "type": "object", "properties": {"webterminal_auth_url": {"title": "Webterminal Auth Url", "type": "string", "description": "URL to authenticate with the webterminal"}, "metrics_dashboard_url": {"title": "Metrics Dashboard Url", "type": "string", "description": "URL for Grafana (metrics) dashboard."}, "connect_url": {"title": "Connect Url", "type": "string", "description": "URL for Anyscale connect."}, "jupyter_notebook_url": {"title": "Jupyter Notebook Url", "type": "string", "description": "URL for Jupyter Lab."}, "ray_dashboard_url": {"title": "Ray Dashboard Url", "type": "string", "description": "URL for Ray dashboard."}, "service_proxy_url": {"title": "Service Proxy Url", "type": "string", "description": "URL for web services proxy (e.g. jupyter, tensorboard, etc)."}}, "description": "URLs for additional services running in the Cluster. (ex/ Jupyter, Ray Dashboard).\n\nThis fields can only be populated after the Cluster has finished starting.\nAn absent field indicates the service is not available."}, "ClusterState": {"title": "ClusterState", "enum": ["Terminated", "StartingUp", "StartupErrored", "Running", "Updating", "UpdatingErrored", "Terminating", "AwaitingStartup", "TerminatingErrored", "Unknown"], "type": "string", "description": "Possible States for a Cluster."}, "ClustercomputeListResponse": {"title": "ClustercomputeListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/ClusterCompute"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ClustercomputeResponse": {"title": "ClustercomputeResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ClusterCompute"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ClusterenvironmentListResponse": {"title": "ClusterenvironmentListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/ClusterEnvironment"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ClusterenvironmentResponse": {"title": "ClusterenvironmentResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ClusterEnvironment"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ClusterenvironmentbuildListResponse": {"title": "ClusterenvironmentbuildListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/ClusterEnvironmentBuild"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ClusterenvironmentbuildResponse": {"title": "ClusterenvironmentbuildResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ClusterEnvironmentBuild"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ClusterenvironmentbuildlogresponseResponse": {"title": "ClusterenvironmentbuildlogresponseResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ClusterEnvironmentBuildLogResponse"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ClusterenvironmentbuildoperationResponse": {"title": "ClusterenvironmentbuildoperationResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ClusterEnvironmentBuildOperation"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ClusteroperationResponse": {"title": "ClusteroperationResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ClusterOperation"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ClustersQuery": {"title": "ClustersQuery", "type": "object", "properties": {"project_id": {"title": "Project Id", "type": "string", "description": "Filters Clusters belonging to a Project. If this field is absent, no filtering is done."}, "name": {"title": "Name", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters Clusters by name. If this field is absent, no filtering is done."}, "paging": {"title": "Paging", "allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination information.", "default": {"count": 10}}, "state_filter": {"uniqueItems": true, "type": "array", "items": {"$ref": "#/components/schemas/ClusterState"}, "description": "Filter Sessions by Session State. If this field is an empty set, no filtering is done.", "default": []}}, "description": "Query model used to filter Clusters."}, "ComputeNodeType": {"title": "ComputeNodeType", "required": ["name", "instance_type"], "type": "object", "properties": {"name": {"type": "string", "description": "An arbitrary name for this node type, which will be registered with OSS available_node_types. "}, "instance_type": {"type": "string", "description": "The cloud provider instance type to use for this node."}, "resources": {"allOf": [{"$ref": "#/components/schemas/Resources"}], "description": "Declaration of node resources for Autoscaler."}}, "additionalProperties": false}, "ComputeTemplate": {"title": "ComputeTemplate", "required": ["id", "name", "creator_id", "organization_id", "created_at", "last_modified_at", "config"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "creator_id": {"type": "string"}, "organization_id": {"type": "string"}, "project_id": {"type": "string"}, "created_at": {"type": "string", "format": "date-time"}, "last_modified_at": {"type": "string", "format": "date-time"}, "deleted_at": {"type": "string", "format": "date-time"}, "config": {"$ref": "#/components/schemas/ComputeTemplateConfig"}}, "additionalProperties": false}, "ComputeTemplateConfig": {"title": "ComputeTemplateConfig", "required": ["cloud_id", "region", "head_node_type", "worker_node_types"], "type": "object", "properties": {"cloud_id": {"type": "string", "description": "The ID of the Anyscale cloud to use for launching sessions."}, "max_workers": {"type": "integer", "description": "Desired limit on total running workers for this session."}, "region": {"type": "string", "description": "The region to launch sessions in, e.g. \"us-west-2\"."}, "allowed_azs": {"type": "array", "items": {"type": "string"}, "description": "The availability zones that sessions are allowed to be launched in, e.g. \"us-west-2a\". If not specified, any AZ may be used."}, "head_node_type": {"allOf": [{"$ref": "#/components/schemas/ComputeNodeType"}], "description": "Node configuration to use for the head node. "}, "worker_node_types": {"type": "array", "items": {"$ref": "#/components/schemas/WorkerNodeType"}, "description": "A list of node types to use for worker nodes. "}, "aws": {"allOf": [{"$ref": "#/components/schemas/AWSNodeOptions"}], "description": "Fields specific to AWS node types."}, "gcp": {"allOf": [{"$ref": "#/components/schemas/GCPNodeOptions"}], "description": "Fields specific to GCP node types."}, "azure": {"allOf": [{"$ref": "#/components/schemas/AzureNodeOptions"}], "description": "Fields specific to Azure node types."}}, "additionalProperties": false, "description": "Configuration of compute resources to use for launching a session.\n    "}, "ComputeTemplateQuery": {"title": "ComputeTemplateQuery", "type": "object", "properties": {"orgwide": {"type": "boolean", "default": false}, "project_id": {"type": "string"}, "creator_id": {"type": "string", "description": "Filters Compute Templates by creator. This is only supported when `orgwide` is True."}, "name": {"allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters ComputeTemplates by name. If this field is absent, no filtering is done. For now, only equals match is supported when `orgwide` is False."}, "include_anonymous": {"type": "boolean", "description": "Whether to include anonymous compute templates in the search. Anonymous compute templates are usually not shown in list views.", "default": false}}, "additionalProperties": false}, "ComputetemplateListResponse": {"title": "ComputetemplateListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/ComputeTemplate"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ComputetemplateResponse": {"title": "ComputetemplateResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ComputeTemplate"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ComputetemplateconfigResponse": {"title": "ComputetemplateconfigResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ComputeTemplateConfig"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "CreateAppConfig": {"title": "CreateAppConfig", "required": ["name", "config_json"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the App Template."}, "project_id": {"title": "Project Id", "type": "string", "description": "ID of the Project this App Config is for."}, "config_json": {"title": "Config Json", "allOf": [{"$ref": "#/components/schemas/CreateAppConfigConfigurationSchema"}], "description": "Config JSON to use to create a new App Config."}}, "description": "Model used to create an App Config."}, "CreateAppConfigConfigurationSchema": {"title": "CreateAppConfigConfigurationSchema", "required": ["base_image"], "type": "object", "properties": {"base_image": {"allOf": [{"$ref": "#/components/schemas/SUPPORTED_BASE_IMAGES_ENUM"}], "description": "The base image to use to create a new app config. It needs to be one of the images that we currently support (SupportedBaseImages)."}, "env_vars": {"title": "Env Vars", "type": "object", "description": "Environment varibles in the docker image that'll be used at runtime."}, "debian_packages": {"title": "Debian Packages", "type": "array", "items": {"type": "string"}, "description": "List of debian packages that'll be included in the image."}, "python": {"title": "Python", "allOf": [{"$ref": "#/components/schemas/PythonModules"}], "description": "Python related dependencies."}, "post_build_cmds": {"title": "Post Build Cmds", "type": "array", "items": {"type": "string"}, "description": "List of post build commands that'll be included in the image."}}}, "CreateBuild": {"title": "CreateBuild", "required": ["application_template_id", "config_json"], "type": "object", "properties": {"application_template_id": {"title": "Application Template Id", "type": "string", "description": "ID of the App Config this Build belongs to."}, "config_json": {"title": "Config Json", "allOf": [{"$ref": "#/components/schemas/CreateAppConfigConfigurationSchema"}], "description": "Config JSON to use to create a new Build."}}, "description": "Model used to create a Build."}, "CreateCloud": {"title": "CreateCloud", "required": ["name", "provider", "region", "credentials"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of this Cloud."}, "provider": {"allOf": [{"$ref": "#/components/schemas/CloudProviders"}], "description": "Provider of this Cloud (e.g. AWS)."}, "region": {"title": "Region", "type": "string", "description": "Region this Cloud is operating in. This value needs to be supported by this Cloud's provider. (e.g. us-west-2)"}, "credentials": {"title": "Credentials", "type": "string", "description": "Credentials needed to interact with this Cloud."}, "config": {"title": "Config", "allOf": [{"$ref": "#/components/schemas/CloudConfig"}], "description": "Additional configurable properties of this Cloud.", "default": {"max_stopped_instances": 0}}, "is_k8s": {"title": "Is K8S", "type": "boolean", "description": "Whether this cloud is managed via K8s", "default": false}, "is_aioa": {"title": "Is Aioa", "type": "boolean", "description": "Whether this cloud is an AIOA cloud.", "default": false}}, "description": "Model used to create a Cloud."}, "CreateCluster": {"title": "CreateCluster", "required": ["name", "cluster_environment_build_id", "cluster_compute_id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of this Cluster."}, "project_id": {"title": "Project Id", "type": "string", "description": "Project that this Cluster belongs to. If none, this Cluster will use the default Project."}, "cluster_environment_build_id": {"title": "Cluster Environment Build Id", "type": "string", "description": "Cluster Environment Build that this Cluster is using."}, "cluster_compute_id": {"title": "Cluster Compute Id", "type": "string", "description": "Cluster Compute that this Cluster is using."}, "idle_timeout_minutes": {"title": "Idle Timeout Minutes", "type": "integer", "description": "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'.", "default": 120}, "allow_public_internet_traffic": {"title": "Allow Public Internet Traffic", "type": "boolean", "description": "Whether public internet traffic can access Serve endpoints or if an authentication token is required.", "default": false}}, "description": "Model used to create a new Cluster."}, "CreateClusterCompute": {"title": "CreateClusterCompute", "required": ["config"], "type": "object", "properties": {"name": {"type": "string"}, "project_id": {"type": "string"}, "config": {"$ref": "#/components/schemas/CreateClusterComputeConfig"}, "anonymous": {"type": "boolean", "description": "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.", "default": false}}, "additionalProperties": false}, "CreateClusterComputeConfig": {"title": "CreateClusterComputeConfig", "required": ["cloud_id", "head_node_type", "worker_node_types"], "type": "object", "properties": {"cloud_id": {"type": "string", "description": "The ID of the Anyscale cloud to use for launching Clusters."}, "max_workers": {"type": "integer", "description": "Desired limit on total running workers for this Cluster."}, "region": {"type": "string", "description": "Deprecated! When creating a cluster compute, a region does not have to be provided. Instead we will use the value from the cloud.", "default": "USE_CLOUD"}, "allowed_azs": {"type": "array", "items": {"type": "string"}, "description": "The availability zones that clusters are allowed to be launched in, e.g. \"us-west-2a\". If not specified, any AZ may be used."}, "head_node_type": {"allOf": [{"$ref": "#/components/schemas/ComputeNodeType"}], "description": "Node configuration to use for the head node. "}, "worker_node_types": {"type": "array", "items": {"$ref": "#/components/schemas/WorkerNodeType"}, "description": "A list of node types to use for worker nodes. "}, "aws": {"allOf": [{"$ref": "#/components/schemas/AWSNodeOptions"}], "description": "Fields specific to AWS node types."}, "gcp": {"allOf": [{"$ref": "#/components/schemas/GCPNodeOptions"}], "description": "Fields specific to GCP node types."}, "azure": {"allOf": [{"$ref": "#/components/schemas/AzureNodeOptions"}], "description": "Fields specific to Azure node types."}}, "additionalProperties": false, "description": "Configuration of compute resources to use for launching a Cluster.\n    "}, "CreateClusterEnvironment": {"title": "CreateClusterEnvironment", "required": ["name", "config_json"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the Cluster Environment."}, "project_id": {"title": "Project Id", "type": "string", "description": "ID of the Project this Cluster Environment is for."}, "config_json": {"title": "Config Json", "allOf": [{"$ref": "#/components/schemas/CreateClusterEnvironmentConfigurationSchema"}], "description": "Config JSON to use to create a new Cluster Environment."}}, "description": "Model used to create an Cluster Environment."}, "CreateClusterEnvironmentBuild": {"title": "CreateClusterEnvironmentBuild", "required": ["cluster_environment_id", "config_json"], "type": "object", "properties": {"cluster_environment_id": {"title": "Cluster Environment Id", "type": "string", "description": "ID of the Cluster Environment this Build belongs to."}, "config_json": {"title": "Config Json", "allOf": [{"$ref": "#/components/schemas/CreateAppConfigConfigurationSchema"}], "description": "Config JSON to use to create a new Build."}}, "description": "Model used to create a Cluster Environment Build."}, "CreateClusterEnvironmentConfigurationSchema": {"title": "CreateClusterEnvironmentConfigurationSchema", "required": ["base_image"], "type": "object", "properties": {"base_image": {"allOf": [{"$ref": "#/components/schemas/SUPPORTED_BASE_IMAGES_ENUM"}], "description": "The base image to use to create a new Cluster Environment. It needs to be one of the images that we currently support (SupportedBaseImages)."}, "env_vars": {"title": "Env Vars", "type": "object", "description": "Environment varibles in the docker image that'll be used at runtime."}, "debian_packages": {"title": "Debian Packages", "type": "array", "items": {"type": "string"}, "description": "List of debian packages that'll be included in the image."}, "python": {"title": "Python", "allOf": [{"$ref": "#/components/schemas/PythonModules"}], "description": "Python related dependencies."}, "post_build_cmds": {"title": "Post Build Cmds", "type": "array", "items": {"type": "string"}, "description": "List of post build commands that'll be included in the image."}}}, "CreateComputeTemplate": {"title": "CreateComputeTemplate", "required": ["config"], "type": "object", "properties": {"name": {"type": "string"}, "project_id": {"type": "string"}, "config": {"$ref": "#/components/schemas/ComputeTemplateConfig"}, "anonymous": {"type": "boolean", "description": "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.", "default": false}}, "additionalProperties": false}, "CreateProductionJob": {"title": "CreateProductionJob", "required": ["name", "project_id", "config"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the job"}, "description": {"title": "Description", "type": "string", "description": "Description of the job"}, "project_id": {"title": "Project Id", "type": "string", "description": "Id of the project this job will start clusters in"}, "config": {"$ref": "#/components/schemas/ProductionJobConfig"}}}, "CreateProductionService": {"title": "CreateProductionService", "required": ["name", "project_id", "config", "healthcheck_url"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the job"}, "description": {"title": "Description", "type": "string", "description": "Description of the job"}, "project_id": {"title": "Project Id", "type": "string", "description": "Id of the project this job will start clusters in"}, "config": {"$ref": "#/components/schemas/ProductionJobConfig"}, "healthcheck_url": {"title": "Healthcheck Url", "type": "string", "description": "Healthcheck url"}}}, "CreateProject": {"title": "CreateProject", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the Project to be created."}, "cluster_config": {"title": "Cluster Config", "type": "string", "description": "Cluster config associated with the Project. This can later be used to start a Session. Default will be used if not provided."}, "description": {"title": "Description", "type": "string", "description": "Description of Project."}}, "description": "Model used to create a Project."}, "CreateResponse": {"title": "CreateResponse", "required": ["id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "ID of the newly created entity"}}, "description": "Common response that all create methods should return."}, "CreateSSOConfig": {"title": "CreateSSOConfig", "type": "object", "properties": {"idp_metadata_url": {"title": "Idp Metadata Url", "type": "string", "description": "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."}, "static_idp_config": {"title": "Static Idp Config", "allOf": [{"$ref": "#/components/schemas/StaticSSOConfig"}], "description": "Static identity provider configuration."}}, "description": "Model used to create an SSOConfig. Must contain at least one of idp_metadata_url or static_config."}, "CreateSession": {"title": "CreateSession", "required": ["name", "project_id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the session to be created."}, "project_id": {"title": "Project Id", "type": "string", "description": "Project that the session will be created in."}, "cloud_id": {"title": "Cloud Id", "type": "string", "description": "Cloud that the session will use."}, "cluster_config": {"title": "Cluster Config", "type": "string", "description": "Cluster config that the session can later be started with."}, "build_id": {"title": "Build Id", "type": "string", "description": "ID of the Build that this session was started with."}, "compute_template_id": {"title": "Compute Template Id", "type": "string", "description": "ID of the compute template that this session was started with."}, "idle_timeout": {"title": "Idle Timeout", "type": "integer", "description": "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'.", "default": 120}, "uses_app_config": {"title": "Uses App Config", "type": "boolean", "description": "Whether or not the session uses app config. If true, it means this is not a legacy session started with cluster yaml.", "default": false}, "allow_public_internet_traffic": {"title": "Allow Public Internet Traffic", "type": "boolean", "description": "Whether public internet traffic can access Serve endpoints or if an authentication token is required.", "default": false}}, "description": "Model used to create a Session.\n\nIf uses_app_config is set, build_id and compute_template_id must be passed. Otherwise, cluster_config and cloud_id must be passed."}, "CreateSessionCommand": {"title": "CreateSessionCommand", "required": ["session_id", "shell_command"], "type": "object", "properties": {"session_id": {"title": "Session Id", "type": "string", "description": "ID of the Session to execute this command on."}, "shell_command": {"title": "Shell Command", "type": "string", "description": "Shell command string that will be executed."}}, "description": "Model used to create and execute a command on a Session."}, "EbsBlockDevice": {"title": "EbsBlockDevice", "type": "object", "properties": {"DeleteOnTermination": {"type": "boolean"}, "Encrypted": {"type": "boolean"}, "Iops": {"type": "integer"}, "KmsKeyId": {"type": "string"}, "OutpostArn": {"type": "string"}, "SnapshotId": {"type": "string"}, "Throughput": {"type": "integer"}, "VolumeSize": {"type": "integer"}, "VolumeType": {"type": "string"}}, "additionalProperties": false, "description": "https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html"}, "GCPNodeOptions": {"title": "GCPNodeOptions", "type": "object", "properties": {"serviceAccount": {"$ref": "#/components/schemas/ServiceAccount"}}, "additionalProperties": false}, "HTTPValidationError": {"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"$ref": "#/components/schemas/ValidationError"}}}}, "HaJobGoalStates": {"title": "HaJobGoalStates", "enum": ["TERMINATED", "SUCCESS", "RUNNING"], "type": "string", "description": "An enumeration."}, "HaJobStates": {"title": "HaJobStates", "enum": ["PENDING", "AWAITING_CLUSTER_START", "UPDATING", "RUNNING", "SUCCESS", "ERRORED", "TERMINATED", "CLEANING_UP", "BROKEN", "OUT_OF_RETRIES"], "type": "string", "description": "An enumeration."}, "IamInstanceProfileSpecification": {"title": "IamInstanceProfileSpecification", "type": "object", "properties": {"Arn": {"type": "string"}, "Name": {"type": "string"}}, "additionalProperties": false, "description": "https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfileSpecification.html"}, "Job": {"title": "Job", "required": ["id", "ray_session_name", "ray_job_id", "status", "created_at", "cluster_id", "namespace_id", "runtime_environment_id", "creator_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "ray_session_name": {"title": "Ray Session Name", "type": "string", "description": "Name of the Session provided from Ray"}, "ray_job_id": {"title": "Ray Job Id", "type": "string", "description": "ID of the Job provided from Ray"}, "name": {"title": "Name", "type": "string", "description": "Name of this Job."}, "status": {"allOf": [{"$ref": "#/components/schemas/JobStatus"}], "description": "Status of this Job's execution."}, "created_at": {"title": "Created At", "type": "string", "description": "Time at which this Job was created.", "format": "date-time"}, "finished_at": {"title": "Finished At", "type": "string", "description": "Time at which this Job finished. If absent, this Job is still running.", "format": "date-time"}, "ray_job_submission_id": {"title": "Ray Job Submission Id", "type": "string", "description": "ID of the submitted Ray Job that this Job corresponds to."}, "cluster_id": {"title": "Cluster Id", "type": "string", "description": "ID of the Anyscale Cluster this Job is on."}, "namespace_id": {"title": "Namespace Id", "type": "string", "description": "ID of the Anyscale Namespace this Job is using."}, "runtime_environment_id": {"title": "Runtime Environment Id", "type": "string", "description": "ID of the Anyscale Runtime Environment this Job is using."}, "project_id": {"title": "Project Id", "type": "string", "description": "ID of the Project this Job belongs to."}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the user who created this Job."}}}, "JobListResponse": {"title": "JobListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Job"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "JobResponse": {"title": "JobResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Job"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "JobRunType": {"title": "JobRunType", "enum": ["INTERACTIVE_SESSION", "RUN", "RAY_SUBMIT"], "type": "string", "description": "An enumeration."}, "JobStatus": {"title": "JobStatus", "enum": ["RUNNING", "COMPLETED", "PENDING", "STOPPED", "SUCCEEDED", "FAILED", "UNKNOWN"], "type": "string", "description": "An enumeration."}, "JobsLogs": {"title": "JobsLogs", "required": ["logs", "ready"], "type": "object", "properties": {"logs": {"title": "Logs", "type": "string", "description": "Logs of this entity"}, "ready": {"title": "Ready", "type": "boolean", "description": "\n            Indicates if underlying logs service is ready to use.\n            If false, clients will need to request for logs until this field is True.\n        "}}, "description": "DEPRECATED: The logs for this job"}, "JobsQuery": {"title": "JobsQuery", "type": "object", "properties": {"name": {"title": "Name", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters Jobs by name. If this field is absent, no filtering is done."}, "runtime_environment_id": {"title": "Runtime Environment Id", "type": "string", "description": "Filters Jobs by runtime enviornment id. If this field is absent, no filtering is done."}, "cluster_id": {"title": "Cluster Id", "type": "string", "description": "Filters Jobs by cluster id. If this field is absent, no filtering is done."}, "creator_id": {"title": "Creator Id", "type": "string", "description": "Filters Jobs by creator_id. If this field is absent, no filtering is done."}, "ray_job_id": {"title": "Ray Job Id", "type": "string", "description": "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."}, "project_id": {"title": "Project Id", "type": "string", "description": "Filters Jobs by project_id. If this field is absent, no filtering is done."}, "include_child_jobs": {"title": "Include Child Jobs", "type": "boolean", "description": "Include jobs that have parents", "default": false}, "ha_job_id": {"title": "Ha Job Id", "type": "string", "description": "Filter by the anyscale job"}, "show_ray_client_runs_only": {"title": "Show Ray Client Runs Only", "type": "boolean", "description": "DEPRECATED: use type_filter. Shows only ray client runs. Orthogonal to passing ha_job_id", "default": true}, "paging": {"title": "Paging", "allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination information.", "default": {"count": 10}}, "state_filter": {"uniqueItems": true, "type": "array", "items": {"$ref": "#/components/schemas/BaseJobStatus"}, "description": "Filter Jobs by Job Status. If this field is an empty set, no filtering is done.", "default": []}, "type_filter": {"uniqueItems": true, "type": "array", "items": {"$ref": "#/components/schemas/JobRunType"}, "description": "Filter Jobs by their type. Their type is determined by their usage within the product e.g. Interactive sessions, job runs", "default": []}}, "description": "Query model used to filter Jobs."}, "JobslogsResponse": {"title": "JobslogsResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/JobsLogs"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ListResponseMetadata": {"title": "ListResponseMetadata", "type": "object", "properties": {"total": {"type": "integer"}, "next_paging_token": {"type": "string"}}, "additionalProperties": false, "description": "Metadata for a ListResponse containing common info like pagination"}, "LogLevelTypes": {"title": "LogLevelTypes", "enum": ["info", "error"], "type": "string", "description": "The classification of a session event.\n    "}, "Namespace": {"title": "Namespace", "required": ["id", "cluster_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "cluster_id": {"title": "Cluster Id", "type": "string", "description": "ID of the Cluster that this Namespace exists within."}, "name": {"title": "Name", "type": "string", "description": "Optional name for this Namespace."}}, "description": "Representation of a Ray Namespace that is used within an Anyscale Cluster."}, "NamespaceResponse": {"title": "NamespaceResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Namespace"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "NetworkInterface": {"title": "NetworkInterface", "required": ["SubnetId", "Groups"], "type": "object", "properties": {"SubnetId": {"type": "string"}, "Groups": {"type": "array", "items": {"type": "string"}}, "AssociatePublicIpAddress": {"type": "boolean", "default": true}}, "additionalProperties": false, "description": "Allows users to override network interface used by your instances.\n\nSee https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#networkinterface"}, "ObjectStorageConfig": {"title": "ObjectStorageConfig", "type": "object", "properties": {"s3": {"title": "S3", "allOf": [{"$ref": "#/components/schemas/ObjectStorageConfigS3"}], "description": "S3 configuration"}}, "description": "Field representing a object storage configuration for an organization in a region"}, "ObjectStorageConfigS3": {"title": "ObjectStorageConfigS3", "required": ["region", "bucket", "path", "aws_access_key_id", "aws_secret_access_key", "aws_session_token"], "type": "object", "properties": {"region": {"title": "Region", "type": "string"}, "bucket": {"title": "Bucket", "type": "string"}, "path": {"title": "Path", "type": "string"}, "aws_access_key_id": {"title": "Aws Access Key Id", "type": "string"}, "aws_secret_access_key": {"title": "Aws Secret Access Key", "type": "string"}, "aws_session_token": {"title": "Aws Session Token", "type": "string"}}}, "ObjectstorageconfigResponse": {"title": "ObjectstorageconfigResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ObjectStorageConfig"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "OperationError": {"title": "OperationError", "required": ["message"], "type": "object", "properties": {"message": {"title": "Message", "type": "string", "description": "Human readable message explaining why this operation failed."}}, "description": "The response of this operation in case of failure\n    "}, "OperationProgress": {"title": "OperationProgress", "required": ["message"], "type": "object", "properties": {"message": {"title": "Message", "type": "string", "description": "Human readable message about the progress of an operation."}}, "description": "Provides detailed information about how this operation is progressing.\n    "}, "OperationResult": {"title": "OperationResult", "type": "object", "properties": {"data": {"title": "Data", "description": "The response of this operation in case of success.        This is typically the resource that this operation acted on."}, "error": {"title": "Error", "allOf": [{"$ref": "#/components/schemas/OperationError"}], "description": "The response of this operation in case of failure"}}, "description": "The result of an Operation upon completion.\nExactly one of `error` or `data` will be set."}, "Organization": {"title": "Organization", "required": ["id", "name", "public_identifier"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "name": {"title": "Name", "type": "string", "description": "Organization's display name."}, "public_identifier": {"title": "Public Identifier", "type": "string", "description": "Organization's public identifier."}, "sso_required": {"title": "Sso Required", "type": "boolean", "description": "Require users to log in to your organization using single sign on (SSO).", "default": false}}, "description": "Fields representing an Organization"}, "OrganizationResponse": {"title": "OrganizationResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Organization"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "PageQuery": {"title": "PageQuery", "type": "object", "properties": {"count": {"title": "Count", "minimum": 0.0, "type": "integer", "description": "Number of elements to fetch. Defaults to 10.", "default": 10}, "paging_token": {"title": "Paging Token", "type": "string", "description": "Token used for pagination. If absent, server will return elements from the first page."}}, "description": "Query model for paginating results."}, "ProductionJob": {"title": "ProductionJob", "required": ["id", "name", "created_at", "creator_id", "config", "state", "project_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "The id of this job"}, "name": {"title": "Name", "type": "string", "description": "Name of the job"}, "description": {"title": "Description", "type": "string", "description": "Description of the job"}, "created_at": {"title": "Created At", "type": "string", "description": "The time this job was created", "format": "date-time"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "The id of the user who created this job"}, "config": {"title": "Config", "allOf": [{"$ref": "#/components/schemas/ProductionJobConfig"}], "description": "The config that was used to create this job"}, "state": {"title": "State", "allOf": [{"$ref": "#/components/schemas/ProductionJobStateTransition"}], "description": "The current state of this job"}, "project_id": {"title": "Project Id", "type": "string", "description": "Id of the project this job will start clusters in"}}, "description": "Model of a Production Job for use in the SDK."}, "ProductionJobConfig": {"title": "ProductionJobConfig", "required": ["entrypoint", "build_id", "compute_config_id"], "type": "object", "properties": {"entrypoint": {"title": "Entrypoint", "type": "string", "description": "A script that will be run to start your job. This command will be run in the root directory of the specified runtime env. Eg. 'python script.py'"}, "runtime_env": {"title": "Runtime Env", "allOf": [{"$ref": "#/components/schemas/RayRuntimeEnvConfig"}], "description": "A ray runtime env json. Your entrypoint will be run in the environment specified by this runtime env."}, "build_id": {"title": "Build Id", "type": "string", "description": "The id of the cluster env build. This id will determine the docker image your job is run on."}, "compute_config_id": {"title": "Compute Config Id", "type": "string", "description": "The id of the compute configuration that you want to use. This id will specify the resources required for your job"}, "max_retries": {"title": "Max Retries", "type": "integer", "description": "The number of retries this job will attempt on failure. Set to None to set infinite retries", "default": 5}, "runtime_env_config": {"title": "Runtime Env Config", "allOf": [{"$ref": "#/components/schemas/RayRuntimeEnvConfig"}], "description": "DEPRECATED: Use runtime_env"}}}, "ProductionJobStateTransition": {"title": "ProductionJobStateTransition", "required": ["id", "state_transitioned_at", "current_state"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "The id of this job state transition"}, "state_transitioned_at": {"title": "State Transitioned At", "type": "string", "description": "The last time the state of this job was updated. This includes updates to the state and to the goal state", "format": "date-time"}, "current_state": {"allOf": [{"$ref": "#/components/schemas/HaJobStates"}], "description": "The current state of the job"}, "goal_state": {"allOf": [{"$ref": "#/components/schemas/HaJobGoalStates"}], "description": "The goal state of the job"}, "error": {"title": "Error", "type": "string", "description": "An error message that occurred in this job state transition"}, "operation_message": {"title": "Operation Message", "type": "string", "description": "The logging message for this job state transition"}, "cluster_id": {"title": "Cluster Id", "type": "string", "description": "The id of the cluster the job is running on"}}}, "ProductionService": {"title": "ProductionService", "required": ["id", "name", "created_at", "creator_id", "config", "state", "project_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "The id of this job"}, "name": {"title": "Name", "type": "string", "description": "Name of the job"}, "description": {"title": "Description", "type": "string", "description": "Description of the job"}, "created_at": {"title": "Created At", "type": "string", "description": "The time this job was created", "format": "date-time"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "The id of the user who created this job"}, "config": {"title": "Config", "allOf": [{"$ref": "#/components/schemas/ProductionJobConfig"}], "description": "The config that was used to create this job"}, "state": {"title": "State", "allOf": [{"$ref": "#/components/schemas/ProductionJobStateTransition"}], "description": "The current state of this job"}, "project_id": {"title": "Project Id", "type": "string", "description": "Id of the project this job will start clusters in"}}, "description": "Model of a Production Service for use in the SDK."}, "ProductionjobListResponse": {"title": "ProductionjobListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/ProductionJob"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ProductionjobResponse": {"title": "ProductionjobResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ProductionJob"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ProductionserviceListResponse": {"title": "ProductionserviceListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/ProductionService"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ProductionserviceResponse": {"title": "ProductionserviceResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/ProductionService"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "Project": {"title": "Project", "required": ["name", "cluster_config", "id", "created_at", "organization_id", "active_sessions", "last_activity_at", "is_default"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the Project to be created."}, "cluster_config": {"title": "Cluster Config", "type": "string", "description": "Cluster config associated with the Project. This can later be used to start a Session."}, "description": {"title": "Description", "type": "string", "description": "Description of Project."}, "id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier of the Project."}, "creator_id": {"title": "Creator Id", "type": "string", "description": "Identifier of user who created the Project."}, "created_at": {"title": "Created At", "type": "string", "description": "Time at which Project was created.", "format": "date-time"}, "organization_id": {"title": "Organization Id", "type": "string", "description": "Organization that the Project is associated with."}, "active_sessions": {"title": "Active Sessions", "type": "integer", "description": "Read only. Number of active sessions for this project."}, "last_activity_at": {"title": "Last Activity At", "type": "string", "description": "Read only. The most recent activity for this project. This is based on the most recently created sessions", "format": "date-time"}, "last_used_cloud_id": {"title": "Last Used Cloud Id", "type": "string", "description": "ID of the last cloud used in this project, or by the user if this is a new project. "}, "is_default": {"title": "Is Default", "type": "boolean", "description": "True if this project is the default project for the organization."}}, "description": "Model used to read a Project."}, "ProjectListResponse": {"title": "ProjectListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Project"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "ProjectResponse": {"title": "ProjectResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Project"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "ProjectsQuery": {"title": "ProjectsQuery", "type": "object", "properties": {"name": {"title": "Name", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters Projects by name. If this field is absent, no filtering is done."}, "creator_id": {"title": "Creator Id", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters Projects by creator_id. If this field is absent, no filtering is done."}, "paging": {"title": "Paging", "allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination information.", "default": {"count": 10}}}, "description": "Query model used to filter Projects."}, "PythonModules": {"title": "PythonModules", "type": "object", "properties": {"pip_packages": {"title": "Pip Packages", "type": "array", "items": {"type": "string"}, "description": "List of pip packages that'll be included in the image."}, "conda_packages": {"title": "Conda Packages", "type": "array", "items": {"type": "string"}, "description": "List of conda packages that'll be included in the image."}}}, "PythonVersion": {"title": "PythonVersion", "enum": ["py36", "py37", "py38"], "type": "string", "description": "An enumeration."}, "RayRuntimeEnvConfig": {"title": "RayRuntimeEnvConfig", "type": "object", "properties": {"working_dir": {"title": "Working Dir", "type": "string", "description": "The working directory that your code will run in. Must be a remote URI like an s3 or git path."}, "py_modules": {"title": "Py Modules", "type": "array", "items": {"type": "string"}, "description": "Python modules that will be installed along with your runtime env. These must be remote URIs."}, "pip": {"title": "Pip", "type": "array", "items": {"type": "string"}, "description": "A list of pip packages to install."}, "conda": {"title": "Conda", "description": "[Union[Dict[str, Any], str]: Either the conda YAML config or the name of a local conda env (e.g., \"pytorch_p36\"), "}, "env_vars": {"title": "Env Vars", "type": "object", "additionalProperties": {"type": "string"}, "description": "Environment variables to set."}}, "description": "A runtime env config. Can be used to start a production job."}, "Resources": {"title": "Resources", "type": "object", "properties": {"cpu": {"type": "integer", "description": "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."}, "gpu": {"type": "integer", "description": "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."}, "memory": {"type": "integer", "description": "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."}, "object_store_memory": {"type": "integer", "description": "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."}, "custom_resources": {"type": "object", "additionalProperties": {"type": "integer"}, "description": "Declare custom resources for this node to be used by Ray autoscaler.", "default": {}}}, "additionalProperties": false}, "RuntimeEnvironment": {"title": "RuntimeEnvironment", "required": ["id", "ray_env_hash", "created_at", "creator_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "Server assigned unique Identifier"}, "ray_env_hash": {"title": "Ray Env Hash", "type": "string", "description": "A hash of this Runtime Environment as provided by Ray"}, "name": {"title": "Name", "type": "string", "description": "Name for this Runtime Environment."}, "working_dir": {"title": "Working Dir", "type": "string", "description": "The working directory for this Runtime Environment."}, "py_modules": {"title": "Py Modules", "type": "array", "items": {"type": "string"}, "description": "Python modules included in this Runtime Environment."}, "pip_packages": {"title": "Pip Packages", "type": "string", "description": "Pip dependencies installed in this Runtime Environment."}, "conda_env_name": {"title": "Conda Env Name", "type": "string", "description": "Name of the Conda environment this Runtime Environment is using."}, "conda_values": {"title": "Conda Values", "type": "object", "description": "Conda values for this Runtime Environment."}, "env_variables": {"title": "Env Variables", "type": "object", "additionalProperties": {"type": "string"}, "description": "Environment variables set for this Runtime Environment."}, "created_at": {"title": "Created At", "type": "string", "description": "Time at which this Runtime Environment was created.", "format": "date-time"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the User who created this Runtime Environment."}}, "description": "Reusable runtime environment for Jobs and Actors running in Anyscale."}, "RuntimeenvironmentResponse": {"title": "RuntimeenvironmentResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/RuntimeEnvironment"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "SSOConfig": {"title": "SSOConfig", "required": ["id", "created_at", "creator_id"], "type": "object", "properties": {"idp_metadata_url": {"title": "Idp Metadata Url", "type": "string", "description": "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."}, "static_idp_config": {"title": "Static Idp Config", "allOf": [{"$ref": "#/components/schemas/StaticSSOConfig"}], "description": "Static identity provider configuration."}, "id": {"title": "Id", "type": "string", "description": "ID of this SSO Config."}, "created_at": {"title": "Created At", "type": "string", "description": "Time at which this SSO Config was created.", "format": "date-time"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "ID of the user who created this SSO Config."}}, "description": "Read model of an SSOConfig\n    "}, "SSOMode": {"title": "SSOMode", "enum": ["off", "optional", "required"], "type": "string", "description": "An enumeration."}, "SUPPORTED_BASE_IMAGES_ENUM": {"title": "SUPPORTED_BASE_IMAGES_ENUM", "enum": ["anyscale/ray-ml:1.10.0-py36-gpu", "anyscale/ray-ml:1.10.0-py37-gpu", "anyscale/ray-ml:1.10.0-py38-gpu", "anyscale/ray-ml:1.10.0rc0-py36-gpu", "anyscale/ray-ml:1.10.0rc0-py37-gpu", "anyscale/ray-ml:1.10.0rc0-py38-gpu", "anyscale/ray-ml:1.2.0", "anyscale/ray-ml:1.2.0-gpu", "anyscale/ray-ml:1.3.0", "anyscale/ray-ml:1.3.0-gpu", "anyscale/ray-ml:1.3.0-py36", "anyscale/ray-ml:1.3.0-py36-gpu", "anyscale/ray-ml:1.3.0-py37", "anyscale/ray-ml:1.3.0-py37-gpu", "anyscale/ray-ml:1.3.0-py38", "anyscale/ray-ml:1.3.0-py38-gpu", "anyscale/ray-ml:1.4-rc0", "anyscale/ray-ml:1.4-rc0-gpu", "anyscale/ray-ml:1.4-rc0-py36", "anyscale/ray-ml:1.4-rc0-py36-gpu", "anyscale/ray-ml:1.4-rc0-py37", "anyscale/ray-ml:1.4-rc0-py37-gpu", "anyscale/ray-ml:1.4-rc0-py38", "anyscale/ray-ml:1.4-rc0-py38-gpu", "anyscale/ray-ml:1.4-rc1", "anyscale/ray-ml:1.4-rc1-gpu", "anyscale/ray-ml:1.4-rc1-py36", "anyscale/ray-ml:1.4-rc1-py36-gpu", "anyscale/ray-ml:1.4-rc1-py37", "anyscale/ray-ml:1.4-rc1-py37-gpu", "anyscale/ray-ml:1.4-rc1-py38", "anyscale/ray-ml:1.4-rc1-py38-gpu", "anyscale/ray-ml:1.4-rc2", "anyscale/ray-ml:1.4-rc2-gpu", "anyscale/ray-ml:1.4-rc2-py36", "anyscale/ray-ml:1.4-rc2-py36-gpu", "anyscale/ray-ml:1.4-rc2-py37", "anyscale/ray-ml:1.4-rc2-py37-gpu", "anyscale/ray-ml:1.4-rc2-py38", "anyscale/ray-ml:1.4-rc2-py38-gpu", "anyscale/ray-ml:1.4.0", "anyscale/ray-ml:1.4.0-gpu", "anyscale/ray-ml:1.4.0-py36", "anyscale/ray-ml:1.4.0-py36-gpu", "anyscale/ray-ml:1.4.0-py37", "anyscale/ray-ml:1.4.0-py37-gpu", "anyscale/ray-ml:1.4.0-py38", "anyscale/ray-ml:1.4.0-py38-gpu", "anyscale/ray-ml:1.4.1", "anyscale/ray-ml:1.4.1-gpu", "anyscale/ray-ml:1.4.1-py36", "anyscale/ray-ml:1.4.1-py36-gpu", "anyscale/ray-ml:1.4.1-py37", "anyscale/ray-ml:1.4.1-py37-gpu", "anyscale/ray-ml:1.4.1-py38", "anyscale/ray-ml:1.4.1-py38-gpu", "anyscale/ray-ml:1.5.0", "anyscale/ray-ml:1.5.0-gpu", "anyscale/ray-ml:1.5.0-py36", "anyscale/ray-ml:1.5.0-py36-gpu", "anyscale/ray-ml:1.5.0-py37", "anyscale/ray-ml:1.5.0-py37-gpu", "anyscale/ray-ml:1.5.0-py38", "anyscale/ray-ml:1.5.0-py38-gpu", "anyscale/ray-ml:1.5.2", "anyscale/ray-ml:1.5.2-gpu", "anyscale/ray-ml:1.5.2-py36", "anyscale/ray-ml:1.5.2-py36-gpu", "anyscale/ray-ml:1.5.2-py37", "anyscale/ray-ml:1.5.2-py37-gpu", "anyscale/ray-ml:1.5.2-py38", "anyscale/ray-ml:1.5.2-py38-gpu", "anyscale/ray-ml:1.6.0", "anyscale/ray-ml:1.6.0-gpu", "anyscale/ray-ml:1.6.0-py36", "anyscale/ray-ml:1.6.0-py36-gpu", "anyscale/ray-ml:1.6.0-py37", "anyscale/ray-ml:1.6.0-py37-gpu", "anyscale/ray-ml:1.6.0-py38", "anyscale/ray-ml:1.6.0-py38-gpu", "anyscale/ray-ml:1.7.0", "anyscale/ray-ml:1.7.0-gpu", "anyscale/ray-ml:1.7.0-py36", "anyscale/ray-ml:1.7.0-py36-gpu", "anyscale/ray-ml:1.7.0-py37", "anyscale/ray-ml:1.7.0-py37-gpu", "anyscale/ray-ml:1.7.0-py38", "anyscale/ray-ml:1.7.0-py38-gpu", "anyscale/ray-ml:1.7.0rc0", "anyscale/ray-ml:1.7.0rc0-gpu", "anyscale/ray-ml:1.7.0rc0-py36", "anyscale/ray-ml:1.7.0rc0-py36-gpu", "anyscale/ray-ml:1.7.0rc0-py37", "anyscale/ray-ml:1.7.0rc0-py37-gpu", "anyscale/ray-ml:1.7.0rc0-py38", "anyscale/ray-ml:1.7.0rc0-py38-gpu", "anyscale/ray-ml:1.8.0", "anyscale/ray-ml:1.8.0-gpu", "anyscale/ray-ml:1.8.0-py36", "anyscale/ray-ml:1.8.0-py36-gpu", "anyscale/ray-ml:1.8.0-py37", "anyscale/ray-ml:1.8.0-py37-gpu", "anyscale/ray-ml:1.8.0-py38", "anyscale/ray-ml:1.8.0-py38-gpu", "anyscale/ray-ml:1.9.0-py36-gpu", "anyscale/ray-ml:1.9.0-py37-gpu", "anyscale/ray-ml:1.9.0-py38-gpu", "anyscale/ray-ml:1.9.0rc1-py36-gpu", "anyscale/ray-ml:1.9.0rc1-py37-gpu", "anyscale/ray-ml:1.9.0rc1-py38-gpu", "anyscale/ray-ml:1.9.0rc2-py36-gpu", "anyscale/ray-ml:1.9.0rc2-py37-gpu", "anyscale/ray-ml:1.9.0rc2-py38-gpu", "anyscale/ray-ml:1.9.1-py36-gpu", "anyscale/ray-ml:1.9.1-py37-gpu", "anyscale/ray-ml:1.9.1-py38-gpu", "anyscale/ray-ml:1.9.1rc0-py36-gpu", "anyscale/ray-ml:1.9.1rc0-py37-gpu", "anyscale/ray-ml:1.9.1rc0-py38-gpu", "anyscale/ray-ml:1.9.2-py36-gpu", "anyscale/ray-ml:1.9.2-py37-gpu", "anyscale/ray-ml:1.9.2-py38-gpu", "anyscale/ray-ml:nightly-py36-gpu", "anyscale/ray-ml:nightly-py37-gpu", "anyscale/ray-ml:nightly-py38-gpu", "anyscale/ray:1.10.0-py36", "anyscale/ray:1.10.0-py36-cu101", "anyscale/ray:1.10.0-py36-cu102", "anyscale/ray:1.10.0-py36-cu110", "anyscale/ray:1.10.0-py36-cu111", "anyscale/ray:1.10.0-py36-cu112", "anyscale/ray:1.10.0-py37", "anyscale/ray:1.10.0-py37-cu101", "anyscale/ray:1.10.0-py37-cu102", "anyscale/ray:1.10.0-py37-cu110", "anyscale/ray:1.10.0-py37-cu111", "anyscale/ray:1.10.0-py37-cu112", "anyscale/ray:1.10.0-py38", "anyscale/ray:1.10.0-py38-cu101", "anyscale/ray:1.10.0-py38-cu102", "anyscale/ray:1.10.0-py38-cu110", "anyscale/ray:1.10.0-py38-cu111", "anyscale/ray:1.10.0-py38-cu112", "anyscale/ray:1.10.0rc0-py36", "anyscale/ray:1.10.0rc0-py36-cu101", "anyscale/ray:1.10.0rc0-py36-cu102", "anyscale/ray:1.10.0rc0-py36-cu110", "anyscale/ray:1.10.0rc0-py36-cu111", "anyscale/ray:1.10.0rc0-py36-cu112", "anyscale/ray:1.10.0rc0-py37", "anyscale/ray:1.10.0rc0-py37-cu101", "anyscale/ray:1.10.0rc0-py37-cu102", "anyscale/ray:1.10.0rc0-py37-cu110", "anyscale/ray:1.10.0rc0-py37-cu111", "anyscale/ray:1.10.0rc0-py37-cu112", "anyscale/ray:1.10.0rc0-py38", "anyscale/ray:1.10.0rc0-py38-cu101", "anyscale/ray:1.10.0rc0-py38-cu102", "anyscale/ray:1.10.0rc0-py38-cu110", "anyscale/ray:1.10.0rc0-py38-cu111", "anyscale/ray:1.10.0rc0-py38-cu112", "anyscale/ray:1.2.0", "anyscale/ray:1.2.0-gpu", "anyscale/ray:1.3.0", "anyscale/ray:1.3.0-gpu", "anyscale/ray:1.3.0-py36", "anyscale/ray:1.3.0-py36-gpu", "anyscale/ray:1.3.0-py37", "anyscale/ray:1.3.0-py37-gpu", "anyscale/ray:1.3.0-py38", "anyscale/ray:1.3.0-py38-gpu", "anyscale/ray:1.4-rc0", "anyscale/ray:1.4-rc0-gpu", "anyscale/ray:1.4-rc0-py36", "anyscale/ray:1.4-rc0-py36-gpu", "anyscale/ray:1.4-rc0-py37", "anyscale/ray:1.4-rc0-py37-gpu", "anyscale/ray:1.4-rc0-py38", "anyscale/ray:1.4-rc0-py38-gpu", "anyscale/ray:1.4-rc1", "anyscale/ray:1.4-rc1-gpu", "anyscale/ray:1.4-rc1-py36", "anyscale/ray:1.4-rc1-py36-gpu", "anyscale/ray:1.4-rc1-py37", "anyscale/ray:1.4-rc1-py37-gpu", "anyscale/ray:1.4-rc1-py38", "anyscale/ray:1.4-rc1-py38-gpu", "anyscale/ray:1.4-rc2", "anyscale/ray:1.4-rc2-gpu", "anyscale/ray:1.4-rc2-py36", "anyscale/ray:1.4-rc2-py36-gpu", "anyscale/ray:1.4-rc2-py37", "anyscale/ray:1.4-rc2-py37-gpu", "anyscale/ray:1.4-rc2-py38", "anyscale/ray:1.4-rc2-py38-gpu", "anyscale/ray:1.4.0", "anyscale/ray:1.4.0-gpu", "anyscale/ray:1.4.0-py36", "anyscale/ray:1.4.0-py36-gpu", "anyscale/ray:1.4.0-py37", "anyscale/ray:1.4.0-py37-gpu", "anyscale/ray:1.4.0-py38", "anyscale/ray:1.4.0-py38-gpu", "anyscale/ray:1.4.1", "anyscale/ray:1.4.1-gpu", "anyscale/ray:1.4.1-py36", "anyscale/ray:1.4.1-py36-gpu", "anyscale/ray:1.4.1-py37", "anyscale/ray:1.4.1-py37-gpu", "anyscale/ray:1.4.1-py38", "anyscale/ray:1.4.1-py38-gpu", "anyscale/ray:1.5.0", "anyscale/ray:1.5.0-gpu", "anyscale/ray:1.5.0-py36", "anyscale/ray:1.5.0-py36-gpu", "anyscale/ray:1.5.0-py37", "anyscale/ray:1.5.0-py37-gpu", "anyscale/ray:1.5.0-py38", "anyscale/ray:1.5.0-py38-gpu", "anyscale/ray:1.5.2", "anyscale/ray:1.5.2-gpu", "anyscale/ray:1.5.2-py36", "anyscale/ray:1.5.2-py36-gpu", "anyscale/ray:1.5.2-py37", "anyscale/ray:1.5.2-py37-gpu", "anyscale/ray:1.5.2-py38", "anyscale/ray:1.5.2-py38-gpu", "anyscale/ray:1.6.0", "anyscale/ray:1.6.0-gpu", "anyscale/ray:1.6.0-py36", "anyscale/ray:1.6.0-py36-gpu", "anyscale/ray:1.6.0-py37", "anyscale/ray:1.6.0-py37-gpu", "anyscale/ray:1.6.0-py38", "anyscale/ray:1.6.0-py38-gpu", "anyscale/ray:1.7.0", "anyscale/ray:1.7.0-gpu", "anyscale/ray:1.7.0-py36", "anyscale/ray:1.7.0-py36-gpu", "anyscale/ray:1.7.0-py37", "anyscale/ray:1.7.0-py37-gpu", "anyscale/ray:1.7.0-py38", "anyscale/ray:1.7.0-py38-gpu", "anyscale/ray:1.7.0rc0", "anyscale/ray:1.7.0rc0-gpu", "anyscale/ray:1.7.0rc0-py36", "anyscale/ray:1.7.0rc0-py36-gpu", "anyscale/ray:1.7.0rc0-py37", "anyscale/ray:1.7.0rc0-py37-gpu", "anyscale/ray:1.7.0rc0-py38", "anyscale/ray:1.7.0rc0-py38-gpu", "anyscale/ray:1.8.0", "anyscale/ray:1.8.0-gpu", "anyscale/ray:1.8.0-py36", "anyscale/ray:1.8.0-py36-gpu", "anyscale/ray:1.8.0-py37", "anyscale/ray:1.8.0-py37-gpu", "anyscale/ray:1.8.0-py38", "anyscale/ray:1.8.0-py38-gpu", "anyscale/ray:1.9.0-py36", "anyscale/ray:1.9.0-py36-cu101", "anyscale/ray:1.9.0-py36-cu102", "anyscale/ray:1.9.0-py36-cu110", "anyscale/ray:1.9.0-py36-cu111", "anyscale/ray:1.9.0-py36-cu112", "anyscale/ray:1.9.0-py37", "anyscale/ray:1.9.0-py37-cu101", "anyscale/ray:1.9.0-py37-cu102", "anyscale/ray:1.9.0-py37-cu110", "anyscale/ray:1.9.0-py37-cu111", "anyscale/ray:1.9.0-py37-cu112", "anyscale/ray:1.9.0-py38", "anyscale/ray:1.9.0-py38-cu101", "anyscale/ray:1.9.0-py38-cu102", "anyscale/ray:1.9.0-py38-cu110", "anyscale/ray:1.9.0-py38-cu111", "anyscale/ray:1.9.0-py38-cu112", "anyscale/ray:1.9.0rc1-py36", "anyscale/ray:1.9.0rc1-py36-cu101", "anyscale/ray:1.9.0rc1-py36-cu102", "anyscale/ray:1.9.0rc1-py36-cu110", "anyscale/ray:1.9.0rc1-py36-cu111", "anyscale/ray:1.9.0rc1-py36-cu112", "anyscale/ray:1.9.0rc1-py37", "anyscale/ray:1.9.0rc1-py37-cu101", "anyscale/ray:1.9.0rc1-py37-cu102", "anyscale/ray:1.9.0rc1-py37-cu110", "anyscale/ray:1.9.0rc1-py37-cu111", "anyscale/ray:1.9.0rc1-py37-cu112", "anyscale/ray:1.9.0rc1-py38", "anyscale/ray:1.9.0rc1-py38-cu101", "anyscale/ray:1.9.0rc1-py38-cu102", "anyscale/ray:1.9.0rc1-py38-cu110", "anyscale/ray:1.9.0rc1-py38-cu111", "anyscale/ray:1.9.0rc1-py38-cu112", "anyscale/ray:1.9.0rc2-py36", "anyscale/ray:1.9.0rc2-py36-cu101", "anyscale/ray:1.9.0rc2-py36-cu102", "anyscale/ray:1.9.0rc2-py36-cu110", "anyscale/ray:1.9.0rc2-py36-cu111", "anyscale/ray:1.9.0rc2-py36-cu112", "anyscale/ray:1.9.0rc2-py37", "anyscale/ray:1.9.0rc2-py37-cu101", "anyscale/ray:1.9.0rc2-py37-cu102", "anyscale/ray:1.9.0rc2-py37-cu110", "anyscale/ray:1.9.0rc2-py37-cu111", "anyscale/ray:1.9.0rc2-py37-cu112", "anyscale/ray:1.9.0rc2-py38", "anyscale/ray:1.9.0rc2-py38-cu101", "anyscale/ray:1.9.0rc2-py38-cu102", "anyscale/ray:1.9.0rc2-py38-cu110", "anyscale/ray:1.9.0rc2-py38-cu111", "anyscale/ray:1.9.0rc2-py38-cu112", "anyscale/ray:1.9.1-py36", "anyscale/ray:1.9.1-py36-cu101", "anyscale/ray:1.9.1-py36-cu102", "anyscale/ray:1.9.1-py36-cu110", "anyscale/ray:1.9.1-py36-cu111", "anyscale/ray:1.9.1-py36-cu112", "anyscale/ray:1.9.1-py37", "anyscale/ray:1.9.1-py37-cu101", "anyscale/ray:1.9.1-py37-cu102", "anyscale/ray:1.9.1-py37-cu110", "anyscale/ray:1.9.1-py37-cu111", "anyscale/ray:1.9.1-py37-cu112", "anyscale/ray:1.9.1-py38", "anyscale/ray:1.9.1-py38-cu101", "anyscale/ray:1.9.1-py38-cu102", "anyscale/ray:1.9.1-py38-cu110", "anyscale/ray:1.9.1-py38-cu111", "anyscale/ray:1.9.1-py38-cu112", "anyscale/ray:1.9.1rc0-py36", "anyscale/ray:1.9.1rc0-py36-cu101", "anyscale/ray:1.9.1rc0-py36-cu102", "anyscale/ray:1.9.1rc0-py36-cu110", "anyscale/ray:1.9.1rc0-py36-cu111", "anyscale/ray:1.9.1rc0-py36-cu112", "anyscale/ray:1.9.1rc0-py37", "anyscale/ray:1.9.1rc0-py37-cu101", "anyscale/ray:1.9.1rc0-py37-cu102", "anyscale/ray:1.9.1rc0-py37-cu110", "anyscale/ray:1.9.1rc0-py37-cu111", "anyscale/ray:1.9.1rc0-py37-cu112", "anyscale/ray:1.9.1rc0-py38", "anyscale/ray:1.9.1rc0-py38-cu101", "anyscale/ray:1.9.1rc0-py38-cu102", "anyscale/ray:1.9.1rc0-py38-cu110", "anyscale/ray:1.9.1rc0-py38-cu111", "anyscale/ray:1.9.1rc0-py38-cu112", "anyscale/ray:1.9.2-py36", "anyscale/ray:1.9.2-py36-cu101", "anyscale/ray:1.9.2-py36-cu102", "anyscale/ray:1.9.2-py36-cu110", "anyscale/ray:1.9.2-py36-cu111", "anyscale/ray:1.9.2-py36-cu112", "anyscale/ray:1.9.2-py37", "anyscale/ray:1.9.2-py37-cu101", "anyscale/ray:1.9.2-py37-cu102", "anyscale/ray:1.9.2-py37-cu110", "anyscale/ray:1.9.2-py37-cu111", "anyscale/ray:1.9.2-py37-cu112", "anyscale/ray:1.9.2-py38", "anyscale/ray:1.9.2-py38-cu101", "anyscale/ray:1.9.2-py38-cu102", "anyscale/ray:1.9.2-py38-cu110", "anyscale/ray:1.9.2-py38-cu111", "anyscale/ray:1.9.2-py38-cu112", "anyscale/ray:nightly-py36", "anyscale/ray:nightly-py36-cu101", "anyscale/ray:nightly-py36-cu102", "anyscale/ray:nightly-py36-cu110", "anyscale/ray:nightly-py36-cu111", "anyscale/ray:nightly-py36-cu112", "anyscale/ray:nightly-py37", "anyscale/ray:nightly-py37-cu101", "anyscale/ray:nightly-py37-cu102", "anyscale/ray:nightly-py37-cu110", "anyscale/ray:nightly-py37-cu111", "anyscale/ray:nightly-py37-cu112", "anyscale/ray:nightly-py38", "anyscale/ray:nightly-py38-cu101", "anyscale/ray:nightly-py38-cu102", "anyscale/ray:nightly-py38-cu110", "anyscale/ray:nightly-py38-cu111", "anyscale/ray:nightly-py38-cu112"], "description": "An enumeration."}, "ServiceAccount": {"title": "ServiceAccount", "required": ["email"], "type": "object", "properties": {"email": {"type": "string"}, "scopes": {"type": "array", "items": {"type": "string"}, "description": "Scopes for the ServiceAccount to run with, leave empty to use the existing scopes of the underlying machine."}}, "additionalProperties": false}, "Session": {"title": "Session", "required": ["name", "project_id", "cloud_id", "cluster_config", "id", "state", "creator_id", "created_at", "access_token", "tensorboard_available", "cluster_config_last_modified_at", "ssh_authorized_keys", "ssh_private_key"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the session to be created."}, "project_id": {"title": "Project Id", "type": "string", "description": "Project that the session will be created in."}, "cloud_id": {"title": "Cloud Id", "type": "string", "description": "Cloud that the session will use."}, "cluster_config": {"title": "Cluster Config", "type": "string", "description": "Cluster config that the session can later be started with."}, "build_id": {"title": "Build Id", "type": "string", "description": "ID of the Build that this session was started with."}, "compute_template_id": {"title": "Compute Template Id", "type": "string", "description": "ID of the compute template that this session was started with."}, "idle_timeout": {"title": "Idle Timeout", "type": "integer", "description": "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'.", "default": 120}, "uses_app_config": {"title": "Uses App Config", "type": "boolean", "description": "Whether or not the session uses app config. If true, it means this is not a legacy session started with cluster yaml.", "default": false}, "allow_public_internet_traffic": {"title": "Allow Public Internet Traffic", "type": "boolean", "description": "Whether public internet traffic can access Serve endpoints or if an authentication token is required.", "default": false}, "id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "state": {"allOf": [{"$ref": "#/components/schemas/SessionState"}], "description": "Current state of the Session."}, "pending_state": {"allOf": [{"$ref": "#/components/schemas/SessionState"}], "description": "Pending state of the Session if a state transition has been requested."}, "state_data": {"title": "State Data", "allOf": [{"$ref": "#/components/schemas/SessionStateData"}], "description": "Additional information about the current state"}, "creator_id": {"title": "Creator Id", "type": "string", "description": "Identifier of user who created the Session."}, "created_at": {"title": "Created At", "type": "string", "description": "Time at which session was created.", "format": "date-time"}, "webterminal_auth_url": {"title": "Webterminal Auth Url", "type": "string", "description": "URL to authenticate with the webterminalThis field will only be populated after the Session finishes starting."}, "metrics_dashboard_url": {"title": "Metrics Dashboard Url", "type": "string", "description": "URL for Grafana (metrics) dashboard for this Session. This field will only be populated after the Session finishes starting."}, "connect_url": {"title": "Connect Url", "type": "string", "description": "URL for Anyscale connect for this Session. This field will only be populated after the Session finishes starting."}, "jupyter_notebook_url": {"title": "Jupyter Notebook Url", "type": "string", "description": "URL for Jupyter Lab for this Session. This field will only be populated after the Session finishes starting."}, "ray_dashboard_url": {"title": "Ray Dashboard Url", "type": "string", "description": "URL for Ray dashboard for this Session. This field will only be populated after the Session finishes starting."}, "access_token": {"title": "Access Token", "type": "string", "description": "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."}, "service_proxy_url": {"title": "Service Proxy Url", "type": "string", "description": "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."}, "tensorboard_available": {"title": "Tensorboard Available", "type": "boolean", "description": "Represents whether Tensorboard is available."}, "cluster_config_last_modified_at": {"title": "Cluster Config Last Modified At", "type": "string", "description": "Time when the cluster config for the Session was last modified.", "format": "date-time"}, "host_name": {"title": "Host Name", "type": "string", "description": "URL for the head node of the cluster. This field will be populated after the cluster finishes starting."}, "head_node_ip": {"title": "Head Node Ip", "type": "string", "description": "Head IP of the Session. This field will be populated after the cluster finishes starting."}, "ssh_authorized_keys": {"title": "Ssh Authorized Keys", "type": "array", "items": {"type": "string"}, "description": "Serialized SSH Public Keys to be placed in the machine's authorized_keys."}, "ssh_private_key": {"title": "Ssh Private Key", "type": "string", "description": "SSH Private key that can be used to access the session's servers."}, "anyscaled_config": {"title": "Anyscaled Config", "type": "string", "description": "Serialized AnyscaleD config that is general to head and worker nodes."}, "anyscaled_config_generated_at": {"title": "Anyscaled Config Generated At", "type": "string", "description": "Time when AnyscaleD config was generated at.", "format": "date-time"}, "default_build_id": {"title": "Default Build Id", "type": "string", "description": "Default build id used for the session. Only not null when using default builds."}, "idle_timeout_last_activity_at": {"title": "Idle Timeout Last Activity At", "type": "string", "description": "The time when this session started idling. If idle_timeout is enabled and this value is None, then this session is still active.", "format": "date-time"}, "ray_version": {"title": "Ray Version", "type": "string", "description": "The last known ray version running on this cluster."}, "ray_version_last_updated_at": {"title": "Ray Version Last Updated At", "type": "string", "description": "The time in which the ray version of this was updated.", "format": "date-time"}}, "description": "Model used to read a Session."}, "SessionCommand": {"title": "SessionCommand", "required": ["session_id", "shell_command", "id", "created_at"], "type": "object", "properties": {"session_id": {"title": "Session Id", "type": "string", "description": "ID of the Session to execute this command on."}, "shell_command": {"title": "Shell Command", "type": "string", "description": "Shell command string that will be executed."}, "id": {"title": "Id", "type": "string", "description": "Server assigned unique identifier."}, "type": {"allOf": [{"$ref": "#/components/schemas/SessionCommandTypes"}], "description": "Where this command was executed", "default": "COMMAND_LINE_RUNNER"}, "created_at": {"title": "Created At", "type": "string", "description": "Timestamp of when this command was created.", "format": "date-time"}, "finished_at": {"title": "Finished At", "type": "string", "description": "\n        Timestamp of when this command completed its execution.\n        This value will be absent if the command is still running.\n        ", "format": "date-time"}, "status_code": {"title": "Status Code", "type": "integer", "description": "\n        Exit status of this command.\n        This value will be absent if the command is still running.\n        "}, "killed_at": {"title": "Killed At", "type": "string", "description": "\n        Timestamp of when this command was killed.\n        This value will be absent if the command is still running or completed its execution normally.\n        ", "format": "date-time"}, "web_terminal_tab_id": {"title": "Web Terminal Tab Id", "type": "string", "description": "\n        The id for the web terminal tab in which this\n        command was executed.\n        "}}, "description": "Model used to create and execute a command on a Session."}, "SessionCommandTypes": {"title": "SessionCommandTypes", "enum": ["WEBTERMINAL", "COMMAND_LINE_RUNNER"], "type": "string", "description": "An enumeration."}, "SessionEvent": {"title": "SessionEvent", "required": ["event_type", "log_level", "timestamp", "description", "id"], "type": "object", "properties": {"event_type": {"title": "Event Type", "type": "string", "description": "The category of session event."}, "log_level": {"allOf": [{"$ref": "#/components/schemas/LogLevelTypes"}], "description": "The severity of the session event."}, "timestamp": {"title": "Timestamp", "type": "string", "description": "The time at which the session event occurred.", "format": "date-time"}, "description": {"title": "Description", "type": "string", "description": "A human readable description of the session event."}, "cause": {"title": "Cause", "allOf": [{"$ref": "#/components/schemas/SessionEventCause"}], "description": "The reason why the session event occurred. None indicates an unknown cause."}, "id": {"title": "Id", "type": "string", "description": "A unique identifier for the session event."}}, "description": "Model of a session event item from the session event log."}, "SessionEventCause": {"title": "SessionEventCause", "type": "object", "properties": {"cause_user": {"title": "Cause User", "type": "string", "description": "The username of the user who caused the session event."}, "cause_system": {"title": "Cause System", "type": "string", "description": "The name of the internal anyscale system that caused the session event."}}, "description": "Model of a session event cause. Exactly one of cause_user or\ncause_system is non-None."}, "SessionEventTypes": {"title": "SessionEventTypes", "enum": ["edited", "terminate_command", "start_command", "running", "terminated", "awaiting_file_mounts", "starting", "updating", "terminating", "created", "terminating_errored", "updating_errored", "startup_errored"], "type": "string", "description": "The type of session event.\n    "}, "SessionListResponse": {"title": "SessionListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Session"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "SessionOperation": {"title": "SessionOperation", "required": ["id", "completed", "session_id", "session_operation_type"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "description": "ID of this operation."}, "completed": {"title": "Completed", "type": "boolean", "description": "Boolean indicating if this operation is completed."}, "progress": {"title": "Progress", "allOf": [{"$ref": "#/components/schemas/OperationProgress"}], "description": "Details about the progress of this operation at the time of the request.             This will be absent for completed operations."}, "result": {"title": "Result", "allOf": [{"$ref": "#/components/schemas/OperationResult"}], "description": "The result of this operation after it has completed.             This is always provided when the operation is complete."}, "session_id": {"title": "Session Id", "type": "string", "description": "ID of the Session that is being updated."}, "session_operation_type": {"allOf": [{"$ref": "#/components/schemas/SessionOperationType"}], "description": "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"}}, "description": "Describes a long running session operation that will eventually complete."}, "SessionOperationType": {"title": "SessionOperationType", "enum": ["start", "stop", "terminate"], "type": "string", "description": "The type of session operation.\n    "}, "SessionResponse": {"title": "SessionResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/Session"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "SessionStartingUpData": {"title": "SessionStartingUpData", "type": "object", "properties": {"startup_progress": {"type": "string"}, "startup_error": {"type": "string"}}, "additionalProperties": false}, "SessionState": {"title": "SessionState", "enum": ["Stopped", "Terminated", "StartingUp", "StartupErrored", "Running", "Updating", "UpdatingErrored", "Stopping", "Terminating", "AwaitingStartup", "AwaitingFileMounts", "TerminatingErrored", "StoppingErrored"], "type": "string", "description": "An enumeration."}, "SessionStateData": {"title": "SessionStateData", "type": "object", "properties": {"startup": {"$ref": "#/components/schemas/SessionStartingUpData"}, "stopping": {"$ref": "#/components/schemas/SessionStoppingData"}}, "description": "A way to support unions that gets around the code generator's lack of support for\nreal unions."}, "SessionStoppingData": {"title": "SessionStoppingData", "type": "object", "properties": {"stop_progress": {"type": "string"}, "stop_error": {"type": "string"}}, "additionalProperties": false}, "SessioncommandListResponse": {"title": "SessioncommandListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/SessionCommand"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "SessioncommandResponse": {"title": "SessioncommandResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/SessionCommand"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "SessioneventListResponse": {"title": "SessioneventListResponse", "required": ["results"], "type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/SessionEvent"}}, "metadata": {"allOf": [{"$ref": "#/components/schemas/ListResponseMetadata"}], "default": {}}}, "additionalProperties": false, "description": "A list response form the API. Contains a field \"results\" which has the contents of the response."}, "SessionoperationResponse": {"title": "SessionoperationResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/SessionOperation"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "SessionsQuery": {"title": "SessionsQuery", "type": "object", "properties": {"name": {"title": "Name", "allOf": [{"$ref": "#/components/schemas/TextQuery"}], "description": "Filters Cluster by name. If this field is absent, no filtering is done."}, "paging": {"title": "Paging", "allOf": [{"$ref": "#/components/schemas/PageQuery"}], "description": "Pagination information.", "default": {"count": 10}}, "state_filter": {"uniqueItems": true, "type": "array", "items": {"$ref": "#/components/schemas/SessionState"}, "description": "Filter Cluster by Session State. If this field is an empty set, no filtering is done.", "default": []}, "creator_id": {"title": "Creator Id", "type": "string", "description": "Filters Jobs by creator_id. If this field is absent, no filtering is done."}}, "description": "Query model used to filter Cluster."}, "SsoconfigResponse": {"title": "SsoconfigResponse", "required": ["result"], "type": "object", "properties": {"result": {"$ref": "#/components/schemas/SSOConfig"}}, "additionalProperties": false, "description": "A response from the API. Contains a field \"result\" which has the contents of the response."}, "StartClusterOptions": {"title": "StartClusterOptions", "type": "object", "properties": {"cluster_environment_build_id": {"title": "Cluster Environment Build Id", "type": "string", "description": "Cluster Environment Build used to start Cluster."}, "cluster_compute_id": {"title": "Cluster Compute Id", "type": "string", "description": "Cluster Compute used to start the Cluster."}, "allow_public_internet_traffic": {"title": "Allow Public Internet Traffic", "type": "boolean", "description": "Whether public internet traffic can access Serve endpoints or if an authentication token is required. Will not update current value if not provided."}}, "description": "Options to set when starting a Cluster."}, "StartSessionOptions": {"title": "StartSessionOptions", "type": "object", "properties": {"cluster_config": {"title": "Cluster Config", "type": "string", "description": "New cluster config to apply to the Session."}, "build_id": {"title": "Build Id", "type": "string", "description": "Build ID to start the session with."}, "compute_template_id": {"title": "Compute Template Id", "type": "string", "description": "Compute template ID to start the session with."}, "allow_public_internet_traffic": {"title": "Allow Public Internet Traffic", "type": "boolean", "description": "Whether public internet traffic can access Serve endpoints or if an authentication token is required. Will not update current value if not provided."}}, "description": "Options to set when starting a session."}, "StaticSSOConfig": {"title": "StaticSSOConfig", "required": ["idp_entity_id", "idp_sso_url", "idp_sso_binding", "idp_x509cert"], "type": "object", "properties": {"idp_entity_id": {"title": "Idp Entity Id", "type": "string", "description": "Static configuration for the SAML 2.0 identity provider's entity id."}, "idp_sso_url": {"title": "Idp Sso Url", "type": "string", "description": "Static configuration for the SAML 2.0 identity provider's url."}, "idp_sso_binding": {"title": "Idp Sso Binding", "type": "string", "description": "Static configuration for the SAML 2.0 identity provider's sso binding."}, "idp_x509cert": {"title": "Idp X509Cert", "type": "string", "description": "Static configuration for the SAML 2.0 identity provider's x509cert"}}}, "TerminateClusterOptions": {"title": "TerminateClusterOptions", "type": "object", "properties": {"take_snapshot": {"title": "Take Snapshot", "type": "boolean", "description": "Takes a snapshot to preserve the state of the Cluster before terminating. The state will be restored the next time the Cluster is started.", "default": true}}, "description": "Options to set when terminating a Cluster."}, "TerminateSessionOptions": {"title": "TerminateSessionOptions", "type": "object", "properties": {"workers_only": {"title": "Workers Only", "type": "boolean", "description": "Only destroy the workers when terminating.", "default": false}, "keep_min_workers": {"title": "Keep Min Workers", "type": "boolean", "description": "Retain the minimal amount of workers specified in the config when terminating.", "default": false}, "delete": {"title": "Delete", "type": "boolean", "description": "Delete the session after terminating.", "default": false}, "take_snapshot": {"title": "Take Snapshot", "type": "boolean", "description": "Takes a snapshot to preserve the state of the session before terminating. The state will be restored the next time the session is started.", "default": true}}, "description": "Optional values to set when terminating a Session."}, "TextQuery": {"title": "TextQuery", "type": "object", "properties": {"equals": {"title": "Equals", "type": "string", "description": "Property is an exact match of this value."}, "not_equal": {"title": "Not Equal", "type": "string", "description": "Property does not match of this value."}, "contains": {"title": "Contains", "type": "string", "description": "Property contains this value as a substring. The value should not have opening and closing wildcard characters."}}, "description": "Query model to filter results based on Text properties (e.g. name, description).\n\nExactly one field should be populated."}, "UpdateAppConfig": {"title": "UpdateAppConfig", "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the App Config."}}, "description": "Updateable fields for an App Config\n\nThe field will not be updated if its value is absent."}, "UpdateCloud": {"title": "UpdateCloud", "type": "object", "properties": {"config": {"title": "Config", "allOf": [{"$ref": "#/components/schemas/CloudConfig"}], "description": "Additional configurable properties of this Cloud."}}, "description": "Updateable fields for a Cloud. If a field is absent, it will not be updated."}, "UpdateCluster": {"title": "UpdateCluster", "type": "object", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of this Cluster."}, "idle_timeout_minutes": {"title": "Idle Timeout Minutes", "type": "integer", "description": "Idle timeout in minutes."}, "cluster_environment_build_id": {"title": "Cluster Environment Build Id", "type": "string", "description": "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."}, "cluster_compute_id": {"title": "Cluster Compute Id", "type": "string", "description": "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."}}, "description": "Model used to update a Cluster.\nA field will not be updated if its value is absent."}, "UpdateComputeTemplate": {"title": "UpdateComputeTemplate", "type": "object", "properties": {"name": {"type": "string"}, "config": {"$ref": "#/components/schemas/ComputeTemplateConfig"}}, "additionalProperties": false}, "UpdateOrganization": {"title": "UpdateOrganization", "required": ["sso_mode"], "type": "object", "properties": {"sso_mode": {"allOf": [{"$ref": "#/components/schemas/SSOMode"}], "description": "Mode for use of single sign on (SSO) for your organization.WARNING: It is dangerous to require SSO if you are not confident it is correctly configured. Once SSO is required, 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."}}, "description": "Fields to update in the organization.\n    "}, "UpdateProject": {"title": "UpdateProject", "type": "object", "properties": {"cluster_config": {"title": "Cluster Config", "type": "string", "description": "New cluster config to apply to the Project on update action."}, "description": {"title": "Description", "type": "string", "description": "New description to update in the Project."}}, "description": "Model for updating a Project. A field will not be updated if its value is absent."}, "UpdateSession": {"title": "UpdateSession", "type": "object", "properties": {"cluster_config": {"title": "Cluster Config", "type": "string", "description": "New cluster config to apply to the Session on update action."}, "idle_timeout": {"title": "Idle Timeout", "type": "integer", "description": "Idle timeout (in minutes)"}}, "description": "Model for updating a Session. A field will not be updated if its value is absent."}, "ValidationError": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}, "WorkerNodeType": {"title": "WorkerNodeType", "required": ["name", "instance_type"], "type": "object", "properties": {"name": {"type": "string", "description": "An arbitrary name for this node type, which will be registered with OSS available_node_types. "}, "instance_type": {"type": "string", "description": "The cloud provider instance type to use for this node."}, "resources": {"allOf": [{"$ref": "#/components/schemas/Resources"}], "description": "Declaration of node resources for Autoscaler."}, "min_workers": {"type": "integer", "description": "The minimum number of nodes of this type that Anyscale should spin up."}, "max_workers": {"type": "integer", "description": "The maximum number of nodes of this type that Anyscale should spin up."}, "use_spot": {"type": "boolean", "description": "Whether or not to use spot instances for this node type.", "default": false}}, "additionalProperties": false}}}}