AnalysisDefinition
The definition of an analysis.
Contents
Note
In the following list, the required parameters are described first.
- DataSetIdentifierDeclarations
-
An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
Type: Array of DataSetIdentifierDeclaration objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
- AnalysisDefaults
-
The configuration for default analysis settings.
Type: AnalysisDefaults object
Required: No
- CalculatedFields
-
An array of calculated field definitions for the analysis.
Type: Array of CalculatedField objects
Array Members: Maximum number of 500 items.
Required: No
- 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.
Type: Array of ColumnConfiguration objects
Array Members: Maximum number of 2000 items.
Required: No
- FilterGroups
-
Filter definitions for an analysis.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
Type: Array of FilterGroup objects
Array Members: Maximum number of 2000 items.
Required: No
- Options
-
An array of option definitions for an analysis.
Type: AssetOptions object
Required: No
- 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.
Type: Array of ParameterDeclaration objects
Array Members: Maximum number of 200 items.
Required: No
- QueryExecutionOptions
-
A structure that describes the query execution options.
Type: QueryExecutionOptions object
Required: No
- Sheets
-
An array of sheet definitions for an analysis. Each
SheetDefinition
provides detailed information about a sheet within this analysis.Type: Array of SheetDefinition objects
Array Members: Maximum number of 20 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: