@aws-sdk/client-quicksight 3.1020.0 → 3.1022.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/README.md +14 -0
  2. package/dist-cjs/index.js +48 -0
  3. package/dist-cjs/schemas/schemas_0.js +186 -82
  4. package/dist-es/QuickSight.js +4 -0
  5. package/dist-es/commands/DescribeAutomationJobCommand.js +16 -0
  6. package/dist-es/commands/StartAutomationJobCommand.js +16 -0
  7. package/dist-es/commands/index.js +2 -0
  8. package/dist-es/index.js +1 -0
  9. package/dist-es/models/enums.js +17 -0
  10. package/dist-es/models/models_5.js +1 -0
  11. package/dist-es/schemas/schemas_0.js +160 -56
  12. package/dist-types/QuickSight.d.ts +14 -0
  13. package/dist-types/QuickSightClient.d.ts +4 -2
  14. package/dist-types/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
  15. package/dist-types/commands/CreateAnalysisCommand.d.ts +2007 -161
  16. package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +3 -0
  17. package/dist-types/commands/CreateDashboardCommand.d.ts +2007 -161
  18. package/dist-types/commands/CreateDataSourceCommand.d.ts +9 -4
  19. package/dist-types/commands/CreateTemplateCommand.d.ts +2007 -161
  20. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +2007 -161
  21. package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +2 -2
  22. package/dist-types/commands/DescribeAutomationJobCommand.d.ts +104 -0
  23. package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +3 -0
  24. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +2007 -161
  25. package/dist-types/commands/DescribeDataSourceCommand.d.ts +4 -4
  26. package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -2
  27. package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
  28. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +2007 -161
  29. package/dist-types/commands/ListCustomPermissionsCommand.d.ts +3 -0
  30. package/dist-types/commands/ListDataSourcesCommand.d.ts +4 -4
  31. package/dist-types/commands/ListTopicReviewedAnswersCommand.d.ts +2 -1
  32. package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +2 -2
  33. package/dist-types/commands/StartAutomationJobCommand.d.ts +101 -0
  34. package/dist-types/commands/UpdateAnalysisCommand.d.ts +2007 -161
  35. package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +3 -0
  36. package/dist-types/commands/UpdateDashboardCommand.d.ts +2007 -161
  37. package/dist-types/commands/UpdateDataSourceCommand.d.ts +9 -4
  38. package/dist-types/commands/UpdateTemplateCommand.d.ts +2007 -161
  39. package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +2 -1
  40. package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +1 -1
  41. package/dist-types/commands/index.d.ts +2 -0
  42. package/dist-types/index.d.ts +1 -0
  43. package/dist-types/models/enums.d.ts +41 -0
  44. package/dist-types/models/models_0.d.ts +16 -16
  45. package/dist-types/models/models_1.d.ts +84 -30
  46. package/dist-types/models/models_2.d.ts +96 -213
  47. package/dist-types/models/models_3.d.ts +334 -230
  48. package/dist-types/models/models_4.d.ts +282 -250
  49. package/dist-types/models/models_5.d.ts +248 -0
  50. package/dist-types/schemas/schemas_0.d.ts +10 -0
  51. package/dist-types/ts3.4/QuickSight.d.ts +34 -0
  52. package/dist-types/ts3.4/QuickSightClient.d.ts +12 -0
  53. package/dist-types/ts3.4/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/DescribeAutomationJobCommand.d.ts +51 -0
  55. package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +4 -2
  56. package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/ListTopicReviewedAnswersCommand.d.ts +2 -4
  58. package/dist-types/ts3.4/commands/StartAutomationJobCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +2 -4
  60. package/dist-types/ts3.4/commands/UpdateVPCConnectionCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  62. package/dist-types/ts3.4/index.d.ts +1 -0
  63. package/dist-types/ts3.4/models/enums.d.ts +23 -0
  64. package/dist-types/ts3.4/models/models_0.d.ts +4 -4
  65. package/dist-types/ts3.4/models/models_1.d.ts +21 -8
  66. package/dist-types/ts3.4/models/models_2.d.ts +22 -137
  67. package/dist-types/ts3.4/models/models_3.d.ts +171 -43
  68. package/dist-types/ts3.4/models/models_4.d.ts +56 -60
  69. package/dist-types/ts3.4/models/models_5.d.ts +62 -0
  70. package/dist-types/ts3.4/schemas/schemas_0.d.ts +10 -0
  71. package/package.json +6 -6
@@ -1,6 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import type { UpdateUserCustomPermissionRequest, UpdateUserCustomPermissionResponse } from "../models/models_4";
3
+ import type { UpdateUserCustomPermissionRequest } from "../models/models_4";
4
+ import type { UpdateUserCustomPermissionResponse } from "../models/models_5";
4
5
  import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
