@aws-sdk/client-quicksight 3.1048.0 → 3.1050.0

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import type { ActionConnectorErrorType, ActionConnectorSearchFilterNameEnum, ActionConnectorType, AggType, AnalysisErrorType, AnchorOption, AuthorizationCodeGrantCredentialsSource, AxisBinding, CategoricalAggregationFunction, CategoryFilterMatchOperator, CategoryFilterSelectAllOptions, ClientCredentialsSource, ColumnRole, CommitMode, ConnectionAuthType, ControlSortDirection, CrossDatasetTypes, DashboardBehavior, DataLabelContent, DataLabelOverlap, DataLabelPosition, DataPrepSimpleAggregationFunctionType, DateAggregationFunction, DayOfTheWeek, DecalPatternType, DecalStyleType, DigitGroupingStyle, Edition, FilterNullOption, FilterOperator, FilterVisualScope, FontDecoration, FontStyle, FontWeightName, HorizontalTextAlignment, ImageCustomActionTrigger, LayoutElementType, LegendPosition, NegativeValueDisplayMode, NumberScale, NumericEqualityMatchOperator, NumericFilterSelectAllOptions, NumericSeparatorSymbol, OtherCategories, PanelBorderStyle, PaperOrientation, PaperSize, ParameterValueType, QBusinessInsightsStatus, QueryExecutionMode, ReferenceLineLabelHorizontalPosition, ReferenceLineLabelVerticalPosition, ReferenceLinePatternType, ReferenceLineSeriesType, ReferenceLineValueLabelRelativePosition, RelativeDateType, RelativeFontSize, ResizeOption, ResourceStatus, SectionPageBreakStatus, SelectAllValueOptions, SelectedFieldOptions, SelectedTooltipType, SheetContentType, SheetControlDateTimePickerType, SheetControlListType, SheetControlSliderType, SheetImageScalingType, SheetLayoutGroupMemberType, SimpleAttributeAggregationFunction, SimpleNumericalAggregationFunction, SmallMultiplesAxisPlacement, SmallMultiplesAxisScale, SortDirection, SpecialValue, TargetVisualOptions, TimeGranularity, TooltipTarget, TooltipTitleType, TopicTimeGranularity, URLTargetConfiguration, ValueWhenUnsetOption, Visibility, VisualCustomActionTrigger, VisualHighlightTrigger, WidgetStatus } from "./enums";
+import type { ActionConnectorErrorType, ActionConnectorSearchFilterNameEnum, ActionConnectorType, AggType, AnalysisErrorType, AnchorOption, AuthorizationCodeGrantCredentialsSource, AxisBinding, CategoricalAggregationFunction, CategoryFilterMatchOperator, CategoryFilterSelectAllOptions, ClientCredentialsSource, ColumnRole, CommitMode, ConnectionAuthType, ControlSortDirection, CrossDatasetTypes, DashboardBehavior, DataLabelContent, DataLabelOverlap, DataLabelPosition, DataPrepSimpleAggregationFunctionType, DateAggregationFunction, DayOfTheWeek, DecalPatternType, DecalStyleType, DigitGroupingStyle, Edition, FilterNullOption, FilterOperator, FilterVisualScope, FontDecoration, FontStyle, FontWeightName, HorizontalTextAlignment, ImageCustomActionTrigger, LayoutElementType, LegendPosition, NegativeValueDisplayMode, NumberScale, NumericEqualityMatchOperator, NumericFilterSelectAllOptions, NumericSeparatorSymbol, OtherCategories, PanelBorderStyle, PaperOrientation, PaperSize, ParameterValueType, QBusinessInsightsStatus, QueryExecutionMode, ReferenceLineLabelHorizontalPosition, ReferenceLineLabelVerticalPosition, ReferenceLinePatternType, ReferenceLineSeriesType, ReferenceLineValueLabelRelativePosition, RelativeDateType, RelativeFontSize, ResizeOption, ResourceStatus, SectionPageBreakStatus, SelectAllValueOptions, SelectedFieldOptions, SheetContentType, SheetControlDateTimePickerType, SheetControlListType, SheetControlSliderType, SheetImageScalingType, SheetLayoutGroupMemberType, SimpleAttributeAggregationFunction, SimpleNumericalAggregationFunction, SmallMultiplesAxisPlacement, SmallMultiplesAxisScale, SortDirection, SpecialValue, TargetVisualOptions, TimeGranularity, TooltipTarget, TooltipTitleType, TopicTimeGranularity, URLTargetConfiguration, ValueWhenUnsetOption, Visibility, VisualCustomActionTrigger, VisualHighlightTrigger, WidgetStatus } from "./enums";
 /**
  * <p>The Quick Sight customizations associated with your Amazon Web Services account or a Quick Sight namespace in a specific Amazon Web Services Region.</p>
  * @public
@@ -614,6 +614,17 @@ export interface ActiveIAMPolicyAssignment {
      */
     PolicyArn?: string | undefined;
 }
