Skip to content

/AWS1/IF_AG2=>UPDATEROUTE()

About UpdateRoute

Updates a Route.

Method Signature

METHODS /AWS1/IF_AG2~UPDATEROUTE
  IMPORTING
    !IV_APIID TYPE /AWS1/AG2__STRING OPTIONAL
    !IV_APIKEYREQUIRED TYPE /AWS1/AG2__BOOLEAN OPTIONAL
    !IT_AUTHORIZATIONSCOPES TYPE /AWS1/CL_AG2AUTHSCOPES_W=>TT_AUTHORIZATIONSCOPES OPTIONAL
    !IV_AUTHORIZATIONTYPE TYPE /AWS1/AG2AUTHORIZATIONTYPE OPTIONAL
    !IV_AUTHORIZERID TYPE /AWS1/AG2ID OPTIONAL
    !IV_MODELSELECTIONEXPRESSION TYPE /AWS1/AG2SELECTIONEXPRESSION OPTIONAL
    !IV_OPERATIONNAME TYPE /AWS1/AG2STRWLENGTHBETWEEN1A00 OPTIONAL
    !IT_REQUESTMODELS TYPE /AWS1/CL_AG2ROUTEMODELS_W=>TT_ROUTEMODELS OPTIONAL
    !IT_REQUESTPARAMETERS TYPE /AWS1/CL_AG2PARAMETERCNSTRNTS=>TT_ROUTEPARAMETERS OPTIONAL
    !IV_ROUTEID TYPE /AWS1/AG2__STRING OPTIONAL
    !IV_ROUTEKEY TYPE /AWS1/AG2SELECTIONKEY OPTIONAL
    !IV_ROUTERSPSELECTIONXPRSN TYPE /AWS1/AG2SELECTIONEXPRESSION OPTIONAL
    !IV_TARGET TYPE /AWS1/AG2STRWLENGTHBETWEEN1A01 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ag2updaterouteresult
  RAISING
    /AWS1/CX_AG2BADREQUESTEX
    /AWS1/CX_AG2CONFLICTEXCEPTION
    /AWS1/CX_AG2NOTFOUNDEXCEPTION
    /AWS1/CX_AG2TOOMANYREQUESTSEX
    /AWS1/CX_AG2CLIENTEXC
    /AWS1/CX_AG2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_apiid TYPE /AWS1/AG2__STRING /AWS1/AG2__STRING

The API identifier.

iv_routeid TYPE /AWS1/AG2__STRING /AWS1/AG2__STRING

The route ID.

Optional arguments:

iv_apikeyrequired TYPE /AWS1/AG2__BOOLEAN /AWS1/AG2__BOOLEAN

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

it_authorizationscopes TYPE /AWS1/CL_AG2AUTHSCOPES_W=>TT_AUTHORIZATIONSCOPES TT_AUTHORIZATIONSCOPES

The authorization scopes supported by this route.

iv_authorizationtype TYPE /AWS1/AG2AUTHORIZATIONTYPE /AWS1/AG2AUTHORIZATIONTYPE

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

iv_authorizerid TYPE /AWS1/AG2ID /AWS1/AG2ID

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

iv_modelselectionexpression TYPE /AWS1/AG2SELECTIONEXPRESSION /AWS1/AG2SELECTIONEXPRESSION

The model selection expression for the route. Supported only for WebSocket APIs.

iv_operationname TYPE /AWS1/AG2STRWLENGTHBETWEEN1A00 /AWS1/AG2STRWLENGTHBETWEEN1A00

The operation name for the route.

it_requestmodels TYPE /AWS1/CL_AG2ROUTEMODELS_W=>TT_ROUTEMODELS TT_ROUTEMODELS

The request models for the route. Supported only for WebSocket APIs.

it_requestparameters TYPE /AWS1/CL_AG2PARAMETERCNSTRNTS=>TT_ROUTEPARAMETERS TT_ROUTEPARAMETERS

The request parameters for the route. Supported only for WebSocket APIs.

iv_routekey TYPE /AWS1/AG2SELECTIONKEY /AWS1/AG2SELECTIONKEY

The route key for the route.

iv_routerspselectionxprsn TYPE /AWS1/AG2SELECTIONEXPRESSION /AWS1/AG2SELECTIONEXPRESSION

The route response selection expression for the route. Supported only for WebSocket APIs.

iv_target TYPE /AWS1/AG2STRWLENGTHBETWEEN1A01 /AWS1/AG2STRWLENGTHBETWEEN1A01

The target for the route.

RETURNING

oo_output TYPE REF TO /aws1/cl_ag2updaterouteresult /AWS1/CL_AG2UPDATEROUTERESULT

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->updateroute(
  it_authorizationscopes = VALUE /aws1/cl_ag2authscopes_w=>tt_authorizationscopes(
    ( new /aws1/cl_ag2authscopes_w( |string| ) )
  )
  it_requestmodels = VALUE /aws1/cl_ag2routemodels_w=>tt_routemodels(
    (
      VALUE /aws1/cl_ag2routemodels_w=>ts_routemodels_maprow(
        value = new /aws1/cl_ag2routemodels_w( |string| )
        key = |string|
      )
    )
  )
  it_requestparameters = VALUE /aws1/cl_ag2parametercnstrnts=>tt_routeparameters(
    (
      VALUE /aws1/cl_ag2parametercnstrnts=>ts_routeparameters_maprow(
        key = |string|
        value = new /aws1/cl_ag2parametercnstrnts( ABAP_TRUE )
      )
    )
  )
  iv_apiid = |string|
  iv_apikeyrequired = ABAP_TRUE
  iv_authorizationtype = |string|
  iv_authorizerid = |string|
  iv_modelselectionexpression = |string|
  iv_operationname = |string|
  iv_routeid = |string|
  iv_routekey = |string|
  iv_routerspselectionxprsn = |string|
  iv_target = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv___boolean = lo_result->get_apigatewaymanaged( ).
  lv___boolean = lo_result->get_apikeyrequired( ).
  LOOP AT lo_result->get_authorizationscopes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_stringwithlengthbetween = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_authorizationtype = lo_result->get_authorizationtype( ).
  lv_id = lo_result->get_authorizerid( ).
  lv_selectionexpression = lo_result->get_modelselectionexpression( ).
  lv_stringwithlengthbetween = lo_result->get_operationname( ).
  LOOP AT lo_result->get_requestmodels( ) into ls_row_2.
    lv_key = ls_row_2-key.
    lo_value = ls_row_2-value.
    IF lo_value IS NOT INITIAL.
      lv_stringwithlengthbetween_1 = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_requestparameters( ) into ls_row_3.
    lv_key = ls_row_3-key.
    lo_value_1 = ls_row_3-value.
    IF lo_value_1 IS NOT INITIAL.
      lv___boolean = lo_value_1->get_required( ).
    ENDIF.
  ENDLOOP.
  lv_id = lo_result->get_routeid( ).
  lv_selectionkey = lo_result->get_routekey( ).
  lv_selectionexpression = lo_result->get_routerspselectionxprsn( ).
  lv_stringwithlengthbetween_1 = lo_result->get_target( ).
ENDIF.