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

Description

 
Synopsis

Documentation

data AnonymousUserDashboardEmbeddingConfiguration Source #

Information about the dashboard that you want to embed.

See: newAnonymousUserDashboardEmbeddingConfiguration smart constructor.

Constructors

AnonymousUserDashboardEmbeddingConfiguration' 

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.

    The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

Instances

Instances details
Eq AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

Read AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

Show AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

Generic AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

NFData AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

Hashable AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

ToJSON AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

type Rep AnonymousUserDashboardEmbeddingConfiguration Source # 
Instance details

Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardEmbeddingConfiguration

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

newAnonymousUserDashboardEmbeddingConfiguration Source #

Create a value of AnonymousUserDashboardEmbeddingConfiguration 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:AnonymousUserDashboardEmbeddingConfiguration', anonymousUserDashboardEmbeddingConfiguration_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.

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

anonymousUserDashboardEmbeddingConfiguration_initialDashboardId :: Lens' AnonymousUserDashboardEmbeddingConfiguration 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.

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.