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

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",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aws_account_id ⇒ 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.

• #identity_type ⇒ String

  The authentication method that the user uses to sign in.

• #reset_disabled ⇒ Boolean

  Remove the reset button on the embedded dashboard.

• #session_lifetime_in_minutes ⇒ Integer

  How many minutes the session is valid.

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

#aws_account_id ⇒ String

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

Returns:

• (String)

# 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_id ⇒ String

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

Returns:

• (String)

# 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_type ⇒ String

The authentication method that the user uses to sign in.

Returns:

• (String)

# 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_disabled ⇒ Boolean

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

Returns:

• (Boolean)

# 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_minutes ⇒ Integer

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

Returns:

• (Integer)

# 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_disabled ⇒ Boolean

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

Returns:

• (Boolean)

# 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_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.

Returns:

• (String)

# 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