Update Public Sharing Settings

quicksight_update_public_sharing_settings

R Documentation

Description¶

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

Usage¶

quicksight_update_public_sharing_settings(AwsAccountId,
  PublicSharingEnabled)

Arguments¶

AwsAccountId

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

PublicSharingEnabled

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

Value¶

A list with the following syntax:

list(
  RequestId = "string",
  Status = 123
)

Request syntax¶

svc$update_public_sharing_settings(
  AwsAccountId = "string",
  PublicSharingEnabled = TRUE|FALSE
)