@aws-sdk/client-quicksight 3.947.0 → 3.950.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.
- package/README.md +8 -0
- package/dist-cjs/index.js +415 -101
- package/dist-es/QuickSight.js +2 -0
- package/dist-es/commands/GetIdentityContextCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/enums.js +49 -17
- package/dist-es/schemas/schemas_0.js +349 -84
- package/dist-types/QuickSight.d.ts +7 -0
- package/dist-types/QuickSightClient.d.ts +3 -2
- package/dist-types/commands/CreateAnalysisCommand.d.ts +194 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +194 -0
- package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/CreateDataSourceCommand.d.ts +5 -0
- package/dist-types/commands/CreateTemplateCommand.d.ts +194 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +194 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +194 -0
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +19 -0
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +89 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +194 -0
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/GetIdentityContextCommand.d.ts +143 -0
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +55 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +194 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +194 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +5 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +194 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +97 -41
- package/dist-types/models/models_0.d.ts +265 -162
- package/dist-types/models/models_1.d.ts +615 -822
- package/dist-types/models/models_2.d.ts +5138 -5090
- package/dist-types/models/models_3.d.ts +3935 -3902
- package/dist-types/models/models_4.d.ts +727 -7
- package/dist-types/schemas/schemas_0.d.ts +33 -0
- package/dist-types/ts3.4/QuickSight.d.ts +17 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicRefreshCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetIdentityContextCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +61 -23
- package/dist-types/ts3.4/models/models_0.d.ts +41 -38
- package/dist-types/ts3.4/models/models_1.d.ts +140 -164
- package/dist-types/ts3.4/models/models_2.d.ts +174 -176
- package/dist-types/ts3.4/models/models_3.d.ts +183 -147
- package/dist-types/ts3.4/models/models_4.d.ts +189 -13
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +33 -0
- package/package.json +3 -3
|
@@ -1,5 +1,166 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { type
|
|
1
|
+
import { ArcThickness, ArcThicknessOptions, AxisBinding, 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, WordCloudCloudLayout, WordCloudWordCasing, WordCloudWordOrientation, WordCloudWordPadding, WordCloudWordScaling } from "./enums";
|
|
2
|
+
import { type AxisDisplayOptions, type BarChartConfiguration, type BorderSettings, type CategoryDrillDownFilter, type ChartAxisLabelOptions, type ColumnSort, type CustomActionFilterOperation, type CustomActionNavigationOperation, type CustomActionSetParametersOperation, type CustomActionURLOperation, type DataLabelOptions, type DecalSettings, type FieldSort, type FontConfiguration, type FormatConfiguration, type ItemsLimitConfiguration, type LegendOptions, type NumberDisplayFormatConfiguration, type PercentageDisplayFormatConfiguration, type SmallMultiplesOptions, type TooltipOptions, type VisualInteractionOptions, type VisualPalette, ColumnIdentifier, ContributionAnalysisDefault, DataPathValue, DimensionField, FieldSortOptions, MeasureField, ReferenceLine, VisualCustomAction } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* <p>The numeric equality type drill down filter.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface NumericEqualityDrillDownFilter {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The column that the filter is applied to.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
Column: ColumnIdentifier | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>The value of the double input numeric drill down filter.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
Value: number | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* <p>The time range drill down filter.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export interface TimeRangeDrillDownFilter {
|
|
24
|
+
/**
|
|
25
|
+
* <p>The column that the filter is applied to.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
Column: ColumnIdentifier | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The minimum value for the filter value range.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
RangeMinimum: Date | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* <p>The maximum value for the filter value range.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
RangeMaximum: Date | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
TimeGranularity: TimeGranularity | undefined;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* <p>The drill down filter for the column hierarchies.</p>
|
|
47
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
export interface DrillDownFilter {
|
|
51
|
+
/**
|
|
52
|
+
* <p>The numeric equality type drill down filter. This filter is used for number type columns.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
NumericEqualityFilter?: NumericEqualityDrillDownFilter | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The category type drill down filter. This filter is used for string type columns.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
CategoryFilter?: CategoryDrillDownFilter | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* <p>The time range drill down filter. This filter is used for date time columns.</p>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
TimeRangeFilter?: TimeRangeDrillDownFilter | undefined;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* <p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export interface DateTimeHierarchy {
|
|
72
|
+
/**
|
|
73
|
+
* <p>The hierarchy ID of the <code>DateTime</code> hierarchy.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
HierarchyId: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The option that determines the drill down filters for the
|
|
79
|
+
* <code>DateTime</code> hierarchy.</p>
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
DrillDownFilters?: DrillDownFilter[] | undefined;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* <p>The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.</p>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export interface ExplicitHierarchy {
|
|
89
|
+
/**
|
|
90
|
+
* <p>The hierarchy ID of the explicit hierarchy.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
HierarchyId: string | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>The list of columns that define the explicit hierarchy.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
Columns: ColumnIdentifier[] | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>The option that determines the drill down filters for the explicit hierarchy.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
DrillDownFilters?: DrillDownFilter[] | undefined;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* <p>The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export interface PredefinedHierarchy {
|
|
110
|
+
/**
|
|
111
|
+
* <p>The hierarchy ID of the predefined hierarchy.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
HierarchyId: string | undefined;
|
|
115
|
+
/**
|
|
116
|
+
* <p>The list of columns that define the predefined hierarchy.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
Columns: ColumnIdentifier[] | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* <p>The option that determines the drill down filters for the predefined hierarchy.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
DrillDownFilters?: DrillDownFilter[] | undefined;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* <p>The option that determines the hierarchy of the fields for a visual element.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
export interface ColumnHierarchy {
|
|
131
|
+
/**
|
|
132
|
+
* <p>The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
ExplicitHierarchy?: ExplicitHierarchy | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* <p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
DateTimeHierarchy?: DateTimeHierarchy | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <p>The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
PredefinedHierarchy?: PredefinedHierarchy | undefined;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* <p>The text format for a subtitle.</p>
|
|
149
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export interface LongFormatText {
|
|
153
|
+
/**
|
|
154
|
+
* <p>Plain text format.</p>
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
PlainText?: string | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* <p>Rich text. Examples of rich text include bold, underline, and italics.</p>
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
RichText?: string | undefined;
|
|
163
|
+
}
|
|
3
164
|
/**
|
|
4
165
|
* <p>The subtitle label options for a visual.</p>
|
|
5
166
|
* @public
|
|
@@ -313,126 +474,334 @@ export interface BoxPlotVisual {
|
|
|
313
474
|
VisualContentAltText?: string | undefined;
|
|
314
475
|
}
|
|
315
476
|
/**
|
|
316
|
-
* <p>
|
|
477
|
+
* <p>Line styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
317
478
|
* @public
|
|
318
479
|
*/
|
|
319
|
-
export interface
|
|
480
|
+
export interface LineChartLineStyleSettings {
|
|
320
481
|
/**
|
|
321
|
-
* <p>
|
|
482
|
+
* <p>Configuration option that determines whether to show the line for the series.</p>
|
|
322
483
|
* @public
|
|
323
484
|
*/
|
|
324
|
-
|
|
485
|
+
LineVisibility?: Visibility | undefined;
|
|
325
486
|
/**
|
|
326
|
-
* <p>
|
|
487
|
+
* <p>Interpolation style for line series.</p>
|
|
488
|
+
* <ul>
|
|
489
|
+
* <li>
|
|
490
|
+
* <p>
|
|
491
|
+
* <code>LINEAR</code>: Show as default, linear style.</p>
|
|
492
|
+
* </li>
|
|
493
|
+
* <li>
|
|
494
|
+
* <p>
|
|
495
|
+
* <code>SMOOTH</code>: Show as a smooth curve.</p>
|
|
496
|
+
* </li>
|
|
497
|
+
* <li>
|
|
498
|
+
* <p>
|
|
499
|
+
* <code>STEPPED</code>: Show steps in line.</p>
|
|
500
|
+
* </li>
|
|
501
|
+
* </ul>
|
|
327
502
|
* @public
|
|
328
503
|
*/
|
|
329
|
-
|
|
504
|
+
LineInterpolation?: LineInterpolation | undefined;
|
|
330
505
|
/**
|
|
331
|
-
* <p>
|
|
506
|
+
* <p>Line style for line series.</p>
|
|
507
|
+
* <ul>
|
|
508
|
+
* <li>
|
|
509
|
+
* <p>
|
|
510
|
+
* <code>SOLID</code>: Show as a solid line.</p>
|
|
511
|
+
* </li>
|
|
512
|
+
* <li>
|
|
513
|
+
* <p>
|
|
514
|
+
* <code>DOTTED</code>: Show as a dotted line.</p>
|
|
515
|
+
* </li>
|
|
516
|
+
* <li>
|
|
517
|
+
* <p>
|
|
518
|
+
* <code>DASHED</code>: Show as a dashed line.</p>
|
|
519
|
+
* </li>
|
|
520
|
+
* </ul>
|
|
332
521
|
* @public
|
|
333
522
|
*/
|
|
334
|
-
|
|
523
|
+
LineStyle?: LineChartLineStyle | undefined;
|
|
335
524
|
/**
|
|
336
|
-
* <p>
|
|
525
|
+
* <p>Width that determines the line thickness.</p>
|
|
337
526
|
* @public
|
|
338
527
|
*/
|
|
339
|
-
|
|
528
|
+
LineWidth?: string | undefined;
|
|
340
529
|
}
|
|
341
530
|
/**
|
|
342
|
-
* <p>
|
|
343
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
531
|
+
* <p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
344
532
|
* @public
|
|
345
533
|
*/
|
|
346
|
-
export interface
|
|
534
|
+
export interface LineChartMarkerStyleSettings {
|
|
347
535
|
/**
|
|
348
|
-
* <p>
|
|
536
|
+
* <p>Configuration option that determines whether to show the markers in the series.</p>
|
|
349
537
|
* @public
|
|
350
538
|
*/
|
|
351
|
-
|
|
352
|
-
}
|
|
353
|
-
/**
|
|
354
|
-
* <p>The options that are available for a single Y axis in a chart.</p>
|
|
355
|
-
* @public
|
|
356
|
-
*/
|
|
357
|
-
export interface YAxisOptions {
|
|
539
|
+
MarkerVisibility?: Visibility | undefined;
|
|
358
540
|
/**
|
|
359
|
-
* <p>
|
|
360
|
-
* <
|
|
541
|
+
* <p>Shape option for markers in the series.</p>
|
|
542
|
+
* <ul>
|
|
543
|
+
* <li>
|
|
544
|
+
* <p>
|
|
545
|
+
* <code>CIRCLE</code>: Show marker as a circle.</p>
|
|
546
|
+
* </li>
|
|
547
|
+
* <li>
|
|
548
|
+
* <p>
|
|
549
|
+
* <code>TRIANGLE</code>: Show marker as a triangle.</p>
|
|
550
|
+
* </li>
|
|
551
|
+
* <li>
|
|
552
|
+
* <p>
|
|
553
|
+
* <code>SQUARE</code>: Show marker as a square.</p>
|
|
554
|
+
* </li>
|
|
555
|
+
* <li>
|
|
556
|
+
* <p>
|
|
557
|
+
* <code>DIAMOND</code>: Show marker as a diamond.</p>
|
|
558
|
+
* </li>
|
|
559
|
+
* <li>
|
|
560
|
+
* <p>
|
|
561
|
+
* <code>ROUNDED_SQUARE</code>: Show marker as a rounded square.</p>
|
|
562
|
+
* </li>
|
|
563
|
+
* </ul>
|
|
361
564
|
* @public
|
|
362
565
|
*/
|
|
363
|
-
|
|
364
|
-
}
|
|
365
|
-
/**
|
|
366
|
-
* <p>The settings of a chart's single axis configuration.</p>
|
|
367
|
-
* @public
|
|
368
|
-
*/
|
|
369
|
-
export interface SingleAxisOptions {
|
|
566
|
+
MarkerShape?: LineChartMarkerShape | undefined;
|
|
370
567
|
/**
|
|
371
|
-
* <p>
|
|
568
|
+
* <p>Size of marker in the series.</p>
|
|
372
569
|
* @public
|
|
373
570
|
*/
|
|
374
|
-
|
|
571
|
+
MarkerSize?: string | undefined;
|
|
572
|
+
/**
|
|
573
|
+
* <p>Color of marker in the series.</p>
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
MarkerColor?: string | undefined;
|
|
375
577
|
}
|
|
376
578
|
/**
|
|
377
|
-
* <p>The
|
|
579
|
+
* <p>The options that determine the default presentation of all series in <code>ComboChartVisual</code>.</p>
|
|
378
580
|
* @public
|
|
379
581
|
*/
|
|
380
|
-
export interface
|
|
582
|
+
export interface ComboChartDefaultSeriesSettings {
|
|
381
583
|
/**
|
|
382
|
-
* <p>
|
|
584
|
+
* <p>Line styles options for all line series in the visual.</p>
|
|
383
585
|
* @public
|
|
384
586
|
*/
|
|
385
|
-
|
|
587
|
+
LineStyleSettings?: LineChartLineStyleSettings | undefined;
|
|
386
588
|
/**
|
|
387
|
-
* <p>
|
|
589
|
+
* <p>Marker styles options for all line series in the visual.</p>
|
|
388
590
|
* @public
|
|
389
591
|
*/
|
|
390
|
-
|
|
592
|
+
MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined;
|
|
391
593
|
/**
|
|
392
|
-
* <p>
|
|
594
|
+
* <p>Decal settings for all series in the visual.</p>
|
|
393
595
|
* @public
|
|
394
596
|
*/
|
|
395
|
-
|
|
597
|
+
DecalSettings?: DecalSettings | undefined;
|
|
396
598
|
/**
|
|
397
|
-
* <p>
|
|
599
|
+
* <p>Border settings for all bar series in the visual.</p>
|
|
398
600
|
* @public
|
|
399
601
|
*/
|
|
400
|
-
|
|
602
|
+
BorderSettings?: BorderSettings | undefined;
|
|
401
603
|
}
|
|
402
604
|
/**
|
|
403
|
-
* <p>The
|
|
605
|
+
* <p>The aggregated field wells of a combo chart.</p>
|
|
404
606
|
* @public
|
|
405
607
|
*/
|
|
406
|
-
export interface
|
|
608
|
+
export interface ComboChartAggregatedFieldWells {
|
|
407
609
|
/**
|
|
408
|
-
* <p>The field wells of
|
|
610
|
+
* <p>The aggregated category field wells of a combo chart.</p>
|
|
409
611
|
* @public
|
|
410
612
|
*/
|
|
411
|
-
|
|
613
|
+
Category?: DimensionField[] | undefined;
|
|
412
614
|
/**
|
|
413
|
-
* <p>The
|
|
615
|
+
* <p>The aggregated <code>BarValues</code> field well of a combo chart.</p>
|
|
414
616
|
* @public
|
|
415
617
|
*/
|
|
416
|
-
|
|
618
|
+
BarValues?: MeasureField[] | undefined;
|
|
417
619
|
/**
|
|
418
|
-
* <p>
|
|
419
|
-
* <ul>
|
|
420
|
-
* <li>
|
|
421
|
-
* <p>
|
|
422
|
-
* <code>CLUSTERED</code>: For clustered bar combo charts.</p>
|
|
423
|
-
* </li>
|
|
424
|
-
* <li>
|
|
425
|
-
* <p>
|
|
426
|
-
* <code>STACKED</code>: For stacked bar combo charts.</p>
|
|
427
|
-
* </li>
|
|
428
|
-
* <li>
|
|
429
|
-
* <p>
|
|
430
|
-
* <code>STACKED_PERCENT</code>: Do not use. If you use this value, the operation returns a validation error.</p>
|
|
431
|
-
* </li>
|
|
432
|
-
* </ul>
|
|
620
|
+
* <p>The aggregated colors field well of a combo chart.</p>
|
|
433
621
|
* @public
|
|
434
622
|
*/
|
|
435
|
-
|
|
623
|
+
Colors?: DimensionField[] | undefined;
|
|
624
|
+
/**
|
|
625
|
+
* <p>The aggregated <code>LineValues</code> field well of a combo chart.</p>
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
LineValues?: MeasureField[] | undefined;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* <p>The field wells of the visual.</p>
|
|
632
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
633
|
+
* @public
|
|
634
|
+
*/
|
|
635
|
+
export interface ComboChartFieldWells {
|
|
636
|
+
/**
|
|
637
|
+
* <p>The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.</p>
|
|
638
|
+
* @public
|
|
639
|
+
*/
|
|
640
|
+
ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells | undefined;
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* <p>Options that determine the presentation of a series in the visual.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
export interface ComboChartSeriesSettings {
|
|
647
|
+
/**
|
|
648
|
+
* <p>Line styles options for the line series in the visual.</p>
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
LineStyleSettings?: LineChartLineStyleSettings | undefined;
|
|
652
|
+
/**
|
|
653
|
+
* <p>Marker styles options for the line series in the visual.</p>
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined;
|
|
657
|
+
/**
|
|
658
|
+
* <p>Decal settings for the series in the visual.</p>
|
|
659
|
+
* @public
|
|
660
|
+
*/
|
|
661
|
+
DecalSettings?: DecalSettings | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* <p>Border settings for the bar series in the visual.</p>
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
BorderSettings?: BorderSettings | undefined;
|
|
667
|
+
}
|
|
668
|
+
/**
|
|
669
|
+
* <p>The data field series item configuration of a <code>ComboChartVisual</code>.</p>
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
export interface DataFieldComboSeriesItem {
|
|
673
|
+
/**
|
|
674
|
+
* <p>Field ID of the field that you are setting the series configuration for.</p>
|
|
675
|
+
* @public
|
|
676
|
+
*/
|
|
677
|
+
FieldId: string | undefined;
|
|
678
|
+
/**
|
|
679
|
+
* <p>Field value of the field that you are setting the series configuration for.</p>
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
FieldValue?: string | undefined;
|
|
683
|
+
/**
|
|
684
|
+
* <p>Options that determine the presentation of series associated to the field.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
Settings?: ComboChartSeriesSettings | undefined;
|
|
688
|
+
}
|
|
689
|
+
/**
|
|
690
|
+
* <p>The field series item configuration of a <code>ComboChartVisual</code>.</p>
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
export interface FieldComboSeriesItem {
|
|
694
|
+
/**
|
|
695
|
+
* <p>Field ID of the field for which you are setting the series configuration.</p>
|
|
696
|
+
* @public
|
|
697
|
+
*/
|
|
698
|
+
FieldId: string | undefined;
|
|
699
|
+
/**
|
|
700
|
+
* <p>Options that determine the presentation of series associated to the field.</p>
|
|
701
|
+
* @public
|
|
702
|
+
*/
|
|
703
|
+
Settings?: ComboChartSeriesSettings | undefined;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* <p>The series item configuration of a <code>ComboChartVisual</code>.</p>
|
|
707
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
export interface ComboSeriesItem {
|
|
711
|
+
/**
|
|
712
|
+
* <p>The field series item configuration of a <code>ComboChartVisual</code>.</p>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
FieldComboSeriesItem?: FieldComboSeriesItem | undefined;
|
|
716
|
+
/**
|
|
717
|
+
* <p>The data field series item configuration of a <code>ComboChartVisual</code>.</p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
DataFieldComboSeriesItem?: DataFieldComboSeriesItem | undefined;
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* <p>The options that are available for a single Y axis in a chart.</p>
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
726
|
+
export interface YAxisOptions {
|
|
727
|
+
/**
|
|
728
|
+
* <p>The Y axis type to be used in the chart.</p>
|
|
729
|
+
* <p>If you choose <code>PRIMARY_Y_AXIS</code>, the primary Y Axis is located on the leftmost vertical axis of the chart.</p>
|
|
730
|
+
* @public
|
|
731
|
+
*/
|
|
732
|
+
YAxis: SingleYAxisOption | undefined;
|
|
733
|
+
}
|
|
734
|
+
/**
|
|
735
|
+
* <p>The settings of a chart's single axis configuration.</p>
|
|
736
|
+
* @public
|
|
737
|
+
*/
|
|
738
|
+
export interface SingleAxisOptions {
|
|
739
|
+
/**
|
|
740
|
+
* <p>The Y axis options of a single axis configuration.</p>
|
|
741
|
+
* @public
|
|
742
|
+
*/
|
|
743
|
+
YAxisOptions?: YAxisOptions | undefined;
|
|
744
|
+
}
|
|
745
|
+
/**
|
|
746
|
+
* <p>The sort configuration of a <code>ComboChartVisual</code>.</p>
|
|
747
|
+
* @public
|
|
748
|
+
*/
|
|
749
|
+
export interface ComboChartSortConfiguration {
|
|
750
|
+
/**
|
|
751
|
+
* <p>The sort configuration of the category field well in a combo chart.</p>
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
CategorySort?: FieldSortOptions[] | undefined;
|
|
755
|
+
/**
|
|
756
|
+
* <p>The item limit configuration for the category field well of a combo chart.</p>
|
|
757
|
+
* @public
|
|
758
|
+
*/
|
|
759
|
+
CategoryItemsLimit?: ItemsLimitConfiguration | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* <p>The sort configuration of the color field well in a combo chart.</p>
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
ColorSort?: FieldSortOptions[] | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* <p>The item limit configuration of the color field well in a combo chart.</p>
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
ColorItemsLimit?: ItemsLimitConfiguration | undefined;
|
|
770
|
+
}
|
|
771
|
+
/**
|
|
772
|
+
* <p>The configuration of a <code>ComboChartVisual</code>.</p>
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
775
|
+
export interface ComboChartConfiguration {
|
|
776
|
+
/**
|
|
777
|
+
* <p>The field wells of the visual.</p>
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
FieldWells?: ComboChartFieldWells | undefined;
|
|
781
|
+
/**
|
|
782
|
+
* <p>The sort configuration of a <code>ComboChartVisual</code>.</p>
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
SortConfiguration?: ComboChartSortConfiguration | undefined;
|
|
786
|
+
/**
|
|
787
|
+
* <p>Determines the bar arrangement in a combo chart. The following are valid values in this structure:</p>
|
|
788
|
+
* <ul>
|
|
789
|
+
* <li>
|
|
790
|
+
* <p>
|
|
791
|
+
* <code>CLUSTERED</code>: For clustered bar combo charts.</p>
|
|
792
|
+
* </li>
|
|
793
|
+
* <li>
|
|
794
|
+
* <p>
|
|
795
|
+
* <code>STACKED</code>: For stacked bar combo charts.</p>
|
|
796
|
+
* </li>
|
|
797
|
+
* <li>
|
|
798
|
+
* <p>
|
|
799
|
+
* <code>STACKED_PERCENT</code>: Do not use. If you use this value, the operation returns a validation error.</p>
|
|
800
|
+
* </li>
|
|
801
|
+
* </ul>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
BarsArrangement?: BarsArrangement | undefined;
|
|
436
805
|
/**
|
|
437
806
|
* <p>The category axis of a combo chart.</p>
|
|
438
807
|
* @public
|
|
@@ -473,6 +842,16 @@ export interface ComboChartConfiguration {
|
|
|
473
842
|
* @public
|
|
474
843
|
*/
|
|
475
844
|
ColorLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* <p>The options that determine the default presentation of all series in <code>ComboChartVisual</code>.</p>
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
DefaultSeriesSettings?: ComboChartDefaultSeriesSettings | undefined;
|
|
850
|
+
/**
|
|
851
|
+
* <p>The series item configuration of a <code>ComboChartVisual</code>.</p>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
Series?: ComboSeriesItem[] | undefined;
|
|
476
855
|
/**
|
|
477
856
|
* <p>The legend display setup of the visual.</p>
|
|
478
857
|
* @public
|
|
@@ -907,6 +1286,114 @@ export interface FilledMapConditionalFormatting {
|
|
|
907
1286
|
*/
|
|
908
1287
|
ConditionalFormattingOptions: FilledMapConditionalFormattingOption[] | undefined;
|
|
909
1288
|
}
|
|
1289
|
+
/**
|
|
1290
|
+
* <p>The preference coordinate for the geocode preference.</p>
|
|
1291
|
+
* @public
|
|
1292
|
+
*/
|
|
1293
|
+
export interface Coordinate {
|
|
1294
|
+
/**
|
|
1295
|
+
* <p>The latitude coordinate value for the geocode preference.</p>
|
|
1296
|
+
* @public
|
|
1297
|
+
*/
|
|
1298
|
+
Latitude: number | undefined;
|
|
1299
|
+
/**
|
|
1300
|
+
* <p>The longitude coordinate value for the geocode preference.</p>
|
|
1301
|
+
* @public
|
|
1302
|
+
*/
|
|
1303
|
+
Longitude: number | undefined;
|
|
1304
|
+
}
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>The preference hierarchy for the geocode preference.</p>
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
export interface GeocoderHierarchy {
|
|
1310
|
+
/**
|
|
1311
|
+
* <p>The country value for the preference hierarchy.</p>
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
Country?: string | undefined;
|
|
1315
|
+
/**
|
|
1316
|
+
* <p>The state/region value for the preference hierarchy.</p>
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
State?: string | undefined;
|
|
1320
|
+
/**
|
|
1321
|
+
* <p>The county/district value for the preference hierarchy.</p>
|
|
1322
|
+
* @public
|
|
1323
|
+
*/
|
|
1324
|
+
County?: string | undefined;
|
|
1325
|
+
/**
|
|
1326
|
+
* <p>The city value for the preference hierarchy.</p>
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
City?: string | undefined;
|
|
1330
|
+
/**
|
|
1331
|
+
* <p>The postcode value for the preference hierarchy.</p>
|
|
1332
|
+
* @public
|
|
1333
|
+
*/
|
|
1334
|
+
PostCode?: string | undefined;
|
|
1335
|
+
}
|
|
1336
|
+
/**
|
|
1337
|
+
* <p>The preference value for the geocode preference.</p>
|
|
1338
|
+
* @public
|
|
1339
|
+
*/
|
|
1340
|
+
export type GeocodePreferenceValue = GeocodePreferenceValue.CoordinateMember | GeocodePreferenceValue.GeocoderHierarchyMember | GeocodePreferenceValue.$UnknownMember;
|
|
1341
|
+
/**
|
|
1342
|
+
* @public
|
|
1343
|
+
*/
|
|
1344
|
+
export declare namespace GeocodePreferenceValue {
|
|
1345
|
+
/**
|
|
1346
|
+
* <p>The preference hierarchy for the geocode preference.</p>
|
|
1347
|
+
* @public
|
|
1348
|
+
*/
|
|
1349
|
+
interface GeocoderHierarchyMember {
|
|
1350
|
+
GeocoderHierarchy: GeocoderHierarchy;
|
|
1351
|
+
Coordinate?: never;
|
|
1352
|
+
$unknown?: never;
|
|
1353
|
+
}
|
|
1354
|
+
/**
|
|
1355
|
+
* <p>The preference coordinate for the geocode preference.</p>
|
|
1356
|
+
* @public
|
|
1357
|
+
*/
|
|
1358
|
+
interface CoordinateMember {
|
|
1359
|
+
GeocoderHierarchy?: never;
|
|
1360
|
+
Coordinate: Coordinate;
|
|
1361
|
+
$unknown?: never;
|
|
1362
|
+
}
|
|
1363
|
+
/**
|
|
1364
|
+
* @public
|
|
1365
|
+
*/
|
|
1366
|
+
interface $UnknownMember {
|
|
1367
|
+
GeocoderHierarchy?: never;
|
|
1368
|
+
Coordinate?: never;
|
|
1369
|
+
$unknown: [string, any];
|
|
1370
|
+
}
|
|
1371
|
+
/**
|
|
1372
|
+
* @deprecated unused in schema-serde mode.
|
|
1373
|
+
*
|
|
1374
|
+
*/
|
|
1375
|
+
interface Visitor<T> {
|
|
1376
|
+
GeocoderHierarchy: (value: GeocoderHierarchy) => T;
|
|
1377
|
+
Coordinate: (value: Coordinate) => T;
|
|
1378
|
+
_: (name: string, value: any) => T;
|
|
1379
|
+
}
|
|
1380
|
+
}
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>The geocode preference.</p>
|
|
1383
|
+
* @public
|
|
1384
|
+
*/
|
|
1385
|
+
export interface GeocodePreference {
|
|
1386
|
+
/**
|
|
1387
|
+
* <p>The unique request key for the geocode preference.</p>
|
|
1388
|
+
* @public
|
|
1389
|
+
*/
|
|
1390
|
+
RequestKey: GeocoderHierarchy | undefined;
|
|
1391
|
+
/**
|
|
1392
|
+
* <p>The preference definition for the geocode preference.</p>
|
|
1393
|
+
* @public
|
|
1394
|
+
*/
|
|
1395
|
+
Preference: GeocodePreferenceValue | undefined;
|
|
1396
|
+
}
|
|
910
1397
|
/**
|
|
911
1398
|
* <p>A filled map.</p>
|
|
912
1399
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html">Creating filled maps</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
@@ -953,6 +1440,11 @@ export interface FilledMapVisual {
|
|
|
953
1440
|
* @public
|
|
954
1441
|
*/
|
|
955
1442
|
VisualContentAltText?: string | undefined;
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>The geocoding prefences for filled map visual.</p>
|
|
1445
|
+
* @public
|
|
1446
|
+
*/
|
|
1447
|
+
GeocodingPreferences?: GeocodePreference[] | undefined;
|
|
956
1448
|
}
|
|
957
1449
|
/**
|
|
958
1450
|
* <p>The options that determine the presentation of the data labels.</p>
|
|
@@ -1719,6 +2211,11 @@ export interface GeospatialMapVisual {
|
|
|
1719
2211
|
* @public
|
|
1720
2212
|
*/
|
|
1721
2213
|
VisualContentAltText?: string | undefined;
|
|
2214
|
+
/**
|
|
2215
|
+
* <p>The geocoding prefences for geospatial map.</p>
|
|
2216
|
+
* @public
|
|
2217
|
+
*/
|
|
2218
|
+
GeocodingPreferences?: GeocodePreference[] | undefined;
|
|
1722
2219
|
}
|
|
1723
2220
|
/**
|
|
1724
2221
|
* <p>Determines the color that is applied to a particular data value.</p>
|
|
@@ -3557,127 +4054,30 @@ export interface LayerMapVisual {
|
|
|
3557
4054
|
VisualContentAltText?: string | undefined;
|
|
3558
4055
|
}
|
|
3559
4056
|
/**
|
|
3560
|
-
* <p>
|
|
4057
|
+
* <p>The options that determine the default presentation of all line series in <code>LineChartVisual</code>.</p>
|
|
3561
4058
|
* @public
|
|
3562
4059
|
*/
|
|
3563
|
-
export interface
|
|
4060
|
+
export interface LineChartDefaultSeriesSettings {
|
|
3564
4061
|
/**
|
|
3565
|
-
* <p>
|
|
4062
|
+
* <p>The axis to which you are binding all line series to.</p>
|
|
3566
4063
|
* @public
|
|
3567
4064
|
*/
|
|
3568
|
-
|
|
4065
|
+
AxisBinding?: AxisBinding | undefined;
|
|
3569
4066
|
/**
|
|
3570
|
-
* <p>
|
|
3571
|
-
* <ul>
|
|
3572
|
-
* <li>
|
|
3573
|
-
* <p>
|
|
3574
|
-
* <code>LINEAR</code>: Show as default, linear style.</p>
|
|
3575
|
-
* </li>
|
|
3576
|
-
* <li>
|
|
3577
|
-
* <p>
|
|
3578
|
-
* <code>SMOOTH</code>: Show as a smooth curve.</p>
|
|
3579
|
-
* </li>
|
|
3580
|
-
* <li>
|
|
3581
|
-
* <p>
|
|
3582
|
-
* <code>STEPPED</code>: Show steps in line.</p>
|
|
3583
|
-
* </li>
|
|
3584
|
-
* </ul>
|
|
4067
|
+
* <p>Line styles options for all line series in the visual.</p>
|
|
3585
4068
|
* @public
|
|
3586
4069
|
*/
|
|
3587
|
-
|
|
4070
|
+
LineStyleSettings?: LineChartLineStyleSettings | undefined;
|
|
3588
4071
|
/**
|
|
3589
|
-
* <p>
|
|
3590
|
-
* <ul>
|
|
3591
|
-
* <li>
|
|
3592
|
-
* <p>
|
|
3593
|
-
* <code>SOLID</code>: Show as a solid line.</p>
|
|
3594
|
-
* </li>
|
|
3595
|
-
* <li>
|
|
3596
|
-
* <p>
|
|
3597
|
-
* <code>DOTTED</code>: Show as a dotted line.</p>
|
|
3598
|
-
* </li>
|
|
3599
|
-
* <li>
|
|
3600
|
-
* <p>
|
|
3601
|
-
* <code>DASHED</code>: Show as a dashed line.</p>
|
|
3602
|
-
* </li>
|
|
3603
|
-
* </ul>
|
|
3604
|
-
* @public
|
|
3605
|
-
*/
|
|
3606
|
-
LineStyle?: LineChartLineStyle | undefined;
|
|
3607
|
-
/**
|
|
3608
|
-
* <p>Width that determines the line thickness.</p>
|
|
3609
|
-
* @public
|
|
3610
|
-
*/
|
|
3611
|
-
LineWidth?: string | undefined;
|
|
3612
|
-
}
|
|
3613
|
-
/**
|
|
3614
|
-
* <p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>
|
|
3615
|
-
* @public
|
|
3616
|
-
*/
|
|
3617
|
-
export interface LineChartMarkerStyleSettings {
|
|
3618
|
-
/**
|
|
3619
|
-
* <p>Configuration option that determines whether to show the markers in the series.</p>
|
|
3620
|
-
* @public
|
|
3621
|
-
*/
|
|
3622
|
-
MarkerVisibility?: Visibility | undefined;
|
|
3623
|
-
/**
|
|
3624
|
-
* <p>Shape option for markers in the series.</p>
|
|
3625
|
-
* <ul>
|
|
3626
|
-
* <li>
|
|
3627
|
-
* <p>
|
|
3628
|
-
* <code>CIRCLE</code>: Show marker as a circle.</p>
|
|
3629
|
-
* </li>
|
|
3630
|
-
* <li>
|
|
3631
|
-
* <p>
|
|
3632
|
-
* <code>TRIANGLE</code>: Show marker as a triangle.</p>
|
|
3633
|
-
* </li>
|
|
3634
|
-
* <li>
|
|
3635
|
-
* <p>
|
|
3636
|
-
* <code>SQUARE</code>: Show marker as a square.</p>
|
|
3637
|
-
* </li>
|
|
3638
|
-
* <li>
|
|
3639
|
-
* <p>
|
|
3640
|
-
* <code>DIAMOND</code>: Show marker as a diamond.</p>
|
|
3641
|
-
* </li>
|
|
3642
|
-
* <li>
|
|
3643
|
-
* <p>
|
|
3644
|
-
* <code>ROUNDED_SQUARE</code>: Show marker as a rounded square.</p>
|
|
3645
|
-
* </li>
|
|
3646
|
-
* </ul>
|
|
3647
|
-
* @public
|
|
3648
|
-
*/
|
|
3649
|
-
MarkerShape?: LineChartMarkerShape | undefined;
|
|
3650
|
-
/**
|
|
3651
|
-
* <p>Size of marker in the series.</p>
|
|
3652
|
-
* @public
|
|
3653
|
-
*/
|
|
3654
|
-
MarkerSize?: string | undefined;
|
|
3655
|
-
/**
|
|
3656
|
-
* <p>Color of marker in the series.</p>
|
|
3657
|
-
* @public
|
|
3658
|
-
*/
|
|
3659
|
-
MarkerColor?: string | undefined;
|
|
3660
|
-
}
|
|
3661
|
-
/**
|
|
3662
|
-
* <p>The options that determine the default presentation of all line series in <code>LineChartVisual</code>.</p>
|
|
3663
|
-
* @public
|
|
3664
|
-
*/
|
|
3665
|
-
export interface LineChartDefaultSeriesSettings {
|
|
3666
|
-
/**
|
|
3667
|
-
* <p>The axis to which you are binding all line series to.</p>
|
|
3668
|
-
* @public
|
|
3669
|
-
*/
|
|
3670
|
-
AxisBinding?: AxisBinding | undefined;
|
|
3671
|
-
/**
|
|
3672
|
-
* <p>Line styles options for all line series in the visual.</p>
|
|
4072
|
+
* <p>Marker styles options for all line series in the visual.</p>
|
|
3673
4073
|
* @public
|
|
3674
4074
|
*/
|
|
3675
|
-
|
|
4075
|
+
MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined;
|
|
3676
4076
|
/**
|
|
3677
|
-
* <p>
|
|
4077
|
+
* <p>Decal settings options for all line series in the visual.</p>
|
|
3678
4078
|
* @public
|
|
3679
4079
|
*/
|
|
3680
|
-
|
|
4080
|
+
DecalSettings?: DecalSettings | undefined;
|
|
3681
4081
|
}
|
|
3682
4082
|
/**
|
|
3683
4083
|
* <p>The field well configuration of a line chart.</p>
|
|
@@ -3889,6 +4289,11 @@ export interface LineChartSeriesSettings {
|
|
|
3889
4289
|
* @public
|
|
3890
4290
|
*/
|
|
3891
4291
|
MarkerStyleSettings?: LineChartMarkerStyleSettings | undefined;
|
|
4292
|
+
/**
|
|
4293
|
+
* <p>Decal settings for a line series in <code>LineChartVisual</code>.</p>
|
|
4294
|
+
* @public
|
|
4295
|
+
*/
|
|
4296
|
+
DecalSettings?: DecalSettings | undefined;
|
|
3892
4297
|
}
|
|
3893
4298
|
/**
|
|
3894
4299
|
* <p>The data field series item configuration of a line chart.</p>
|
|
@@ -4372,6 +4777,33 @@ export interface PieChartVisual {
|
|
|
4372
4777
|
*/
|
|
4373
4778
|
VisualContentAltText?: string | undefined;
|
|
4374
4779
|
}
|
|
4780
|
+
/**
|
|
4781
|
+
* <p>The configuration that controls field customization options available to dashboard readers for a visual.</p>
|
|
4782
|
+
* @public
|
|
4783
|
+
*/
|
|
4784
|
+
export interface VisualCustomizationFieldsConfiguration {
|
|
4785
|
+
/**
|
|
4786
|
+
* <p>Specifies whether dashboard readers can customize fields for this visual. This option is <code>ENABLED</code> by default.</p>
|
|
4787
|
+
* @public
|
|
4788
|
+
*/
|
|
4789
|
+
Status?: DashboardCustomizationStatus | undefined;
|
|
4790
|
+
/**
|
|
4791
|
+
* <p>The additional dataset fields available for dashboard readers to customize the visual with, beyond the fields already configured on the visual.</p>
|
|
4792
|
+
* @public
|
|
4793
|
+
*/
|
|
4794
|
+
AdditionalFields?: ColumnIdentifier[] | undefined;
|
|
4795
|
+
}
|
|
4796
|
+
/**
|
|
4797
|
+
* <p>The options that define customizations available to dashboard readers for a specific visual</p>
|
|
4798
|
+
* @public
|
|
4799
|
+
*/
|
|
4800
|
+
export interface DashboardCustomizationVisualOptions {
|
|
4801
|
+
/**
|
|
4802
|
+
* <p>The configuration that controls field customization options available to dashboard readers for a visual.</p>
|
|
4803
|
+
* @public
|
|
4804
|
+
*/
|
|
4805
|
+
FieldsConfiguration?: VisualCustomizationFieldsConfiguration | undefined;
|
|
4806
|
+
}
|
|
4375
4807
|
/**
|
|
4376
4808
|
* <p>The target of a pivot table field collapse state.</p>
|
|
4377
4809
|
* @public
|
|
@@ -5026,6 +5458,11 @@ export interface PivotTableConfiguration {
|
|
|
5026
5458
|
* @public
|
|
5027
5459
|
*/
|
|
5028
5460
|
PaginatedReportOptions?: PivotTablePaginatedReportOptions | undefined;
|
|
5461
|
+
/**
|
|
5462
|
+
* <p>The options that define customizations available to dashboard readers for a specific visual</p>
|
|
5463
|
+
* @public
|
|
5464
|
+
*/
|
|
5465
|
+
DashboardCustomizationVisualOptions?: DashboardCustomizationVisualOptions | undefined;
|
|
5029
5466
|
/**
|
|
5030
5467
|
* <p>The general visual interactions setup for a visual.</p>
|
|
5031
5468
|
* @public
|
|
@@ -6237,6 +6674,11 @@ export interface TableConfiguration {
|
|
|
6237
6674
|
* @public
|
|
6238
6675
|
*/
|
|
6239
6676
|
TableInlineVisualizations?: TableInlineVisualization[] | undefined;
|
|
6677
|
+
/**
|
|
6678
|
+
* <p>The options that define customizations available to dashboard readers for a specific visual</p>
|
|
6679
|
+
* @public
|
|
6680
|
+
*/
|
|
6681
|
+
DashboardCustomizationVisualOptions?: DashboardCustomizationVisualOptions | undefined;
|
|
6240
6682
|
/**
|
|
6241
6683
|
* <p>The general visual interactions setup for a visual.</p>
|
|
6242
6684
|
* @public
|
|
@@ -6770,652 +7212,3 @@ export interface WordCloudOptions {
|
|
|
6770
7212
|
*/
|
|
6771
7213
|
MaximumStringLength?: number | undefined;
|
|
6772
7214
|
}
|
|
6773
|
-
/**
|
|
6774
|
-
* <p>The configuration of a word cloud visual.</p>
|
|
6775
|
-
* @public
|
|
6776
|
-
*/
|
|
6777
|
-
export interface WordCloudChartConfiguration {
|
|
6778
|
-
/**
|
|
6779
|
-
* <p>The field wells of the visual.</p>
|
|
6780
|
-
* @public
|
|
6781
|
-
*/
|
|
6782
|
-
FieldWells?: WordCloudFieldWells | undefined;
|
|
6783
|
-
/**
|
|
6784
|
-
* <p>The sort configuration of a word cloud visual.</p>
|
|
6785
|
-
* @public
|
|
6786
|
-
*/
|
|
6787
|
-
SortConfiguration?: WordCloudSortConfiguration | undefined;
|
|
6788
|
-
/**
|
|
6789
|
-
* <p>The label options (label text, label visibility, and sort icon visibility) for the word cloud category.</p>
|
|
6790
|
-
* @public
|
|
6791
|
-
*/
|
|
6792
|
-
CategoryLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
6793
|
-
/**
|
|
6794
|
-
* <p>The options for a word cloud visual.</p>
|
|
6795
|
-
* @public
|
|
6796
|
-
*/
|
|
6797
|
-
WordCloudOptions?: WordCloudOptions | undefined;
|
|
6798
|
-
/**
|
|
6799
|
-
* <p>The general visual interactions setup for a visual.</p>
|
|
6800
|
-
* @public
|
|
6801
|
-
*/
|
|
6802
|
-
Interactions?: VisualInteractionOptions | undefined;
|
|
6803
|
-
}
|
|
6804
|
-
/**
|
|
6805
|
-
* <p>A word cloud.</p>
|
|
6806
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html">Using word clouds</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6807
|
-
* @public
|
|
6808
|
-
*/
|
|
6809
|
-
export interface WordCloudVisual {
|
|
6810
|
-
/**
|
|
6811
|
-
* <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>
|
|
6812
|
-
* @public
|
|
6813
|
-
*/
|
|
6814
|
-
VisualId: string | undefined;
|
|
6815
|
-
/**
|
|
6816
|
-
* <p>The title that is displayed on the visual.</p>
|
|
6817
|
-
* @public
|
|
6818
|
-
*/
|
|
6819
|
-
Title?: VisualTitleLabelOptions | undefined;
|
|
6820
|
-
/**
|
|
6821
|
-
* <p>The subtitle that is displayed on the visual.</p>
|
|
6822
|
-
* @public
|
|
6823
|
-
*/
|
|
6824
|
-
Subtitle?: VisualSubtitleLabelOptions | undefined;
|
|
6825
|
-
/**
|
|
6826
|
-
* <p>The configuration settings of the visual.</p>
|
|
6827
|
-
* @public
|
|
6828
|
-
*/
|
|
6829
|
-
ChartConfiguration?: WordCloudChartConfiguration | undefined;
|
|
6830
|
-
/**
|
|
6831
|
-
* <p>The list of custom actions that are configured for a visual.</p>
|
|
6832
|
-
* @public
|
|
6833
|
-
*/
|
|
6834
|
-
Actions?: VisualCustomAction[] | undefined;
|
|
6835
|
-
/**
|
|
6836
|
-
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
6837
|
-
* @public
|
|
6838
|
-
*/
|
|
6839
|
-
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
6840
|
-
/**
|
|
6841
|
-
* <p>The alt text for the visual.</p>
|
|
6842
|
-
* @public
|
|
6843
|
-
*/
|
|
6844
|
-
VisualContentAltText?: string | undefined;
|
|
6845
|
-
}
|
|
6846
|
-
/**
|
|
6847
|
-
* <p>A visual displayed on a sheet in an analysis, dashboard, or template.</p>
|
|
6848
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
6849
|
-
* @public
|
|
6850
|
-
*/
|
|
6851
|
-
export interface Visual {
|
|
6852
|
-
/**
|
|
6853
|
-
* <p>A table visual.</p>
|
|
6854
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/tabular.html">Using tables as visuals</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6855
|
-
* @public
|
|
6856
|
-
*/
|
|
6857
|
-
TableVisual?: TableVisual | undefined;
|
|
6858
|
-
/**
|
|
6859
|
-
* <p>A pivot table.</p>
|
|
6860
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html">Using pivot tables</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6861
|
-
* @public
|
|
6862
|
-
*/
|
|
6863
|
-
PivotTableVisual?: PivotTableVisual | undefined;
|
|
6864
|
-
/**
|
|
6865
|
-
* <p>A bar chart.</p>
|
|
6866
|
-
* <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 Quick Suite User Guide</i>.</p>
|
|
6867
|
-
* @public
|
|
6868
|
-
*/
|
|
6869
|
-
BarChartVisual?: BarChartVisual | undefined;
|
|
6870
|
-
/**
|
|
6871
|
-
* <p>A key performance indicator (KPI).</p>
|
|
6872
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/kpi.html">Using KPIs</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6873
|
-
* @public
|
|
6874
|
-
*/
|
|
6875
|
-
KPIVisual?: KPIVisual | undefined;
|
|
6876
|
-
/**
|
|
6877
|
-
* <p>A pie or donut chart.</p>
|
|
6878
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html">Using pie charts</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6879
|
-
* @public
|
|
6880
|
-
*/
|
|
6881
|
-
PieChartVisual?: PieChartVisual | undefined;
|
|
6882
|
-
/**
|
|
6883
|
-
* <p>A gauge chart.</p>
|
|
6884
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html">Using gauge charts</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6885
|
-
* @public
|
|
6886
|
-
*/
|
|
6887
|
-
GaugeChartVisual?: GaugeChartVisual | undefined;
|
|
6888
|
-
/**
|
|
6889
|
-
* <p>A line chart.</p>
|
|
6890
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html">Using line charts</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6891
|
-
* @public
|
|
6892
|
-
*/
|
|
6893
|
-
LineChartVisual?: LineChartVisual | undefined;
|
|
6894
|
-
/**
|
|
6895
|
-
* <p>A heat map.</p>
|
|
6896
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html">Using heat maps</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6897
|
-
* @public
|
|
6898
|
-
*/
|
|
6899
|
-
HeatMapVisual?: HeatMapVisual | undefined;
|
|
6900
|
-
/**
|
|
6901
|
-
* <p>A tree map.</p>
|
|
6902
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html">Using tree maps</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6903
|
-
* @public
|
|
6904
|
-
*/
|
|
6905
|
-
TreeMapVisual?: TreeMapVisual | undefined;
|
|
6906
|
-
/**
|
|
6907
|
-
* <p>A geospatial map or a points on map visual.</p>
|
|
6908
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html">Creating point maps</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6909
|
-
* @public
|
|
6910
|
-
*/
|
|
6911
|
-
GeospatialMapVisual?: GeospatialMapVisual | undefined;
|
|
6912
|
-
/**
|
|
6913
|
-
* <p>A filled map.</p>
|
|
6914
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html">Creating filled maps</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6915
|
-
* @public
|
|
6916
|
-
*/
|
|
6917
|
-
FilledMapVisual?: FilledMapVisual | undefined;
|
|
6918
|
-
/**
|
|
6919
|
-
* <p>The properties for a layer map visual</p>
|
|
6920
|
-
* @public
|
|
6921
|
-
*/
|
|
6922
|
-
LayerMapVisual?: LayerMapVisual | undefined;
|
|
6923
|
-
/**
|
|
6924
|
-
* <p>A funnel chart.</p>
|
|
6925
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html">Using funnel charts</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6926
|
-
* @public
|
|
6927
|
-
*/
|
|
6928
|
-
FunnelChartVisual?: FunnelChartVisual | undefined;
|
|
6929
|
-
/**
|
|
6930
|
-
* <p>A scatter plot.</p>
|
|
6931
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html">Using scatter plots</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6932
|
-
* @public
|
|
6933
|
-
*/
|
|
6934
|
-
ScatterPlotVisual?: ScatterPlotVisual | undefined;
|
|
6935
|
-
/**
|
|
6936
|
-
* <p>A combo chart.</p>
|
|
6937
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html">Using combo charts</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6938
|
-
* @public
|
|
6939
|
-
*/
|
|
6940
|
-
ComboChartVisual?: ComboChartVisual | undefined;
|
|
6941
|
-
/**
|
|
6942
|
-
* <p>A box plot.</p>
|
|
6943
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html">Using box plots</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6944
|
-
* @public
|
|
6945
|
-
*/
|
|
6946
|
-
BoxPlotVisual?: BoxPlotVisual | undefined;
|
|
6947
|
-
/**
|
|
6948
|
-
* <p>A waterfall chart.</p>
|
|
6949
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html">Using waterfall charts</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6950
|
-
* @public
|
|
6951
|
-
*/
|
|
6952
|
-
WaterfallVisual?: WaterfallVisual | undefined;
|
|
6953
|
-
/**
|
|
6954
|
-
* <p>A histogram.</p>
|
|
6955
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html">Using histograms</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6956
|
-
* @public
|
|
6957
|
-
*/
|
|
6958
|
-
HistogramVisual?: HistogramVisual | undefined;
|
|
6959
|
-
/**
|
|
6960
|
-
* <p>A word cloud.</p>
|
|
6961
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html">Using word clouds</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6962
|
-
* @public
|
|
6963
|
-
*/
|
|
6964
|
-
WordCloudVisual?: WordCloudVisual | undefined;
|
|
6965
|
-
/**
|
|
6966
|
-
* <p>An insight visual.</p>
|
|
6967
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html">Working with insights</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6968
|
-
* @public
|
|
6969
|
-
*/
|
|
6970
|
-
InsightVisual?: InsightVisual | undefined;
|
|
6971
|
-
/**
|
|
6972
|
-
* <p>A sankey diagram.</p>
|
|
6973
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html">Using Sankey diagrams</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6974
|
-
* @public
|
|
6975
|
-
*/
|
|
6976
|
-
SankeyDiagramVisual?: SankeyDiagramVisual | undefined;
|
|
6977
|
-
/**
|
|
6978
|
-
* <p>A visual that contains custom content.</p>
|
|
6979
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html">Using custom visual content</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6980
|
-
* @public
|
|
6981
|
-
*/
|
|
6982
|
-
CustomContentVisual?: CustomContentVisual | undefined;
|
|
6983
|
-
/**
|
|
6984
|
-
* <p>An empty visual.</p>
|
|
6985
|
-
* @public
|
|
6986
|
-
*/
|
|
6987
|
-
EmptyVisual?: EmptyVisual | undefined;
|
|
6988
|
-
/**
|
|
6989
|
-
* <p>A radar chart visual.</p>
|
|
6990
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html">Using radar charts</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
6991
|
-
* @public
|
|
6992
|
-
*/
|
|
6993
|
-
RadarChartVisual?: RadarChartVisual | undefined;
|
|
6994
|
-
/**
|
|
6995
|
-
* <p>The custom plugin visual type.</p>
|
|
6996
|
-
* @public
|
|
6997
|
-
*/
|
|
6998
|
-
PluginVisual?: PluginVisual | undefined;
|
|
6999
|
-
}
|
|
7000
|
-
/**
|
|
7001
|
-
* <p>A sheet is an object that contains a set of visuals that
|
|
7002
|
-
* are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.</p>
|
|
7003
|
-
* @public
|
|
7004
|
-
*/
|
|
7005
|
-
export interface SheetDefinition {
|
|
7006
|
-
/**
|
|
7007
|
-
* <p>The unique identifier of a sheet.</p>
|
|
7008
|
-
* @public
|
|
7009
|
-
*/
|
|
7010
|
-
SheetId: string | undefined;
|
|
7011
|
-
/**
|
|
7012
|
-
* <p>The title of the sheet.</p>
|
|
7013
|
-
* @public
|
|
7014
|
-
*/
|
|
7015
|
-
Title?: string | undefined;
|
|
7016
|
-
/**
|
|
7017
|
-
* <p>A description of the sheet.</p>
|
|
7018
|
-
* @public
|
|
7019
|
-
*/
|
|
7020
|
-
Description?: string | undefined;
|
|
7021
|
-
/**
|
|
7022
|
-
* <p>The name of the sheet. This name is displayed on the sheet's tab in the Quick Suite
|
|
7023
|
-
* console.</p>
|
|
7024
|
-
* @public
|
|
7025
|
-
*/
|
|
7026
|
-
Name?: string | undefined;
|
|
7027
|
-
/**
|
|
7028
|
-
* <p>The list of parameter controls that are on a sheet.</p>
|
|
7029
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html">Using a Control with a Parameter in Amazon Quick Sight</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
7030
|
-
* @public
|
|
7031
|
-
*/
|
|
7032
|
-
ParameterControls?: ParameterControl[] | undefined;
|
|
7033
|
-
/**
|
|
7034
|
-
* <p>The list of filter controls that are on a sheet.</p>
|
|
7035
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html">Adding filter controls to analysis sheets</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
7036
|
-
* @public
|
|
7037
|
-
*/
|
|
7038
|
-
FilterControls?: FilterControl[] | undefined;
|
|
7039
|
-
/**
|
|
7040
|
-
* <p>A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.</p>
|
|
7041
|
-
* @public
|
|
7042
|
-
*/
|
|
7043
|
-
Visuals?: Visual[] | undefined;
|
|
7044
|
-
/**
|
|
7045
|
-
* <p>The text boxes that are on a sheet.</p>
|
|
7046
|
-
* @public
|
|
7047
|
-
*/
|
|
7048
|
-
TextBoxes?: SheetTextBox[] | undefined;
|
|
7049
|
-
/**
|
|
7050
|
-
* <p>A list of images on a sheet.</p>
|
|
7051
|
-
* @public
|
|
7052
|
-
*/
|
|
7053
|
-
Images?: SheetImage[] | undefined;
|
|
7054
|
-
/**
|
|
7055
|
-
* <p>Layouts define how the components of a sheet are arranged.</p>
|
|
7056
|
-
* <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>
|
|
7057
|
-
* @public
|
|
7058
|
-
*/
|
|
7059
|
-
Layouts?: Layout[] | undefined;
|
|
7060
|
-
/**
|
|
7061
|
-
* <p>The control layouts of the sheet.</p>
|
|
7062
|
-
* @public
|
|
7063
|
-
*/
|
|
7064
|
-
SheetControlLayouts?: SheetControlLayout[] | undefined;
|
|
7065
|
-
/**
|
|
7066
|
-
* <p>The layout content type of the sheet. Choose one of the following options:</p>
|
|
7067
|
-
* <ul>
|
|
7068
|
-
* <li>
|
|
7069
|
-
* <p>
|
|
7070
|
-
* <code>PAGINATED</code>: Creates a sheet for a paginated report.</p>
|
|
7071
|
-
* </li>
|
|
7072
|
-
* <li>
|
|
7073
|
-
* <p>
|
|
7074
|
-
* <code>INTERACTIVE</code>: Creates a sheet for an interactive dashboard.</p>
|
|
7075
|
-
* </li>
|
|
7076
|
-
* </ul>
|
|
7077
|
-
* @public
|
|
7078
|
-
*/
|
|
7079
|
-
ContentType?: SheetContentType | undefined;
|
|
7080
|
-
/**
|
|
7081
|
-
* <p>A list of visual custom actions for the sheet.</p>
|
|
7082
|
-
* @public
|
|
7083
|
-
*/
|
|
7084
|
-
CustomActionDefaults?: VisualCustomActionDefaults | undefined;
|
|
7085
|
-
}
|
|
7086
|
-
/**
|
|
7087
|
-
* <p>The structure that contains the Amazon S3 location to download the static file from.</p>
|
|
7088
|
-
* @public
|
|
7089
|
-
*/
|
|
7090
|
-
export interface StaticFileS3SourceOptions {
|
|
7091
|
-
/**
|
|
7092
|
-
* <p>The name of the Amazon S3 bucket.</p>
|
|
7093
|
-
* @public
|
|
7094
|
-
*/
|
|
7095
|
-
BucketName: string | undefined;
|
|
7096
|
-
/**
|
|
7097
|
-
* <p>The identifier of the static file in the Amazon S3 bucket.</p>
|
|
7098
|
-
* @public
|
|
7099
|
-
*/
|
|
7100
|
-
ObjectKey: string | undefined;
|
|
7101
|
-
/**
|
|
7102
|
-
* <p>The Region of the Amazon S3 account that contains the bucket.</p>
|
|
7103
|
-
* @public
|
|
7104
|
-
*/
|
|
7105
|
-
Region: string | undefined;
|
|
7106
|
-
}
|
|
7107
|
-
/**
|
|
7108
|
-
* <p>The structure that contains the URL to download the static file from.</p>
|
|
7109
|
-
* @public
|
|
7110
|
-
*/
|
|
7111
|
-
export interface StaticFileUrlSourceOptions {
|
|
7112
|
-
/**
|
|
7113
|
-
* <p>The URL to download the static file from.</p>
|
|
7114
|
-
* @public
|
|
7115
|
-
*/
|
|
7116
|
-
Url: string | undefined;
|
|
7117
|
-
}
|
|
7118
|
-
/**
|
|
7119
|
-
* <p>The source of the static file.</p>
|
|
7120
|
-
* @public
|
|
7121
|
-
*/
|
|
7122
|
-
export interface StaticFileSource {
|
|
7123
|
-
/**
|
|
7124
|
-
* <p>The structure that contains the URL to download the static file from.</p>
|
|
7125
|
-
* @public
|
|
7126
|
-
*/
|
|
7127
|
-
UrlOptions?: StaticFileUrlSourceOptions | undefined;
|
|
7128
|
-
/**
|
|
7129
|
-
* <p>The structure that contains the Amazon S3 location to download the static file from.</p>
|
|
7130
|
-
* @public
|
|
7131
|
-
*/
|
|
7132
|
-
S3Options?: StaticFileS3SourceOptions | undefined;
|
|
7133
|
-
}
|
|
7134
|
-
/**
|
|
7135
|
-
* <p>A static file that contains an image.</p>
|
|
7136
|
-
* @public
|
|
7137
|
-
*/
|
|
7138
|
-
export interface ImageStaticFile {
|
|
7139
|
-
/**
|
|
7140
|
-
* <p>The ID of the static file that contains an image.</p>
|
|
7141
|
-
* @public
|
|
7142
|
-
*/
|
|
7143
|
-
StaticFileId: string | undefined;
|
|
7144
|
-
/**
|
|
7145
|
-
* <p>The source of the image static file.</p>
|
|
7146
|
-
* @public
|
|
7147
|
-
*/
|
|
7148
|
-
Source?: StaticFileSource | undefined;
|
|
7149
|
-
}
|
|
7150
|
-
/**
|
|
7151
|
-
* <p>A static file that contains the geospatial data.</p>
|
|
7152
|
-
* @public
|
|
7153
|
-
*/
|
|
7154
|
-
export interface SpatialStaticFile {
|
|
7155
|
-
/**
|
|
7156
|
-
* <p>The ID of the spatial static file.</p>
|
|
7157
|
-
* @public
|
|
7158
|
-
*/
|
|
7159
|
-
StaticFileId: string | undefined;
|
|
7160
|
-
/**
|
|
7161
|
-
* <p>The source of the spatial static file.</p>
|
|
7162
|
-
* @public
|
|
7163
|
-
*/
|
|
7164
|
-
Source?: StaticFileSource | undefined;
|
|
7165
|
-
}
|
|
7166
|
-
/**
|
|
7167
|
-
* <p>The static file.</p>
|
|
7168
|
-
* @public
|
|
7169
|
-
*/
|
|
7170
|
-
export interface StaticFile {
|
|
7171
|
-
/**
|
|
7172
|
-
* <p>The image static file.</p>
|
|
7173
|
-
* @public
|
|
7174
|
-
*/
|
|
7175
|
-
ImageStaticFile?: ImageStaticFile | undefined;
|
|
7176
|
-
/**
|
|
7177
|
-
* <p>The spacial static file.</p>
|
|
7178
|
-
* @public
|
|
7179
|
-
*/
|
|
7180
|
-
SpatialStaticFile?: SpatialStaticFile | undefined;
|
|
7181
|
-
}
|
|
7182
|
-
/**
|
|
7183
|
-
* <p>The definition of an analysis.</p>
|
|
7184
|
-
* @public
|
|
7185
|
-
*/
|
|
7186
|
-
export interface AnalysisDefinition {
|
|
7187
|
-
/**
|
|
7188
|
-
* <p>An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead
|
|
7189
|
-
* of dataset ARNs throughout analysis sub-structures.</p>
|
|
7190
|
-
* @public
|
|
7191
|
-
*/
|
|
7192
|
-
DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined;
|
|
7193
|
-
/**
|
|
7194
|
-
* <p>An array of sheet definitions for an analysis. Each <code>SheetDefinition</code> provides detailed information about
|
|
7195
|
-
* a sheet within this analysis.</p>
|
|
7196
|
-
* @public
|
|
7197
|
-
*/
|
|
7198
|
-
Sheets?: SheetDefinition[] | undefined;
|
|
7199
|
-
/**
|
|
7200
|
-
* <p>An array of calculated field definitions for the analysis.</p>
|
|
7201
|
-
* @public
|
|
7202
|
-
*/
|
|
7203
|
-
CalculatedFields?: CalculatedField[] | undefined;
|
|
7204
|
-
/**
|
|
7205
|
-
* <p>An array of parameter declarations for an analysis.</p>
|
|
7206
|
-
* <p>Parameters are named variables that can transfer a value for use by an action or an object.</p>
|
|
7207
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon Quick Sight</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
7208
|
-
* @public
|
|
7209
|
-
*/
|
|
7210
|
-
ParameterDeclarations?: ParameterDeclaration[] | undefined;
|
|
7211
|
-
/**
|
|
7212
|
-
* <p>Filter definitions for an analysis.</p>
|
|
7213
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon Quick Sight</a> in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
7214
|
-
* @public
|
|
7215
|
-
*/
|
|
7216
|
-
FilterGroups?: FilterGroup[] | undefined;
|
|
7217
|
-
/**
|
|
7218
|
-
* <p>
|
|
7219
|
-
* An array of analysis-level column configurations. Column configurations can be used to set default
|
|
7220
|
-
* formatting for a column to be used throughout an analysis.
|
|
7221
|
-
* </p>
|
|
7222
|
-
* @public
|
|
7223
|
-
*/
|
|
7224
|
-
ColumnConfigurations?: ColumnConfiguration[] | undefined;
|
|
7225
|
-
/**
|
|
7226
|
-
* <p>The configuration for default analysis settings.</p>
|
|
7227
|
-
* @public
|
|
7228
|
-
*/
|
|
7229
|
-
AnalysisDefaults?: AnalysisDefaults | undefined;
|
|
7230
|
-
/**
|
|
7231
|
-
* <p>An array of option definitions for an analysis.</p>
|
|
7232
|
-
* @public
|
|
7233
|
-
*/
|
|
7234
|
-
Options?: AssetOptions | undefined;
|
|
7235
|
-
/**
|
|
7236
|
-
* <p>A structure that describes the query execution options.</p>
|
|
7237
|
-
* @public
|
|
7238
|
-
*/
|
|
7239
|
-
QueryExecutionOptions?: QueryExecutionOptions | undefined;
|
|
7240
|
-
/**
|
|
7241
|
-
* <p>The static files for the definition.</p>
|
|
7242
|
-
* @public
|
|
7243
|
-
*/
|
|
7244
|
-
StaticFiles?: StaticFile[] | undefined;
|
|
7245
|
-
}
|
|
7246
|
-
/**
|
|
7247
|
-
* <p>A filter that you apply when searching for one or more analyses.</p>
|
|
7248
|
-
* @public
|
|
7249
|
-
*/
|
|
7250
|
-
export interface AnalysisSearchFilter {
|
|
7251
|
-
/**
|
|
7252
|
-
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator": "StringEquals"</code>. Valid values are <code>"StringEquals"</code> and <code>"StringLike"</code>.</p>
|
|
7253
|
-
* <p>If you set the operator value to <code>"StringEquals"</code>, you need to provide an ownership related filter in the <code>"NAME"</code> field and the arn of the user or group whose folders you want to search in the <code>"Value"</code> field. For example, <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
7254
|
-
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the folders you are searching for. For example, <code>"Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>ANALYSIS_NAME</code>.</p>
|
|
7255
|
-
* @public
|
|
7256
|
-
*/
|
|
7257
|
-
Operator?: FilterOperator | undefined;
|
|
7258
|
-
/**
|
|
7259
|
-
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
7260
|
-
* "QUICKSIGHT_OWNER"</code>.</p>
|
|
7261
|
-
* <p>Valid values are defined as follows:</p>
|
|
7262
|
-
* <ul>
|
|
7263
|
-
* <li>
|
|
7264
|
-
* <p>
|
|
7265
|
-
* <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered. </p>
|
|
7266
|
-
* </li>
|
|
7267
|
-
* <li>
|
|
7268
|
-
* <p>
|
|
7269
|
-
* <code>QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.</p>
|
|
7270
|
-
* </li>
|
|
7271
|
-
* <li>
|
|
7272
|
-
* <p>
|
|
7273
|
-
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
7274
|
-
* </li>
|
|
7275
|
-
* <li>
|
|
7276
|
-
* <p>
|
|
7277
|
-
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
7278
|
-
* </li>
|
|
7279
|
-
* <li>
|
|
7280
|
-
* <p>
|
|
7281
|
-
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. </p>
|
|
7282
|
-
* </li>
|
|
7283
|
-
* <li>
|
|
7284
|
-
* <p>
|
|
7285
|
-
* <code>ANALYSIS_NAME</code>: Any analyses whose names have a substring match to this value will be returned.</p>
|
|
7286
|
-
* </li>
|
|
7287
|
-
* </ul>
|
|
7288
|
-
* @public
|
|
7289
|
-
*/
|
|
7290
|
-
Name?: AnalysisFilterAttribute | undefined;
|
|
7291
|
-
/**
|
|
7292
|
-
* <p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want
|
|
7293
|
-
* to use as a filter, for example <code>"Value"</code>. An example is
|
|
7294
|
-
* <code>"arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
7295
|
-
* @public
|
|
7296
|
-
*/
|
|
7297
|
-
Value?: string | undefined;
|
|
7298
|
-
}
|
|
7299
|
-
/**
|
|
7300
|
-
* <p>Dataset reference.</p>
|
|
7301
|
-
* @public
|
|
7302
|
-
*/
|
|
7303
|
-
export interface DataSetReference {
|
|
7304
|
-
/**
|
|
7305
|
-
* <p>Dataset placeholder.</p>
|
|
7306
|
-
* @public
|
|
7307
|
-
*/
|
|
7308
|
-
DataSetPlaceholder: string | undefined;
|
|
7309
|
-
/**
|
|
7310
|
-
* <p>Dataset Amazon Resource Name (ARN).</p>
|
|
7311
|
-
* @public
|
|
7312
|
-
*/
|
|
7313
|
-
DataSetArn: string | undefined;
|
|
7314
|
-
}
|
|
7315
|
-
/**
|
|
7316
|
-
* <p>The source template of an analysis.</p>
|
|
7317
|
-
* @public
|
|
7318
|
-
*/
|
|
7319
|
-
export interface AnalysisSourceTemplate {
|
|
7320
|
-
/**
|
|
7321
|
-
* <p>The dataset references of the source template of an analysis.</p>
|
|
7322
|
-
* @public
|
|
7323
|
-
*/
|
|
7324
|
-
DataSetReferences: DataSetReference[] | undefined;
|
|
7325
|
-
/**
|
|
7326
|
-
* <p>The Amazon Resource Name (ARN) of the source template of an analysis.</p>
|
|
7327
|
-
* @public
|
|
7328
|
-
*/
|
|
7329
|
-
Arn: string | undefined;
|
|
7330
|
-
}
|
|
7331
|
-
/**
|
|
7332
|
-
* <p>The source entity of an analysis.</p>
|
|
7333
|
-
* @public
|
|
7334
|
-
*/
|
|
7335
|
-
export interface AnalysisSourceEntity {
|
|
7336
|
-
/**
|
|
7337
|
-
* <p>The source template for the source entity of the analysis.</p>
|
|
7338
|
-
* @public
|
|
7339
|
-
*/
|
|
7340
|
-
SourceTemplate?: AnalysisSourceTemplate | undefined;
|
|
7341
|
-
}
|
|
7342
|
-
/**
|
|
7343
|
-
* <p>The summary metadata that describes an analysis.</p>
|
|
7344
|
-
* @public
|
|
7345
|
-
*/
|
|
7346
|
-
export interface AnalysisSummary {
|
|
7347
|
-
/**
|
|
7348
|
-
* <p>The Amazon Resource Name (ARN) for the analysis.</p>
|
|
7349
|
-
* @public
|
|
7350
|
-
*/
|
|
7351
|
-
Arn?: string | undefined;
|
|
7352
|
-
/**
|
|
7353
|
-
* <p>The ID of the analysis. This ID displays in the URL.</p>
|
|
7354
|
-
* @public
|
|
7355
|
-
*/
|
|
7356
|
-
AnalysisId?: string | undefined;
|
|
7357
|
-
/**
|
|
7358
|
-
* <p>The name of the analysis. This name is displayed in the Quick Sight console.
|
|
7359
|
-
* </p>
|
|
7360
|
-
* @public
|
|
7361
|
-
*/
|
|
7362
|
-
Name?: string | undefined;
|
|
7363
|
-
/**
|
|
7364
|
-
* <p>The last known status for the analysis.</p>
|
|
7365
|
-
* @public
|
|
7366
|
-
*/
|
|
7367
|
-
Status?: ResourceStatus | undefined;
|
|
7368
|
-
/**
|
|
7369
|
-
* <p>The time that the analysis was created.</p>
|
|
7370
|
-
* @public
|
|
7371
|
-
*/
|
|
7372
|
-
CreatedTime?: Date | undefined;
|
|
7373
|
-
/**
|
|
7374
|
-
* <p>The time that the analysis was last updated.</p>
|
|
7375
|
-
* @public
|
|
7376
|
-
*/
|
|
7377
|
-
LastUpdatedTime?: Date | undefined;
|
|
7378
|
-
}
|
|
7379
|
-
/**
|
|
7380
|
-
* <p>The definition of the Anchor.</p>
|
|
7381
|
-
* @public
|
|
7382
|
-
*/
|
|
7383
|
-
export interface Anchor {
|
|
7384
|
-
/**
|
|
7385
|
-
* <p>The <code>AnchorType</code> for the Anchor.</p>
|
|
7386
|
-
* @public
|
|
7387
|
-
*/
|
|
7388
|
-
AnchorType?: AnchorType | undefined;
|
|
7389
|
-
/**
|
|
7390
|
-
* <p>The <code>TimeGranularity</code> of the Anchor.</p>
|
|
7391
|
-
* @public
|
|
7392
|
-
*/
|
|
7393
|
-
TimeGranularity?: TimeGranularity | undefined;
|
|
7394
|
-
/**
|
|
7395
|
-
* <p>The offset of the Anchor.</p>
|
|
7396
|
-
* @public
|
|
7397
|
-
*/
|
|
7398
|
-
Offset?: number | undefined;
|
|
7399
|
-
}
|
|
7400
|
-
/**
|
|
7401
|
-
* <p>The shared view settings of an embedded dashboard.</p>
|
|
7402
|
-
* @public
|
|
7403
|
-
*/
|
|
7404
|
-
export interface SharedViewConfigurations {
|
|
7405
|
-
/**
|
|
7406
|
-
* <p>The shared view settings of an embedded dashboard.</p>
|
|
7407
|
-
* @public
|
|
7408
|
-
*/
|
|
7409
|
-
Enabled: boolean | undefined;
|
|
7410
|
-
}
|
|
7411
|
-
/**
|
|
7412
|
-
* <p>The feature configuration for an embedded dashboard.</p>
|
|
7413
|
-
* @public
|
|
7414
|
-
*/
|
|
7415
|
-
export interface AnonymousUserDashboardFeatureConfigurations {
|
|
7416
|
-
/**
|
|
7417
|
-
* <p>The shared view settings of an embedded dashboard.</p>
|
|
7418
|
-
* @public
|
|
7419
|
-
*/
|
|
7420
|
-
SharedView?: SharedViewConfigurations | undefined;
|
|
7421
|
-
}
|