@aws-sdk/client-quicksight 3.598.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.
- package/dist-cjs/index.js +195 -48
- package/dist-es/models/models_0.js +0 -14
- package/dist-es/models/models_1.js +14 -23
- package/dist-es/models/models_2.js +25 -2
- package/dist-es/protocols/Aws_restJson1.js +161 -2
- package/dist-types/commands/CreateAnalysisCommand.d.ts +60 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +60 -0
- package/dist-types/commands/CreateTemplateCommand.d.ts +60 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +60 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +60 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +60 -0
- package/dist-types/commands/ListAssetBundleImportJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -2
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +60 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +60 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +60 -0
- package/dist-types/models/models_0.d.ts +180 -194
- package/dist-types/models/models_1.d.ts +174 -199
- package/dist-types/models/models_2.d.ts +192 -106
- package/dist-types/models/models_3.d.ts +113 -189
- package/dist-types/models/models_4.d.ts +190 -2
- package/dist-types/ts3.4/commands/ListAssetBundleImportJobsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +43 -48
- package/dist-types/ts3.4/models/models_1.d.ts +45 -62
- package/dist-types/ts3.4/models/models_2.d.ts +71 -33
- package/dist-types/ts3.4/models/models_3.d.ts +29 -49
- package/dist-types/ts3.4/models/models_4.d.ts +47 -0
- package/package.json +4 -4
|
@@ -1,4 +1,177 @@
|
|
|
1
|
-
import { AxisBinding, AxisDisplayOptions, BarChartFieldWells, BarChartOrientation, BarChartSortConfiguration, BarsArrangement, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition,
|
|
1
|
+
import { AxisBinding, AxisDisplayOptions, BarChartFieldWells, BarChartOrientation, BarChartSortConfiguration, BarsArrangement, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ColumnTooltipItem, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DimensionField, FieldSort, FieldSortOptions, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PercentageDisplayFormatConfiguration, ReferenceLine, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipTarget, URLTargetConfiguration, Visibility, VisualCustomAction, VisualInteractionOptions, WidgetStatus } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>The tooltip item for the fields.</p>
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface FieldTooltipItem {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The unique ID of the field that is targeted by the tooltip.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
FieldId: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The label of the tooltip item.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
Label?: string;
|
|
17
|
+
/**
|
|
18
|
+
* <p>The visibility of the tooltip item.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
Visibility?: Visibility;
|
|
22
|
+
/**
|
|
23
|
+
* <p>Determines the target of the field tooltip item in a combo chart visual.</p>
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
TooltipTarget?: TooltipTarget;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* <p>The tooltip.</p>
|
|
30
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface TooltipItem {
|
|
34
|
+
/**
|
|
35
|
+
* <p>The tooltip item for the fields.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
FieldTooltipItem?: FieldTooltipItem;
|
|
39
|
+
/**
|
|
40
|
+
* <p>The tooltip item for the columns that are not part of a field well.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
ColumnTooltipItem?: ColumnTooltipItem;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
* @enum
|
|
48
|
+
*/
|
|
49
|
+
export declare const TooltipTitleType: {
|
|
50
|
+
readonly NONE: "NONE";
|
|
51
|
+
readonly PRIMARY_VALUE: "PRIMARY_VALUE";
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export type TooltipTitleType = (typeof TooltipTitleType)[keyof typeof TooltipTitleType];
|
|
57
|
+
/**
|
|
58
|
+
* <p>The setup for the detailed tooltip.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
export interface FieldBasedTooltip {
|
|
62
|
+
/**
|
|
63
|
+
* <p>The visibility of <code>Show aggregations</code>.</p>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
AggregationVisibility?: Visibility;
|
|
67
|
+
/**
|
|
68
|
+
* <p>The type for the >tooltip title. Choose one of the following options:</p>
|
|
69
|
+
* <ul>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>
|
|
72
|
+
* <code>NONE</code>: Doesn't use the primary value as the title.</p>
|
|
73
|
+
* </li>
|
|
74
|
+
* <li>
|
|
75
|
+
* <p>
|
|
76
|
+
* <code>PRIMARY_VALUE</code>: Uses primary value as the title.</p>
|
|
77
|
+
* </li>
|
|
78
|
+
* </ul>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
TooltipTitleType?: TooltipTitleType;
|
|
82
|
+
/**
|
|
83
|
+
* <p>The fields configuration in the
|
|
84
|
+
* tooltip.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
TooltipFields?: TooltipItem[];
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
* @enum
|
|
92
|
+
*/
|
|
93
|
+
export declare const SelectedTooltipType: {
|
|
94
|
+
readonly BASIC: "BASIC";
|
|
95
|
+
readonly DETAILED: "DETAILED";
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export type SelectedTooltipType = (typeof SelectedTooltipType)[keyof typeof SelectedTooltipType];
|
|
101
|
+
/**
|
|
102
|
+
* <p>The display options for the visual tooltip.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export interface TooltipOptions {
|
|
106
|
+
/**
|
|
107
|
+
* <p>Determines whether or not the tooltip is visible.</p>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
TooltipVisibility?: Visibility;
|
|
111
|
+
/**
|
|
112
|
+
* <p>The selected type for the tooltip. Choose one of the following options:</p>
|
|
113
|
+
* <ul>
|
|
114
|
+
* <li>
|
|
115
|
+
* <p>
|
|
116
|
+
* <code>BASIC</code>: A basic tooltip.</p>
|
|
117
|
+
* </li>
|
|
118
|
+
* <li>
|
|
119
|
+
* <p>
|
|
120
|
+
* <code>DETAILED</code>: A detailed tooltip.</p>
|
|
121
|
+
* </li>
|
|
122
|
+
* </ul>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
SelectedTooltipType?: SelectedTooltipType;
|
|
126
|
+
/**
|
|
127
|
+
* <p>The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
FieldBasedTooltip?: FieldBasedTooltip;
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
* @enum
|
|
135
|
+
*/
|
|
136
|
+
export declare const PivotTableDataPathType: {
|
|
137
|
+
readonly COUNT_METRIC_COLUMN: "COUNT_METRIC_COLUMN";
|
|
138
|
+
readonly EMPTY_COLUMN_HEADER: "EMPTY_COLUMN_HEADER";
|
|
139
|
+
readonly HIERARCHY_ROWS_LAYOUT_COLUMN: "HIERARCHY_ROWS_LAYOUT_COLUMN";
|
|
140
|
+
readonly MULTIPLE_ROW_METRICS_COLUMN: "MULTIPLE_ROW_METRICS_COLUMN";
|
|
141
|
+
};
|
|
142
|
+
/**
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
export type PivotTableDataPathType = (typeof PivotTableDataPathType)[keyof typeof PivotTableDataPathType];
|
|
146
|
+
/**
|
|
147
|
+
* <p>The type of the data path value.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
export interface DataPathType {
|
|
151
|
+
/**
|
|
152
|
+
* <p>The type of data path value utilized in a pivot table. Choose one of the following options:</p>
|
|
153
|
+
* <ul>
|
|
154
|
+
* <li>
|
|
155
|
+
* <p>
|
|
156
|
+
* <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>
|
|
157
|
+
* </li>
|
|
158
|
+
* <li>
|
|
159
|
+
* <p>
|
|
160
|
+
* <code>MULTIPLE_ROW_METRICS_COLUMN</code> - The type of data path for the metric column when the row is set to Metric Placement.</p>
|
|
161
|
+
* </li>
|
|
162
|
+
* <li>
|
|
163
|
+
* <p>
|
|
164
|
+
* <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>
|
|
165
|
+
* </li>
|
|
166
|
+
* <li>
|
|
167
|
+
* <p>
|
|
168
|
+
* <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>
|
|
169
|
+
* </li>
|
|
170
|
+
* </ul>
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
PivotTableDataPathType?: PivotTableDataPathType;
|
|
174
|
+
}
|
|
2
175
|
/**
|
|
3
176
|
* <p>The data path that needs to be sorted.</p>
|
|
4
177
|
* @public
|
|
@@ -6595,188 +6768,6 @@ export interface WaterfallChartSortConfiguration {
|
|
|
6595
6768
|
*/
|
|
6596
6769
|
BreakdownItemsLimit?: ItemsLimitConfiguration;
|
|
6597
6770
|
}
|
|
6598
|
-
/**
|
|
6599
|
-
* <p>The options that determine the presentation of a waterfall visual.</p>
|
|
6600
|
-
* @public
|
|
6601
|
-
*/
|
|
6602
|
-
export interface WaterfallChartOptions {
|
|
6603
|
-
/**
|
|
6604
|
-
* <p>This option determines the total bar label of a waterfall visual.</p>
|
|
6605
|
-
* @public
|
|
6606
|
-
*/
|
|
6607
|
-
TotalBarLabel?: string;
|
|
6608
|
-
}
|
|
6609
|
-
/**
|
|
6610
|
-
* <p>The configuration for a waterfall visual.</p>
|
|
6611
|
-
* @public
|
|
6612
|
-
*/
|
|
6613
|
-
export interface WaterfallChartConfiguration {
|
|
6614
|
-
/**
|
|
6615
|
-
* <p>The field well configuration of a waterfall visual.</p>
|
|
6616
|
-
* @public
|
|
6617
|
-
*/
|
|
6618
|
-
FieldWells?: WaterfallChartFieldWells;
|
|
6619
|
-
/**
|
|
6620
|
-
* <p>The sort configuration of a waterfall visual.</p>
|
|
6621
|
-
* @public
|
|
6622
|
-
*/
|
|
6623
|
-
SortConfiguration?: WaterfallChartSortConfiguration;
|
|
6624
|
-
/**
|
|
6625
|
-
* <p>The options that determine the presentation of a waterfall visual.</p>
|
|
6626
|
-
* @public
|
|
6627
|
-
*/
|
|
6628
|
-
WaterfallChartOptions?: WaterfallChartOptions;
|
|
6629
|
-
/**
|
|
6630
|
-
* <p>The options that determine the presentation of the category axis label.</p>
|
|
6631
|
-
* @public
|
|
6632
|
-
*/
|
|
6633
|
-
CategoryAxisLabelOptions?: ChartAxisLabelOptions;
|
|
6634
|
-
/**
|
|
6635
|
-
* <p>The options that determine the presentation of the category axis.</p>
|
|
6636
|
-
* @public
|
|
6637
|
-
*/
|
|
6638
|
-
CategoryAxisDisplayOptions?: AxisDisplayOptions;
|
|
6639
|
-
/**
|
|
6640
|
-
* <p>The options that determine the presentation of the y-axis label.</p>
|
|
6641
|
-
* @public
|
|
6642
|
-
*/
|
|
6643
|
-
PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
|
|
6644
|
-
/**
|
|
6645
|
-
* <p>The options that determine the presentation of the y-axis.</p>
|
|
6646
|
-
* @public
|
|
6647
|
-
*/
|
|
6648
|
-
PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
|
|
6649
|
-
/**
|
|
6650
|
-
* <p>The legend configuration of a waterfall visual.</p>
|
|
6651
|
-
* @public
|
|
6652
|
-
*/
|
|
6653
|
-
Legend?: LegendOptions;
|
|
6654
|
-
/**
|
|
6655
|
-
* <p>The data label configuration of a waterfall visual.</p>
|
|
6656
|
-
* @public
|
|
6657
|
-
*/
|
|
6658
|
-
DataLabels?: DataLabelOptions;
|
|
6659
|
-
/**
|
|
6660
|
-
* <p>The visual palette configuration of a waterfall visual.</p>
|
|
6661
|
-
* @public
|
|
6662
|
-
*/
|
|
6663
|
-
VisualPalette?: VisualPalette;
|
|
6664
|
-
/**
|
|
6665
|
-
* <p>The color configuration of a waterfall visual.</p>
|
|
6666
|
-
* @public
|
|
6667
|
-
*/
|
|
6668
|
-
ColorConfiguration?: WaterfallChartColorConfiguration;
|
|
6669
|
-
/**
|
|
6670
|
-
* <p>The general visual interactions setup for a visual.</p>
|
|
6671
|
-
* @public
|
|
6672
|
-
*/
|
|
6673
|
-
Interactions?: VisualInteractionOptions;
|
|
6674
|
-
}
|
|
6675
|
-
/**
|
|
6676
|
-
* <p>A waterfall chart.</p>
|
|
6677
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6678
|
-
* @public
|
|
6679
|
-
*/
|
|
6680
|
-
export interface WaterfallVisual {
|
|
6681
|
-
/**
|
|
6682
|
-
* <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>
|
|
6683
|
-
* @public
|
|
6684
|
-
*/
|
|
6685
|
-
VisualId: string | undefined;
|
|
6686
|
-
/**
|
|
6687
|
-
* <p>The title that is displayed on the visual.</p>
|
|
6688
|
-
* @public
|
|
6689
|
-
*/
|
|
6690
|
-
Title?: VisualTitleLabelOptions;
|
|
6691
|
-
/**
|
|
6692
|
-
* <p>The subtitle that is displayed on the visual.</p>
|
|
6693
|
-
* @public
|
|
6694
|
-
*/
|
|
6695
|
-
Subtitle?: VisualSubtitleLabelOptions;
|
|
6696
|
-
/**
|
|
6697
|
-
* <p>The configuration for a waterfall visual.</p>
|
|
6698
|
-
* @public
|
|
6699
|
-
*/
|
|
6700
|
-
ChartConfiguration?: WaterfallChartConfiguration;
|
|
6701
|
-
/**
|
|
6702
|
-
* <p>The list of custom actions that are configured for a visual.</p>
|
|
6703
|
-
* @public
|
|
6704
|
-
*/
|
|
6705
|
-
Actions?: VisualCustomAction[];
|
|
6706
|
-
/**
|
|
6707
|
-
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
6708
|
-
* @public
|
|
6709
|
-
*/
|
|
6710
|
-
ColumnHierarchies?: ColumnHierarchy[];
|
|
6711
|
-
}
|
|
6712
|
-
/**
|
|
6713
|
-
* <p>The aggregated field wells of a word cloud.</p>
|
|
6714
|
-
* @public
|
|
6715
|
-
*/
|
|
6716
|
-
export interface WordCloudAggregatedFieldWells {
|
|
6717
|
-
/**
|
|
6718
|
-
* <p>The group by field well of a word cloud. Values are grouped by group by fields.</p>
|
|
6719
|
-
* @public
|
|
6720
|
-
*/
|
|
6721
|
-
GroupBy?: DimensionField[];
|
|
6722
|
-
/**
|
|
6723
|
-
* <p>The size field well of a word cloud. Values are aggregated based on group by fields.</p>
|
|
6724
|
-
* @public
|
|
6725
|
-
*/
|
|
6726
|
-
Size?: MeasureField[];
|
|
6727
|
-
}
|
|
6728
|
-
/**
|
|
6729
|
-
* <p>The field wells of a word cloud visual.</p>
|
|
6730
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
6731
|
-
* @public
|
|
6732
|
-
*/
|
|
6733
|
-
export interface WordCloudFieldWells {
|
|
6734
|
-
/**
|
|
6735
|
-
* <p>The aggregated field wells of a word cloud.</p>
|
|
6736
|
-
* @public
|
|
6737
|
-
*/
|
|
6738
|
-
WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells;
|
|
6739
|
-
}
|
|
6740
|
-
/**
|
|
6741
|
-
* <p>The sort configuration of a word cloud visual.</p>
|
|
6742
|
-
* @public
|
|
6743
|
-
*/
|
|
6744
|
-
export interface WordCloudSortConfiguration {
|
|
6745
|
-
/**
|
|
6746
|
-
* <p>The limit on the number of groups that are displayed in a word cloud.</p>
|
|
6747
|
-
* @public
|
|
6748
|
-
*/
|
|
6749
|
-
CategoryItemsLimit?: ItemsLimitConfiguration;
|
|
6750
|
-
/**
|
|
6751
|
-
* <p>The sort configuration of group by fields.</p>
|
|
6752
|
-
* @public
|
|
6753
|
-
*/
|
|
6754
|
-
CategorySort?: FieldSortOptions[];
|
|
6755
|
-
}
|
|
6756
|
-
/**
|
|
6757
|
-
* @public
|
|
6758
|
-
* @enum
|
|
6759
|
-
*/
|
|
6760
|
-
export declare const WordCloudCloudLayout: {
|
|
6761
|
-
readonly FLUID: "FLUID";
|
|
6762
|
-
readonly NORMAL: "NORMAL";
|
|
6763
|
-
};
|
|
6764
|
-
/**
|
|
6765
|
-
* @public
|
|
6766
|
-
*/
|
|
6767
|
-
export type WordCloudCloudLayout = (typeof WordCloudCloudLayout)[keyof typeof WordCloudCloudLayout];
|
|
6768
|
-
/**
|
|
6769
|
-
* @public
|
|
6770
|
-
* @enum
|
|
6771
|
-
*/
|
|
6772
|
-
export declare const WordCloudWordCasing: {
|
|
6773
|
-
readonly EXISTING_CASE: "EXISTING_CASE";
|
|
6774
|
-
readonly LOWER_CASE: "LOWER_CASE";
|
|
6775
|
-
};
|
|
6776
|
-
/**
|
|
6777
|
-
* @public
|
|
6778
|
-
*/
|
|
6779
|
-
export type WordCloudWordCasing = (typeof WordCloudWordCasing)[keyof typeof WordCloudWordCasing];
|
|
6780
6771
|
/**
|
|
6781
6772
|
* @internal
|
|
6782
6773
|
*/
|
|
@@ -7309,19 +7300,3 @@ export declare const WaterfallChartAggregatedFieldWellsFilterSensitiveLog: (obj:
|
|
|
7309
7300
|
* @internal
|
|
7310
7301
|
*/
|
|
7311
7302
|
export declare const WaterfallChartFieldWellsFilterSensitiveLog: (obj: WaterfallChartFieldWells) => any;
|
|
7312
|
-
/**
|
|
7313
|
-
* @internal
|
|
7314
|
-
*/
|
|
7315
|
-
export declare const WaterfallChartConfigurationFilterSensitiveLog: (obj: WaterfallChartConfiguration) => any;
|
|
7316
|
-
/**
|
|
7317
|
-
* @internal
|
|
7318
|
-
*/
|
|
7319
|
-
export declare const WaterfallVisualFilterSensitiveLog: (obj: WaterfallVisual) => any;
|
|
7320
|
-
/**
|
|
7321
|
-
* @internal
|
|
7322
|
-
*/
|
|
7323
|
-
export declare const WordCloudAggregatedFieldWellsFilterSensitiveLog: (obj: WordCloudAggregatedFieldWells) => any;
|
|
7324
|
-
/**
|
|
7325
|
-
* @internal
|
|
7326
|
-
*/
|
|
7327
|
-
export declare const WordCloudFieldWellsFilterSensitiveLog: (obj: WordCloudFieldWells) => any;
|
|
@@ -1,7 +1,189 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
import { AccountCustomization, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DashboardBehavior, DataSetIdentifierDeclaration, Edition, FilterControl, FilterGroup, Layout, ParameterControl, ParameterDeclaration, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, TimeGranularity, VisualCustomAction, VisualInteractionOptions, VisualMenuOption } from "./models_0";
|
|
3
|
-
import { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LineChartVisual, PieChartVisual, PivotTableVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualSubtitleLabelOptions, VisualTitleLabelOptions,
|
|
2
|
+
import { AccountCustomization, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, AxisDisplayOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, DashboardBehavior, DataLabelOptions, DataSetIdentifierDeclaration, DimensionField, Edition, FieldSortOptions, FilterControl, FilterGroup, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, ParameterControl, ParameterDeclaration, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, TimeGranularity, VisualCustomAction, VisualInteractionOptions, VisualMenuOption } from "./models_0";
|
|
3
|
+
import { BarChartVisual, BoxPlotVisual, ColumnHierarchy, ComboChartVisual, CustomContentVisual, EmptyVisual, FilledMapVisual, FunnelChartVisual, GaugeChartVisual, GeospatialMapVisual, HeatMapVisual, HistogramVisual, InsightVisual, KPIVisual, LineChartVisual, PieChartVisual, PivotTableVisual, RadarChartVisual, SankeyDiagramVisual, ScatterPlotVisual, TableVisual, TreeMapVisual, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WaterfallChartColorConfiguration, WaterfallChartFieldWells, WaterfallChartSortConfiguration } from "./models_1";
|
|
4
4
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* <p>The options that determine the presentation of a waterfall visual.</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface WaterfallChartOptions {
|
|
10
|
+
/**
|
|
11
|
+
* <p>This option determines the total bar label of a waterfall visual.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
TotalBarLabel?: string;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* <p>The configuration for a waterfall visual.</p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export interface WaterfallChartConfiguration {
|
|
21
|
+
/**
|
|
22
|
+
* <p>The field well configuration of a waterfall visual.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
FieldWells?: WaterfallChartFieldWells;
|
|
26
|
+
/**
|
|
27
|
+
* <p>The sort configuration of a waterfall visual.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
SortConfiguration?: WaterfallChartSortConfiguration;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The options that determine the presentation of a waterfall visual.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
WaterfallChartOptions?: WaterfallChartOptions;
|
|
36
|
+
/**
|
|
37
|
+
* <p>The options that determine the presentation of the category axis label.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
CategoryAxisLabelOptions?: ChartAxisLabelOptions;
|
|
41
|
+
/**
|
|
42
|
+
* <p>The options that determine the presentation of the category axis.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
CategoryAxisDisplayOptions?: AxisDisplayOptions;
|
|
46
|
+
/**
|
|
47
|
+
* <p>The options that determine the presentation of the y-axis label.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The options that determine the presentation of the y-axis.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The legend configuration of a waterfall visual.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
Legend?: LegendOptions;
|
|
61
|
+
/**
|
|
62
|
+
* <p>The data label configuration of a waterfall visual.</p>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
DataLabels?: DataLabelOptions;
|
|
66
|
+
/**
|
|
67
|
+
* <p>The visual palette configuration of a waterfall visual.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
VisualPalette?: VisualPalette;
|
|
71
|
+
/**
|
|
72
|
+
* <p>The color configuration of a waterfall visual.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
ColorConfiguration?: WaterfallChartColorConfiguration;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The general visual interactions setup for a visual.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
Interactions?: VisualInteractionOptions;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* <p>A waterfall chart.</p>
|
|
84
|
+
* <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 QuickSight User Guide</i>.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export interface WaterfallVisual {
|
|
88
|
+
/**
|
|
89
|
+
* <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>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
VisualId: string | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>The title that is displayed on the visual.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
Title?: VisualTitleLabelOptions;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The subtitle that is displayed on the visual.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
Subtitle?: VisualSubtitleLabelOptions;
|
|
103
|
+
/**
|
|
104
|
+
* <p>The configuration for a waterfall visual.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
ChartConfiguration?: WaterfallChartConfiguration;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The list of custom actions that are configured for a visual.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
Actions?: VisualCustomAction[];
|
|
113
|
+
/**
|
|
114
|
+
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
ColumnHierarchies?: ColumnHierarchy[];
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* <p>The aggregated field wells of a word cloud.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
export interface WordCloudAggregatedFieldWells {
|
|
124
|
+
/**
|
|
125
|
+
* <p>The group by field well of a word cloud. Values are grouped by group by fields.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
GroupBy?: DimensionField[];
|
|
129
|
+
/**
|
|
130
|
+
* <p>The size field well of a word cloud. Values are aggregated based on group by fields.</p>
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
Size?: MeasureField[];
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* <p>The field wells of a word cloud visual.</p>
|
|
137
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export interface WordCloudFieldWells {
|
|
141
|
+
/**
|
|
142
|
+
* <p>The aggregated field wells of a word cloud.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* <p>The sort configuration of a word cloud visual.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
export interface WordCloudSortConfiguration {
|
|
152
|
+
/**
|
|
153
|
+
* <p>The limit on the number of groups that are displayed in a word cloud.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
CategoryItemsLimit?: ItemsLimitConfiguration;
|
|
157
|
+
/**
|
|
158
|
+
* <p>The sort configuration of group by fields.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
CategorySort?: FieldSortOptions[];
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
* @enum
|
|
166
|
+
*/
|
|
167
|
+
export declare const WordCloudCloudLayout: {
|
|
168
|
+
readonly FLUID: "FLUID";
|
|
169
|
+
readonly NORMAL: "NORMAL";
|
|
170
|
+
};
|
|
171
|
+
/**
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
export type WordCloudCloudLayout = (typeof WordCloudCloudLayout)[keyof typeof WordCloudCloudLayout];
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
* @enum
|
|
178
|
+
*/
|
|
179
|
+
export declare const WordCloudWordCasing: {
|
|
180
|
+
readonly EXISTING_CASE: "EXISTING_CASE";
|
|
181
|
+
readonly LOWER_CASE: "LOWER_CASE";
|
|
182
|
+
};
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
export type WordCloudWordCasing = (typeof WordCloudWordCasing)[keyof typeof WordCloudWordCasing];
|
|
5
187
|
/**
|
|
6
188
|
* @public
|
|
7
189
|
* @enum
|
|
@@ -7588,117 +7770,21 @@ export interface CreateTemplateAliasResponse {
|
|
|
7588
7770
|
RequestId?: string;
|
|
7589
7771
|
}
|
|
7590
7772
|
/**
|
|
7591
|
-
*
|
|
7592
|
-
* hexadecimal color code that consists of six alphanumerical characters, prefixed with
|
|
7593
|
-
* <code>#</code>, for example #37BFF5. </p>
|
|
7594
|
-
* @public
|
|
7595
|
-
*/
|
|
7596
|
-
export interface DataColorPalette {
|
|
7597
|
-
/**
|
|
7598
|
-
* <p>The hexadecimal codes for the colors.</p>
|
|
7599
|
-
* @public
|
|
7600
|
-
*/
|
|
7601
|
-
Colors?: string[];
|
|
7602
|
-
/**
|
|
7603
|
-
* <p>The minimum and maximum hexadecimal codes that describe a color gradient. </p>
|
|
7604
|
-
* @public
|
|
7605
|
-
*/
|
|
7606
|
-
MinMaxGradient?: string[];
|
|
7607
|
-
/**
|
|
7608
|
-
* <p>The hexadecimal code of a color that applies to charts where a lack of data is
|
|
7609
|
-
* highlighted.</p>
|
|
7610
|
-
* @public
|
|
7611
|
-
*/
|
|
7612
|
-
EmptyFillColor?: string;
|
|
7613
|
-
}
|
|
7614
|
-
/**
|
|
7615
|
-
* <p>Display options related to tiles on a sheet.</p>
|
|
7616
|
-
* @public
|
|
7617
|
-
*/
|
|
7618
|
-
export interface TileStyle {
|
|
7619
|
-
/**
|
|
7620
|
-
* <p>The border around a tile.</p>
|
|
7621
|
-
* @public
|
|
7622
|
-
*/
|
|
7623
|
-
Border?: BorderStyle;
|
|
7624
|
-
}
|
|
7625
|
-
/**
|
|
7626
|
-
* <p>The display options for gutter spacing between tiles on a sheet.</p>
|
|
7627
|
-
* @public
|
|
7628
|
-
*/
|
|
7629
|
-
export interface GutterStyle {
|
|
7630
|
-
/**
|
|
7631
|
-
* <p>This Boolean value controls whether to display a gutter space between sheet tiles.
|
|
7632
|
-
* </p>
|
|
7633
|
-
* @public
|
|
7634
|
-
*/
|
|
7635
|
-
Show?: boolean;
|
|
7636
|
-
}
|
|
7637
|
-
/**
|
|
7638
|
-
* <p>The display options for margins around the outside edge of sheets.</p>
|
|
7639
|
-
* @public
|
|
7640
|
-
*/
|
|
7641
|
-
export interface MarginStyle {
|
|
7642
|
-
/**
|
|
7643
|
-
* <p>This Boolean value controls whether to display sheet margins.</p>
|
|
7644
|
-
* @public
|
|
7645
|
-
*/
|
|
7646
|
-
Show?: boolean;
|
|
7647
|
-
}
|
|
7648
|
-
/**
|
|
7649
|
-
* <p>The display options for the layout of tiles on a sheet.</p>
|
|
7650
|
-
* @public
|
|
7773
|
+
* @internal
|
|
7651
7774
|
*/
|
|
7652
|
-
export
|
|
7653
|
-
/**
|
|
7654
|
-
* <p>The gutter settings that apply between tiles. </p>
|
|
7655
|
-
* @public
|
|
7656
|
-
*/
|
|
7657
|
-
Gutter?: GutterStyle;
|
|
7658
|
-
/**
|
|
7659
|
-
* <p>The margin settings that apply around the outside edge of sheets.</p>
|
|
7660
|
-
* @public
|
|
7661
|
-
*/
|
|
7662
|
-
Margin?: MarginStyle;
|
|
7663
|
-
}
|
|
7775
|
+
export declare const WaterfallChartConfigurationFilterSensitiveLog: (obj: WaterfallChartConfiguration) => any;
|
|
7664
7776
|
/**
|
|
7665
|
-
*
|
|
7666
|
-
* @public
|
|
7777
|
+
* @internal
|
|
7667
7778
|
*/
|
|
7668
|
-
export
|
|
7669
|
-
/**
|
|
7670
|
-
* <p>The display options for tiles.</p>
|
|
7671
|
-
* @public
|
|
7672
|
-
*/
|
|
7673
|
-
Tile?: TileStyle;
|
|
7674
|
-
/**
|
|
7675
|
-
* <p>The layout options for tiles.</p>
|
|
7676
|
-
* @public
|
|
7677
|
-
*/
|
|
7678
|
-
TileLayout?: TileLayoutStyle;
|
|
7679
|
-
}
|
|
7779
|
+
export declare const WaterfallVisualFilterSensitiveLog: (obj: WaterfallVisual) => any;
|
|
7680
7780
|
/**
|
|
7681
|
-
*
|
|
7682
|
-
* @public
|
|
7781
|
+
* @internal
|
|
7683
7782
|
*/
|
|
7684
|
-
export
|
|
7685
|
-
/**
|
|
7686
|
-
* <p>Determines the font family settings.</p>
|
|
7687
|
-
* @public
|
|
7688
|
-
*/
|
|
7689
|
-
FontFamily?: string;
|
|
7690
|
-
}
|
|
7783
|
+
export declare const WordCloudAggregatedFieldWellsFilterSensitiveLog: (obj: WordCloudAggregatedFieldWells) => any;
|
|
7691
7784
|
/**
|
|
7692
|
-
*
|
|
7693
|
-
* @public
|
|
7785
|
+
* @internal
|
|
7694
7786
|
*/
|
|
7695
|
-
export
|
|
7696
|
-
/**
|
|
7697
|
-
* <p>Determines the list of font families.</p>
|
|
7698
|
-
* @public
|
|
7699
|
-
*/
|
|
7700
|
-
FontFamilies?: Font[];
|
|
7701
|
-
}
|
|
7787
|
+
export declare const WordCloudFieldWellsFilterSensitiveLog: (obj: WordCloudFieldWells) => any;
|
|
7702
7788
|
/**
|
|
7703
7789
|
* @internal
|
|
7704
7790
|
*/
|