DESCRIBESIMULATIONJOBBATCH()`¶

About DescribeSimulationJobBatch¶

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.

Describes a simulation job batch.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_batch` `TYPE /AWS1/RBMARN` `/AWS1/RBMARN`¶

The id of the batch to describe.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rbmdscsimulationjob03` `/AWS1/CL_RBMDSCSIMULATIONJOB03`¶

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_rbm~describesimulationjobbatch( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_arn( ).
  lv_simulationjobbatchstatu = lo_result->get_status( ).
  lv_lastupdatedat = lo_result->get_lastupdatedat( ).
  lv_createdat = lo_result->get_createdat( ).
  lv_clientrequesttoken = lo_result->get_clientrequesttoken( ).
  lo_batchpolicy = lo_result->get_batchpolicy( ).
  IF lo_batchpolicy IS NOT INITIAL.
    lv_batchtimeoutinseconds = lo_batchpolicy->get_timeoutinseconds( ).
    lv_maxconcurrency = lo_batchpolicy->get_maxconcurrency( ).
  ENDIF.
  lv_simulationjobbatcherror = lo_result->get_failurecode( ).
  lv_genericstring = lo_result->get_failurereason( ).
  LOOP AT lo_result->get_failedrequests( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_simulationjobrequest = lo_row_1->get_request( ).
      IF lo_simulationjobrequest IS NOT INITIAL.
        lo_outputlocation = lo_simulationjobrequest->get_outputlocation( ).
        IF lo_outputlocation IS NOT INITIAL.
          lv_s3bucket = lo_outputlocation->get_s3bucket( ).
          lv_s3key = lo_outputlocation->get_s3prefix( ).
        ENDIF.
        lo_loggingconfig = lo_simulationjobrequest->get_loggingconfig( ).
        IF lo_loggingconfig IS NOT INITIAL.
          lv_boxedboolean = lo_loggingconfig->get_recordallrostopics( ).
        ENDIF.
        lv_jobduration = lo_simulationjobrequest->get_maxjobdurationinseconds( ).
        lv_iamrole = lo_simulationjobrequest->get_iamrole( ).
        lv_failurebehavior = lo_simulationjobrequest->get_failurebehavior( ).
        lv_boxedboolean = lo_simulationjobrequest->get_usedefaultapplications( ).
        LOOP AT lo_simulationjobrequest->get_robotapplications( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_arn = lo_row_3->get_application( ).
            lv_version = lo_row_3->get_applicationversion( ).
            lo_launchconfig = lo_row_3->get_launchconfig( ).
            IF lo_launchconfig IS NOT INITIAL.
              lv_command = lo_launchconfig->get_packagename( ).
              lv_command = lo_launchconfig->get_launchfile( ).
              LOOP AT lo_launchconfig->get_environmentvariables( ) into ls_row_4.
                lv_key = ls_row_4-key.
                lo_value = ls_row_4-value.
                IF lo_value IS NOT INITIAL.
                  lv_environmentvariablevalu = lo_value->get_value( ).
                ENDIF.
              ENDLOOP.
              lo_portforwardingconfig = lo_launchconfig->get_portforwardingconfig( ).
              IF lo_portforwardingconfig IS NOT INITIAL.
                LOOP AT lo_portforwardingconfig->get_portmappings( ) into lo_row_5.
                  lo_row_6 = lo_row_5.
                  IF lo_row_6 IS NOT INITIAL.
                    lv_port = lo_row_6->get_jobport( ).
                    lv_nonsystemport = lo_row_6->get_applicationport( ).
                    lv_boolean = lo_row_6->get_enableonpublicip( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
              lv_boolean = lo_launchconfig->get_streamui( ).
              LOOP AT lo_launchconfig->get_command( ) into lo_row_7.
                lo_row_8 = lo_row_7.
                IF lo_row_8 IS NOT INITIAL.
                  lv_nonemptystring = lo_row_8->get_value( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
            LOOP AT lo_row_3->get_uploadconfigurations( ) into lo_row_9.
              lo_row_10 = lo_row_9.
              IF lo_row_10 IS NOT INITIAL.
                lv_name = lo_row_10->get_name( ).
                lv_path = lo_row_10->get_path( ).
                lv_uploadbehavior = lo_row_10->get_uploadbehavior( ).
              ENDIF.
            ENDLOOP.
            lv_boxedboolean = lo_row_3->get_usedefaultuploadconfs( ).
            LOOP AT lo_row_3->get_tools( ) into lo_row_11.
              lo_row_12 = lo_row_11.
              IF lo_row_12 IS NOT INITIAL.
                lv_boxedboolean = lo_row_12->get_streamui( ).
                lv_name = lo_row_12->get_name( ).
                lv_unrestrictedcommand = lo_row_12->get_command( ).
                lv_boxedboolean = lo_row_12->get_streamoutputtocloudwatch( ).
                lv_exitbehavior = lo_row_12->get_exitbehavior( ).
              ENDIF.
            ENDLOOP.
            lv_boxedboolean = lo_row_3->get_usedefaulttools( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_simulationjobrequest->get_simulationapplications( ) into lo_row_13.
          lo_row_14 = lo_row_13.
          IF lo_row_14 IS NOT INITIAL.
            lv_arn = lo_row_14->get_application( ).
            lv_version = lo_row_14->get_applicationversion( ).
            lo_launchconfig = lo_row_14->get_launchconfig( ).
            IF lo_launchconfig IS NOT INITIAL.
              lv_command = lo_launchconfig->get_packagename( ).
              lv_command = lo_launchconfig->get_launchfile( ).
              LOOP AT lo_launchconfig->get_environmentvariables( ) into ls_row_4.
                lv_key = ls_row_4-key.
                lo_value = ls_row_4-value.
                IF lo_value IS NOT INITIAL.
                  lv_environmentvariablevalu = lo_value->get_value( ).
                ENDIF.
              ENDLOOP.
              lo_portforwardingconfig = lo_launchconfig->get_portforwardingconfig( ).
              IF lo_portforwardingconfig IS NOT INITIAL.
                LOOP AT lo_portforwardingconfig->get_portmappings( ) into lo_row_5.
                  lo_row_6 = lo_row_5.
                  IF lo_row_6 IS NOT INITIAL.
                    lv_port = lo_row_6->get_jobport( ).
                    lv_nonsystemport = lo_row_6->get_applicationport( ).
                    lv_boolean = lo_row_6->get_enableonpublicip( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
              lv_boolean = lo_launchconfig->get_streamui( ).
              LOOP AT lo_launchconfig->get_command( ) into lo_row_7.
                lo_row_8 = lo_row_7.
                IF lo_row_8 IS NOT INITIAL.
                  lv_nonemptystring = lo_row_8->get_value( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
            LOOP AT lo_row_14->get_uploadconfigurations( ) into lo_row_9.
              lo_row_10 = lo_row_9.
              IF lo_row_10 IS NOT INITIAL.
                lv_name = lo_row_10->get_name( ).
                lv_path = lo_row_10->get_path( ).
                lv_uploadbehavior = lo_row_10->get_uploadbehavior( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_14->get_worldconfigs( ) into lo_row_15.
              lo_row_16 = lo_row_15.
              IF lo_row_16 IS NOT INITIAL.
                lv_arn = lo_row_16->get_world( ).
              ENDIF.
            ENDLOOP.
            lv_boxedboolean = lo_row_14->get_usedefaultuploadconfs( ).
            LOOP AT lo_row_14->get_tools( ) into lo_row_11.
              lo_row_12 = lo_row_11.
              IF lo_row_12 IS NOT INITIAL.
                lv_boxedboolean = lo_row_12->get_streamui( ).
                lv_name = lo_row_12->get_name( ).
                lv_unrestrictedcommand = lo_row_12->get_command( ).
                lv_boxedboolean = lo_row_12->get_streamoutputtocloudwatch( ).
                lv_exitbehavior = lo_row_12->get_exitbehavior( ).
              ENDIF.
            ENDLOOP.
            lv_boxedboolean = lo_row_14->get_usedefaulttools( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_simulationjobrequest->get_datasources( ) into lo_row_17.
          lo_row_18 = lo_row_17.
          IF lo_row_18 IS NOT INITIAL.
            lv_name = lo_row_18->get_name( ).
            lv_s3bucket = lo_row_18->get_s3bucket( ).
            LOOP AT lo_row_18->get_s3keys( ) into lo_row_19.
              lo_row_20 = lo_row_19.
              IF lo_row_20 IS NOT INITIAL.
                lv_s3keyorprefix = lo_row_20->get_value( ).
              ENDIF.
            ENDLOOP.
            lv_datasourcetype = lo_row_18->get_type( ).
            lv_path = lo_row_18->get_destination( ).
          ENDIF.
        ENDLOOP.
        lo_vpcconfig = lo_simulationjobrequest->get_vpcconfig( ).
        IF lo_vpcconfig IS NOT INITIAL.
          LOOP AT lo_vpcconfig->get_subnets( ) into lo_row_21.
            lo_row_22 = lo_row_21.
            IF lo_row_22 IS NOT INITIAL.
              lv_nonemptystring = lo_row_22->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_vpcconfig->get_securitygroups( ) into lo_row_23.
            lo_row_24 = lo_row_23.
            IF lo_row_24 IS NOT INITIAL.
              lv_nonemptystring = lo_row_24->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_boolean = lo_vpcconfig->get_assignpublicip( ).
        ENDIF.
        lo_compute = lo_simulationjobrequest->get_compute( ).
        IF lo_compute IS NOT INITIAL.
          lv_simulationunit = lo_compute->get_simulationunitlimit( ).
          lv_computetype = lo_compute->get_computetype( ).
          lv_gpuunit = lo_compute->get_gpuunitlimit( ).
        ENDIF.
        LOOP AT lo_simulationjobrequest->get_tags( ) into ls_row_25.
          lv_key_1 = ls_row_25-key.
          lo_value_1 = ls_row_25-value.
          IF lo_value_1 IS NOT INITIAL.
            lv_tagvalue = lo_value_1->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_genericstring = lo_row_1->get_failurereason( ).
      lv_simulationjoberrorcode = lo_row_1->get_failurecode( ).
      lv_failedat = lo_row_1->get_failedat( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_pendingrequests( ) into lo_row_26.
    lo_row_27 = lo_row_26.
    IF lo_row_27 IS NOT INITIAL.
      lo_outputlocation = lo_row_27->get_outputlocation( ).
      IF lo_outputlocation IS NOT INITIAL.
        lv_s3bucket = lo_outputlocation->get_s3bucket( ).
        lv_s3key = lo_outputlocation->get_s3prefix( ).
      ENDIF.
      lo_loggingconfig = lo_row_27->get_loggingconfig( ).
      IF lo_loggingconfig IS NOT INITIAL.
        lv_boxedboolean = lo_loggingconfig->get_recordallrostopics( ).
      ENDIF.
      lv_jobduration = lo_row_27->get_maxjobdurationinseconds( ).
      lv_iamrole = lo_row_27->get_iamrole( ).
      lv_failurebehavior = lo_row_27->get_failurebehavior( ).
      lv_boxedboolean = lo_row_27->get_usedefaultapplications( ).
      LOOP AT lo_row_27->get_robotapplications( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_arn = lo_row_3->get_application( ).
          lv_version = lo_row_3->get_applicationversion( ).
          lo_launchconfig = lo_row_3->get_launchconfig( ).
          IF lo_launchconfig IS NOT INITIAL.
            lv_command = lo_launchconfig->get_packagename( ).
            lv_command = lo_launchconfig->get_launchfile( ).
            LOOP AT lo_launchconfig->get_environmentvariables( ) into ls_row_4.
              lv_key = ls_row_4-key.
              lo_value = ls_row_4-value.
              IF lo_value IS NOT INITIAL.
                lv_environmentvariablevalu = lo_value->get_value( ).
              ENDIF.
            ENDLOOP.
            lo_portforwardingconfig = lo_launchconfig->get_portforwardingconfig( ).
            IF lo_portforwardingconfig IS NOT INITIAL.
              LOOP AT lo_portforwardingconfig->get_portmappings( ) into lo_row_5.
                lo_row_6 = lo_row_5.
                IF lo_row_6 IS NOT INITIAL.
                  lv_port = lo_row_6->get_jobport( ).
                  lv_nonsystemport = lo_row_6->get_applicationport( ).
                  lv_boolean = lo_row_6->get_enableonpublicip( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
            lv_boolean = lo_launchconfig->get_streamui( ).
            LOOP AT lo_launchconfig->get_command( ) into lo_row_7.
              lo_row_8 = lo_row_7.
              IF lo_row_8 IS NOT INITIAL.
                lv_nonemptystring = lo_row_8->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
          LOOP AT lo_row_3->get_uploadconfigurations( ) into lo_row_9.
            lo_row_10 = lo_row_9.
            IF lo_row_10 IS NOT INITIAL.
              lv_name = lo_row_10->get_name( ).
              lv_path = lo_row_10->get_path( ).
              lv_uploadbehavior = lo_row_10->get_uploadbehavior( ).
            ENDIF.
          ENDLOOP.
          lv_boxedboolean = lo_row_3->get_usedefaultuploadconfs( ).
          LOOP AT lo_row_3->get_tools( ) into lo_row_11.
            lo_row_12 = lo_row_11.
            IF lo_row_12 IS NOT INITIAL.
              lv_boxedboolean = lo_row_12->get_streamui( ).
              lv_name = lo_row_12->get_name( ).
              lv_unrestrictedcommand = lo_row_12->get_command( ).
              lv_boxedboolean = lo_row_12->get_streamoutputtocloudwatch( ).
              lv_exitbehavior = lo_row_12->get_exitbehavior( ).
            ENDIF.
          ENDLOOP.
          lv_boxedboolean = lo_row_3->get_usedefaulttools( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_27->get_simulationapplications( ) into lo_row_13.
        lo_row_14 = lo_row_13.
        IF lo_row_14 IS NOT INITIAL.
          lv_arn = lo_row_14->get_application( ).
          lv_version = lo_row_14->get_applicationversion( ).
          lo_launchconfig = lo_row_14->get_launchconfig( ).
          IF lo_launchconfig IS NOT INITIAL.
            lv_command = lo_launchconfig->get_packagename( ).
            lv_command = lo_launchconfig->get_launchfile( ).
            LOOP AT lo_launchconfig->get_environmentvariables( ) into ls_row_4.
              lv_key = ls_row_4-key.
              lo_value = ls_row_4-value.
              IF lo_value IS NOT INITIAL.
                lv_environmentvariablevalu = lo_value->get_value( ).
              ENDIF.
            ENDLOOP.
            lo_portforwardingconfig = lo_launchconfig->get_portforwardingconfig( ).
            IF lo_portforwardingconfig IS NOT INITIAL.
              LOOP AT lo_portforwardingconfig->get_portmappings( ) into lo_row_5.
                lo_row_6 = lo_row_5.
                IF lo_row_6 IS NOT INITIAL.
                  lv_port = lo_row_6->get_jobport( ).
                  lv_nonsystemport = lo_row_6->get_applicationport( ).
                  lv_boolean = lo_row_6->get_enableonpublicip( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
            lv_boolean = lo_launchconfig->get_streamui( ).
            LOOP AT lo_launchconfig->get_command( ) into lo_row_7.
              lo_row_8 = lo_row_7.
              IF lo_row_8 IS NOT INITIAL.
                lv_nonemptystring = lo_row_8->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
          LOOP AT lo_row_14->get_uploadconfigurations( ) into lo_row_9.
            lo_row_10 = lo_row_9.
            IF lo_row_10 IS NOT INITIAL.
              lv_name = lo_row_10->get_name( ).
              lv_path = lo_row_10->get_path( ).
              lv_uploadbehavior = lo_row_10->get_uploadbehavior( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_row_14->get_worldconfigs( ) into lo_row_15.
            lo_row_16 = lo_row_15.
            IF lo_row_16 IS NOT INITIAL.
              lv_arn = lo_row_16->get_world( ).
            ENDIF.
          ENDLOOP.
          lv_boxedboolean = lo_row_14->get_usedefaultuploadconfs( ).
          LOOP AT lo_row_14->get_tools( ) into lo_row_11.
            lo_row_12 = lo_row_11.
            IF lo_row_12 IS NOT INITIAL.
              lv_boxedboolean = lo_row_12->get_streamui( ).
              lv_name = lo_row_12->get_name( ).
              lv_unrestrictedcommand = lo_row_12->get_command( ).
              lv_boxedboolean = lo_row_12->get_streamoutputtocloudwatch( ).
              lv_exitbehavior = lo_row_12->get_exitbehavior( ).
            ENDIF.
          ENDLOOP.
          lv_boxedboolean = lo_row_14->get_usedefaulttools( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_27->get_datasources( ) into lo_row_17.
        lo_row_18 = lo_row_17.
        IF lo_row_18 IS NOT INITIAL.
          lv_name = lo_row_18->get_name( ).
          lv_s3bucket = lo_row_18->get_s3bucket( ).
          LOOP AT lo_row_18->get_s3keys( ) into lo_row_19.
            lo_row_20 = lo_row_19.
            IF lo_row_20 IS NOT INITIAL.
              lv_s3keyorprefix = lo_row_20->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_datasourcetype = lo_row_18->get_type( ).
          lv_path = lo_row_18->get_destination( ).
        ENDIF.
      ENDLOOP.
      lo_vpcconfig = lo_row_27->get_vpcconfig( ).
      IF lo_vpcconfig IS NOT INITIAL.
        LOOP AT lo_vpcconfig->get_subnets( ) into lo_row_21.
          lo_row_22 = lo_row_21.
          IF lo_row_22 IS NOT INITIAL.
            lv_nonemptystring = lo_row_22->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_vpcconfig->get_securitygroups( ) into lo_row_23.
          lo_row_24 = lo_row_23.
          IF lo_row_24 IS NOT INITIAL.
            lv_nonemptystring = lo_row_24->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_boolean = lo_vpcconfig->get_assignpublicip( ).
      ENDIF.
      lo_compute = lo_row_27->get_compute( ).
      IF lo_compute IS NOT INITIAL.
        lv_simulationunit = lo_compute->get_simulationunitlimit( ).
        lv_computetype = lo_compute->get_computetype( ).
        lv_gpuunit = lo_compute->get_gpuunitlimit( ).
      ENDIF.
      LOOP AT lo_row_27->get_tags( ) into ls_row_25.
        lv_key_1 = ls_row_25-key.
        lo_value_1 = ls_row_25-value.
        IF lo_value_1 IS NOT INITIAL.
          lv_tagvalue = lo_value_1->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_createdrequests( ) into lo_row_28.
    lo_row_29 = lo_row_28.
    IF lo_row_29 IS NOT INITIAL.
      lv_arn = lo_row_29->get_arn( ).
      lv_lastupdatedat = lo_row_29->get_lastupdatedat( ).
      lv_name = lo_row_29->get_name( ).
      lv_simulationjobstatus = lo_row_29->get_status( ).
      LOOP AT lo_row_29->get_simulationapplicationn00( ) into lo_row_30.
        lo_row_31 = lo_row_30.
        IF lo_row_31 IS NOT INITIAL.
          lv_name = lo_row_31->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_29->get_robotapplicationnames( ) into lo_row_32.
        lo_row_33 = lo_row_32.
        IF lo_row_33 IS NOT INITIAL.
          lv_name = lo_row_33->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_29->get_datasourcenames( ) into lo_row_34.
        lo_row_35 = lo_row_34.
        IF lo_row_35 IS NOT INITIAL.
          lv_name = lo_row_35->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_computetype = lo_row_29->get_computetype( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_tags( ) into ls_row_25.
    lv_key_1 = ls_row_25-key.
    lo_value_1 = ls_row_25-value.
    IF lo_value_1 IS NOT INITIAL.
      lv_tagvalue = lo_value_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/CL_RBM=>DESCRIBESIMULATIONJOBBATCH()¶