AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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 GenerateEmbedUrlForRegisteredUserRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  session_lifetime_in_minutes: 1,
  user_arn: "Arn", # required
  experience_configuration: { # required
    dashboard: {
      initial_dashboard_id: "RestrictiveResourceId", # required
    },
    quick_sight_console: {
      initial_path: "EntryPath",
    },
    q_search_bar: {
      initial_topic_id: "RestrictiveResourceId",
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


7078
7079
7080
7081
7082
7083
7084
7085
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7078

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

#experience_configurationTypes::RegisteredUserEmbeddingExperienceConfiguration

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



7078
7079
7080
7081
7082
7083
7084
7085
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7078

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

#session_lifetime_in_minutesInteger

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

Returns:

  • (Integer)


7078
7079
7080
7081
7082
7083
7084
7085
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7078

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

#user_arnString

The Amazon Resource Name for the registered user.

Returns:

  • (String)


7078
7079
7080
7081
7082
7083
7084
7085
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7078

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