DESCRIBEPROXY()`¶

About DescribeProxy¶

Returns the data objects for the specified proxy.

Method Signature¶

METHODS /AWS1/IF_NWF~DESCRIBEPROXY
  IMPORTING
    !IV_PROXYNAME TYPE /AWS1/NWFRESOURCENAME OPTIONAL
    !IV_PROXYARN TYPE /AWS1/NWFRESOURCEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwfdescrproxyresponse
  RAISING
    /AWS1/CX_NWFINTERNALSERVERERR
    /AWS1/CX_NWFINVALIDREQUESTEX
    /AWS1/CX_NWFRESOURCENOTFOUNDEX
    /AWS1/CX_NWFTHROTTLINGEX
    /AWS1/CX_NWFCLIENTEXC
    /AWS1/CX_NWFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_proxyname` `TYPE /AWS1/NWFRESOURCENAME` `/AWS1/NWFRESOURCENAME`¶

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

`iv_proxyarn` `TYPE /AWS1/NWFRESOURCEARN` `/AWS1/NWFRESOURCEARN`¶

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nwfdescrproxyresponse` `/AWS1/CL_NWFDESCRPROXYRESPONSE`¶

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->describeproxy(
  iv_proxyarn = |string|
  iv_proxyname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_describeproxyresource = lo_result->get_proxy( ).
  IF lo_describeproxyresource IS NOT INITIAL.
    lv_resourcename = lo_describeproxyresource->get_proxyname( ).
    lv_resourcearn = lo_describeproxyresource->get_proxyarn( ).
    lv_resourcename = lo_describeproxyresource->get_proxyconfigurationname( ).
    lv_resourcearn = lo_describeproxyresource->get_proxyconfigurationarn( ).
    lv_natgatewayid = lo_describeproxyresource->get_natgatewayid( ).
    lv_proxystate = lo_describeproxyresource->get_proxystate( ).
    lv_proxymodifystate = lo_describeproxyresource->get_proxymodifystate( ).
    LOOP AT lo_describeproxyresource->get_listenerproperties( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_natgatewayport = lo_row_1->get_port( ).
        lv_listenerpropertytype = lo_row_1->get_type( ).
      ENDIF.
    ENDLOOP.
    lo_tlsinterceptproperties = lo_describeproxyresource->get_tlsinterceptproperties( ).
    IF lo_tlsinterceptproperties IS NOT INITIAL.
      lv_resourcearn = lo_tlsinterceptproperties->get_pcaarn( ).
      lv_tlsinterceptmode = lo_tlsinterceptproperties->get_tlsinterceptmode( ).
    ENDIF.
    lv_vpcendpointservicename = lo_describeproxyresource->get_vpcendpointservicename( ).
    lv_privatednsname = lo_describeproxyresource->get_privatednsname( ).
    lv_createtime = lo_describeproxyresource->get_createtime( ).
    lv_deletetime = lo_describeproxyresource->get_deletetime( ).
    lv_updatetime = lo_describeproxyresource->get_updatetime( ).
    lv_failurecode = lo_describeproxyresource->get_failurecode( ).
    lv_failuremessage = lo_describeproxyresource->get_failuremessage( ).
    LOOP AT lo_describeproxyresource->get_tags( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_tagkey = lo_row_3->get_key( ).
        lv_tagvalue = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_updatetoken = lo_result->get_updatetoken( ).
ENDIF.

/AWS1/IF_NWF=>DESCRIBEPROXY()¶