UPDATEPUBLICSHARINGSETTINGS()`¶

About UpdatePublicSharingSettings¶

This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing:

Dashboards can be shared publicly
This setting affects your entire Amazon Web Services account and all Quick Sight users

Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured.

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard.

To use this operation, turn on session capacity pricing for your Amazon Quick Sight account.

Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using Quick Suite with IAM in the Amazon Quick Sight User Guide.

Method Signature¶

METHODS /AWS1/IF_QST~UPDATEPUBLICSHARINGSETTINGS
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_PUBLICSHARINGENABLED TYPE /AWS1/QSTBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstuppubsharingstgs01
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTUNSUPPEDPRICINGP00
    /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 Amazon Web Services account ID associated with your Amazon Quick Sight subscription.

Optional arguments:¶

`iv_publicsharingenabled` `TYPE /AWS1/QSTBOOLEAN` `/AWS1/QSTBOOLEAN`¶

A Boolean value that indicates whether public sharing is turned on for an Quick Suite account.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstuppubsharingstgs01` `/AWS1/CL_QSTUPPUBSHARINGSTGS01`¶

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->updatepublicsharingsettings(
  iv_awsaccountid = |string|
  iv_publicsharingenabled = ABAP_TRUE
).

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( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>UPDATEPUBLICSHARINGSETTINGS()¶