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
  session_lifetime_in_minutes: 1,
  undo_redo_disabled: false,
  reset_disabled: false,
  user_arn: "Arn",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5437

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

#dashboard_idString

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

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5437

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

#identity_typeString

The authentication method that the user uses to sign in.

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5437

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :user_arn)
  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)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5437

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :user_arn)
  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)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5437

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :user_arn)
  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)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5437

class GetDashboardEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :identity_type,
  :session_lifetime_in_minutes,
  :undo_redo_disabled,
  :reset_disabled,
  :user_arn)
  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.

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5437

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