Skip to content

/AWS1/IF_AG2=>CREATEPORTAL()

About CreatePortal

Creates a portal.

Method Signature

METHODS /AWS1/IF_AG2~CREATEPORTAL
  IMPORTING
    !IO_AUTHORIZATION TYPE REF TO /AWS1/CL_AG2AUTHORIZATION OPTIONAL
    !IO_ENDPOINTCONFIGURATION TYPE REF TO /AWS1/CL_AG2ENDPTCONFREQUEST OPTIONAL
    !IT_INCLUDEDPORTALPRODUCTARNS TYPE /AWS1/CL_AG2__LSTOF__STRMIN200=>TT___LISTOF__STRMIN20MAX2048 OPTIONAL
    !IV_LOGOURI TYPE /AWS1/AG2__STRINGMIN0MAX1092 OPTIONAL
    !IO_PORTALCONTENT TYPE REF TO /AWS1/CL_AG2PORTALCONTENT OPTIONAL
    !IV_RUMAPPMONITORNAME TYPE /AWS1/AG2__STRINGMIN0MAX255 OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_AG2TAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ag2createportalrsp
  RAISING
    /AWS1/CX_AG2ACCESSDENIEDEX
    /AWS1/CX_AG2BADREQUESTEX
    /AWS1/CX_AG2TOOMANYREQUESTSEX
    /AWS1/CX_AG2CLIENTEXC
    /AWS1/CX_AG2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_authorization TYPE REF TO /AWS1/CL_AG2AUTHORIZATION /AWS1/CL_AG2AUTHORIZATION

The authentication configuration for the portal.

io_endpointconfiguration TYPE REF TO /AWS1/CL_AG2ENDPTCONFREQUEST /AWS1/CL_AG2ENDPTCONFREQUEST

The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.

io_portalcontent TYPE REF TO /AWS1/CL_AG2PORTALCONTENT /AWS1/CL_AG2PORTALCONTENT

The content of the portal.

Optional arguments:

it_includedportalproductarns TYPE /AWS1/CL_AG2__LSTOF__STRMIN200=>TT___LISTOF__STRMIN20MAX2048 TT___LISTOF__STRMIN20MAX2048

The ARNs of the portal products included in the portal.

iv_logouri TYPE /AWS1/AG2__STRINGMIN0MAX1092 /AWS1/AG2__STRINGMIN0MAX1092

The URI for the portal logo image that is displayed in the portal header.

iv_rumappmonitorname TYPE /AWS1/AG2__STRINGMIN0MAX255 /AWS1/AG2__STRINGMIN0MAX255

The name of the Amazon CloudWatch RUM app monitor for the portal.

it_tags TYPE /AWS1/CL_AG2TAGS_W=>TT_TAGS TT_TAGS