+/**
+ * <p>Additional notes that provide supplementary context for a column.</p>
+ * @public
+ */
+export interface AdditionalNotes {
+    /**
+     * <p>The additional notes text.</p>
+     * @public
+     */
+    Text?: string | undefined;
+}
 /**
  * <p>An ad hoc (one-time) filtering option.</p>
  * @public
@@ -7497,39 +7508,3 @@ export interface SheetTooltip {
      */
     SheetId?: string | undefined;
 }
-/**
- * <p>The display options for the visual tooltip.</p>
- * @public
- */
-export interface TooltipOptions {
-    /**
-     * <p>Determines whether or not the tooltip is visible.</p>
-     * @public
-     */
-    TooltipVisibility?: Visibility | undefined;
-    /**
-     * <p>The selected type for the tooltip. Choose one of the following options:</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>BASIC</code>: A basic tooltip.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>DETAILED</code>: A detailed tooltip.</p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    SelectedTooltipType?: SelectedTooltipType | undefined;
-    /**
-     * <p>The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.</p>
-     * @public
-     */
-    FieldBasedTooltip?: FieldBasedTooltip | undefined;
-    /**
-     * <p>The configuration of the sheet tooltip.</p>
-     * @public
-     */
-    SheetTooltip?: SheetTooltip | undefined;
-}

package/dist-types/models/models_1.d.ts

@@ -1,5 +1,41 @@
-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, PivotTableDataPathType, 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";
-import type { AxisDisplayOptions, BarChartDefaultSeriesSettings, BarChartFieldWells, BarChartSortConfiguration, BarSeriesItem, BorderSettings, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, CustomActionFilterOperation, CustomActionNavigationOperation, CustomActionSetParametersOperation, CustomActionURLOperation, DataLabelOptions, DecalSettings, DimensionField, FieldSort, FieldSortOptions, FontConfiguration, FormatConfiguration, ItemsLimitConfiguration, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PercentageDisplayFormatConfiguration, ReferenceLine, SmallMultiplesOptions, TooltipOptions, VisualCustomAction, VisualInteractionOptions } from "./models_0";
+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, PivotTableDataPathType, PivotTableFieldCollapseState, PivotTableMetricPlacement, PivotTableRowsLayout, PivotTableSubtotalLevel, PluginVisualAxisName, PrimaryValueDisplayType, RadarChartAxesRangeScale, RadarChartShape, SelectedTooltipType, SimpleTotalAggregationFunction, SingleYAxisOption, SortDirection, SparklineAxisBehavior, SparklineVisualType, StyledCellType, TableBorderStyle, TableCellImageScalingConfiguration, TableFieldIconSetType, TableOrientation, TableTotalsPlacement, TableTotalsScrollStatus, TextWrap, TimeGranularity, TopBottomComputationType, TopBottomSortOrder, TransposedColumnType, URLTargetConfiguration, VerticalTextAlignment, Visibility, WidgetStatus } from "./enums";
+import type { AxisDisplayOptions, BarChartDefaultSeriesSettings, BarChartFieldWells, BarChartSortConfiguration, BarSeriesItem, BorderSettings, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, CustomActionFilterOperation, CustomActionNavigationOperation, CustomActionSetParametersOperation, CustomActionURLOperation, DataLabelOptions, DecalSettings, DimensionField, FieldBasedTooltip, FieldSort, FieldSortOptions, FontConfiguration, FormatConfiguration, ItemsLimitConfiguration, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PercentageDisplayFormatConfiguration, ReferenceLine, SheetTooltip, SmallMultiplesOptions, VisualCustomAction, VisualInteractionOptions } from "./models_0";
+/**
+ * <p>The display options for the visual tooltip.</p>
+ * @public
+ */
+export interface TooltipOptions {
+    /**
+     * <p>Determines whether or not the tooltip is visible.</p>
+     * @public
+     */
+    TooltipVisibility?: Visibility | undefined;
+    /**
+     * <p>The selected type for the tooltip. Choose one of the following options:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>BASIC</code>: A basic tooltip.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>DETAILED</code>: A detailed tooltip.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    SelectedTooltipType?: SelectedTooltipType | undefined;
+    /**
+     * <p>The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.</p>
+     * @public
+     */
+    FieldBasedTooltip?: FieldBasedTooltip | undefined;
+    /**
+     * <p>The configuration of the sheet tooltip.</p>
+     * @public
+     */
+    SheetTooltip?: SheetTooltip | undefined;
+}
 /**
  * <p>The type of the data path value.</p>
  * @public
@@ -7277,19 +7313,3 @@ export interface WaterfallChartFieldWells {
      */
     WaterfallChartAggregatedFieldWells?: WaterfallChartAggregatedFieldWells | undefined;
 }
