feat(client-quicksight): This release launches new updates to QuickSi…

…ght KPI visuals - support for sparklines, new templated layout and new targets for conditional formatting rules.
aws · Sep 11, 2023 · 12e1529 · 12e1529
1 parent 4e65c3e
commit 12e1529
Show file tree

Hide file tree

Showing 19 changed files with 1,380 additions and 663 deletions.
diff --git a/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts b/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts
@@ -2251,6 +2251,17 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
  *                   PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL",
  *                   PrimaryValueFontConfiguration: "<FontConfiguration>",
  *                   SecondaryValueFontConfiguration: "<FontConfiguration>",
+ *                   Sparkline: { // KPISparklineOptions
+ *                     Visibility: "HIDDEN" || "VISIBLE",
+ *                     Type: "LINE" || "AREA", // required
+ *                     Color: "STRING_VALUE",
+ *                     TooltipVisibility: "HIDDEN" || "VISIBLE",
+ *                   },
+ *                   VisualLayoutOptions: { // KPIVisualLayoutOptions
+ *                     StandardLayout: { // KPIVisualStandardLayout
+ *                       Type: "CLASSIC" || "VERTICAL", // required
+ *                     },
+ *                   },
  *                 },
  *               },
  *               ConditionalFormatting: { // KPIConditionalFormatting
@@ -2279,6 +2290,46 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
  *                     ProgressBar: { // KPIProgressBarConditionalFormatting
  *                       ForegroundColor: "<ConditionalFormattingColor>",
  *                     },
+ *                     ActualValue: { // KPIActualValueConditionalFormatting
+ *                       TextColor: "<ConditionalFormattingColor>",
+ *                       Icon: {
+ *                         IconSet: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
+ *                         },
+ *                         CustomCondition: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconOptions: {
+ *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
+ *                             UnicodeIcon: "STRING_VALUE",
+ *                           },
+ *                           Color: "STRING_VALUE",
+ *                           DisplayConfiguration: {
+ *                             IconDisplayOption: "ICON_ONLY",
+ *                           },
+ *                         },
+ *                       },
+ *                     },
+ *                     ComparisonValue: { // KPIComparisonValueConditionalFormatting
+ *                       TextColor: "<ConditionalFormattingColor>",
+ *                       Icon: {
+ *                         IconSet: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
+ *                         },
+ *                         CustomCondition: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconOptions: {
+ *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
+ *                             UnicodeIcon: "STRING_VALUE",
+ *                           },
+ *                           Color: "STRING_VALUE",
+ *                           DisplayConfiguration: {
+ *                             IconDisplayOption: "ICON_ONLY",
+ *                           },
+ *                         },
+ *                       },
+ *                     },
  *                   },
  *                 ],
  *               },
