DataZone / Client / get_notebook_run

get_notebook_run

DataZone.Client.get_notebook_run(**kwargs)

Gets the details of a notebook run in Amazon SageMaker Unified Studio.

See also: AWS API Documentation

Request Syntax

response = client.get_notebook_run(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• identifier (string) –

  [REQUIRED]

  The identifier of the notebook run.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'domainId': 'string',
    'owningProjectId': 'string',
    'notebookId': 'string',
    'scheduleId': 'string',
    'status': 'QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
    'cellOrder': [
        {},
    ],
    'metadata': {
        'string': 'string'
    },
    'parameters': {
        'string': 'string'
    },
    'computeConfiguration': {
        'instanceType': 'string',
        'environmentVersion': 'string'
    },
    'networkConfiguration': {
        'networkAccessType': 'PUBLIC_INTERNET_ONLY'|'VPC_ONLY',
        'vpcId': 'string',
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    },
    'timeoutConfiguration': {
        'runTimeoutInMinutes': 123
    },
    'environmentConfiguration': {
        'imageVersion': 'string',
        'packageConfig': {
            'packageManager': 'UV',
            'packageSpecification': 'string'
        }
    },
    'storageConfiguration': {
        'projectS3Path': 'string',
        'kmsKeyArn': 'string'
    },
    'triggerSource': {
        'type': 'MANUAL'|'SCHEDULED'|'WORKFLOW',
        'name': 'string'
    },
    'error': {
        'message': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'startedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • id (string) –

    The identifier of the notebook run.

  • domainId (string) –

    The identifier of the Amazon SageMaker Unified Studio domain.

  • owningProjectId (string) –

    The identifier of the project that owns the notebook run.

  • notebookId (string) –

    The identifier of the notebook.

  • scheduleId (string) –

    The identifier of the schedule associated with the notebook run.

  • status (string) –

    The status of the notebook run.

  • cellOrder (list) –

    The ordered list of cells in the notebook run.

    • (dict) –

      The information about a cell in a notebook run in Amazon SageMaker Unified Studio.

  • metadata (dict) –

    The metadata of the notebook run.

    • (string) –

      • (string) –

  • parameters (dict) –

    The sensitive parameters of the notebook run.

    • (string) –

      • (string) –

  • computeConfiguration (dict) –

    The compute configuration of the notebook run.

    • instanceType (string) –

      The instance type for the notebook run compute.

    • environmentVersion (string) –

      The environment version for the notebook run compute.

  • networkConfiguration (dict) –

    The network configuration of the notebook run.

    • networkAccessType (string) –

      The network access type for the notebook run. Valid values are PUBLIC_INTERNET_ONLY and VPC_ONLY.

    • vpcId (string) –

      The identifier of the VPC for the notebook run. This is required when the network access type is VPC_ONLY.

    • subnetIds (list) –

      The identifiers of the subnets for the notebook run. You can specify up to 10 subnets.

      • (string) –

    • securityGroupIds (list) –

      The identifiers of the security groups for the notebook run. You can specify up to 5 security groups.

      • (string) –

  • timeoutConfiguration (dict) –

    The timeout configuration of the notebook run.

    • runTimeoutInMinutes (integer) –

      The timeout for the notebook run, in minutes. The minimum value is 60 minutes (1 hour), the maximum value is 1440 minutes (24 hours), and the default value is 720 minutes (12 hours).

  • environmentConfiguration (dict) –

    The environment configuration of the notebook run, including image version and package settings.

    • imageVersion (string) –

      The image version for the notebook run environment.

    • packageConfig (dict) –

      The package configuration for the notebook run environment.

      • packageManager (string) –

        The package manager for the notebook run environment. The default value is UV.

      • packageSpecification (string) –

        The package specification content for the notebook run environment. The maximum length is 10240 characters.

  • storageConfiguration (dict) –

    The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

    • projectS3Path (string) –

      The Amazon Simple Storage Service path for the project storage.

    • kmsKeyArn (string) –

      The ARN of the KMS key used for encryption.

  • triggerSource (dict) –

    The source that triggered the notebook run.

    • type (string) –

      The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.

    • name (string) –

      The name of the trigger source.

  • error (dict) –

    The error details if the notebook run failed.

    • message (string) –

      The error message. The maximum length is 1024 characters.

  • createdAt (datetime) –

    The timestamp of when the notebook run was created.

  • createdBy (string) –

    The identifier of the user who created the notebook run.

  • updatedAt (datetime) –

    The timestamp of when the notebook run was last updated.

  • updatedBy (string) –

    The identifier of the user who last updated the notebook run.

  • startedAt (datetime) –

    The timestamp of when the notebook run started executing.

  • completedAt (datetime) –

    The timestamp of when the notebook run completed.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException