@aws-sdk/client-quicksight 3.431.0 → 3.433.0

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

@@ -1989,6 +1989,22 @@ export interface RelativeDatesFilter {
      */
     ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
 }
+/**
+ * @public
+ * <p>The rolling date configuration of a date time filter.</p>
+ */
+export interface RollingDateConfiguration {
+    /**
+     * @public
+     * <p>The data set that is used in the rolling date configuration.</p>
+     */
+    DataSetIdentifier?: string;
+    /**
+     * @public
+     * <p>The expression of the rolling date configuration.</p>
+     */
+    Expression: string | undefined;
+}
 /**
  * @public
  * <p>A <code>TimeEqualityFilter</code> filters values that are equal to a given value.</p>
@@ -2007,13 +2023,13 @@ export interface TimeEqualityFilter {
     /**
      * @public
      * <p>The value of a <code>TimeEquality</code> filter.</p>
-     *          <p>This field is mutually exclusive to <code>ParameterName</code>.</p>
+     *          <p>This field is mutually exclusive to <code>RollingDate</code> and <code>ParameterName</code>.</p>
      */
     Value?: Date;
     /**
      * @public
      * <p>The parameter whose value should be used for the filter value.</p>
-     *          <p>This field is mutually exclusive to <code>Value</code>.</p>
+     *          <p>This field is mutually exclusive to <code>Value</code> and <code>RollingDate</code>.</p>
      */
     ParameterName?: string;
     /**
@@ -2021,22 +2037,12 @@ export interface TimeEqualityFilter {
      * <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
      */
     TimeGranularity?: TimeGranularity;
-}
-/**
- * @public
- * <p>The rolling date configuration of a date time filter.</p>
- */
-export interface RollingDateConfiguration {
-    /**
-     * @public
-     * <p>The data set that is used in the rolling date configuration.</p>
-     */
-    DataSetIdentifier?: string;
     /**
      * @public
-     * <p>The expression of the rolling date configuration.</p>
+     * <p>The rolling date input for the <code>TimeEquality</code> filter.</p>
+     *          <p>This field is mutually exclusive to <code>Value</code> and <code>ParameterName</code>.</p>
      */
-    Expression: string | undefined;
+    RollingDate?: RollingDateConfiguration;
 }
 /**
  * @public
@@ -5466,6 +5472,18 @@ export interface ReferenceLineDynamicDataConfiguration {
      */
     Calculation: NumericalAggregationFunction | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ReferenceLineSeriesType: {
+    readonly BAR: "BAR";
+    readonly LINE: "LINE";
+};
+/**
+ * @public
+ */
+export type ReferenceLineSeriesType = (typeof ReferenceLineSeriesType)[keyof typeof ReferenceLineSeriesType];
 /**
  * @public
  * <p>The static data configuration of the reference line data configuration.</p>
@@ -5484,8 +5502,7 @@ export interface ReferenceLineStaticDataConfiguration {
 export interface ReferenceLineDataConfiguration {
     /**
      * @public
-     * <p>The static data configuration of the reference line data
-     *             configuration.</p>
+     * <p>The static data configuration of the reference line data configuration.</p>
      */
     StaticConfiguration?: ReferenceLineStaticDataConfiguration;
     /**
@@ -5498,14 +5515,35 @@ export interface ReferenceLineDataConfiguration {
      * <p>The axis binding type of the reference line. Choose one of the following options:</p>
      *          <ul>
      *             <li>
-     *                <p>PrimaryY</p>
+     *                <p>
+     *                   <code>PrimaryY</code>
+     *                </p>
      *             </li>
      *             <li>
-     *                <p>SecondaryY</p>
+     *                <p>
+     *                   <code>SecondaryY</code>
+     *                </p>
      *             </li>
      *          </ul>
      */
     AxisBinding?: AxisBinding;
