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

Description

Synopsis

Documentation

data DashboardVersionDefinition Source #

The contents of a dashboard.

See: newDashboardVersionDefinition smart constructor.

Constructors

DashboardVersionDefinition'

Fields

analysisDefaults :: Maybe AnalysisDefaults
calculatedFields :: Maybe [CalculatedField]
An array of calculated field definitions for the dashboard.
columnConfigurations :: Maybe [ColumnConfiguration]
An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.
filterGroups :: Maybe [FilterGroup]
The filter definitions for a dashboard.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
parameterDeclarations :: Maybe [ParameterDeclaration]
The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.
For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
sheets :: Maybe [SheetDefinition]
An array of sheet definitions for a dashboard.
dataSetIdentifierDeclarations :: NonEmpty DataSetIdentifierDeclaration
An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

Instances

Instances details

FromJSON DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition Methods parseJSON :: Value -> Parser DashboardVersionDefinition # parseJSONList :: Value -> Parser [DashboardVersionDefinition] #
ToJSON DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition Methods toJSON :: DashboardVersionDefinition -> Value # toEncoding :: DashboardVersionDefinition -> Encoding # toJSONList :: [DashboardVersionDefinition] -> Value # toEncodingList :: [DashboardVersionDefinition] -> Encoding #
Generic DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition Associated Types type Rep DashboardVersionDefinition :: Type -> Type # Methods from :: DashboardVersionDefinition -> Rep DashboardVersionDefinition x # to :: Rep DashboardVersionDefinition x -> DashboardVersionDefinition #
Show DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition Methods showsPrec :: Int -> DashboardVersionDefinition -> ShowS # show :: DashboardVersionDefinition -> String # showList :: [DashboardVersionDefinition] -> ShowS #
NFData DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition Methods rnf :: DashboardVersionDefinition -> () #
Eq DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition Methods (==) :: DashboardVersionDefinition -> DashboardVersionDefinition -> Bool # (/=) :: DashboardVersionDefinition -> DashboardVersionDefinition -> Bool #
Hashable DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition Methods hashWithSalt :: Int -> DashboardVersionDefinition -> Int # hash :: DashboardVersionDefinition -> Int #
type Rep DashboardVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.DashboardVersionDefinition type Rep DashboardVersionDefinition = D1 ('MetaData "DashboardVersionDefinition" "Amazonka.QuickSight.Types.DashboardVersionDefinition" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DashboardVersionDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analysisDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalysisDefaults)) :: (S1 ('MetaSel ('Just "calculatedFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CalculatedField])) :: S1 ('MetaSel ('Just "columnConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ColumnConfiguration])))) :: ((S1 ('MetaSel ('Just "filterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FilterGroup])) :: S1 ('MetaSel ('Just "parameterDeclarations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterDeclaration]))) :: (S1 ('MetaSel ('Just "sheets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SheetDefinition])) :: S1 ('MetaSel ('Just "dataSetIdentifierDeclarations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty DataSetIdentifierDeclaration))))))

newDashboardVersionDefinition Source #

Arguments

:: NonEmpty DataSetIdentifierDeclaration	`$sel:dataSetIdentifierDeclarations:DashboardVersionDefinition'`
-> DashboardVersionDefinition

Create a value of DashboardVersionDefinition 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:analysisDefaults:DashboardVersionDefinition', dashboardVersionDefinition_analysisDefaults - Undocumented member.

$sel:calculatedFields:DashboardVersionDefinition', dashboardVersionDefinition_calculatedFields - An array of calculated field definitions for the dashboard.

$sel:columnConfigurations:DashboardVersionDefinition', dashboardVersionDefinition_columnConfigurations - An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

$sel:filterGroups:DashboardVersionDefinition', dashboardVersionDefinition_filterGroups - The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

$sel:parameterDeclarations:DashboardVersionDefinition', dashboardVersionDefinition_parameterDeclarations - The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

$sel:sheets:DashboardVersionDefinition', dashboardVersionDefinition_sheets - An array of sheet definitions for a dashboard.

$sel:dataSetIdentifierDeclarations:DashboardVersionDefinition', dashboardVersionDefinition_dataSetIdentifierDeclarations - An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

dashboardVersionDefinition_analysisDefaults :: Lens' DashboardVersionDefinition (Maybe AnalysisDefaults) Source #

Undocumented member.

dashboardVersionDefinition_calculatedFields :: Lens' DashboardVersionDefinition (Maybe [CalculatedField]) Source #

An array of calculated field definitions for the dashboard.

dashboardVersionDefinition_columnConfigurations :: Lens' DashboardVersionDefinition (Maybe [ColumnConfiguration]) Source #

An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

dashboardVersionDefinition_filterGroups :: Lens' DashboardVersionDefinition (Maybe [FilterGroup]) Source #

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

dashboardVersionDefinition_parameterDeclarations :: Lens' DashboardVersionDefinition (Maybe [ParameterDeclaration]) Source #

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

dashboardVersionDefinition_sheets :: Lens' DashboardVersionDefinition (Maybe [SheetDefinition]) Source #

An array of sheet definitions for a dashboard.

dashboardVersionDefinition_dataSetIdentifierDeclarations :: Lens' DashboardVersionDefinition (NonEmpty DataSetIdentifierDeclaration) Source #

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.