Skip to content

/AWS1/CL_CUS=>UPDATEDOMAINLAYOUT()

About UpdateDomainLayout

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Method Signature

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the domain.

iv_layoutdefinitionname TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the layout.

Optional arguments:

iv_description TYPE /AWS1/CUSSENSITIVETEXT /AWS1/CUSSENSITIVETEXT

The description of the layout

iv_displayname TYPE /AWS1/CUSDISPLAYNAME /AWS1/CUSDISPLAYNAME

The display name of the layout

iv_isdefault TYPE /AWS1/CUSBOOLEAN /AWS1/CUSBOOLEAN

If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

iv_layouttype TYPE /AWS1/CUSLAYOUTTYPE /AWS1/CUSLAYOUTTYPE

The type of layout that can be used to view data under a Customer Profiles domain.

iv_layout TYPE /AWS1/CUSSENSITIVESTR1TO200000 /AWS1/CUSSENSITIVESTR1TO200000

A customizable layout that can be used to view data under a Customer Profiles domain.

RETURNING

oo_output TYPE REF TO /aws1/cl_cusupdatedomlayoutrsp /AWS1/CL_CUSUPDATEDOMLAYOUTRSP

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->/aws1/if_cus~updatedomainlayout(
  iv_description = |string|
  iv_displayname = |string|
  iv_domainname = |string|
  iv_isdefault = ABAP_TRUE
  iv_layout = |string|
  iv_layoutdefinitionname = |string|
  iv_layouttype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_name = lo_result->get_layoutdefinitionname( ).
  lv_sensitivetext = lo_result->get_description( ).
  lv_displayname = lo_result->get_displayname( ).
  lv_boolean = lo_result->get_isdefault( ).
  lv_layouttype = lo_result->get_layouttype( ).
  lv_sensitivestring1to20000 = lo_result->get_layout( ).
  lv_string1to255 = lo_result->get_version( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_lastupdatedat( ).
  LOOP AT lo_result->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.