DESCRIBEWORLDGENERATIONJOB()`¶

About DescribeWorldGenerationJob¶

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 world generation job.

Method Signature¶

METHODS /AWS1/IF_RBM~DESCRIBEWORLDGENERATIONJOB
  IMPORTING
    !IV_JOB TYPE /AWS1/RBMARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rbmdscworldgenerati01
  RAISING
    /AWS1/CX_RBMINTERNALSERVEREX
    /AWS1/CX_RBMINVALIDPARAMETEREX
    /AWS1/CX_RBMRESOURCENOTFOUNDEX
    /AWS1/CX_RBMTHROTTLINGEX
    /AWS1/CX_RBMCLIENTEXC
    /AWS1/CX_RBMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_job` `TYPE /AWS1/RBMARN` `/AWS1/RBMARN`¶

The Amazon Resource Name (arn) of the world generation job to describe.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rbmdscworldgenerati01` `/AWS1/CL_RBMDSCWORLDGENERATI01`¶

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->describeworldgenerationjob( |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_worldgenerationjobstatu = lo_result->get_status( ).
  lv_createdat = lo_result->get_createdat( ).
  lv_worldgenerationjoberror = lo_result->get_failurecode( ).
  lv_genericstring = lo_result->get_failurereason( ).
  lv_clientrequesttoken = lo_result->get_clientrequesttoken( ).
  lv_arn = lo_result->get_template( ).
  lo_worldcount = lo_result->get_worldcount( ).
  IF lo_worldcount IS NOT INITIAL.
    lv_floorplancount = lo_worldcount->get_floorplancount( ).
    lv_interiorcountperfloorpl = lo_worldcount->get_interiorcntperfloorplan( ).
  ENDIF.
  lo_finishedworldssummary = lo_result->get_finishedworldssummary( ).
  IF lo_finishedworldssummary IS NOT INITIAL.
    lv_integer = lo_finishedworldssummary->get_finishedcount( ).
    LOOP AT lo_finishedworldssummary->get_succeededworlds( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_arn = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lo_failuresummary = lo_finishedworldssummary->get_failuresummary( ).
    IF lo_failuresummary IS NOT INITIAL.
      lv_integer = lo_failuresummary->get_totalfailurecount( ).
      LOOP AT lo_failuresummary->get_failures( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_worldgenerationjoberror = lo_row_3->get_failurecode( ).
          lv_genericstring = lo_row_3->get_samplefailurereason( ).
          lv_integer = lo_row_3->get_failurecount( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
  LOOP AT lo_result->get_tags( ) into ls_row_4.
    lv_key = ls_row_4-key.
    lo_value = ls_row_4-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_worldtags( ) into ls_row_4.
    lv_key = ls_row_4-key.
    lo_value = ls_row_4-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_RBM=>DESCRIBEWORLDGENERATIONJOB()¶