DataZone / Client / start_notebook_export

start_notebook_export

DataZone.Client.start_notebook_export(**kwargs)

Starts a notebook export in Amazon SageMaker Unified Studio. This operation exports a notebook to a specified file format and stores the output in Amazon Simple Storage Service.

See also: AWS API Documentation

Request Syntax

response = client.start_notebook_export(
    domainIdentifier='string',
    notebookIdentifier='string',
    owningProjectIdentifier='string',
    fileFormat='PDF'|'IPYNB',
    clientToken='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• notebookIdentifier (string) –

  [REQUIRED]

  The identifier of the notebook to export.

• owningProjectIdentifier (string) –

  [REQUIRED]

  The identifier of the project that owns the notebook.

• fileFormat (string) –

  [REQUIRED]

  The file format for the notebook export. Valid values are PDF and IPYNB.

• 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

{
    'id': 'string',
    'domainId': 'string',
    'owningProjectId': 'string',
    'notebookId': 'string',
    'fileFormat': 'PDF'|'IPYNB',
    'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string'
}

Response Structure

• (dict) –

  • id (string) –

    The identifier of the notebook export.

  • domainId (string) –

    The identifier of the Amazon SageMaker Unified Studio domain.

  • owningProjectId (string) –

    The identifier of the project that owns the notebook.

  • notebookId (string) –

    The identifier of the notebook.

  • fileFormat (string) –

    The file format of the notebook export.

  • status (string) –

    The status of the notebook export.

  • createdAt (datetime) –

    The timestamp of when the notebook export was started.

  • createdBy (string) –

    The identifier of the user who started the notebook export.

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