A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"ContentType" : String,
"Description" : String,
"FilterControls" : [ FilterControl, ... ],
"Images" : [ SheetImage, ... ],
"Layouts" : [ Layout, ... ],
"Name" : String,
"ParameterControls" : [ ParameterControl, ... ],
"SheetControlLayouts" : [ SheetControlLayout, ... ],
"SheetId" : String,
"TextBoxes" : [ SheetTextBox, ... ],
"Title" : String,
"Visuals" : [ Visual, ... ]
}
YAML
ContentType: String
Description: String
FilterControls:
- FilterControl
Images:
- SheetImage
Layouts:
- Layout
Name: String
ParameterControls:
- ParameterControl
SheetControlLayouts:
- SheetControlLayout
SheetId: String
TextBoxes:
- SheetTextBox
Title: String
Visuals:
- Visual
Properties
ContentType-
The layout content type of the sheet. Choose one of the following options:
-
PAGINATED: Creates a sheet for a paginated report. -
INTERACTIVE: Creates a sheet for an interactive dashboard.
Required: No
Type: String
Allowed values:
PAGINATED | INTERACTIVEUpdate requires: No interruption
-
Description-
A description of the sheet.
Required: No
Type: String
Minimum:
1Maximum:
1024Update requires: No interruption
FilterControls-
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.
Required: No
Type: Array of FilterControl
Minimum:
0Maximum:
200Update requires: No interruption
Images-
A list of images on a sheet.
Required: No
Type: Array of SheetImage
Minimum:
0Maximum:
10Update requires: No interruption
Layouts-
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
Required: No
Type: Array of Layout
Minimum:
1Maximum:
1Update requires: No interruption
Name-
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Required: No
Type: String
Minimum:
1Maximum:
2048Update requires: No interruption
ParameterControls-
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
Required: No
Type: Array of ParameterControl
Minimum:
0Maximum:
200Update requires: No interruption
SheetControlLayouts-
The control layouts of the sheet.
Required: No
Type: Array of SheetControlLayout
Minimum:
0Maximum:
1Update requires: No interruption
SheetId-
The unique identifier of a sheet.
Required: Yes
Type: String
Pattern:
^[\w\-]+$Minimum:
1Maximum:
512Update requires: No interruption
TextBoxes-
The text boxes that are on a sheet.
Required: No
Type: Array of SheetTextBox
Minimum:
0Maximum:
100Update requires: No interruption
Title-
The title of the sheet.
Required: No
Type: String
Minimum:
1Maximum:
1024Update requires: No interruption
Visuals-
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
Required: No
Type: Array of Visual
Minimum:
0Maximum:
50Update requires: No interruption
