AWS::QuickSight::Analysis AnalysisDefinition
The definition of an analysis.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AnalysisDefaults" :
AnalysisDefaults
, "CalculatedFields" :[ CalculatedField, ... ]
, "ColumnConfigurations" :[ ColumnConfiguration, ... ]
, "DataSetIdentifierDeclarations" :[ DataSetIdentifierDeclaration, ... ]
, "FilterGroups" :[ FilterGroup, ... ]
, "Options" :AssetOptions
, "ParameterDeclarations" :[ ParameterDeclaration, ... ]
, "QueryExecutionOptions" :QueryExecutionOptions
, "Sheets" :[ SheetDefinition, ... ]
}
YAML
AnalysisDefaults:
AnalysisDefaults
CalculatedFields:- CalculatedField
ColumnConfigurations:- ColumnConfiguration
DataSetIdentifierDeclarations:- DataSetIdentifierDeclaration
FilterGroups:- FilterGroup
Options:AssetOptions
ParameterDeclarations:- ParameterDeclaration
QueryExecutionOptions:QueryExecutionOptions
Sheets:- SheetDefinition
Properties
AnalysisDefaults
Property description not available.
Required: No
Type: AnalysisDefaults
Update requires: No interruption
CalculatedFields
-
An array of calculated field definitions for the analysis.
Required: No
Type: Array of CalculatedField
Minimum:
0
Maximum:
500
Update requires: No interruption
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.
Required: No
Type: Array of ColumnConfiguration
Minimum:
0
Maximum:
2000
Update requires: No interruption
DataSetIdentifierDeclarations
-
An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
Required: Yes
Type: Array of DataSetIdentifierDeclaration
Minimum:
1
Maximum:
50
Update requires: No interruption
FilterGroups
-
Filter definitions for an analysis.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
Required: No
Type: Array of FilterGroup
Minimum:
0
Maximum:
2000
Update requires: No interruption
Options
-
An array of option definitions for an analysis.
Required: No
Type: AssetOptions
Update requires: No interruption
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.
Required: No
Type: Array of ParameterDeclaration
Minimum:
0
Maximum:
200
Update requires: No interruption
QueryExecutionOptions
Property description not available.
Required: No
Type: QueryExecutionOptions
Update requires: No interruption
Sheets
-
An array of sheet definitions for an analysis. Each
SheetDefinition
provides detailed information about a sheet within this analysis.Required: No
Type: Array of SheetDefinition
Minimum:
0
Maximum:
20
Update requires: No interruption