Skip to content

/AWS1/IF_DZN=>STARTNOTEBOOKSYNC()

About StartNotebookSync

Starts a notebook sync in Amazon SageMaker Unified Studio. This operation syncs a notebook from a Git repository into a project.

Method Signature

METHODS /AWS1/IF_DZN~STARTNOTEBOOKSYNC
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_OWNINGPROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IO_SOURCELOCATION TYPE REF TO /AWS1/CL_DZNSOURCELOCATION OPTIONAL
    !IO_GITMETADATA TYPE REF TO /AWS1/CL_DZNGITMETADATA OPTIONAL
    !IV_NOTEBOOKID TYPE /AWS1/DZNNOTEBOOKID OPTIONAL
    !IV_NAME TYPE /AWS1/DZNNOTEBOOKNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DZNDESCRIPTION OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DZNCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznstrtnotebooksncout
  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 sync the notebook.

iv_owningprojectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

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

io_sourcelocation TYPE REF TO /AWS1/CL_DZNSOURCELOCATION /AWS1/CL_DZNSOURCELOCATION

The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.

Optional arguments:

io_gitmetadata TYPE REF TO /AWS1/CL_DZNGITMETADATA /AWS1/CL_DZNGITMETADATA

The Git metadata for the notebook sync, including repository, branch, and commit information.

iv_notebookid TYPE /AWS1/DZNNOTEBOOKID /AWS1/DZNNOTEBOOKID

The identifier of an existing notebook to sync. If not specified, a new notebook is created.

iv_name TYPE /AWS1/DZNNOTEBOOKNAME /AWS1/DZNNOTEBOOKNAME

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

iv_description TYPE /AWS1/DZNDESCRIPTION /AWS1/DZNDESCRIPTION

The description of the notebook.

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_dznstrtnotebooksncout /AWS1/CL_DZNSTRTNOTEBOOKSNCOUT

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->startnotebooksync(
  io_gitmetadata = new /aws1/cl_dzngitmetadata(
    iv_branch = |string|
    iv_commithash = |string|
    iv_commitmessage = |string|
    iv_committedat = '20150101000000.0000000'
    iv_connectionid = |string|
    iv_filename = |string|
    iv_repository = |string|
  )
  io_sourcelocation = new /aws1/cl_dznsourcelocation( |string| )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_domainidentifier = |string|
  iv_name = |string|
  iv_notebookid = |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_notebookid = lo_result->get_notebookid( ).
  lv_notebookstatus = lo_result->get_status( ).
  lv_domainid = lo_result->get_domainid( ).
  lv_projectid = lo_result->get_owningprojectid( ).
  lo_sourcelocation = lo_result->get_sourcelocation( ).
  IF lo_sourcelocation IS NOT INITIAL.
    lv_s3sourcelocation = lo_sourcelocation->get_s3( ).
  ENDIF.
  lo_gitmetadata = lo_result->get_gitmetadata( ).
  IF lo_gitmetadata IS NOT INITIAL.
    lv_gitconnectionid = lo_gitmetadata->get_connectionid( ).
    lv_gitrepository = lo_gitmetadata->get_repository( ).
    lv_gitbranch = lo_gitmetadata->get_branch( ).
    lv_commithash = lo_gitmetadata->get_commithash( ).
    lv_filename = lo_gitmetadata->get_filename( ).
    lv_timestamp = lo_gitmetadata->get_committedat( ).
    lv_commitmessage = lo_gitmetadata->get_commitmessage( ).
  ENDIF.
  lv_notebookname = lo_result->get_name( ).
  lv_description = lo_result->get_description( ).
  lv_createdat = lo_result->get_createdat( ).
  lv_createdby = lo_result->get_createdby( ).
ENDIF.