QuickSight / Client / describe_account_customization

describe_account_customization

QuickSight.Client.describe_account_customization(**kwargs)

Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

  • Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Quick Sight, you choose one Amazon Web Services Region to use as your home Region. That’s where your free SPICE capacity is located. You can use Quick Sight in any supported Amazon Web Services Region.

  • Amazon Web Services Region - You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you’re using the CLI, you can use one of the following options:

  • Namespace - A Quick Sight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.

  • Applied customizations - Quick Sight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_customization(
    AwsAccountId='string',
    Namespace='string',
    Resolved=True|False
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID for the Amazon Web Services account that you want to describe Quick Sight customizations for.

  • Namespace (string) – The Quick Sight namespace that you want to describe Quick Sight customizations for.

  • Resolved (boolean) – The Resolved flag works with the other parameters to determine which view of Quick Sight customizations is returned. You can add this flag to your command to use the same view that Quick Sight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AwsAccountId': 'string',
    'Namespace': 'string',
    'AccountCustomization': {
        'DefaultTheme': 'string',
        'DefaultEmailCustomizationTemplate': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the customization that’s associated with this Amazon Web Services account.

    • AwsAccountId (string) –

      The ID for the Amazon Web Services account that you’re describing.

    • Namespace (string) –

      The Quick Sight namespace that you’re describing.

    • AccountCustomization (dict) –

      The Quick Sight customizations that exist.

      • DefaultTheme (string) –

        The default theme for this Quick Sight subscription.

      • DefaultEmailCustomizationTemplate (string) –

        The default email customization template.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions