Skip to content

/AWS1/IF_ECS=>DESCREXPRESSGATEWAYSERVICE()

About DescribeExpressGatewayService

Retrieves detailed information about an Express service, including current status, configuration, managed infrastructure, and service revisions.

Returns comprehensive service details, active service revisions, ingress paths with endpoints, and managed Amazon Web Services resource status including load balancers and auto-scaling policies.

Use the include parameter to retrieve additional information such as resource tags.

Method Signature

METHODS /AWS1/IF_ECS~DESCREXPRESSGATEWAYSERVICE
  IMPORTING
    !IV_SERVICEARN TYPE /AWS1/ECSSTRING OPTIONAL
    !IT_INCLUDE TYPE /AWS1/CL_ECSEXPRESSGWSVCINCL00=>TT_EXPRESSGWSVCINCLUDELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecsdscexpressgwsvcrsp
  RAISING
    /AWS1/CX_ECSACCESSDENIEDEX
    /AWS1/CX_ECSCLIENTEXCEPTION
    /AWS1/CX_ECSCLUSTERNOTFOUNDEX
    /AWS1/CX_ECSINVALIDPARAMETEREX
    /AWS1/CX_ECSRESOURCENOTFOUNDEX
    /AWS1/CX_ECSSERVEREXCEPTION
    /AWS1/CX_ECSUNSUPPEDFEATUREEX
    /AWS1/CX_ECSCLIENTEXC
    /AWS1/CX_ECSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_servicearn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Amazon Resource Name (ARN) of the Express service to describe. The ARN uniquely identifies the service within your Amazon Web Services account and region.

Optional arguments:

it_include TYPE /AWS1/CL_ECSEXPRESSGWSVCINCL00=>TT_EXPRESSGWSVCINCLUDELIST TT_EXPRESSGWSVCINCLUDELIST

Specifies additional information to include in the response. Valid values are TAGS to include resource tags associated with the Express service.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecsdscexpressgwsvcrsp /AWS1/CL_ECSDSCEXPRESSGWSVCRSP

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->descrexpressgatewayservice(
  it_include = VALUE /aws1/cl_ecsexpressgwsvcincl00=>tt_expressgwsvcincludelist(
    ( new /aws1/cl_ecsexpressgwsvcincl00( |string| ) )
  )
  iv_servicearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ecsexpressgatewayservic = lo_result->get_service( ).
  IF lo_ecsexpressgatewayservic IS NOT INITIAL.
    lv_string = lo_ecsexpressgatewayservic->get_cluster( ).
    lv_string = lo_ecsexpressgatewayservic->get_servicename( ).
    lv_string = lo_ecsexpressgatewayservic->get_servicearn( ).
    lv_string = lo_ecsexpressgatewayservic->get_infrastructurerolearn( ).
    lo_expressgatewayservicest = lo_ecsexpressgatewayservic->get_status( ).
    IF lo_expressgatewayservicest IS NOT INITIAL.
      lv_expressgatewayservicest_1 = lo_expressgatewayservicest->get_statuscode( ).
      lv_string = lo_expressgatewayservicest->get_statusreason( ).
    ENDIF.
    lv_string = lo_ecsexpressgatewayservic->get_currentdeployment( ).
    LOOP AT lo_ecsexpressgatewayservic->get_activeconfigurations( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_servicerevisionarn( ).
        lv_string = lo_row_1->get_executionrolearn( ).
        lv_string = lo_row_1->get_taskrolearn( ).
        lv_string = lo_row_1->get_cpu( ).
        lv_string = lo_row_1->get_memory( ).
        lo_expressgatewayservicene = lo_row_1->get_networkconfiguration( ).
        IF lo_expressgatewayservicene IS NOT INITIAL.
          LOOP AT lo_expressgatewayservicene->get_securitygroups( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_string = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_expressgatewayservicene->get_subnets( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_string = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        lv_string = lo_row_1->get_healthcheckpath( ).
        lo_expressgatewaycontainer = lo_row_1->get_primarycontainer( ).
        IF lo_expressgatewaycontainer IS NOT INITIAL.
          lv_string = lo_expressgatewaycontainer->get_image( ).
          lv_boxedinteger = lo_expressgatewaycontainer->get_containerport( ).
          lo_expressgatewayserviceaw = lo_expressgatewaycontainer->get_awslogsconfiguration( ).
          IF lo_expressgatewayserviceaw IS NOT INITIAL.
            lv_string = lo_expressgatewayserviceaw->get_loggroup( ).
            lv_string = lo_expressgatewayserviceaw->get_logstreamprefix( ).
          ENDIF.
          lo_expressgatewayrepositor = lo_expressgatewaycontainer->get_repositorycredentials( ).
          IF lo_expressgatewayrepositor IS NOT INITIAL.
            lv_string = lo_expressgatewayrepositor->get_credentialsparameter( ).
          ENDIF.
          LOOP AT lo_expressgatewaycontainer->get_command( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_string = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_expressgatewaycontainer->get_environment( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_name( ).
              lv_string = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_expressgatewaycontainer->get_secrets( ) into lo_row_6.
            lo_row_7 = lo_row_6.
            IF lo_row_7 IS NOT INITIAL.
              lv_string = lo_row_7->get_name( ).
              lv_string = lo_row_7->get_valuefrom( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        lo_expressgatewayscalingta = lo_row_1->get_scalingtarget( ).
        IF lo_expressgatewayscalingta IS NOT INITIAL.
          lv_boxedinteger = lo_expressgatewayscalingta->get_mintaskcount( ).
          lv_boxedinteger = lo_expressgatewayscalingta->get_maxtaskcount( ).
          lv_expressgatewayservicesc = lo_expressgatewayscalingta->get_autoscalingmetric( ).
          lv_boxedinteger = lo_expressgatewayscalingta->get_autoscalingtargetvalue( ).
        ENDIF.
        LOOP AT lo_row_1->get_ingresspaths( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_accesstype = lo_row_9->get_accesstype( ).
            lv_string = lo_row_9->get_endpoint( ).
          ENDIF.
        ENDLOOP.
        lv_timestamp = lo_row_1->get_createdat( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_ecsexpressgatewayservic->get_tags( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_tagkey = lo_row_11->get_key( ).
        lv_tagvalue = lo_row_11->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_timestamp = lo_ecsexpressgatewayservic->get_createdat( ).
    lv_timestamp = lo_ecsexpressgatewayservic->get_updatedat( ).
  ENDIF.
ENDIF.