Skip to content

GetNotebookOutput

Source code in docs_src/capo_datazone/types/get_notebook_output.py
class GetNotebookOutput(TypedDict, closed=True):
    id: "capo_datazone.types.notebook_id.NotebookId"
    """<p>The identifier of the notebook.</p>"""
    name: "capo_datazone.types.notebook_name.NotebookName"
    """<p>The name of the notebook.</p>"""
    owning_project_id: "capo_datazone.types.project_id.ProjectId"
    """<p>The identifier of the project that owns the notebook.</p>"""
    domain_id: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon SageMaker Unified Studio domain.</p>"""
    cell_order: "capo_datazone.types.cell_order.CellOrder"
    """<p>The ordered list of cells in the notebook.</p>"""
    status: "capo_datazone.types.notebook_status.NotebookStatus"
    """<p>The status of the notebook.</p>"""
    type: NotRequired["capo_datazone.types.notebook_type.NotebookType"]
    """<p>The type of the notebook.</p>"""
    description: NotRequired["capo_datazone.types.description.Description"]
    """<p>The description of the notebook.</p>"""
    created_at: NotRequired["capo_datazone.types.created_at.CreatedAt"]
    """<p>The timestamp of when the notebook was created.</p>"""
    created_by: NotRequired["capo_datazone.types.created_by.CreatedBy"]
    """<p>The identifier of the user who created the notebook.</p>"""
    updated_at: NotRequired["capo_datazone.types.updated_at.UpdatedAt"]
    """<p>The timestamp of when the notebook was last updated.</p>"""
    updated_by: NotRequired["capo_datazone.types.updated_by.UpdatedBy"]
    """<p>The identifier of the user who last updated the notebook.</p>"""
    locked_by: NotRequired["str"]
    """<p>The identifier of the user who locked the notebook.</p>"""
    locked_at: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the notebook was locked.</p>"""
    lock_expires_at: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the notebook lock expires.</p>"""
    compute_id: NotRequired["capo_datazone.types.compute_id.ComputeId"]
    """<p>The identifier of the compute associated with the notebook.</p>"""
    metadata: NotRequired["capo_datazone.types.metadata.Metadata"]
    """<p>The metadata of the notebook.</p>"""
    parameters: NotRequired["capo_datazone.types.parameters.Parameters"]
    """<p>The sensitive parameters of the notebook.</p>"""
    environment_configuration: NotRequired[
        "capo_datazone.types.environment_config.EnvironmentConfig"
    ]
    """<p>The environment configuration of the notebook.</p>"""
    error: NotRequired["capo_datazone.types.notebook_error.NotebookError"]
    """<p>The error details if the notebook is in a failed state.</p>"""
    git_metadata: NotRequired["capo_datazone.types.git_metadata.GitMetadata"]
    """<p>The Git metadata associated with the notebook.</p>"""

cell_order instance-attribute

cell_order: CellOrder

The ordered list of cells in the notebook.

compute_id instance-attribute

compute_id: NotRequired[ComputeId]

The identifier of the compute associated with the notebook.

created_at instance-attribute

created_at: NotRequired[CreatedAt]

The timestamp of when the notebook was created.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The identifier of the user who created the notebook.

description instance-attribute

description: NotRequired[Description]

The description of the notebook.

domain_id instance-attribute

domain_id: DomainId

The identifier of the Amazon SageMaker Unified Studio domain.

environment_configuration instance-attribute

environment_configuration: NotRequired[EnvironmentConfig]

The environment configuration of the notebook.

error instance-attribute

error: NotRequired[NotebookError]

The error details if the notebook is in a failed state.

git_metadata instance-attribute

git_metadata: NotRequired[GitMetadata]

The Git metadata associated with the notebook.

id instance-attribute

The identifier of the notebook.

lock_expires_at instance-attribute

lock_expires_at: NotRequired[datetime]

The timestamp of when the notebook lock expires.

locked_at instance-attribute

locked_at: NotRequired[datetime]

The timestamp of when the notebook was locked.

locked_by instance-attribute

locked_by: NotRequired[str]

The identifier of the user who locked the notebook.

metadata instance-attribute

metadata: NotRequired[Metadata]

The metadata of the notebook.

name instance-attribute

The name of the notebook.

owning_project_id instance-attribute

owning_project_id: ProjectId

The identifier of the project that owns the notebook.

parameters instance-attribute

parameters: NotRequired[Parameters]

The sensitive parameters of the notebook.

status instance-attribute

The status of the notebook.

type instance-attribute

type: NotRequired[NotebookType]

The type of the notebook.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The timestamp of when the notebook was last updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The identifier of the user who last updated the notebook.