Skip to content

Commit fd1d5c3

Browse files
author
awstools
committed
feat(client-quicksight): Add support to analysis and sheet level highlighting in QuickSight.
1 parent 4f30f3e commit fd1d5c3

20 files changed

+570
-416
lines changed

‎clients/client-quicksight/src/commands/CancelIngestionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { CancelIngestionRequest, CancelIngestionResponse } from "../models/models_2";
8+
import { CancelIngestionRequest, CancelIngestionResponse } from "../models/models_3";
99
import { de_CancelIngestionCommand, se_CancelIngestionCommand } from "../protocols/Aws_restJson1";
1010
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
1111

‎clients/client-quicksight/src/commands/CreateAnalysisCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4813,6 +4813,11 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
48134813
* },
48144814
* ],
48154815
* ContentType: "PAGINATED" || "INTERACTIVE",
4816+
* CustomActionDefaults: { // VisualCustomActionDefaults
4817+
* highlightOperation: { // VisualHighlightOperation
4818+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4819+
* },
4820+
* },
48164821
* },
48174822
* ],
48184823
* CalculatedFields: [ // CalculatedFields
@@ -5463,6 +5468,11 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
54635468
* ExcludedDataSetArns: [ // DataSetArnsList
54645469
* "STRING_VALUE",
54655470
* ],
5471+
* CustomActionDefaults: {
5472+
* highlightOperation: {
5473+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5474+
* },
5475+
* },
54665476
* },
54675477
* QueryExecutionOptions: { // QueryExecutionOptions
54685478
* QueryExecutionMode: "AUTO" || "MANUAL",

‎clients/client-quicksight/src/commands/CreateDashboardCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4860,6 +4860,11 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
48604860
* },
48614861
* ],
48624862
* ContentType: "PAGINATED" || "INTERACTIVE",
4863+
* CustomActionDefaults: { // VisualCustomActionDefaults
4864+
* highlightOperation: { // VisualHighlightOperation
4865+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4866+
* },
4867+
* },
48634868
* },
48644869
* ],
48654870
* CalculatedFields: [ // CalculatedFields
@@ -5510,6 +5515,11 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
55105515
* ExcludedDataSetArns: [ // DataSetArnsList
55115516
* "STRING_VALUE",
55125517
* ],
5518+
* CustomActionDefaults: {
5519+
* highlightOperation: {
5520+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5521+
* },
5522+
* },
55135523
* },
55145524
* StaticFiles: [ // StaticFileList
55155525
* { // StaticFile

‎clients/client-quicksight/src/commands/CreateTemplateCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4807,6 +4807,11 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
48074807
* },
48084808
* ],
48094809
* ContentType: "PAGINATED" || "INTERACTIVE",
4810+
* CustomActionDefaults: { // VisualCustomActionDefaults
4811+
* highlightOperation: { // VisualHighlightOperation
4812+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4813+
* },
4814+
* },
48104815
* },
48114816
* ],
48124817
* CalculatedFields: [ // CalculatedFields
@@ -5457,6 +5462,11 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
54575462
* ExcludedDataSetArns: [ // DataSetArnsList
54585463
* "STRING_VALUE",
54595464
* ],
5465+
* CustomActionDefaults: {
5466+
* highlightOperation: {
5467+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5468+
* },
5469+
* },
54605470
* },
54615471
* QueryExecutionOptions: { // QueryExecutionOptions
54625472
* QueryExecutionMode: "AUTO" || "MANUAL",

‎clients/client-quicksight/src/commands/DeleteTopicRefreshScheduleCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { DeleteTopicRefreshScheduleRequest, DeleteTopicRefreshScheduleResponse } from "../models/models_3";
8+
import { DeleteTopicRefreshScheduleRequest, DeleteTopicRefreshScheduleResponse } from "../models/models_4";
99
import { de_DeleteTopicRefreshScheduleCommand, se_DeleteTopicRefreshScheduleCommand } from "../protocols/Aws_restJson1";
1010
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
1111

‎clients/client-quicksight/src/commands/DeleteUserCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
55
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
8-
import { DeleteUserRequest } from "../models/models_3";
9-
import { DeleteUserResponse } from "../models/models_4";
8+
import { DeleteUserRequest, DeleteUserResponse } from "../models/models_4";
109
import { de_DeleteUserCommand, se_DeleteUserCommand } from "../protocols/Aws_restJson1";
1110
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
1211

‎clients/client-quicksight/src/commands/DescribeAnalysisDefinitionCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4779,6 +4779,11 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
47794779
* // },
47804780
* // ],
47814781
* // ContentType: "PAGINATED" || "INTERACTIVE",
4782+
* // CustomActionDefaults: { // VisualCustomActionDefaults
4783+
* // highlightOperation: { // VisualHighlightOperation
4784+
* // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4785+
* // },
4786+
* // },
47824787
* // },
47834788
* // ],
47844789
* // CalculatedFields: [ // CalculatedFields
@@ -5429,6 +5434,11 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
54295434
* // ExcludedDataSetArns: [ // DataSetArnsList
54305435
* // "STRING_VALUE",
54315436
* // ],
5437+
* // CustomActionDefaults: {
5438+
* // highlightOperation: {
5439+
* // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5440+
* // },
5441+
* // },
54325442
* // },
54335443
* // QueryExecutionOptions: { // QueryExecutionOptions
54345444
* // QueryExecutionMode: "AUTO" || "MANUAL",

‎clients/client-quicksight/src/commands/DescribeDashboardDefinitionCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4786,6 +4786,11 @@ export interface DescribeDashboardDefinitionCommandOutput
47864786
* // },
47874787
* // ],
47884788
* // ContentType: "PAGINATED" || "INTERACTIVE",
4789+
* // CustomActionDefaults: { // VisualCustomActionDefaults
4790+
* // highlightOperation: { // VisualHighlightOperation
4791+
* // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4792+
* // },
4793+
* // },
47894794
* // },
47904795
* // ],
47914796
* // CalculatedFields: [ // CalculatedFields
@@ -5436,6 +5441,11 @@ export interface DescribeDashboardDefinitionCommandOutput
54365441
* // ExcludedDataSetArns: [ // DataSetArnsList
54375442
* // "STRING_VALUE",
54385443
* // ],
5444+
* // CustomActionDefaults: {
5445+
* // highlightOperation: {
5446+
* // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5447+
* // },
5448+
* // },
54395449
* // },
54405450
* // StaticFiles: [ // StaticFileList
54415451
* // { // StaticFile

‎clients/client-quicksight/src/commands/DescribeTemplateDefinitionCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4799,6 +4799,11 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
47994799
* // },
48004800
* // ],
48014801
* // ContentType: "PAGINATED" || "INTERACTIVE",
4802+
* // CustomActionDefaults: { // VisualCustomActionDefaults
4803+
* // highlightOperation: { // VisualHighlightOperation
4804+
* // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4805+
* // },
4806+
* // },
48024807
* // },
48034808
* // ],
48044809
* // CalculatedFields: [ // CalculatedFields
@@ -5449,6 +5454,11 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
54495454
* // ExcludedDataSetArns: [ // DataSetArnsList
54505455
* // "STRING_VALUE",
54515456
* // ],
5457+
* // CustomActionDefaults: {
5458+
* // highlightOperation: {
5459+
* // Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5460+
* // },
5461+
* // },
54525462
* // },
54535463
* // QueryExecutionOptions: { // QueryExecutionOptions
54545464
* // QueryExecutionMode: "AUTO" || "MANUAL",

‎clients/client-quicksight/src/commands/StartAssetBundleImportJobCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
StartAssetBundleImportJobRequest,
1010
StartAssetBundleImportJobRequestFilterSensitiveLog,
1111
StartAssetBundleImportJobResponse,
12-
} from "../models/models_4";
12+
} from "../models/models_5";
1313
import { de_StartAssetBundleImportJobCommand, se_StartAssetBundleImportJobCommand } from "../protocols/Aws_restJson1";
1414
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
1515

