You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::QuickSight::Types::GetDashboardEmbedUrlRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetDashboardEmbedUrlRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
  session_lifetime_in_minutes: 1,
  undo_redo_disabled: false,
  reset_disabled: false,
  state_persistence_enabled: false,
  user_arn: "Arn",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The ID for the AWS account that contains the dashboard that you\'re embedding.

Returns:

  • (String) —

    The ID for the AWS account that contains the dashboard that you\'re embedding.

#dashboard_id ⇒ String

The ID for the dashboard, also added to the IAM policy.

Returns:

  • (String) —

    The ID for the dashboard, also added to the IAM policy.

#identity_type ⇒ String

The authentication method that the user uses to sign in.

Possible values:

  • IAM
  • QUICKSIGHT

Returns:

  • (String) —

    The authentication method that the user uses to sign in.

#reset_disabled ⇒ Boolean

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

Returns:

  • (Boolean) —

    Remove the reset button on the embedded dashboard.

#session_lifetime_in_minutes ⇒ Integer

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

Returns:

  • (Integer) —

    How many minutes the session is valid.

#state_persistence_enabled ⇒ 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 (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in 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.

Returns:

  • (Boolean) —

    Adds persistence of state for the user session in an embedded dashboard.

#undo_redo_disabled ⇒ Boolean

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

Returns:

  • (Boolean) —

    Remove the undo/redo button on the embedded dashboard.

#user_arn ⇒ 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:

  • 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.

Returns:

  • (String) —

    The Amazon QuickSight user\'s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.