+    /**
+     * @public
+     * <p>The series type of the reference line data configuration. Choose one of the following options:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>BAR</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>LINE</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     */
+    SeriesType?: ReferenceLineSeriesType;
 }
 /**
  * @public
@@ -6203,6 +6241,49 @@ export interface TooltipOptions {
      */
     FieldBasedTooltip?: FieldBasedTooltip;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const PivotTableDataPathType: {
+    readonly COUNT_METRIC_COLUMN: "COUNT_METRIC_COLUMN";
+    readonly EMPTY_COLUMN_HEADER: "EMPTY_COLUMN_HEADER";
+    readonly HIERARCHY_ROWS_LAYOUT_COLUMN: "HIERARCHY_ROWS_LAYOUT_COLUMN";
+    readonly MULTIPLE_ROW_METRICS_COLUMN: "MULTIPLE_ROW_METRICS_COLUMN";
+};
+/**
+ * @public
+ */
+export type PivotTableDataPathType = (typeof PivotTableDataPathType)[keyof typeof PivotTableDataPathType];
+/**
+ * @public
+ * <p>The type of the data path value.</p>
+ */
+export interface DataPathType {
+    /**
+     * @public
+     * <p>The type of data path value utilized in a pivot table. Choose one of the following options:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>HIERARCHY_ROWS_LAYOUT_COLUMN</code> - The type of data path for the rows layout column, when <code>RowsLayout</code> is set to <code>HIERARCHY</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>MULTIPLE_ROW_METRICS_COLUMN</code> - The type of data path for the metric column when the row is set to Metric Placement.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>EMPTY_COLUMN_HEADER</code> - The type of data path for the column with empty column header, when there is no field in <code>ColumnsFieldWell</code> and the row is set to Metric Placement.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>COUNT_METRIC_COLUMN</code> - The type of data path for the column with <code>COUNT</code> as the metric, when there is no field in the <code>ValuesFieldWell</code>.</p>
+     *             </li>
+     *          </ul>
+     */
+    PivotTableDataPathType?: PivotTableDataPathType;
+}
 /**
  * @public
  * <p>The data path that needs to be sorted.</p>
@@ -6212,12 +6293,17 @@ export interface DataPathValue {
      * @public
      * <p>The field ID of the field that needs to be sorted.</p>
      */
-    FieldId: string | undefined;
+    FieldId?: string;
     /**
      * @public
      * <p>The actual value of the field that needs to be sorted.</p>
      */
-    FieldValue: string | undefined;
+    FieldValue?: string;
+    /**
+     * @public
+     * <p>The type configuration of the field.</p>
+     */
+    DataPathType?: DataPathType;
 }
 /**
  * @public
@@ -6578,87 +6664,6 @@ export interface VisualTitleLabelOptions {
      */
     FormatText?: ShortFormatText;
 }
