Class: Aws::QuickSight::Types::GenerateEmbedUrlForRegisteredUserRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_domains ⇒ Array<String>

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Returns:

  • (Array<String>) 


15686
15687
15688
15689
15690
15691
15692
15693
15694
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15686

class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :user_arn,
  :experience_configuration,
  :allowed_domains)
  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.

Returns:

  • (String) 


15686
15687
15688
15689
15690
15691
15692
15693
15694
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15686

class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :user_arn,
  :experience_configuration,
  :allowed_domains)
  SENSITIVE = []
  include Aws::Structure
end

#experience_configuration ⇒ Types::RegisteredUserEmbeddingExperienceConfiguration

The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.

Returns:



15686
15687
15688
15689
15690
15691
15692
15693
15694
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15686

class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :user_arn,
  :experience_configuration,
  :allowed_domains)
  SENSITIVE = []
  include Aws::Structure
end

#session_lifetime_in_minutes ⇒ Integer

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

Returns:

  • (Integer) 


15686
15687
15688
15689
15690
15691
15692
15693
15694
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15686

class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :user_arn,
  :experience_configuration,
  :allowed_domains)
  SENSITIVE = []
  include Aws::Structure
end

#user_arn ⇒ String

The Amazon Resource Name for the registered user.

Returns:

  • (String) 


15686
15687
15688
15689
15690
15691
15692
15693
15694
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15686

class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :user_arn,
  :experience_configuration,
  :allowed_domains)
  SENSITIVE = []
  include Aws::Structure
end