feat(client-quicksight): Add support to analysis and sheet level highlighting in QuickSight.

awstools · awstools · commit fd1d5c3c2730 · 2025-04-10T18:18:03.000Z
diff --git a/clients/client-quicksight/src/commands/CancelIngestionCommand.ts b/clients/client-quicksight/src/commands/CancelIngestionCommand.ts
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { CancelIngestionRequest, CancelIngestionResponse } from "../models/models_2";
+import { CancelIngestionRequest, CancelIngestionResponse } from "../models/models_3";
 import { de_CancelIngestionCommand, se_CancelIngestionCommand } from "../protocols/Aws_restJson1";
 import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
 
diff --git a/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts b/clients/client-quicksight/src/commands/CreateAnalysisCommand.ts
@@ -4813,6 +4813,11 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
  *           },
  *         ],
  *         ContentType: "PAGINATED" || "INTERACTIVE",
+ *         CustomActionDefaults: { // VisualCustomActionDefaults
+ *           highlightOperation: { // VisualHighlightOperation
+ *             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *           },
+ *         },
  *       },
  *     ],
  *     CalculatedFields: [ // CalculatedFields
@@ -5463,6 +5468,11 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
  *       ExcludedDataSetArns: [ // DataSetArnsList
  *         "STRING_VALUE",
  *       ],
+ *       CustomActionDefaults: {
+ *         highlightOperation: {
+ *           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *         },
+ *       },
  *     },
  *     QueryExecutionOptions: { // QueryExecutionOptions
  *       QueryExecutionMode: "AUTO" || "MANUAL",
diff --git a/clients/client-quicksight/src/commands/CreateDashboardCommand.ts b/clients/client-quicksight/src/commands/CreateDashboardCommand.ts
@@ -4860,6 +4860,11 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
  *           },
  *         ],
  *         ContentType: "PAGINATED" || "INTERACTIVE",
+ *         CustomActionDefaults: { // VisualCustomActionDefaults
+ *           highlightOperation: { // VisualHighlightOperation
+ *             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *           },
+ *         },
  *       },
  *     ],
  *     CalculatedFields: [ // CalculatedFields
@@ -5510,6 +5515,11 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
  *       ExcludedDataSetArns: [ // DataSetArnsList
  *         "STRING_VALUE",
  *       ],
+ *       CustomActionDefaults: {
+ *         highlightOperation: {
+ *           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *         },
+ *       },
  *     },
  *     StaticFiles: [ // StaticFileList
  *       { // StaticFile
diff --git a/clients/client-quicksight/src/commands/CreateTemplateCommand.ts b/clients/client-quicksight/src/commands/CreateTemplateCommand.ts
@@ -4807,6 +4807,11 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
  *           },
  *         ],
  *         ContentType: "PAGINATED" || "INTERACTIVE",
