@aws-sdk/client-quicksight 3.600.0 → 3.606.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 (35) hide show
  1. package/dist-cjs/index.js +195 -48
  2. package/dist-es/models/models_0.js +0 -14
  3. package/dist-es/models/models_1.js +14 -23
  4. package/dist-es/models/models_2.js +25 -2
  5. package/dist-es/protocols/Aws_restJson1.js +161 -2
  6. package/dist-types/commands/CreateAnalysisCommand.d.ts +60 -0
  7. package/dist-types/commands/CreateDashboardCommand.d.ts +60 -0
  8. package/dist-types/commands/CreateTemplateCommand.d.ts +60 -0
  9. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +60 -0
  10. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +60 -0
  11. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +60 -0
  12. package/dist-types/commands/ListAssetBundleImportJobsCommand.d.ts +2 -1
  13. package/dist-types/commands/ListDashboardVersionsCommand.d.ts +1 -1
  14. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  15. package/dist-types/commands/ListDataSetsCommand.d.ts +1 -1
  16. package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -2
  17. package/dist-types/commands/UpdateAnalysisCommand.d.ts +60 -0
  18. package/dist-types/commands/UpdateDashboardCommand.d.ts +60 -0
  19. package/dist-types/commands/UpdateTemplateCommand.d.ts +60 -0
  20. package/dist-types/models/models_0.d.ts +180 -194
  21. package/dist-types/models/models_1.d.ts +174 -199
  22. package/dist-types/models/models_2.d.ts +192 -106
  23. package/dist-types/models/models_3.d.ts +113 -189
  24. package/dist-types/models/models_4.d.ts +190 -2
  25. package/dist-types/ts3.4/commands/ListAssetBundleImportJobsCommand.d.ts +2 -4
  26. package/dist-types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
  27. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
  28. package/dist-types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
  29. package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +4 -2
  30. package/dist-types/ts3.4/models/models_0.d.ts +43 -48
  31. package/dist-types/ts3.4/models/models_1.d.ts +45 -62
  32. package/dist-types/ts3.4/models/models_2.d.ts +71 -33
  33. package/dist-types/ts3.4/models/models_3.d.ts +29 -49
  34. package/dist-types/ts3.4/models/models_4.d.ts +47 -0
  35. package/package.json +3 -3
@@ -2199,6 +2199,65 @@ export interface CategoryFilter {
2199
2199
  */
2200
2200
  DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
2201
2201
  }
2202
+ /**
2203
+ * <p>A <code>CategoryInnerFilter</code> filters text values for the <code>NestedFilter</code>.</p>
2204
+ * @public
2205
+ */
2206
+ export interface CategoryInnerFilter {
2207
+ /**
2208
+ * <p>A column of a data set.</p>
2209
+ * @public
2210
+ */
2211
+ Column: ColumnIdentifier | undefined;
2212
+ /**
2213
+ * <p>The configuration for a <code>CategoryFilter</code>.</p>
2214
+ * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
2215
+ * @public
2216
+ */
2217
+ Configuration: CategoryFilterConfiguration | undefined;
2218
+ /**
2219
+ * <p>The default configuration for all dependent controls of the filter.</p>
2220
+ * @public
2221
+ */
2222
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
2223
+ }
2224
+ /**
2225
+ * <p>The <code>InnerFilter</code> defines the subset of data to be used with the <code>NestedFilter</code>.</p>
2226
+ * @public
2227
+ */
2228
+ export interface InnerFilter {
2229
+ /**
2230
+ * <p>A <code>CategoryInnerFilter</code> filters text values for the <code>NestedFilter</code>.</p>
2231
+ * @public
2232
+ */
2233
+ CategoryInnerFilter?: CategoryInnerFilter;
2234
+ }
2235
+ /**
2236
+ * <p>A <code>NestedFilter</code> filters data with a subset of data that is defined by the nested inner filter.</p>
2237
+ * @public
2238
+ */
2239
+ export interface NestedFilter {
2240
+ /**
2241
+ * <p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>
2242
+ * @public
2243
+ */
2244
+ FilterId: string | undefined;
2245
+ /**
2246
+ * <p>The column that the filter is applied to.</p>
2247
+ * @public
2248
+ */
2249
+ Column: ColumnIdentifier | undefined;
2250
+ /**
2251
+ * <p>A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.</p>
2252
+ * @public
2253
+ */
2254
+ IncludeInnerSet: boolean | undefined;
2255
+ /**
2256
+ * <p>The <code>InnerFilter</code> defines the subset of data to be used with the <code>NestedFilter</code>.</p>
2257
+ * @public
2258
+ */
2259
+ InnerFilter: InnerFilter | undefined;
2260
+ }
2202
2261
  /**
2203
2262
  * @public
2204
2263
  * @enum
@@ -2838,6 +2897,11 @@ export interface Filter {
2838
2897
  * @public
2839
2898
  */