-/**
- * @public
- * <p>A bar chart.</p>
- *          <p>The <code>BarChartVisual</code> structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:</p>
- *          <ul>
- *             <li>
- *                <p>Horizontal bar chart</p>
- *             </li>
- *             <li>
- *                <p>Vertical bar chart</p>
- *             </li>
- *             <li>
- *                <p>Horizontal stacked bar chart</p>
- *             </li>
- *             <li>
- *                <p>Vertical stacked bar chart</p>
- *             </li>
- *             <li>
- *                <p>Horizontal stacked 100% bar chart</p>
- *             </li>
- *             <li>
- *                <p>Vertical stacked 100% bar chart</p>
- *             </li>
- *          </ul>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html">Using bar charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
- */
-export interface BarChartVisual {
-    /**
-     * @public
-     * <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>
-     */
-    VisualId: string | undefined;
-    /**
-     * @public
-     * <p>The title that is displayed on the visual.</p>
-     */
-    Title?: VisualTitleLabelOptions;
-    /**
-     * @public
-     * <p>The subtitle that is displayed on the visual.</p>
-     */
-    Subtitle?: VisualSubtitleLabelOptions;
-    /**
-     * @public
-     * <p>The configuration settings of the visual.</p>
-     */
-    ChartConfiguration?: BarChartConfiguration;
-    /**
-     * @public
-     * <p>The list of custom actions that are configured for a visual.</p>
-     */
-    Actions?: VisualCustomAction[];
-    /**
-     * @public
-     * <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
-     */
-    ColumnHierarchies?: ColumnHierarchy[];
-}
-/**
- * @public
- * @enum
- */
-export declare const BoxPlotFillStyle: {
-    readonly SOLID: "SOLID";
-    readonly TRANSPARENT: "TRANSPARENT";
-};
-/**
- * @public
- */
-export type BoxPlotFillStyle = (typeof BoxPlotFillStyle)[keyof typeof BoxPlotFillStyle];
-/**
- * @public
- * <p>The style options of the box plot.</p>
- */
-export interface BoxPlotStyleOptions {
-    /**
-     * @public
-     * <p>The fill styles (solid, transparent) of the box plot.</p>
-     */
-    FillStyle?: BoxPlotFillStyle;
-}
 /**
  * @internal
  */