-/**
- * <p>The sort configuration of a waterfall visual.</p>
- * @public
- */
-export interface WaterfallChartSortConfiguration {
-    /**
-     * <p>The sort configuration of the category fields.</p>
-     * @public
-     */
-    CategorySort?: FieldSortOptions[] | undefined;
-    /**
-     * <p>The limit on the number of bar groups that are displayed.</p>
-     * @public
-     */
-    BreakdownItemsLimit?: ItemsLimitConfiguration | undefined;
-}

package/dist-types/models/models_2.d.ts

@@ -1,6 +1,22 @@
 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, ComparisonMethodType, ConnectionAuthType, ConstantType, ContributionAnalysisDirection, ContributionAnalysisSortType, DashboardBehavior, DashboardUIState, DataSetDateComparisonFilterOperator, DataSetNumericComparisonFilterOperator, DatasetParameterValueType, DataSetStringComparisonFilterOperator, DataSetStringListFilterOperator, DisplayFormat, Edition, FilterClass, FilterOperator, GeoSpatialCountryCode, GeoSpatialDataRole, HorizontalTextAlignment, 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";
-import type { AccountCustomization, AdHocFilteringOption, AggFunction, AggregateOperation, AggregationPartitionBy, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, AxisDisplayOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DataLabelOptions, DataPrepAggregationFunction, DataSetColumnIdMapping, DataSetIdentifierDeclaration, DimensionField, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, ParameterControl, ParameterDeclaration, QueryExecutionOptions, SheetControlLayout, SheetImage, SheetTextBox, TransformOperationSource, VisualCustomAction, VisualCustomActionDefaults, VisualInteractionOptions, VisualMenuOption } from "./models_0";
-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, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallChartColorConfiguration, WaterfallChartFieldWells, WaterfallChartSortConfiguration } from "./models_1";
+import type { AccountCustomization, AdditionalNotes, AdHocFilteringOption, AggFunction, AggregateOperation, AggregationPartitionBy, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, AxisDisplayOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DataLabelOptions, DataPrepAggregationFunction, DataSetColumnIdMapping, DataSetIdentifierDeclaration, DimensionField, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, ParameterControl, ParameterDeclaration, QueryExecutionOptions, SheetControlLayout, SheetImage, SheetTextBox, TransformOperationSource, VisualCustomAction, VisualCustomActionDefaults, VisualInteractionOptions, VisualMenuOption } from "./models_0";
+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, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallChartColorConfiguration, WaterfallChartFieldWells } from "./models_1";
+/**
+ * <p>The sort configuration of a waterfall visual.</p>
+ * @public
+ */
+export interface WaterfallChartSortConfiguration {
+    /**
+     * <p>The sort configuration of the category fields.</p>
+     * @public
+     */
+    CategorySort?: FieldSortOptions[] | undefined;
+    /**
+     * <p>The limit on the number of bar groups that are displayed.</p>
+     * @public
+     */
+    BreakdownItemsLimit?: ItemsLimitConfiguration | undefined;
+}
 /**
  * <p>The options that determine the presentation of a waterfall visual.</p>
  * @public
@@ -7508,6 +7524,38 @@ export interface ColumnSchema {
      */
     GeographicRole?: string | undefined;
 }