‎clients/client-quicksight/src/commands/UpdateAnalysisCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4799,6 +4799,11 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M
47994799
* },
48004800
* ],
48014801
* ContentType: "PAGINATED" || "INTERACTIVE",
4802+
* CustomActionDefaults: { // VisualCustomActionDefaults
4803+
* highlightOperation: { // VisualHighlightOperation
4804+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4805+
* },
4806+
* },
48024807
* },
48034808
* ],
48044809
* CalculatedFields: [ // CalculatedFields
@@ -5449,6 +5454,11 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M
54495454
* ExcludedDataSetArns: [ // DataSetArnsList
54505455
* "STRING_VALUE",
54515456
* ],
5457+
* CustomActionDefaults: {
5458+
* highlightOperation: {
5459+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5460+
* },
5461+
* },
54525462
* },
54535463
* QueryExecutionOptions: { // QueryExecutionOptions
54545464
* QueryExecutionMode: "AUTO" || "MANUAL",

‎clients/client-quicksight/src/commands/UpdateDashboardCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4845,6 +4845,11 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
48454845
* },
48464846
* ],
48474847
* ContentType: "PAGINATED" || "INTERACTIVE",
4848+
* CustomActionDefaults: { // VisualCustomActionDefaults
4849+
* highlightOperation: { // VisualHighlightOperation
4850+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4851+
* },
4852+
* },
48484853
* },
48494854
* ],
48504855
* CalculatedFields: [ // CalculatedFields
@@ -5495,6 +5500,11 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
54955500
* ExcludedDataSetArns: [ // DataSetArnsList
54965501
* "STRING_VALUE",
54975502
* ],
5503+
* CustomActionDefaults: {
5504+
* highlightOperation: {
5505+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5506+
* },
5507+
* },
54985508
* },
54995509
* StaticFiles: [ // StaticFileList
55005510
* { // StaticFile

‎clients/client-quicksight/src/commands/UpdateTemplateCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4786,6 +4786,11 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
47864786
* },
47874787
* ],
47884788
* ContentType: "PAGINATED" || "INTERACTIVE",
4789+
* CustomActionDefaults: { // VisualCustomActionDefaults
4790+
* highlightOperation: { // VisualHighlightOperation
4791+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
4792+
* },
4793+
* },
47894794
* },
47904795
* ],
47914796
* CalculatedFields: [ // CalculatedFields
@@ -5436,6 +5441,11 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
54365441
* ExcludedDataSetArns: [ // DataSetArnsList
54375442
* "STRING_VALUE",
54385443
* ],
5444+
* CustomActionDefaults: {
5445+
* highlightOperation: {
5446+
* Trigger: "DATA_POINT_CLICK" || "DATA_POINT_HOVER" || "NONE", // required
5447+
* },
5448+
* },
54395449
* },
54405450
* QueryExecutionOptions: { // QueryExecutionOptions
54415451
* QueryExecutionMode: "AUTO" || "MANUAL",

‎clients/client-quicksight/src/models/models_0.ts

Lines changed: 45 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4157,6 +4157,45 @@ export interface FilterGroup {
41574157
CrossDataset: CrossDatasetTypes | undefined;
41584158
}
41594159

4160+
/**
4161+
* @public
4162+
* @enum
4163+
*/
4164+
export const VisualHighlightTrigger = {
4165+
DATA_POINT_CLICK: "DATA_POINT_CLICK",
4166+
DATA_POINT_HOVER: "DATA_POINT_HOVER",
4167+
NONE: "NONE",
4168+
} as const;
4169+
4170+
/**
4171+
* @public
4172+
*/
4173+
export type VisualHighlightTrigger = (typeof VisualHighlightTrigger)[keyof typeof VisualHighlightTrigger];
4174+
4175+
/**
4176+
* <p>Defines what initiates a highlight operation on a visual, such as a click or hover.</p>
4177+
* @public
4178+
*/
4179+
export interface VisualHighlightOperation {
4180+
/**
4181+
* <p>Specifies whether a highlight operation is initiated by a click or hover, or whether it's disabled.</p>
4182+
* @public
4183+
*/
4184+
Trigger: VisualHighlightTrigger | undefined;
4185+
}
4186+
4187+
/**
4188+
* <p>A list of custom actions applied to visuals in an analysis or sheet.</p>
4189+
* @public
4190+
*/
4191+
export interface VisualCustomActionDefaults {
4192+
/**
4193+
* <p>A list of highlight operations available for visuals in an analysis or sheet.</p>
4194+
* @public
4195+
*/
4196+
highlightOperation?: VisualHighlightOperation | undefined;
4197+
}
4198+
41604199
/**
41614200
* @public
41624201
* @enum
@@ -4218,6 +4257,12 @@ export interface AssetOptions {
42184257
* @public
42194258
*/
42204259
ExcludedDataSetArns?: string[] | undefined;
4260+
4261+
/**
4262+
* <p>A list of visual custom actions for the analysis.</p>
4263+
* @public
4264+
*/
4265+
CustomActionDefaults?: VisualCustomActionDefaults | undefined;
42214266
}
42224267