5
6
  /**
6
7
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import type { UpdateVPCConnectionRequest, UpdateVPCConnectionResponse } from "../models/models_4";
3
+ import type { UpdateVPCConnectionRequest, UpdateVPCConnectionResponse } from "../models/models_5";
4
4
  import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
5
5
  /**
6
6
  * @public
@@ -70,6 +70,7 @@ export * from "./DescribeAnalysisDefinitionCommand";
70
70
  export * from "./DescribeAnalysisPermissionsCommand";
71
71
  export * from "./DescribeAssetBundleExportJobCommand";
72
72
  export * from "./DescribeAssetBundleImportJobCommand";
73
+ export * from "./DescribeAutomationJobCommand";
73
74
  export * from "./DescribeBrandAssignmentCommand";
74
75
  export * from "./DescribeBrandCommand";
75
76
  export * from "./DescribeBrandPublishedVersionCommand";
@@ -174,6 +175,7 @@ export * from "./SearchGroupsCommand";
174
175
  export * from "./SearchTopicsCommand";
175
176
  export * from "./StartAssetBundleExportJobCommand";
176
177
  export * from "./StartAssetBundleImportJobCommand";
178
+ export * from "./StartAutomationJobCommand";
177
179
  export * from "./StartDashboardSnapshotJobCommand";
178
180
  export * from "./StartDashboardSnapshotJobScheduleCommand";
179
181
  export * from "./TagResourceCommand";
@@ -22,4 +22,5 @@ export * from "./models/models_1";
22
22
  export * from "./models/models_2";
23
23
  export * from "./models/models_3";
24
24
  export * from "./models/models_4";
25
+ export * from "./models/models_5";
25
26
  export { QuickSightServiceException } from "./models/QuickSightServiceException";
@@ -1195,6 +1195,7 @@ export type TooltipTitleType = (typeof TooltipTitleType)[keyof typeof TooltipTit
1195
1195
  export declare const SelectedTooltipType: {
1196
1196
  readonly BASIC: "BASIC";
1197
1197
  readonly DETAILED: "DETAILED";
1198
+ readonly SHEET: "SHEET";
1198
1199
  };
1199
1200
  /**
1200
1201
  * @public
@@ -1889,6 +1890,30 @@ export declare const TransposedColumnType: {
1889
1890
  * @public
1890
1891
  */
1891
1892
  export type TransposedColumnType = (typeof TransposedColumnType)[keyof typeof TransposedColumnType];
1893
+ /**
1894
+ * @public
1895
+ * @enum
1896
+ */
1897
+ export declare const SparklineVisualType: {
1898
+ readonly AREA_LINE: "AREA_LINE";
1899
+ readonly LINE: "LINE";
1900
+ };
1901
+ /**
1902
+ * @public
1903
+ */
1904
+ export type SparklineVisualType = (typeof SparklineVisualType)[keyof typeof SparklineVisualType];
1905
+ /**
1906
+ * @public
1907
+ * @enum
1908
+ */
1909
+ export declare const SparklineAxisBehavior: {
1910
+ readonly INDEPENDENT: "INDEPENDENT";
1911
+ readonly SHARED: "SHARED";
1912
+ };
1913
+ /**
1914
+ * @public
1915
+ */
1916
+ export type SparklineAxisBehavior = (typeof SparklineAxisBehavior)[keyof typeof SparklineAxisBehavior];
1892
1917
  /**
1893
1918
  * @public
1894
1919
  * @enum
@@ -2215,6 +2240,7 @@ export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeo
2215
2240
  * @enum
2216
2241
  */
2217
2242
  export declare const AuthenticationType: {
2243
+ readonly KEYPAIR: "KEYPAIR";
2218
2244
  readonly PASSWORD: "PASSWORD";
2219
2245
  readonly TOKEN: "TOKEN";
2220
2246
  readonly X509: "X509";
@@ -2328,6 +2354,21 @@ export declare const AuthorSpecifiedAggregation: {
2328
2354
  * @public
2329
2355
  */
2330
2356
  export type AuthorSpecifiedAggregation = (typeof AuthorSpecifiedAggregation)[keyof typeof AuthorSpecifiedAggregation];
2357
+ /**
2358
+ * @public
2359
+ * @enum
2360
+ */
2361
+ export declare const AutomationJobStatus: {
2362
+ readonly FAILED: "FAILED";
2363
+ readonly QUEUED: "QUEUED";
2364
+ readonly RUNNING: "RUNNING";
2365
+ readonly STOPPED: "STOPPED";
2366
+ readonly SUCCEEDED: "SUCCEEDED";
2367
+ };
2368
+ /**
2369
+ * @public
2370
+ */
2371
+ export type AutomationJobStatus = (typeof AutomationJobStatus)[keyof typeof AutomationJobStatus];
2331
2372
  /**
2332
2373
  * @public
2333
2374
  * @enum
@@ -7329,6 +7329,17 @@ export interface FieldBasedTooltip {
7329
7329
  */
7330
7330
  TooltipFields?: TooltipItem[] | undefined;
7331
7331
  }
7332
+ /**
7333
+ * <p>The configuration of the sheet tooltip.</p>
7334
+ * @public
7335
+ */
7336
+ export interface SheetTooltip {
7337
+ /**
7338
+ * <p>The sheet ID of the tooltip sheet that is used by the tooltip.</p>
7339
+ * @public
7340
+ */
7341
+ SheetId?: string | undefined;
7342
+ }
7332
7343
  /**
7333
7344
  * <p>The display options for the visual tooltip.</p>
7334
7345
  * @public
@@ -7359,6 +7370,11 @@ export interface TooltipOptions {
7359
7370
  * @public
7360
7371
  */
7361
7372
  FieldBasedTooltip?: FieldBasedTooltip | undefined;
7373
+ /**
7374
+ * <p>The configuration of the sheet tooltip.</p>
7375
+ * @public
7376
+ */
7377
+ SheetTooltip?: SheetTooltip | undefined;
7362
7378
  }