@@ -6715,6 +6720,10 @@ export declare const ColumnConfigurationFilterSensitiveLog: (obj: ColumnConfigur
  * @internal
  */
 export declare const RollingDateConfigurationFilterSensitiveLog: (obj: RollingDateConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const TimeEqualityFilterFilterSensitiveLog: (obj: TimeEqualityFilter) => any;
 /**
  * @internal
  */
@@ -6947,7 +6956,3 @@ export declare const VisualPaletteFilterSensitiveLog: (obj: VisualPalette) => an
  * @internal
  */
 export declare const BarChartConfigurationFilterSensitiveLog: (obj: BarChartConfiguration) => any;
-/**
- * @internal
- */
-export declare const BarChartVisualFilterSensitiveLog: (obj: BarChartVisual) => any;

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

@@ -1,4 +1,85 @@
-import { AnalysisDefaults, AxisBinding, AxisDisplayOptions, BarChartVisual, BarsArrangement, BoxPlotStyleOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, ColumnHierarchy, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DataPathValue, DataSetIdentifierDeclaration, DimensionField, FieldSort, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, ParameterControl, ParameterDeclaration, PercentageDisplayFormatConfiguration, ReferenceLine, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipOptions, URLTargetConfiguration, Visibility, VisualCustomAction, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WidgetStatus } from "./models_0";
+import { AnalysisDefaults, AxisBinding, AxisDisplayOptions, BarChartConfiguration, BarsArrangement, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, ColumnHierarchy, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DataPathValue, DataSetIdentifierDeclaration, DimensionField, FieldSort, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, ParameterControl, ParameterDeclaration, PercentageDisplayFormatConfiguration, ReferenceLine, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipOptions, URLTargetConfiguration, Visibility, VisualCustomAction, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WidgetStatus } from "./models_0";
+/**
+ * @public
+ * <p>A bar chart.</p>
+ *          <p>The <code>BarChartVisual</code> structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Horizontal bar chart</p>
+ *             </li>
+ *             <li>
+ *                <p>Vertical bar chart</p>
+ *             </li>
+ *             <li>
+ *                <p>Horizontal stacked bar chart</p>
+ *             </li>
+ *             <li>
+ *                <p>Vertical stacked bar chart</p>
+ *             </li>
+ *             <li>
+ *                <p>Horizontal stacked 100% bar chart</p>
+ *             </li>
+ *             <li>
+ *                <p>Vertical stacked 100% bar chart</p>
+ *             </li>
+ *          </ul>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html">Using bar charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
+ */
+export interface BarChartVisual {
+    /**
+     * @public
+     * <p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>
+     */
+    VisualId: string | undefined;
+    /**
+     * @public
+     * <p>The title that is displayed on the visual.</p>
+     */
+    Title?: VisualTitleLabelOptions;
+    /**
+     * @public
+     * <p>The subtitle that is displayed on the visual.</p>
+     */
+    Subtitle?: VisualSubtitleLabelOptions;
+    /**
+     * @public
+     * <p>The configuration settings of the visual.</p>
+     */
+    ChartConfiguration?: BarChartConfiguration;
+    /**
+     * @public
+     * <p>The list of custom actions that are configured for a visual.</p>
+     */
+    Actions?: VisualCustomAction[];
+    /**
+     * @public
+     * <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
+     */
+    ColumnHierarchies?: ColumnHierarchy[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const BoxPlotFillStyle: {
+    readonly SOLID: "SOLID";
+    readonly TRANSPARENT: "TRANSPARENT";
+};
+/**
+ * @public
+ */
+export type BoxPlotFillStyle = (typeof BoxPlotFillStyle)[keyof typeof BoxPlotFillStyle];
+/**
+ * @public
+ * <p>The style options of the box plot.</p>
+ */
+export interface BoxPlotStyleOptions {
+    /**
+     * @public
+     * <p>The fill styles (solid, transparent) of the box plot.</p>
+     */
+    FillStyle?: BoxPlotFillStyle;
+}
 /**
  * @public
  * <p>The options of a box plot visual.</p>
@@ -4431,6 +4512,49 @@ export declare const TableTotalsScrollStatus: {
  * @public
  */
 export type TableTotalsScrollStatus = (typeof TableTotalsScrollStatus)[keyof typeof TableTotalsScrollStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const SimpleTotalAggregationFunction: {
+    readonly AVERAGE: "AVERAGE";
+    readonly DEFAULT: "DEFAULT";
+    readonly MAX: "MAX";
+    readonly MIN: "MIN";
+    readonly NONE: "NONE";
+    readonly SUM: "SUM";
+};
+/**
+ * @public
+ */
+export type SimpleTotalAggregationFunction = (typeof SimpleTotalAggregationFunction)[keyof typeof SimpleTotalAggregationFunction];
+/**
+ * @public
+ * <p>An aggregation function that aggregates the total values of a measure.</p>
+ */
+export interface TotalAggregationFunction {
+    /**
+     * @public
+     * <p>A built in aggregation function for total values.</p>
+     */
+    SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction;
+}
+/**
+ * @public
+ * <p>The total aggregation settings map of a field id.</p>
+ */
+export interface TotalAggregationOption {
+    /**
+     * @public
+     * <p>The field id that's associated with the total aggregation option.</p>
+     */
+    FieldId: string | undefined;
+    /**
+     * @public
+     * <p>The total aggregation function that you want to set for a specified field id.</p>
+     */
+    TotalAggregationFunction: TotalAggregationFunction | undefined;
+}
 /**
  * @public
  * <p>The optional configuration of totals cells in a <code>PivotTableVisual</code>.</p>
@@ -4471,6 +4595,11 @@ export interface PivotTotalOptions {
      * <p>The cell styling options for the total of header cells.</p>
      */
     MetricHeaderCellStyle?: TableCellStyle;
+    /**
+     * @public
+     * <p>The total aggregation options for each value field.</p>
+     */
+    TotalAggregationOptions?: TotalAggregationOption[];
 }
 /**
  * @public
@@ -5545,6 +5674,11 @@ export interface TotalOptions {
      * <p>Cell styling options for the total cells.</p>
      */
     TotalCellStyle?: TableCellStyle;
+    /**
+     * @public
+     * <p>The total aggregation settings for each value field.</p>
+     */
+    TotalAggregationOptions?: TotalAggregationOption[];
 }
 /**
  * @public
@@ -6724,124 +6858,9 @@ export declare const SnapshotFileSheetSelectionScope: {
  */
 export type SnapshotFileSheetSelectionScope = (typeof SnapshotFileSheetSelectionScope)[keyof typeof SnapshotFileSheetSelectionScope];
 /**
- * @public
- * <p>A structure that contains information that identifies the snapshot that needs to be generated.</p>
- */
-export interface SnapshotFileSheetSelection {
-    /**
-     * @public
-     * <p>The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.</p>
-     */
-    SheetId: string | undefined;
-    /**
-     * @public
-     * <p>The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>ALL_VISUALS</code> - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>SELECTED_VISUALS</code> - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.</p>
-     *             </li>
-     *          </ul>
-     */
-    SelectionScope: SnapshotFileSheetSelectionScope | undefined;
-    /**
-     * @public
-     * <p>
-     *             A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
-     *         </p>
-     */
-    VisualIds?: string[];
-}
-/**
- * @public
- * <p>A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.</p>
- */
-export interface SnapshotFile {
-    /**
-     * @public
-     * <p>A list of <code>SnapshotFileSheetSelection</code> objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.</p>
-     */
-    SheetSelections: SnapshotFileSheetSelection[] | undefined;
-    /**
-     * @public
-     * <p>The format of the snapshot file to be generated. You can choose between <code>CSV</code>, <code>Excel</code>, or <code>PDF</code>.</p>
-     */
-    FormatType: SnapshotFileFormatType | undefined;
-}
-/**
- * @public
- * <p>Information on the error that caused the snapshot job to fail.</p>
- */
-export interface SnapshotJobResultErrorInfo {
-    /**
-     * @public
-     * <p>The error message.</p>
-     */
-    ErrorMessage?: string;
-    /**
-     * @public
-     * <p>The error type.</p>
-     */
-    ErrorType?: string;
-}
-/**
- * @public
- * <p>An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.</p>
- */
-export interface S3BucketConfiguration {
-    /**
-     * @public
-     * <p>The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.</p>
-     */
-    BucketName: string | undefined;
-    /**
-     * @public
-     * <p>The prefix of the Amazon S3 bucket that the generated snapshots are stored in.</p>
-     */
-    BucketPrefix: string | undefined;
-    /**
-     * @public
-     * <p>The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the <code>StartDashboardSnapshotJob</code> API call is made.</p>
-     */
-    BucketRegion: string | undefined;
-}
-/**
- * @public
- * <p>A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.</p>
- */
-export interface SnapshotS3DestinationConfiguration {
-    /**
-     * @public
-     * <p>A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.</p>
-     */
-    BucketConfiguration?: S3BucketConfiguration;
-}
-/**
- * @public
- * <p>The Amazon S3 result from the snapshot job. The result includes the <code>DestinationConfiguration</code> and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.</p>
+ * @internal
  */
-export interface SnapshotJobS3Result {
-    /**
-     * @public
-     * <p>A list of Amazon S3 bucket configurations that are provided when you make a <code>StartDashboardSnapshotJob</code> API call.
-     *         </p>
-     */
-    S3DestinationConfiguration?: SnapshotS3DestinationConfiguration;
-    /**
-     * @public
-     * <p>The Amazon S3 Uri.</p>
-     */
-    S3Uri?: string;
-    /**
-     * @public
-     * <p>An array of error records that describe any failures that occur while the dashboard snapshot job runs.</p>
-     */
-    ErrorInfo?: SnapshotJobResultErrorInfo[];
-}
+export declare const BarChartVisualFilterSensitiveLog: (obj: BarChartVisual) => any;
 /**
  * @internal
  */
@@ -7390,7 +7409,3 @@ export declare const SheetDefinitionFilterSensitiveLog: (obj: SheetDefinition) =
  * @internal
  */
 export declare const AnalysisDefinitionFilterSensitiveLog: (obj: AnalysisDefinition) => any;
-/**
- * @internal
- */
-export declare const SnapshotJobS3ResultFilterSensitiveLog: (obj: SnapshotJobS3Result) => any;