STARTNOTEBOOKEXPORT()`¶

About StartNotebookExport¶

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.

Method Signature¶

METHODS /AWS1/IF_DZN~STARTNOTEBOOKEXPORT
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_NOTEBOOKIDENTIFIER TYPE /AWS1/DZNNOTEBOOKID OPTIONAL
    !IV_OWNINGPROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_FILEFORMAT TYPE /AWS1/DZNFILEFORMAT OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DZNCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznstrtnotebookexpout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNSERVICEQUOTAEXCDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainidentifier` `TYPE /AWS1/DZNDOMAINID` `/AWS1/DZNDOMAINID`¶

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

`iv_notebookidentifier` `TYPE /AWS1/DZNNOTEBOOKID` `/AWS1/DZNNOTEBOOKID`¶

The identifier of the notebook to export.

`iv_owningprojectidentifier` `TYPE /AWS1/DZNPROJECTID` `/AWS1/DZNPROJECTID`¶

The identifier of the project that owns the notebook.

`iv_fileformat` `TYPE /AWS1/DZNFILEFORMAT` `/AWS1/DZNFILEFORMAT`¶

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

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/DZNCLIENTTOKEN` `/AWS1/DZNCLIENTTOKEN`¶

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dznstrtnotebookexpout` `/AWS1/CL_DZNSTRTNOTEBOOKEXPOUT`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startnotebookexport(
  iv_clienttoken = |string|
  iv_domainidentifier = |string|
  iv_fileformat = |string|
  iv_notebookidentifier = |string|
  iv_owningprojectidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_exportid = lo_result->get_id( ).
  lv_domainid = lo_result->get_domainid( ).
  lv_projectid = lo_result->get_owningprojectid( ).
  lv_notebookid = lo_result->get_notebookid( ).
  lv_fileformat = lo_result->get_fileformat( ).
  lv_notebookexportstatus = lo_result->get_status( ).
  lv_createdat = lo_result->get_createdat( ).
  lv_createdby = lo_result->get_createdby( ).
ENDIF.

/AWS1/IF_DZN=>STARTNOTEBOOKEXPORT()¶