QuickSight / Client / describe_account_settings

describe_account_settings#

QuickSight.Client.describe_account_settings(**kwargs)#

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

response = client.describe_account_settings(
    AwsAccountId='string'
)
Parameters:

AwsAccountId (string) –

[REQUIRED]

The ID for the Amazon Web Services account that contains the settings that you want to list.

Return type:

dict

Returns:

Response Syntax

{
    'AccountSettings': {
        'AccountName': 'string',
        'Edition': 'STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
        'DefaultNamespace': 'string',
        'NotificationEmail': 'string',
        'PublicSharingEnabled': True|False,
        'TerminationProtectionEnabled': 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 value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

      • TerminationProtectionEnabled (boolean) –

        A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn’t allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions