DESCRIBEWEBAPP()`¶

About DescribeWebApp¶

Describes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted.

For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Method Signature¶

METHODS /AWS1/IF_TRN~DESCRIBEWEBAPP
  IMPORTING
    !IV_WEBAPPID TYPE /AWS1/TRNWEBAPPID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trndescrwebapprsp
  RAISING
    /AWS1/CX_TRNACCESSDENIEDEX
    /AWS1/CX_TRNINTERNALSVCERROR
    /AWS1/CX_TRNINVALIDREQUESTEX
    /AWS1/CX_TRNRESOURCENOTFOUNDEX
    /AWS1/CX_TRNTHROTTLINGEX
    /AWS1/CX_TRNCLIENTEXC
    /AWS1/CX_TRNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_webappid` `TYPE /AWS1/TRNWEBAPPID` `/AWS1/TRNWEBAPPID`¶

Provide the unique identifier for the web app.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trndescrwebapprsp` `/AWS1/CL_TRNDESCRWEBAPPRSP`¶

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->describewebapp( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_describedwebapp = lo_result->get_webapp( ).
  IF lo_describedwebapp IS NOT INITIAL.
    lv_arn = lo_describedwebapp->get_arn( ).
    lv_webappid = lo_describedwebapp->get_webappid( ).
    lo_describedwebappidentity = lo_describedwebapp->get_descrdidpvdrdetails( ).
    IF lo_describedwebappidentity IS NOT INITIAL.
      lo_describedidentitycenter = lo_describedwebappidentity->get_identitycenterconfig( ).
      IF lo_describedidentitycenter IS NOT INITIAL.
        lv_identitycenterapplicati = lo_describedidentitycenter->get_applicationarn( ).
        lv_identitycenterinstancea = lo_describedidentitycenter->get_instancearn( ).
        lv_role = lo_describedidentitycenter->get_role( ).
      ENDIF.
    ENDIF.
    lv_webappaccessendpoint = lo_describedwebapp->get_accessendpoint( ).
    lv_webappendpoint = lo_describedwebapp->get_webappendpoint( ).
    lo_webappunits = lo_describedwebapp->get_webappunits( ).
    IF lo_webappunits IS NOT INITIAL.
      lv_webappunitcount = lo_webappunits->get_provisioned( ).
    ENDIF.
    LOOP AT lo_describedwebapp->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tagkey = lo_row_1->get_key( ).
        lv_tagvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_webappendpointpolicy = lo_describedwebapp->get_webappendpointpolicy( ).
    lv_webappendpointtype = lo_describedwebapp->get_endpointtype( ).
    lo_describedwebappendpoint = lo_describedwebapp->get_describedendpointdetails( ).
    IF lo_describedwebappendpoint IS NOT INITIAL.
      lo_describedwebappvpcconfi = lo_describedwebappendpoint->get_vpc( ).
      IF lo_describedwebappvpcconfi IS NOT INITIAL.
        LOOP AT lo_describedwebappvpcconfi->get_subnetids( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_subnetid = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_vpcid = lo_describedwebappvpcconfi->get_vpcid( ).
        lv_vpcendpointid = lo_describedwebappvpcconfi->get_vpcendpointid( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_TRN=>DESCRIBEWEBAPP()¶