+/**
+ * <p>The semantic type information for a column in the new data preparation experience.</p>
+ * @public
+ */
+export interface ColumnSemanticType {
+    /**
+     * <p>The geographical role of the column in the new data preparation experience.</p>
+     * @public
+     */
+    GeographicalRole?: GeoSpatialDataRole | undefined;
+}
+/**
+ * <p>A semantic property for a column.</p>
+ * @public
+ */
+export interface ColumnSemanticProperty {
+    /**
+     * <p>A description of the column.</p>
+     * @public
+     */
+    Description?: ColumnDescription | undefined;
+    /**
+     * <p>Additional notes for the column.</p>
+     * @public
+     */
+    AdditionalNotes?: AdditionalNotes | undefined;
+    /**
+     * <p>The semantic type of the column.</p>
+     * @public
+     */
+    SemanticType?: ColumnSemanticType | undefined;
+}
 /**
  * <p>A tag for a column in a
  *             <code>
@@ -9661,71 +9709,3 @@ export interface StringDatasetParameterDefaultValues {
      */
     StaticValues?: string[] | undefined;
 }
-/**
- * <p>A string parameter for a dataset.</p>
- * @public
- */
-export interface StringDatasetParameter {
-    /**
-     * <p>An identifier for the string parameter that is created in the dataset.</p>
-     * @public
-     */
-    Id: string | undefined;
-    /**
-     * <p>The name of the string parameter that is created in the dataset.</p>
-     * @public
-     */
-    Name: string | undefined;
-    /**
-     * <p>The value type of the dataset parameter. Valid values are <code>single value</code> or <code>multi value</code>.</p>
-     * @public
-     */
-    ValueType: DatasetParameterValueType | undefined;
-    /**
-     * <p>A list of default values for a given string dataset parameter type. This structure only accepts static values.</p>
-     * @public
-     */
-    DefaultValues?: StringDatasetParameterDefaultValues | undefined;
-}
-/**
- * <p>A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.</p>
- * @public
- */
-export interface DatasetParameter {
-    /**
-     * <p>A string parameter that is created in the dataset.</p>
-     * @public
-     */
-    StringDatasetParameter?: StringDatasetParameter | undefined;
-    /**
-     * <p>A decimal parameter that is created in the dataset.</p>
-     * @public
-     */
-    DecimalDatasetParameter?: DecimalDatasetParameter | undefined;
-    /**
-     * <p>An integer parameter that is created in the dataset.</p>
-     * @public
-     */
-    IntegerDatasetParameter?: IntegerDatasetParameter | undefined;
-    /**
-     * <p>A date time parameter that is created in the dataset.</p>
-     * @public
-     */
-    DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined;
-}
-/**
- * <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
- * @public
- */
-export interface DataSetUsageConfiguration {
-    /**
-     * <p>An option that controls whether a child dataset of a direct query can use this dataset as a source.</p>
-     * @public
-     */
-    DisableUseAsDirectQuerySource?: boolean | undefined;
-    /**
-     * <p>An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source.</p>
-     * @public
-     */
-    DisableUseAsImportedSource?: boolean | undefined;
-}