DataZone / Client / start_notebook_import

start_notebook_import

DataZone.Client.start_notebook_import(**kwargs)

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

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

  • domainIdentifier (string) –

    [REQUIRED]

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

  • owningProjectIdentifier (string) –

    [REQUIRED]

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

  • sourceLocation (dict) –

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

    Note

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

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

  • name (string) –

    [REQUIRED]

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

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

  • type (string) – The type of the notebook to import. If not specified, defaults to DATA.

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

Exceptions