Class: Aws::QuickSight::Types::GetDashboardEmbedUrlRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::QuickSight::Types::GetDashboardEmbedUrlRequest
- Defined in:
- gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb
Overview
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
-
#additional_dashboard_ids ⇒ Array<String>
A list of one or more dashboard IDs that you want to add to a session that includes anonymous users.
-
#aws_account_id ⇒ String
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
-
#dashboard_id ⇒ String
The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
-
#identity_type ⇒ String
The authentication method that the user uses to sign in.
-
#namespace ⇒ String
The Amazon QuickSight namespace that contains the dashboard IDs in this request.
-
#reset_disabled ⇒ Boolean
Remove the reset button on the embedded dashboard.
-
#session_lifetime_in_minutes ⇒ Integer
How many minutes the session is valid.
-
#state_persistence_enabled ⇒ 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.
-
#user_arn ⇒ String
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
QUICKSIGHT
identity type.
Instance Attribute Details
#additional_dashboard_ids ⇒ Array<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.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_id ⇒ String
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_id ⇒ String
The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_type ⇒ String
The authentication method that the user uses to sign in.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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 |
#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
.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_disabled ⇒ Boolean
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_minutes ⇒ Integer
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_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
(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
.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_disabled ⇒ Boolean
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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_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.
7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7371 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 |