Allow listing domains at runtime with the QuickSight API - Amazon QuickSight

Allow listing domains at runtime with the QuickSight 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 QuickSight 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 QuickSight 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 Working with embedded analytics.