AWS API Changes

2026/10/08 - Amazon DataZone - 2 updated api methods

Changes Adds support for multi-file notebook import. StartNotebookImport now accepts an s3Files source location with an ordered list of Amazon S3 objects, creating one notebook cell per file, plus a type field to create either a DATA or SQL notebook.

StartNotebookImport (updated)

Link ¶
Changes (both)

{'sourceLocation': {'s3Files': {'bucket': 'string',
                                'fileList': [{'key': 'string'}]}},
 'type': 'DATA | SQL'}

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',
        's3Files': {
            'bucket': 'string',
            'fileList': [
                {
                    'key': 'string'
                },
            ]
        }
    },
    name='string',
    description='string',
    type='DATA'|'SQL',
    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. Specify either a single Amazon Simple Storage Service URI, or a list of objects to import as the notebook's cells.

s3 (string) --

The Amazon Simple Storage Service URI of the notebook source file.
s3Files (dict) --

The Amazon Simple Storage Service objects to import as the notebook's cells. One cell is created for each object, in the order in which you list them.
- bucket (string) -- [REQUIRED]
  
  The name of the Amazon Simple Storage Service bucket that contains the files to import.
- fileList (list) -- [REQUIRED]
  
  The files to import. Cells are created in the order in which you list the files. You can specify between 1 and 100 files.
  - (dict) --
    
    A single Amazon Simple Storage Service object to import as a notebook cell.
    - key (string) -- [REQUIRED]
      
      The key of the Amazon Simple Storage Service object to import.

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 type:

string

param type:

The type of the notebook to import. If not specified, defaults to DATA.

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',
    'type': 'DATA'|'SQL',
    'sourceLocation': {
        's3': 'string',
        's3Files': {
            'bucket': 'string',
            'fileList': [
                {
                    'key': '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.
- type (string) --
  
  The type of the imported notebook.
- sourceLocation (dict) --
  
  The source location from which the notebook was imported.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: s3, s3Files. 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.
  - s3Files (dict) --
    
    The Amazon Simple Storage Service objects to import as the notebook's cells. One cell is created for each object, in the order in which you list them.
    - bucket (string) --
      
      The name of the Amazon Simple Storage Service bucket that contains the files to import.
    - fileList (list) --
      
      The files to import. Cells are created in the order in which you list the files. You can specify between 1 and 100 files.
      - (dict) --
        
        A single Amazon Simple Storage Service object to import as a notebook cell.
        
        key (string) --
        
        The key of the Amazon Simple Storage Service object to import.
- createdAt (datetime) --
  
  The timestamp of when the notebook import was started.
- createdBy (string) --
  
  The identifier of the user who started the notebook import.

StartNotebookSync (updated)

Link ¶
Changes (both)

{'sourceLocation': {'s3Files': {'bucket': 'string',
                                'fileList': [{'key': 'string'}]}}}

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',
        's3Files': {
            'bucket': 'string',
            'fileList': [
                {
                    'key': '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.
s3Files (dict) --

The Amazon Simple Storage Service objects to import as the notebook's cells. One cell is created for each object, in the order in which you list them.
- bucket (string) -- [REQUIRED]
  
  The name of the Amazon Simple Storage Service bucket that contains the files to import.
- fileList (list) -- [REQUIRED]
  
  The files to import. Cells are created in the order in which you list the files. You can specify between 1 and 100 files.
  - (dict) --
    
    A single Amazon Simple Storage Service object to import as a notebook cell.
    - key (string) -- [REQUIRED]
      
      The key of the Amazon Simple Storage Service object to import.

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',
        's3Files': {
            'bucket': 'string',
            'fileList': [
                {
                    'key': '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, s3Files. 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.
  - s3Files (dict) --
    
    The Amazon Simple Storage Service objects to import as the notebook's cells. One cell is created for each object, in the order in which you list them.
    - bucket (string) --
      
      The name of the Amazon Simple Storage Service bucket that contains the files to import.
    - fileList (list) --
      
      The files to import. Cells are created in the order in which you list the files. You can specify between 1 and 100 files.
      - (dict) --
        
        A single Amazon Simple Storage Service object to import as a notebook cell.
        
        key (string) --
        
        The key of the Amazon Simple Storage Service object to import.
- 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.