account_customizations

Creates, updates, deletes, gets or lists an account_customizations resource.

Overview

Name	account_customizations
Type	Resource
Id	aws.quicksight.account_customizations

Fields

The following fields are returned by SELECT queries:

describe_account_customization

Name	Datatype	Description
account_customization	object	The Quick Sight customizations associated with your Amazon Web Services account or a Quick Sight namespace in a specific Amazon Web Services Region.
arn	string	The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.
aws_account_id	string	The ID for the Amazon Web Services account that you're describing. (pattern: <code>^[0-9]{12}$</code>)
namespace	string	The Quick Sight namespace that you're describing. (pattern: <code>^[a-zA-Z0-9._-]*$</code>)
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_account_customization	select	aws_account_id, region	namespace, resolved	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: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. 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.
create_account_customization	insert	aws_account_id, region, AccountCustomization	namespace	Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight 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.
update_account_customization	update	aws_account_id, region, AccountCustomization	namespace	Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
delete_account_customization	delete	aws_account_id, region	namespace	This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate. Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The ID for the Amazon Web Services account that you want to delete Quick Sight customizations from.
region	string	AWS region (default: us-east-1)
namespace	string	The Quick Sight namespace that you're deleting the customizations from.
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.

SELECT examples

describe_account_customization

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: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. 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.

SELECT
account_customization,
arn,
aws_account_id,
namespace,
request_id,
status
FROM aws.quicksight.account_customizations
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND namespace = '{{ namespace }}'
AND resolved = '{{ resolved }}'
;

INSERT examples

create_account_customization

Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight 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.

INSERT INTO aws.quicksight.account_customizations (
AccountCustomization,
Tags,
aws_account_id,
region,
namespace
)
SELECT 
'{{ AccountCustomization }}' /* required */,
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ region }}',
'{{ namespace }}'
RETURNING
account_customization,
arn,
aws_account_id,
namespace,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: account_customizations
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the account_customizations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the account_customizations resource.
  - name: AccountCustomization
    description: |
      The Quick Sight customizations associated with your Amazon Web Services account or a Quick Sight namespace in a specific Amazon Web Services Region.
    value:
      DefaultTheme: "{{ DefaultTheme }}"
      DefaultEmailCustomizationTemplate: "{{ DefaultEmailCustomizationTemplate }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: namespace
    value: "{{ namespace }}"
    description: The Quick Sight namespace that you want to add customizations to.
    description: The Quick Sight namespace that you want to add customizations to.

UPDATE examples

update_account_customization

Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

UPDATE aws.quicksight.account_customizations
SET 
AccountCustomization = '{{ AccountCustomization }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND AccountCustomization = '{{ AccountCustomization }}' --required
AND namespace = '{{ namespace}}'
RETURNING
account_customization,
arn,
aws_account_id,
namespace,
request_id,
status;

DELETE examples

delete_account_customization

This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate. Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.

DELETE FROM aws.quicksight.account_customizations
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND namespace = '{{ namespace }}'
;