Skip to content

/AWS1/IF_WSW=>CREATEPORTAL()

About CreatePortal

Creates a web portal.

Method Signature

METHODS /AWS1/IF_WSW~CREATEPORTAL
  IMPORTING
    !IV_DISPLAYNAME TYPE /AWS1/WSWDISPLAYNAME OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_WSWTAG=>TT_TAGLIST OPTIONAL
    !IV_CUSTOMERMANAGEDKEY TYPE /AWS1/WSWKEYARN OPTIONAL
    !IT_ADDITIONALENCCONTEXT TYPE /AWS1/CL_WSWENCCONTEXTMAP_W=>TT_ENCRYPTIONCONTEXTMAP OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/WSWCLIENTTOKEN OPTIONAL
    !IV_AUTHENTICATIONTYPE TYPE /AWS1/WSWAUTHENTICATIONTYPE OPTIONAL
    !IV_INSTANCETYPE TYPE /AWS1/WSWINSTANCETYPE OPTIONAL
    !IV_MAXCONCURRENTSESSIONS TYPE /AWS1/WSWMAXCONCURRENTSESSIONS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wswcreateportalrsp
  RAISING
    /AWS1/CX_WSWACCESSDENIEDEX
    /AWS1/CX_WSWCONFLICTEXCEPTION
    /AWS1/CX_WSWINTERNALSERVEREX
    /AWS1/CX_WSWRESOURCENOTFOUNDEX
    /AWS1/CX_WSWSERVICEQUOTAEXCDEX
    /AWS1/CX_WSWTHROTTLINGEX
    /AWS1/CX_WSWVALIDATIONEX
    /AWS1/CX_WSWCLIENTEXC
    /AWS1/CX_WSWSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_displayname TYPE /AWS1/WSWDISPLAYNAME /AWS1/WSWDISPLAYNAME

The name of the web portal. This is not visible to users who log into the web portal.

it_tags TYPE /AWS1/CL_WSWTAG=>TT_TAGLIST TT_TAGLIST

The tags to add to the web portal. A tag is a key-value pair.

iv_customermanagedkey TYPE /AWS1/WSWKEYARN /AWS1/WSWKEYARN

The customer managed key of the web portal.

it_additionalenccontext TYPE /AWS1/CL_WSWENCCONTEXTMAP_W=>TT_ENCRYPTIONCONTEXTMAP TT_ENCRYPTIONCONTEXTMAP

The additional encryption context of the portal.

iv_clienttoken TYPE /AWS1/WSWCLIENTTOKEN /AWS1/WSWCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

iv_authenticationtype TYPE /AWS1/WSWAUTHENTICATIONTYPE /AWS1/WSWAUTHENTICATIONTYPE

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

iv_instancetype TYPE /AWS1/WSWINSTANCETYPE /AWS1/WSWINSTANCETYPE

The type and resources of the underlying instance.

iv_maxconcurrentsessions TYPE /AWS1/WSWMAXCONCURRENTSESSIONS /AWS1/WSWMAXCONCURRENTSESSIONS

The maximum number of concurrent sessions for the portal.

RETURNING

oo_output TYPE REF TO /aws1/cl_wswcreateportalrsp /AWS1/CL_WSWCREATEPORTALRSP

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(
  it_additionalenccontext = VALUE /aws1/cl_wswenccontextmap_w=>tt_encryptioncontextmap(
    (
      VALUE /aws1/cl_wswenccontextmap_w=>ts_encryptioncontextmap_maprow(
        key = |string|
        value = new /aws1/cl_wswenccontextmap_w( |string| )
      )
    )
  )
  it_tags = VALUE /aws1/cl_wswtag=>tt_taglist(
    (
      new /aws1/cl_wswtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_authenticationtype = |string|
  iv_clienttoken = |string|
  iv_customermanagedkey = |string|
  iv_displayname = |string|
  iv_instancetype = |string|
  iv_maxconcurrentsessions = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_portalarn( ).
  lv_portalendpoint = lo_result->get_portalendpoint( ).
ENDIF.