2840
2899
  TopBottomFilter?: TopBottomFilter;
2900
+ /**
2901
+ * <p>A <code>NestedFilter</code> filters data with a subset of data that is defined by the nested inner filter.</p>
2902
+ * @public
2903
+ */
2904
+ NestedFilter?: NestedFilter;
2841
2905
  }
2842
2906
  /**
2843
2907
  * @public
@@ -4053,6 +4117,117 @@ export interface SectionPageBreakConfiguration {
4053
4117
  */
4054
4118
  After?: SectionAfterPageBreak;
4055
4119
  }
4120
+ /**
4121
+ * <p>The sort configuration for a column that is not used in a field well.</p>
4122
+ * @public
4123
+ */
4124
+ export interface ColumnSort {
4125
+ /**
4126
+ * <p>A column of a data set.</p>
4127
+ * @public
4128
+ */
4129
+ SortBy: ColumnIdentifier | undefined;
4130
+ /**
4131
+ * <p>The sort direction.</p>
4132
+ * @public
4133
+ */
4134
+ Direction: SortDirection | undefined;
4135
+ /**
4136
+ * <p>The aggregation function that is defined in the column sort.</p>
4137
+ * @public
4138
+ */
4139
+ AggregationFunction?: AggregationFunction;
4140
+ }
4141
+ /**
4142
+ * <p>Describes the <b>Category</b> dataset column and constraints for the dynamic values used to repeat the contents of a section.</p>
4143
+ * @public
4144
+ */
4145
+ export interface BodySectionDynamicCategoryDimensionConfiguration {
4146
+ /**
4147
+ * <p>A column of a data set.</p>
4148
+ * @public
4149
+ */
4150
+ Column: ColumnIdentifier | undefined;
4151
+ /**
4152
+ * <p>Number of values to use from the column for repetition.</p>
4153
+ * @public
4154
+ */
4155
+ Limit?: number;
4156
+ /**
4157
+ * <p>Sort criteria on the column values that you use for repetition. </p>
4158
+ * @public
4159
+ */
4160
+ SortByMetrics?: ColumnSort[];
4161
+ }
4162
+ /**
4163
+ * <p>Describes the <b>Numeric</b> dataset column and constraints for the dynamic values used to repeat the contents of a section.</p>
4164
+ * @public
4165
+ */
4166
+ export interface BodySectionDynamicNumericDimensionConfiguration {
4167
+ /**
4168
+ * <p>A column of a data set.</p>
4169
+ * @public
4170
+ */
4171
+ Column: ColumnIdentifier | undefined;
4172
+ /**
4173
+ * <p>Number of values to use from the column for repetition.</p>
4174
+ * @public
4175
+ */
4176
+ Limit?: number;
4177
+ /**
4178
+ * <p>Sort criteria on the column values that you use for repetition. </p>
4179
+ * @public
4180
+ */
4181
+ SortByMetrics?: ColumnSort[];
4182
+ }
4183
+ /**
4184
+ * <p>Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either <b>Category</b> or <b>Numeric</b> column configuration</p>
4185
+ * @public
4186
+ */
4187
+ export interface BodySectionRepeatDimensionConfiguration {
4188
+ /**
4189
+ * <p>Describes the <b>Category</b> dataset column and constraints around the dynamic values that will be used in repeating the section contents.</p>
4190
+ * @public
4191
+ */
4192
+ DynamicCategoryDimensionConfiguration?: BodySectionDynamicCategoryDimensionConfiguration;
4193
+ /**
4194
+ * <p>Describes the <b>Numeric</b> dataset column and constraints around the dynamic values used to repeat the contents of a section.</p>
4195
+ * @public
4196
+ */
4197
+ DynamicNumericDimensionConfiguration?: BodySectionDynamicNumericDimensionConfiguration;
4198
+ }
4199
+ /**
4200
+ * <p>The page break configuration to apply for each repeating instance.</p>
4201
+ * @public
4202
+ */
4203
+ export interface BodySectionRepeatPageBreakConfiguration {
4204
+ /**
4205
+ * <p>The configuration of a page break after a section.</p>
4206
+ * @public
4207
+ */
4208
+ After?: SectionAfterPageBreak;
4209
+ }
4210
+ /**
4211
+ * <p>Describes the configurations that are required to declare a section as repeating.</p>
4212
+ * @public
4213
+ */
4214
+ export interface BodySectionRepeatConfiguration {
4215
+ /**
4216
+ * <p>List of <code>BodySectionRepeatDimensionConfiguration</code> values that describe the dataset column and constraints for the column used to repeat the contents of a section.</p>
4217
+ * @public
4218
+ */
4219
+ DimensionConfigurations?: BodySectionRepeatDimensionConfiguration[];
4220
+ /**
4221
+ * <p>Page break configuration to apply for each repeating instance.</p>
4222
+ * @public
4223
+ */
4224
+ PageBreakConfiguration?: BodySectionRepeatPageBreakConfiguration;
4225
+ /**
4226
+ * <p>List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.</p>
4227
+ * @public
4228
+ */
4229
+ NonRepeatingVisuals?: string[];
4230
+ }
4056
4231
  /**
4057
4232
  * <p>The options that style a section.</p>
4058
4233
  * @public
@@ -4096,6 +4271,11 @@ export interface BodySectionConfiguration {
4096
4271
  * @public
4097
4272
  */
