

# Amazon Quick brand customization
<a name="brand-customization"></a>

Amazon Quick allows account admins to customize their application's branding and visual theme to align with their organization's guidelines. This customization includes the following visual elements to create a cohesive look and feel across all non-administrative Amazon Quick console pages, schedules, alerts, and email reports.
+ Logo
+ Favicon
+ Associated alt text for visual assets

The following list shows the different areas customizable theme colors are grouped into.

**Brand colors**
+ **Global navigation bar** colors are applied to the topmost bar in the Amazon Quick UI and include the company logo that is diaplayed in the standard and embedded Amazon Quick consoles.
+ **Application bar** colors are applied to the secondary navigation bar that contains contextual actions.

**Interaction colors**
+ **Accent** colors are applied to interactive elements like buttons, borders, and icons.

**Surface colors**
+ **Primary** colors are applied to high-emphasis surfaces like the homepage background and text.
+ **Secondary** colors are applied to practical surfaces like borders, backgrounds, and form fields. Secondary colors are used alongside primary colors.

**Status colors**
+ **Success** colors are applied to success messages.
+ **Danger** colors are applied to error messages.
+ **Warning** colors are applied to warning messages.
+ **Info** colors are applied to informational messages.

**Data visualization colors**
+ **Dimension** colors are used to identify associations between data columns that share the same role.
+ **Measure** colors are used to idenfity metrics or measured values.

**Features**
+ **Visualization** colors are applied to the **Visualization** icon.
+ **Insight** colors are applied to the **Insight** icon.
+ **Connection** colors are applied to the **Connection** icon.
+ **Automation** colors are applied to the **Automation** icon.

Use the following sections to get started with brand customization in Amazon Quick.

