Skip to content

StartNotebookRunInput

Source code in docs_src/capo_datazone/types/start_notebook_run_input.py
class StartNotebookRunInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.</p>"""
    owning_project_identifier: "capo_datazone.types.project_id.ProjectId"
    """<p>The identifier of the project that owns the notebook run.</p>"""
    notebook_identifier: "capo_datazone.types.notebook_id.NotebookId"
    """<p>The identifier of the notebook to run.</p>"""
    schedule_identifier: NotRequired["capo_datazone.types.schedule_id.ScheduleId"]
    """<p>The identifier of the schedule associated with the notebook run.</p>"""
    compute_configuration: NotRequired[
        "capo_datazone.types.compute_config.ComputeConfig"
    ]
    """<p>The compute configuration for the notebook run, including instance type and environment version.</p>"""
    network_configuration: NotRequired[
        "capo_datazone.types.network_config.NetworkConfig"
    ]
    """<p>The network configuration for the notebook run, including network access type and optional VPC settings.</p>"""
    timeout_configuration: NotRequired[
        "capo_datazone.types.timeout_config.TimeoutConfig"
    ]
    """<p>The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).</p>"""
    notification_configuration: NotRequired[
        "capo_datazone.types.notification_config.NotificationConfig"
    ]
    """<p>The notification configuration for the notebook run. Use this to specify the notebook run states that trigger notifications.</p>"""
    trigger_source: NotRequired["capo_datazone.types.trigger_source.TriggerSource"]
    """<p>The source that triggered the notebook run.</p>"""
    metadata: NotRequired["capo_datazone.types.metadata.Metadata"]
    """<p>The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>"""
    parameters: NotRequired["capo_datazone.types.parameters.Parameters"]
    """<p>The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</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.

compute_configuration instance-attribute

compute_configuration: NotRequired[ComputeConfig]

The compute configuration for the notebook run, including instance type and environment version.

domain_identifier instance-attribute

domain_identifier: DomainId

The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.

metadata instance-attribute

metadata: NotRequired[Metadata]

The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

network_configuration instance-attribute

network_configuration: NotRequired[NetworkConfig]

The network configuration for the notebook run, including network access type and optional VPC settings.

notebook_identifier instance-attribute

notebook_identifier: NotebookId

The identifier of the notebook to run.

notification_configuration instance-attribute

notification_configuration: NotRequired[NotificationConfig]

The notification configuration for the notebook run. Use this to specify the notebook run states that trigger notifications.

owning_project_identifier instance-attribute

owning_project_identifier: ProjectId

The identifier of the project that owns the notebook run.

parameters instance-attribute

parameters: NotRequired[Parameters]

The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

schedule_identifier instance-attribute

schedule_identifier: NotRequired[ScheduleId]

The identifier of the schedule associated with the notebook run.

timeout_configuration instance-attribute

timeout_configuration: NotRequired[TimeoutConfig]

The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

trigger_source instance-attribute

trigger_source: NotRequired[TriggerSource]

The source that triggered the notebook run.