client.notebooks.get_deployments

A method of the Notebooks endpoint.

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

Get details about a Notebook deployment

API URL: GET /notebooks/{notebook_id}/deployments/{deployment_id}

import civis
client = civis.APIClient()
response = client.notebooks.get_deployments(...)

Parameters:

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. 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)
notebook_idint
The ID of the owning Notebook