7363
7379
  /**
7364
7380
  * <p>The type of the data path value.</p>
@@ -7431,19 +7447,3 @@ export interface DataPathColor {
7431
7447
  */
7432
7448
  TimeGranularity?: TimeGranularity | undefined;
7433
7449
  }
7434
- /**
7435
- * <p>The visual display options for the visual palette.</p>
7436
- * @public
7437
- */
7438
- export interface VisualPalette {
7439
- /**
7440
- * <p>The chart color options for the visual palette.</p>
7441
- * @public
7442
- */
7443
- ChartColor?: string | undefined;
7444
- /**
7445
- * <p>The color map options for the visual palette.</p>
7446
- * @public
7447
- */
7448
- ColorMap?: DataPathColor[] | undefined;
7449
- }
@@ -1,5 +1,21 @@
1
- import type { ArcThickness, ArcThicknessOptions, AxisBinding, BarChartOrientation, BarsArrangement, BaseMapStyleType, BoxPlotFillStyle, ColorFillType, ComparisonMethod, ConditionalFormattingIconDisplayOption, ConditionalFormattingIconSetType, CustomContentImageScalingConfiguration, CustomContentType, DashboardCustomizationStatus, DataLabelPosition, ForecastComputationSeasonality, FunnelChartMeasureDataLabelStyle, GeospatialColorState, GeospatialLayerType, GeospatialMapNavigation, GeospatialSelectedPointStyle, HistogramBinType, HorizontalTextAlignment, Icon, KPISparklineType, KPIVisualStandardLayoutType, LayerCustomActionTrigger, LineChartLineStyle, LineChartMarkerShape, LineChartType, LineInterpolation, MapZoomMode, MaximumMinimumComputationType, MissingDataTreatmentOption, PivotTableConditionalFormattingScopeRole, PivotTableFieldCollapseState, PivotTableMetricPlacement, PivotTableRowsLayout, PivotTableSubtotalLevel, PluginVisualAxisName, PrimaryValueDisplayType, RadarChartAxesRangeScale, RadarChartShape, SimpleTotalAggregationFunction, SingleYAxisOption, SortDirection, StyledCellType, TableBorderStyle, TableCellImageScalingConfiguration, TableFieldIconSetType, TableOrientation, TableTotalsPlacement, TableTotalsScrollStatus, TextWrap, TimeGranularity, TopBottomComputationType, TopBottomSortOrder, TransposedColumnType, URLTargetConfiguration, VerticalTextAlignment, Visibility, WidgetStatus } from "./enums";
2
- import type { AxisDisplayOptions, BarChartDefaultSeriesSettings, BarChartFieldWells, BarChartSortConfiguration, BarSeriesItem, BorderSettings, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, CustomActionFilterOperation, CustomActionNavigationOperation, CustomActionSetParametersOperation, CustomActionURLOperation, DataLabelOptions, DataPathValue, DecalSettings, DimensionField, FieldSort, FieldSortOptions, FontConfiguration, FormatConfiguration, ItemsLimitConfiguration, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PercentageDisplayFormatConfiguration, ReferenceLine, SmallMultiplesOptions, TooltipOptions, VisualCustomAction, VisualInteractionOptions, VisualPalette } from "./models_0";
1
+ import type { ArcThickness, ArcThicknessOptions, AxisBinding, BarChartOrientation, BarsArrangement, BaseMapStyleType, BoxPlotFillStyle, ColorFillType, ComparisonMethod, ConditionalFormattingIconDisplayOption, ConditionalFormattingIconSetType, CustomContentImageScalingConfiguration, CustomContentType, DashboardCustomizationStatus, DataLabelPosition, ForecastComputationSeasonality, FunnelChartMeasureDataLabelStyle, GeospatialColorState, GeospatialLayerType, GeospatialMapNavigation, GeospatialSelectedPointStyle, HistogramBinType, HorizontalTextAlignment, Icon, KPISparklineType, KPIVisualStandardLayoutType, LayerCustomActionTrigger, LineChartLineStyle, LineChartMarkerShape, LineChartType, LineInterpolation, MapZoomMode, MaximumMinimumComputationType, MissingDataTreatmentOption, PivotTableConditionalFormattingScopeRole, PivotTableFieldCollapseState, PivotTableMetricPlacement, PivotTableRowsLayout, PivotTableSubtotalLevel, PluginVisualAxisName, PrimaryValueDisplayType, RadarChartAxesRangeScale, RadarChartShape, SimpleTotalAggregationFunction, SingleYAxisOption, SortDirection, SparklineAxisBehavior, SparklineVisualType, StyledCellType, TableBorderStyle, TableCellImageScalingConfiguration, TableFieldIconSetType, TableOrientation, TableTotalsPlacement, TableTotalsScrollStatus, TextWrap, TimeGranularity, TopBottomComputationType, TopBottomSortOrder, TransposedColumnType, URLTargetConfiguration, VerticalTextAlignment, Visibility, WidgetStatus } from "./enums";
2
+ import type { AxisDisplayOptions, BarChartDefaultSeriesSettings, BarChartFieldWells, BarChartSortConfiguration, BarSeriesItem, BorderSettings, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, CustomActionFilterOperation, CustomActionNavigationOperation, CustomActionSetParametersOperation, CustomActionURLOperation, DataLabelOptions, DataPathColor, DataPathValue, DecalSettings, DimensionField, FieldSort, FieldSortOptions, FontConfiguration, FormatConfiguration, ItemsLimitConfiguration, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PercentageDisplayFormatConfiguration, ReferenceLine, SmallMultiplesOptions, TooltipOptions, VisualCustomAction, VisualInteractionOptions } from "./models_0";
3
+ /**
4
+ * <p>The visual display options for the visual palette.</p>
5
+ * @public
6
+ */
7
+ export interface VisualPalette {
8
+ /**
9
+ * <p>The chart color options for the visual palette.</p>
10
+ * @public
11
+ */
12
+ ChartColor?: string | undefined;
13
+ /**
14
+ * <p>The color map options for the visual palette.</p>
15
+ * @public
16
+ */
17
+ ColorMap?: DataPathColor[] | undefined;
18
+ }
3
19
  /**
4
20
  * <p>The configuration of a <code>BarChartVisual</code>.</p>
5
21
  * @public
@@ -5585,6 +5601,11 @@ export interface PivotTableConfiguration {
5585
5601
  * @public
5586
5602
  */
5587
5603
  PaginatedReportOptions?: PivotTablePaginatedReportOptions | undefined;
5604
+ /**
5605
+ * <p>The display options for the visual tooltip.</p>
5606
+ * @public
5607
+ */
5608
+ Tooltip?: TooltipOptions | undefined;
5588
5609
  /**
5589
5610
  * <p>The options that define customizations available to dashboard readers for a specific visual</p>
5590
5611
  * @public
@@ -6688,6 +6709,57 @@ export interface DataBarsOptions {
6688
6709
  */
6689
6710
  NegativeColor?: string | undefined;
6690
6711
  }
6712
+ /**
6713
+ * <p>The options for sparklines in a table.</p>
6714
+ * @public
6715
+ */
6716
+ export interface SparklinesOptions {
6717
+ /**
6718
+ * <p>The field ID of the value column that the sparkline is applied to.</p>
6719
+ * @public
6720
+ */
6721
+ FieldId: string | undefined;
6722
+ /**
6723
+ * <p>The dimension type field.</p>
6724
+ * @public
6725
+ */
6726
+ XAxisField: DimensionField | undefined;
6727
+ /**
6728
+ * <p>Determines whether the Y axis is shared across all sparklines or independent for each sparkline.</p>
6729
+ * @public
6730
+ */
6731
+ YAxisBehavior?: SparklineAxisBehavior | undefined;
6732
+ /**
6733
+ * <p>The type of the sparkline. Valid values are <code>LINE</code> and <code>AREA_LINE</code>.</p>
6734
+ * @public
6735
+ */
6736
+ VisualType?: SparklineVisualType | undefined;
6737
+ /**
6738
+ * <p>The color of the sparkline line.</p>
6739
+ * @public
6740
+ */
6741
+ LineColor?: string | undefined;
6742
+ /**
6743
+ * <p>The interpolation style for the sparkline line.</p>
6744
+ * @public
6745
+ */
6746
+ LineInterpolation?: LineInterpolation | undefined;
6747
+ /**
6748
+ * <p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>
6749
+ * @public
6750
+ */
6751
+ AllPointsMarker?: LineChartMarkerStyleSettings | undefined;
6752
+ /**
6753
+ * <p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>
6754
+ * @public
6755
+ */
6756
+ MaxValueMarker?: LineChartMarkerStyleSettings | undefined;
6757
+ /**
6758
+ * <p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>
6759
+ * @public
6760
+ */
6761
+ MinValueMarker?: LineChartMarkerStyleSettings | undefined;
6762
+ }
6691
6763
  /**
6692
6764
  * <p>The inline visualization of a specific type to display within a chart.</p>
6693
6765
  * @public
@@ -6698,6 +6770,11 @@ export interface TableInlineVisualization {
6698
6770
  * @public
6699
6771
  */
6700
6772
  DataBars?: DataBarsOptions | undefined;
6773
+ /**
6774
+ * <p>The configuration of the inline visualization of the sparklines within a chart.</p>
6775
+ * @public
6776
+ */
6777
+ Sparklines?: SparklinesOptions | undefined;
6701
6778
  }
6702
6779
  /**
6703
6780
  * <p>The table options for a table visual.</p>
@@ -6801,6 +6878,11 @@ export interface TableConfiguration {
6801
6878
  * @public
6802
6879
  */
6803
6880
  TableInlineVisualizations?: TableInlineVisualization[] | undefined;
6881
+ /**
6882
+ * <p>The display options for the visual tooltip.</p>
6883
+ * @public
6884
+ */
6885
+ Tooltip?: TooltipOptions | undefined;
6804
6886
  /**
6805
6887
  * <p>The options that define customizations available to dashboard readers for a specific visual</p>
6806
6888
  * @public
@@ -7259,31 +7341,3 @@ export interface WaterfallVisual {
7259
7341
  */
7260
7342
  VisualContentAltText?: string | undefined;
7261
7343
  }
