From 12e15298ffda884e48dce911262601e382394c27 Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 11 Sep 2023 18:16:18 +0000 Subject: [PATCH] feat(client-quicksight): This release launches new updates to QuickSight KPI visuals - support for sparklines, new templated layout and new targets for conditional formatting rules. --- .../src/commands/CreateAnalysisCommand.ts | 69 +++- .../src/commands/CreateDashboardCommand.ts | 69 +++- .../src/commands/CreateTemplateCommand.ts | 69 +++- .../DescribeAnalysisDefinitionCommand.ts | 69 +++- .../DescribeDashboardDefinitionCommand.ts | 69 +++- .../DescribeTemplateDefinitionCommand.ts | 69 +++- .../src/commands/TagResourceCommand.ts | 2 +- .../src/commands/UntagResourceCommand.ts | 2 +- .../UpdateAccountCustomizationCommand.ts | 2 +- .../commands/UpdateAccountSettingsCommand.ts | 3 +- .../src/commands/UpdateAnalysisCommand.ts | 69 +++- .../src/commands/UpdateDashboardCommand.ts | 69 +++- .../src/commands/UpdateTemplateCommand.ts | 69 +++- .../client-quicksight/src/models/models_1.ts | 293 ++++++++------ .../client-quicksight/src/models/models_2.ts | 314 ++++++--------- .../client-quicksight/src/models/models_3.ts | 375 ++++++++++-------- .../client-quicksight/src/models/models_4.ts | 172 +++++++- .../src/protocols/Aws_restJson1.ts | 95 ++++- .../sdk-codegen/aws-models/quicksight.json | 164 +++++++- 19 files changed, 1380 insertions(+), 663 deletions(-) diff --git a/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts b/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts index 518af5cdc202..280c218a44f0 100644 --- 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: "", * SecondaryValueFontConfiguration: "", + * 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: "", * }, + * ActualValue: { // KPIActualValueConditionalFormatting + * TextColor: "", + * 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: "", + * 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: "", - * 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: "", * }, * Arc: { // GaugeChartArcConditionalFormatting * ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/CreateDashboardCommand.ts b/clients/client-quicksight/src/commands/CreateDashboardCommand.ts index f7b6b54f1ffc..7399c512af5b 100644 --- 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: "", * SecondaryValueFontConfiguration: "", + * 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: "", * }, + * ActualValue: { // KPIActualValueConditionalFormatting + * TextColor: "", + * 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: "", + * 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: "", - * 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: "", * }, * Arc: { // GaugeChartArcConditionalFormatting * ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/CreateTemplateCommand.ts b/clients/client-quicksight/src/commands/CreateTemplateCommand.ts index dfc078789172..c6762d801dfb 100644 --- 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: "", * SecondaryValueFontConfiguration: "", + * 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: "", * }, + * ActualValue: { // KPIActualValueConditionalFormatting + * TextColor: "", + * 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: "", + * 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: "", - * 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: "", * }, * Arc: { // GaugeChartArcConditionalFormatting * ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts index bf007943f197..ea89280f6e5e 100644 --- a/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts @@ -2217,6 +2217,17 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * // PrimaryValueFontConfiguration: "", * // SecondaryValueFontConfiguration: "", + * // 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 @@ -2245,6 +2256,46 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // ProgressBar: { // KPIProgressBarConditionalFormatting * // ForegroundColor: "", * // }, + * // ActualValue: { // KPIActualValueConditionalFormatting + * // TextColor: "", + * // 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: "", + * // 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", + * // }, + * // }, + * // }, + * // }, * // }, * // ], * // }, @@ -2764,23 +2815,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi * // { // GaugeChartConditionalFormattingOption * // PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting * // TextColor: "", - * // 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: "", * // }, * // Arc: { // GaugeChartArcConditionalFormatting * // ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts index 8ce8763891d5..457a6606647e 100644 --- a/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts @@ -2224,6 +2224,17 @@ export interface DescribeDashboardDefinitionCommandOutput * // PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * // PrimaryValueFontConfiguration: "", * // SecondaryValueFontConfiguration: "", + * // 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 @@ -2252,6 +2263,46 @@ export interface DescribeDashboardDefinitionCommandOutput * // ProgressBar: { // KPIProgressBarConditionalFormatting * // ForegroundColor: "", * // }, + * // ActualValue: { // KPIActualValueConditionalFormatting + * // TextColor: "", + * // 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: "", + * // 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", + * // }, + * // }, + * // }, + * // }, * // }, * // ], * // }, @@ -2771,23 +2822,7 @@ export interface DescribeDashboardDefinitionCommandOutput * // { // GaugeChartConditionalFormattingOption * // PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting * // TextColor: "", - * // 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: "", * // }, * // Arc: { // GaugeChartArcConditionalFormatting * // ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts index 6070bd5133d8..4447de551ea6 100644 --- a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts +++ b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts @@ -2237,6 +2237,17 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * // PrimaryValueFontConfiguration: "", * // SecondaryValueFontConfiguration: "", + * // 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 @@ -2265,6 +2276,46 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // ProgressBar: { // KPIProgressBarConditionalFormatting * // ForegroundColor: "", * // }, + * // ActualValue: { // KPIActualValueConditionalFormatting + * // TextColor: "", + * // 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: "", + * // 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", + * // }, + * // }, + * // }, + * // }, * // }, * // ], * // }, @@ -2784,23 +2835,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat * // { // GaugeChartConditionalFormattingOption * // PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting * // TextColor: "", - * // 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: "", * // }, * // Arc: { // GaugeChartArcConditionalFormatting * // ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/TagResourceCommand.ts b/clients/client-quicksight/src/commands/TagResourceCommand.ts index c755469ba027..6177d83e743f 100644 --- a/clients/client-quicksight/src/commands/TagResourceCommand.ts +++ b/clients/client-quicksight/src/commands/TagResourceCommand.ts @@ -13,7 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { TagResourceRequest, TagResourceResponse } from "../models/models_3"; +import { TagResourceRequest, TagResourceResponse } from "../models/models_4"; import { de_TagResourceCommand, se_TagResourceCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UntagResourceCommand.ts b/clients/client-quicksight/src/commands/UntagResourceCommand.ts index 22c2edbaecea..c49e3781eb39 100644 --- a/clients/client-quicksight/src/commands/UntagResourceCommand.ts +++ b/clients/client-quicksight/src/commands/UntagResourceCommand.ts @@ -13,7 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { UntagResourceRequest, UntagResourceResponse } from "../models/models_3"; +import { UntagResourceRequest, UntagResourceResponse } from "../models/models_4"; import { de_UntagResourceCommand, se_UntagResourceCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateAccountCustomizationCommand.ts b/clients/client-quicksight/src/commands/UpdateAccountCustomizationCommand.ts index c326ce869ad5..cb2e580ca768 100644 --- a/clients/client-quicksight/src/commands/UpdateAccountCustomizationCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateAccountCustomizationCommand.ts @@ -13,7 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { UpdateAccountCustomizationRequest, UpdateAccountCustomizationResponse } from "../models/models_3"; +import { UpdateAccountCustomizationRequest, UpdateAccountCustomizationResponse } from "../models/models_4"; import { de_UpdateAccountCustomizationCommand, se_UpdateAccountCustomizationCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateAccountSettingsCommand.ts b/clients/client-quicksight/src/commands/UpdateAccountSettingsCommand.ts index 9620ea0d4461..5106aba13bc4 100644 --- a/clients/client-quicksight/src/commands/UpdateAccountSettingsCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateAccountSettingsCommand.ts @@ -13,8 +13,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { UpdateAccountSettingsRequest } from "../models/models_3"; -import { UpdateAccountSettingsResponse } from "../models/models_4"; +import { UpdateAccountSettingsRequest, UpdateAccountSettingsResponse } from "../models/models_4"; import { de_UpdateAccountSettingsCommand, se_UpdateAccountSettingsCommand } from "../protocols/Aws_restJson1"; import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; diff --git a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts index f252f5198d49..758c3c18614f 100644 --- a/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts @@ -2237,6 +2237,17 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * PrimaryValueFontConfiguration: "", * SecondaryValueFontConfiguration: "", + * 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 @@ -2265,6 +2276,46 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * ProgressBar: { // KPIProgressBarConditionalFormatting * ForegroundColor: "", * }, + * ActualValue: { // KPIActualValueConditionalFormatting + * TextColor: "", + * 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: "", + * 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", + * }, + * }, + * }, + * }, * }, * ], * }, @@ -2784,23 +2835,7 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M * { // GaugeChartConditionalFormattingOption * PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting * TextColor: "", - * 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: "", * }, * Arc: { // GaugeChartArcConditionalFormatting * ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts b/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts index 7c19b56b1ecf..9c2715246004 100644 --- a/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts @@ -2282,6 +2282,17 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * PrimaryValueFontConfiguration: "", * SecondaryValueFontConfiguration: "", + * 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 @@ -2310,6 +2321,46 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * ProgressBar: { // KPIProgressBarConditionalFormatting * ForegroundColor: "", * }, + * ActualValue: { // KPIActualValueConditionalFormatting + * TextColor: "", + * 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: "", + * 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", + * }, + * }, + * }, + * }, * }, * ], * }, @@ -2829,23 +2880,7 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ * { // GaugeChartConditionalFormattingOption * PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting * TextColor: "", - * 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: "", * }, * Arc: { // GaugeChartArcConditionalFormatting * ForegroundColor: "", diff --git a/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts b/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts index 4cc23436d388..e8025753429f 100644 --- a/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts +++ b/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts @@ -2224,6 +2224,17 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * PrimaryValueDisplayType: "HIDDEN" || "COMPARISON" || "ACTUAL", * PrimaryValueFontConfiguration: "", * SecondaryValueFontConfiguration: "", + * 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 @@ -2252,6 +2263,46 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * ProgressBar: { // KPIProgressBarConditionalFormatting * ForegroundColor: "", * }, + * ActualValue: { // KPIActualValueConditionalFormatting + * TextColor: "", + * 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: "", + * 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", + * }, + * }, + * }, + * }, * }, * ], * }, @@ -2771,23 +2822,7 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * { // GaugeChartConditionalFormattingOption * PrimaryValue: { // GaugeChartPrimaryValueConditionalFormatting * TextColor: "", - * 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: "", * }, * Arc: { // GaugeChartArcConditionalFormatting * ForegroundColor: "", diff --git a/clients/client-quicksight/src/models/models_1.ts b/clients/client-quicksight/src/models/models_1.ts index 9b05ddb4db73..ca10c4231728 100644 --- a/clients/client-quicksight/src/models/models_1.ts +++ b/clients/client-quicksight/src/models/models_1.ts @@ -3051,6 +3051,50 @@ export interface SecondaryValueOptions { Visibility?: Visibility | string; } +/** + * @public + * @enum + */ +export const KPISparklineType = { + AREA: "AREA", + LINE: "LINE", +} as const; + +/** + * @public + */ +export type KPISparklineType = (typeof KPISparklineType)[keyof typeof KPISparklineType]; + +/** + * @public + *

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

+ */ +export interface KPISparklineOptions { + /** + * @public + *

The visibility of the sparkline.

+ */ + Visibility?: Visibility | string; + + /** + * @public + *

The type of the sparkline.

+ */ + Type: KPISparklineType | string | undefined; + + /** + * @public + *

The color of the sparkline.

+ */ + Color?: string; + + /** + * @public + *

The tooltip visibility of the sparkline.

+ */ + TooltipVisibility?: Visibility | string; +} + /** * @public *

The options that determine the presentation of trend arrows in a KPI visual.

@@ -3063,6 +3107,45 @@ export interface TrendArrowOptions { Visibility?: Visibility | string; } +/** + * @public + * @enum + */ +export const KPIVisualStandardLayoutType = { + CLASSIC: "CLASSIC", + VERTICAL: "VERTICAL", +} as const; + +/** + * @public + */ +export type KPIVisualStandardLayoutType = + (typeof KPIVisualStandardLayoutType)[keyof typeof KPIVisualStandardLayoutType]; + +/** + * @public + *

The standard layout of the KPI visual.

+ */ +export interface KPIVisualStandardLayout { + /** + * @public + *

The standard layout type.

+ */ + Type: KPIVisualStandardLayoutType | string | undefined; +} + +/** + * @public + *

The options that determine the layout a KPI visual.

+ */ +export interface KPIVisualLayoutOptions { + /** + * @public + *

The standard layout of the KPI visual.

+ */ + StandardLayout?: KPIVisualStandardLayout; +} + /** * @public *

The options that determine the presentation of a KPI visual.

@@ -3109,6 +3192,18 @@ export interface KPIOptions { *

The options that determine the secondary value font configuration.

*/ SecondaryValueFontConfiguration?: FontConfiguration; + + /** + * @public + *

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

+ */ + Sparkline?: KPISparklineOptions; + + /** + * @public + *

The options that determine the layout a KPI visual.

+ */ + VisualLayoutOptions?: KPIVisualLayoutOptions; } /** @@ -3147,6 +3242,42 @@ export interface KPIConfiguration { KPIOptions?: KPIOptions; } +/** + * @public + *

The conditional formatting for the actual value of a KPI visual.

+ */ +export interface KPIActualValueConditionalFormatting { + /** + * @public + *

The conditional formatting of the actual value's text color.

+ */ + TextColor?: ConditionalFormattingColor; + + /** + * @public + *

The conditional formatting of the actual value's icon.

+ */ + Icon?: ConditionalFormattingIcon; +} + +/** + * @public + *

The conditional formatting for the comparison value of a KPI visual.

+ */ +export interface KPIComparisonValueConditionalFormatting { + /** + * @public + *

The conditional formatting of the comparison value's text color.

+ */ + TextColor?: ConditionalFormattingColor; + + /** + * @public + *

The conditional formatting of the comparison value's icon.

+ */ + Icon?: ConditionalFormattingIcon; +} + /** * @public *

The conditional formatting for the primary value of a KPI visual.

@@ -3193,6 +3324,18 @@ export interface KPIConditionalFormattingOption { *

The conditional formatting for the progress bar of a KPI visual.

*/ ProgressBar?: KPIProgressBarConditionalFormatting; + + /** + * @public + *

The conditional formatting for the actual value of a KPI visual.

+ */ + ActualValue?: KPIActualValueConditionalFormatting; + + /** + * @public + *

The conditional formatting for the comparison value of a KPI visual.

+ */ + ComparisonValue?: KPIComparisonValueConditionalFormatting; } /** @@ -7740,115 +7883,6 @@ export interface SnapshotJobS3Result { ErrorInfo?: SnapshotJobResultErrorInfo[]; } -/** - * @public - *

A structure that contains information on the generated snapshot file groups.

- */ -export interface SnapshotJobResultFileGroup { - /** - * @public - *

A list of SnapshotFile objects.

- */ - Files?: SnapshotFile[]; - - /** - * @public - *

A list of SnapshotJobS3Result objects.

- */ - S3Results?: SnapshotJobS3Result[]; -} - -/** - * @public - *

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call. - *

- */ -export interface AnonymousUserSnapshotJobResult { - /** - * @public - *

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

- */ - FileGroups?: SnapshotJobResultFileGroup[]; -} - -/** - * @public - * @enum - */ -export const AssetBundleExportJobAnalysisPropertyToOverride = { - NAME: "Name", -} as const; - -/** - * @public - */ -export type AssetBundleExportJobAnalysisPropertyToOverride = - (typeof AssetBundleExportJobAnalysisPropertyToOverride)[keyof typeof AssetBundleExportJobAnalysisPropertyToOverride]; - -/** - * @public - *

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

- */ -export interface AssetBundleExportJobAnalysisOverrideProperties { - /** - * @public - *

The ARN of the specific Analysis resource whose override properties are configured in this structure.

- */ - Arn?: string; - - /** - * @public - *

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

- */ - Properties: (AssetBundleExportJobAnalysisPropertyToOverride | string)[] | undefined; -} - -/** - * @public - * @enum - */ -export const AssetBundleExportJobDashboardPropertyToOverride = { - NAME: "Name", -} as const; - -/** - * @public - */ -export type AssetBundleExportJobDashboardPropertyToOverride = - (typeof AssetBundleExportJobDashboardPropertyToOverride)[keyof typeof AssetBundleExportJobDashboardPropertyToOverride]; - -/** - * @public - *

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

- */ -export interface AssetBundleExportJobDashboardOverrideProperties { - /** - * @public - *

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

- */ - Arn?: string; - - /** - * @public - *

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

- */ - Properties: (AssetBundleExportJobDashboardPropertyToOverride | string)[] | undefined; -} - -/** - * @public - * @enum - */ -export const AssetBundleExportJobDataSetPropertyToOverride = { - NAME: "Name", -} as const; - -/** - * @public - */ -export type AssetBundleExportJobDataSetPropertyToOverride = - (typeof AssetBundleExportJobDataSetPropertyToOverride)[keyof typeof AssetBundleExportJobDataSetPropertyToOverride]; - /** * @internal */ @@ -8444,6 +8478,28 @@ export const KPIConfigurationFilterSensitiveLog = (obj: KPIConfiguration): any = ...(obj.KPIOptions && { KPIOptions: KPIOptionsFilterSensitiveLog(obj.KPIOptions) }), }); +/** + * @internal + */ +export const KPIActualValueConditionalFormattingFilterSensitiveLog = ( + obj: KPIActualValueConditionalFormatting +): any => ({ + ...obj, + ...(obj.TextColor && { TextColor: ConditionalFormattingColorFilterSensitiveLog(obj.TextColor) }), + ...(obj.Icon && { Icon: ConditionalFormattingIconFilterSensitiveLog(obj.Icon) }), +}); + +/** + * @internal + */ +export const KPIComparisonValueConditionalFormattingFilterSensitiveLog = ( + obj: KPIComparisonValueConditionalFormatting +): any => ({ + ...obj, + ...(obj.TextColor && { TextColor: ConditionalFormattingColorFilterSensitiveLog(obj.TextColor) }), + ...(obj.Icon && { Icon: ConditionalFormattingIconFilterSensitiveLog(obj.Icon) }), +}); + /** * @internal */ @@ -8472,6 +8528,10 @@ export const KPIConditionalFormattingOptionFilterSensitiveLog = (obj: KPIConditi ...obj, ...(obj.PrimaryValue && { PrimaryValue: KPIPrimaryValueConditionalFormattingFilterSensitiveLog(obj.PrimaryValue) }), ...(obj.ProgressBar && { ProgressBar: KPIProgressBarConditionalFormattingFilterSensitiveLog(obj.ProgressBar) }), + ...(obj.ActualValue && { ActualValue: KPIActualValueConditionalFormattingFilterSensitiveLog(obj.ActualValue) }), + ...(obj.ComparisonValue && { + ComparisonValue: KPIComparisonValueConditionalFormattingFilterSensitiveLog(obj.ComparisonValue), + }), }); /** @@ -9055,18 +9115,3 @@ export const SnapshotJobS3ResultFilterSensitiveLog = (obj: SnapshotJobS3Result): ...obj, ...(obj.S3Uri && { S3Uri: SENSITIVE_STRING }), }); - -/** - * @internal - */ -export const SnapshotJobResultFileGroupFilterSensitiveLog = (obj: SnapshotJobResultFileGroup): any => ({ - ...obj, - ...(obj.S3Results && { S3Results: obj.S3Results.map((item) => SnapshotJobS3ResultFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const AnonymousUserSnapshotJobResultFilterSensitiveLog = (obj: AnonymousUserSnapshotJobResult): any => ({ - ...obj, -}); diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts index 26d64edc4c93..bea21a49564c 100644 --- a/clients/client-quicksight/src/models/models_2.ts +++ b/clients/client-quicksight/src/models/models_2.ts @@ -26,15 +26,124 @@ import { import { AnalysisDefinition, AnalysisSourceEntity, - AssetBundleExportJobAnalysisOverrideProperties, - AssetBundleExportJobDashboardOverrideProperties, - AssetBundleExportJobDataSetPropertyToOverride, DataSetReference, FilterOperator, SheetDefinition, + SnapshotFile, + SnapshotJobS3Result, + SnapshotJobS3ResultFilterSensitiveLog, } from "./models_1"; import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + * @public + *

A structure that contains information on the generated snapshot file groups.

+ */ +export interface SnapshotJobResultFileGroup { + /** + * @public + *

A list of SnapshotFile objects.

+ */ + Files?: SnapshotFile[]; + + /** + * @public + *

A list of SnapshotJobS3Result objects.

+ */ + S3Results?: SnapshotJobS3Result[]; +} + +/** + * @public + *

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call. + *

+ */ +export interface AnonymousUserSnapshotJobResult { + /** + * @public + *

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

+ */ + FileGroups?: SnapshotJobResultFileGroup[]; +} + +/** + * @public + * @enum + */ +export const AssetBundleExportJobAnalysisPropertyToOverride = { + NAME: "Name", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobAnalysisPropertyToOverride = + (typeof AssetBundleExportJobAnalysisPropertyToOverride)[keyof typeof AssetBundleExportJobAnalysisPropertyToOverride]; + +/** + * @public + *

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

+ */ +export interface AssetBundleExportJobAnalysisOverrideProperties { + /** + * @public + *

The ARN of the specific Analysis resource whose override properties are configured in this structure.

+ */ + Arn?: string; + + /** + * @public + *

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

+ */ + Properties: (AssetBundleExportJobAnalysisPropertyToOverride | string)[] | undefined; +} + +/** + * @public + * @enum + */ +export const AssetBundleExportJobDashboardPropertyToOverride = { + NAME: "Name", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobDashboardPropertyToOverride = + (typeof AssetBundleExportJobDashboardPropertyToOverride)[keyof typeof AssetBundleExportJobDashboardPropertyToOverride]; + +/** + * @public + *

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

+ */ +export interface AssetBundleExportJobDashboardOverrideProperties { + /** + * @public + *

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

+ */ + Arn?: string; + + /** + * @public + *

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

+ */ + Properties: (AssetBundleExportJobDashboardPropertyToOverride | string)[] | undefined; +} + +/** + * @public + * @enum + */ +export const AssetBundleExportJobDataSetPropertyToOverride = { + NAME: "Name", +} as const; + +/** + * @public + */ +export type AssetBundleExportJobDataSetPropertyToOverride = + (typeof AssetBundleExportJobDataSetPropertyToOverride)[keyof typeof AssetBundleExportJobDataSetPropertyToOverride]; + /** * @public *

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

@@ -9142,200 +9251,19 @@ export const LookbackWindowSizeUnit = { export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit]; /** - * @public - *

The lookback window setup of an incremental refresh configuration.

- */ -export interface LookbackWindow { - /** - * @public - *

The name of the lookback window column.

- */ - ColumnName: string | undefined; - - /** - * @public - *

The lookback window column size.

- */ - Size: number | undefined; - - /** - * @public - *

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

- */ - SizeUnit: LookbackWindowSizeUnit | string | undefined; -} - -/** - * @public - *

The incremental refresh configuration for a dataset.

- */ -export interface IncrementalRefresh { - /** - * @public - *

The lookback window setup for an incremental refresh configuration.

- */ - LookbackWindow: LookbackWindow | undefined; -} - -/** - * @public - *

The refresh configuration of a dataset.

- */ -export interface RefreshConfiguration { - /** - * @public - *

The incremental refresh for the dataset.

- */ - IncrementalRefresh: IncrementalRefresh | undefined; -} - -/** - * @public - *

The refresh properties of a dataset.

- */ -export interface DataSetRefreshProperties { - /** - * @public - *

The refresh configuration for a dataset.

- */ - RefreshConfiguration: RefreshConfiguration | undefined; -} - -/** - * @public - *

A filter that you apply when searching for datasets.

- */ -export interface DataSetSearchFilter { - /** - * @public - *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

- *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

- *

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

- */ - Operator: FilterOperator | string | undefined; - - /** - * @public - *

The name of the value that you want to use as a filter, for example, "Name": - * "QUICKSIGHT_OWNER".

- *

Valid values are defined as follows:

- *
    - *
  • - *

    - * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.

    - *
    • - *
  • - *

    - * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.

    - *
    • - *
  • - *

    - * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.

    - *
    • - *
  • - *

    - * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.

    - *
    • - *
  • - *

    - * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.

    - *
    • - *
  • - *

    - * DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.

    - *
    • - *
- */ - Name: DataSetFilterAttribute | string | undefined; - - /** - * @public - *

The value of the named item, in this case QUICKSIGHT_OWNER, that you want - * to use as a filter, for example, "Value": - * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

- */ - Value: string | undefined; -} - -/** - * @public - *

Dataset summary.

- */ -export interface DataSetSummary { - /** - * @public - *

The Amazon Resource Name (ARN) of the dataset.

- */ - Arn?: string; - - /** - * @public - *

The ID of the dataset.

- */ - DataSetId?: string; - - /** - * @public - *

A display name for the dataset.

- */ - Name?: string; - - /** - * @public - *

The time that this dataset was created.

- */ - CreatedTime?: Date; - - /** - * @public - *

The last time that this dataset was updated.

- */ - LastUpdatedTime?: Date; - - /** - * @public - *

A value that indicates whether you want to import the data into SPICE.

- */ - ImportMode?: DataSetImportMode | string; - - /** - * @public - *

The row-level security configuration for the dataset.

- */ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet; - - /** - * @public - *

Whether or not the row level permission tags are applied.

- */ - RowLevelPermissionTagConfigurationApplied?: boolean; - - /** - * @public - *

A value that indicates if the dataset has column level permission configured.

- */ - ColumnLevelPermissionRulesApplied?: boolean; -} - -/** - * @public - * @enum + * @internal */ -export const DataSourceErrorInfoType = { - ACCESS_DENIED: "ACCESS_DENIED", - CONFLICT: "CONFLICT", - COPY_SOURCE_NOT_FOUND: "COPY_SOURCE_NOT_FOUND", - ENGINE_VERSION_NOT_SUPPORTED: "ENGINE_VERSION_NOT_SUPPORTED", - GENERIC_SQL_FAILURE: "GENERIC_SQL_FAILURE", - TIMEOUT: "TIMEOUT", - UNKNOWN: "UNKNOWN", - UNKNOWN_HOST: "UNKNOWN_HOST", -} as const; +export const SnapshotJobResultFileGroupFilterSensitiveLog = (obj: SnapshotJobResultFileGroup): any => ({ + ...obj, + ...(obj.S3Results && { S3Results: obj.S3Results.map((item) => SnapshotJobS3ResultFilterSensitiveLog(item)) }), +}); /** - * @public + * @internal */ -export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType]; +export const AnonymousUserSnapshotJobResultFilterSensitiveLog = (obj: AnonymousUserSnapshotJobResult): any => ({ + ...obj, +}); /** * @internal diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts index 9915556c0dea..09d1d788be25 100644 --- a/clients/client-quicksight/src/models/models_3.ts +++ b/clients/client-quicksight/src/models/models_3.ts @@ -17,7 +17,6 @@ import { AnalysisSearchFilter, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, - AnonymousUserSnapshotJobResult, DashboardVisualId, FilterOperator, SnapshotFile, @@ -26,6 +25,7 @@ import { import { _Parameters, _ParametersFilterSensitiveLog, + AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, @@ -50,11 +50,9 @@ import { DashboardVersionSummary, DataSet, DataSetConfiguration, + DataSetFilterAttribute, DataSetFilterSensitiveLog, - DataSetRefreshProperties, - DataSetSearchFilter, - DataSetSummary, - DataSourceErrorInfoType, + DataSetImportMode, DataSourceParameters, DataSourceType, FolderType, @@ -62,10 +60,12 @@ import { GroupMember, IdentityStore, IngestionStatus, + LookbackWindowSizeUnit, MemberType, NamespaceStatus, RefreshSchedule, ResourcePermission, + RowLevelPermissionDataSet, SharingModel, SslProperties, Tag, @@ -81,6 +81,202 @@ import { } from "./models_2"; import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException"; +/** + * @public + *

The lookback window setup of an incremental refresh configuration.

+ */ +export interface LookbackWindow { + /** + * @public + *

The name of the lookback window column.

+ */ + ColumnName: string | undefined; + + /** + * @public + *

The lookback window column size.

+ */ + Size: number | undefined; + + /** + * @public + *

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

+ */ + SizeUnit: LookbackWindowSizeUnit | string | undefined; +} + +/** + * @public + *

The incremental refresh configuration for a dataset.

+ */ +export interface IncrementalRefresh { + /** + * @public + *

The lookback window setup for an incremental refresh configuration.

+ */ + LookbackWindow: LookbackWindow | undefined; +} + +/** + * @public + *

The refresh configuration of a dataset.

+ */ +export interface RefreshConfiguration { + /** + * @public + *

The incremental refresh for the dataset.

+ */ + IncrementalRefresh: IncrementalRefresh | undefined; +} + +/** + * @public + *

The refresh properties of a dataset.

+ */ +export interface DataSetRefreshProperties { + /** + * @public + *

The refresh configuration for a dataset.

+ */ + RefreshConfiguration: RefreshConfiguration | undefined; +} + +/** + * @public + *

A filter that you apply when searching for datasets.

+ */ +export interface DataSetSearchFilter { + /** + * @public + *

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

+ *

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

+ *

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

+ */ + Operator: FilterOperator | string | undefined; + + /** + * @public + *

The name of the value that you want to use as a filter, for example, "Name": + * "QUICKSIGHT_OWNER".

+ *

Valid values are defined as follows:

+ *
    + *
  • + *

    + * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.

    + *
    • + *
  • + *

    + * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.

    + *
    • + *
  • + *

    + * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.

    + *
    • + *
  • + *

    + * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.

    + *
    • + *
  • + *

    + * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.

    + *
    • + *
  • + *

    + * DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.

    + *
    • + *
+ */ + Name: DataSetFilterAttribute | string | undefined; + + /** + * @public + *

The value of the named item, in this case QUICKSIGHT_OWNER, that you want + * to use as a filter, for example, "Value": + * "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

+ */ + Value: string | undefined; +} + +/** + * @public + *

Dataset summary.

+ */ +export interface DataSetSummary { + /** + * @public + *

The Amazon Resource Name (ARN) of the dataset.

+ */ + Arn?: string; + + /** + * @public + *

The ID of the dataset.

+ */ + DataSetId?: string; + + /** + * @public + *

A display name for the dataset.

+ */ + Name?: string; + + /** + * @public + *

The time that this dataset was created.

+ */ + CreatedTime?: Date; + + /** + * @public + *

The last time that this dataset was updated.

+ */ + LastUpdatedTime?: Date; + + /** + * @public + *

A value that indicates whether you want to import the data into SPICE.

+ */ + ImportMode?: DataSetImportMode | string; + + /** + * @public + *

The row-level security configuration for the dataset.

+ */ + RowLevelPermissionDataSet?: RowLevelPermissionDataSet; + + /** + * @public + *

Whether or not the row level permission tags are applied.

+ */ + RowLevelPermissionTagConfigurationApplied?: boolean; + + /** + * @public + *

A value that indicates if the dataset has column level permission configured.

+ */ + ColumnLevelPermissionRulesApplied?: boolean; +} + +/** + * @public + * @enum + */ +export const DataSourceErrorInfoType = { + ACCESS_DENIED: "ACCESS_DENIED", + CONFLICT: "CONFLICT", + COPY_SOURCE_NOT_FOUND: "COPY_SOURCE_NOT_FOUND", + ENGINE_VERSION_NOT_SUPPORTED: "ENGINE_VERSION_NOT_SUPPORTED", + GENERIC_SQL_FAILURE: "GENERIC_SQL_FAILURE", + TIMEOUT: "TIMEOUT", + UNKNOWN: "UNKNOWN", + UNKNOWN_HOST: "UNKNOWN_HOST", +} as const; + +/** + * @public + */ +export type DataSourceErrorInfoType = (typeof DataSourceErrorInfoType)[keyof typeof DataSourceErrorInfoType]; + /** * @public *

Error information for the data source creation or update.

@@ -8961,175 +9157,6 @@ export interface StartDashboardSnapshotJobResponse { Status?: number; } -/** - * @public - */ -export interface TagResourceRequest { - /** - * @public - *

The Amazon Resource Name (ARN) of the resource that you want to tag.

- */ - ResourceArn: string | undefined; - - /** - * @public - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

- */ - Tags: Tag[] | undefined; -} - -/** - * @public - */ -export interface TagResourceResponse { - /** - * @public - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; - - /** - * @public - *

The HTTP status of the request.

- */ - Status?: number; -} - -/** - * @public - */ -export interface UntagResourceRequest { - /** - * @public - *

The Amazon Resource Name (ARN) of the resource that you want to untag.

- */ - ResourceArn: string | undefined; - - /** - * @public - *

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

- */ - TagKeys: string[] | undefined; -} - -/** - * @public - */ -export interface UntagResourceResponse { - /** - * @public - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; - - /** - * @public - *

The HTTP status of the request.

- */ - Status?: number; -} - -/** - * @public - */ -export interface UpdateAccountCustomizationRequest { - /** - * @public - *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations - * for.

- */ - AwsAccountId: string | undefined; - - /** - * @public - *

The namespace that you want to update Amazon QuickSight customizations for.

- */ - Namespace?: string; - - /** - * @public - *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

- */ - AccountCustomization: AccountCustomization | undefined; -} - -/** - * @public - */ -export interface UpdateAccountCustomizationResponse { - /** - * @public - *

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

- */ - Arn?: string; - - /** - * @public - *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations - * for.

- */ - AwsAccountId?: string; - - /** - * @public - *

The namespace associated with the customization that you're updating.

- */ - Namespace?: string; - - /** - * @public - *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

- */ - AccountCustomization?: AccountCustomization; - - /** - * @public - *

The Amazon Web Services request ID for this operation.

- */ - RequestId?: string; - - /** - * @public - *

The HTTP status of the request.

- */ - Status?: number; -} - -/** - * @public - */ -export interface UpdateAccountSettingsRequest { - /** - * @public - *

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to - * list.

- */ - AwsAccountId: string | undefined; - - /** - * @public - *

The default namespace for this Amazon Web Services account. Currently, the default is - * default. IAM users that - * register for the first time with Amazon QuickSight provide an email address that becomes - * associated with the default namespace. - *

- */ - DefaultNamespace: string | undefined; - - /** - * @public - *

The email address that you want Amazon QuickSight to send notifications to regarding your - * Amazon Web Services account or Amazon QuickSight subscription.

- */ - NotificationEmail?: string; - - /** - * @public - *

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

- */ - TerminationProtectionEnabled?: boolean; -} - /** * @internal */ diff --git a/clients/client-quicksight/src/models/models_4.ts b/clients/client-quicksight/src/models/models_4.ts index 8d48a7444160..d6a84ba3fda1 100644 --- a/clients/client-quicksight/src/models/models_4.ts +++ b/clients/client-quicksight/src/models/models_4.ts @@ -1,7 +1,7 @@ // smithy-typescript generated code import { SENSITIVE_STRING } from "@smithy/smithy-client"; -import { ResourceStatus } from "./models_0"; +import { AccountCustomization, ResourceStatus } from "./models_0"; import { AnalysisDefinition, AnalysisSourceEntity } from "./models_1"; import { _Parameters, @@ -28,6 +28,7 @@ import { RowLevelPermissionTagConfiguration, RowLevelPermissionTagConfigurationFilterSensitiveLog, SslProperties, + Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, @@ -41,6 +42,175 @@ import { } from "./models_2"; import { LinkSharingConfiguration, User, UserRole } from "./models_3"; +/** + * @public + */ +export interface TagResourceRequest { + /** + * @public + *

The Amazon Resource Name (ARN) of the resource that you want to tag.

+ */ + ResourceArn: string | undefined; + + /** + * @public + *

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

+ */ + Tags: Tag[] | undefined; +} + +/** + * @public + */ +export interface TagResourceResponse { + /** + * @public + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; + + /** + * @public + *

The HTTP status of the request.

+ */ + Status?: number; +} + +/** + * @public + */ +export interface UntagResourceRequest { + /** + * @public + *

The Amazon Resource Name (ARN) of the resource that you want to untag.

+ */ + ResourceArn: string | undefined; + + /** + * @public + *

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

+ */ + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceResponse { + /** + * @public + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; + + /** + * @public + *

The HTTP status of the request.

+ */ + Status?: number; +} + +/** + * @public + */ +export interface UpdateAccountCustomizationRequest { + /** + * @public + *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations + * for.

+ */ + AwsAccountId: string | undefined; + + /** + * @public + *

The namespace that you want to update Amazon QuickSight customizations for.

+ */ + Namespace?: string; + + /** + * @public + *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

+ */ + AccountCustomization: AccountCustomization | undefined; +} + +/** + * @public + */ +export interface UpdateAccountCustomizationResponse { + /** + * @public + *

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

+ */ + Arn?: string; + + /** + * @public + *

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations + * for.

+ */ + AwsAccountId?: string; + + /** + * @public + *

The namespace associated with the customization that you're updating.

+ */ + Namespace?: string; + + /** + * @public + *

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

+ */ + AccountCustomization?: AccountCustomization; + + /** + * @public + *

The Amazon Web Services request ID for this operation.

+ */ + RequestId?: string; + + /** + * @public + *

The HTTP status of the request.

+ */ + Status?: number; +} + +/** + * @public + */ +export interface UpdateAccountSettingsRequest { + /** + * @public + *

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to + * list.

+ */ + AwsAccountId: string | undefined; + + /** + * @public + *

The default namespace for this Amazon Web Services account. Currently, the default is + * default. IAM users that + * register for the first time with Amazon QuickSight provide an email address that becomes + * associated with the default namespace. + *

+ */ + DefaultNamespace: string | undefined; + + /** + * @public + *

The email address that you want Amazon QuickSight to send notifications to regarding your + * Amazon Web Services account or Amazon QuickSight subscription.

+ */ + NotificationEmail?: string; + + /** + * @public + *

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

+ */ + TerminationProtectionEnabled?: boolean; +} + /** * @public */ diff --git a/clients/client-quicksight/src/protocols/Aws_restJson1.ts b/clients/client-quicksight/src/protocols/Aws_restJson1.ts index 56c0aa077d4b..856bcabb3ec4 100644 --- a/clients/client-quicksight/src/protocols/Aws_restJson1.ts +++ b/clients/client-quicksight/src/protocols/Aws_restJson1.ts @@ -685,11 +685,6 @@ import { ArcAxisDisplayRange, ArcConfiguration, ArcOptions, - AssetBundleExportJobAnalysisOverrideProperties, - AssetBundleExportJobAnalysisPropertyToOverride, - AssetBundleExportJobDashboardOverrideProperties, - AssetBundleExportJobDashboardPropertyToOverride, - AssetBundleExportJobDataSetPropertyToOverride, BinCountOptions, BinWidthOptions, BoxPlotAggregatedFieldWells, @@ -782,6 +777,8 @@ import { HistogramVisual, InsightConfiguration, InsightVisual, + KPIActualValueConditionalFormatting, + KPIComparisonValueConditionalFormatting, KPIConditionalFormatting, KPIConditionalFormattingOption, KPIConfiguration, @@ -790,7 +787,10 @@ import { KPIPrimaryValueConditionalFormatting, KPIProgressBarConditionalFormatting, KPISortConfiguration, + KPISparklineOptions, KPIVisual, + KPIVisualLayoutOptions, + KPIVisualStandardLayout, LineChartAggregatedFieldWells, LineChartConfiguration, LineChartDefaultSeriesSettings, @@ -923,7 +923,12 @@ import { import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, + AssetBundleExportJobAnalysisOverrideProperties, + AssetBundleExportJobAnalysisPropertyToOverride, + AssetBundleExportJobDashboardOverrideProperties, + AssetBundleExportJobDashboardPropertyToOverride, AssetBundleExportJobDataSetOverrideProperties, + AssetBundleExportJobDataSetPropertyToOverride, AssetBundleExportJobDataSourceOverrideProperties, AssetBundleExportJobDataSourcePropertyToOverride, AssetBundleExportJobRefreshScheduleOverrideProperties, @@ -992,10 +997,7 @@ import { DataSetConfiguration, DatasetMetadata, DatasetParameter, - DataSetRefreshProperties, DataSetSchema, - DataSetSearchFilter, - DataSetSummary, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, @@ -1016,7 +1018,6 @@ import { Font, GeoSpatialColumnGroup, GutterStyle, - IncrementalRefresh, InputColumn, IntegerDatasetParameter, IntegerDatasetParameterDefaultValues, @@ -1029,7 +1030,6 @@ import { LimitExceededException, LogicalTable, LogicalTableSource, - LookbackWindow, ManifestFileLocation, MarginStyle, MariaDbParameters, @@ -1048,7 +1048,6 @@ import { RangeConstant, RdsParameters, RedshiftParameters, - RefreshConfiguration, RefreshFrequency, RefreshSchedule, RelationalTable, @@ -1113,6 +1112,9 @@ import { VpcConnectionProperties, } from "../models/models_2"; import { + DataSetRefreshProperties, + DataSetSearchFilter, + DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, @@ -1122,10 +1124,13 @@ import { FolderSummary, GroupSearchFilter, IdentityTypeNotSupportedException, + IncrementalRefresh, Ingestion, InvalidNextTokenException, InvalidRequestException, + LookbackWindow, QuickSightUserNotFoundException, + RefreshConfiguration, RegisteredUserConsoleFeatureConfigurations, RegisteredUserDashboardEmbeddingConfiguration, RegisteredUserDashboardFeatureConfigurations, @@ -21227,6 +21232,32 @@ const se_InsightVisual = (input: InsightVisual, context: __SerdeContext): any => // se_JoinKeyProperties omitted. +/** + * serializeAws_restJson1KPIActualValueConditionalFormatting + */ +const se_KPIActualValueConditionalFormatting = ( + input: KPIActualValueConditionalFormatting, + context: __SerdeContext +): any => { + return take(input, { + Icon: _json, + TextColor: (_) => se_ConditionalFormattingColor(_, context), + }); +}; + +/** + * serializeAws_restJson1KPIComparisonValueConditionalFormatting + */ +const se_KPIComparisonValueConditionalFormatting = ( + input: KPIComparisonValueConditionalFormatting, + context: __SerdeContext +): any => { + return take(input, { + Icon: _json, + TextColor: (_) => se_ConditionalFormattingColor(_, context), + }); +}; + /** * serializeAws_restJson1KPIConditionalFormatting */ @@ -21241,6 +21272,8 @@ const se_KPIConditionalFormatting = (input: KPIConditionalFormatting, context: _ */ const se_KPIConditionalFormattingOption = (input: KPIConditionalFormattingOption, context: __SerdeContext): any => { return take(input, { + ActualValue: (_) => se_KPIActualValueConditionalFormatting(_, context), + ComparisonValue: (_) => se_KPIComparisonValueConditionalFormatting(_, context), PrimaryValue: (_) => se_KPIPrimaryValueConditionalFormatting(_, context), ProgressBar: (_) => se_KPIProgressBarConditionalFormatting(_, context), }); @@ -21318,6 +21351,8 @@ const se_KPISortConfiguration = (input: KPISortConfiguration, context: __SerdeCo }); }; +// se_KPISparklineOptions omitted. + /** * serializeAws_restJson1KPIVisual */ @@ -21333,6 +21368,10 @@ const se_KPIVisual = (input: KPIVisual, context: __SerdeContext): any => { }); }; +// se_KPIVisualLayoutOptions omitted. + +// se_KPIVisualStandardLayout omitted. + // se_LabelOptions omitted. /** @@ -26243,6 +26282,32 @@ const de_InsightVisual = (output: any, context: __SerdeContext): InsightVisual = // de_JoinKeyProperties omitted. +/** + * deserializeAws_restJson1KPIActualValueConditionalFormatting + */ +const de_KPIActualValueConditionalFormatting = ( + output: any, + context: __SerdeContext +): KPIActualValueConditionalFormatting => { + return take(output, { + Icon: _json, + TextColor: (_: any) => de_ConditionalFormattingColor(_, context), + }) as any; +}; + +/** + * deserializeAws_restJson1KPIComparisonValueConditionalFormatting + */ +const de_KPIComparisonValueConditionalFormatting = ( + output: any, + context: __SerdeContext +): KPIComparisonValueConditionalFormatting => { + return take(output, { + Icon: _json, + TextColor: (_: any) => de_ConditionalFormattingColor(_, context), + }) as any; +}; + /** * deserializeAws_restJson1KPIConditionalFormatting */ @@ -26257,6 +26322,8 @@ const de_KPIConditionalFormatting = (output: any, context: __SerdeContext): KPIC */ const de_KPIConditionalFormattingOption = (output: any, context: __SerdeContext): KPIConditionalFormattingOption => { return take(output, { + ActualValue: (_: any) => de_KPIActualValueConditionalFormatting(_, context), + ComparisonValue: (_: any) => de_KPIComparisonValueConditionalFormatting(_, context), PrimaryValue: (_: any) => de_KPIPrimaryValueConditionalFormatting(_, context), ProgressBar: (_: any) => de_KPIProgressBarConditionalFormatting(_, context), }) as any; @@ -26335,6 +26402,8 @@ const de_KPISortConfiguration = (output: any, context: __SerdeContext): KPISortC }) as any; }; +// de_KPISparklineOptions omitted. + /** * deserializeAws_restJson1KPIVisual */ @@ -26350,6 +26419,10 @@ const de_KPIVisual = (output: any, context: __SerdeContext): KPIVisual => { }) as any; }; +// de_KPIVisualLayoutOptions omitted. + +// de_KPIVisualStandardLayout omitted. + // de_LabelOptions omitted. /** diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 1a24de0384c4..e43d2de01ab6 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -176,7 +176,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 16 + "max": 20 } } }, @@ -25463,6 +25463,46 @@ } } }, + "com.amazonaws.quicksight#KPIActualValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the actual value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the actual value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the comparison value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the comparison value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" + } + }, "com.amazonaws.quicksight#KPIConditionalFormatting": { "type": "structure", "members": { @@ -25491,6 +25531,18 @@ "traits": { "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" } + }, + "ActualValue": { + "target": "com.amazonaws.quicksight#KPIActualValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" + } + }, + "ComparisonValue": { + "target": "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" + } } }, "traits": { @@ -25605,6 +25657,18 @@ "traits": { "smithy.api#documentation": "

The options that determine the secondary value font configuration.

" } + }, + "Sparkline": { + "target": "com.amazonaws.quicksight#KPISparklineOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" + } + }, + "VisualLayoutOptions": { + "target": "com.amazonaws.quicksight#KPIVisualLayoutOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" + } } }, "traits": { @@ -25659,6 +25723,56 @@ "smithy.api#documentation": "

The sort configuration of a KPI visual.

" } }, + "com.amazonaws.quicksight#KPISparklineOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the sparkline.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#KPISparklineType", + "traits": { + "smithy.api#documentation": "

The type of the sparkline.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the sparkline.

" + } + }, + "TooltipVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The tooltip visibility of the sparkline.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPISparklineType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AREA" + } + } + } + }, "com.amazonaws.quicksight#KPIVisual": { "type": "structure", "members": { @@ -25710,6 +25824,52 @@ "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" } }, + "com.amazonaws.quicksight#KPIVisualLayoutOptions": { + "type": "structure", + "members": { + "StandardLayout": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayout", + "traits": { + "smithy.api#documentation": "

The standard layout of the KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayout": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayoutType", + "traits": { + "smithy.api#documentation": "

The standard layout type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The standard layout of the KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayoutType": { + "type": "enum", + "members": { + "CLASSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIC" + } + }, + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + } + } + }, "com.amazonaws.quicksight#LabelOptions": { "type": "structure", "members": { @@ -50536,4 +50696,4 @@ } } } -} \ No newline at end of file +}