DESCRIBEWORKSPACE()`¶

About DescribeWorkspace¶

Retrieves details about a workspace, including its configuration and metadata.

Method Signature¶

METHODS /AWS1/IF_CNT~DESCRIBEWORKSPACE
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_WORKSPACEID TYPE /AWS1/CNTWORKSPACEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntdescrworkspacersp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /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_workspaceid` `TYPE /AWS1/CNTWORKSPACEID` `/AWS1/CNTWORKSPACEID`¶

The identifier of the workspace.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntdescrworkspacersp` `/AWS1/CL_CNTDESCRWORKSPACERSP`¶

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->describeworkspace(
  iv_instanceid = |string|
  iv_workspaceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_workspace = lo_result->get_workspace( ).
  IF lo_workspace IS NOT INITIAL.
    lv_visibility = lo_workspace->get_visibility( ).
    lv_workspaceid = lo_workspace->get_id( ).
    lv_workspacename = lo_workspace->get_name( ).
    lv_arn = lo_workspace->get_arn( ).
    lv_workspacedescription = lo_workspace->get_description( ).
    lo_workspacetheme = lo_workspace->get_theme( ).
    IF lo_workspacetheme IS NOT INITIAL.
      lo_workspacethemeconfig = lo_workspacetheme->get_light( ).
      IF lo_workspacethemeconfig IS NOT INITIAL.
        lo_workspacethemepalette = lo_workspacethemeconfig->get_palette( ).
        IF lo_workspacethemepalette IS NOT INITIAL.
          lo_paletteheader = lo_workspacethemepalette->get_header( ).
          IF lo_paletteheader IS NOT INITIAL.
            lv_themestring = lo_paletteheader->get_background( ).
            lv_themestring = lo_paletteheader->get_text( ).
            lv_themestring = lo_paletteheader->get_texthover( ).
            lv_boolean = lo_paletteheader->get_invertactionscolors( ).
          ENDIF.
          lo_palettenavigation = lo_workspacethemepalette->get_navigation( ).
          IF lo_palettenavigation IS NOT INITIAL.
            lv_themestring = lo_palettenavigation->get_background( ).
            lv_themestring = lo_palettenavigation->get_textbackgroundhover( ).
            lv_themestring = lo_palettenavigation->get_textbackgroundactive( ).
            lv_themestring = lo_palettenavigation->get_text( ).
            lv_themestring = lo_palettenavigation->get_texthover( ).
            lv_themestring = lo_palettenavigation->get_textactive( ).
            lv_boolean = lo_palettenavigation->get_invertactionscolors( ).
          ENDIF.
          lo_palettecanvas = lo_workspacethemepalette->get_canvas( ).
          IF lo_palettecanvas IS NOT INITIAL.
            lv_themestring = lo_palettecanvas->get_containerbackground( ).
            lv_themestring = lo_palettecanvas->get_pagebackground( ).
            lv_themestring = lo_palettecanvas->get_activebackground( ).
          ENDIF.
          lo_paletteprimary = lo_workspacethemepalette->get_primary( ).
          IF lo_paletteprimary IS NOT INITIAL.
            lv_themestring = lo_paletteprimary->get_default( ).
            lv_themestring = lo_paletteprimary->get_active( ).
            lv_themestring = lo_paletteprimary->get_contrasttext( ).
          ENDIF.
        ENDIF.
        lo_workspacethemeimages = lo_workspacethemeconfig->get_images( ).
        IF lo_workspacethemeimages IS NOT INITIAL.
          lo_imageslogo = lo_workspacethemeimages->get_logo( ).
          IF lo_imageslogo IS NOT INITIAL.
            lv_themeimagelink = lo_imageslogo->get_default( ).
            lv_themeimagelink = lo_imageslogo->get_favicon( ).
          ENDIF.
        ENDIF.
        lo_workspacethemetypograph = lo_workspacethemeconfig->get_typography( ).
        IF lo_workspacethemetypograph IS NOT INITIAL.
          lo_fontfamily = lo_workspacethemetypograph->get_fontfamily( ).
          IF lo_fontfamily IS NOT INITIAL.
            lv_workspacefontfamily = lo_fontfamily->get_default( ).
          ENDIF.
        ENDIF.
      ENDIF.
      lo_workspacethemeconfig = lo_workspacetheme->get_dark( ).
      IF lo_workspacethemeconfig IS NOT INITIAL.
        lo_workspacethemepalette = lo_workspacethemeconfig->get_palette( ).
        IF lo_workspacethemepalette IS NOT INITIAL.
          lo_paletteheader = lo_workspacethemepalette->get_header( ).
          IF lo_paletteheader IS NOT INITIAL.
            lv_themestring = lo_paletteheader->get_background( ).
            lv_themestring = lo_paletteheader->get_text( ).
            lv_themestring = lo_paletteheader->get_texthover( ).
            lv_boolean = lo_paletteheader->get_invertactionscolors( ).
          ENDIF.
          lo_palettenavigation = lo_workspacethemepalette->get_navigation( ).
          IF lo_palettenavigation IS NOT INITIAL.
            lv_themestring = lo_palettenavigation->get_background( ).
            lv_themestring = lo_palettenavigation->get_textbackgroundhover( ).
            lv_themestring = lo_palettenavigation->get_textbackgroundactive( ).
            lv_themestring = lo_palettenavigation->get_text( ).
            lv_themestring = lo_palettenavigation->get_texthover( ).
            lv_themestring = lo_palettenavigation->get_textactive( ).
            lv_boolean = lo_palettenavigation->get_invertactionscolors( ).
          ENDIF.
          lo_palettecanvas = lo_workspacethemepalette->get_canvas( ).
          IF lo_palettecanvas IS NOT INITIAL.
            lv_themestring = lo_palettecanvas->get_containerbackground( ).
            lv_themestring = lo_palettecanvas->get_pagebackground( ).
            lv_themestring = lo_palettecanvas->get_activebackground( ).
          ENDIF.
          lo_paletteprimary = lo_workspacethemepalette->get_primary( ).
          IF lo_paletteprimary IS NOT INITIAL.
            lv_themestring = lo_paletteprimary->get_default( ).
            lv_themestring = lo_paletteprimary->get_active( ).
            lv_themestring = lo_paletteprimary->get_contrasttext( ).
          ENDIF.
        ENDIF.
        lo_workspacethemeimages = lo_workspacethemeconfig->get_images( ).
        IF lo_workspacethemeimages IS NOT INITIAL.
          lo_imageslogo = lo_workspacethemeimages->get_logo( ).
          IF lo_imageslogo IS NOT INITIAL.
            lv_themeimagelink = lo_imageslogo->get_default( ).
            lv_themeimagelink = lo_imageslogo->get_favicon( ).
          ENDIF.
        ENDIF.
        lo_workspacethemetypograph = lo_workspacethemeconfig->get_typography( ).
        IF lo_workspacethemetypograph IS NOT INITIAL.
          lo_fontfamily = lo_workspacethemetypograph->get_fontfamily( ).
          IF lo_fontfamily IS NOT INITIAL.
            lv_workspacefontfamily = lo_fontfamily->get_default( ).
          ENDIF.
        ENDIF.
      ENDIF.
    ENDIF.
    lv_workspacetitle = lo_workspace->get_title( ).
    lv_timestamp = lo_workspace->get_lastmodifiedtime( ).
    lv_regionname = lo_workspace->get_lastmodifiedregion( ).
    LOOP AT lo_workspace->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.
  ENDIF.
ENDIF.

/AWS1/IF_CNT=>DESCRIBEWORKSPACE()¶