7262
- /**
7263
- * <p>The aggregated field wells of a word cloud.</p>
7264
- * @public
7265
- */
7266
- export interface WordCloudAggregatedFieldWells {
7267
- /**
7268
- * <p>The group by field well of a word cloud. Values are grouped by group by fields.</p>
7269
- * @public
7270
- */
7271
- GroupBy?: DimensionField[] | undefined;
7272
- /**
7273
- * <p>The size field well of a word cloud. Values are aggregated based on group by fields.</p>
7274
- * @public
7275
- */
7276
- Size?: MeasureField[] | undefined;
7277
- }
7278
- /**
7279
- * <p>The field wells of a word cloud visual.</p>
7280
- * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
7281
- * @public
7282
- */
7283
- export interface WordCloudFieldWells {
7284
- /**
7285
- * <p>The aggregated field wells of a word cloud.</p>
7286
- * @public
7287
- */
7288
- WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells | undefined;
7289
- }
@@ -1,6 +1,34 @@
1
- import type { ActionConnectorType, AggType, AnalysisFilterAttribute, AnchorType, AnonymousUserDashboardEmbeddingConfigurationDisabledFeature, AnonymousUserDashboardEmbeddingConfigurationEnabledFeature, AssetBundleExportFormat, AssetBundleExportJobAnalysisPropertyToOverride, AssetBundleExportJobDashboardPropertyToOverride, AssetBundleExportJobDataSetPropertyToOverride, AssetBundleExportJobDataSourcePropertyToOverride, AssetBundleExportJobFolderPropertyToOverride, AssetBundleExportJobRefreshSchedulePropertyToOverride, AssetBundleExportJobStatus, AssetBundleExportJobThemePropertyToOverride, AssetBundleExportJobVPCConnectionPropertyToOverride, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AuthenticationMethodOption, AuthenticationType, AuthorizationCodeGrantCredentialsSource, BrandStatus, BrandVersionStatus, CapabilityState, ClientCredentialsSource, ColumnDataSubType, ColumnDataType, ColumnOrderingType, ColumnTagName, ComparisonMethodType, ConnectionAuthType, ConstantType, ContributionAnalysisDirection, ContributionAnalysisSortType, DashboardBehavior, DashboardUIState, DataSetDateComparisonFilterOperator, DataSetNumericComparisonFilterOperator, DatasetParameterValueType, DataSetStringComparisonFilterOperator, DataSetStringListFilterOperator, DisplayFormat, Edition, FilterClass, FilterOperator, GeoSpatialCountryCode, GeoSpatialDataRole, InputColumnDataType, JoinOperationType, JoinType, LookbackWindowSizeUnit, NullFilterOption, NumberScale, RefreshFailureAlertStatus, ResourceStatus, ReviewedAnswerErrorCode, ServiceType, SheetContentType, SnapshotFileFormatType, SnapshotFileSheetSelectionScope, StarburstProductType, TimeGranularity, TopicIRFilterFunction, TopicIRFilterType, TopicNumericSeparatorSymbol, TopicSortDirection, TopicTimeGranularity, UndefinedSpecifiedValueType, ValidationStrategyMode, WebCrawlerAuthType, WordCloudCloudLayout, WordCloudWordCasing, WordCloudWordOrientation, WordCloudWordPadding, WordCloudWordScaling } from "./enums";
2
- import type { AccountCustomization, AdHocFilteringOption, AggFunction, AggregateOperation, AggregationPartitionBy, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DataPrepAggregationFunction, DataSetColumnIdMapping, DataSetIdentifierDeclaration, FieldSortOptions, FilterControl, FilterGroup, ItemsLimitConfiguration, Layout, ParameterControl, ParameterDeclaration, QueryExecutionOptions, SheetControlLayout, SheetImage, SheetTextBox, TransformOperationSource, VisualCustomAction, VisualCustomActionDefaults, VisualInteractionOptions, VisualMenuOption } from "./models_0";
3
- import type { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LayerMapVisual, LineChartVisual, PieChartVisual, PivotTableVisual, PluginVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallVisual, WordCloudFieldWells } from "./models_1";
1
+ import type { ActionConnectorType, AggType, AnalysisFilterAttribute, AnchorType, AnonymousUserDashboardEmbeddingConfigurationDisabledFeature, AnonymousUserDashboardEmbeddingConfigurationEnabledFeature, AssetBundleExportFormat, AssetBundleExportJobAnalysisPropertyToOverride, AssetBundleExportJobDashboardPropertyToOverride, AssetBundleExportJobDataSetPropertyToOverride, AssetBundleExportJobDataSourcePropertyToOverride, AssetBundleExportJobFolderPropertyToOverride, AssetBundleExportJobRefreshSchedulePropertyToOverride, AssetBundleExportJobStatus, AssetBundleExportJobThemePropertyToOverride, AssetBundleExportJobVPCConnectionPropertyToOverride, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AuthenticationMethodOption, AuthenticationType, AuthorizationCodeGrantCredentialsSource, BrandStatus, BrandVersionStatus, CapabilityState, ClientCredentialsSource, ColumnDataSubType, ColumnDataType, ColumnOrderingType, ColumnTagName, ComparisonMethodType, ConnectionAuthType, ConstantType, ContributionAnalysisDirection, ContributionAnalysisSortType, DashboardBehavior, DashboardUIState, DataSetDateComparisonFilterOperator, DataSetNumericComparisonFilterOperator, DatasetParameterValueType, DataSetStringComparisonFilterOperator, DataSetStringListFilterOperator, DisplayFormat, Edition, FilterClass, FilterOperator, GeoSpatialCountryCode, GeoSpatialDataRole, InputColumnDataType, JoinOperationType, LookbackWindowSizeUnit, NullFilterOption, NumberScale, RefreshFailureAlertStatus, ResourceStatus, ReviewedAnswerErrorCode, ServiceType, SheetContentType, SnapshotFileFormatType, SnapshotFileSheetSelectionScope, StarburstProductType, TimeGranularity, TopicIRFilterFunction, TopicIRFilterType, TopicNumericSeparatorSymbol, TopicSortDirection, TopicTimeGranularity, UndefinedSpecifiedValueType, ValidationStrategyMode, WebCrawlerAuthType, WordCloudCloudLayout, WordCloudWordCasing, WordCloudWordOrientation, WordCloudWordPadding, WordCloudWordScaling } from "./enums";
2
+ import type { AccountCustomization, AdHocFilteringOption, AggFunction, AggregateOperation, AggregationPartitionBy, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DataPrepAggregationFunction, DataSetColumnIdMapping, DataSetIdentifierDeclaration, DimensionField, FieldSortOptions, FilterControl, FilterGroup, ItemsLimitConfiguration, Layout, MeasureField, ParameterControl, ParameterDeclaration, QueryExecutionOptions, SheetControlLayout, SheetImage, SheetTextBox, TransformOperationSource, VisualCustomAction, VisualCustomActionDefaults, VisualInteractionOptions, VisualMenuOption } from "./models_0";
3
+ import type { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LayerMapVisual, LineChartVisual, PieChartVisual, PivotTableVisual, PluginVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallVisual } from "./models_1";
4
+ /**
5
+ * <p>The aggregated field wells of a word cloud.</p>
6
+ * @public
7
+ */
8
+ export interface WordCloudAggregatedFieldWells {
9
+ /**
10
+ * <p>The group by field well of a word cloud. Values are grouped by group by fields.</p>
11
+ * @public
12
+ */
13
+ GroupBy?: DimensionField[] | undefined;
14
+ /**
15
+ * <p>The size field well of a word cloud. Values are aggregated based on group by fields.</p>
16
+ * @public
17
+ */
18
+ Size?: MeasureField[] | undefined;
19
+ }
20
+ /**
21
+ * <p>The field wells of a word cloud visual.</p>
22
+ * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
23
+ * @public
24
+ */
25
+ export interface WordCloudFieldWells {
26
+ /**
27
+ * <p>The aggregated field wells of a word cloud.</p>
28
+ * @public
29
+ */
30
+ WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells | undefined;
31
+ }
4
32
  /**
5
33
  * <p>The sort configuration of a word cloud visual.</p>
6
34
  * @public
@@ -462,6 +490,45 @@ export interface StaticFile {
462
490
  */
