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.RegisteredUserDashboardEmbeddingConfiguration

Description

 
Synopsis

Documentation

data RegisteredUserDashboardEmbeddingConfiguration Source #

Information about the dashboard you want to embed.

See: newRegisteredUserDashboardEmbeddingConfiguration smart constructor.

Constructors

RegisteredUserDashboardEmbeddingConfiguration' 

Fields

  • initialDashboardId :: Text

    The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

    If the user does not have permission to view this dashboard, they see a permissions error message.

Instances

Instances details
Eq RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

Read RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

Show RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

Generic RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

NFData RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

Hashable RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

ToJSON RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

type Rep RegisteredUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.RegisteredUserDashboardEmbeddingConfiguration

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

newRegisteredUserDashboardEmbeddingConfiguration Source #

Create a value of RegisteredUserDashboardEmbeddingConfiguration 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:initialDashboardId:RegisteredUserDashboardEmbeddingConfiguration', registeredUserDashboardEmbeddingConfiguration_initialDashboardId - The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

registeredUserDashboardEmbeddingConfiguration_initialDashboardId :: Lens' RegisteredUserDashboardEmbeddingConfiguration Text Source #

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.