# KPIVisual
<a name="API_KPIVisual"></a>

A key performance indicator (KPI).

For more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.

## Contents
<a name="API_KPIVisual_Contents"></a>

**Note**  
In the following list, the required parameters are described first.

 ** VisualId **   <a name="QS-Type-KPIVisual-VisualId"></a>
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 **   <a name="QS-Type-KPIVisual-Actions"></a>
The list of custom actions that are configured for a visual.  
Type: Array of [VisualCustomAction](API_VisualCustomAction.md) objects  
Array Members: Maximum number of 10 items.  
Required: No

 ** ChartConfiguration **   <a name="QS-Type-KPIVisual-ChartConfiguration"></a>
The configuration of a KPI visual.  
Type: [KPIConfiguration](API_KPIConfiguration.md) object  
Required: No

 ** ColumnHierarchies **   <a name="QS-Type-KPIVisual-ColumnHierarchies"></a>
The column hierarchy that is used during drill-downs and drill-ups.  
Type: Array of [ColumnHierarchy](API_ColumnHierarchy.md) objects  
Array Members: Maximum number of 2 items.  
Required: No

 ** ConditionalFormatting **   <a name="QS-Type-KPIVisual-ConditionalFormatting"></a>
The conditional formatting of a KPI visual.  
Type: [KPIConditionalFormatting](API_KPIConditionalFormatting.md) object  
Required: No

 ** Subtitle **   <a name="QS-Type-KPIVisual-Subtitle"></a>
The subtitle that is displayed on the visual.  
Type: [VisualSubtitleLabelOptions](API_VisualSubtitleLabelOptions.md) object  
Required: No

 ** Title **   <a name="QS-Type-KPIVisual-Title"></a>
The title that is displayed on the visual.  
Type: [VisualTitleLabelOptions](API_VisualTitleLabelOptions.md) object  
Required: No

 ** VisualContentAltText **   <a name="QS-Type-KPIVisual-VisualContentAltText"></a>
The alt text for the visual.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_KPIVisual_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/KPIVisual) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/KPIVisual) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/KPIVisual)