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

Description

Synopsis

Documentation

data AnalysisDefinition Source #

The definition of an analysis.

See: newAnalysisDefinition smart constructor.

Constructors

AnalysisDefinition'

Fields

analysisDefaults :: Maybe AnalysisDefaults
calculatedFields :: Maybe [CalculatedField]
An array of calculated field definitions for the analysis.
columnConfigurations :: Maybe [ColumnConfiguration]
An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.
filterGroups :: Maybe [FilterGroup]
Filter definitions for an analysis.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
parameterDeclarations :: Maybe [ParameterDeclaration]
An array of parameter declarations for an analysis.
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 an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
dataSetIdentifierDeclarations :: NonEmpty DataSetIdentifierDeclaration
An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

Instances

Instances details

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

newAnalysisDefinition Source #

Arguments

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

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

$sel:calculatedFields:AnalysisDefinition', analysisDefinition_calculatedFields - An array of calculated field definitions for the analysis.

$sel:columnConfigurations:AnalysisDefinition', analysisDefinition_columnConfigurations - An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

$sel:filterGroups:AnalysisDefinition', analysisDefinition_filterGroups - Filter definitions for an analysis.

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

$sel:parameterDeclarations:AnalysisDefinition', analysisDefinition_parameterDeclarations - An array of parameter declarations for an analysis.

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:AnalysisDefinition', analysisDefinition_sheets - An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

$sel:dataSetIdentifierDeclarations:AnalysisDefinition', analysisDefinition_dataSetIdentifierDeclarations - An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

analysisDefinition_analysisDefaults :: Lens' AnalysisDefinition (Maybe AnalysisDefaults) Source #

Undocumented member.

analysisDefinition_calculatedFields :: Lens' AnalysisDefinition (Maybe [CalculatedField]) Source #

An array of calculated field definitions for the analysis.

analysisDefinition_columnConfigurations :: Lens' AnalysisDefinition (Maybe [ColumnConfiguration]) Source #

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

analysisDefinition_filterGroups :: Lens' AnalysisDefinition (Maybe [FilterGroup]) Source #

Filter definitions for an analysis.

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

analysisDefinition_parameterDeclarations :: Lens' AnalysisDefinition (Maybe [ParameterDeclaration]) Source #

An array of parameter declarations for an analysis.

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.

analysisDefinition_sheets :: Lens' AnalysisDefinition (Maybe [SheetDefinition]) Source #

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

analysisDefinition_dataSetIdentifierDeclarations :: Lens' AnalysisDefinition (NonEmpty DataSetIdentifierDeclaration) Source #

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.