@@ -2798,23 +2849,7 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
  *                   { // GaugeChartConditionalFormattingOption
  *                     PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting
  *                       TextColor: "<ConditionalFormattingColor>",
- *                       Icon: {
- *                         IconSet: {
- *                           Expression: "STRING_VALUE", // required
- *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
- *                         },
- *                         CustomCondition: {
- *                           Expression: "STRING_VALUE", // required
- *                           IconOptions: {
- *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
- *                             UnicodeIcon: "STRING_VALUE",
- *                           },
- *                           Color: "STRING_VALUE",
- *                           DisplayConfiguration: {
- *                             IconDisplayOption: "ICON_ONLY",
- *                           },
- *                         },
- *                       },
+ *                       Icon: "<ConditionalFormattingIcon>",
  *                     },
  *                     Arc: { // GaugeChartArcConditionalFormatting
  *                       ForegroundColor: "<ConditionalFormattingColor>",

diff --git a/clients/client-quicksight/src/commands/CreateDashboardCommand.ts b/clients/client-quicksight/src/commands/CreateDashboardCommand.ts
@@ -2297,6 +2297,17 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
  *                   PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL",
  *                   PrimaryValueFontConfiguration: "<FontConfiguration>",
  *                   SecondaryValueFontConfiguration: "<FontConfiguration>",
+ *                   Sparkline: { // KPISparklineOptions
+ *                     Visibility: "HIDDEN" || "VISIBLE",
+ *                     Type: "LINE" || "AREA", // required
+ *                     Color: "STRING_VALUE",
+ *                     TooltipVisibility: "HIDDEN" || "VISIBLE",
+ *                   },
+ *                   VisualLayoutOptions: { // KPIVisualLayoutOptions
+ *                     StandardLayout: { // KPIVisualStandardLayout
+ *                       Type: "CLASSIC" || "VERTICAL", // required
+ *                     },
+ *                   },
  *                 },
  *               },
  *               ConditionalFormatting: { // KPIConditionalFormatting
@@ -2325,6 +2336,46 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
  *                     ProgressBar: { // KPIProgressBarConditionalFormatting
  *                       ForegroundColor: "<ConditionalFormattingColor>",
  *                     },
+ *                     ActualValue: { // KPIActualValueConditionalFormatting
+ *                       TextColor: "<ConditionalFormattingColor>",
+ *                       Icon: {
+ *                         IconSet: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
+ *                         },
+ *                         CustomCondition: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconOptions: {
+ *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
+ *                             UnicodeIcon: "STRING_VALUE",
+ *                           },
+ *                           Color: "STRING_VALUE",
+ *                           DisplayConfiguration: {
+ *                             IconDisplayOption: "ICON_ONLY",
+ *                           },
+ *                         },
+ *                       },
+ *                     },
+ *                     ComparisonValue: { // KPIComparisonValueConditionalFormatting
+ *                       TextColor: "<ConditionalFormattingColor>",
+ *                       Icon: {
+ *                         IconSet: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
+ *                         },
+ *                         CustomCondition: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconOptions: {
+ *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
+ *                             UnicodeIcon: "STRING_VALUE",
+ *                           },
+ *                           Color: "STRING_VALUE",
+ *                           DisplayConfiguration: {
+ *                             IconDisplayOption: "ICON_ONLY",
+ *                           },
+ *                         },
+ *                       },
+ *                     },
  *                   },
  *                 ],
  *               },
@@ -2844,23 +2895,7 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
  *                   { // GaugeChartConditionalFormattingOption
  *                     PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting
  *                       TextColor: "<ConditionalFormattingColor>",
- *                       Icon: {
- *                         IconSet: {
- *                           Expression: "STRING_VALUE", // required
- *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
- *                         },
- *                         CustomCondition: {
- *                           Expression: "STRING_VALUE", // required
- *                           IconOptions: {
- *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
- *                             UnicodeIcon: "STRING_VALUE",
- *                           },
- *                           Color: "STRING_VALUE",
- *                           DisplayConfiguration: {
- *                             IconDisplayOption: "ICON_ONLY",
- *                           },
- *                         },
- *                       },
+ *                       Icon: "<ConditionalFormattingIcon>",
  *                     },
  *                     Arc: { // GaugeChartArcConditionalFormatting
  *                       ForegroundColor: "<ConditionalFormattingColor>",

diff --git a/clients/client-quicksight/src/commands/CreateTemplateCommand.ts b/clients/client-quicksight/src/commands/CreateTemplateCommand.ts
@@ -2245,6 +2245,17 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
  *                   PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL",
  *                   PrimaryValueFontConfiguration: "<FontConfiguration>",
  *                   SecondaryValueFontConfiguration: "<FontConfiguration>",
+ *                   Sparkline: { // KPISparklineOptions
+ *                     Visibility: "HIDDEN" || "VISIBLE",
+ *                     Type: "LINE" || "AREA", // required
+ *                     Color: "STRING_VALUE",
+ *                     TooltipVisibility: "HIDDEN" || "VISIBLE",
+ *                   },
+ *                   VisualLayoutOptions: { // KPIVisualLayoutOptions
+ *                     StandardLayout: { // KPIVisualStandardLayout
+ *                       Type: "CLASSIC" || "VERTICAL", // required
+ *                     },
+ *                   },
  *                 },
  *               },
  *               ConditionalFormatting: { // KPIConditionalFormatting
@@ -2273,6 +2284,46 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
  *                     ProgressBar: { // KPIProgressBarConditionalFormatting
  *                       ForegroundColor: "<ConditionalFormattingColor>",
  *                     },
+ *                     ActualValue: { // KPIActualValueConditionalFormatting
+ *                       TextColor: "<ConditionalFormattingColor>",
+ *                       Icon: {
+ *                         IconSet: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
+ *                         },
+ *                         CustomCondition: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconOptions: {
+ *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
+ *                             UnicodeIcon: "STRING_VALUE",
+ *                           },
+ *                           Color: "STRING_VALUE",
+ *                           DisplayConfiguration: {
+ *                             IconDisplayOption: "ICON_ONLY",
+ *                           },
+ *                         },
+ *                       },
+ *                     },
+ *                     ComparisonValue: { // KPIComparisonValueConditionalFormatting
+ *                       TextColor: "<ConditionalFormattingColor>",
+ *                       Icon: {
+ *                         IconSet: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
+ *                         },
+ *                         CustomCondition: {
+ *                           Expression: "STRING_VALUE", // required
+ *                           IconOptions: {
+ *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
+ *                             UnicodeIcon: "STRING_VALUE",
+ *                           },
+ *                           Color: "STRING_VALUE",
+ *                           DisplayConfiguration: {
+ *                             IconDisplayOption: "ICON_ONLY",
+ *                           },
+ *                         },
+ *                       },
+ *                     },
  *                   },
  *                 ],
  *               },
@@ -2792,23 +2843,7 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
  *                   { // GaugeChartConditionalFormattingOption
  *                     PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting
  *                       TextColor: "<ConditionalFormattingColor>",
- *                       Icon: {
- *                         IconSet: {
- *                           Expression: "STRING_VALUE", // required
- *                           IconSetType: "PLUS_MINUS" || "CHECK_X" || "THREE_COLOR_ARROW" || "THREE_GRAY_ARROW" || "CARET_UP_MINUS_DOWN" || "THREE_SHAPE" || "THREE_CIRCLE" || "FLAGS" || "BARS" || "FOUR_COLOR_ARROW" || "FOUR_GRAY_ARROW",
- *                         },
- *                         CustomCondition: {
- *                           Expression: "STRING_VALUE", // required
- *                           IconOptions: {
- *                             Icon: "CARET_UP" || "CARET_DOWN" || "PLUS" || "MINUS" || "ARROW_UP" || "ARROW_DOWN" || "ARROW_LEFT" || "ARROW_UP_LEFT" || "ARROW_DOWN_LEFT" || "ARROW_RIGHT" || "ARROW_UP_RIGHT" || "ARROW_DOWN_RIGHT" || "FACE_UP" || "FACE_DOWN" || "FACE_FLAT" || "ONE_BAR" || "TWO_BAR" || "THREE_BAR" || "CIRCLE" || "TRIANGLE" || "SQUARE" || "FLAG" || "THUMBS_UP" || "THUMBS_DOWN" || "CHECKMARK" || "X",
- *                             UnicodeIcon: "STRING_VALUE",
- *                           },
- *                           Color: "STRING_VALUE",
- *                           DisplayConfiguration: {
- *                             IconDisplayOption: "ICON_ONLY",
- *                           },
- *                         },
- *                       },
+ *                       Icon: "<ConditionalFormattingIcon>",
  *                     },
  *                     Arc: { // GaugeChartArcConditionalFormatting
  *                       ForegroundColor: "<ConditionalFormattingColor>",