libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

Description

 
Synopsis

Documentation

data RegisteredUserQuickSightConsoleEmbeddingConfiguration Source #

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

See: newRegisteredUserQuickSightConsoleEmbeddingConfiguration smart constructor.

Constructors

RegisteredUserQuickSightConsoleEmbeddingConfiguration' 

Fields

  • initialPath :: Maybe Text

    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.

Instances

Instances details
Eq RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

Read RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

Show RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

Generic RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

NFData RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

Hashable RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

ToJSON RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

type Rep RegisteredUserQuickSightConsoleEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration

type Rep RegisteredUserQuickSightConsoleEmbeddingConfiguration = D1 ('MetaData "RegisteredUserQuickSightConsoleEmbeddingConfiguration" "Amazonka.QuickSight.Types.RegisteredUserQuickSightConsoleEmbeddingConfiguration" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "RegisteredUserQuickSightConsoleEmbeddingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "initialPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newRegisteredUserQuickSightConsoleEmbeddingConfiguration :: RegisteredUserQuickSightConsoleEmbeddingConfiguration Source #

Create a value of RegisteredUserQuickSightConsoleEmbeddingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:initialPath:RegisteredUserQuickSightConsoleEmbeddingConfiguration', registeredUserQuickSightConsoleEmbeddingConfiguration_initialPath - 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.

registeredUserQuickSightConsoleEmbeddingConfiguration_initialPath :: Lens' RegisteredUserQuickSightConsoleEmbeddingConfiguration (Maybe Text) Source #

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.