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

Description

Synopsis

Documentation

data DashboardVisualId Source #

A structure that contains the following elements:

The DashboardId of the dashboard that has the visual that you want to embed.
The SheetId of the sheet that has the visual that you want to embed.
The VisualId of the visual that you want to embed.

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

See: newDashboardVisualId smart constructor.

Constructors

DashboardVisualId'

Fields

dashboardId :: Text
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.
sheetId :: Text
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
visualId :: Text
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

Instances

Instances details

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

newDashboardVisualId Source #

Arguments

:: Text	`$sel:dashboardId:DashboardVisualId'`
-> Text	`$sel:sheetId:DashboardVisualId'`
-> Text	`$sel:visualId:DashboardVisualId'`
-> DashboardVisualId

Create a value of DashboardVisualId 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:dashboardId:DashboardVisualId', dashboardVisualId_dashboardId - The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

$sel:sheetId:DashboardVisualId', dashboardVisualId_sheetId - The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

$sel:visualId:DashboardVisualId', dashboardVisualId_visualId - The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

dashboardVisualId_dashboardId :: Lens' DashboardVisualId Text Source #

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

dashboardVisualId_sheetId :: Lens' DashboardVisualId Text Source #

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

dashboardVisualId_visualId :: Lens' DashboardVisualId Text Source #

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.