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

Description

Synopsis

Documentation

data TemplateVersionDefinition Source #

The detailed definition of a template.

See: newTemplateVersionDefinition smart constructor.

Constructors

TemplateVersionDefinition'

Fields

analysisDefaults :: Maybe AnalysisDefaults
calculatedFields :: Maybe [CalculatedField]
An array of calculated field definitions for the template.
columnConfigurations :: Maybe [ColumnConfiguration]
An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
filterGroups :: Maybe [FilterGroup]
Filter definitions for a template.
For more information, see Filtering Data in the Amazon QuickSight User Guide.
parameterDeclarations :: Maybe [ParameterDeclaration]
An array of parameter declarations for a template.
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 template.
dataSetConfigurations :: [DataSetConfiguration]
An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

Instances

Instances details

FromJSON TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition Methods parseJSON :: Value -> Parser TemplateVersionDefinition # parseJSONList :: Value -> Parser [TemplateVersionDefinition] #
ToJSON TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition Methods toJSON :: TemplateVersionDefinition -> Value # toEncoding :: TemplateVersionDefinition -> Encoding # toJSONList :: [TemplateVersionDefinition] -> Value # toEncodingList :: [TemplateVersionDefinition] -> Encoding #
Generic TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition Associated Types type Rep TemplateVersionDefinition :: Type -> Type # Methods from :: TemplateVersionDefinition -> Rep TemplateVersionDefinition x # to :: Rep TemplateVersionDefinition x -> TemplateVersionDefinition #
Show TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition Methods showsPrec :: Int -> TemplateVersionDefinition -> ShowS # show :: TemplateVersionDefinition -> String # showList :: [TemplateVersionDefinition] -> ShowS #
NFData TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition Methods rnf :: TemplateVersionDefinition -> () #
Eq TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition Methods (==) :: TemplateVersionDefinition -> TemplateVersionDefinition -> Bool # (/=) :: TemplateVersionDefinition -> TemplateVersionDefinition -> Bool #
Hashable TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition Methods hashWithSalt :: Int -> TemplateVersionDefinition -> Int # hash :: TemplateVersionDefinition -> Int #
type Rep TemplateVersionDefinition Source #
Instance details Defined in Amazonka.QuickSight.Types.TemplateVersionDefinition type Rep TemplateVersionDefinition = D1 ('MetaData "TemplateVersionDefinition" "Amazonka.QuickSight.Types.TemplateVersionDefinition" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "TemplateVersionDefinition'" '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 "dataSetConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DataSetConfiguration])))))

newTemplateVersionDefinition :: TemplateVersionDefinition Source #

Create a value of TemplateVersionDefinition 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:TemplateVersionDefinition', templateVersionDefinition_analysisDefaults - Undocumented member.

$sel:calculatedFields:TemplateVersionDefinition', templateVersionDefinition_calculatedFields - An array of calculated field definitions for the template.

$sel:columnConfigurations:TemplateVersionDefinition', templateVersionDefinition_columnConfigurations - An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

$sel:filterGroups:TemplateVersionDefinition', templateVersionDefinition_filterGroups - Filter definitions for a template.

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

$sel:parameterDeclarations:TemplateVersionDefinition', templateVersionDefinition_parameterDeclarations - An array of parameter declarations for a template.

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:TemplateVersionDefinition', templateVersionDefinition_sheets - An array of sheet definitions for a template.

$sel:dataSetConfigurations:TemplateVersionDefinition', templateVersionDefinition_dataSetConfigurations - An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

templateVersionDefinition_analysisDefaults :: Lens' TemplateVersionDefinition (Maybe AnalysisDefaults) Source #

Undocumented member.

templateVersionDefinition_calculatedFields :: Lens' TemplateVersionDefinition (Maybe [CalculatedField]) Source #

An array of calculated field definitions for the template.

templateVersionDefinition_columnConfigurations :: Lens' TemplateVersionDefinition (Maybe [ColumnConfiguration]) Source #

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

templateVersionDefinition_filterGroups :: Lens' TemplateVersionDefinition (Maybe [FilterGroup]) Source #

Filter definitions for a template.

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

templateVersionDefinition_parameterDeclarations :: Lens' TemplateVersionDefinition (Maybe [ParameterDeclaration]) Source #

An array of parameter declarations for a template.

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.

templateVersionDefinition_sheets :: Lens' TemplateVersionDefinition (Maybe [SheetDefinition]) Source #

An array of sheet definitions for a template.

templateVersionDefinition_dataSetConfigurations :: Lens' TemplateVersionDefinition [DataSetConfiguration] Source #

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.