Customizing the QuickSight Console - Amazon QuickSight

Customizing the QuickSight Console

Using Amazon QuickSight, you can create a customized experience for people using either the AWS Management Console or QuickSight consoles embedded in your application.

Currently, different options for customizing QuickSight are available separately in the console and the QuickSight API. Following, you can find information about the available options.

The following customization options are currently available:

  • You can accept or decline the sample assets. These assets include sample datasets and analyses that are added when a person signs in for the first time.

  • You can show or hide default videos. These videos include the animation that displays for new users and also the tutorial videos shown on the QuickSight home page.

  • You can create and specify a default theme.

Important

All customizations apply only to the AWS Region that you are using in the API or that is selected in the QuickSight console.

To check your Region setting, you can use one of the following procedures.

To check your AWS Region on the QuickSight console

  1. Choose your profile icon at upper right to open the menu.

  2. View your current AWS Region, listed next to a location icon.

  3. (Optional) Choose another AWS Region from the menu to change to that Region. Remember to change back after you are finished with customizations.

To check your AWS Region using the AWS CLI

  • On the command line, enter the following command and press Enter to view the current settings.

    aws configure list

    To reconfigure your default Region, use the aws configure command.

To keep your default Region, you can add the --region parameter to most CLI commands.

To customize QuickSight by using the console

  1. Choose your profile icon at upper right to open the menu.

  2. Choose Manage QuickSight to open the administration page.

  3. On the navigation pane, choose Account customization to open the customization options.

  4. Select the Show introductory videos check box to show the default tutorial videos and the introductory animation. Clear the check box to hide QuickSight videos and the intro animation for all users in your current AWS Region.

  5. Select the Create sample datasets and analyses check box to accept sample datasets and analyses for new users. Doing this also applies to existing users who open QuickSight in a new AWS Region. Clear the check box if you want to decline sample datasets and analyses. You can also provide your own versions of these to your users.

To set a default theme by using the API

  1. Identify the custom theme that you want to use as the default, and locate its theme ID. If you want to use one of the QuickSight starter themes, skip this step.

    To get the theme ID of a custom theme, use the ListThemes API operation for the Region where the theme is. Make sure that the theme is in the same Region with the users or groups that need to use it.

    The following example shows a shell script that uses the list-themes command in the AWS CLI. It sets the AWS Account ID and the AWS Region as variables. If you previously used aws configure to set a default Region, adding the --region variable to your command overrides your default setting.

    #declare variables awsacct1='111122223333' region='us-west-2' aws quicksight list-themes \ --region $region \ --aws-account-id $awsacct1 \ --type 'CUSTOM'
  2. Use the ListUsers or ListGroups API operation to collect the Amazon Resource Names (ARNs) for users or groups that need to use the theme as a default. You need only the top-level ARN. If all your users are part of the same group, use the group ARN.

    For more information on QuickSight ARNs, see ARN Formats in the Amazon QuickSight API Reference.

  3. If you're using a custom theme, grant access to the theme for the ARNs that you collected in the previous step. If you're using a starter theme, skip this step because all users have access to starter themes.

    The following example shows a shell script that uses the update-theme-permissions command The grant-permissions parameter is shown using shorthand syntax. You can use JSON or YAML instead. For more information, see Specifying Parameter Values in the AWS Command Line Interface User Guide.

    #declare variables awsacct1='111122223333' namespace='default' region='us-west-2' theme-id='bdb844d0-0fe9-4d9d-b520-0fe602d93639' #Find this with list-themes aws quicksight update-theme-permissions \ #Specify region if necessary: --region $region \ --aws-account-id $awsacct1 \ --theme-id $theme-id \ --grant-permissions Principal="arn:aws:quicksight:$region:$awsacct1:group/$namespace/QuickSight_Group_Name",Actions="quicksight:DescribeTheme","quicksight:ListThemeVersions","quicksight:ListThemeAliases","quicksight:DescribeThemeAlias"
  4. Assign the theme as the default for the same ARN or ARNs.

    #declare variables awsacct1='111122223333' namespace='default' region='us-west-2' theme-id='bdb844d0-0fe9-4d9d-b520-0fe602d93639' aws quicksight create-account-customization \ #Specify region if necessary: --region $region \ --aws-account-id $awsacct1 \ --namespace $namespace \ --account-customization DefaultTheme="arn:aws:quicksight:$region:$awsacct1:theme/$theme-id"

Currently, there are three starter themes: Classic, Midnight, and Seaside. Their ARNs are the capitalized spelling of their theme name. If you are using a starter theme instead of a custom theme, use one of the following theme ARNs:

  • arn:aws:quicksight::aws:theme/CLASSIC

  • arn:aws:quicksight::aws:theme/MIDNIGHT

  • arn:aws:quicksight::aws:theme/SEASIDE