+ *         CustomActionDefaults: { // VisualCustomActionDefaults
+ *           highlightOperation: { // VisualHighlightOperation
+ *             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *           },
+ *         },
  *       },
  *     ],
  *     CalculatedFields: [ // CalculatedFields
@@ -5457,6 +5462,11 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
  *       ExcludedDataSetArns: [ // DataSetArnsList
  *         "STRING_VALUE",
  *       ],
+ *       CustomActionDefaults: {
+ *         highlightOperation: {
+ *           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *         },
+ *       },
  *     },
  *     QueryExecutionOptions: { // QueryExecutionOptions
  *       QueryExecutionMode: "AUTO" || "MANUAL",
diff --git a/clients/client-quicksight/src/commands/DeleteTopicRefreshScheduleCommand.ts b/clients/client-quicksight/src/commands/DeleteTopicRefreshScheduleCommand.ts
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { DeleteTopicRefreshScheduleRequest, DeleteTopicRefreshScheduleResponse } from "../models/models_3";
+import { DeleteTopicRefreshScheduleRequest, DeleteTopicRefreshScheduleResponse } from "../models/models_4";
 import { de_DeleteTopicRefreshScheduleCommand, se_DeleteTopicRefreshScheduleCommand } from "../protocols/Aws_restJson1";
 import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
 
diff --git a/clients/client-quicksight/src/commands/DeleteUserCommand.ts b/clients/client-quicksight/src/commands/DeleteUserCommand.ts
@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { DeleteUserRequest } from "../models/models_3";
-import { DeleteUserResponse } from "../models/models_4";
+import { DeleteUserRequest, DeleteUserResponse } from "../models/models_4";
 import { de_DeleteUserCommand, se_DeleteUserCommand } from "../protocols/Aws_restJson1";
 import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
 
diff --git a/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts
@@ -4779,6 +4779,11 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
  * //           },
  * //         ],
  * //         ContentType: "PAGINATED" || "INTERACTIVE",
+ * //         CustomActionDefaults: { // VisualCustomActionDefaults
+ * //           highlightOperation: { // VisualHighlightOperation
+ * //             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ * //           },
+ * //         },
  * //       },
  * //     ],
  * //     CalculatedFields: [ // CalculatedFields
@@ -5429,6 +5434,11 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
  * //       ExcludedDataSetArns: [ // DataSetArnsList
  * //         "STRING_VALUE",
  * //       ],
+ * //       CustomActionDefaults: {
+ * //         highlightOperation: {
+ * //           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ * //         },
+ * //       },
  * //     },
  * //     QueryExecutionOptions: { // QueryExecutionOptions
  * //       QueryExecutionMode: "AUTO" || "MANUAL",
diff --git a/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts
@@ -4786,6 +4786,11 @@ export interface DescribeDashboardDefinitionCommandOutput
  * //           },
  * //         ],
  * //         ContentType: "PAGINATED" || "INTERACTIVE",
+ * //         CustomActionDefaults: { // VisualCustomActionDefaults
+ * //           highlightOperation: { // VisualHighlightOperation
+ * //             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ * //           },
+ * //         },
  * //       },
  * //     ],
  * //     CalculatedFields: [ // CalculatedFields
@@ -5436,6 +5441,11 @@ export interface DescribeDashboardDefinitionCommandOutput
  * //       ExcludedDataSetArns: [ // DataSetArnsList
  * //         "STRING_VALUE",
  * //       ],
+ * //       CustomActionDefaults: {
+ * //         highlightOperation: {
+ * //           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ * //         },
+ * //       },
  * //     },
  * //     StaticFiles: [ // StaticFileList
  * //       { // StaticFile
diff --git a/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts b/clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts
@@ -4799,6 +4799,11 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
  * //           },
  * //         ],
  * //         ContentType: "PAGINATED" || "INTERACTIVE",
+ * //         CustomActionDefaults: { // VisualCustomActionDefaults
+ * //           highlightOperation: { // VisualHighlightOperation
+ * //             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ * //           },
+ * //         },
  * //       },
  * //     ],
  * //     CalculatedFields: [ // CalculatedFields
@@ -5449,6 +5454,11 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
  * //       ExcludedDataSetArns: [ // DataSetArnsList
  * //         "STRING_VALUE",
  * //       ],
+ * //       CustomActionDefaults: {
+ * //         highlightOperation: {
+ * //           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ * //         },
+ * //       },
  * //     },
  * //     QueryExecutionOptions: { // QueryExecutionOptions
  * //       QueryExecutionMode: "AUTO" || "MANUAL",
diff --git a/clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts b/clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts
@@ -9,7 +9,7 @@ import {
   StartAssetBundleImportJobRequest,
   StartAssetBundleImportJobRequestFilterSensitiveLog,
   StartAssetBundleImportJobResponse,
-} from "../models/models_4";
+} from "../models/models_5";
 import { de_StartAssetBundleImportJobCommand, se_StartAssetBundleImportJobCommand } 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
@@ -4799,6 +4799,11 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M
  *           },
  *         ],
  *         ContentType: "PAGINATED" || "INTERACTIVE",
+ *         CustomActionDefaults: { // VisualCustomActionDefaults
+ *           highlightOperation: { // VisualHighlightOperation
+ *             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *           },
+ *         },
  *       },
  *     ],
  *     CalculatedFields: [ // CalculatedFields
@@ -5449,6 +5454,11 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M
  *       ExcludedDataSetArns: [ // DataSetArnsList
  *         "STRING_VALUE",
  *       ],
+ *       CustomActionDefaults: {
+ *         highlightOperation: {
+ *           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *         },
+ *       },
  *     },
  *     QueryExecutionOptions: { // QueryExecutionOptions
  *       QueryExecutionMode: "AUTO" || "MANUAL",
diff --git a/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts b/clients/client-quicksight/src/commands/UpdateDashboardCommand.ts
@@ -4845,6 +4845,11 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
  *           },
  *         ],
  *         ContentType: "PAGINATED" || "INTERACTIVE",
+ *         CustomActionDefaults: { // VisualCustomActionDefaults
+ *           highlightOperation: { // VisualHighlightOperation
+ *             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *           },
+ *         },
  *       },
  *     ],
  *     CalculatedFields: [ // CalculatedFields
@@ -5495,6 +5500,11 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
  *       ExcludedDataSetArns: [ // DataSetArnsList
  *         "STRING_VALUE",
  *       ],
+ *       CustomActionDefaults: {
+ *         highlightOperation: {
+ *           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *         },
+ *       },
  *     },
  *     StaticFiles: [ // StaticFileList
  *       { // StaticFile
diff --git a/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts b/clients/client-quicksight/src/commands/UpdateTemplateCommand.ts
@@ -4786,6 +4786,11 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
  *           },
  *         ],
  *         ContentType: "PAGINATED" || "INTERACTIVE",