4098
4273
  PageBreakConfiguration?: SectionPageBreakConfiguration;
4274
+ /**
4275
+ * <p>Describes the configurations that are required to declare a section as repeating.</p>
4276
+ * @public
4277
+ */
4278
+ RepeatConfiguration?: BodySectionRepeatConfiguration;
4099
4279
  }
4100
4280
  /**
4101
4281
  * <p>The configuration of a header or footer section.</p>
@@ -6345,27 +6525,6 @@ export interface ItemsLimitConfiguration {
6345
6525
  */
6346
6526
  OtherCategories?: OtherCategories;
6347
6527
  }
6348
- /**
6349
- * <p>The sort configuration for a column that is not used in a field well.</p>
6350
- * @public
6351
- */
6352
- export interface ColumnSort {
6353
- /**
6354
- * <p>A column of a data set.</p>
6355
- * @public
6356
- */
6357
- SortBy: ColumnIdentifier | undefined;
6358
- /**
6359
- * <p>The sort direction.</p>
6360
- * @public
6361
- */
6362
- Direction: SortDirection | undefined;
6363
- /**
6364
- * <p>The aggregation function that is defined in the column sort.</p>
6365
- * @public
6366
- */
6367
- AggregationFunction?: AggregationFunction;
6368
- }
6369
6528
  /**
6370
6529
  * <p>The sort configuration for a field in a
6371
6530
  * field well.</p>
@@ -6490,179 +6649,6 @@ export interface ColumnTooltipItem {
6490
6649
  */
6491
6650
  TooltipTarget?: TooltipTarget;
6492
6651
  }