463
491
  SpatialStaticFile?: SpatialStaticFile | undefined;
464
492
  }
493
+ /**
494
+ * <p>A tooltip sheet is an object that contains a set of visuals that
495
+ * are used as a tooltip. Every analysis and dashboard must contain at least one non-tooltip sheet.</p>
496
+ * @public
497
+ */
498
+ export interface TooltipSheetDefinition {
499
+ /**
500
+ * <p>The unique identifier of a tooltip sheet.</p>
501
+ * @public
502
+ */
503
+ SheetId: string | undefined;
504
+ /**
505
+ * <p>The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick
506
+ * console.</p>
507
+ * @public
508
+ */
509
+ Name?: string | undefined;
510
+ /**
511
+ * <p>A list of the visuals that are on a tooltip sheet.</p>
512
+ * @public
513
+ */
514
+ Visuals?: Visual[] | undefined;
515
+ /**
516
+ * <p>The text boxes that are on a tooltip sheet.</p>
517
+ * @public
518
+ */
519
+ TextBoxes?: SheetTextBox[] | undefined;
520
+ /**
521
+ * <p>A list of images on a tooltip sheet.</p>
522
+ * @public
523
+ */
524
+ Images?: SheetImage[] | undefined;
525
+ /**
526
+ * <p>Layouts define how the components of a tooltip sheet are arranged.</p>
527
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html">Types of layout</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
528
+ * @public
529
+ */
530
+ Layouts?: Layout[] | undefined;
531
+ }
465
532
  /**
466
533
  * <p>The definition of an analysis.</p>
467
534
  * @public
@@ -479,6 +546,12 @@ export interface AnalysisDefinition {
479
546
  * @public
480
547
  */
481
548
  Sheets?: SheetDefinition[] | undefined;
549
+ /**
550
+ * <p>An array of tooltip sheet definitions for an analysis. Each <code>TooltipSheetDefinition</code> provides detailed information about
551
+ * a tooltip sheet within this analysis.</p>
552
+ * @public
553
+ */
554
+ TooltipSheets?: TooltipSheetDefinition[] | undefined;
482
555
  /**
483
556
  * <p>An array of calculated field definitions for the analysis.</p>
484
557
  * @public
@@ -6944,6 +7017,16 @@ export interface Capabilities {
6944
7017
  * @public
6945
7018
  */
