

# Customizations
<a name="customizations"></a>

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

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

The following customization options are currently available:
+ You can customize the welcome content Quick provides for new users:
  + 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 introductory videos. These videos include the animation that displays for new users and also the tutorial videos shown on the Amazon Quick home page. 
+ You can create and specify a default theme.
+ You can customize dashboard report emails, pixel perfect report emails, and alert emails by editing the email template.

**Important**  
All customizations apply only to the AWS Region that you are using in the API or that is selected in the Amazon Quick console. 

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

**To check your AWS Region on the Amazon Quick console**

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

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

1. (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.

**Topics**
+ [Amazon Quick brand customization](brand-customization.md)
+ [Chat agent customization in Amazon Quick](manage-agent.md)

# 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`

# Chat agent customization in Amazon Quick
<a name="manage-agent"></a>

When a user account subscribes to Quick, the service automatically creates a system default chat agent. This agent powers the default chat experience, allowing Amazon Quick users to leverage all chat functionalities (such as uploading files to chat, using large language model (LLM) parametric knowledge, and answering from their enterprise data) out of the box. The system default chat agent can be updated in the Amazon Quick agent section by a select set of users who are designated as owners for the agent by the admin.

All chat agents (including system and custom) as well as flows are also equipped with guardrails and safety controls to ensure responsible use. Any agent or flow that you chat with will use these default guardrails powering the chat interactions:
+ **Prompt leak protection** – Automatically enabled to prevent prompt injection and other LLM-breaking attacks.
+ **Prompt safety** – Protects against common security threats like malicious instructions, instructions to ignore guardrails, and others.
+ **Blocked words and phrases** – Protects against inappropriate content including insults, hate speech, sexual content, violence, and misconduct, for both chat requests and responses. 

As an admin, you can define blocked phrases for all Amazon Quick chat agents. If you do, Amazon Quick ensures that chat agent and flows responses across your Amazon Quick instance don't include these words or phrases. No blocked words or phrases are assigned to your chat agent or flows by default. You can choose up to 50 words or phrases to block.

Admins can also configure whether URLs in chat responses appear as clickable hyperlinks or plain text. This setting applies across all chat agents and flows in your instance, allowing you to control how links are presented to users.

**Note**  
Admins can also control permissions for whether users can create and use chat agents and flows. For instructions on how to do that, see [Custom permissions](https://docs.aws.amazon.com/quicksuite/latest/userguide/create-custom-permissions-profile.html).

The following sections outline how to edit the system default agent and add blocked words for chat to influence all agent responses and flows.

**Topics**
+ [Grant user permissions to edit system default chat agent](#edit-default-agent-permissions)
+ [Edit system chat agent settings](#edit-default-agent)
+ [Configure clickable external links in chat responses](#configure-clickable-links)
+ [Adding blocked words and phrases for chat agents](#general-agent-settings)
+ [Edit blocked words and phrases for chat agents and flows](#edit-general-agent-settings)

## Grant user permissions to edit system default chat agent
<a name="edit-default-agent-permissions"></a>

The system default chat agent can be edited by users the admin designates as owners to this agent in the admin console. The following procedure shows you how to grant admin permissions to a user so that they can edit the system default agent.

**To grant permissions to edit system default agent**

1. Log in to the Amazon Quick console.

1. Select **Manage Quick** from the Amazon Quick admin console.

1. From the admin console left navigation menu, select **Account**, and then select **Manage assets**.

1. In **Manage assets**, select **Chat agents**.

1. Select **My Assistant** from the list of chat agents shown. Then, from the **Actions** menu, select **Share**.

1. In the **Share assets** modal, use the **User or Group** search bar to find the user or group you want to designate as owners for the system agent.

1. Then, from **Permissions**, choose **Owner**. Then, select **Share**.

## Edit system chat agent settings
<a name="edit-default-agent"></a>

To customize your system chat agent, users designated as owners need to login to Amazon Quick and visit the agent library page. Admins can directly access this page by clicking on the **Go to agent** link in admin console under **Chat agent customization**. Once in Amazon Quick, follow these steps to edit your system default chat agent's properties. You can preview and test how your system agent works as you configure it.

**To update system chat agent settings**

1. Log in to the Amazon Quick console.

1. Select **Manage Quick** from the Amazon Quick admin console.

1. From the admin console left navigation menu, select **Customization**, and then select **Chat agent customization**.

1. In **Chat agent customization**, in **System chat agent**, select **Go to chat agent**.

1. In the **My Assistant** page, in **Configure chat agent**, customize the following sections:

   1. In **Chat agent persona**, configure your chat agent's personality, identity, tone, and response style. For detailed information about agent customization options, see [Working with chat agents](https://docs.aws.amazon.com/quicksuite/latest/userguide/working-with-agents.html) in the *Amazon Quick User Guide*.
**Note**  
This agent powers default chat interactions across all users of this account with chat feature access. Ensure that your instructions (e.g. identity and response style) work well for all users of this account.

   1. In **Reference documents**, upload files that remain active in your chat agent's memory to guide all interactions. For detailed information about file upload options, see [Working with chat agents](https://docs.aws.amazon.com/quicksuite/latest/userguide/working-with-agents.html) in the *Amazon Quick User Guide*.
**Note**  
Since this agent is meant for broad use, this is a place to upload enterprise-level response templates and guides.  
The system default agent isn't linked to specific knowledge sources, actions, or spaces to ensure it works for all users regardless of their access permissions. This setting can't be changed.

1. In **Customization**, configure details to help recognize the chat agent. For detailed information about customization options, see [Working with chat agents](https://docs.aws.amazon.com/quicksuite/latest/userguide/working-with-agents.html) in the *Amazon Quick User Guide*. 

## Configure clickable external links in chat responses
<a name="configure-clickable-links"></a>

Admins can configure whether URLs in chat agent responses appear as clickable hyperlinks. The following procedure shows you how to enable clickable hyperlinks for all chat agents in your Amazon Quick instance.

**To enable clickable external links**

1. Log in to the Amazon Quick console.

1. Select **Manage Quick** from the Amazon Quick admin console.

1. From the admin console left navigation menu, select **Customization**, and then select **Chat agent customization**.

1. Under **Clickable external links**, turn the toggle on.

## Adding blocked words and phrases for chat agents
<a name="general-agent-settings"></a>

Default guardrails and admin provided blocked words serve as general settings that all chat agents and flows consider when the user chats with them. Admin configured blocked words are filtered out from responses in both chat agents and flows within your Amazon Quick instance.

To learn more about chat agents, see [Working with chat agents](https://docs.aws.amazon.com/quicksuite/latest/userguide/working-with-agents.html) in the *Amazon Quick User Guide*.

**To assign blocked words and phrases for all chat agents**

1. Log in to the Amazon Quick console.

1. Select **Manage Quick**.

1. From the left navigation menu, select **Customization**, and then select **Chat agent customization**.

1. In **Chat agent customizations**, for **Guardrails and safety controls**, do the following:

   1. **Add blocked words and phrases** – Select **Add** to add blocked words and phrases. You can add upto 50 words and phrases.

## Edit blocked words and phrases for chat agents and flows
<a name="edit-general-agent-settings"></a>

To edit blocked words and phrases added to chat agents and flows, use the following procedure.

**To edit blocked words and phrases for all chat agents and flows**

1. Log in to the Amazon Quick console.

1. Select **Manage Quick**.

1. From the left navigation menu, select **Customization**, and then select **Chat agent customization**.

1. In **Chat agent customization**, for **Guardrails and safety controls**, do the following:

   1. **Add blocked words and phrases** – Select **Remove** to remove existing blocked words and phrases. Or, select **Add** to add new ones. You can add upto 50 words and phrases.