Amazon DataZone

Starts a notebook sync in Amazon SageMaker Unified Studio. This operation syncs a notebook from a Git repository into a project.

See also: AWS API Documentation

Request Syntax

client.start_notebook_sync(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    sourceLocation={
        's3': 'string'
    },
    gitMetadata={
        'connectionId': 'string',
        'repository': 'string',
        'branch': 'string',
        'commitHash': 'string',
        'fileName': 'string',
        'committedAt': datetime(2015, 1, 1),
        'commitMessage': 'string'
    },
    notebookId='string',
    name='string',
    description='string',
    clientToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type owningProjectIdentifier:

string

param owningProjectIdentifier:

[REQUIRED]

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

type sourceLocation:

dict

param sourceLocation:

[REQUIRED]

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

• s3 (string) --

  The Amazon Simple Storage Service URI of the notebook source file.

type gitMetadata:

dict

param gitMetadata:

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

• connectionId (string) -- [REQUIRED]

  The identifier of the Git connection.

• repository (string) -- [REQUIRED]

  The name of the Git repository.

• branch (string) -- [REQUIRED]

  The name of the Git branch.

• commitHash (string) -- [REQUIRED]

  The commit hash in the Git repository.

• fileName (string) --

  The name of the file in the Git repository.

• committedAt (datetime) --

  The timestamp of when the commit was made.

• commitMessage (string) --

  The commit message associated with the Git commit.

type notebookId:

string

param notebookId:

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

type name:

string

param name:

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

type description:

string

param description:

The description of the notebook.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'notebookId': 'string',
    'status': 'ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
    'domainId': 'string',
    'owningProjectId': 'string',
    'sourceLocation': {
        's3': 'string'
    },
    'gitMetadata': {
        'connectionId': 'string',
        'repository': 'string',
        'branch': 'string',
        'commitHash': 'string',
        'fileName': 'string',
        'committedAt': datetime(2015, 1, 1),
        'commitMessage': 'string'
    },
    'name': 'string',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string'
}

Response Structure

• (dict) --

  • notebookId (string) --

    The identifier of the synced notebook.

  • status (string) --

    The status of the notebook sync.

  • domainId (string) --

    The identifier of the Amazon SageMaker Unified Studio domain.

  • owningProjectId (string) --

    The identifier of the project that owns the synced notebook.

  • sourceLocation (dict) --

    The source location from which the notebook was synced.

    • s3 (string) --

      The Amazon Simple Storage Service URI of the notebook source file.

  • gitMetadata (dict) --

    The Git metadata associated with the synced notebook.

    • connectionId (string) --

      The identifier of the Git connection.

    • repository (string) --

      The name of the Git repository.

    • branch (string) --

      The name of the Git branch.

    • commitHash (string) --

      The commit hash in the Git repository.

    • fileName (string) --

      The name of the file in the Git repository.

    • committedAt (datetime) --

      The timestamp of when the commit was made.

    • commitMessage (string) --

      The commit message associated with the Git commit.

  • name (string) --

    The name of the synced notebook.

  • description (string) --

    The description of the synced notebook.

  • createdAt (datetime) --

    The timestamp of when the notebook sync was started.

  • createdBy (string) --

    The identifier of the user who started the notebook sync.

{'gitMetadata': {'branch': 'string',
                 'commitHash': 'string',
                 'commitMessage': 'string',
                 'committedAt': 'timestamp',
                 'connectionId': 'string',
                 'fileName': 'string',
                 'repository': 'string'},
 'status': {'SYNC_FAILED', 'SYNC_IN_PROGRESS'}}

Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.

See also: AWS API Documentation

Request Syntax

