2022/05/18 - Amazon QuickSight - 1 new 1 updated api methods
Changes API UpdatePublicSharingSettings enables IAM admins to enable/disable account level setting for public access of dashboards. When enabled, owners/co-owners for dashboards can enable public access on their dashboards. These dashboards can only be accessed through share link or embedding.
Use the UpdatePublicSharingSettings operation to enable or disable the public sharing settings of an Amazon QuickSight dashboard.
To use this operation, enable session capacity pricing on your Amazon QuickSight account.
Before you can enable public sharing on your account, you need to allow public sharing permissions to an administrative user in the IAM console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM .
See also: AWS API Documentation
Request Syntax
client.update_public_sharing_settings(
AwsAccountId='string',
PublicSharingEnabled=True|False
)
string
[REQUIRED]
The Amazon Web Services account ID associated with your Amazon QuickSight subscription.
boolean
A boolean that indicates whether or not public sharing is enabled on a Amazon QuickSight account.
dict
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.
{'AccountSettings': {'PublicSharingEnabled': 'boolean'}}
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.describe_account_settings(
AwsAccountId='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the settings that you want to list.
dict
Response Syntax
{
'AccountSettings': {
'AccountName': 'string',
'Edition': 'STANDARD'|'ENTERPRISE',
'DefaultNamespace': 'string',
'NotificationEmail': 'string',
'PublicSharingEnabled': True|False
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AccountSettings (dict) --
The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription. In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
AccountName (string) --
The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
Edition (string) --
The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
DefaultNamespace (string) --
The default Amazon QuickSight namespace for your Amazon Web Services account.
NotificationEmail (string) --
The main notification email for your Amazon QuickSight subscription.
PublicSharingEnabled (boolean) --
A boolean that indicates whether or not public sharing is enabled on an Amazon QuickSight account. For more information about enabling public sharing, see UpdatePublicSharingSettings .
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.