**Topics**
+ [

## Permisisons for Amazon Quick brand customization
](#brand-customization-permissions)
+ [

## Create a custom brand in Amazon Quick
](#brand-customization-create)
+ [

# Setting a default theme for Amazon Quick analyses with the Amazon Quick APIs
](customizing-quicksight-default-theme.md)

## Permisisons for Amazon Quick brand customization
<a name="brand-customization-permissions"></a>

To set up a brand, you must be granted an Admin role through IAM Identity Center or IAM. Admins whose roles are granted to them within Amazon Quick can't create brands. To learn more about integrating your account with IAM Identity Center, see [Configure your Amazon Quick account with IAM Identity Center](https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html). For information about admin roles and capabilities, see [Understanding Amazon Quick subscriptions and roles](https://docs.aws.amazon.com/quicksight/latest/user/user-types.html#subscription-role-mapping).

Admin users can only manage brands that are in the same capacity Region as their Amazon Quick account.

The IAM role that you use to create a brand in Amazon Quick must contain `quicksight:*` or granular action permissions to manage brands in the admin console. The following granular permissions are required for admins to work with Amazon Quick brands:
+ `quicksight:CreateBrand`
+ `quicksight:UpdateBrand`
+ `quicksight:DescribeBrand`
+ `quicksight:DescribeBrandPublishedVersion`
+ `quicksight:UpdateBrandPublishedVersion`
+ `quicksight:DeleteBrand`
+ `quicksight:ListBrands`
+ `quicksight:UpdateBrandAssignment`
+ `quicksight:DescribeBrandAssignment`
+ `quicksight:DeleteBrandAssignment`

After you confirm that your Admin role contains the required permissions, you can [Create a custom brand](https://docs.aws.amazon.com/quicksight/latest/user/brand-customization-create.html) in the Amazon Quick admin console.

## Create a custom brand in Amazon Quick
<a name="brand-customization-create"></a>

Use the following procedure to create a custom brand in Amazon Quick.

1. Open the [Quick console](https://quicksight.aws.amazon.com/).

1. Choose the user icon at the top right, and then choose **Manage Quick**.

1. Choose **Customize application**.

1. On the **Customize application** page that opens, choose **ADD BRAND**. The **Brand settings** page opens.

1. Navigate to the **Brand Info** section.

1. For **Brand name**, enter a name for the brand. The brand name can contain up to 512 characters.

1. (Optional) For **Brand description**, enter a description for the custom brand. The brand description can contain up to 512 characters.

1. Navigate to the **Logo** section.  
![\[The Logo section of the Brand Info page.\]](http://docs.aws.amazon.com/quick/latest/userguide/images/logo.png)

1. For **Primary**, choose the ellipsis (three dots) next to the primary icon, and then choose **Replace image**.

1. In the **Choose image** pop up that opens, perform one of the following actions:

   1. Drag and drop image into the **Drag an image here** box.

   1. Choose **Select a file** to select a file from your computer.

   1. Enter a public URL or Amazon S3 URI in the text bar.

   The image that you choose must be a `.jpeg`, `.png`, or `.svg` format and can't exceed 1MB.

   When you are finished choosing an image, choose **Apply**.

1. For **Favicon**, choose the ellipsis (three dots) next to the favicon, and then choose **Replace image**.

1. In the **Choose image** pop up that opens, perform one of the following actions:

   1. Drag and drop image into the **Drag an image here** box.

   1. Choose **Select a file** to select a file from your computer.

   1. Enter a public URL or Amazon S3 URI in the text bar.

   The image that you choose must be a `.jpeg`, `.png`, or `.svg` format and can't exceed 1MB.

   When you are finished choosing an image, choose **Apply**.

1. (Optional) For **Alt text**, enter alt text to display with the logo. The alt text can contain up to 512 characters.

1. To make changes to the theme colors of the brand, navigate to the **Appearance** pane on the left and choose **Theme**.

1. The **Theme settings** page appears and displays all parts of a Amazon Quick theme that can be customized. The following image shows the configuration settings of the global navigation bar.  
![\[The configuration settings for the global navigation bar. Use the Background and Foreground swatches to customize the colors of every theme item listed on the Theme settings page.\]](http://docs.aws.amazon.com/quick/latest/userguide/images/navigation-bar.png)

1. To change the background color of an area, navigate to the item that you want to change and choose the **Background** color swatch.

1. In the **Custom color** pop up that appears, choose a color from the color gradient or enter a hex code value in the **HEX** bar, and then choose **APPLY**.

1. To change the foreground color of an area, navigate to the item that you want to change and choose the **Foreground** color swatch.

1. In the **Custom color** pop up that appears, choose a color from the color gradient or enter a hex code value in the **HEX** bar, and then choose **APPLY**.

1. When you are finished configuring a custom brand, choose **PUBLISH** to publish and apply the brand customization to all Amazon Quick user accounts. If you don't want to publish the brand, choose **SAVE** to save the brand for later.

When you finish creating a brand in Amazon Quick, the new brand appears in the brands table on the **Customize application** page of the Quick admin console. The **Status** column of the brands table indicates which brand is currently published to the Quick account. To make changes to a custom brand, locate the brand that you want to change in the brands table, choose the ellipsis (three dots) icon in the **Actions** column, and then choose **Publish**, **Edit**, or **Delete**. 

Once you publish a brand, it can take up to 10 minutes for the new brand to propagate across all users.

# Setting a default theme for Amazon Quick analyses with the Amazon Quick APIs
<a name="customizing-quicksight-default-theme"></a>

**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](https://docs.aws.amazon.com//quicksight/latest/APIReference/API_ListThemes.html) 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'
   ```

   

1. Use the [ListUsers](https://docs.aws.amazon.com//quicksight/latest/APIReference/API_ListUsers.html) or [ListGroups](https://docs.aws.amazon.com//quicksight/latest/APIReference/API_ListGroups.html) 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 Amazon Quick ARNs, see [ARN formats](https://docs.aws.amazon.com//quicksight/latest/APIReference/qs-arn-format.html) in the *Quick API Reference.* 

1. 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](https://docs.aws.amazon.com//quicksight/latest/APIReference/API_UpdateThemePermissions.html) command The `grant-permissions` parameter is shown using shorthand syntax. You can use JSON or YAML instead. For more information, see [Specifying parameter values](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html) 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"
   ```

1. 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`
+ `arn:aws:quicksight::aws:theme/RAINIER`