client.create_notebook(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    name='string',
    description='string',
    metadata={
        'string': 'string'
    },
    parameters={
        'string': 'string'
    },
    clientToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type owningProjectIdentifier:

string

param owningProjectIdentifier:

[REQUIRED]

The identifier of the project that owns the notebook.

type name:

string

param name:

[REQUIRED]

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

type description:

string

param description:

The description of the notebook.

type metadata:

dict

param metadata:

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

• (string) --

  • (string) --

type parameters:

dict

param parameters:

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

• (string) --

  • (string) --

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'owningProjectId': 'string',
    'domainId': 'string',
    'cellOrder': [
        {},
    ],
    'status': 'ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
    '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'
    },
    'gitMetadata': {
        'connectionId': 'string',
        'repository': 'string',
        'branch': 'string',
        'commitHash': 'string',
        'fileName': 'string',
        'committedAt': datetime(2015, 1, 1),
        'commitMessage': '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 creation failed.

    • message (string) --

      The error message. The maximum length is 256 characters.

  • gitMetadata (dict) --

    The Git metadata associated with the notebook.

    • connectionId (string) --

      The identifier of the Git connection.

    • repository (string) --

      The name of the Git repository.

    • branch (string) --

      The name of the Git branch.

    • commitHash (string) --

      The commit hash in the Git repository.

    • fileName (string) --

      The name of the file in the Git repository.

    • committedAt (datetime) --

      The timestamp of when the commit was made.

    • commitMessage (string) --

      The commit message associated with the Git commit.

{'gitMetadata': {'branch': 'string',
                 'commitHash': 'string',
                 'commitMessage': 'string',
                 'committedAt': 'timestamp',
                 'connectionId': 'string',
                 'fileName': 'string',
                 'repository': 'string'},
 'status': {'SYNC_FAILED', 'SYNC_IN_PROGRESS'}}

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

See also: AWS API Documentation

Request Syntax

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

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the notebook.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'owningProjectId': 'string',
    'domainId': 'string',
    'cellOrder': [
        {},
    ],
    'status': 'ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
    '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'
    },
    'gitMetadata': {
        'connectionId': 'string',
        'repository': 'string',
        'branch': 'string',
        'commitHash': 'string',
        'fileName': 'string',
        'committedAt': datetime(2015, 1, 1),
        'commitMessage': '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.

  • gitMetadata (dict) --

    The Git metadata associated with the notebook.

    • connectionId (string) --

      The identifier of the Git connection.

    • repository (string) --

      The name of the Git repository.

    • branch (string) --

      The name of the Git branch.

    • commitHash (string) --

      The commit hash in the Git repository.

    • fileName (string) --

      The name of the file in the Git repository.

    • committedAt (datetime) --

      The timestamp of when the commit was made.

    • commitMessage (string) --

      The commit message associated with the Git commit.

{'status': {'SYNC_FAILED', 'SYNC_IN_PROGRESS'}}

{'items': {'status': {'SYNC_FAILED', 'SYNC_IN_PROGRESS'}}}

Lists notebooks in Amazon SageMaker Unified Studio.

See also: AWS API Documentation

Request Syntax

client.list_notebooks(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    maxResults=123,
    sortOrder='ASCENDING'|'DESCENDING',
    sortBy='CREATED_AT'|'UPDATED_AT',
    status='ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
    nextToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.

type owningProjectIdentifier:

string

param owningProjectIdentifier:

[REQUIRED]

The identifier of the project that owns the notebooks.

type maxResults:

integer

param maxResults:

The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of MaxResults, the response contains a NextToken value.

type sortOrder:

string

param sortOrder:

The sort order for the results.

type sortBy:

string

param sortBy:

The field to sort the results by.

type status:

string

param status:

The status to filter notebooks by.

type nextToken:

string

param nextToken:

When the number of notebooks is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebooks to list the next set of notebooks.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'owningProjectId': 'string',
            'domainId': 'string',
            'status': 'ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    The results of the ListNotebooks action.

    • (dict) --

      The summary of a notebook in Amazon SageMaker Unified Studio.

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

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

  • nextToken (string) --

    When the number of notebooks is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebooks to list the next set of notebooks.

{'status': {'SYNC_FAILED', 'SYNC_IN_PROGRESS'}}

Starts a notebook import in Amazon SageMaker Unified Studio. This operation imports a notebook from an Amazon Simple Storage Service location into a project.

See also: AWS API Documentation

Request Syntax

client.start_notebook_import(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    sourceLocation={
        's3': 'string'
    },
    name='string',
    description='string',
    clientToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type owningProjectIdentifier:

string

param owningProjectIdentifier:

[REQUIRED]

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

type sourceLocation:

dict

param sourceLocation:

[REQUIRED]

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

• s3 (string) --

  The Amazon Simple Storage Service URI of the notebook source file.

type name:

string

param name:

[REQUIRED]

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

type description:

string

param description:

The description of the imported notebook.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'notebookId': 'string',
    'status': 'ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
    'domainId': 'string',
    'owningProjectId': 'string',
    'name': 'string',
    'description': 'string',
    'sourceLocation': {
        's3': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string'
}

Response Structure

• (dict) --

  • notebookId (string) --

    The identifier of the imported notebook.

  • status (string) --

    The status of the notebook import.

  • domainId (string) --

    The identifier of the Amazon SageMaker Unified Studio domain.

  • owningProjectId (string) --

    The identifier of the project that owns the imported notebook.

  • name (string) --

    The name of the imported notebook.

  • description (string) --

    The description of the imported notebook.

  • sourceLocation (dict) --

    The source location from which the notebook was imported.

    • s3 (string) --

      The Amazon Simple Storage Service URI of the notebook source file.

  • createdAt (datetime) --

    The timestamp of when the notebook import was started.

  • createdBy (string) --

    The identifier of the user who started the notebook import.

{'status': {'SYNC_FAILED', 'SYNC_IN_PROGRESS'}}

{'gitMetadata': {'branch': 'string',
                 'commitHash': 'string',
                 'commitMessage': 'string',
                 'committedAt': 'timestamp',
                 'connectionId': 'string',
                 'fileName': 'string',
                 'repository': 'string'},
 'status': {'SYNC_FAILED', 'SYNC_IN_PROGRESS'}}

Updates a notebook in Amazon SageMaker Unified Studio.

See also: AWS API Documentation

Request Syntax

client.update_notebook(
    domainIdentifier='string',
    identifier='string',
    description='string',
    status='ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
    name='string',
    cellOrder=[
        {}
        ,
    ],
    metadata={
        'string': 'string'
    },
    parameters={
        'string': 'string'
    },
    environmentConfiguration={
        'imageVersion': 'string',
        'packageConfig': {
            'packageManager': 'UV',
            'packageSpecification': 'string'
        }
    },
    clientToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the notebook to update.

type description:

string

param description:

The updated description of the notebook.

type status:

string

param status:

The updated status of the notebook.

type name:

string

param name:

The updated name of the notebook.

type cellOrder:

list

param cellOrder:

The updated ordered list of cells in the notebook.

• (dict) --

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

type metadata:

dict

param metadata:

The updated metadata for the notebook, specified as key-value pairs.

• (string) --

  • (string) --

type parameters:

dict

param parameters:

The updated sensitive parameters for the notebook, specified as key-value pairs.

• (string) --

  • (string) --

type environmentConfiguration:

dict

param environmentConfiguration:

The updated environment configuration for the notebook.

• imageVersion (string) --

  The image version for the notebook run environment.

• packageConfig (dict) --

  The package configuration for the notebook run environment.

  • packageManager (string) -- [REQUIRED]

    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.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'owningProjectId': 'string',
    'domainId': 'string',
    'cellOrder': [
        {},
    ],
    'status': 'ACTIVE'|'ARCHIVED'|'SYNC_IN_PROGRESS'|'SYNC_FAILED',
    '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'
    },
    'gitMetadata': {
        'connectionId': 'string',
        'repository': 'string',
        'branch': 'string',
        'commitHash': 'string',
        'fileName': 'string',
        'committedAt': datetime(2015, 1, 1),
        'commitMessage': '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.

  • gitMetadata (dict) --

    The Git metadata associated with the notebook.

    • connectionId (string) --

      The identifier of the Git connection.

    • repository (string) --

      The name of the Git repository.

    • branch (string) --

      The name of the Git branch.

    • commitHash (string) --

      The commit hash in the Git repository.

    • fileName (string) --

      The name of the file in the Git repository.

    • committedAt (datetime) --

      The timestamp of when the commit was made.

    • commitMessage (string) --

      The commit message associated with the Git commit.