42234268
/**
@@ -7366,58 +7411,6 @@ export interface LegendOptions {
73667411
ValueFontConfiguration?: FontConfiguration | undefined;
73677412
}
73687413

7369-
/**
7370-
* @public
7371-
* @enum
7372-
*/
7373-
export const BarChartOrientation = {
7374-
HORIZONTAL: "HORIZONTAL",
7375-
VERTICAL: "VERTICAL",
7376-
} as const;
7377-
7378-
/**
7379-
* @public
7380-
*/
7381-
export type BarChartOrientation = (typeof BarChartOrientation)[keyof typeof BarChartOrientation];
7382-
7383-
/**
7384-
* @public
7385-
* @enum
7386-
*/
7387-
export const AxisBinding = {
7388-
PRIMARY_YAXIS: "PRIMARY_YAXIS",
7389-
SECONDARY_YAXIS: "SECONDARY_YAXIS",
7390-
} as const;
7391-
7392-
/**
7393-
* @public
7394-
*/
7395-
export type AxisBinding = (typeof AxisBinding)[keyof typeof AxisBinding];
7396-
7397-
/**
7398-
* <p>The dynamic configuration of the reference line data configuration.</p>
7399-
* @public
7400-
*/
7401-
export interface ReferenceLineDynamicDataConfiguration {
7402-
/**
7403-
* <p>The column that the dynamic data targets.</p>
7404-
* @public
7405-
*/
7406-
Column: ColumnIdentifier | undefined;
7407-
7408-
/**
7409-
* <p>The aggregation function that is used in the dynamic data.</p>
7410-
* @public
7411-
*/
7412-
MeasureAggregationFunction?: AggregationFunction | undefined;
7413-
7414-
/**
7415-
* <p>The calculation that is used in the dynamic data.</p>
7416-
* @public
7417-
*/
7418-
Calculation: NumericalAggregationFunction | undefined;
7419-
}
7420-
74217414
/**
74227415
* @internal
74237416
*/

0 commit comments

Comments
 (0)