Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration

Description

Synopsis

data AnonymousUserDashboardVisualEmbeddingConfiguration = AnonymousUserDashboardVisualEmbeddingConfiguration' {
- initialDashboardVisualId :: DashboardVisualId
}
newAnonymousUserDashboardVisualEmbeddingConfiguration :: DashboardVisualId -> AnonymousUserDashboardVisualEmbeddingConfiguration
anonymousUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' AnonymousUserDashboardVisualEmbeddingConfiguration DashboardVisualId

Documentation

data AnonymousUserDashboardVisualEmbeddingConfiguration Source #

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

See: newAnonymousUserDashboardVisualEmbeddingConfiguration smart constructor.

Constructors

AnonymousUserDashboardVisualEmbeddingConfiguration'

Fields

initialDashboardVisualId :: DashboardVisualId
The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

Instances

Instances details

ToJSON AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration Methods toJSON :: AnonymousUserDashboardVisualEmbeddingConfiguration -> Value # toEncoding :: AnonymousUserDashboardVisualEmbeddingConfiguration -> Encoding # toJSONList :: [AnonymousUserDashboardVisualEmbeddingConfiguration] -> Value # toEncodingList :: [AnonymousUserDashboardVisualEmbeddingConfiguration] -> Encoding #
Generic AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration Associated Types type Rep AnonymousUserDashboardVisualEmbeddingConfiguration :: Type -> Type # Methods from :: AnonymousUserDashboardVisualEmbeddingConfiguration -> Rep AnonymousUserDashboardVisualEmbeddingConfiguration x # to :: Rep AnonymousUserDashboardVisualEmbeddingConfiguration x -> AnonymousUserDashboardVisualEmbeddingConfiguration #
Read AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration Methods readsPrec :: Int -> ReadS AnonymousUserDashboardVisualEmbeddingConfiguration # readList :: ReadS [AnonymousUserDashboardVisualEmbeddingConfiguration] # readPrec :: ReadPrec AnonymousUserDashboardVisualEmbeddingConfiguration # readListPrec :: ReadPrec [AnonymousUserDashboardVisualEmbeddingConfiguration] #
Show AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration Methods showsPrec :: Int -> AnonymousUserDashboardVisualEmbeddingConfiguration -> ShowS # show :: AnonymousUserDashboardVisualEmbeddingConfiguration -> String # showList :: [AnonymousUserDashboardVisualEmbeddingConfiguration] -> ShowS #
NFData AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration Methods rnf :: AnonymousUserDashboardVisualEmbeddingConfiguration -> () #
Eq AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration Methods (==) :: AnonymousUserDashboardVisualEmbeddingConfiguration -> AnonymousUserDashboardVisualEmbeddingConfiguration -> Bool # (/=) :: AnonymousUserDashboardVisualEmbeddingConfiguration -> AnonymousUserDashboardVisualEmbeddingConfiguration -> Bool #
Hashable AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration Methods hashWithSalt :: Int -> AnonymousUserDashboardVisualEmbeddingConfiguration -> Int # hash :: AnonymousUserDashboardVisualEmbeddingConfiguration -> Int #
type Rep AnonymousUserDashboardVisualEmbeddingConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration type Rep AnonymousUserDashboardVisualEmbeddingConfiguration = D1 ('MetaData "AnonymousUserDashboardVisualEmbeddingConfiguration" "Amazonka.QuickSight.Types.AnonymousUserDashboardVisualEmbeddingConfiguration" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "AnonymousUserDashboardVisualEmbeddingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "initialDashboardVisualId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DashboardVisualId)))

newAnonymousUserDashboardVisualEmbeddingConfiguration Source #

Arguments

:: DashboardVisualId	`$sel:initialDashboardVisualId:AnonymousUserDashboardVisualEmbeddingConfiguration'`
-> AnonymousUserDashboardVisualEmbeddingConfiguration

Create a value of AnonymousUserDashboardVisualEmbeddingConfiguration 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:initialDashboardVisualId:AnonymousUserDashboardVisualEmbeddingConfiguration', anonymousUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId - The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

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

anonymousUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' AnonymousUserDashboardVisualEmbeddingConfiguration DashboardVisualId Source #

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

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