@aws-sdk/client-quicksight 3.554.0 → 3.558.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 +16644 -16530
- package/dist-es/models/models_0.js +31 -51
- package/dist-es/models/models_1.js +21 -53
- package/dist-es/models/models_2.js +54 -25
- package/dist-es/models/models_3.js +25 -0
- package/dist-es/protocols/Aws_restJson1.js +115 -4
- package/dist-types/commands/CreateAnalysisCommand.d.ts +300 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +300 -0
- package/dist-types/commands/CreateTemplateCommand.d.ts +300 -0
- package/dist-types/commands/CreateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +300 -0
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +6 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +300 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +300 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist-types/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
- package/dist-types/commands/ListIngestionsCommand.d.ts +1 -1
- package/dist-types/commands/ListNamespacesCommand.d.ts +1 -2
- package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +52 -5
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +300 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +300 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +300 -0
- package/dist-types/models/models_0.d.ts +717 -725
- package/dist-types/models/models_1.d.ts +286 -446
- package/dist-types/models/models_2.d.ts +463 -302
- package/dist-types/models/models_3.d.ts +316 -280
- package/dist-types/models/models_4.d.ts +280 -4
- package/dist-types/ts3.4/commands/CreateThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIngestionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +174 -190
- package/dist-types/ts3.4/models/models_1.d.ts +77 -134
- package/dist-types/ts3.4/models/models_2.d.ts +159 -91
- package/dist-types/ts3.4/models/models_3.d.ts +91 -72
- package/dist-types/ts3.4/models/models_4.d.ts +76 -3
- package/package.json +4 -4
|
@@ -1,4 +1,281 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AxisBinding, AxisDisplayOptions, BarChartFieldWells, BarChartOrientation, BarChartSortConfiguration, BarsArrangement, ChartAxisLabelOptions, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DataPathType, DimensionField, FieldSort, FieldSortOptions, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PercentageDisplayFormatConfiguration, ReferenceLine, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipOptions, URLTargetConfiguration, Visibility, VisualCustomAction, VisualInteractionOptions, WidgetStatus } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>The data path that needs to be sorted.</p>
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface DataPathValue {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The field ID of the field that needs to be sorted.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
FieldId?: string;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The actual value of the field that needs to be sorted.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
FieldValue?: string;
|
|
17
|
+
/**
|
|
18
|
+
* <p>The type configuration of the field.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
DataPathType?: DataPathType;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* <p>The color map that determines the color options for a particular element.</p>
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export interface DataPathColor {
|
|
28
|
+
/**
|
|
29
|
+
* <p>The element that the color needs to be applied to.</p>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
Element: DataPathValue | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* <p>The color that needs to be applied to the element.</p>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
Color: string | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* <p>The time granularity of the field that the color needs to be applied to.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
TimeGranularity?: TimeGranularity;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* <p>The visual display options for the visual palette.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
export interface VisualPalette {
|
|
49
|
+
/**
|
|
50
|
+
* <p>The chart color options for the visual palette.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
ChartColor?: string;
|
|
54
|
+
/**
|
|
55
|
+
* <p>The color map options for the visual palette.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
ColorMap?: DataPathColor[];
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* <p>The configuration of a <code>BarChartVisual</code>.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
export interface BarChartConfiguration {
|
|
65
|
+
/**
|
|
66
|
+
* <p>The field wells of the visual.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
FieldWells?: BarChartFieldWells;
|
|
70
|
+
/**
|
|
71
|
+
* <p>The sort configuration of a <code>BarChartVisual</code>.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
SortConfiguration?: BarChartSortConfiguration;
|
|
75
|
+
/**
|
|
76
|
+
* <p>The orientation of the bars in a bar chart visual. There are two valid values in this structure:</p>
|
|
77
|
+
* <ul>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>
|
|
80
|
+
* <code>HORIZONTAL</code>: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.</p>
|
|
81
|
+
* </li>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>
|
|
84
|
+
* <code>VERTICAL</code>: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* </ul>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
Orientation?: BarChartOrientation;
|
|
90
|
+
/**
|
|
91
|
+
* <p>Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
BarsArrangement?: BarsArrangement;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The palette (chart color) display setup of the visual.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
VisualPalette?: VisualPalette;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The small multiples setup for the visual.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
SmallMultiplesOptions?: SmallMultiplesOptions;
|
|
105
|
+
/**
|
|
106
|
+
* <p>The label display options (grid line, range, scale, axis step) for bar chart category.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
CategoryAxis?: AxisDisplayOptions;
|
|
110
|
+
/**
|
|
111
|
+
* <p>The label options (label text, label visibility and sort icon visibility) for a bar chart.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
CategoryLabelOptions?: ChartAxisLabelOptions;
|
|
115
|
+
/**
|
|
116
|
+
* <p>The label display options (grid line, range, scale, axis step) for a bar chart value.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
ValueAxis?: AxisDisplayOptions;
|
|
120
|
+
/**
|
|
121
|
+
* <p>The label options (label text, label visibility and sort icon visibility) for a bar chart value.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
ValueLabelOptions?: ChartAxisLabelOptions;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
ColorLabelOptions?: ChartAxisLabelOptions;
|
|
130
|
+
/**
|
|
131
|
+
* <p>The legend display setup of the visual.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
Legend?: LegendOptions;
|
|
135
|
+
/**
|
|
136
|
+
* <p>The options that determine if visual data labels are displayed.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
DataLabels?: DataLabelOptions;
|
|
140
|
+
/**
|
|
141
|
+
* <p>The tooltip display setup of the visual.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
Tooltip?: TooltipOptions;
|
|
145
|
+
/**
|
|
146
|
+
* <p>The reference line setup of the visual.</p>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
ReferenceLines?: ReferenceLine[];
|
|
150
|
+
/**
|
|
151
|
+
* <p>The contribution analysis (anomaly configuration) setup of the visual.</p>
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
|
|
155
|
+
/**
|
|
156
|
+
* <p>The general visual interactions setup for a visual.</p>
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
Interactions?: VisualInteractionOptions;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* <p>The category drill down filter.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export interface CategoryDrillDownFilter {
|
|
166
|
+
/**
|
|
167
|
+
* <p>The column that the filter is applied to.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
Column: ColumnIdentifier | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* <p>A list of the string inputs that are the values of the category drill down filter.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
CategoryValues: string[] | undefined;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* <p>The numeric equality type drill down filter.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
export interface NumericEqualityDrillDownFilter {
|
|
182
|
+
/**
|
|
183
|
+
* <p>The column that the filter is applied to.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
Column: ColumnIdentifier | undefined;
|
|
187
|
+
/**
|
|
188
|
+
* <p>The value of the double input numeric drill down filter.</p>
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
Value: number | undefined;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* <p>The time range drill down filter.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
export interface TimeRangeDrillDownFilter {
|
|
198
|
+
/**
|
|
199
|
+
* <p>The column that the filter is applied to.</p>
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
Column: ColumnIdentifier | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* <p>The minimum value for the filter value range.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
RangeMinimum: Date | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>The maximum value for the filter value range.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
RangeMaximum: Date | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
TimeGranularity: TimeGranularity | undefined;
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* <p>The drill down filter for the column hierarchies.</p>
|
|
221
|
+
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
export interface DrillDownFilter {
|
|
225
|
+
/**
|
|
226
|
+
* <p>The numeric equality type drill down filter. This filter is used for number type columns.</p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
NumericEqualityFilter?: NumericEqualityDrillDownFilter;
|
|
230
|
+
/**
|
|
231
|
+
* <p>The category type drill down filter. This filter is used for string type columns.</p>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
CategoryFilter?: CategoryDrillDownFilter;
|
|
235
|
+
/**
|
|
236
|
+
* <p>The time range drill down filter. This filter is used for date time columns.</p>
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
TimeRangeFilter?: TimeRangeDrillDownFilter;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* <p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export interface DateTimeHierarchy {
|
|
246
|
+
/**
|
|
247
|
+
* <p>The hierarchy ID of the <code>DateTime</code> hierarchy.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
HierarchyId: string | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* <p>The option that determines the drill down filters for the
|
|
253
|
+
* <code>DateTime</code> hierarchy.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
DrillDownFilters?: DrillDownFilter[];
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* <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>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
export interface ExplicitHierarchy {
|
|
263
|
+
/**
|
|
264
|
+
* <p>The hierarchy ID of the explicit hierarchy.</p>
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
HierarchyId: string | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* <p>The list of columns that define the explicit hierarchy.</p>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
Columns: ColumnIdentifier[] | undefined;
|
|
273
|
+
/**
|
|
274
|
+
* <p>The option that determines the drill down filters for the explicit hierarchy.</p>
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
DrillDownFilters?: DrillDownFilter[];
|
|
278
|
+
}
|
|
2
279
|
/**
|
|
3
280
|
* <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>
|
|
4
281
|
* @public
|
|
@@ -6492,438 +6769,21 @@ export declare const WordCloudWordOrientation: {
|
|
|
6492
6769
|
*/
|
|
6493
6770
|
export type WordCloudWordOrientation = (typeof WordCloudWordOrientation)[keyof typeof WordCloudWordOrientation];
|
|
6494
6771
|
/**
|
|
6495
|
-
* @
|
|
6496
|
-
* @enum
|
|
6497
|
-
*/
|
|
6498
|
-
export declare const WordCloudWordPadding: {
|
|
6499
|
-
readonly LARGE: "LARGE";
|
|
6500
|
-
readonly MEDIUM: "MEDIUM";
|
|
6501
|
-
readonly NONE: "NONE";
|
|
6502
|
-
readonly SMALL: "SMALL";
|
|
6503
|
-
};
|
|
6504
|
-
/**
|
|
6505
|
-
* @public
|
|
6506
|
-
*/
|
|
6507
|
-
export type WordCloudWordPadding = (typeof WordCloudWordPadding)[keyof typeof WordCloudWordPadding];
|
|
6508
|
-
/**
|
|
6509
|
-
* @public
|
|
6510
|
-
* @enum
|
|
6511
|
-
*/
|
|
6512
|
-
export declare const WordCloudWordScaling: {
|
|
6513
|
-
readonly EMPHASIZE: "EMPHASIZE";
|
|
6514
|
-
readonly NORMAL: "NORMAL";
|
|
6515
|
-
};
|
|
6516
|
-
/**
|
|
6517
|
-
* @public
|
|
6518
|
-
*/
|
|
6519
|
-
export type WordCloudWordScaling = (typeof WordCloudWordScaling)[keyof typeof WordCloudWordScaling];
|
|
6520
|
-
/**
|
|
6521
|
-
* <p>The word cloud options for a word cloud visual.</p>
|
|
6522
|
-
* @public
|
|
6523
|
-
*/
|
|
6524
|
-
export interface WordCloudOptions {
|
|
6525
|
-
/**
|
|
6526
|
-
* <p>The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.</p>
|
|
6527
|
-
* @public
|
|
6528
|
-
*/
|
|
6529
|
-
WordOrientation?: WordCloudWordOrientation;
|
|
6530
|
-
/**
|
|
6531
|
-
* <p>The word scaling options (emphasize, normal) for the words in a word cloud.</p>
|
|
6532
|
-
* @public
|
|
6533
|
-
*/
|
|
6534
|
-
WordScaling?: WordCloudWordScaling;
|
|
6535
|
-
/**
|
|
6536
|
-
* <p>The cloud layout options (fluid, normal) of a word cloud.</p>
|
|
6537
|
-
* @public
|
|
6538
|
-
*/
|
|
6539
|
-
CloudLayout?: WordCloudCloudLayout;
|
|
6540
|
-
/**
|
|
6541
|
-
* <p>The word casing options (lower_case, existing_case) for the words in a word cloud.</p>
|
|
6542
|
-
* @public
|
|
6543
|
-
*/
|
|
6544
|
-
WordCasing?: WordCloudWordCasing;
|
|
6545
|
-
/**
|
|
6546
|
-
* <p>The word padding options (none, small, medium, large) for the words in a word cloud.</p>
|
|
6547
|
-
* @public
|
|
6548
|
-
*/
|
|
6549
|
-
WordPadding?: WordCloudWordPadding;
|
|
6550
|
-
/**
|
|
6551
|
-
* <p>The length limit of each word from 1-100.</p>
|
|
6552
|
-
* @public
|
|
6553
|
-
*/
|
|
6554
|
-
MaximumStringLength?: number;
|
|
6555
|
-
}
|
|
6556
|
-
/**
|
|
6557
|
-
* <p>The configuration of a word cloud visual.</p>
|
|
6558
|
-
* @public
|
|
6559
|
-
*/
|
|
6560
|
-
export interface WordCloudChartConfiguration {
|
|
6561
|
-
/**
|
|
6562
|
-
* <p>The field wells of the visual.</p>
|
|
6563
|
-
* @public
|
|
6564
|
-
*/
|
|
6565
|
-
FieldWells?: WordCloudFieldWells;
|
|
6566
|
-
/**
|
|
6567
|
-
* <p>The sort configuration of a word cloud visual.</p>
|
|
6568
|
-
* @public
|
|
6569
|
-
*/
|
|
6570
|
-
SortConfiguration?: WordCloudSortConfiguration;
|
|
6571
|
-
/**
|
|
6572
|
-
* <p>The label options (label text, label visibility, and sort icon visibility) for the word cloud category.</p>
|
|
6573
|
-
* @public
|
|
6574
|
-
*/
|
|
6575
|
-
CategoryLabelOptions?: ChartAxisLabelOptions;
|
|
6576
|
-
/**
|
|
6577
|
-
* <p>The options for a word cloud visual.</p>
|
|
6578
|
-
* @public
|
|
6579
|
-
*/
|
|
6580
|
-
WordCloudOptions?: WordCloudOptions;
|
|
6581
|
-
/**
|
|
6582
|
-
* <p>The general visual interactions setup for a visual.</p>
|
|
6583
|
-
* @public
|
|
6584
|
-
*/
|
|
6585
|
-
Interactions?: VisualInteractionOptions;
|
|
6586
|
-
}
|
|
6587
|
-
/**
|
|
6588
|
-
* <p>A word cloud.</p>
|
|
6589
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6590
|
-
* @public
|
|
6591
|
-
*/
|
|
6592
|
-
export interface WordCloudVisual {
|
|
6593
|
-
/**
|
|
6594
|
-
* <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>
|
|
6595
|
-
* @public
|
|
6596
|
-
*/
|
|
6597
|
-
VisualId: string | undefined;
|
|
6598
|
-
/**
|
|
6599
|
-
* <p>The title that is displayed on the visual.</p>
|
|
6600
|
-
* @public
|
|
6601
|
-
*/
|
|
6602
|
-
Title?: VisualTitleLabelOptions;
|
|
6603
|
-
/**
|
|
6604
|
-
* <p>The subtitle that is displayed on the visual.</p>
|
|
6605
|
-
* @public
|
|
6606
|
-
*/
|
|
6607
|
-
Subtitle?: VisualSubtitleLabelOptions;
|
|
6608
|
-
/**
|
|
6609
|
-
* <p>The configuration settings of the visual.</p>
|
|
6610
|
-
* @public
|
|
6611
|
-
*/
|
|
6612
|
-
ChartConfiguration?: WordCloudChartConfiguration;
|
|
6613
|
-
/**
|
|
6614
|
-
* <p>The list of custom actions that are configured for a visual.</p>
|
|
6615
|
-
* @public
|
|
6616
|
-
*/
|
|
6617
|
-
Actions?: VisualCustomAction[];
|
|
6618
|
-
/**
|
|
6619
|
-
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
6620
|
-
* @public
|
|
6621
|
-
*/
|
|
6622
|
-
ColumnHierarchies?: ColumnHierarchy[];
|
|
6623
|
-
}
|
|
6624
|
-
/**
|
|
6625
|
-
* <p>A visual displayed on a sheet in an analysis, dashboard, or template.</p>
|
|
6626
|
-
* <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
|
|
6627
|
-
* @public
|
|
6628
|
-
*/
|
|
6629
|
-
export interface Visual {
|
|
6630
|
-
/**
|
|
6631
|
-
* <p>A table visual.</p>
|
|
6632
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6633
|
-
* @public
|
|
6634
|
-
*/
|
|
6635
|
-
TableVisual?: TableVisual;
|
|
6636
|
-
/**
|
|
6637
|
-
* <p>A pivot table.</p>
|
|
6638
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6639
|
-
* @public
|
|
6640
|
-
*/
|
|
6641
|
-
PivotTableVisual?: PivotTableVisual;
|
|
6642
|
-
/**
|
|
6643
|
-
* <p>A bar chart.</p>
|
|
6644
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html">Using bar charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6645
|
-
* @public
|
|
6646
|
-
*/
|
|
6647
|
-
BarChartVisual?: BarChartVisual;
|
|
6648
|
-
/**
|
|
6649
|
-
* <p>A key performance indicator (KPI).</p>
|
|
6650
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/kpi.html">Using KPIs</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6651
|
-
* @public
|
|
6652
|
-
*/
|
|
6653
|
-
KPIVisual?: KPIVisual;
|
|
6654
|
-
/**
|
|
6655
|
-
* <p>A pie or donut chart.</p>
|
|
6656
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6657
|
-
* @public
|
|
6658
|
-
*/
|
|
6659
|
-
PieChartVisual?: PieChartVisual;
|
|
6660
|
-
/**
|
|
6661
|
-
* <p>A gauge chart.</p>
|
|
6662
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6663
|
-
* @public
|
|
6664
|
-
*/
|
|
6665
|
-
GaugeChartVisual?: GaugeChartVisual;
|
|
6666
|
-
/**
|
|
6667
|
-
* <p>A line chart.</p>
|
|
6668
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6669
|
-
* @public
|
|
6670
|
-
*/
|
|
6671
|
-
LineChartVisual?: LineChartVisual;
|
|
6672
|
-
/**
|
|
6673
|
-
* <p>A heat map.</p>
|
|
6674
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6675
|
-
* @public
|
|
6676
|
-
*/
|
|
6677
|
-
HeatMapVisual?: HeatMapVisual;
|
|
6678
|
-
/**
|
|
6679
|
-
* <p>A tree map.</p>
|
|
6680
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6681
|
-
* @public
|
|
6682
|
-
*/
|
|
6683
|
-
TreeMapVisual?: TreeMapVisual;
|
|
6684
|
-
/**
|
|
6685
|
-
* <p>A geospatial map or a points on map visual.</p>
|
|
6686
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6687
|
-
* @public
|
|
6688
|
-
*/
|
|
6689
|
-
GeospatialMapVisual?: GeospatialMapVisual;
|
|
6690
|
-
/**
|
|
6691
|
-
* <p>A filled map.</p>
|
|
6692
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6693
|
-
* @public
|
|
6694
|
-
*/
|
|
6695
|
-
FilledMapVisual?: FilledMapVisual;
|
|
6696
|
-
/**
|
|
6697
|
-
* <p>A funnel chart.</p>
|
|
6698
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6699
|
-
* @public
|
|
6700
|
-
*/
|
|
6701
|
-
FunnelChartVisual?: FunnelChartVisual;
|
|
6702
|
-
/**
|
|
6703
|
-
* <p>A scatter plot.</p>
|
|
6704
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6705
|
-
* @public
|
|
6706
|
-
*/
|
|
6707
|
-
ScatterPlotVisual?: ScatterPlotVisual;
|
|
6708
|
-
/**
|
|
6709
|
-
* <p>A combo chart.</p>
|
|
6710
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6711
|
-
* @public
|
|
6712
|
-
*/
|
|
6713
|
-
ComboChartVisual?: ComboChartVisual;
|
|
6714
|
-
/**
|
|
6715
|
-
* <p>A box plot.</p>
|
|
6716
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6717
|
-
* @public
|
|
6718
|
-
*/
|
|
6719
|
-
BoxPlotVisual?: BoxPlotVisual;
|
|
6720
|
-
/**
|
|
6721
|
-
* <p>A waterfall chart.</p>
|
|
6722
|
-
* <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>
|
|
6723
|
-
* @public
|
|
6724
|
-
*/
|
|
6725
|
-
WaterfallVisual?: WaterfallVisual;
|
|
6726
|
-
/**
|
|
6727
|
-
* <p>A histogram.</p>
|
|
6728
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6729
|
-
* @public
|
|
6730
|
-
*/
|
|
6731
|
-
HistogramVisual?: HistogramVisual;
|
|
6732
|
-
/**
|
|
6733
|
-
* <p>A word cloud.</p>
|
|
6734
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6735
|
-
* @public
|
|
6736
|
-
*/
|
|
6737
|
-
WordCloudVisual?: WordCloudVisual;
|
|
6738
|
-
/**
|
|
6739
|
-
* <p>An insight visual.</p>
|
|
6740
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6741
|
-
* @public
|
|
6742
|
-
*/
|
|
6743
|
-
InsightVisual?: InsightVisual;
|
|
6744
|
-
/**
|
|
6745
|
-
* <p>A sankey diagram.</p>
|
|
6746
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6747
|
-
* @public
|
|
6748
|
-
*/
|
|
6749
|
-
SankeyDiagramVisual?: SankeyDiagramVisual;
|
|
6750
|
-
/**
|
|
6751
|
-
* <p>A visual that contains custom content.</p>
|
|
6752
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6753
|
-
* @public
|
|
6754
|
-
*/
|
|
6755
|
-
CustomContentVisual?: CustomContentVisual;
|
|
6756
|
-
/**
|
|
6757
|
-
* <p>An empty visual.</p>
|
|
6758
|
-
* @public
|
|
6759
|
-
*/
|
|
6760
|
-
EmptyVisual?: EmptyVisual;
|
|
6761
|
-
/**
|
|
6762
|
-
* <p>A radar chart visual.</p>
|
|
6763
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6764
|
-
* @public
|
|
6765
|
-
*/
|
|
6766
|
-
RadarChartVisual?: RadarChartVisual;
|
|
6767
|
-
}
|
|
6768
|
-
/**
|
|
6769
|
-
* <p>A sheet is an object that contains a set of visuals that
|
|
6770
|
-
* are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.</p>
|
|
6771
|
-
* @public
|
|
6772
|
-
*/
|
|
6773
|
-
export interface SheetDefinition {
|
|
6774
|
-
/**
|
|
6775
|
-
* <p>The unique identifier of a sheet.</p>
|
|
6776
|
-
* @public
|
|
6777
|
-
*/
|
|
6778
|
-
SheetId: string | undefined;
|
|
6779
|
-
/**
|
|
6780
|
-
* <p>The title of the sheet.</p>
|
|
6781
|
-
* @public
|
|
6782
|
-
*/
|
|
6783
|
-
Title?: string;
|
|
6784
|
-
/**
|
|
6785
|
-
* <p>A description of the sheet.</p>
|
|
6786
|
-
* @public
|
|
6787
|
-
*/
|
|
6788
|
-
Description?: string;
|
|
6789
|
-
/**
|
|
6790
|
-
* <p>The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight
|
|
6791
|
-
* console.</p>
|
|
6792
|
-
* @public
|
|
6793
|
-
*/
|
|
6794
|
-
Name?: string;
|
|
6795
|
-
/**
|
|
6796
|
-
* <p>The list of parameter controls that are on a sheet.</p>
|
|
6797
|
-
* <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 QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6798
|
-
* @public
|
|
6799
|
-
*/
|
|
6800
|
-
ParameterControls?: ParameterControl[];
|
|
6801
|
-
/**
|
|
6802
|
-
* <p>The list of filter controls that are on a sheet.</p>
|
|
6803
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6804
|
-
* @public
|
|
6805
|
-
*/
|
|
6806
|
-
FilterControls?: FilterControl[];
|
|
6807
|
-
/**
|
|
6808
|
-
* <p>A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.</p>
|
|
6809
|
-
* @public
|
|
6810
|
-
*/
|
|
6811
|
-
Visuals?: Visual[];
|
|
6812
|
-
/**
|
|
6813
|
-
* <p>The text boxes that are on a sheet.</p>
|
|
6814
|
-
* @public
|
|
6815
|
-
*/
|
|
6816
|
-
TextBoxes?: SheetTextBox[];
|
|
6817
|
-
/**
|
|
6818
|
-
* <p>Layouts define how the components of a sheet are arranged.</p>
|
|
6819
|
-
* <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 QuickSight User Guide</i>.</p>
|
|
6820
|
-
* @public
|
|
6821
|
-
*/
|
|
6822
|
-
Layouts?: Layout[];
|
|
6823
|
-
/**
|
|
6824
|
-
* <p>The control layouts of the sheet.</p>
|
|
6825
|
-
* @public
|
|
6826
|
-
*/
|
|
6827
|
-
SheetControlLayouts?: SheetControlLayout[];
|
|
6828
|
-
/**
|
|
6829
|
-
* <p>The layout content type of the sheet. Choose one of the following options:</p>
|
|
6830
|
-
* <ul>
|
|
6831
|
-
* <li>
|
|
6832
|
-
* <p>
|
|
6833
|
-
* <code>PAGINATED</code>: Creates a sheet for a paginated report.</p>
|
|
6834
|
-
* </li>
|
|
6835
|
-
* <li>
|
|
6836
|
-
* <p>
|
|
6837
|
-
* <code>INTERACTIVE</code>: Creates a sheet for an interactive dashboard.</p>
|
|
6838
|
-
* </li>
|
|
6839
|
-
* </ul>
|
|
6840
|
-
* @public
|
|
6841
|
-
*/
|
|
6842
|
-
ContentType?: SheetContentType;
|
|
6843
|
-
}
|
|
6844
|
-
/**
|
|
6845
|
-
* <p>The definition of an analysis.</p>
|
|
6846
|
-
* @public
|
|
6847
|
-
*/
|
|
6848
|
-
export interface AnalysisDefinition {
|
|
6849
|
-
/**
|
|
6850
|
-
* <p>An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead
|
|
6851
|
-
* of dataset ARNs throughout analysis sub-structures.</p>
|
|
6852
|
-
* @public
|
|
6853
|
-
*/
|
|
6854
|
-
DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined;
|
|
6855
|
-
/**
|
|
6856
|
-
* <p>An array of sheet definitions for an analysis. Each <code>SheetDefinition</code> provides detailed information about
|
|
6857
|
-
* a sheet within this analysis.</p>
|
|
6858
|
-
* @public
|
|
6859
|
-
*/
|
|
6860
|
-
Sheets?: SheetDefinition[];
|
|
6861
|
-
/**
|
|
6862
|
-
* <p>An array of calculated field definitions for the analysis.</p>
|
|
6863
|
-
* @public
|
|
6864
|
-
*/
|
|
6865
|
-
CalculatedFields?: CalculatedField[];
|
|
6866
|
-
/**
|
|
6867
|
-
* <p>An array of parameter declarations for an analysis.</p>
|
|
6868
|
-
* <p>Parameters are named variables that can transfer a value for use by an action or an object.</p>
|
|
6869
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6870
|
-
* @public
|
|
6871
|
-
*/
|
|
6872
|
-
ParameterDeclarations?: ParameterDeclaration[];
|
|
6873
|
-
/**
|
|
6874
|
-
* <p>Filter definitions for an analysis.</p>
|
|
6875
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
6876
|
-
* @public
|
|
6877
|
-
*/
|
|
6878
|
-
FilterGroups?: FilterGroup[];
|
|
6879
|
-
/**
|
|
6880
|
-
* <p>
|
|
6881
|
-
* An array of analysis-level column configurations. Column configurations can be used to set default
|
|
6882
|
-
* formatting for a column to be used throughout an analysis.
|
|
6883
|
-
* </p>
|
|
6884
|
-
* @public
|
|
6885
|
-
*/
|
|
6886
|
-
ColumnConfigurations?: ColumnConfiguration[];
|
|
6887
|
-
/**
|
|
6888
|
-
* <p>The configuration for default analysis settings.</p>
|
|
6889
|
-
* @public
|
|
6890
|
-
*/
|
|
6891
|
-
AnalysisDefaults?: AnalysisDefaults;
|
|
6892
|
-
/**
|
|
6893
|
-
* <p>An array of option definitions for an analysis.</p>
|
|
6894
|
-
* @public
|
|
6895
|
-
*/
|
|
6896
|
-
Options?: AssetOptions;
|
|
6897
|
-
}
|
|
6898
|
-
/**
|
|
6899
|
-
* @public
|
|
6900
|
-
* @enum
|
|
6772
|
+
* @internal
|
|
6901
6773
|
*/
|
|
6902
|
-
export declare const
|
|
6903
|
-
readonly ANALYSIS_NAME: "ANALYSIS_NAME";
|
|
6904
|
-
readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
|
|
6905
|
-
readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
|
|
6906
|
-
readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
|
|
6907
|
-
readonly QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER";
|
|
6908
|
-
readonly QUICKSIGHT_USER: "QUICKSIGHT_USER";
|
|
6909
|
-
readonly QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER";
|
|
6910
|
-
};
|
|
6774
|
+
export declare const DataPathValueFilterSensitiveLog: (obj: DataPathValue) => any;
|
|
6911
6775
|
/**
|
|
6912
|
-
* @
|
|
6776
|
+
* @internal
|
|
6913
6777
|
*/
|
|
6914
|
-
export
|
|
6778
|
+
export declare const DataPathColorFilterSensitiveLog: (obj: DataPathColor) => any;
|
|
6915
6779
|
/**
|
|
6916
|
-
* @
|
|
6917
|
-
* @enum
|
|
6780
|
+
* @internal
|
|
6918
6781
|
*/
|
|
6919
|
-
export declare const
|
|
6920
|
-
readonly StringEquals: "StringEquals";
|
|
6921
|
-
readonly StringLike: "StringLike";
|
|
6922
|
-
};
|
|
6782
|
+
export declare const VisualPaletteFilterSensitiveLog: (obj: VisualPalette) => any;
|
|
6923
6783
|
/**
|
|
6924
|
-
* @
|
|
6784
|
+
* @internal
|
|
6925
6785
|
*/
|
|
6926
|
-
export
|
|
6786
|
+
export declare const BarChartConfigurationFilterSensitiveLog: (obj: BarChartConfiguration) => any;
|
|
6927
6787
|
/**
|
|
6928
6788
|
* @internal
|
|
6929
6789
|
*/
|
|
@@ -7456,23 +7316,3 @@ export declare const WordCloudAggregatedFieldWellsFilterSensitiveLog: (obj: Word
|
|
|
7456
7316
|
* @internal
|
|
7457
7317
|
*/
|
|
7458
7318
|
export declare const WordCloudFieldWellsFilterSensitiveLog: (obj: WordCloudFieldWells) => any;
|
|
7459
|
-
/**
|
|
7460
|
-
* @internal
|
|
7461
|
-
*/
|
|
7462
|
-
export declare const WordCloudChartConfigurationFilterSensitiveLog: (obj: WordCloudChartConfiguration) => any;
|
|
7463
|
-
/**
|
|
7464
|
-
* @internal
|
|
7465
|
-
*/
|
|
7466
|
-
export declare const WordCloudVisualFilterSensitiveLog: (obj: WordCloudVisual) => any;
|
|
7467
|
-
/**
|
|
7468
|
-
* @internal
|
|
7469
|
-
*/
|
|
7470
|
-
export declare const VisualFilterSensitiveLog: (obj: Visual) => any;
|
|
7471
|
-
/**
|
|
7472
|
-
* @internal
|
|
7473
|
-
*/
|
|
7474
|
-
export declare const SheetDefinitionFilterSensitiveLog: (obj: SheetDefinition) => any;
|
|
7475
|
-
/**
|
|
7476
|
-
* @internal
|
|
7477
|
-
*/
|
|
7478
|
-
export declare const AnalysisDefinitionFilterSensitiveLog: (obj: AnalysisDefinition) => any;
|