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

Description

Synopsis

data RegisteredUserDashboardVisualEmbeddingConfiguration = RegisteredUserDashboardVisualEmbeddingConfiguration' {
- initialDashboardVisualId :: DashboardVisualId
}
newRegisteredUserDashboardVisualEmbeddingConfiguration :: DashboardVisualId -> RegisteredUserDashboardVisualEmbeddingConfiguration
registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' RegisteredUserDashboardVisualEmbeddingConfiguration DashboardVisualId

Documentation

data RegisteredUserDashboardVisualEmbeddingConfiguration Source #

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

See: newRegisteredUserDashboardVisualEmbeddingConfiguration smart constructor.

Constructors

RegisteredUserDashboardVisualEmbeddingConfiguration'

Fields

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

newRegisteredUserDashboardVisualEmbeddingConfiguration Source #

Arguments

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

Create a value of RegisteredUserDashboardVisualEmbeddingConfiguration 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:RegisteredUserDashboardVisualEmbeddingConfiguration', registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId - The visual ID for the visual that you want the user to embed. 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.

registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' RegisteredUserDashboardVisualEmbeddingConfiguration DashboardVisualId Source #

The visual ID for the visual that you want the user to embed. 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.