UpdatePublicSharingSettings - Amazon QuickSight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Use the UpdatePublicSharingSettings 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 Amazon Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.

Request Syntax

PUT /accounts/AwsAccountId/public-sharing-settings HTTP/1.1 Content-type: application/json { "PublicSharingEnabled": boolean }

URI Request Parameters

The request uses the following URI parameters.


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

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.


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

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "RequestId": "string" }

Response Elements

If the action is successful, the service sends back the following HTTP response.


The HTTP status of the request.

The following data is returned in JSON format by the service.


The Amazon request ID for this operation.

Type: String


For information about the errors that are common to all actions, see Common Errors.


You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401


An internal failure occurred.

HTTP Status Code: 500


One or more parameters has a value that isn't valid.

HTTP Status Code: 400


One or more resources can't be found.

HTTP Status Code: 404


Access is throttled.

HTTP Status Code: 429


This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on the Manage Amazon QuickSight page.

After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the --identity-type ANONYMOUS option.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: