Skip to content

/AWS1/IF_DZN=>STOPNOTEBOOKRUN()

About StopNotebookRun

Stops a running notebook run in an Amazon DataZone domain.

Method Signature

METHODS /AWS1/IF_DZN~STOPNOTEBOOKRUN
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/DZNNOTEBOOKRUNID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DZNCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznstopnotebookrunout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /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 DataZone domain in which the notebook run is stopped.

iv_identifier TYPE /AWS1/DZNNOTEBOOKRUNID /AWS1/DZNNOTEBOOKRUNID

The identifier of the notebook run to stop.

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_dznstopnotebookrunout /AWS1/CL_DZNSTOPNOTEBOOKRUNOUT

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->stopnotebookrun(
  iv_clienttoken = |string|
  iv_domainidentifier = |string|
  iv_identifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_notebookrunid = lo_result->get_id( ).
  lv_domainid = lo_result->get_domainid( ).
  lv_projectid = lo_result->get_owningprojectid( ).
  lv_notebookrunstatus = lo_result->get_status( ).
ENDIF.