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'
    },
    name='string',
    description='string',
    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. 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.

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

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

      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.

    • createdAt (datetime) –

      The timestamp of when the notebook import was started.

    • createdBy (string) –

      The identifier of the user who started the notebook import.

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