client.studios.post

A method of the Studios endpoint.

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

import civis
client = civis.APIClient()
response = client.studios.post(...)

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. One of pending, running, terminated or sleeping.

  • 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”.

• archivedbool

  The archival status of the requested item(s).