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::RegisteredUserQuickSightConsoleEmbeddingConfiguration

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

{
  initial_path: "EntryPath",
}

Information about the Amazon QuickSight console that you want to embed.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#initial_pathString

The initial URL path for the Amazon QuickSight console. InitialPath is required.

The entry point URL is constrained to the following paths:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.

  • /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.

Returns:

  • (String)


10261
10262
10263
10264
10265
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10261

class RegisteredUserQuickSightConsoleEmbeddingConfiguration < Struct.new(
  :initial_path)
  SENSITIVE = []
  include Aws::Structure
end