@aws-sdk/client-quicksight

GenerateEmbedUrlForRegisteredUserCommandInput Interface

Members

Name
Type
Details
AwsAccountId Requiredstring | undefined

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

ExperienceConfiguration RequiredRegisteredUserEmbeddingExperienceConfiguration | undefined

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

UserArn Requiredstring | undefined

The Amazon Resource Name for the registered user.

AllowedDomains string[] | undefined

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

SessionLifetimeInMinutes number | undefined

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

Full Signature

export interface GenerateEmbedUrlForRegisteredUserCommandInput extends GenerateEmbedUrlForRegisteredUserRequest