Studios

class Studios(session_kwargs, client, return_type='raw')

Civis API /studios endpoint:

import civis
client = civis.APIClient()
# Call client.studios.<method>(<arguments>) to make a request, e.g.:
client.studios.post(...)

Methods

`delete_deployments`(studio_id, deployment_id)	Delete a Studio deployment
`get`(id)	Get a Studio
`get_deployments`(studio_id, deployment_id)	Get details about a Studio deployment
`list_deployments`(studio_id, *[, ...])	List deployments for a Studio
`list_deployments_logs`(id, deployment_id, *)	Get the logs for a Studio deployment
`patch`(id, *[, name, docker_image_name, ...])	Update some attributes of this Studio
`post`(*[, name, docker_image_name, ...])	Create a Studio
`post_deployments`(studio_id, *[, deployment_id])	Deploy a Studio
`put`(id, *[, name, docker_image_name, ...])	Replace all attributes of this Studio
`put_archive`(id, status)	Update the archive status of this object

delete_deployments(studio_id: int, deployment_id: int) → Response

Delete a Studio deployment

API URL: DELETE /studios/{studio_id}/deployments/{deployment_id}

Parameters:

studio_idint: The ID of the owning Studio
deployment_idint: The ID for this deployment

Returns:

None: Response code 204: success

get(id: int) → Response

Get a Studio

API URL: GET /studios/{id}

Parameters:

idint

Returns:

civis.Response

idint
The ID of the studio.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of the studio.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
instance_typestr
The EC2 instance type to deploy to.
required_resourcescivis.Response
- memoryint
  The amount of memory allocated to the studio.
- disk_spacefloat (float)
  The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
- cpuint
  The amount of cpu allocated to the studio.
created_at : str (time)
updated_at : str (time)
most_recent_deploymentcivis.Response
- deployment_idint
  The ID for this deployment.
- user_idint
  The ID of the owner.
- hoststr
  Domain of the deployment.
- namestr
  Name of the deployment.
- docker_image_namestr
  The name of the docker image to pull from DockerHub.
- docker_image_tagstr
  The tag of the docker image to pull from DockerHub (default: latest).
- display_urlstr
  A signed URL for viewing the deployed item.
- instance_typestr
  The EC2 instance type requested for the deployment.
- memoryint
  The memory allocated to the deployment, in MB.
- cpuint
  The cpu allocated to the deployment, in millicores.
- statestr
  The state of the deployment.
- state_messagestr
  A detailed description of the state.
- max_memory_usagefloat (float)
  If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
- max_cpu_usagefloat (float)
  If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
- created_at : str (time)
- updated_at : str (time)
- studio_idint
  The ID of the owning Studio
git_credential_idint
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.
paramsList[civis.Response]
A definition of the parameters to use as environment variables in this studio.
- namestr
  The variable’s name as used within your code.
- descriptionstr
  A short sentence or fragment describing this parameter.
- typestr
  The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
- valueobject
  The value you would like to set this param to.
git_repo_idint
The ID of the git repository.
git_repo_urlstr
The URL of the git repository (e.g., https://github.com/organization/repo_name.git).
git_refstr
The git reference if git repo is specified
partition_labelstr
The partition label used to run this object.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).

get_deployments(studio_id: int, deployment_id: int) → Response

Get details about a Studio deployment

API URL: GET /studios/{studio_id}/deployments/{deployment_id}

Parameters:

studio_idint: The ID of the owning Studio
deployment_idint: The ID for this deployment

Returns:

civis.Response

deployment_idint
The ID for this deployment.
user_idint
The ID of the owner.
hoststr
Domain of the deployment.
namestr
Name of the deployment.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
display_urlstr
A signed URL for viewing the deployed item.
instance_typestr
The EC2 instance type requested for the deployment.
memoryint
The memory allocated to the deployment, in MB.
cpuint
The cpu allocated to the deployment, in millicores.
statestr
The state of the deployment.
state_messagestr
A detailed description of the state.
max_memory_usagefloat (float)
If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
max_cpu_usagefloat (float)
If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
created_at : str (time)
updated_at : str (time)
studio_idint
The ID of the owning Studio

