QuickSight / Client / update_public_sharing_settings

update_public_sharing_settings

QuickSight.Client.update_public_sharing_settings(**kwargs)

Warning

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 QuickSight with IAM in the Amazon Quick Sight User Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_public_sharing_settings(
    AwsAccountId='string',
    PublicSharingEnabled=True|False
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID associated with your Amazon Quick Sight subscription.

  • PublicSharingEnabled (boolean) – A Boolean value that indicates whether public sharing is turned on for an QuickSight account.

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.UnsupportedPricingPlanException

  • QuickSight.Client.exceptions.InternalFailureException