PUT

/accounts/{AwsAccountId}/public-sharing-settings

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/public-sharing-settings

Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity pricing for your Amazon QuickSight 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 QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using Amazon QuickSight with IAM</a> in the Amazon QuickSight User Guide.

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

Body Params

PublicSharingEnabledboolean

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/public-sharing-settings' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}