A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide.
Contents
Note
In the following list, the required parameters are described first.
- VisualId
-
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- Actions
-
The list of custom actions that are configured for a visual.
Type: Array of VisualCustomAction objects
Array Members: Maximum number of 10 items.
Required: No
- ChartConfiguration
-
The configuration of a KPI visual.
Type: KPIConfiguration object
Required: No
- ColumnHierarchies
-
The column hierarchy that is used during drill-downs and drill-ups.
Type: Array of ColumnHierarchy objects
Array Members: Maximum number of 2 items.
Required: No
- ConditionalFormatting
-
The conditional formatting of a KPI visual.
Type: KPIConditionalFormatting object
Required: No
- Subtitle
-
The subtitle that is displayed on the visual.
Type: VisualSubtitleLabelOptions object
Required: No
- Title
-
The title that is displayed on the visual.
Type: VisualTitleLabelOptions object
Required: No
- VisualContentAltText
-
The alt text for the visual.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
