Skip to content

/AWS1/IF_QST=>DELETEBRAND()

About DeleteBrand

This API permanently deletes the specified Quick Sight brand. When you delete a brand:

  • The brand and all its associated branding elements are permanently removed

  • Any applications or dashboards using this brand will revert to default styling

  • This action cannot be undone through the API

Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.

Deletes an Quick Sight brand.

Method Signature

METHODS /AWS1/IF_QST~DELETEBRAND
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_BRANDID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdeletebrandrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALSERVEREX
    /AWS1/CX_QSTINVALIDREQUESTEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /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 of the Amazon Web Services account that owns the brand.

iv_brandid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the Quick Suite brand.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstdeletebrandrsp /AWS1/CL_QSTDELETEBRANDRSP

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->deletebrand(
  iv_awsaccountid = |string|
  iv_brandid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_requestid( ).
ENDIF.