@aws-sdk/client-quicksight

GetDashboardEmbedUrlCommandInput Interface

The input for GetDashboardEmbedUrlCommand.

Members

Name
Type
Details
AwsAccountId Requiredstring | undefined

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

DashboardId Requiredstring | undefined

The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

IdentityType RequiredEmbeddingIdentityType | undefined

The authentication method that the user uses to sign in.

AdditionalDashboardIds string[] | undefined

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Namespace string | undefined

The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.

ResetDisabled boolean | undefined

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

SessionLifetimeInMinutes number | undefined

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

StatePersistenceEnabled boolean | undefined

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

UndoRedoDisabled boolean | undefined

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

UserArn string | undefined

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

Full Signature

export interface GetDashboardEmbedUrlCommandInput extends GetDashboardEmbedUrlRequest