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

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::GenerateEmbedUrlForRegisteredUserRequest

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #aws_account_id ⇒ String

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

• #experience_configuration ⇒ Types::RegisteredUserEmbeddingExperienceConfiguration

  The experience that you want to embed.

• #session_lifetime_in_minutes ⇒ Integer

  How many minutes the session is valid.

• #user_arn ⇒ String

  The Amazon Resource Name for the registered user.

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, `*.sapp.amazon.com` includes all subdomains under `sapp.amazon.com`.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 17428

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)

# File 'lib/aws-sdk-quicksight/types.rb', line 17428

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 that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&amp;A experience, or the entire Amazon QuickSight console.

Returns:

• (Types::RegisteredUserEmbeddingExperienceConfiguration)

# File 'lib/aws-sdk-quicksight/types.rb', line 17428

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)

# File 'lib/aws-sdk-quicksight/types.rb', line 17428

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)

# File 'lib/aws-sdk-quicksight/types.rb', line 17428

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