Skip to content

/AWS1/IF_EMS=>STARTSESSION()

About StartSession

Creates and starts a new session on the specified application. The application must be in the STARTED state or have AutoStart enabled, and have interactive sessions enabled. This operation is supported for EMR release 7.13.0 and later.

Method Signature

METHODS /AWS1/IF_EMS~STARTSESSION
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/EMSAPPLICATIONID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EMSCLIENTTOKEN OPTIONAL
    !IV_EXECUTIONROLEARN TYPE /AWS1/EMSIAMROLEARN OPTIONAL
    !IO_CONFIGURATIONOVERRIDES TYPE REF TO /AWS1/CL_EMSSESSIONCONFOVRDS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_EMSTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_IDLETIMEOUTMINUTES TYPE /AWS1/EMSDURATION OPTIONAL
    !IV_NAME TYPE /AWS1/EMSSTRING256 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_emsstartsessionrsp
  RAISING
    /AWS1/CX_EMSCONFLICTEXCEPTION
    /AWS1/CX_EMSINTERNALSERVEREX
    /AWS1/CX_EMSRESOURCENOTFOUNDEX
    /AWS1/CX_EMSSERVICEQUOTAEXCDEX
    /AWS1/CX_EMSVALIDATIONEX
    /AWS1/CX_EMSCLIENTEXC
    /AWS1/CX_EMSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/EMSAPPLICATIONID /AWS1/EMSAPPLICATIONID

The ID of the application on which to start the session.

iv_clienttoken TYPE /AWS1/EMSCLIENTTOKEN /AWS1/EMSCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the successful response without performing the operation again.

iv_executionrolearn TYPE /AWS1/EMSIAMROLEARN /AWS1/EMSIAMROLEARN

The execution role ARN for the session. Amazon EMR Serverless uses this role to access Amazon Web Services resources on your behalf during session execution.

Optional arguments:

io_configurationoverrides TYPE REF TO /AWS1/CL_EMSSESSIONCONFOVRDS /AWS1/CL_EMSSESSIONCONFOVRDS

The configuration overrides for the session. Only runtime configuration overrides are supported.

it_tags TYPE /AWS1/CL_EMSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags to assign to the session.

iv_idletimeoutminutes TYPE /AWS1/EMSDURATION /AWS1/EMSDURATION

The idle timeout in minutes for the session. After the session remains idle for this duration, Amazon EMR Serverless automatically terminates it.

iv_name TYPE /AWS1/EMSSTRING256 /AWS1/EMSSTRING256

The optional name for the session.

RETURNING

oo_output TYPE REF TO /aws1/cl_emsstartsessionrsp /AWS1/CL_EMSSTARTSESSIONRSP

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->startsession(
  io_configurationoverrides = new /aws1/cl_emssessionconfovrds(
    it_runtimeconfiguration = VALUE /aws1/cl_emsconfiguration=>tt_configurationlist(
      (
        new /aws1/cl_emsconfiguration(
          it_configurations = VALUE /aws1/cl_emsconfiguration=>tt_configurationlist(
          )
          it_properties = VALUE /aws1/cl_emssensitiveprpsmap_w=>tt_sensitivepropertiesmap(
            (
              VALUE /aws1/cl_emssensitiveprpsmap_w=>ts_sensitiveprpsmap_maprow(
                key = |string|
                value = new /aws1/cl_emssensitiveprpsmap_w( |string| )
              )
            )
          )
          iv_classification = |string|
        )
      )
    )
  )
  it_tags = VALUE /aws1/cl_emstagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_emstagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_emstagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_clienttoken = |string|
  iv_executionrolearn = |string|
  iv_idletimeoutminutes = 123
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_applicationid = lo_result->get_applicationid( ).
  lv_sessionid = lo_result->get_sessionid( ).
  lv_sessionarn = lo_result->get_arn( ).
ENDIF.