This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
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, ... ], "StaticFiles" :[ StaticFile, ... ]}
YAML
AnalysisDefaults:AnalysisDefaultsCalculatedFields:- CalculatedFieldColumnConfigurations:- ColumnConfigurationDataSetIdentifierDeclarations:- DataSetIdentifierDeclarationFilterGroups:- FilterGroupOptions:AssetOptionsParameterDeclarations:- ParameterDeclarationQueryExecutionOptions:QueryExecutionOptionsSheets:- SheetDefinitionStaticFiles:- StaticFile
Properties
AnalysisDefaultsProperty 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:
0Maximum:
500Update 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:
0Maximum:
2000Update 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:
1Maximum:
50Update requires: No interruption
FilterGroups-
Filter definitions for an analysis.
For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.
Required: No
Type: Array of FilterGroup
Minimum:
0Maximum:
2000Update 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 Quick Sight in the Amazon Quick Suite User Guide.
Required: No
Type: Array of ParameterDeclaration
Minimum:
0Maximum:
200Update requires: No interruption
QueryExecutionOptionsProperty description not available.
Required: No
Type: QueryExecutionOptions
Update requires: No interruption
Sheets-
An array of sheet definitions for an analysis. Each
SheetDefinitionprovides detailed information about a sheet within this analysis.Required: No
Type: Array of SheetDefinition
Minimum:
0Maximum:
20Update requires: No interruption
StaticFiles-
The static files for the definition.
Required: No
Type: Array of StaticFile
Minimum:
0Maximum:
200Update requires: No interruption
