CREATEACCOUNTCUSTOMIZATION()`¶

About CreateAccountCustomization¶

Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide.

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

Method Signature¶

METHODS /AWS1/IF_QST~CREATEACCOUNTCUSTOMIZATION
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/QSTNAMESPACE OPTIONAL
    !IO_ACCOUNTCUSTOMIZATION TYPE REF TO /AWS1/CL_QSTACCTCUSTOMIZATION OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstcreaccustization01
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTRESOURCEEXISTSEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTRESOURCEUNAVAILEX
    /AWS1/CX_QSTTHROTTLINGEX
    /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 for the Amazon Web Services account that you want to customize Quick Sight for.

`io_accountcustomization` `TYPE REF TO /AWS1/CL_QSTACCTCUSTOMIZATION` `/AWS1/CL_QSTACCTCUSTOMIZATION`¶

The Quick Sight customizations you're adding. You can add these to an Amazon Web Services account and a QuickSight namespace.

For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

Optional arguments:¶

`iv_namespace` `TYPE /AWS1/QSTNAMESPACE` `/AWS1/QSTNAMESPACE`¶

The Quick Sight namespace that you want to add customizations to.

`it_tags` `TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST` `TT_TAGLIST`¶

A list of the tags that you want to attach to this resource.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstcreaccustization01` `/AWS1/CL_QSTCREACCUSTIZATION01`¶

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->createaccountcustomization(
  io_accountcustomization = new /aws1/cl_qstacctcustomization(
    iv_defaulttheme = |string|
    iv_defemailcustomizationtmpl = |string|
  )
  it_tags = VALUE /aws1/cl_qsttag=>tt_taglist(
    (
      new /aws1/cl_qsttag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_awsaccountid = |string|
  iv_namespace = |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_awsaccountid = lo_result->get_awsaccountid( ).
  lv_namespace = lo_result->get_namespace( ).
  lo_accountcustomization = lo_result->get_accountcustomization( ).
  IF lo_accountcustomization IS NOT INITIAL.
    lv_arn = lo_accountcustomization->get_defaulttheme( ).
    lv_arn = lo_accountcustomization->get_defemailcustizationtmpl( ).
  ENDIF.
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>CREATEACCOUNTCUSTOMIZATION()¶