/AWS1/IF_APY=>UPDATEAPI()

About UpdateApi

Updates an Api.

Method Signature

METHODS /AWS1/IF_APY~UPDATEAPI
  IMPORTING
    !IV_APIID TYPE /AWS1/APYSTRING OPTIONAL
    !IV_NAME TYPE /AWS1/APYAPINAME OPTIONAL
    !IV_OWNERCONTACT TYPE /AWS1/APYSTRING OPTIONAL
    !IO_EVENTCONFIG TYPE REF TO /AWS1/CL_APYEVENTCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_apyupdateapiresponse
  RAISING
    /AWS1/CX_APYACCESSDENIEDEX
    /AWS1/CX_APYBADREQUESTEX
    /AWS1/CX_APYCONCURRENTMODEX
    /AWS1/CX_APYINTERNALFAILUREEX
    /AWS1/CX_APYNOTFOUNDEXCEPTION
    /AWS1/CX_APYUNAUTHORIZEDEX
    /AWS1/CX_APYCLIENTEXC
    /AWS1/CX_APYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_apiid TYPE /AWS1/APYSTRING /AWS1/APYSTRING

The Api ID.

iv_name TYPE /AWS1/APYAPINAME /AWS1/APYAPINAME

The name of the Api.

Optional arguments:

iv_ownercontact TYPE /AWS1/APYSTRING /AWS1/APYSTRING

The owner contact information for the Api.

io_eventconfig TYPE REF TO /AWS1/CL_APYEVENTCONFIG /AWS1/CL_APYEVENTCONFIG

The new event configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

RETURNING

oo_output TYPE REF TO /aws1/cl_apyupdateapiresponse /AWS1/CL_APYUPDATEAPIRESPONSE

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->updateapi(
  io_eventconfig = new /aws1/cl_apyeventconfig(
    io_logconfig = new /aws1/cl_apyeventlogconfig(
      iv_cloudwatchlogsrolearn = |string|
      iv_loglevel = |string|
    )
    it_authproviders = VALUE /aws1/cl_apyauthprovider=>tt_authproviders(
      (
        new /aws1/cl_apyauthprovider(
          io_cognitoconfig = new /aws1/cl_apycognitoconfig(
            iv_appidclientregex = |string|
            iv_awsregion = |string|
            iv_userpoolid = |string|
          )
          io_lambdaauthorizerconfig = new /aws1/cl_apylambdaauthrconfig(
            iv_authorizeruri = |string|
            iv_authrresultttlinseconds = 123
            iv_identityvalidationxprsn = |string|
          )
          io_openidconnectconfig = new /aws1/cl_apyopenidcnctconfig(
            iv_authttl = 123
            iv_clientid = |string|
            iv_iatttl = 123
            iv_issuer = |string|
          )
          iv_authtype = |string|
        )
      )
    )
    it_connectionauthmodes = VALUE /aws1/cl_apyauthmode=>tt_authmodes(
      ( new /aws1/cl_apyauthmode( |string| ) )
    )
    it_defaultpublishauthmodes = VALUE /aws1/cl_apyauthmode=>tt_authmodes(
      ( new /aws1/cl_apyauthmode( |string| ) )
    )
    it_defaultsubscribeauthmodes = VALUE /aws1/cl_apyauthmode=>tt_authmodes(
      ( new /aws1/cl_apyauthmode( |string| ) )
    )
  )
  iv_apiid = |string|
  iv_name = |string|
  iv_ownercontact = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_api = lo_result->get_api( ).
  IF lo_api IS NOT INITIAL.
    lv_string = lo_api->get_apiid( ).
    lv_apiname = lo_api->get_name( ).
    lv_ownercontact = lo_api->get_ownercontact( ).
    LOOP AT lo_api->get_tags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_api->get_dns( ) into ls_row_1.
      lv_key_1 = ls_row_1-key.
      lo_value_1 = ls_row_1-value.
      IF lo_value_1 IS NOT INITIAL.
        lv_string = lo_value_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_api->get_apiarn( ).
    lv_timestamp = lo_api->get_created( ).
    lv_boolean = lo_api->get_xrayenabled( ).
    lv_string = lo_api->get_wafwebaclarn( ).
    lo_eventconfig = lo_api->get_eventconfig( ).
    IF lo_eventconfig IS NOT INITIAL.
      LOOP AT lo_eventconfig->get_authproviders( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_authenticationtype = lo_row_3->get_authtype( ).
          lo_cognitoconfig = lo_row_3->get_cognitoconfig( ).
          IF lo_cognitoconfig IS NOT INITIAL.
            lv_string = lo_cognitoconfig->get_userpoolid( ).
            lv_string = lo_cognitoconfig->get_awsregion( ).
            lv_string = lo_cognitoconfig->get_appidclientregex( ).
          ENDIF.
          lo_openidconnectconfig = lo_row_3->get_openidconnectconfig( ).
          IF lo_openidconnectconfig IS NOT INITIAL.
            lv_string = lo_openidconnectconfig->get_issuer( ).
            lv_string = lo_openidconnectconfig->get_clientid( ).
            lv_long = lo_openidconnectconfig->get_iatttl( ).
            lv_long = lo_openidconnectconfig->get_authttl( ).
          ENDIF.
          lo_lambdaauthorizerconfig = lo_row_3->get_lambdaauthorizerconfig( ).
          IF lo_lambdaauthorizerconfig IS NOT INITIAL.
            lv_ttl = lo_lambdaauthorizerconfig->get_authrresultttlinseconds( ).
            lv_string = lo_lambdaauthorizerconfig->get_authorizeruri( ).
            lv_string = lo_lambdaauthorizerconfig->get_identityvalidationxprsn( ).
          ENDIF.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_eventconfig->get_connectionauthmodes( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_authenticationtype = lo_row_5->get_authtype( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_eventconfig->get_defaultpublishauthmodes( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_authenticationtype = lo_row_5->get_authtype( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_eventconfig->get_defaultsubauthmodes( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_authenticationtype = lo_row_5->get_authtype( ).
        ENDIF.
      ENDLOOP.
      lo_eventlogconfig = lo_eventconfig->get_logconfig( ).
      IF lo_eventlogconfig IS NOT INITIAL.
        lv_eventloglevel = lo_eventlogconfig->get_loglevel( ).
        lv_string = lo_eventlogconfig->get_cloudwatchlogsrolearn( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.