QuickSight / Client / describe_account_subscription

describe_account_subscription#

QuickSight.Client.describe_account_subscription(**kwargs)#

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account’s subscription. A successful API call returns an AccountInfo object that includes an account’s name, subscription status, authentication type, edition, and notification email address.

See also: AWS API Documentation

Request Syntax

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

AwsAccountId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'AccountInfo': {
        'AccountName': 'string',
        'Edition': 'STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
        'NotificationEmail': 'string',
        'AuthenticationType': 'string',
        'AccountSubscriptionStatus': 'string',
        'IAMIdentityCenterInstanceArn': 'string'
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • AccountInfo (dict) –

      A structure that contains the following elements:

      • Your Amazon QuickSight account name.

      • The edition of Amazon QuickSight that your account is using.

      • The notification email address that is associated with the Amazon QuickSight account.

      • The authentication type of the Amazon QuickSight account.

      • The status of the Amazon QuickSight account’s subscription.

      • AccountName (string) –

        The account name that 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’s unique over all of Amazon Web Services, and it appears only when users sign in.

      • Edition (string) –

        The edition of your Amazon QuickSight account.

      • NotificationEmail (string) –

        The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

      • AuthenticationType (string) –

        The way that your Amazon QuickSight account is authenticated.

      • AccountSubscriptionStatus (string) –

        The status of your account subscription.

      • IAMIdentityCenterInstanceArn (string) –

        The Amazon Resource Name (ARN) for the IAM Identity Center instance.

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions