Skip to content

/AWS1/CL_EMR=>LISTSTEPS()

About ListSteps

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve.

Method Signature

IMPORTING

Required arguments:

iv_clusterid TYPE /AWS1/EMRCLUSTERID /AWS1/EMRCLUSTERID

The identifier of the cluster for which to list the steps.

Optional arguments:

it_stepstates TYPE /AWS1/CL_EMRSTEPSTATELIST_W=>TT_STEPSTATELIST TT_STEPSTATELIST

The filter to limit the step list based on certain states.

it_stepids TYPE /AWS1/CL_EMRXMLSTRINGLIST_W=>TT_XMLSTRINGLIST TT_XMLSTRINGLIST

The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.

iv_marker TYPE /AWS1/EMRMARKER /AWS1/EMRMARKER

The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_emrliststepsoutput /AWS1/CL_EMRLISTSTEPSOUTPUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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->/aws1/if_emr~liststeps(
  it_stepids = VALUE /aws1/cl_emrxmlstringlist_w=>tt_xmlstringlist(
    ( new /aws1/cl_emrxmlstringlist_w( |string| ) )
  )
  it_stepstates = VALUE /aws1/cl_emrstepstatelist_w=>tt_stepstatelist(
    ( new /aws1/cl_emrstepstatelist_w( |string| ) )
  )
  iv_clusterid = |string|
  iv_marker = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_steps( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_stepid = lo_row_1->get_id( ).
      lv_string = lo_row_1->get_name( ).
      lo_hadoopstepconfig = lo_row_1->get_config( ).
      IF lo_hadoopstepconfig IS NOT INITIAL.
        lv_string = lo_hadoopstepconfig->get_jar( ).
        LOOP AT lo_hadoopstepconfig->get_properties( ) into ls_row_2.
          lv_key = ls_row_2-key.
          lo_value = ls_row_2-value.
          IF lo_value IS NOT INITIAL.
            lv_string = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_string = lo_hadoopstepconfig->get_mainclass( ).
        LOOP AT lo_hadoopstepconfig->get_args( ) into lo_row_3.
          lo_row_4 = lo_row_3.
          IF lo_row_4 IS NOT INITIAL.
            lv_string = lo_row_4->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_actiononfailure = lo_row_1->get_actiononfailure( ).
      lo_stepstatus = lo_row_1->get_status( ).
      IF lo_stepstatus IS NOT INITIAL.
        lv_stepstate = lo_stepstatus->get_state( ).
        lo_stepstatechangereason = lo_stepstatus->get_statechangereason( ).
        IF lo_stepstatechangereason IS NOT INITIAL.
          lv_stepstatechangereasonco = lo_stepstatechangereason->get_code( ).
          lv_string = lo_stepstatechangereason->get_message( ).
        ENDIF.
        lo_failuredetails = lo_stepstatus->get_failuredetails( ).
        IF lo_failuredetails IS NOT INITIAL.
          lv_string = lo_failuredetails->get_reason( ).
          lv_string = lo_failuredetails->get_message( ).
          lv_string = lo_failuredetails->get_logfile( ).
        ENDIF.
        lo_steptimeline = lo_stepstatus->get_timeline( ).
        IF lo_steptimeline IS NOT INITIAL.
          lv_date = lo_steptimeline->get_creationdatetime( ).
          lv_date = lo_steptimeline->get_startdatetime( ).
          lv_date = lo_steptimeline->get_enddatetime( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_marker = lo_result->get_marker( ).
ENDIF.