DataZone / Client / get_notebook

get_notebook

DataZone.Client.get_notebook(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• identifier (string) –

  [REQUIRED]

  The identifier of the notebook.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'owningProjectId': 'string',
    'domainId': 'string',
    'cellOrder': [
        {},
    ],
    'status': 'ACTIVE'|'ARCHIVED',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'lockedBy': 'string',
    'lockedAt': datetime(2015, 1, 1),
    'lockExpiresAt': datetime(2015, 1, 1),
    'computeId': 'string',
    'metadata': {
        'string': 'string'
    },
    'parameters': {
        'string': 'string'
    },
    'environmentConfiguration': {
        'imageVersion': 'string',
        'packageConfig': {
            'packageManager': 'UV',
            'packageSpecification': 'string'
        }
    },
    'error': {
        'message': 'string'
    }
}

Response Structure

• (dict) –

  • id (string) –

    The identifier of the notebook.

  • name (string) –

    The name of the notebook.

  • owningProjectId (string) –

    The identifier of the project that owns the notebook.

  • domainId (string) –

    The identifier of the Amazon SageMaker Unified Studio domain.

  • cellOrder (list) –

    The ordered list of cells in the notebook.

    • (dict) –

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

  • status (string) –

    The status of the notebook.

  • description (string) –

    The description of the notebook.

  • createdAt (datetime) –

    The timestamp of when the notebook was created.

  • createdBy (string) –

    The identifier of the user who created the notebook.

  • updatedAt (datetime) –

    The timestamp of when the notebook was last updated.

  • updatedBy (string) –

    The identifier of the user who last updated the notebook.

  • lockedBy (string) –

    The identifier of the user who locked the notebook.

  • lockedAt (datetime) –

    The timestamp of when the notebook was locked.

  • lockExpiresAt (datetime) –

    The timestamp of when the notebook lock expires.

  • computeId (string) –

    The identifier of the compute associated with the notebook.

  • metadata (dict) –

    The metadata of the notebook.

    • (string) –

      • (string) –

  • parameters (dict) –

    The sensitive parameters of the notebook.

    • (string) –

      • (string) –

  • environmentConfiguration (dict) –

    The environment configuration of the notebook.

    • 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.

  • error (dict) –

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

    • message (string) –

      The error message. The maximum length is 256 characters.

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