DESCRIBECOMPUTEENVIRONMENTS()`¶

About DescribeComputeEnvironments¶

Describes one or more of your compute environments.

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you launch your Amazon ECS container instances into.

Method Signature¶

METHODS /AWS1/IF_BTC~DESCRIBECOMPUTEENVIRONMENTS
  IMPORTING
    !IT_COMPUTEENVIRONMENTS TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BTCINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BTCSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btcdsccomputeenviro01
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_computeenvironments` `TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST` `TT_STRINGLIST`¶

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

`iv_maxresults` `TYPE /AWS1/BTCINTEGER` `/AWS1/BTCINTEGER`¶

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

`iv_nexttoken` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_btcdsccomputeenviro01` `/AWS1/CL_BTCDSCCOMPUTEENVIRO01`¶

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->describecomputeenvironments(
  it_computeenvironments = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
    ( new /aws1/cl_btcstringlist_w( |string| ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |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_computeenvironments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_computeenvironmentname( ).
      lv_string = lo_row_1->get_computeenvironmentarn( ).
      lv_integer = lo_row_1->get_unmanagedvcpus( ).
      lv_string = lo_row_1->get_ecsclusterarn( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_cetype = lo_row_1->get_type( ).
      lv_cestate = lo_row_1->get_state( ).
      lv_cestatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusreason( ).
      lo_computeresource = lo_row_1->get_computeresources( ).
      IF lo_computeresource IS NOT INITIAL.
        lv_crtype = lo_computeresource->get_type( ).
        lv_crallocationstrategy = lo_computeresource->get_allocationstrategy( ).
        lv_integer = lo_computeresource->get_minvcpus( ).
        lv_integer = lo_computeresource->get_maxvcpus( ).
        lv_integer = lo_computeresource->get_desiredvcpus( ).
        LOOP AT lo_computeresource->get_instancetypes( ) 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.
        lv_string = lo_computeresource->get_imageid( ).
        LOOP AT lo_computeresource->get_subnets( ) 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.
        LOOP AT lo_computeresource->get_securitygroupids( ) 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.
        lv_string = lo_computeresource->get_ec2keypair( ).
        lv_string = lo_computeresource->get_instancerole( ).
        LOOP AT lo_computeresource->get_tags( ) into ls_row_5.
          lv_key_1 = ls_row_5-key.
          lo_value_1 = ls_row_5-value.
          IF lo_value_1 IS NOT INITIAL.
            lv_string = lo_value_1->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_string = lo_computeresource->get_placementgroup( ).
        lv_integer = lo_computeresource->get_bidpercentage( ).
        lv_string = lo_computeresource->get_spotiamfleetrole( ).
        lo_launchtemplatespecifica = lo_computeresource->get_launchtemplate( ).
        IF lo_launchtemplatespecifica IS NOT INITIAL.
          lv_string = lo_launchtemplatespecifica->get_launchtemplateid( ).
          lv_string = lo_launchtemplatespecifica->get_launchtemplatename( ).
          lv_string = lo_launchtemplatespecifica->get_version( ).
          LOOP AT lo_launchtemplatespecifica->get_overrides( ) into lo_row_6.
            lo_row_7 = lo_row_6.
            IF lo_row_7 IS NOT INITIAL.
              lv_string = lo_row_7->get_launchtemplateid( ).
              lv_string = lo_row_7->get_launchtemplatename( ).
              lv_string = lo_row_7->get_version( ).
              LOOP AT lo_row_7->get_targetinstancetypes( ) 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.
              lv_userdatatype = lo_row_7->get_userdatatype( ).
            ENDIF.
          ENDLOOP.
          lv_userdatatype = lo_launchtemplatespecifica->get_userdatatype( ).
        ENDIF.
        LOOP AT lo_computeresource->get_ec2configuration( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_imagetype = lo_row_9->get_imagetype( ).
            lv_imageidoverride = lo_row_9->get_imageidoverride( ).
            lv_kubernetesversion = lo_row_9->get_imagekubernetesversion( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_string = lo_row_1->get_servicerole( ).
      lo_updatepolicy = lo_row_1->get_updatepolicy( ).
      IF lo_updatepolicy IS NOT INITIAL.
        lv_boolean = lo_updatepolicy->get_terminatejobsonupdate( ).
        lv_jobexecutiontimeoutminu = lo_updatepolicy->get_jobexectimeoutminutes( ).
      ENDIF.
      lo_eksconfiguration = lo_row_1->get_eksconfiguration( ).
      IF lo_eksconfiguration IS NOT INITIAL.
        lv_string = lo_eksconfiguration->get_eksclusterarn( ).
        lv_string = lo_eksconfiguration->get_kubernetesnamespace( ).
      ENDIF.
      lv_orchestrationtype = lo_row_1->get_containerorchestration00( ).
      lv_string = lo_row_1->get_uuid( ).
      lv_string = lo_row_1->get_context( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To describe a compute environment¶

This example describes the P2OnDemand compute environment.

DATA(lo_result) = lo_client->describecomputeenvironments(
  it_computeenvironments = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
    ( new /aws1/cl_btcstringlist_w( |P2OnDemand| ) )
  )
).

/AWS1/IF_BTC=>DESCRIBECOMPUTEENVIRONMENTS()¶