6946
7019
  Space?: CapabilityState | undefined;
7020
+ /**
7021
+ * <p>The ability to create spaces.</p>
7022
+ * @public
7023
+ */
7024
+ CreateSpaces?: CapabilityState | undefined;
7025
+ /**
7026
+ * <p>The ability to share spaces with other users and groups.</p>
7027
+ * @public
7028
+ */
7029
+ ShareSpaces?: CapabilityState | undefined;
6947
7030
  /**
6948
7031
  * <p>The ability to perform chat-related actions.</p>
6949
7032
  * @public
@@ -6954,6 +7037,11 @@ export interface Capabilities {
6954
7037
  * @public
6955
7038
  */
6956
7039
  CreateChatAgents?: CapabilityState | undefined;
7040
+ /**
7041
+ * <p>The ability to share chat agents with other users and groups.</p>
7042
+ * @public
7043
+ */
7044
+ ShareChatAgents?: CapabilityState | undefined;
6957
7045
  /**
6958
7046
  * <p>The ability to perform research-related actions.</p>
6959
7047
  * @public
@@ -8169,6 +8257,11 @@ export interface DashboardVersionDefinition {
8169
8257
  * @public
8170
8258
  */
8171
8259
  Sheets?: SheetDefinition[] | undefined;
8260
+ /**
8261
+ * <p>An array of tooltip sheet definitions for a dashboard.</p>
8262
+ * @public
8263
+ */
8264
+ TooltipSheets?: TooltipSheetDefinition[] | undefined;
8172
8265
  /**
8173
8266
  * <p>An array of calculated field definitions for the dashboard.</p>
8174
8267
  * @public
@@ -9464,213 +9557,3 @@ export interface UntagColumnOperation {
9464
9557
  */
9465
9558
  TagNames: ColumnTagName[] | undefined;
9466
9559
  }