list_deployments(studio_id: int, *, deployment_id: int = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List deployments for a Studio

API URL: GET /studios/{studio_id}/deployments

Parameters:

studio_idint: The ID of the owning Studio
deployment_idint, optional: The ID for this deployment
limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 50.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to created_at. Must be one of: created_at.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.ListResponse | civis.PaginatedResponse

deployment_idint
The ID for this deployment.
user_idint
The ID of the owner.
hoststr
Domain of the deployment.
namestr
Name of the deployment.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
instance_typestr
The EC2 instance type requested for the deployment.
memoryint
The memory allocated to the deployment, in MB.
cpuint
The cpu allocated to the deployment, in millicores.
statestr
The state of the deployment.
state_messagestr
A detailed description of the state.
max_memory_usagefloat (float)
If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
max_cpu_usagefloat (float)
If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
created_at : str (time)
updated_at : str (time)
studio_idint
The ID of the owning Studio

list_deployments_logs(id: int, deployment_id: int, *, start_at: str = None, end_at: str = None, limit: int = None) → ListResponse

Get the logs for a Studio deployment

API URL: GET /studios/{id}/deployments/{deployment_id}/logs

Parameters:

idint: The ID of the owning Studio.
deployment_idint: The ID for this deployment.
start_atstr, optional: Log entries with a lower timestamp will be omitted.
end_atstr, optional: Log entries with a higher timestamp will be omitted.
limitint, optional: The maximum number of log messages to return. Default of 10000.

Returns:

civis.ListResponse

messagestr
The log message.
streamstr
The stream of the log. One of “stdout”, “stderr”.
created_atstr (date-time)
The time the log was created.
sourcestr
The source of the log. One of “system”, “user”.

patch(id: int, *, name: str = None, docker_image_name: str = None, docker_image_tag: str = None, instance_type: str = None, required_resources: dict = None, git_credential_id: int = None, params: List[dict] = None, git_repo_url: str = None, git_ref: str = None, partition_label: str = None) → Response

Update some attributes of this Studio

API URL: PATCH /studios/{id}

Parameters:

idint

The ID of the studio.

namestr, optional

The name of the studio.

docker_image_namestr, optional

The name of the docker image to pull from DockerHub.

docker_image_tagstr, optional

The tag of the docker image to pull from DockerHub (default: latest).

instance_typestr, optional

The EC2 instance type to deploy to.

required_resourcesdict, optional

memoryint
The amount of memory allocated to the studio.
disk_spacefloat (float)
The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
cpuint
The amount of cpu allocated to the studio.

git_credential_idint, optional

The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.

paramsList[dict], optional

A definition of the parameters to use as environment variables in this studio.

namestr
The variable’s name as used within your code.
descriptionstr
A short sentence or fragment describing this parameter.
typestr
The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
valueobject
The value you would like to set this param to.

git_repo_urlstr, optional

The URL of the git repository (e.g., https://github.com/organization/repo_name.git).

git_refstr, optional

The git reference if git repo is specified

partition_labelstr, optional

The partition label used to run this object.

Returns:

civis.Response

idint
The ID of the studio.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of the studio.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
instance_typestr
The EC2 instance type to deploy to.
required_resourcescivis.Response
- memoryint
  The amount of memory allocated to the studio.
- disk_spacefloat (float)
  The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
- cpuint
  The amount of cpu allocated to the studio.
created_at : str (time)
updated_at : str (time)
most_recent_deploymentcivis.Response
- deployment_idint
  The ID for this deployment.
- user_idint
  The ID of the owner.
- hoststr
  Domain of the deployment.
- namestr
  Name of the deployment.
- docker_image_namestr
  The name of the docker image to pull from DockerHub.
- docker_image_tagstr
  The tag of the docker image to pull from DockerHub (default: latest).
- display_urlstr
  A signed URL for viewing the deployed item.
- instance_typestr
  The EC2 instance type requested for the deployment.
- memoryint
  The memory allocated to the deployment, in MB.
- cpuint
  The cpu allocated to the deployment, in millicores.
- statestr
  The state of the deployment.
- state_messagestr
  A detailed description of the state.
- max_memory_usagefloat (float)
  If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
- max_cpu_usagefloat (float)
  If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
- created_at : str (time)
- updated_at : str (time)
- studio_idint
  The ID of the owning Studio
git_credential_idint
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.
paramsList[civis.Response]
A definition of the parameters to use as environment variables in this studio.
- namestr
  The variable’s name as used within your code.
- descriptionstr
  A short sentence or fragment describing this parameter.
- typestr
  The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
- valueobject
  The value you would like to set this param to.
git_repo_idint
The ID of the git repository.
git_repo_urlstr
The URL of the git repository (e.g., https://github.com/organization/repo_name.git).
git_refstr
The git reference if git repo is specified
partition_labelstr
The partition label used to run this object.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).

post(*, name: str = None, docker_image_name: str = None, docker_image_tag: str = None, instance_type: str = None, required_resources: dict = None, git_credential_id: int = None, params: List[dict] = None, git_repo_url: str = None, git_ref: str = None, partition_label: str = None) → Response

Create a Studio

API URL: POST /studios

Parameters:

namestr, optional

The name of the studio.

docker_image_namestr, optional

The name of the docker image to pull from DockerHub.

docker_image_tagstr, optional

The tag of the docker image to pull from DockerHub (default: latest).

instance_typestr, optional

The EC2 instance type to deploy to.

required_resourcesdict, optional

memoryint
The amount of memory allocated to the studio.
disk_spacefloat (float)
The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
cpuint
The amount of cpu allocated to the studio.

git_credential_idint, optional

The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.

paramsList[dict], optional

A definition of the parameters to use as environment variables in this studio.

namestr
The variable’s name as used within your code.
descriptionstr
A short sentence or fragment describing this parameter.
typestr
The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
valueobject
The value you would like to set this param to.

git_repo_urlstr, optional

The URL of the git repository (e.g., https://github.com/organization/repo_name.git).

git_refstr, optional

The git reference if git repo is specified

partition_labelstr, optional

The partition label used to run this object.

Returns:

civis.Response

idint
The ID of the studio.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of the studio.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
instance_typestr
The EC2 instance type to deploy to.
required_resourcescivis.Response
- memoryint
  The amount of memory allocated to the studio.
- disk_spacefloat (float)
  The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
- cpuint
  The amount of cpu allocated to the studio.
created_at : str (time)
updated_at : str (time)
most_recent_deploymentcivis.Response
- deployment_idint
  The ID for this deployment.
- user_idint
  The ID of the owner.
- hoststr
  Domain of the deployment.
- namestr
  Name of the deployment.
- docker_image_namestr
  The name of the docker image to pull from DockerHub.
- docker_image_tagstr
  The tag of the docker image to pull from DockerHub (default: latest).
- display_urlstr
  A signed URL for viewing the deployed item.
- instance_typestr
  The EC2 instance type requested for the deployment.
- memoryint
  The memory allocated to the deployment, in MB.
- cpuint
  The cpu allocated to the deployment, in millicores.
- statestr
  The state of the deployment.
- state_messagestr
  A detailed description of the state.
- max_memory_usagefloat (float)
  If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
- max_cpu_usagefloat (float)
  If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
- created_at : str (time)
- updated_at : str (time)
- studio_idint
  The ID of the owning Studio
git_credential_idint
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.
paramsList[civis.Response]
A definition of the parameters to use as environment variables in this studio.
- namestr
  The variable’s name as used within your code.
- descriptionstr
  A short sentence or fragment describing this parameter.
- typestr
  The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
- valueobject
  The value you would like to set this param to.
git_repo_idint
The ID of the git repository.
git_repo_urlstr
The URL of the git repository (e.g., https://github.com/organization/repo_name.git).
git_refstr
The git reference if git repo is specified
partition_labelstr
The partition label used to run this object.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).

post_deployments(studio_id: int, *, deployment_id: int = None) → Response

Deploy a Studio

API URL: POST /studios/{studio_id}/deployments

Parameters:

studio_idint: The ID of the owning Studio
deployment_idint, optional: The ID for this deployment

Returns:

civis.Response

deployment_idint
The ID for this deployment.
user_idint
The ID of the owner.
hoststr
Domain of the deployment.
namestr
Name of the deployment.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
display_urlstr
A signed URL for viewing the deployed item.
instance_typestr
The EC2 instance type requested for the deployment.
memoryint
The memory allocated to the deployment, in MB.
cpuint
The cpu allocated to the deployment, in millicores.
statestr
The state of the deployment.
state_messagestr
A detailed description of the state.
max_memory_usagefloat (float)
If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
max_cpu_usagefloat (float)
If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
created_at : str (time)
updated_at : str (time)
studio_idint
The ID of the owning Studio

put(id: int, *, name: str = None, docker_image_name: str = None, docker_image_tag: str = None, instance_type: str = None, required_resources: dict = None, git_credential_id: int = None, params: List[dict] = None, git_repo_url: str = None, git_ref: str = None, partition_label: str = None) → Response

Replace all attributes of this Studio

API URL: PUT /studios/{id}

Parameters:

idint

The ID of the studio.

namestr, optional

The name of the studio.

docker_image_namestr, optional

The name of the docker image to pull from DockerHub.

docker_image_tagstr, optional

The tag of the docker image to pull from DockerHub (default: latest).

instance_typestr, optional

The EC2 instance type to deploy to.

required_resourcesdict, optional

memoryint
The amount of memory allocated to the studio.
disk_spacefloat (float)
The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
cpuint
The amount of cpu allocated to the studio.

git_credential_idint, optional

The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.

paramsList[dict], optional

A definition of the parameters to use as environment variables in this studio.

namestr
The variable’s name as used within your code.
descriptionstr
A short sentence or fragment describing this parameter.
typestr
The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
valueobject
The value you would like to set this param to.

git_repo_urlstr, optional

The URL of the git repository (e.g., https://github.com/organization/repo_name.git).

git_refstr, optional

The git reference if git repo is specified

partition_labelstr, optional

The partition label used to run this object.

Returns:

civis.Response

idint
The ID of the studio.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of the studio.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
instance_typestr
The EC2 instance type to deploy to.
required_resourcescivis.Response
- memoryint
  The amount of memory allocated to the studio.
- disk_spacefloat (float)
  The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
- cpuint
  The amount of cpu allocated to the studio.
created_at : str (time)
updated_at : str (time)
most_recent_deploymentcivis.Response
- deployment_idint
  The ID for this deployment.
- user_idint
  The ID of the owner.
- hoststr
  Domain of the deployment.
- namestr
  Name of the deployment.
- docker_image_namestr
  The name of the docker image to pull from DockerHub.
- docker_image_tagstr
  The tag of the docker image to pull from DockerHub (default: latest).
- display_urlstr
  A signed URL for viewing the deployed item.
- instance_typestr
  The EC2 instance type requested for the deployment.
- memoryint
  The memory allocated to the deployment, in MB.
- cpuint
  The cpu allocated to the deployment, in millicores.
- statestr
  The state of the deployment.
- state_messagestr
  A detailed description of the state.
- max_memory_usagefloat (float)
  If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
- max_cpu_usagefloat (float)
  If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
- created_at : str (time)
- updated_at : str (time)
- studio_idint
  The ID of the owning Studio
git_credential_idint
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.
paramsList[civis.Response]
A definition of the parameters to use as environment variables in this studio.
- namestr
  The variable’s name as used within your code.
- descriptionstr
  A short sentence or fragment describing this parameter.
- typestr
  The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
- valueobject
  The value you would like to set this param to.
git_repo_idint
The ID of the git repository.
git_repo_urlstr
The URL of the git repository (e.g., https://github.com/organization/repo_name.git).
git_refstr
The git reference if git repo is specified
partition_labelstr
The partition label used to run this object.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).

put_archive(id: int, status: bool) → Response

Update the archive status of this object

API URL: PUT /studios/{id}/archive

Parameters:

idint: The ID of the object.
statusbool: The desired archived status of the object.

Returns:

civis.Response

idint
The ID of the studio.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of the studio.
docker_image_namestr
The name of the docker image to pull from DockerHub.
docker_image_tagstr
The tag of the docker image to pull from DockerHub (default: latest).
instance_typestr
The EC2 instance type to deploy to.
required_resourcescivis.Response
- memoryint
  The amount of memory allocated to the studio.
- disk_spacefloat (float)
  The amount of disk space, in GB, to allocate for the studio. Fractional values (e.g. 0.25) are supported.
- cpuint
  The amount of cpu allocated to the studio.
created_at : str (time)
updated_at : str (time)
most_recent_deploymentcivis.Response
- deployment_idint
  The ID for this deployment.
- user_idint
  The ID of the owner.
- hoststr
  Domain of the deployment.
- namestr
  Name of the deployment.
- docker_image_namestr
  The name of the docker image to pull from DockerHub.
- docker_image_tagstr
  The tag of the docker image to pull from DockerHub (default: latest).
- display_urlstr
  A signed URL for viewing the deployed item.
- instance_typestr
  The EC2 instance type requested for the deployment.
- memoryint
  The memory allocated to the deployment, in MB.
- cpuint
  The cpu allocated to the deployment, in millicores.
- statestr
  The state of the deployment.
- state_messagestr
  A detailed description of the state.
- max_memory_usagefloat (float)
  If the deployment has finished, the maximum amount of memory used during the deployment, in MB.
- max_cpu_usagefloat (float)
  If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.
- created_at : str (time)
- updated_at : str (time)
- studio_idint
  The ID of the owning Studio
git_credential_idint
The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you’ve submitted will be used.
paramsList[civis.Response]
A definition of the parameters to use as environment variables in this studio.
- namestr
  The variable’s name as used within your code.
- descriptionstr
  A short sentence or fragment describing this parameter.
- typestr
  The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom
- valueobject
  The value you would like to set this param to.
git_repo_idint
The ID of the git repository.
git_repo_urlstr
The URL of the git repository (e.g., https://github.com/organization/repo_name.git).
git_refstr
The git reference if git repo is specified
partition_labelstr
The partition label used to run this object.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.
archivedstr
The archival status of the requested item(s).