SheetDefinition
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.
Contents
Note
In the following list, the required parameters are described first.
- SheetId
-
The unique identifier of a sheet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- 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.
Type: String
Valid Values:
PAGINATED | INTERACTIVERequired: No
-
- Description
-
A description of the sheet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- 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.
Type: Array of FilterControl objects
Array Members: Maximum number of 200 items.
Required: No
- Images
-
A list of images on a sheet.
Type: Array of SheetImage objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- Layouts
-
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
Type: Array of Layout objects
Array Members: Fixed number of 1 item.
Required: No
- Name
-
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- 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.
Type: Array of ParameterControl objects
Array Members: Maximum number of 200 items.
Required: No
- SheetControlLayouts
-
The control layouts of the sheet.
Type: Array of SheetControlLayout objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
- TextBoxes
-
The text boxes that are on a sheet.
Type: Array of SheetTextBox objects
Array Members: Maximum number of 100 items.
Required: No
- Title
-
The title of the sheet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- Visuals
-
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
Type: Array of Visual objects
Array Members: Maximum number of 50 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
