QuickSight / Client / create_account_customization

create_account_customization#

QuickSight.Client.create_account_customization(**kwargs)#

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don’t share it with the namespace, the theme isn’t visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

See also: AWS API Documentation

Request Syntax

response = client.create_account_customization(
    AwsAccountId='string',
    Namespace='string',
    AccountCustomization={
        'DefaultTheme': 'string',
        'DefaultEmailCustomizationTemplate': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

  • Namespace (string) – The Amazon QuickSight namespace that you want to add customizations to.

  • AccountCustomization (dict) –

    [REQUIRED]

    The Amazon QuickSight customizations you’re adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace.

    For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

    • DefaultTheme (string) –

      The default theme for this Amazon QuickSight subscription.

    • DefaultEmailCustomizationTemplate (string) –

      The default email customization template.

  • Tags (list) –

    A list of the tags that you want to attach to this resource.

    • (dict) –

      The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

      • Key (string) – [REQUIRED]

        Tag key.

      • Value (string) – [REQUIRED]

        Tag value.

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) for the customization that you created for this Amazon Web Services account.

    • AwsAccountId (string) –

      The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

    • Namespace (string) –

      The namespace associated with the customization you’re creating.

    • AccountCustomization (dict) –

      The Amazon QuickSight customizations you’re adding in the current Amazon Web Services Region.

      • DefaultTheme (string) –

        The default theme for this Amazon QuickSight 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