6493
- /**
6494
- * <p>The tooltip item for the fields.</p>
6495
- * @public
6496
- */
6497
- export interface FieldTooltipItem {
6498
- /**
6499
- * <p>The unique ID of the field that is targeted by the tooltip.</p>
6500
- * @public
6501
- */
6502
- FieldId: string | undefined;
6503
- /**
6504
- * <p>The label of the tooltip item.</p>
6505
- * @public
6506
- */
6507
- Label?: string;
6508
- /**
6509
- * <p>The visibility of the tooltip item.</p>
6510
- * @public
6511
- */
6512
- Visibility?: Visibility;
6513
- /**
6514
- * <p>Determines the target of the field tooltip item in a combo chart visual.</p>
6515
- * @public
6516
- */
6517
- TooltipTarget?: TooltipTarget;
6518
- }
6519
- /**
6520
- * <p>The tooltip.</p>
6521
- * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
6522
- * @public
6523
- */
6524
- export interface TooltipItem {
6525
- /**
6526
- * <p>The tooltip item for the fields.</p>
6527
- * @public
6528
- */
6529
- FieldTooltipItem?: FieldTooltipItem;
6530
- /**
6531
- * <p>The tooltip item for the columns that are not part of a field well.</p>
6532
- * @public
6533
- */
6534
- ColumnTooltipItem?: ColumnTooltipItem;
6535
- }
6536
- /**
6537
- * @public
6538
- * @enum
6539
- */
6540
- export declare const TooltipTitleType: {
6541
- readonly NONE: "NONE";
6542
- readonly PRIMARY_VALUE: "PRIMARY_VALUE";
6543
- };
6544
- /**
6545
- * @public
6546
- */
6547
- export type TooltipTitleType = (typeof TooltipTitleType)[keyof typeof TooltipTitleType];
6548
- /**
6549
- * <p>The setup for the detailed tooltip.</p>
6550
- * @public
6551
- */
6552
- export interface FieldBasedTooltip {
6553
- /**
6554
- * <p>The visibility of <code>Show aggregations</code>.</p>
6555
- * @public
6556
- */
6557
- AggregationVisibility?: Visibility;
6558
- /**
6559
- * <p>The type for the >tooltip title. Choose one of the following options:</p>
6560
- * <ul>
6561
- * <li>
6562
- * <p>
6563
- * <code>NONE</code>: Doesn't use the primary value as the title.</p>
6564
- * </li>
6565
- * <li>
6566
- * <p>
6567
- * <code>PRIMARY_VALUE</code>: Uses primary value as the title.</p>
6568
- * </li>
6569
- * </ul>
6570
- * @public
6571
- */
6572
- TooltipTitleType?: TooltipTitleType;
6573
- /**
6574
- * <p>The fields configuration in the
6575
- * tooltip.</p>
6576
- * @public
6577
- */
6578
- TooltipFields?: TooltipItem[];
6579
- }
6580
- /**
6581
- * @public
6582
- * @enum
6583
- */
6584
- export declare const SelectedTooltipType: {
6585
- readonly BASIC: "BASIC";
6586
- readonly DETAILED: "DETAILED";
6587
- };
6588
- /**
6589
- * @public
6590
- */
6591
- export type SelectedTooltipType = (typeof SelectedTooltipType)[keyof typeof SelectedTooltipType];
6592
- /**
6593
- * <p>The display options for the visual tooltip.</p>
6594
- * @public
6595
- */
6596
- export interface TooltipOptions {
6597
- /**
6598
- * <p>Determines whether or not the tooltip is visible.</p>
6599
- * @public
6600
- */
6601
- TooltipVisibility?: Visibility;
6602
- /**
6603
- * <p>The selected type for the tooltip. Choose one of the following options:</p>
6604
- * <ul>
6605
- * <li>
6606
- * <p>
6607
- * <code>BASIC</code>: A basic tooltip.</p>
6608
- * </li>
6609
- * <li>
6610
- * <p>
6611
- * <code>DETAILED</code>: A detailed tooltip.</p>
6612
- * </li>
6613
- * </ul>
6614
- * @public
6615
- */
6616
- SelectedTooltipType?: SelectedTooltipType;
6617
- /**
6618
- * <p>The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.</p>
6619
- * @public
6620
- */
6621
- FieldBasedTooltip?: FieldBasedTooltip;
6622
- }
6623
- /**
6624
- * @public
6625
- * @enum
6626
- */
6627
- export declare const PivotTableDataPathType: {
6628
- readonly COUNT_METRIC_COLUMN: "COUNT_METRIC_COLUMN";
6629
- readonly EMPTY_COLUMN_HEADER: "EMPTY_COLUMN_HEADER";
6630
- readonly HIERARCHY_ROWS_LAYOUT_COLUMN: "HIERARCHY_ROWS_LAYOUT_COLUMN";
6631
- readonly MULTIPLE_ROW_METRICS_COLUMN: "MULTIPLE_ROW_METRICS_COLUMN";
6632
- };
6633
- /**
6634
- * @public
6635
- */
6636
- export type PivotTableDataPathType = (typeof PivotTableDataPathType)[keyof typeof PivotTableDataPathType];
6637
- /**
6638
- * <p>The type of the data path value.</p>
6639
- * @public
6640
- */
6641
- export interface DataPathType {
6642
- /**
6643
- * <p>The type of data path value utilized in a pivot table. Choose one of the following options:</p>
6644
- * <ul>
6645
- * <li>
6646
- * <p>
6647
- * <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>
6648
- * </li>
6649
- * <li>
6650
- * <p>
6651
- * <code>MULTIPLE_ROW_METRICS_COLUMN</code> - The type of data path for the metric column when the row is set to Metric Placement.</p>
6652
- * </li>
6653
- * <li>
6654
- * <p>
6655
- * <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>
6656
- * </li>
6657
- * <li>
6658
- * <p>
6659
- * <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>
6660
- * </li>
6661
- * </ul>
6662
- * @public
6663
- */
6664
- PivotTableDataPathType?: PivotTableDataPathType;
6665
- }
6666
6652
  /**
6667
6653
  * @internal
6668
6654
  */