Managing domains
| Applies to: Enterprise Edition |
| Intended audience: Amazon Quick Suite administrators |
In Amazon Quick Suite Enterprise edition, you can embed Amazon Quick Sight dashboards, visuals, consoles, and Q search bars in an app or web page. Domains that are going to host these embedded assets must be on an allow list, the list of approved domains for your Quick Suite subscription. This requirement protects your data by preventing unapproved domains from hosting embedded dashboards. To embed a Amazon Quick Sight dashboard, visual, console, or Q search bar to a web page or app, add approved domains to a static allow list in the Quick Suite console. Alternatively, add them at runtime with the Quick Suite API.
Use the following sections to learn more about adding domains for embedded analytics.
Allow listing static domains
You can add static domains to your allow list through the Amazon Quick Suite console. All domains on your allow list (such as development, staging, and production) must be explicitly allowed, and they must use HTTPS. You can add up to 100 domains to the allow list.
To embed a dashboard to a static domain:
-
Approve the hosting domains and subdomains for embedding.
-
Publish the dashboard.
-
Share the dashboard with users or groups so they can see the embedded version of it.
Use the following procedure to view or edit the list of approved domains.
To view or edit the list of approved domains
-
Choose the profile icon at top right.
-
Choose Manage Amazon Quick Suite. You must be an Amazon Quick Suite admin to access this screen.
-
Choose Domains and Embedding on the left. The domains that you can embed a dashboard in are listed at the bottom of the page.
-
(Optional) Add a new domain here by entering it in the Domain box. You can also choose Include subdomains to allow embedded dashboards on all subdomains. Choose Add to add the domain.
You can edit or delete existing domain by choosing the icons next to each domain in the list at the bottom of the page.
Make sure that you use a valid HTTPS URL. The following list shows examples of URLs that are valid for embedded dashboards that use a static domain:
-
https://example-1.com
-
https://www.アマゾンドメイン.jp
-
https://www.亚马逊域名.cn:1234
-
https://111.222.33.44:1234
-
https://111.222.33.44
-
http://localhost
The following list shows examples of URLs that are not valid for embedded dashboards:
-
http://example
-
https://example.com.*.example-1.co.uk
-
https://co.uk
-
https://111.222.33.44.55:1234
-
https://111.222.33.44.55
Allow listing domains at runtime with the Amazon Quick Suite API
You can add a domain at runtime to an allow list with the AllowedDomains
parameter of a GenerateEmbedUrlForAnonymousUser or a
GenerateEmbedUrlForRegisteredUser API call. The
AllowedDomains parameter is an optional parameter. It grants you the
option as a developer to override the static domains that are configured in the
Manage Amazon Quick Suite menu.
You can list up to three domains or subdomains. Adding domains to the allow list at
runtime also adds HTTP support for the domain localhost. The generated URL
is then embedded in a developer's website. Only the domains that are listed in the
parameter can access the embedded dashboard.
To embed a dashboard to a domain at runtime, see Embedding with the Amazon Quick Suite APIs.
Make sure that you use a valid URL. The following list shows examples of URLs that are valid for embedded dashboards that use a runtime domain:
-
https://example-1.com
-
http://localhost
-
https://www.アマゾンドメイン.jp
-
https://*.sapp.amazon.com
The following list shows examples of URLs that are not valid for embedded dashboards:
-
https://example.com.*.example-1.co.uk
-
https://co.uk
-
https://111.222.33.44.55:1234
-
https://111.222.33.44.55
For more information about embedded dashboards, see Embedding with the Amazon Quick Suite APIs.