Skip to content

StartNotebookSyncInput

Source code in docs_src/capo_datazone/types/start_notebook_sync_input.py
class StartNotebookSyncInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon SageMaker Unified Studio domain in which to sync the notebook.</p>"""
    owning_project_identifier: "capo_datazone.types.project_id.ProjectId"
    """<p>The identifier of the project that will own the synced notebook.</p>"""
    source_location: "capo_datazone.types.source_location.SourceLocation"
    """<p>The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.</p>"""
    git_metadata: NotRequired["capo_datazone.types.git_metadata.GitMetadata"]
    """<p>The Git metadata for the notebook sync, including repository, branch, and commit information.</p>"""
    notebook_id: NotRequired["capo_datazone.types.notebook_id.NotebookId"]
    """<p>The identifier of an existing notebook to sync. If not specified, a new notebook is created.</p>"""
    name: NotRequired["capo_datazone.types.notebook_name.NotebookName"]
    """<p>The name of the notebook. The name must be between 1 and 256 characters.</p>"""
    description: NotRequired["capo_datazone.types.description.Description"]
    """<p>The description of the notebook.</p>"""
    client_token: NotRequired["capo_datazone.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

description instance-attribute

description: NotRequired[Description]

The description of the notebook.

domain_identifier instance-attribute

domain_identifier: DomainId

The identifier of the Amazon SageMaker Unified Studio domain in which to sync the notebook.

git_metadata instance-attribute

git_metadata: NotRequired[GitMetadata]

The Git metadata for the notebook sync, including repository, branch, and commit information.

name instance-attribute

name: NotRequired[NotebookName]

The name of the notebook. The name must be between 1 and 256 characters.

notebook_id instance-attribute

notebook_id: NotRequired[NotebookId]

The identifier of an existing notebook to sync. If not specified, a new notebook is created.

owning_project_identifier instance-attribute

owning_project_identifier: ProjectId

The identifier of the project that will own the synced notebook.

source_location instance-attribute

source_location: SourceLocation

The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.