+ *         CustomActionDefaults: { // VisualCustomActionDefaults
+ *           highlightOperation: { // VisualHighlightOperation
+ *             Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *           },
+ *         },
  *       },
  *     ],
  *     CalculatedFields: [ // CalculatedFields
@@ -5436,6 +5441,11 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
  *       ExcludedDataSetArns: [ // DataSetArnsList
  *         "STRING_VALUE",
  *       ],
+ *       CustomActionDefaults: {
+ *         highlightOperation: {
+ *           Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
+ *         },
+ *       },
  *     },
  *     QueryExecutionOptions: { // QueryExecutionOptions
  *       QueryExecutionMode: "AUTO" || "MANUAL",
diff --git a/clients/client-quicksight/src/models/models_0.ts b/clients/client-quicksight/src/models/models_0.ts
@@ -4157,6 +4157,45 @@ export interface FilterGroup {
   CrossDataset: CrossDatasetTypes | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const VisualHighlightTrigger = {
+  DATA_POINT_CLICK: "DATA_POINT_CLICK",
+  DATA_POINT_HOVER: "DATA_POINT_HOVER",
+  NONE: "NONE",
+} as const;
+
+/**
+ * @public
+ */
+export type VisualHighlightTrigger = (typeof VisualHighlightTrigger)[keyof typeof VisualHighlightTrigger];
+
+/**
+ * <p>Defines what initiates a highlight operation on a visual, such as a click or hover.</p>
+ * @public
+ */
+export interface VisualHighlightOperation {
+  /**
+   * <p>Specifies whether a highlight operation is initiated by a click or hover, or whether it's disabled.</p>
+   * @public
+   */
+  Trigger: VisualHighlightTrigger | undefined;
+}
+
+/**
+ * <p>A list of custom actions applied to visuals in an analysis or sheet.</p>
+ * @public
+ */
+export interface VisualCustomActionDefaults {
+  /**
+   * <p>A list of highlight operations available for visuals in an analysis or sheet.</p>
+   * @public
+   */
+  highlightOperation?: VisualHighlightOperation | undefined;
+}
+
 /**
  * @public
  * @enum
@@ -4218,6 +4257,12 @@ export interface AssetOptions {
    * @public
    */
   ExcludedDataSetArns?: string[] | undefined;
+
+  /**
+   * <p>A list of visual custom actions for the analysis.</p>
+   * @public
+   */
+  CustomActionDefaults?: VisualCustomActionDefaults | undefined;
 }
 
 /**
@@ -7366,58 +7411,6 @@ export interface LegendOptions {
   ValueFontConfiguration?: FontConfiguration | undefined;
 }
 
-/**
- * @public
- * @enum
- */
-export const BarChartOrientation = {
-  HORIZONTAL: "HORIZONTAL",
-  VERTICAL: "VERTICAL",
-} as const;
-
-/**
- * @public
- */
-export type BarChartOrientation = (typeof BarChartOrientation)[keyof typeof BarChartOrientation];
-
-/**
- * @public
- * @enum
- */
-export const AxisBinding = {
-  PRIMARY_YAXIS: "PRIMARY_YAXIS",
-  SECONDARY_YAXIS: "SECONDARY_YAXIS",
-} as const;
-
-/**
- * @public
- */
-export type AxisBinding = (typeof AxisBinding)[keyof typeof AxisBinding];
-
-/**
- * <p>The dynamic configuration of the reference line data configuration.</p>
- * @public
- */
-export interface ReferenceLineDynamicDataConfiguration {
-  /**
-   * <p>The column that the dynamic data targets.</p>
-   * @public
-   */
-  Column: ColumnIdentifier | undefined;
-
-  /**
-   * <p>The aggregation function that is used in the dynamic data.</p>
-   * @public
-   */
-  MeasureAggregationFunction?: AggregationFunction | undefined;
-
-  /**
-   * <p>The calculation that is used in the dynamic data.</p>
-   * @public
-   */
-  Calculation: NumericalAggregationFunction | undefined;
-}
-
 /**
  * @internal
  */
diff --git a/clients/client-quicksight/src/models/models_1.ts b/clients/client-quicksight/src/models/models_1.ts
diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts
diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts
diff --git a/clients/client-quicksight/src/models/models_4.ts b/clients/client-quicksight/src/models/models_4.ts
diff --git a/clients/client-quicksight/src/models/models_5.ts b/clients/client-quicksight/src/models/models_5.ts
diff --git a/clients/client-quicksight/src/protocols/Aws_restJson1.ts b/clients/client-quicksight/src/protocols/Aws_restJson1.ts