The collection of tags. Each tag element is associated with a given resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_ag2createportalrsp /AWS1/CL_AG2CREATEPORTALRSP

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->createportal(
  io_authorization = new /aws1/cl_ag2authorization(
    io_cognitoconfig = new /aws1/cl_ag2cognitoconfig(
      iv_appclientid = |string|
      iv_userpoolarn = |string|
      iv_userpooldomain = |string|
    )
    io_none = new /aws1/cl_ag2none( )
  )
  io_endpointconfiguration = new /aws1/cl_ag2endptconfrequest(
    io_acmmanaged = new /aws1/cl_ag2acmmanaged(
      iv_certificatearn = |string|
      iv_domainname = |string|
    )
    io_none = new /aws1/cl_ag2none( )
  )
  io_portalcontent = new /aws1/cl_ag2portalcontent(
    io_theme = new /aws1/cl_ag2portaltheme(
      io_customcolors = new /aws1/cl_ag2customcolors(
        iv_accentcolor = |string|
        iv_backgroundcolor = |string|
        iv_errorvalidationcolor = |string|
        iv_headercolor = |string|
        iv_navigationcolor = |string|
        iv_textcolor = |string|
      )
      iv_logolastuploaded = '20150101000000.0000000'
    )
    iv_description = |string|
    iv_displayname = |string|
  )
  it_includedportalproductarns = VALUE /aws1/cl_ag2__lstof__strmin200=>tt___listof__strmin20max2048(
    ( new /aws1/cl_ag2__lstof__strmin200( |string| ) )
  )
  it_tags = VALUE /aws1/cl_ag2tags_w=>tt_tags(
    (
      VALUE /aws1/cl_ag2tags_w=>ts_tags_maprow(
        value = new /aws1/cl_ag2tags_w( |string| )
        key = |string|
      )
    )
  )
  iv_logouri = |string|
  iv_rumappmonitorname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_authorization = lo_result->get_authorization( ).
  IF lo_authorization IS NOT INITIAL.
    lo_cognitoconfig = lo_authorization->get_cognitoconfig( ).
    IF lo_cognitoconfig IS NOT INITIAL.
      lv___stringmin1max256 = lo_cognitoconfig->get_appclientid( ).
      lv___stringmin20max2048 = lo_cognitoconfig->get_userpoolarn( ).
      lv___stringmin20max2048 = lo_cognitoconfig->get_userpooldomain( ).
    ENDIF.
    lo_none = lo_authorization->get_none( ).
    IF lo_none IS NOT INITIAL.
    ENDIF.
  ENDIF.
  lo_endpointconfigurationre = lo_result->get_endpointconfiguration( ).
  IF lo_endpointconfigurationre IS NOT INITIAL.
    lv___stringmin10max2048 = lo_endpointconfigurationre->get_certificatearn( ).
    lv___stringmin3max256 = lo_endpointconfigurationre->get_domainname( ).
    lv___stringmin3max256 = lo_endpointconfigurationre->get_portaldefaultdomainname( ).
    lv___stringmin1max64 = lo_endpointconfigurationre->get_portaldomainhostedzoneid( ).
  ENDIF.
  LOOP AT lo_result->get_incldportalproductarns( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv___stringmin20max2048 = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv___timestampiso8601 = lo_result->get_lastmodified( ).
  lv___timestampiso8601 = lo_result->get_lastpublished( ).
  lv___stringmin0max1024 = lo_result->get_lastpublisheddescription( ).
  lv___stringmin20max2048 = lo_result->get_portalarn( ).
  lo_portalcontent = lo_result->get_portalcontent( ).
  IF lo_portalcontent IS NOT INITIAL.
    lv___stringmin0max1024 = lo_portalcontent->get_description( ).
    lv___stringmin3max255 = lo_portalcontent->get_displayname( ).
    lo_portaltheme = lo_portalcontent->get_theme( ).
    IF lo_portaltheme IS NOT INITIAL.
      lo_customcolors = lo_portaltheme->get_customcolors( ).
      IF lo_customcolors IS NOT INITIAL.
        lv___stringmin1max16 = lo_customcolors->get_accentcolor( ).
        lv___stringmin1max16 = lo_customcolors->get_backgroundcolor( ).
        lv___stringmin1max16 = lo_customcolors->get_errorvalidationcolor( ).
        lv___stringmin1max16 = lo_customcolors->get_headercolor( ).
        lv___stringmin1max16 = lo_customcolors->get_navigationcolor( ).
        lv___stringmin1max16 = lo_customcolors->get_textcolor( ).
      ENDIF.
      lv___timestampiso8601 = lo_portaltheme->get_logolastuploaded( ).
    ENDIF.
  ENDIF.
  lv___stringmin10max30patte = lo_result->get_portalid( ).
  lv_publishstatus = lo_result->get_publishstatus( ).
  lv___stringmin0max255 = lo_result->get_rumappmonitorname( ).
  lo_statusexception = lo_result->get_statusexception( ).
  IF lo_statusexception IS NOT INITIAL.
    lv___stringmin1max256 = lo_statusexception->get_exception( ).
    lv___stringmin1max2048 = lo_statusexception->get_message( ).
  ENDIF.
  LOOP AT lo_result->get_tags( ) into ls_row_2.
    lv_key = ls_row_2-key.
    lo_value = ls_row_2-value.
    IF lo_value IS NOT INITIAL.
      lv_stringwithlengthbetween = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.