Skip to content

/AWS1/IF_CNT=>CREATEWORKSPACE()

About CreateWorkspace

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

Method Signature

METHODS /AWS1/IF_CNT~CREATEWORKSPACE
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_NAME TYPE /AWS1/CNTWORKSPACENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/CNTWORKSPACEDESCRIPTION OPTIONAL
    !IO_THEME TYPE REF TO /AWS1/CL_CNTWORKSPACETHEME OPTIONAL
    !IV_TITLE TYPE /AWS1/CNTWORKSPACETITLE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntcreateworkspacersp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTDUPLICATERESRCEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTLIMITEXCEEDEDEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTSERVICEQUOTAEXCDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

iv_name TYPE /AWS1/CNTWORKSPACENAME /AWS1/CNTWORKSPACENAME

The name of the workspace. Must be unique within the instance and can contain 1-127 characters.

Optional arguments:

iv_description TYPE /AWS1/CNTWORKSPACEDESCRIPTION /AWS1/CNTWORKSPACEDESCRIPTION

The description of the workspace. Maximum length is 250 characters.

io_theme TYPE REF TO /AWS1/CL_CNTWORKSPACETHEME /AWS1/CL_CNTWORKSPACETHEME

The theme configuration for the workspace, including colors and styling.

iv_title TYPE /AWS1/CNTWORKSPACETITLE /AWS1/CNTWORKSPACETITLE

The title displayed for the workspace.

it_tags TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntcreateworkspacersp /AWS1/CL_CNTCREATEWORKSPACERSP

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->createworkspace(
  io_theme = new /aws1/cl_cntworkspacetheme(
    io_dark = new /aws1/cl_cntworkspacethemecfg(
      io_images = new /aws1/cl_cntworkspacethemeim00(
        io_logo = new /aws1/cl_cntimageslogo(
          iv_default = |string|
          iv_favicon = |string|
        )
      )
      io_palette = new /aws1/cl_cntworkspacethemepa00(
        io_canvas = new /aws1/cl_cntpalettecanvas(
          iv_activebackground = |string|
          iv_containerbackground = |string|
          iv_pagebackground = |string|
        )
        io_header = new /aws1/cl_cntpaletteheader(
          iv_background = |string|
          iv_invertactionscolors = ABAP_TRUE
          iv_text = |string|
          iv_texthover = |string|
        )
        io_navigation = new /aws1/cl_cntpalettenavigation(
          iv_background = |string|
          iv_invertactionscolors = ABAP_TRUE
          iv_text = |string|
          iv_textactive = |string|
          iv_textbackgroundactive = |string|
          iv_textbackgroundhover = |string|
          iv_texthover = |string|
        )
        io_primary = new /aws1/cl_cntpaletteprimary(
          iv_active = |string|
          iv_contrasttext = |string|
          iv_default = |string|
        )
      )
      io_typography = new /aws1/cl_cntworkspacethemety00( new /aws1/cl_cntfontfamily( |string| ) )
    )
    io_light = new /aws1/cl_cntworkspacethemecfg(
      io_images = new /aws1/cl_cntworkspacethemeim00(
        io_logo = new /aws1/cl_cntimageslogo(
          iv_default = |string|
          iv_favicon = |string|
        )
      )
      io_palette = new /aws1/cl_cntworkspacethemepa00(
        io_canvas = new /aws1/cl_cntpalettecanvas(
          iv_activebackground = |string|
          iv_containerbackground = |string|
          iv_pagebackground = |string|
        )
        io_header = new /aws1/cl_cntpaletteheader(
          iv_background = |string|
          iv_invertactionscolors = ABAP_TRUE
          iv_text = |string|
          iv_texthover = |string|
        )
        io_navigation = new /aws1/cl_cntpalettenavigation(
          iv_background = |string|
          iv_invertactionscolors = ABAP_TRUE
          iv_text = |string|
          iv_textactive = |string|
          iv_textbackgroundactive = |string|
          iv_textbackgroundhover = |string|
          iv_texthover = |string|
        )
        io_primary = new /aws1/cl_cntpaletteprimary(
          iv_active = |string|
          iv_contrasttext = |string|
          iv_default = |string|
        )
      )
      io_typography = new /aws1/cl_cntworkspacethemety00( new /aws1/cl_cntfontfamily( |string| ) )
    )
  )
  it_tags = VALUE /aws1/cl_cnttagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_cnttagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_cnttagmap_w( |string| )
      )
    )
  )
  iv_description = |string|
  iv_instanceid = |string|
  iv_name = |string|
  iv_title = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_workspaceid = lo_result->get_workspaceid( ).
  lv_arn = lo_result->get_workspacearn( ).
ENDIF.