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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass GetDashboardEmbedUrlRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, ANONYMOUS
  session_lifetime_in_minutes: 1,
  undo_redo_disabled: false,
  reset_disabled: false,
  state_persistence_enabled: false,
  user_arn: "Arn",
  namespace: "Namespace",
  additional_dashboard_ids: ["RestrictiveResourceId"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_dashboard_idsArray<String>

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, 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.

Returns:

  • (Array<String>)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

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

Returns:

  • (String)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_idString

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

Returns:

  • (String)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#identity_typeString

The authentication method that the user uses to sign in.

Returns:

  • (String)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

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

Returns:

  • (String)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#reset_disabledBoolean

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

Returns:

  • (Boolean)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#session_lifetime_in_minutesInteger

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

Returns:

  • (Integer)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#state_persistence_enabledBoolean

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.

Returns:

  • (Boolean)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#undo_redo_disabledBoolean

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

Returns:

  • (Boolean)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end

#user_arnString

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)


7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7309

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :state_persistence_enabled,
  :user_arn,
  :namespace,
  :additional_dashboard_ids)
  SENSITIVE = []
  include Aws::Structure
end