quicksight/aws.sdk.kotlin.services.quicksight.model/GetDashboardEmbedUrlRequest/Builder

Builder

Properties

var additionalDashboardIds: List<String>?

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.

awsAccountId

var awsAccountId: String?

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

dashboardId

var dashboardId: String?

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

identityType

var identityType: EmbeddingIdentityType?

The authentication method that the user uses to sign in.

namespace

var namespace: String?

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

resetDisabled

var resetDisabled: Boolean?

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

sessionLifetimeInMinutes

var sessionLifetimeInMinutes: Long?

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

statePersistenceEnabled

var statePersistenceEnabled: Boolean?

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

var undoRedoDisabled: Boolean?

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

userArn

var userArn: String?

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: