Skip to content

/AWS1/IF_QST=>CREATETHEME()

About CreateTheme

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.

Method Signature

METHODS /AWS1/IF_QST~CREATETHEME
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_THEMEID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
    !IV_NAME TYPE /AWS1/QSTTHEMENAME OPTIONAL
    !IV_BASETHEMEID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
    !IV_VERSIONDESCRIPTION TYPE /AWS1/QSTVERSIONDESCRIPTION OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_QSTTHEMECONFIGURATION OPTIONAL
    !IT_PERMISSIONS TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstcreatethemersp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /AWS1/CX_QSTRESOURCEEXISTSEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTUNSUPPEDUSEREDIT00
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The ID of the Amazon Web Services account where you want to store the new theme.

iv_themeid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

iv_name TYPE /AWS1/QSTTHEMENAME /AWS1/QSTTHEMENAME

A display name for the theme.

iv_basethemeid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

io_configuration TYPE REF TO /AWS1/CL_QSTTHEMECONFIGURATION /AWS1/CL_QSTTHEMECONFIGURATION

The theme configuration, which contains the theme display properties.

Optional arguments:

iv_versiondescription TYPE /AWS1/QSTVERSIONDESCRIPTION /AWS1/QSTVERSIONDESCRIPTION

A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

it_permissions TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST TT_RESOURCEPERMISSIONLIST

A valid grouping of resource permissions to apply to the new theme.

it_tags TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST TT_TAGLIST

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstcreatethemersp /AWS1/CL_QSTCREATETHEMERSP

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->createtheme(
  io_configuration = new /aws1/cl_qstthemeconfiguration(
    io_datacolorpalette = new /aws1/cl_qstdatacolorpalette(
      it_colors = VALUE /aws1/cl_qstcolorlist_w=>tt_colorlist(
        ( new /aws1/cl_qstcolorlist_w( |string| ) )
      )
      it_minmaxgradient = VALUE /aws1/cl_qstcolorlist_w=>tt_colorlist(
        ( new /aws1/cl_qstcolorlist_w( |string| ) )
      )
      iv_emptyfillcolor = |string|
    )
    io_sheet = new /aws1/cl_qstsheetstyle(
      io_tile = new /aws1/cl_qsttilestyle( new /aws1/cl_qstborderstyle( ABAP_TRUE ) )
      io_tilelayout = new /aws1/cl_qsttilelayoutstyle(
        io_gutter = new /aws1/cl_qstgutterstyle( ABAP_TRUE )
        io_margin = new /aws1/cl_qstmarginstyle( ABAP_TRUE )
      )
    )
    io_typography = new /aws1/cl_qsttypography(
      it_fontfamilies = VALUE /aws1/cl_qstfont=>tt_fontlist(
        ( new /aws1/cl_qstfont( |string| ) )
      )
    )
    io_uicolorpalette = new /aws1/cl_qstuicolorpalette(
      iv_accent = |string|
      iv_accentforeground = |string|
      iv_danger = |string|
      iv_dangerforeground = |string|
      iv_dimension = |string|
      iv_dimensionforeground = |string|
      iv_measure = |string|
      iv_measureforeground = |string|
      iv_primarybackground = |string|
      iv_primaryforeground = |string|
      iv_secondarybackground = |string|
      iv_secondaryforeground = |string|
      iv_success = |string|
      iv_successforeground = |string|
      iv_warning = |string|
      iv_warningforeground = |string|
    )
  )
  it_permissions = VALUE /aws1/cl_qstresourcepermission=>tt_resourcepermissionlist(
    (
      new /aws1/cl_qstresourcepermission(
        it_actions = VALUE /aws1/cl_qstactionlist_w=>tt_actionlist(
          ( new /aws1/cl_qstactionlist_w( |string| ) )
        )
        iv_principal = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_qsttag=>tt_taglist(
    (
      new /aws1/cl_qsttag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_awsaccountid = |string|
  iv_basethemeid = |string|
  iv_name = |string|
  iv_themeid = |string|
  iv_versiondescription = |string|
).

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_arn( ).
  lv_arn = lo_result->get_versionarn( ).
  lv_shortrestrictiveresourc = lo_result->get_themeid( ).
  lv_resourcestatus = lo_result->get_creationstatus( ).
  lv_statuscode = lo_result->get_status( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.