9467
- /**
9468
- * <p>A data transformation on a logical table. This is a variant type structure. For this
9469
- * structure to be valid, only one of the attributes can be non-null.</p>
9470
- * @public
9471
- */
9472
- export type TransformOperation = TransformOperation.CastColumnTypeOperationMember | TransformOperation.CreateColumnsOperationMember | TransformOperation.FilterOperationMember | TransformOperation.OverrideDatasetParameterOperationMember | TransformOperation.ProjectOperationMember | TransformOperation.RenameColumnOperationMember | TransformOperation.TagColumnOperationMember | TransformOperation.UntagColumnOperationMember | TransformOperation.$UnknownMember;
9473
- /**
9474
- * @public
9475
- */
9476
- export declare namespace TransformOperation {
9477
- /**
9478
- * <p>An operation that projects columns. Operations that come after a projection can only
9479
- * refer to projected columns.</p>
9480
- * @public
9481
- */
9482
- interface ProjectOperationMember {
9483
- ProjectOperation: ProjectOperation;
9484
- FilterOperation?: never;
9485
- CreateColumnsOperation?: never;
9486
- RenameColumnOperation?: never;
9487
- CastColumnTypeOperation?: never;
9488
- TagColumnOperation?: never;
9489
- UntagColumnOperation?: never;
9490
- OverrideDatasetParameterOperation?: never;
9491
- $unknown?: never;
9492
- }
9493
- /**
9494
- * <p>An operation that filters rows based on some condition.</p>
9495
- * @public
9496
- */
9497
- interface FilterOperationMember {
9498
- ProjectOperation?: never;
9499
- FilterOperation: FilterOperation;
9500
- CreateColumnsOperation?: never;
9501
- RenameColumnOperation?: never;
9502
- CastColumnTypeOperation?: never;
9503
- TagColumnOperation?: never;
9504
- UntagColumnOperation?: never;
9505
- OverrideDatasetParameterOperation?: never;
9506
- $unknown?: never;
9507
- }
9508
- /**
9509
- * <p>An operation that creates calculated columns. Columns created in one such operation
9510
- * form a lexical closure.</p>
9511
- * @public
9512
- */
9513
- interface CreateColumnsOperationMember {
9514
- ProjectOperation?: never;
9515
- FilterOperation?: never;
9516
- CreateColumnsOperation: CreateColumnsOperation;
9517
- RenameColumnOperation?: never;
9518
- CastColumnTypeOperation?: never;
9519
- TagColumnOperation?: never;
9520
- UntagColumnOperation?: never;
9521
- OverrideDatasetParameterOperation?: never;
9522
- $unknown?: never;
9523
- }
9524
- /**
9525
- * <p>An operation that renames a column.</p>
9526
- * @public
9527
- */
9528
- interface RenameColumnOperationMember {
9529
- ProjectOperation?: never;
9530
- FilterOperation?: never;
9531
- CreateColumnsOperation?: never;
9532
- RenameColumnOperation: RenameColumnOperation;
9533
- CastColumnTypeOperation?: never;
9534
- TagColumnOperation?: never;
9535
- UntagColumnOperation?: never;
9536
- OverrideDatasetParameterOperation?: never;
9537
- $unknown?: never;
9538
- }
9539
- /**
9540
- * <p>A transform operation that casts a column to a different type.</p>
9541
- * @public
9542
- */
9543
- interface CastColumnTypeOperationMember {
9544
- ProjectOperation?: never;
9545
- FilterOperation?: never;
9546
- CreateColumnsOperation?: never;
9547
- RenameColumnOperation?: never;
9548
- CastColumnTypeOperation: CastColumnTypeOperation;
9549
- TagColumnOperation?: never;
9550
- UntagColumnOperation?: never;
9551
- OverrideDatasetParameterOperation?: never;
9552
- $unknown?: never;
9553
- }
9554
- /**
9555
- * <p>An operation that tags a column with additional information.</p>
9556
- * @public
9557
- */
9558
- interface TagColumnOperationMember {
9559
- ProjectOperation?: never;
9560
- FilterOperation?: never;
9561
- CreateColumnsOperation?: never;
9562
- RenameColumnOperation?: never;
9563
- CastColumnTypeOperation?: never;
9564
- TagColumnOperation: TagColumnOperation;
9565
- UntagColumnOperation?: never;
9566
- OverrideDatasetParameterOperation?: never;
9567
- $unknown?: never;
9568
- }
9569
- /**
9570
- * <p>A transform operation that removes tags associated with a column.</p>
9571
- * @public
9572
- */
9573
- interface UntagColumnOperationMember {
9574
- ProjectOperation?: never;
9575
- FilterOperation?: never;
9576
- CreateColumnsOperation?: never;
9577
- RenameColumnOperation?: never;
9578
- CastColumnTypeOperation?: never;
9579
- TagColumnOperation?: never;
9580
- UntagColumnOperation: UntagColumnOperation;
9581
- OverrideDatasetParameterOperation?: never;
9582
- $unknown?: never;
9583
- }
9584
- /**
9585
- * <p>A transform operation that overrides the dataset parameter values that are defined in another dataset.</p>
9586
- * @public
9587
- */
9588
- interface OverrideDatasetParameterOperationMember {
9589
- ProjectOperation?: never;
9590
- FilterOperation?: never;
9591
- CreateColumnsOperation?: never;
9592
- RenameColumnOperation?: never;
9593
- CastColumnTypeOperation?: never;
9594
- TagColumnOperation?: never;
9595
- UntagColumnOperation?: never;
9596
- OverrideDatasetParameterOperation: OverrideDatasetParameterOperation;
9597
- $unknown?: never;
9598
- }
9599
- /**
9600
- * @public
9601
- */
9602
- interface $UnknownMember {
9603
- ProjectOperation?: never;
9604
- FilterOperation?: never;
9605
- CreateColumnsOperation?: never;
9606
- RenameColumnOperation?: never;
9607
- CastColumnTypeOperation?: never;
9608
- TagColumnOperation?: never;
9609
- UntagColumnOperation?: never;
9610
- OverrideDatasetParameterOperation?: never;
9611
- $unknown: [string, any];
9612
- }
9613
- /**
9614
- * @deprecated unused in schema-serde mode.
9615
- *
9616
- */
9617
- interface Visitor<T> {
9618
- ProjectOperation: (value: ProjectOperation) => T;
9619
- FilterOperation: (value: FilterOperation) => T;
9620
- CreateColumnsOperation: (value: CreateColumnsOperation) => T;
9621
- RenameColumnOperation: (value: RenameColumnOperation) => T;
9622
- CastColumnTypeOperation: (value: CastColumnTypeOperation) => T;
9623
- TagColumnOperation: (value: TagColumnOperation) => T;
9624
- UntagColumnOperation: (value: UntagColumnOperation) => T;
9625
- OverrideDatasetParameterOperation: (value: OverrideDatasetParameterOperation) => T;
9626
- _: (name: string, value: any) => T;
9627
- }
9628
- }
9629
- /**
9630
- * <p>Properties associated with the columns participating in a join.</p>
9631
- * @public
9632
- */
9633
- export interface JoinKeyProperties {
9634
- /**
9635
- * <p>A value that indicates that a row in a table is uniquely identified by the columns in
9636
- * a join key. This is used by Quick Sight to optimize query performance.</p>
9637
- * @public
9638
- */
9639
- UniqueKey?: boolean | undefined;
9640
- }
9641
- /**
9642
- * <p>The instructions associated with a join. </p>
9643
- * @public
9644
- */
9645
- export interface JoinInstruction {
9646
- /**
9647
- * <p>The operand on the left side of a join.</p>
9648
- * @public
9649
- */
9650
- LeftOperand: string | undefined;
9651
- /**
9652
- * <p>The operand on the right side of a join.</p>
9653
- * @public
9654
- */
9655
- RightOperand: string | undefined;
9656
- /**
9657
- * <p>Join key properties of the left operand.</p>
9658
- * @public
9659
- */
9660
- LeftJoinKeyProperties?: JoinKeyProperties | undefined;
9661
- /**
9662
- * <p>Join key properties of the right operand.</p>
9663
- * @public
9664
- */
9665
- RightJoinKeyProperties?: JoinKeyProperties | undefined;
9666
- /**
9667
- * <p>The type of join that it is.</p>
9668
- * @public
9669
- */
9670
- Type: JoinType | undefined;
9671
- /**
9672
- * <p>The join instructions provided in the <code>ON</code> clause of a join.</p>
9673
- * @public
9674
- */
9675
- OnClause: string | undefined;
9676
- }