DataZone / Client / start_notebook_sync

start_notebook_sync

DataZone.Client.start_notebook_sync(**kwargs)

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

response = 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'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• owningProjectIdentifier (string) –

  [REQUIRED]

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

• sourceLocation (dict) –

  [REQUIRED]

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

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

  • s3 (string) –

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

• gitMetadata (dict) –

  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.

• notebookId (string) – The identifier of an existing notebook to sync. If not specified, a new notebook is created.

• name (string) – The name of the notebook. The name must be between 1 and 256 characters.

• description (string) – The description of the notebook.

• clientToken (string) –

  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.

Return type:

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.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

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

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ServiceQuotaExceededException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException