@aws-sdk/client-quicksight 3.686.0 → 3.691.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 +12 -5
- package/dist-es/models/models_2.js +5 -4
- package/dist-es/models/models_3.js +4 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +41 -3
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +21 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +41 -3
- package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +1 -2
- package/dist-types/commands/ListDataSourcesCommand.d.ts +41 -3
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +21 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +41 -3
- package/dist-types/models/models_0.d.ts +525 -525
- package/dist-types/models/models_1.d.ts +743 -743
- package/dist-types/models/models_2.d.ts +601 -582
- package/dist-types/models/models_3.d.ts +844 -845
- package/dist-types/models/models_4.d.ts +707 -656
- package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeTopicRefreshCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +565 -525
- package/dist-types/ts3.4/models/models_1.d.ts +763 -743
- package/dist-types/ts3.4/models/models_2.d.ts +569 -536
- package/dist-types/ts3.4/models/models_3.d.ts +815 -807
- package/dist-types/ts3.4/models/models_4.d.ts +681 -655
- package/package.json +7 -7
|
@@ -11,52 +11,52 @@ export interface TreeMapConfiguration {
|
|
|
11
11
|
* <p>The field wells of the visual.</p>
|
|
12
12
|
* @public
|
|
13
13
|
*/
|
|
14
|
-
FieldWells?: TreeMapFieldWells;
|
|
14
|
+
FieldWells?: TreeMapFieldWells | undefined;
|
|
15
15
|
/**
|
|
16
16
|
* <p>The sort configuration of a tree map.</p>
|
|
17
17
|
* @public
|
|
18
18
|
*/
|
|
19
|
-
SortConfiguration?: TreeMapSortConfiguration;
|
|
19
|
+
SortConfiguration?: TreeMapSortConfiguration | undefined;
|
|
20
20
|
/**
|
|
21
21
|
* <p>The label options (label text, label visibility) of the groups that are displayed in a tree map.</p>
|
|
22
22
|
* @public
|
|
23
23
|
*/
|
|
24
|
-
GroupLabelOptions?: ChartAxisLabelOptions;
|
|
24
|
+
GroupLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
25
25
|
/**
|
|
26
26
|
* <p>The label options (label text, label visibility) of the sizes that are displayed in a tree map.</p>
|
|
27
27
|
* @public
|
|
28
28
|
*/
|
|
29
|
-
SizeLabelOptions?: ChartAxisLabelOptions;
|
|
29
|
+
SizeLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
30
30
|
/**
|
|
31
31
|
* <p>The label options (label text, label visibility) for the colors displayed in a tree map.</p>
|
|
32
32
|
* @public
|
|
33
33
|
*/
|
|
34
|
-
ColorLabelOptions?: ChartAxisLabelOptions;
|
|
34
|
+
ColorLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
35
35
|
/**
|
|
36
36
|
* <p>The color options (gradient color, point of divergence) of a tree map.</p>
|
|
37
37
|
* @public
|
|
38
38
|
*/
|
|
39
|
-
ColorScale?: ColorScale;
|
|
39
|
+
ColorScale?: ColorScale | undefined;
|
|
40
40
|
/**
|
|
41
41
|
* <p>The legend display setup of the visual.</p>
|
|
42
42
|
* @public
|
|
43
43
|
*/
|
|
44
|
-
Legend?: LegendOptions;
|
|
44
|
+
Legend?: LegendOptions | undefined;
|
|
45
45
|
/**
|
|
46
46
|
* <p>The options that determine if visual data labels are displayed.</p>
|
|
47
47
|
* @public
|
|
48
48
|
*/
|
|
49
|
-
DataLabels?: DataLabelOptions;
|
|
49
|
+
DataLabels?: DataLabelOptions | undefined;
|
|
50
50
|
/**
|
|
51
51
|
* <p>The tooltip display setup of the visual.</p>
|
|
52
52
|
* @public
|
|
53
53
|
*/
|
|
54
|
-
Tooltip?: TooltipOptions;
|
|
54
|
+
Tooltip?: TooltipOptions | undefined;
|
|
55
55
|
/**
|
|
56
56
|
* <p>The general visual interactions setup for a visual.</p>
|
|
57
57
|
* @public
|
|
58
58
|
*/
|
|
59
|
-
Interactions?: VisualInteractionOptions;
|
|
59
|
+
Interactions?: VisualInteractionOptions | undefined;
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
62
|
* <p>A tree map.</p>
|
|
@@ -73,27 +73,27 @@ export interface TreeMapVisual {
|
|
|
73
73
|
* <p>The title that is displayed on the visual.</p>
|
|
74
74
|
* @public
|
|
75
75
|
*/
|
|
76
|
-
Title?: VisualTitleLabelOptions;
|
|
76
|
+
Title?: VisualTitleLabelOptions | undefined;
|
|
77
77
|
/**
|
|
78
78
|
* <p>The subtitle that is displayed on the visual.</p>
|
|
79
79
|
* @public
|
|
80
80
|
*/
|
|
81
|
-
Subtitle?: VisualSubtitleLabelOptions;
|
|
81
|
+
Subtitle?: VisualSubtitleLabelOptions | undefined;
|
|
82
82
|
/**
|
|
83
83
|
* <p>The configuration settings of the visual.</p>
|
|
84
84
|
* @public
|
|
85
85
|
*/
|
|
86
|
-
ChartConfiguration?: TreeMapConfiguration;
|
|
86
|
+
ChartConfiguration?: TreeMapConfiguration | undefined;
|
|
87
87
|
/**
|
|
88
88
|
* <p>The list of custom actions that are configured for a visual.</p>
|
|
89
89
|
* @public
|
|
90
90
|
*/
|
|
91
|
-
Actions?: VisualCustomAction[];
|
|
91
|
+
Actions?: VisualCustomAction[] | undefined;
|
|
92
92
|
/**
|
|
93
93
|
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
94
94
|
* @public
|
|
95
95
|
*/
|
|
96
|
-
ColumnHierarchies?: ColumnHierarchy[];
|
|
96
|
+
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
99
|
* <p>The color configuration for individual groups within a waterfall visual.</p>
|
|
@@ -104,17 +104,17 @@ export interface WaterfallChartGroupColorConfiguration {
|
|
|
104
104
|
* <p>Defines the color for the positive bars of a waterfall chart.</p>
|
|
105
105
|
* @public
|
|
106
106
|
*/
|
|
107
|
-
PositiveBarColor?: string;
|
|
107
|
+
PositiveBarColor?: string | undefined;
|
|
108
108
|
/**
|
|
109
109
|
* <p>Defines the color for the negative bars of a waterfall chart.</p>
|
|
110
110
|
* @public
|
|
111
111
|
*/
|
|
112
|
-
NegativeBarColor?: string;
|
|
112
|
+
NegativeBarColor?: string | undefined;
|
|
113
113
|
/**
|
|
114
114
|
* <p>Defines the color for the total bars of a waterfall chart.</p>
|
|
115
115
|
* @public
|
|
116
116
|
*/
|
|
117
|
-
TotalBarColor?: string;
|
|
117
|
+
TotalBarColor?: string | undefined;
|
|
118
118
|
}
|
|
119
119
|
/**
|
|
120
120
|
* <p>The color configuration of a waterfall visual.</p>
|
|
@@ -125,7 +125,7 @@ export interface WaterfallChartColorConfiguration {
|
|
|
125
125
|
* <p>The color configuration for individual groups within a waterfall visual.</p>
|
|
126
126
|
* @public
|
|
127
127
|
*/
|
|
128
|
-
GroupColorConfiguration?: WaterfallChartGroupColorConfiguration;
|
|
128
|
+
GroupColorConfiguration?: WaterfallChartGroupColorConfiguration | undefined;
|
|
129
129
|
}
|
|
130
130
|
/**
|
|
131
131
|
* <p>The field well configuration of a waterfall visual.</p>
|
|
@@ -136,17 +136,17 @@ export interface WaterfallChartAggregatedFieldWells {
|
|
|
136
136
|
* <p>The category field wells of a waterfall visual.</p>
|
|
137
137
|
* @public
|
|
138
138
|
*/
|
|
139
|
-
Categories?: DimensionField[];
|
|
139
|
+
Categories?: DimensionField[] | undefined;
|
|
140
140
|
/**
|
|
141
141
|
* <p>The value field wells of a waterfall visual.</p>
|
|
142
142
|
* @public
|
|
143
143
|
*/
|
|
144
|
-
Values?: MeasureField[];
|
|
144
|
+
Values?: MeasureField[] | undefined;
|
|
145
145
|
/**
|
|
146
146
|
* <p>The breakdown field wells of a waterfall visual.</p>
|
|
147
147
|
* @public
|
|
148
148
|
*/
|
|
149
|
-
Breakdowns?: DimensionField[];
|
|
149
|
+
Breakdowns?: DimensionField[] | undefined;
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
152
|
* <p>The field well configuration of a waterfall visual.</p>
|
|
@@ -157,7 +157,7 @@ export interface WaterfallChartFieldWells {
|
|
|
157
157
|
* <p>The field well configuration of a waterfall visual.</p>
|
|
158
158
|
* @public
|
|
159
159
|
*/
|
|
160
|
-
WaterfallChartAggregatedFieldWells?: WaterfallChartAggregatedFieldWells;
|
|
160
|
+
WaterfallChartAggregatedFieldWells?: WaterfallChartAggregatedFieldWells | undefined;
|
|
161
161
|
}
|
|
162
162
|
/**
|
|
163
163
|
* <p>The sort configuration of a waterfall visual.</p>
|
|
@@ -168,12 +168,12 @@ export interface WaterfallChartSortConfiguration {
|
|
|
168
168
|
* <p>The sort configuration of the category fields.</p>
|
|
169
169
|
* @public
|
|
170
170
|
*/
|
|
171
|
-
CategorySort?: FieldSortOptions[];
|
|
171
|
+
CategorySort?: FieldSortOptions[] | undefined;
|
|
172
172
|
/**
|
|
173
173
|
* <p>The limit on the number of bar groups that are displayed.</p>
|
|
174
174
|
* @public
|
|
175
175
|
*/
|
|
176
|
-
BreakdownItemsLimit?: ItemsLimitConfiguration;
|
|
176
|
+
BreakdownItemsLimit?: ItemsLimitConfiguration | undefined;
|
|
177
177
|
}
|
|
178
178
|
/**
|
|
179
179
|
* <p>The options that determine the presentation of a waterfall visual.</p>
|
|
@@ -184,7 +184,7 @@ export interface WaterfallChartOptions {
|
|
|
184
184
|
* <p>This option determines the total bar label of a waterfall visual.</p>
|
|
185
185
|
* @public
|
|
186
186
|
*/
|
|
187
|
-
TotalBarLabel?: string;
|
|
187
|
+
TotalBarLabel?: string | undefined;
|
|
188
188
|
}
|
|
189
189
|
/**
|
|
190
190
|
* <p>The configuration for a waterfall visual.</p>
|
|
@@ -195,62 +195,62 @@ export interface WaterfallChartConfiguration {
|
|
|
195
195
|
* <p>The field well configuration of a waterfall visual.</p>
|
|
196
196
|
* @public
|
|
197
197
|
*/
|
|
198
|
-
FieldWells?: WaterfallChartFieldWells;
|
|
198
|
+
FieldWells?: WaterfallChartFieldWells | undefined;
|
|
199
199
|
/**
|
|
200
200
|
* <p>The sort configuration of a waterfall visual.</p>
|
|
201
201
|
* @public
|
|
202
202
|
*/
|
|
203
|
-
SortConfiguration?: WaterfallChartSortConfiguration;
|
|
203
|
+
SortConfiguration?: WaterfallChartSortConfiguration | undefined;
|
|
204
204
|
/**
|
|
205
205
|
* <p>The options that determine the presentation of a waterfall visual.</p>
|
|
206
206
|
* @public
|
|
207
207
|
*/
|
|
208
|
-
WaterfallChartOptions?: WaterfallChartOptions;
|
|
208
|
+
WaterfallChartOptions?: WaterfallChartOptions | undefined;
|
|
209
209
|
/**
|
|
210
210
|
* <p>The options that determine the presentation of the category axis label.</p>
|
|
211
211
|
* @public
|
|
212
212
|
*/
|
|
213
|
-
CategoryAxisLabelOptions?: ChartAxisLabelOptions;
|
|
213
|
+
CategoryAxisLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
214
214
|
/**
|
|
215
215
|
* <p>The options that determine the presentation of the category axis.</p>
|
|
216
216
|
* @public
|
|
217
217
|
*/
|
|
218
|
-
CategoryAxisDisplayOptions?: AxisDisplayOptions;
|
|
218
|
+
CategoryAxisDisplayOptions?: AxisDisplayOptions | undefined;
|
|
219
219
|
/**
|
|
220
220
|
* <p>The options that determine the presentation of the y-axis label.</p>
|
|
221
221
|
* @public
|
|
222
222
|
*/
|
|
223
|
-
PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
|
|
223
|
+
PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
224
224
|
/**
|
|
225
225
|
* <p>The options that determine the presentation of the y-axis.</p>
|
|
226
226
|
* @public
|
|
227
227
|
*/
|
|
228
|
-
PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
|
|
228
|
+
PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined;
|
|
229
229
|
/**
|
|
230
230
|
* <p>The legend configuration of a waterfall visual.</p>
|
|
231
231
|
* @public
|
|
232
232
|
*/
|
|
233
|
-
Legend?: LegendOptions;
|
|
233
|
+
Legend?: LegendOptions | undefined;
|
|
234
234
|
/**
|
|
235
235
|
* <p>The data label configuration of a waterfall visual.</p>
|
|
236
236
|
* @public
|
|
237
237
|
*/
|
|
238
|
-
DataLabels?: DataLabelOptions;
|
|
238
|
+
DataLabels?: DataLabelOptions | undefined;
|
|
239
239
|
/**
|
|
240
240
|
* <p>The visual palette configuration of a waterfall visual.</p>
|
|
241
241
|
* @public
|
|
242
242
|
*/
|
|
243
|
-
VisualPalette?: VisualPalette;
|
|
243
|
+
VisualPalette?: VisualPalette | undefined;
|
|
244
244
|
/**
|
|
245
245
|
* <p>The color configuration of a waterfall visual.</p>
|
|
246
246
|
* @public
|
|
247
247
|
*/
|
|
248
|
-
ColorConfiguration?: WaterfallChartColorConfiguration;
|
|
248
|
+
ColorConfiguration?: WaterfallChartColorConfiguration | undefined;
|
|
249
249
|
/**
|
|
250
250
|
* <p>The general visual interactions setup for a visual.</p>
|
|
251
251
|
* @public
|
|
252
252
|
*/
|
|
253
|
-
Interactions?: VisualInteractionOptions;
|
|
253
|
+
Interactions?: VisualInteractionOptions | undefined;
|
|
254
254
|
}
|
|
255
255
|
/**
|
|
256
256
|
* <p>A waterfall chart.</p>
|
|
@@ -267,27 +267,27 @@ export interface WaterfallVisual {
|
|
|
267
267
|
* <p>The title that is displayed on the visual.</p>
|
|
268
268
|
* @public
|
|
269
269
|
*/
|
|
270
|
-
Title?: VisualTitleLabelOptions;
|
|
270
|
+
Title?: VisualTitleLabelOptions | undefined;
|
|
271
271
|
/**
|
|
272
272
|
* <p>The subtitle that is displayed on the visual.</p>
|
|
273
273
|
* @public
|
|
274
274
|
*/
|
|
275
|
-
Subtitle?: VisualSubtitleLabelOptions;
|
|
275
|
+
Subtitle?: VisualSubtitleLabelOptions | undefined;
|
|
276
276
|
/**
|
|
277
277
|
* <p>The configuration for a waterfall visual.</p>
|
|
278
278
|
* @public
|
|
279
279
|
*/
|
|
280
|
-
ChartConfiguration?: WaterfallChartConfiguration;
|
|
280
|
+
ChartConfiguration?: WaterfallChartConfiguration | undefined;
|
|
281
281
|
/**
|
|
282
282
|
* <p>The list of custom actions that are configured for a visual.</p>
|
|
283
283
|
* @public
|
|
284
284
|
*/
|
|
285
|
-
Actions?: VisualCustomAction[];
|
|
285
|
+
Actions?: VisualCustomAction[] | undefined;
|
|
286
286
|
/**
|
|
287
287
|
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
288
288
|
* @public
|
|
289
289
|
*/
|
|
290
|
-
ColumnHierarchies?: ColumnHierarchy[];
|
|
290
|
+
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
291
291
|
}
|
|
292
292
|
/**
|
|
293
293
|
* <p>The aggregated field wells of a word cloud.</p>
|
|
@@ -298,12 +298,12 @@ export interface WordCloudAggregatedFieldWells {
|
|
|
298
298
|
* <p>The group by field well of a word cloud. Values are grouped by group by fields.</p>
|
|
299
299
|
* @public
|
|
300
300
|
*/
|
|
301
|
-
GroupBy?: DimensionField[];
|
|
301
|
+
GroupBy?: DimensionField[] | undefined;
|
|
302
302
|
/**
|
|
303
303
|
* <p>The size field well of a word cloud. Values are aggregated based on group by fields.</p>
|
|
304
304
|
* @public
|
|
305
305
|
*/
|
|
306
|
-
Size?: MeasureField[];
|
|
306
|
+
Size?: MeasureField[] | undefined;
|
|
307
307
|
}
|
|
308
308
|
/**
|
|
309
309
|
* <p>The field wells of a word cloud visual.</p>
|
|
@@ -315,7 +315,7 @@ export interface WordCloudFieldWells {
|
|
|
315
315
|
* <p>The aggregated field wells of a word cloud.</p>
|
|
316
316
|
* @public
|
|
317
317
|
*/
|
|
318
|
-
WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells;
|
|
318
|
+
WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells | undefined;
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
321
321
|
* <p>The sort configuration of a word cloud visual.</p>
|
|
@@ -326,12 +326,12 @@ export interface WordCloudSortConfiguration {
|
|
|
326
326
|
* <p>The limit on the number of groups that are displayed in a word cloud.</p>
|
|
327
327
|
* @public
|
|
328
328
|
*/
|
|
329
|
-
CategoryItemsLimit?: ItemsLimitConfiguration;
|
|
329
|
+
CategoryItemsLimit?: ItemsLimitConfiguration | undefined;
|
|
330
330
|
/**
|
|
331
331
|
* <p>The sort configuration of group by fields.</p>
|
|
332
332
|
* @public
|
|
333
333
|
*/
|
|
334
|
-
CategorySort?: FieldSortOptions[];
|
|
334
|
+
CategorySort?: FieldSortOptions[] | undefined;
|
|
335
335
|
}
|
|
336
336
|
/**
|
|
337
337
|
* @public
|
|
@@ -404,32 +404,32 @@ export interface WordCloudOptions {
|
|
|
404
404
|
* <p>The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.</p>
|
|
405
405
|
* @public
|
|
406
406
|
*/
|
|
407
|
-
WordOrientation?: WordCloudWordOrientation;
|
|
407
|
+
WordOrientation?: WordCloudWordOrientation | undefined;
|
|
408
408
|
/**
|
|
409
409
|
* <p>The word scaling options (emphasize, normal) for the words in a word cloud.</p>
|
|
410
410
|
* @public
|
|
411
411
|
*/
|
|
412
|
-
WordScaling?: WordCloudWordScaling;
|
|
412
|
+
WordScaling?: WordCloudWordScaling | undefined;
|
|
413
413
|
/**
|
|
414
414
|
* <p>The cloud layout options (fluid, normal) of a word cloud.</p>
|
|
415
415
|
* @public
|
|
416
416
|
*/
|
|
417
|
-
CloudLayout?: WordCloudCloudLayout;
|
|
417
|
+
CloudLayout?: WordCloudCloudLayout | undefined;
|
|
418
418
|
/**
|
|
419
419
|
* <p>The word casing options (lower_case, existing_case) for the words in a word cloud.</p>
|
|
420
420
|
* @public
|
|
421
421
|
*/
|
|
422
|
-
WordCasing?: WordCloudWordCasing;
|
|
422
|
+
WordCasing?: WordCloudWordCasing | undefined;
|
|
423
423
|
/**
|
|
424
424
|
* <p>The word padding options (none, small, medium, large) for the words in a word cloud.</p>
|
|
425
425
|
* @public
|
|
426
426
|
*/
|
|
427
|
-
WordPadding?: WordCloudWordPadding;
|
|
427
|
+
WordPadding?: WordCloudWordPadding | undefined;
|
|
428
428
|
/**
|
|
429
429
|
* <p>The length limit of each word from 1-100.</p>
|
|
430
430
|
* @public
|
|
431
431
|
*/
|
|
432
|
-
MaximumStringLength?: number;
|
|
432
|
+
MaximumStringLength?: number | undefined;
|
|
433
433
|
}
|
|
434
434
|
/**
|
|
435
435
|
* <p>The configuration of a word cloud visual.</p>
|
|
@@ -440,27 +440,27 @@ export interface WordCloudChartConfiguration {
|
|
|
440
440
|
* <p>The field wells of the visual.</p>
|
|
441
441
|
* @public
|
|
442
442
|
*/
|
|
443
|
-
FieldWells?: WordCloudFieldWells;
|
|
443
|
+
FieldWells?: WordCloudFieldWells | undefined;
|
|
444
444
|
/**
|
|
445
445
|
* <p>The sort configuration of a word cloud visual.</p>
|
|
446
446
|
* @public
|
|
447
447
|
*/
|
|
448
|
-
SortConfiguration?: WordCloudSortConfiguration;
|
|
448
|
+
SortConfiguration?: WordCloudSortConfiguration | undefined;
|
|
449
449
|
/**
|
|
450
450
|
* <p>The label options (label text, label visibility, and sort icon visibility) for the word cloud category.</p>
|
|
451
451
|
* @public
|
|
452
452
|
*/
|
|
453
|
-
CategoryLabelOptions?: ChartAxisLabelOptions;
|
|
453
|
+
CategoryLabelOptions?: ChartAxisLabelOptions | undefined;
|
|
454
454
|
/**
|
|
455
455
|
* <p>The options for a word cloud visual.</p>
|
|
456
456
|
* @public
|
|
457
457
|
*/
|
|
458
|
-
WordCloudOptions?: WordCloudOptions;
|
|
458
|
+
WordCloudOptions?: WordCloudOptions | undefined;
|
|
459
459
|
/**
|
|
460
460
|
* <p>The general visual interactions setup for a visual.</p>
|
|
461
461
|
* @public
|
|
462
462
|
*/
|
|
463
|
-
Interactions?: VisualInteractionOptions;
|
|
463
|
+
Interactions?: VisualInteractionOptions | undefined;
|
|
464
464
|
}
|
|
465
465
|
/**
|
|
466
466
|
* <p>A word cloud.</p>
|
|
@@ -477,27 +477,27 @@ export interface WordCloudVisual {
|
|
|
477
477
|
* <p>The title that is displayed on the visual.</p>
|
|
478
478
|
* @public
|
|
479
479
|
*/
|
|
480
|
-
Title?: VisualTitleLabelOptions;
|
|
480
|
+
Title?: VisualTitleLabelOptions | undefined;
|
|
481
481
|
/**
|
|
482
482
|
* <p>The subtitle that is displayed on the visual.</p>
|
|
483
483
|
* @public
|
|
484
484
|
*/
|
|
485
|
-
Subtitle?: VisualSubtitleLabelOptions;
|
|
485
|
+
Subtitle?: VisualSubtitleLabelOptions | undefined;
|
|
486
486
|
/**
|
|
487
487
|
* <p>The configuration settings of the visual.</p>
|
|
488
488
|
* @public
|
|
489
489
|
*/
|
|
490
|
-
ChartConfiguration?: WordCloudChartConfiguration;
|
|
490
|
+
ChartConfiguration?: WordCloudChartConfiguration | undefined;
|
|
491
491
|
/**
|
|
492
492
|
* <p>The list of custom actions that are configured for a visual.</p>
|
|
493
493
|
* @public
|
|
494
494
|
*/
|
|
495
|
-
Actions?: VisualCustomAction[];
|
|
495
|
+
Actions?: VisualCustomAction[] | undefined;
|
|
496
496
|
/**
|
|
497
497
|
* <p>The column hierarchy that is used during drill-downs and drill-ups.</p>
|
|
498
498
|
* @public
|
|
499
499
|
*/
|
|
500
|
-
ColumnHierarchies?: ColumnHierarchy[];
|
|
500
|
+
ColumnHierarchies?: ColumnHierarchy[] | undefined;
|
|
501
501
|
}
|
|
502
502
|
/**
|
|
503
503
|
* <p>A visual displayed on a sheet in an analysis, dashboard, or template.</p>
|
|
@@ -510,138 +510,138 @@ export interface Visual {
|
|
|
510
510
|
* <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>
|
|
511
511
|
* @public
|
|
512
512
|
*/
|
|
513
|
-
TableVisual?: TableVisual;
|
|
513
|
+
TableVisual?: TableVisual | undefined;
|
|
514
514
|
/**
|
|
515
515
|
* <p>A pivot table.</p>
|
|
516
516
|
* <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>
|
|
517
517
|
* @public
|
|
518
518
|
*/
|
|
519
|
-
PivotTableVisual?: PivotTableVisual;
|
|
519
|
+
PivotTableVisual?: PivotTableVisual | undefined;
|
|
520
520
|
/**
|
|
521
521
|
* <p>A bar chart.</p>
|
|
522
522
|
* <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>
|
|
523
523
|
* @public
|
|
524
524
|
*/
|
|
525
|
-
BarChartVisual?: BarChartVisual;
|
|
525
|
+
BarChartVisual?: BarChartVisual | undefined;
|
|
526
526
|
/**
|
|
527
527
|
* <p>A key performance indicator (KPI).</p>
|
|
528
528
|
* <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>
|
|
529
529
|
* @public
|
|
530
530
|
*/
|
|
531
|
-
KPIVisual?: KPIVisual;
|
|
531
|
+
KPIVisual?: KPIVisual | undefined;
|
|
532
532
|
/**
|
|
533
533
|
* <p>A pie or donut chart.</p>
|
|
534
534
|
* <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>
|
|
535
535
|
* @public
|
|
536
536
|
*/
|
|
537
|
-
PieChartVisual?: PieChartVisual;
|
|
537
|
+
PieChartVisual?: PieChartVisual | undefined;
|
|
538
538
|
/**
|
|
539
539
|
* <p>A gauge chart.</p>
|
|
540
540
|
* <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>
|
|
541
541
|
* @public
|
|
542
542
|
*/
|
|
543
|
-
GaugeChartVisual?: GaugeChartVisual;
|
|
543
|
+
GaugeChartVisual?: GaugeChartVisual | undefined;
|
|
544
544
|
/**
|
|
545
545
|
* <p>A line chart.</p>
|
|
546
546
|
* <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>
|
|
547
547
|
* @public
|
|
548
548
|
*/
|
|
549
|
-
LineChartVisual?: LineChartVisual;
|
|
549
|
+
LineChartVisual?: LineChartVisual | undefined;
|
|
550
550
|
/**
|
|
551
551
|
* <p>A heat map.</p>
|
|
552
552
|
* <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>
|
|
553
553
|
* @public
|
|
554
554
|
*/
|
|
555
|
-
HeatMapVisual?: HeatMapVisual;
|
|
555
|
+
HeatMapVisual?: HeatMapVisual | undefined;
|
|
556
556
|
/**
|
|
557
557
|
* <p>A tree map.</p>
|
|
558
558
|
* <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>
|
|
559
559
|
* @public
|
|
560
560
|
*/
|
|
561
|
-
TreeMapVisual?: TreeMapVisual;
|
|
561
|
+
TreeMapVisual?: TreeMapVisual | undefined;
|
|
562
562
|
/**
|
|
563
563
|
* <p>A geospatial map or a points on map visual.</p>
|
|
564
564
|
* <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>
|
|
565
565
|
* @public
|
|
566
566
|
*/
|
|
567
|
-
GeospatialMapVisual?: GeospatialMapVisual;
|
|
567
|
+
GeospatialMapVisual?: GeospatialMapVisual | undefined;
|
|
568
568
|
/**
|
|
569
569
|
* <p>A filled map.</p>
|
|
570
570
|
* <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>
|
|
571
571
|
* @public
|
|
572
572
|
*/
|
|
573
|
-
FilledMapVisual?: FilledMapVisual;
|
|
573
|
+
FilledMapVisual?: FilledMapVisual | undefined;
|
|
574
574
|
/**
|
|
575
575
|
* <p>A funnel chart.</p>
|
|
576
576
|
* <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>
|
|
577
577
|
* @public
|
|
578
578
|
*/
|
|
579
|
-
FunnelChartVisual?: FunnelChartVisual;
|
|
579
|
+
FunnelChartVisual?: FunnelChartVisual | undefined;
|
|
580
580
|
/**
|
|
581
581
|
* <p>A scatter plot.</p>
|
|
582
582
|
* <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>
|
|
583
583
|
* @public
|
|
584
584
|
*/
|
|
585
|
-
ScatterPlotVisual?: ScatterPlotVisual;
|
|
585
|
+
ScatterPlotVisual?: ScatterPlotVisual | undefined;
|
|
586
586
|
/**
|
|
587
587
|
* <p>A combo chart.</p>
|
|
588
588
|
* <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>
|
|
589
589
|
* @public
|
|
590
590
|
*/
|
|
591
|
-
ComboChartVisual?: ComboChartVisual;
|
|
591
|
+
ComboChartVisual?: ComboChartVisual | undefined;
|
|
592
592
|
/**
|
|
593
593
|
* <p>A box plot.</p>
|
|
594
594
|
* <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>
|
|
595
595
|
* @public
|
|
596
596
|
*/
|
|
597
|
-
BoxPlotVisual?: BoxPlotVisual;
|
|
597
|
+
BoxPlotVisual?: BoxPlotVisual | undefined;
|
|
598
598
|
/**
|
|
599
599
|
* <p>A waterfall chart.</p>
|
|
600
600
|
* <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>
|
|
601
601
|
* @public
|
|
602
602
|
*/
|
|
603
|
-
WaterfallVisual?: WaterfallVisual;
|
|
603
|
+
WaterfallVisual?: WaterfallVisual | undefined;
|
|
604
604
|
/**
|
|
605
605
|
* <p>A histogram.</p>
|
|
606
606
|
* <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>
|
|
607
607
|
* @public
|
|
608
608
|
*/
|
|
609
|
-
HistogramVisual?: HistogramVisual;
|
|
609
|
+
HistogramVisual?: HistogramVisual | undefined;
|
|
610
610
|
/**
|
|
611
611
|
* <p>A word cloud.</p>
|
|
612
612
|
* <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>
|
|
613
613
|
* @public
|
|
614
614
|
*/
|
|
615
|
-
WordCloudVisual?: WordCloudVisual;
|
|
615
|
+
WordCloudVisual?: WordCloudVisual | undefined;
|
|
616
616
|
/**
|
|
617
617
|
* <p>An insight visual.</p>
|
|
618
618
|
* <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>
|
|
619
619
|
* @public
|
|
620
620
|
*/
|
|
621
|
-
InsightVisual?: InsightVisual;
|
|
621
|
+
InsightVisual?: InsightVisual | undefined;
|
|
622
622
|
/**
|
|
623
623
|
* <p>A sankey diagram.</p>
|
|
624
624
|
* <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>
|
|
625
625
|
* @public
|
|
626
626
|
*/
|
|
627
|
-
SankeyDiagramVisual?: SankeyDiagramVisual;
|
|
627
|
+
SankeyDiagramVisual?: SankeyDiagramVisual | undefined;
|
|
628
628
|
/**
|
|
629
629
|
* <p>A visual that contains custom content.</p>
|
|
630
630
|
* <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>
|
|
631
631
|
* @public
|
|
632
632
|
*/
|
|
633
|
-
CustomContentVisual?: CustomContentVisual;
|
|
633
|
+
CustomContentVisual?: CustomContentVisual | undefined;
|
|
634
634
|
/**
|
|
635
635
|
* <p>An empty visual.</p>
|
|
636
636
|
* @public
|
|
637
637
|
*/
|
|
638
|
-
EmptyVisual?: EmptyVisual;
|
|
638
|
+
EmptyVisual?: EmptyVisual | undefined;
|
|
639
639
|
/**
|
|
640
640
|
* <p>A radar chart visual.</p>
|
|
641
641
|
* <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>
|
|
642
642
|
* @public
|
|
643
643
|
*/
|
|
644
|
-
RadarChartVisual?: RadarChartVisual;
|
|
644
|
+
RadarChartVisual?: RadarChartVisual | undefined;
|
|
645
645
|
}
|
|
646
646
|
/**
|
|
647
647
|
* <p>A sheet is an object that contains a set of visuals that
|
|
@@ -658,51 +658,51 @@ export interface SheetDefinition {
|
|
|
658
658
|
* <p>The title of the sheet.</p>
|
|
659
659
|
* @public
|
|
660
660
|
*/
|
|
661
|
-
Title?: string;
|
|
661
|
+
Title?: string | undefined;
|
|
662
662
|
/**
|
|
663
663
|
* <p>A description of the sheet.</p>
|
|
664
664
|
* @public
|
|
665
665
|
*/
|
|
666
|
-
Description?: string;
|
|
666
|
+
Description?: string | undefined;
|
|
667
667
|
/**
|
|
668
668
|
* <p>The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight
|
|
669
669
|
* console.</p>
|
|
670
670
|
* @public
|
|
671
671
|
*/
|
|
672
|
-
Name?: string;
|
|
672
|
+
Name?: string | undefined;
|
|
673
673
|
/**
|
|
674
674
|
* <p>The list of parameter controls that are on a sheet.</p>
|
|
675
675
|
* <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>
|
|
676
676
|
* @public
|
|
677
677
|
*/
|
|
678
|
-
ParameterControls?: ParameterControl[];
|
|
678
|
+
ParameterControls?: ParameterControl[] | undefined;
|
|
679
679
|
/**
|
|
680
680
|
* <p>The list of filter controls that are on a sheet.</p>
|
|
681
681
|
* <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>
|
|
682
682
|
* @public
|
|
683
683
|
*/
|
|
684
|
-
FilterControls?: FilterControl[];
|
|
684
|
+
FilterControls?: FilterControl[] | undefined;
|
|
685
685
|
/**
|
|
686
686
|
* <p>A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.</p>
|
|
687
687
|
* @public
|
|
688
688
|
*/
|
|
689
|
-
Visuals?: Visual[];
|
|
689
|
+
Visuals?: Visual[] | undefined;
|
|
690
690
|
/**
|
|
691
691
|
* <p>The text boxes that are on a sheet.</p>
|
|
692
692
|
* @public
|
|
693
693
|
*/
|
|
694
|
-
TextBoxes?: SheetTextBox[];
|
|
694
|
+
TextBoxes?: SheetTextBox[] | undefined;
|
|
695
695
|
/**
|
|
696
696
|
* <p>Layouts define how the components of a sheet are arranged.</p>
|
|
697
697
|
* <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>
|
|
698
698
|
* @public
|
|
699
699
|
*/
|
|
700
|
-
Layouts?: Layout[];
|
|
700
|
+
Layouts?: Layout[] | undefined;
|
|
701
701
|
/**
|
|
702
702
|
* <p>The control layouts of the sheet.</p>
|
|
703
703
|
* @public
|
|
704
704
|
*/
|
|
705
|
-
SheetControlLayouts?: SheetControlLayout[];
|
|
705
|
+
SheetControlLayouts?: SheetControlLayout[] | undefined;
|
|
706
706
|
/**
|
|
707
707
|
* <p>The layout content type of the sheet. Choose one of the following options:</p>
|
|
708
708
|
* <ul>
|
|
@@ -717,7 +717,7 @@ export interface SheetDefinition {
|
|
|
717
717
|
* </ul>
|
|
718
718
|
* @public
|
|
719
719
|
*/
|
|
720
|
-
ContentType?: SheetContentType;
|
|
720
|
+
ContentType?: SheetContentType | undefined;
|
|
721
721
|
}
|
|
722
722
|
/**
|
|
723
723
|
* <p>The definition of an analysis.</p>
|
|
@@ -735,25 +735,25 @@ export interface AnalysisDefinition {
|
|
|
735
735
|
* a sheet within this analysis.</p>
|
|
736
736
|
* @public
|
|
737
737
|
*/
|
|
738
|
-
Sheets?: SheetDefinition[];
|
|
738
|
+
Sheets?: SheetDefinition[] | undefined;
|
|
739
739
|
/**
|
|
740
740
|
* <p>An array of calculated field definitions for the analysis.</p>
|
|
741
741
|
* @public
|
|
742
742
|
*/
|
|
743
|
-
CalculatedFields?: CalculatedField[];
|
|
743
|
+
CalculatedFields?: CalculatedField[] | undefined;
|
|
744
744
|
/**
|
|
745
745
|
* <p>An array of parameter declarations for an analysis.</p>
|
|
746
746
|
* <p>Parameters are named variables that can transfer a value for use by an action or an object.</p>
|
|
747
747
|
* <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>
|
|
748
748
|
* @public
|
|
749
749
|
*/
|
|
750
|
-
ParameterDeclarations?: ParameterDeclaration[];
|
|
750
|
+
ParameterDeclarations?: ParameterDeclaration[] | undefined;
|
|
751
751
|
/**
|
|
752
752
|
* <p>Filter definitions for an analysis.</p>
|
|
753
753
|
* <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>
|
|
754
754
|
* @public
|
|
755
755
|
*/
|
|
756
|
-
FilterGroups?: FilterGroup[];
|
|
756
|
+
FilterGroups?: FilterGroup[] | undefined;
|
|
757
757
|
/**
|
|
758
758
|
* <p>
|
|
759
759
|
* An array of analysis-level column configurations. Column configurations can be used to set default
|
|
@@ -761,22 +761,22 @@ export interface AnalysisDefinition {
|
|
|
761
761
|
* </p>
|
|
762
762
|
* @public
|
|
763
763
|
*/
|
|
764
|
-
ColumnConfigurations?: ColumnConfiguration[];
|
|
764
|
+
ColumnConfigurations?: ColumnConfiguration[] | undefined;
|
|
765
765
|
/**
|
|
766
766
|
* <p>The configuration for default analysis settings.</p>
|
|
767
767
|
* @public
|
|
768
768
|
*/
|
|
769
|
-
AnalysisDefaults?: AnalysisDefaults;
|
|
769
|
+
AnalysisDefaults?: AnalysisDefaults | undefined;
|
|
770
770
|
/**
|
|
771
771
|
* <p>An array of option definitions for an analysis.</p>
|
|
772
772
|
* @public
|
|
773
773
|
*/
|
|
774
|
-
Options?: AssetOptions;
|
|
774
|
+
Options?: AssetOptions | undefined;
|
|
775
775
|
/**
|
|
776
776
|
* <p>A structure that describes the query execution options.</p>
|
|
777
777
|
* @public
|
|
778
778
|
*/
|
|
779
|
-
QueryExecutionOptions?: QueryExecutionOptions;
|
|
779
|
+
QueryExecutionOptions?: QueryExecutionOptions | undefined;
|
|
780
780
|
}
|
|
781
781
|
/**
|
|
782
782
|
* @public
|
|
@@ -818,7 +818,7 @@ export interface AnalysisSearchFilter {
|
|
|
818
818
|
* <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>
|
|
819
819
|
* @public
|
|
820
820
|
*/
|
|
821
|
-
Operator?: FilterOperator;
|
|
821
|
+
Operator?: FilterOperator | undefined;
|
|
822
822
|
/**
|
|
823
823
|
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
824
824
|
* "QUICKSIGHT_OWNER"</code>.</p>
|
|
@@ -851,14 +851,14 @@ export interface AnalysisSearchFilter {
|
|
|
851
851
|
* </ul>
|
|
852
852
|
* @public
|
|
853
853
|
*/
|
|
854
|
-
Name?: AnalysisFilterAttribute;
|
|
854
|
+
Name?: AnalysisFilterAttribute | undefined;
|
|
855
855
|
/**
|
|
856
856
|
* <p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want
|
|
857
857
|
* to use as a filter, for example <code>"Value"</code>. An example is
|
|
858
858
|
* <code>"arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
859
859
|
* @public
|
|
860
860
|
*/
|
|
861
|
-
Value?: string;
|
|
861
|
+
Value?: string | undefined;
|
|
862
862
|
}
|
|
863
863
|
/**
|
|
864
864
|
* <p>Dataset reference.</p>
|
|
@@ -901,7 +901,7 @@ export interface AnalysisSourceEntity {
|
|
|
901
901
|
* <p>The source template for the source entity of the analysis.</p>
|
|
902
902
|
* @public
|
|
903
903
|
*/
|
|
904
|
-
SourceTemplate?: AnalysisSourceTemplate;
|
|
904
|
+
SourceTemplate?: AnalysisSourceTemplate | undefined;
|
|
905
905
|
}
|
|
906
906
|
/**
|
|
907
907
|
* <p>The summary metadata that describes an analysis.</p>
|
|
@@ -912,33 +912,33 @@ export interface AnalysisSummary {
|
|
|
912
912
|
* <p>The Amazon Resource Name (ARN) for the analysis.</p>
|
|
913
913
|
* @public
|
|
914
914
|
*/
|
|
915
|
-
Arn?: string;
|
|
915
|
+
Arn?: string | undefined;
|
|
916
916
|
/**
|
|
917
917
|
* <p>The ID of the analysis. This ID displays in the URL.</p>
|
|
918
918
|
* @public
|
|
919
919
|
*/
|
|
920
|
-
AnalysisId?: string;
|
|
920
|
+
AnalysisId?: string | undefined;
|
|
921
921
|
/**
|
|
922
922
|
* <p>The name of the analysis. This name is displayed in the Amazon QuickSight console.
|
|
923
923
|
* </p>
|
|
924
924
|
* @public
|
|
925
925
|
*/
|
|
926
|
-
Name?: string;
|
|
926
|
+
Name?: string | undefined;
|
|
927
927
|
/**
|
|
928
928
|
* <p>The last known status for the analysis.</p>
|
|
929
929
|
* @public
|
|
930
930
|
*/
|
|
931
|
-
Status?: ResourceStatus;
|
|
931
|
+
Status?: ResourceStatus | undefined;
|
|
932
932
|
/**
|
|
933
933
|
* <p>The time that the analysis was created.</p>
|
|
934
934
|
* @public
|
|
935
935
|
*/
|
|
936
|
-
CreatedTime?: Date;
|
|
936
|
+
CreatedTime?: Date | undefined;
|
|
937
937
|
/**
|
|
938
938
|
* <p>The time that the analysis was last updated.</p>
|
|
939
939
|
* @public
|
|
940
940
|
*/
|
|
941
|
-
LastUpdatedTime?: Date;
|
|
941
|
+
LastUpdatedTime?: Date | undefined;
|
|
942
942
|
}
|
|
943
943
|
/**
|
|
944
944
|
* @public
|
|
@@ -960,17 +960,17 @@ export interface Anchor {
|
|
|
960
960
|
* <p>The <code>AnchorType</code> for the Anchor.</p>
|
|
961
961
|
* @public
|
|
962
962
|
*/
|
|
963
|
-
AnchorType?: AnchorType;
|
|
963
|
+
AnchorType?: AnchorType | undefined;
|
|
964
964
|
/**
|
|
965
965
|
* <p>The <code>TimeGranularity</code> of the Anchor.</p>
|
|
966
966
|
* @public
|
|
967
967
|
*/
|
|
968
|
-
TimeGranularity?: TimeGranularity;
|
|
968
|
+
TimeGranularity?: TimeGranularity | undefined;
|
|
969
969
|
/**
|
|
970
970
|
* <p>The offset of the Anchor.</p>
|
|
971
971
|
* @public
|
|
972
972
|
*/
|
|
973
|
-
Offset?: number;
|
|
973
|
+
Offset?: number | undefined;
|
|
974
974
|
}
|
|
975
975
|
/**
|
|
976
976
|
* @public
|
|
@@ -1014,7 +1014,7 @@ export interface AnonymousUserDashboardFeatureConfigurations {
|
|
|
1014
1014
|
* <p>The shared view settings of an embedded dashboard.</p>
|
|
1015
1015
|
* @public
|
|
1016
1016
|
*/
|
|
1017
|
-
SharedView?: SharedViewConfigurations;
|
|
1017
|
+
SharedView?: SharedViewConfigurations | undefined;
|
|
1018
1018
|
}
|
|
1019
1019
|
/**
|
|
1020
1020
|
* <p>Information about the dashboard that you want to embed.</p>
|
|
@@ -1031,17 +1031,17 @@ export interface AnonymousUserDashboardEmbeddingConfiguration {
|
|
|
1031
1031
|
* <p>A list of all enabled features of a specified anonymous dashboard.</p>
|
|
1032
1032
|
* @public
|
|
1033
1033
|
*/
|
|
1034
|
-
EnabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationEnabledFeature[];
|
|
1034
|
+
EnabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationEnabledFeature[] | undefined;
|
|
1035
1035
|
/**
|
|
1036
1036
|
* <p>A list of all disabled features of a specified anonymous dashboard.</p>
|
|
1037
1037
|
* @public
|
|
1038
1038
|
*/
|
|
1039
|
-
DisabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationDisabledFeature[];
|
|
1039
|
+
DisabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationDisabledFeature[] | undefined;
|
|
1040
1040
|
/**
|
|
1041
1041
|
* <p>The feature configuration for an embedded dashboard.</p>
|
|
1042
1042
|
* @public
|
|
1043
1043
|
*/
|
|
1044
|
-
FeatureConfigurations?: AnonymousUserDashboardFeatureConfigurations;
|
|
1044
|
+
FeatureConfigurations?: AnonymousUserDashboardFeatureConfigurations | undefined;
|
|
1045
1045
|
}
|
|
1046
1046
|
/**
|
|
1047
1047
|
* <p>A structure that contains the following elements:</p>
|
|
@@ -1121,22 +1121,22 @@ export interface AnonymousUserEmbeddingExperienceConfiguration {
|
|
|
1121
1121
|
* <p>The type of embedding experience. In this case, Amazon QuickSight dashboards.</p>
|
|
1122
1122
|
* @public
|
|
1123
1123
|
*/
|
|
1124
|
-
Dashboard?: AnonymousUserDashboardEmbeddingConfiguration;
|
|
1124
|
+
Dashboard?: AnonymousUserDashboardEmbeddingConfiguration | undefined;
|
|
1125
1125
|
/**
|
|
1126
1126
|
* <p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>
|
|
1127
1127
|
* @public
|
|
1128
1128
|
*/
|
|
1129
|
-
DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration;
|
|
1129
|
+
DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration | undefined;
|
|
1130
1130
|
/**
|
|
1131
1131
|
* <p>The Q search bar that you want to use for anonymous user embedding.</p>
|
|
1132
1132
|
* @public
|
|
1133
1133
|
*/
|
|
1134
|
-
QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration;
|
|
1134
|
+
QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration | undefined;
|
|
1135
1135
|
/**
|
|
1136
1136
|
* <p>The Generative Q&A experience that you want to use for anonymous user embedding.</p>
|
|
1137
1137
|
* @public
|
|
1138
1138
|
*/
|
|
1139
|
-
GenerativeQnA?: AnonymousUserGenerativeQnAEmbeddingConfiguration;
|
|
1139
|
+
GenerativeQnA?: AnonymousUserGenerativeQnAEmbeddingConfiguration | undefined;
|
|
1140
1140
|
}
|
|
1141
1141
|
/**
|
|
1142
1142
|
* @public
|
|
@@ -1194,7 +1194,7 @@ export interface SnapshotFileSheetSelection {
|
|
|
1194
1194
|
* </p>
|
|
1195
1195
|
* @public
|
|
1196
1196
|
*/
|
|
1197
|
-
VisualIds?: string[];
|
|
1197
|
+
VisualIds?: string[] | undefined;
|
|
1198
1198
|
}
|
|
1199
1199
|
/**
|
|
1200
1200
|
* <p>A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.</p>
|
|
@@ -1221,12 +1221,12 @@ export interface SnapshotJobResultErrorInfo {
|
|
|
1221
1221
|
* <p>The error message.</p>
|
|
1222
1222
|
* @public
|
|
1223
1223
|
*/
|
|
1224
|
-
ErrorMessage?: string;
|
|
1224
|
+
ErrorMessage?: string | undefined;
|
|
1225
1225
|
/**
|
|
1226
1226
|
* <p>The error type.</p>
|
|
1227
1227
|
* @public
|
|
1228
1228
|
*/
|
|
1229
|
-
ErrorType?: string;
|
|
1229
|
+
ErrorType?: string | undefined;
|
|
1230
1230
|
}
|
|
1231
1231
|
/**
|
|
1232
1232
|
* <p>An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.</p>
|
|
@@ -1270,17 +1270,17 @@ export interface SnapshotJobS3Result {
|
|
|
1270
1270
|
* </p>
|
|
1271
1271
|
* @public
|
|
1272
1272
|
*/
|
|
1273
|
-
S3DestinationConfiguration?: SnapshotS3DestinationConfiguration;
|
|
1273
|
+
S3DestinationConfiguration?: SnapshotS3DestinationConfiguration | undefined;
|
|
1274
1274
|
/**
|
|
1275
1275
|
* <p>The Amazon S3 Uri.</p>
|
|
1276
1276
|
* @public
|
|
1277
1277
|
*/
|
|
1278
|
-
S3Uri?: string;
|
|
1278
|
+
S3Uri?: string | undefined;
|
|
1279
1279
|
/**
|
|
1280
1280
|
* <p>An array of error records that describe any failures that occur while the dashboard snapshot job runs.</p>
|
|
1281
1281
|
* @public
|
|
1282
1282
|
*/
|
|
1283
|
-
ErrorInfo?: SnapshotJobResultErrorInfo[];
|
|
1283
|
+
ErrorInfo?: SnapshotJobResultErrorInfo[] | undefined;
|
|
1284
1284
|
}
|
|
1285
1285
|
/**
|
|
1286
1286
|
* <p>A structure that contains information on the generated snapshot file groups.</p>
|
|
@@ -1291,12 +1291,12 @@ export interface SnapshotJobResultFileGroup {
|
|
|
1291
1291
|
* <p> A list of <code>SnapshotFile</code> objects.</p>
|
|
1292
1292
|
* @public
|
|
1293
1293
|
*/
|
|
1294
|
-
Files?: SnapshotFile[];
|
|
1294
|
+
Files?: SnapshotFile[] | undefined;
|
|
1295
1295
|
/**
|
|
1296
1296
|
* <p> A list of <code>SnapshotJobS3Result</code> objects.</p>
|
|
1297
1297
|
* @public
|
|
1298
1298
|
*/
|
|
1299
|
-
S3Results?: SnapshotJobS3Result[];
|
|
1299
|
+
S3Results?: SnapshotJobS3Result[] | undefined;
|
|
1300
1300
|
}
|
|
1301
1301
|
/**
|
|
1302
1302
|
* <p>A structure that contains the file groups that are requested for the artifact generation in a <code>StartDashboardSnapshotJob</code> API call.
|
|
@@ -1308,7 +1308,7 @@ export interface AnonymousUserSnapshotJobResult {
|
|
|
1308
1308
|
* <p>A list of <code>SnapshotJobResultFileGroup</code> objects that contain information on the files that are requested during a <code>StartDashboardSnapshotJob</code> API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.</p>
|
|
1309
1309
|
* @public
|
|
1310
1310
|
*/
|
|
1311
|
-
FileGroups?: SnapshotJobResultFileGroup[];
|
|
1311
|
+
FileGroups?: SnapshotJobResultFileGroup[] | undefined;
|
|
1312
1312
|
}
|
|
1313
1313
|
/**
|
|
1314
1314
|
* @public
|
|
@@ -1499,7 +1499,7 @@ export interface AssetBundleExportJobResourceIdOverrideConfiguration {
|
|
|
1499
1499
|
* <p>An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.</p>
|
|
1500
1500
|
* @public
|
|
1501
1501
|
*/
|
|
1502
|
-
PrefixForAllResources?: boolean;
|
|
1502
|
+
PrefixForAllResources?: boolean | undefined;
|
|
1503
1503
|
}
|
|
1504
1504
|
/**
|
|
1505
1505
|
* @public
|
|
@@ -1566,47 +1566,47 @@ export interface AssetBundleCloudFormationOverridePropertyConfiguration {
|
|
|
1566
1566
|
* <p>An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.</p>
|
|
1567
1567
|
* @public
|
|
1568
1568
|
*/
|
|
1569
|
-
ResourceIdOverrideConfiguration?: AssetBundleExportJobResourceIdOverrideConfiguration;
|
|
1569
|
+
ResourceIdOverrideConfiguration?: AssetBundleExportJobResourceIdOverrideConfiguration | undefined;
|
|
1570
1570
|
/**
|
|
1571
1571
|
* <p>An optional list of structures that control how <code>VPCConnection</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1572
1572
|
* @public
|
|
1573
1573
|
*/
|
|
1574
|
-
VPCConnections?: AssetBundleExportJobVPCConnectionOverrideProperties[];
|
|
1574
|
+
VPCConnections?: AssetBundleExportJobVPCConnectionOverrideProperties[] | undefined;
|
|
1575
1575
|
/**
|
|
1576
1576
|
* <p>An optional list of structures that control how <code>RefreshSchedule</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1577
1577
|
* @public
|
|
1578
1578
|
*/
|
|
1579
|
-
RefreshSchedules?: AssetBundleExportJobRefreshScheduleOverrideProperties[];
|
|
1579
|
+
RefreshSchedules?: AssetBundleExportJobRefreshScheduleOverrideProperties[] | undefined;
|
|
1580
1580
|
/**
|
|
1581
1581
|
* <p>An optional list of structures that control how <code>DataSource</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1582
1582
|
* @public
|
|
1583
1583
|
*/
|
|
1584
|
-
DataSources?: AssetBundleExportJobDataSourceOverrideProperties[];
|
|
1584
|
+
DataSources?: AssetBundleExportJobDataSourceOverrideProperties[] | undefined;
|
|
1585
1585
|
/**
|
|
1586
1586
|
* <p>An optional list of structures that control how <code>DataSet</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1587
1587
|
* @public
|
|
1588
1588
|
*/
|
|
1589
|
-
DataSets?: AssetBundleExportJobDataSetOverrideProperties[];
|
|
1589
|
+
DataSets?: AssetBundleExportJobDataSetOverrideProperties[] | undefined;
|
|
1590
1590
|
/**
|
|
1591
1591
|
* <p>An optional list of structures that control how <code>Theme</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1592
1592
|
* @public
|
|
1593
1593
|
*/
|
|
1594
|
-
Themes?: AssetBundleExportJobThemeOverrideProperties[];
|
|
1594
|
+
Themes?: AssetBundleExportJobThemeOverrideProperties[] | undefined;
|
|
1595
1595
|
/**
|
|
1596
1596
|
* <p>An optional list of structures that control how <code>Analysis</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1597
1597
|
* @public
|
|
1598
1598
|
*/
|
|
1599
|
-
Analyses?: AssetBundleExportJobAnalysisOverrideProperties[];
|
|
1599
|
+
Analyses?: AssetBundleExportJobAnalysisOverrideProperties[] | undefined;
|
|
1600
1600
|
/**
|
|
1601
1601
|
* <p>An optional list of structures that control how <code>Dashboard</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1602
1602
|
* @public
|
|
1603
1603
|
*/
|
|
1604
|
-
Dashboards?: AssetBundleExportJobDashboardOverrideProperties[];
|
|
1604
|
+
Dashboards?: AssetBundleExportJobDashboardOverrideProperties[] | undefined;
|
|
1605
1605
|
/**
|
|
1606
1606
|
* <p>An optional list of structures that controls how <code>Folder</code> resources are parameterized in the returned CloudFormation template.</p>
|
|
1607
1607
|
* @public
|
|
1608
1608
|
*/
|
|
1609
|
-
Folders?: AssetBundleExportJobFolderOverrideProperties[];
|
|
1609
|
+
Folders?: AssetBundleExportJobFolderOverrideProperties[] | undefined;
|
|
1610
1610
|
}
|
|
1611
1611
|
/**
|
|
1612
1612
|
* @public
|
|
@@ -1629,17 +1629,17 @@ export interface AssetBundleExportJobError {
|
|
|
1629
1629
|
* <p>The ARN of the resource whose processing caused an error.</p>
|
|
1630
1630
|
* @public
|
|
1631
1631
|
*/
|
|
1632
|
-
Arn?: string;
|
|
1632
|
+
Arn?: string | undefined;
|
|
1633
1633
|
/**
|
|
1634
1634
|
* <p>The specific error type of the error that occurred.</p>
|
|
1635
1635
|
* @public
|
|
1636
1636
|
*/
|
|
1637
|
-
Type?: string;
|
|
1637
|
+
Type?: string | undefined;
|
|
1638
1638
|
/**
|
|
1639
1639
|
* <p>A description of the error.</p>
|
|
1640
1640
|
* @public
|
|
1641
1641
|
*/
|
|
1642
|
-
Message?: string;
|
|
1642
|
+
Message?: string | undefined;
|
|
1643
1643
|
}
|
|
1644
1644
|
/**
|
|
1645
1645
|
* @public
|
|
@@ -1664,42 +1664,42 @@ export interface AssetBundleExportJobSummary {
|
|
|
1664
1664
|
* <p>The current status of the export job.</p>
|
|
1665
1665
|
* @public
|
|
1666
1666
|
*/
|
|
1667
|
-
JobStatus?: AssetBundleExportJobStatus;
|
|
1667
|
+
JobStatus?: AssetBundleExportJobStatus | undefined;
|
|
1668
1668
|
/**
|
|
1669
1669
|
* <p>The ARN of the export job.</p>
|
|
1670
1670
|
* @public
|
|
1671
1671
|
*/
|
|
1672
|
-
Arn?: string;
|
|
1672
|
+
Arn?: string | undefined;
|
|
1673
1673
|
/**
|
|
1674
1674
|
* <p>The time that the export job was created.</p>
|
|
1675
1675
|
* @public
|
|
1676
1676
|
*/
|
|
1677
|
-
CreatedTime?: Date;
|
|
1677
|
+
CreatedTime?: Date | undefined;
|
|
1678
1678
|
/**
|
|
1679
1679
|
* <p>The ID of the export job.</p>
|
|
1680
1680
|
* @public
|
|
1681
1681
|
*/
|
|
1682
|
-
AssetBundleExportJobId?: string;
|
|
1682
|
+
AssetBundleExportJobId?: string | undefined;
|
|
1683
1683
|
/**
|
|
1684
1684
|
* <p>The flag that determines the inclusion of resource dependencies in the returned asset bundle.</p>
|
|
1685
1685
|
* @public
|
|
1686
1686
|
*/
|
|
1687
|
-
IncludeAllDependencies?: boolean;
|
|
1687
|
+
IncludeAllDependencies?: boolean | undefined;
|
|
1688
1688
|
/**
|
|
1689
1689
|
* <p>The format for the export job.</p>
|
|
1690
1690
|
* @public
|
|
1691
1691
|
*/
|
|
1692
|
-
ExportFormat?: AssetBundleExportFormat;
|
|
1692
|
+
ExportFormat?: AssetBundleExportFormat | undefined;
|
|
1693
1693
|
/**
|
|
1694
1694
|
* <p>The flag that determines the inclusion of permissions associated with each resource ARN.</p>
|
|
1695
1695
|
* @public
|
|
1696
1696
|
*/
|
|
1697
|
-
IncludePermissions?: boolean;
|
|
1697
|
+
IncludePermissions?: boolean | undefined;
|
|
1698
1698
|
/**
|
|
1699
1699
|
* <p>The flag that determines the inclusion of tags associated with each resource ARN.</p>
|
|
1700
1700
|
* @public
|
|
1701
1701
|
*/
|
|
1702
|
-
IncludeTags?: boolean;
|
|
1702
|
+
IncludeTags?: boolean | undefined;
|
|
1703
1703
|
}
|
|
1704
1704
|
/**
|
|
1705
1705
|
* <p>The option to relax the validation that is required to export each asset. When <code>StrictModeForAllResource</code> is set to <code>false</code>, validation is skipped for specific UI errors.</p>
|
|
@@ -1710,7 +1710,7 @@ export interface AssetBundleExportJobValidationStrategy {
|
|
|
1710
1710
|
* <p>A Boolean value that indicates whether to export resources under strict or lenient mode.</p>
|
|
1711
1711
|
* @public
|
|
1712
1712
|
*/
|
|
1713
|
-
StrictModeForAllResources?: boolean;
|
|
1713
|
+
StrictModeForAllResources?: boolean | undefined;
|
|
1714
1714
|
}
|
|
1715
1715
|
/**
|
|
1716
1716
|
* <p>Describes a warning that occurred during an Asset Bundle export job.</p>
|
|
@@ -1721,12 +1721,12 @@ export interface AssetBundleExportJobWarning {
|
|
|
1721
1721
|
* <p>The ARN of the resource whose processing caused a warning.</p>
|
|
1722
1722
|
* @public
|
|
1723
1723
|
*/
|
|
1724
|
-
Arn?: string;
|
|
1724
|
+
Arn?: string | undefined;
|
|
1725
1725
|
/**
|
|
1726
1726
|
* <p>A description of the warning.</p>
|
|
1727
1727
|
* @public
|
|
1728
1728
|
*/
|
|
1729
|
-
Message?: string;
|
|
1729
|
+
Message?: string | undefined;
|
|
1730
1730
|
}
|
|
1731
1731
|
/**
|
|
1732
1732
|
* @public
|
|
@@ -1754,7 +1754,7 @@ export interface AssetBundleImportJobAnalysisOverrideParameters {
|
|
|
1754
1754
|
* <p>A new name for the analysis.</p>
|
|
1755
1755
|
* @public
|
|
1756
1756
|
*/
|
|
1757
|
-
Name?: string;
|
|
1757
|
+
Name?: string | undefined;
|
|
1758
1758
|
}
|
|
1759
1759
|
/**
|
|
1760
1760
|
* <p>A structure that contains the permissions for the resource that you want to override in an asset bundle import job.</p>
|
|
@@ -1835,7 +1835,7 @@ export interface AssetBundleImportJobDashboardOverrideParameters {
|
|
|
1835
1835
|
* <p>A new name for the dashboard.</p>
|
|
1836
1836
|
* @public
|
|
1837
1837
|
*/
|
|
1838
|
-
Name?: string;
|
|
1838
|
+
Name?: string | undefined;
|
|
1839
1839
|
}
|
|
1840
1840
|
/**
|
|
1841
1841
|
* <p>A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.</p>
|
|
@@ -1846,7 +1846,7 @@ export interface AssetBundleResourceLinkSharingConfiguration {
|
|
|
1846
1846
|
* <p>A list of link sharing permissions for the dashboards that you want to apply overrides to.</p>
|
|
1847
1847
|
* @public
|
|
1848
1848
|
*/
|
|
1849
|
-
Permissions?: AssetBundleResourcePermissions;
|
|
1849
|
+
Permissions?: AssetBundleResourcePermissions | undefined;
|
|
1850
1850
|
}
|
|
1851
1851
|
/**
|
|
1852
1852
|
* <p>An object that contains a list of permissions to be applied to a list of dashboard IDs.</p>
|
|
@@ -1862,12 +1862,12 @@ export interface AssetBundleImportJobDashboardOverridePermissions {
|
|
|
1862
1862
|
* <p>A list of permissions for the dashboards that you want to apply overrides to.</p>
|
|
1863
1863
|
* @public
|
|
1864
1864
|
*/
|
|
1865
|
-
Permissions?: AssetBundleResourcePermissions;
|
|
1865
|
+
Permissions?: AssetBundleResourcePermissions | undefined;
|
|
1866
1866
|
/**
|
|
1867
1867
|
* <p>A structure that contains the link sharing configurations that you want to apply overrides to.</p>
|
|
1868
1868
|
* @public
|
|
1869
1869
|
*/
|
|
1870
|
-
LinkSharingConfiguration?: AssetBundleResourceLinkSharingConfiguration;
|
|
1870
|
+
LinkSharingConfiguration?: AssetBundleResourceLinkSharingConfiguration | undefined;
|
|
1871
1871
|
}
|
|
1872
1872
|
/**
|
|
1873
1873
|
* <p>An object that contains a list of tags to be assigned to a list of dashboard IDs.</p>
|
|
@@ -1899,7 +1899,7 @@ export interface AssetBundleImportJobDataSetOverrideParameters {
|
|
|
1899
1899
|
* <p>A new name for the dataset.</p>
|
|
1900
1900
|
* @public
|
|
1901
1901
|
*/
|
|
1902
|
-
Name?: string;
|
|
1902
|
+
Name?: string | undefined;
|
|
1903
1903
|
}
|
|
1904
1904
|
/**
|
|
1905
1905
|
* <p>An object that contains a list of permissions to be applied to a list of dataset IDs.</p>
|
|
@@ -1958,12 +1958,12 @@ export interface AssetBundleImportJobDataSourceCredentials {
|
|
|
1958
1958
|
* <p>A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.</p>
|
|
1959
1959
|
* @public
|
|
1960
1960
|
*/
|
|
1961
|
-
CredentialPair?: AssetBundleImportJobDataSourceCredentialPair;
|
|
1961
|
+
CredentialPair?: AssetBundleImportJobDataSourceCredentialPair | undefined;
|
|
1962
1962
|
/**
|
|
1963
1963
|
* <p>The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.</p>
|
|
1964
1964
|
* @public
|
|
1965
1965
|
*/
|
|
1966
|
-
SecretArn?: string;
|
|
1966
|
+
SecretArn?: string | undefined;
|
|
1967
1967
|
}
|
|
1968
1968
|
/**
|
|
1969
1969
|
* <p>Parameters for Amazon Athena.</p>
|
|
@@ -1974,12 +1974,12 @@ export interface AthenaParameters {
|
|
|
1974
1974
|
* <p>The workgroup that Amazon Athena uses.</p>
|
|
1975
1975
|
* @public
|
|
1976
1976
|
*/
|
|
1977
|
-
WorkGroup?: string;
|
|
1977
|
+
WorkGroup?: string | undefined;
|
|
1978
1978
|
/**
|
|
1979
1979
|
* <p>Use the <code>RoleArn</code> structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use <code>RoleArn</code> to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.</p>
|
|
1980
1980
|
* @public
|
|
1981
1981
|
*/
|
|
1982
|
-
RoleArn?: string;
|
|
1982
|
+
RoleArn?: string | undefined;
|
|
1983
1983
|
}
|
|
1984
1984
|
/**
|
|
1985
1985
|
* <p>Parameters for Amazon Aurora.</p>
|
|
@@ -2048,7 +2048,7 @@ export interface BigQueryParameters {
|
|
|
2048
2048
|
* <p>The storage location where you create a Google BigQuery data source.</p>
|
|
2049
2049
|
* @public
|
|
2050
2050
|
*/
|
|
2051
|
-
DataSetRegion?: string;
|
|
2051
|
+
DataSetRegion?: string | undefined;
|
|
2052
2052
|
}
|
|
2053
2053
|
/**
|
|
2054
2054
|
* <p>The parameters that are required to connect to a Databricks data source.</p>
|
|
@@ -2235,17 +2235,17 @@ export interface RedshiftIAMParameters {
|
|
|
2235
2235
|
* <p>The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of <code>AutoCreateDatabaseUser</code> to <code>True</code> to create a new user with PUBLIC permissions.</p>
|
|
2236
2236
|
* @public
|
|
2237
2237
|
*/
|
|
2238
|
-
DatabaseUser?: string;
|
|
2238
|
+
DatabaseUser?: string | undefined;
|
|
2239
2239
|
/**
|
|
2240
2240
|
* <p>A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the <code>DatabaseUser</code>. If you choose to include this parameter, the <code>RoleArn</code> must grant access to <code>redshift:JoinGroup</code>.</p>
|
|
2241
2241
|
* @public
|
|
2242
2242
|
*/
|
|
2243
|
-
DatabaseGroups?: string[];
|
|
2243
|
+
DatabaseGroups?: string[] | undefined;
|
|
2244
2244
|
/**
|
|
2245
2245
|
* <p>Automatically creates a database user. If your database doesn't have a <code>DatabaseUser</code>, set this parameter to <code>True</code>. If there is no <code>DatabaseUser</code>, Amazon QuickSight can't connect to your cluster. The <code>RoleArn</code> that you use for this operation must grant access to <code>redshift:CreateClusterUser</code> to successfully create the user.</p>
|
|
2246
2246
|
* @public
|
|
2247
2247
|
*/
|
|
2248
|
-
AutoCreateDatabaseUser?: boolean;
|
|
2248
|
+
AutoCreateDatabaseUser?: boolean | undefined;
|
|
2249
2249
|
}
|
|
2250
2250
|
/**
|
|
2251
2251
|
* <p>The parameters for an IAM Identity Center configuration.</p>
|
|
@@ -2256,7 +2256,7 @@ export interface IdentityCenterConfiguration {
|
|
|
2256
2256
|
* <p>A Boolean option that controls whether Trusted Identity Propagation should be used.</p>
|
|
2257
2257
|
* @public
|
|
2258
2258
|
*/
|
|
2259
|
-
EnableIdentityPropagation?: boolean;
|
|
2259
|
+
EnableIdentityPropagation?: boolean | undefined;
|
|
2260
2260
|
}
|
|
2261
2261
|
/**
|
|
2262
2262
|
* <p>The parameters for Amazon Redshift. The <code>ClusterId</code> field can be blank if
|
|
@@ -2268,12 +2268,12 @@ export interface RedshiftParameters {
|
|
|
2268
2268
|
* <p>Host. This field can be blank if <code>ClusterId</code> is provided.</p>
|
|
2269
2269
|
* @public
|
|
2270
2270
|
*/
|
|
2271
|
-
Host?: string;
|
|
2271
|
+
Host?: string | undefined;
|
|
2272
2272
|
/**
|
|
2273
2273
|
* <p>Port. This field can be blank if the <code>ClusterId</code> is provided.</p>
|
|
2274
2274
|
* @public
|
|
2275
2275
|
*/
|
|
2276
|
-
Port?: number;
|
|
2276
|
+
Port?: number | undefined;
|
|
2277
2277
|
/**
|
|
2278
2278
|
* <p>Database.</p>
|
|
2279
2279
|
* @public
|
|
@@ -2284,18 +2284,18 @@ export interface RedshiftParameters {
|
|
|
2284
2284
|
* provided.</p>
|
|
2285
2285
|
* @public
|
|
2286
2286
|
*/
|
|
2287
|
-
ClusterId?: string;
|
|
2287
|
+
ClusterId?: string | undefined;
|
|
2288
2288
|
/**
|
|
2289
2289
|
* <p>An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html">DataSourceCredentials</a>.</p>
|
|
2290
2290
|
* @public
|
|
2291
2291
|
*/
|
|
2292
|
-
IAMParameters?: RedshiftIAMParameters;
|
|
2292
|
+
IAMParameters?: RedshiftIAMParameters | undefined;
|
|
2293
2293
|
/**
|
|
2294
2294
|
* <p>An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.</p>
|
|
2295
2295
|
* <p>This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.</p>
|
|
2296
2296
|
* @public
|
|
2297
2297
|
*/
|
|
2298
|
-
IdentityCenterConfiguration?: IdentityCenterConfiguration;
|
|
2298
|
+
IdentityCenterConfiguration?: IdentityCenterConfiguration | undefined;
|
|
2299
2299
|
}
|
|
2300
2300
|
/**
|
|
2301
2301
|
* <p>Amazon S3 manifest file location.</p>
|
|
@@ -2328,7 +2328,7 @@ export interface S3Parameters {
|
|
|
2328
2328
|
* <p>Use the <code>RoleArn</code> structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use <code>RoleArn</code> to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.</p>
|
|
2329
2329
|
* @public
|
|
2330
2330
|
*/
|
|
2331
|
-
RoleArn?: string;
|
|
2331
|
+
RoleArn?: string | undefined;
|
|
2332
2332
|
}
|
|
2333
2333
|
/**
|
|
2334
2334
|
* <p>The parameters for ServiceNow.</p>
|
|
@@ -2341,6 +2341,56 @@ export interface ServiceNowParameters {
|
|
|
2341
2341
|
*/
|
|
2342
2342
|
SiteBaseUrl: string | undefined;
|
|
2343
2343
|
}
|
|
2344
|
+
/**
|
|
2345
|
+
* @public
|
|
2346
|
+
* @enum
|
|
2347
|
+
*/
|
|
2348
|
+
export declare const AuthenticationType: {
|
|
2349
|
+
readonly PASSWORD: "PASSWORD";
|
|
2350
|
+
readonly TOKEN: "TOKEN";
|
|
2351
|
+
readonly X509: "X509";
|
|
2352
|
+
};
|
|
2353
|
+
/**
|
|
2354
|
+
* @public
|
|
2355
|
+
*/
|
|
2356
|
+
export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType];
|
|
2357
|
+
/**
|
|
2358
|
+
* <p>VPC connection properties.</p>
|
|
2359
|
+
* @public
|
|
2360
|
+
*/
|
|
2361
|
+
export interface VpcConnectionProperties {
|
|
2362
|
+
/**
|
|
2363
|
+
* <p>The Amazon Resource Name (ARN) for the VPC connection.</p>
|
|
2364
|
+
* @public
|
|
2365
|
+
*/
|
|
2366
|
+
VpcConnectionArn: string | undefined;
|
|
2367
|
+
}
|
|
2368
|
+
/**
|
|
2369
|
+
* <p>An object that contains information needed to create a data source connection that uses OAuth client credentials. This option is available for data source connections that are made with Snowflake and Starburst.</p>
|
|
2370
|
+
* @public
|
|
2371
|
+
*/
|
|
2372
|
+
export interface OAuthParameters {
|
|
2373
|
+
/**
|
|
2374
|
+
* <p>The token endpoint URL of the identity provider.</p>
|
|
2375
|
+
* @public
|
|
2376
|
+
*/
|
|
2377
|
+
TokenProviderUrl: string | undefined;
|
|
2378
|
+
/**
|
|
2379
|
+
* <p>The OAuth scope.</p>
|
|
2380
|
+
* @public
|
|
2381
|
+
*/
|
|
2382
|
+
OAuthScope?: string | undefined;
|
|
2383
|
+
/**
|
|
2384
|
+
* <p>VPC connection properties.</p>
|
|
2385
|
+
* @public
|
|
2386
|
+
*/
|
|
2387
|
+
IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
2388
|
+
/**
|
|
2389
|
+
* <p>The resource uri of the identity provider.</p>
|
|
2390
|
+
* @public
|
|
2391
|
+
*/
|
|
2392
|
+
IdentityProviderResourceUri?: string | undefined;
|
|
2393
|
+
}
|
|
2344
2394
|
/**
|
|
2345
2395
|
* <p>The parameters for Snowflake.</p>
|
|
2346
2396
|
* @public
|
|
@@ -2361,6 +2411,21 @@ export interface SnowflakeParameters {
|
|
|
2361
2411
|
* @public
|
|
2362
2412
|
*/
|
|
2363
2413
|
Warehouse: string | undefined;
|
|
2414
|
+
/**
|
|
2415
|
+
* <p>The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.</p>
|
|
2416
|
+
* @public
|
|
2417
|
+
*/
|
|
2418
|
+
AuthenticationType?: AuthenticationType | undefined;
|
|
2419
|
+
/**
|
|
2420
|
+
* <p>The database access control role.</p>
|
|
2421
|
+
* @public
|
|
2422
|
+
*/
|
|
2423
|
+
DatabaseAccessControlRole?: string | undefined;
|
|
2424
|
+
/**
|
|
2425
|
+
* <p>An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.</p>
|
|
2426
|
+
* @public
|
|
2427
|
+
*/
|
|
2428
|
+
OAuthParameters?: OAuthParameters | undefined;
|
|
2364
2429
|
}
|
|
2365
2430
|
/**
|
|
2366
2431
|
* <p>The parameters for Spark.</p>
|
|
@@ -2435,7 +2500,22 @@ export interface StarburstParameters {
|
|
|
2435
2500
|
* <p>The product type for the Starburst data source.</p>
|
|
2436
2501
|
* @public
|
|
2437
2502
|
*/
|
|
2438
|
-
ProductType?: StarburstProductType;
|
|
2503
|
+
ProductType?: StarburstProductType | undefined;
|
|
2504
|
+
/**
|
|
2505
|
+
* <p>The database access control role.</p>
|
|
2506
|
+
* @public
|
|
2507
|
+
*/
|
|
2508
|
+
DatabaseAccessControlRole?: string | undefined;
|
|
2509
|
+
/**
|
|
2510
|
+
* <p>The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.</p>
|
|
2511
|
+
* @public
|
|
2512
|
+
*/
|
|
2513
|
+
AuthenticationType?: AuthenticationType | undefined;
|
|
2514
|
+
/**
|
|
2515
|
+
* <p>An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.</p>
|
|
2516
|
+
* @public
|
|
2517
|
+
*/
|
|
2518
|
+
OAuthParameters?: OAuthParameters | undefined;
|
|
2439
2519
|
}
|
|
2440
2520
|
/**
|
|
2441
2521
|
* <p>The parameters for Teradata.</p>
|
|
@@ -3437,18 +3517,7 @@ export interface SslProperties {
|
|
|
3437
3517
|
* <p>A Boolean option to control whether SSL should be disabled.</p>
|
|
3438
3518
|
* @public
|
|
3439
3519
|
*/
|
|
3440
|
-
DisableSsl?: boolean;
|
|
3441
|
-
}
|
|
3442
|
-
/**
|
|
3443
|
-
* <p>VPC connection properties.</p>
|
|
3444
|
-
* @public
|
|
3445
|
-
*/
|
|
3446
|
-
export interface VpcConnectionProperties {
|
|
3447
|
-
/**
|
|
3448
|
-
* <p>The Amazon Resource Name (ARN) for the VPC connection.</p>
|
|
3449
|
-
* @public
|
|
3450
|
-
*/
|
|
3451
|
-
VpcConnectionArn: string | undefined;
|
|
3520
|
+
DisableSsl?: boolean | undefined;
|
|
3452
3521
|
}
|
|
3453
3522
|
/**
|
|
3454
3523
|
* <p>The override parameters for a single data source that is being imported.</p>
|
|
@@ -3464,30 +3533,30 @@ export interface AssetBundleImportJobDataSourceOverrideParameters {
|
|
|
3464
3533
|
* <p>A new name for the data source.</p>
|
|
3465
3534
|
* @public
|
|
3466
3535
|
*/
|
|
3467
|
-
Name?: string;
|
|
3536
|
+
Name?: string | undefined;
|
|
3468
3537
|
/**
|
|
3469
3538
|
* <p>The parameters that Amazon QuickSight uses to connect to your underlying data source.
|
|
3470
3539
|
* This is a variant type structure. For this structure to be valid, only one of the
|
|
3471
3540
|
* attributes can be non-null.</p>
|
|
3472
3541
|
* @public
|
|
3473
3542
|
*/
|
|
3474
|
-
DataSourceParameters?: DataSourceParameters;
|
|
3543
|
+
DataSourceParameters?: DataSourceParameters | undefined;
|
|
3475
3544
|
/**
|
|
3476
3545
|
* <p>VPC connection properties.</p>
|
|
3477
3546
|
* @public
|
|
3478
3547
|
*/
|
|
3479
|
-
VpcConnectionProperties?: VpcConnectionProperties;
|
|
3548
|
+
VpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
3480
3549
|
/**
|
|
3481
3550
|
* <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your
|
|
3482
3551
|
* underlying data source.</p>
|
|
3483
3552
|
* @public
|
|
3484
3553
|
*/
|
|
3485
|
-
SslProperties?: SslProperties;
|
|
3554
|
+
SslProperties?: SslProperties | undefined;
|
|
3486
3555
|
/**
|
|
3487
3556
|
* <p>An optional structure that provides the credentials to be used to create the imported data source.</p>
|
|
3488
3557
|
* @public
|
|
3489
3558
|
*/
|
|
3490
|
-
Credentials?: AssetBundleImportJobDataSourceCredentials;
|
|
3559
|
+
Credentials?: AssetBundleImportJobDataSourceCredentials | undefined;
|
|
3491
3560
|
}
|
|
3492
3561
|
/**
|
|
3493
3562
|
* <p>An object that contains a list of permissions to be applied to a list of data source IDs.</p>
|
|
@@ -3530,17 +3599,17 @@ export interface AssetBundleImportJobError {
|
|
|
3530
3599
|
* <p>The ARN of the resource whose processing caused an error.</p>
|
|
3531
3600
|
* @public
|
|
3532
3601
|
*/
|
|
3533
|
-
Arn?: string;
|
|
3602
|
+
Arn?: string | undefined;
|
|
3534
3603
|
/**
|
|
3535
3604
|
* <p>The specific error type or the error that occurred.</p>
|
|
3536
3605
|
* @public
|
|
3537
3606
|
*/
|
|
3538
|
-
Type?: string;
|
|
3607
|
+
Type?: string | undefined;
|
|
3539
3608
|
/**
|
|
3540
3609
|
* <p>A description of the error.</p>
|
|
3541
3610
|
* @public
|
|
3542
3611
|
*/
|
|
3543
|
-
Message?: string;
|
|
3612
|
+
Message?: string | undefined;
|
|
3544
3613
|
}
|
|
3545
3614
|
/**
|
|
3546
3615
|
* <p>The override parameters for a single folder that is being imported.</p>
|
|
@@ -3556,12 +3625,12 @@ export interface AssetBundleImportJobFolderOverrideParameters {
|
|
|
3556
3625
|
* <p>A new name for the folder.</p>
|
|
3557
3626
|
* @public
|
|
3558
3627
|
*/
|
|
3559
|
-
Name?: string;
|
|
3628
|
+
Name?: string | undefined;
|
|
3560
3629
|
/**
|
|
3561
3630
|
* <p>A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.</p>
|
|
3562
3631
|
* @public
|
|
3563
3632
|
*/
|
|
3564
|
-
ParentFolderArn?: string;
|
|
3633
|
+
ParentFolderArn?: string | undefined;
|
|
3565
3634
|
}
|
|
3566
3635
|
/**
|
|
3567
3636
|
* <p>An object that contains a list of permissions to be applied to a list of folder IDs.</p>
|
|
@@ -3577,7 +3646,7 @@ export interface AssetBundleImportJobFolderOverridePermissions {
|
|
|
3577
3646
|
* <p>A structure that contains the permissions for the resource that you want to override in an asset bundle import job.</p>
|
|
3578
3647
|
* @public
|
|
3579
3648
|
*/
|
|
3580
|
-
Permissions?: AssetBundleResourcePermissions;
|
|
3649
|
+
Permissions?: AssetBundleResourcePermissions | undefined;
|
|
3581
3650
|
}
|
|
3582
3651
|
/**
|
|
3583
3652
|
* <p>An object that contains a list of tags to be assigned to a list of folder IDs.</p>
|
|
@@ -3616,7 +3685,7 @@ export interface AssetBundleImportJobRefreshScheduleOverrideParameters {
|
|
|
3616
3685
|
* place in the future.</p>
|
|
3617
3686
|
* @public
|
|
3618
3687
|
*/
|
|
3619
|
-
StartAfterDateTime?: Date;
|
|
3688
|
+
StartAfterDateTime?: Date | undefined;
|
|
3620
3689
|
}
|
|
3621
3690
|
/**
|
|
3622
3691
|
* <p>An optional structure that configures resource ID overrides for the import job.</p>
|
|
@@ -3627,7 +3696,7 @@ export interface AssetBundleImportJobResourceIdOverrideConfiguration {
|
|
|
3627
3696
|
* <p>An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.</p>
|
|
3628
3697
|
* @public
|
|
3629
3698
|
*/
|
|
3630
|
-
PrefixForAllResources?: string;
|
|
3699
|
+
PrefixForAllResources?: string | undefined;
|
|
3631
3700
|
}
|
|
3632
3701
|
/**
|
|
3633
3702
|
* <p>The override parameters for a single theme that is imported.</p>
|
|
@@ -3643,7 +3712,7 @@ export interface AssetBundleImportJobThemeOverrideParameters {
|
|
|
3643
3712
|
* <p>A new name for the theme.</p>
|
|
3644
3713
|
* @public
|
|
3645
3714
|
*/
|
|
3646
|
-
Name?: string;
|
|
3715
|
+
Name?: string | undefined;
|
|
3647
3716
|
}
|
|
3648
3717
|
/**
|
|
3649
3718
|
* <p>The override parameters for a single VPC connection that is imported.</p>
|
|
@@ -3659,29 +3728,29 @@ export interface AssetBundleImportJobVPCConnectionOverrideParameters {
|
|
|
3659
3728
|
* <p>A new name for the VPC connection.</p>
|
|
3660
3729
|
* @public
|
|
3661
3730
|
*/
|
|
3662
|
-
Name?: string;
|
|
3731
|
+
Name?: string | undefined;
|
|
3663
3732
|
/**
|
|
3664
3733
|
* <p>A list of new subnet IDs for the VPC connection you are importing. This field is
|
|
3665
3734
|
* required if you are importing the VPC connection from another Amazon Web Services account or Region.</p>
|
|
3666
3735
|
* @public
|
|
3667
3736
|
*/
|
|
3668
|
-
SubnetIds?: string[];
|
|
3737
|
+
SubnetIds?: string[] | undefined;
|
|
3669
3738
|
/**
|
|
3670
3739
|
* <p>A new security group ID for the VPC connection you are importing. This field is required
|
|
3671
3740
|
* if you are importing the VPC connection from another Amazon Web Services account or Region.</p>
|
|
3672
3741
|
* @public
|
|
3673
3742
|
*/
|
|
3674
|
-
SecurityGroupIds?: string[];
|
|
3743
|
+
SecurityGroupIds?: string[] | undefined;
|
|
3675
3744
|
/**
|
|
3676
3745
|
* <p>An optional override of DNS resolvers to be used by the VPC connection.</p>
|
|
3677
3746
|
* @public
|
|
3678
3747
|
*/
|
|
3679
|
-
DnsResolvers?: string[];
|
|
3748
|
+
DnsResolvers?: string[] | undefined;
|
|
3680
3749
|
/**
|
|
3681
3750
|
* <p>An optional override of the role ARN to be used by the VPC connection.</p>
|
|
3682
3751
|
* @public
|
|
3683
3752
|
*/
|
|
3684
|
-
RoleArn?: string;
|
|
3753
|
+
RoleArn?: string | undefined;
|
|
3685
3754
|
}
|
|
3686
3755
|
/**
|
|
3687
3756
|
* <p>A list of overrides that modify the asset bundle resource configuration before the resource is imported.</p>
|
|
@@ -3692,47 +3761,47 @@ export interface AssetBundleImportJobOverrideParameters {
|
|
|
3692
3761
|
* <p>An optional structure that configures resource ID overrides to be applied within the import job.</p>
|
|
3693
3762
|
* @public
|
|
3694
3763
|
*/
|
|
3695
|
-
ResourceIdOverrideConfiguration?: AssetBundleImportJobResourceIdOverrideConfiguration;
|
|
3764
|
+
ResourceIdOverrideConfiguration?: AssetBundleImportJobResourceIdOverrideConfiguration | undefined;
|
|
3696
3765
|
/**
|
|
3697
3766
|
* <p>A list of overrides for any <code>VPCConnection</code> resources that are present in the asset bundle that is imported.</p>
|
|
3698
3767
|
* @public
|
|
3699
3768
|
*/
|
|
3700
|
-
VPCConnections?: AssetBundleImportJobVPCConnectionOverrideParameters[];
|
|
3769
|
+
VPCConnections?: AssetBundleImportJobVPCConnectionOverrideParameters[] | undefined;
|
|
3701
3770
|
/**
|
|
3702
3771
|
* <p>A list of overrides for any <code>RefreshSchedule</code> resources that are present in the asset bundle that is imported.</p>
|
|
3703
3772
|
* @public
|
|
3704
3773
|
*/
|
|
3705
|
-
RefreshSchedules?: AssetBundleImportJobRefreshScheduleOverrideParameters[];
|
|
3774
|
+
RefreshSchedules?: AssetBundleImportJobRefreshScheduleOverrideParameters[] | undefined;
|
|
3706
3775
|
/**
|
|
3707
3776
|
* <p> A list of overrides for any <code>DataSource</code> resources that are present in the asset bundle that is imported.</p>
|
|
3708
3777
|
* @public
|
|
3709
3778
|
*/
|
|
3710
|
-
DataSources?: AssetBundleImportJobDataSourceOverrideParameters[];
|
|
3779
|
+
DataSources?: AssetBundleImportJobDataSourceOverrideParameters[] | undefined;
|
|
3711
3780
|
/**
|
|
3712
3781
|
* <p>A list of overrides for any <code>DataSet</code> resources that are present in the asset bundle that is imported.</p>
|
|
3713
3782
|
* @public
|
|
3714
3783
|
*/
|
|
3715
|
-
DataSets?: AssetBundleImportJobDataSetOverrideParameters[];
|
|
3784
|
+
DataSets?: AssetBundleImportJobDataSetOverrideParameters[] | undefined;
|
|
3716
3785
|
/**
|
|
3717
3786
|
* <p>A list of overrides for any <code>Theme</code> resources that are present in the asset bundle that is imported.</p>
|
|
3718
3787
|
* @public
|
|
3719
3788
|
*/
|
|
3720
|
-
Themes?: AssetBundleImportJobThemeOverrideParameters[];
|
|
3789
|
+
Themes?: AssetBundleImportJobThemeOverrideParameters[] | undefined;
|
|
3721
3790
|
/**
|
|
3722
3791
|
* <p>A list of overrides for any <code>Analysis</code> resources that are present in the asset bundle that is imported.</p>
|
|
3723
3792
|
* @public
|
|
3724
3793
|
*/
|
|
3725
|
-
Analyses?: AssetBundleImportJobAnalysisOverrideParameters[];
|
|
3794
|
+
Analyses?: AssetBundleImportJobAnalysisOverrideParameters[] | undefined;
|
|
3726
3795
|
/**
|
|
3727
3796
|
* <p>A list of overrides for any <code>Dashboard</code> resources that are present in the asset bundle that is imported.</p>
|
|
3728
3797
|
* @public
|
|
3729
3798
|
*/
|
|
3730
|
-
Dashboards?: AssetBundleImportJobDashboardOverrideParameters[];
|
|
3799
|
+
Dashboards?: AssetBundleImportJobDashboardOverrideParameters[] | undefined;
|
|
3731
3800
|
/**
|
|
3732
3801
|
* <p>A list of overrides for any <code>Folder</code> resources that are present in the asset bundle that is imported.</p>
|
|
3733
3802
|
* @public
|
|
3734
3803
|
*/
|
|
3735
|
-
Folders?: AssetBundleImportJobFolderOverrideParameters[];
|
|
3804
|
+
Folders?: AssetBundleImportJobFolderOverrideParameters[] | undefined;
|
|
3736
3805
|
}
|
|
3737
3806
|
/**
|
|
3738
3807
|
* <p>An object that contains a list of permissions to be applied to a list of theme IDs.</p>
|
|
@@ -3759,32 +3828,32 @@ export interface AssetBundleImportJobOverridePermissions {
|
|
|
3759
3828
|
* <p>A list of permissions overrides for any <code>DataSource</code> resources that are present in the asset bundle that is imported.</p>
|
|
3760
3829
|
* @public
|
|
3761
3830
|
*/
|
|
3762
|
-
DataSources?: AssetBundleImportJobDataSourceOverridePermissions[];
|
|
3831
|
+
DataSources?: AssetBundleImportJobDataSourceOverridePermissions[] | undefined;
|
|
3763
3832
|
/**
|
|
3764
3833
|
* <p>A list of permissions overrides for any <code>DataSet</code> resources that are present in the asset bundle that is imported.</p>
|
|
3765
3834
|
* @public
|
|
3766
3835
|
*/
|
|
3767
|
-
DataSets?: AssetBundleImportJobDataSetOverridePermissions[];
|
|
3836
|
+
DataSets?: AssetBundleImportJobDataSetOverridePermissions[] | undefined;
|
|
3768
3837
|
/**
|
|
3769
3838
|
* <p>A list of permissions overrides for any <code>Theme</code> resources that are present in the asset bundle that is imported.</p>
|
|
3770
3839
|
* @public
|
|
3771
3840
|
*/
|
|
3772
|
-
Themes?: AssetBundleImportJobThemeOverridePermissions[];
|
|
3841
|
+
Themes?: AssetBundleImportJobThemeOverridePermissions[] | undefined;
|
|
3773
3842
|
/**
|
|
3774
3843
|
* <p>A list of permissions overrides for any <code>Analysis</code> resources that are present in the asset bundle that is imported.</p>
|
|
3775
3844
|
* @public
|
|
3776
3845
|
*/
|
|
3777
|
-
Analyses?: AssetBundleImportJobAnalysisOverridePermissions[];
|
|
3846
|
+
Analyses?: AssetBundleImportJobAnalysisOverridePermissions[] | undefined;
|
|
3778
3847
|
/**
|
|
3779
3848
|
* <p>A list of permissions overrides for any <code>Dashboard</code> resources that are present in the asset bundle that is imported.</p>
|
|
3780
3849
|
* @public
|
|
3781
3850
|
*/
|
|
3782
|
-
Dashboards?: AssetBundleImportJobDashboardOverridePermissions[];
|
|
3851
|
+
Dashboards?: AssetBundleImportJobDashboardOverridePermissions[] | undefined;
|
|
3783
3852
|
/**
|
|
3784
3853
|
* <p>A list of permissions for the folders that you want to apply overrides to.</p>
|
|
3785
3854
|
* @public
|
|
3786
3855
|
*/
|
|
3787
|
-
Folders?: AssetBundleImportJobFolderOverridePermissions[];
|
|
3856
|
+
Folders?: AssetBundleImportJobFolderOverridePermissions[] | undefined;
|
|
3788
3857
|
}
|
|
3789
3858
|
/**
|
|
3790
3859
|
* <p>An object that contains a list of tags to be assigned to a list of theme IDs.</p>
|
|
@@ -3827,37 +3896,37 @@ export interface AssetBundleImportJobOverrideTags {
|
|
|
3827
3896
|
* <p>A list of tag overrides for any <code>VPCConnection</code> resources that are present in the asset bundle that is imported.</p>
|
|
3828
3897
|
* @public
|
|
3829
3898
|
*/
|
|
3830
|
-
VPCConnections?: AssetBundleImportJobVPCConnectionOverrideTags[];
|
|
3899
|
+
VPCConnections?: AssetBundleImportJobVPCConnectionOverrideTags[] | undefined;
|
|
3831
3900
|
/**
|
|
3832
3901
|
* <p>A list of tag overrides for any <code>DataSource</code> resources that are present in the asset bundle that is imported.</p>
|
|
3833
3902
|
* @public
|
|
3834
3903
|
*/
|
|
3835
|
-
DataSources?: AssetBundleImportJobDataSourceOverrideTags[];
|
|
3904
|
+
DataSources?: AssetBundleImportJobDataSourceOverrideTags[] | undefined;
|
|
3836
3905
|
/**
|
|
3837
3906
|
* <p>A list of tag overrides for any <code>DataSet</code> resources that are present in the asset bundle that is imported.</p>
|
|
3838
3907
|
* @public
|
|
3839
3908
|
*/
|
|
3840
|
-
DataSets?: AssetBundleImportJobDataSetOverrideTags[];
|
|
3909
|
+
DataSets?: AssetBundleImportJobDataSetOverrideTags[] | undefined;
|
|
3841
3910
|
/**
|
|
3842
3911
|
* <p>A list of tag overrides for any <code>Theme</code> resources that are present in the asset bundle that is imported.</p>
|
|
3843
3912
|
* @public
|
|
3844
3913
|
*/
|
|
3845
|
-
Themes?: AssetBundleImportJobThemeOverrideTags[];
|
|
3914
|
+
Themes?: AssetBundleImportJobThemeOverrideTags[] | undefined;
|
|
3846
3915
|
/**
|
|
3847
3916
|
* <p>A list of tag overrides for any <code>Analysis</code> resources that are present in the asset bundle that is imported.</p>
|
|
3848
3917
|
* @public
|
|
3849
3918
|
*/
|
|
3850
|
-
Analyses?: AssetBundleImportJobAnalysisOverrideTags[];
|
|
3919
|
+
Analyses?: AssetBundleImportJobAnalysisOverrideTags[] | undefined;
|
|
3851
3920
|
/**
|
|
3852
3921
|
* <p>A list of tag overrides for any <code>Dashboard</code> resources that are present in the asset bundle that is imported.</p>
|
|
3853
3922
|
* @public
|
|
3854
3923
|
*/
|
|
3855
|
-
Dashboards?: AssetBundleImportJobDashboardOverrideTags[];
|
|
3924
|
+
Dashboards?: AssetBundleImportJobDashboardOverrideTags[] | undefined;
|
|
3856
3925
|
/**
|
|
3857
3926
|
* <p>A list of tag overrides for any <code>Folder</code> resources that are present in the asset bundle that is imported.</p>
|
|
3858
3927
|
* @public
|
|
3859
3928
|
*/
|
|
3860
|
-
Folders?: AssetBundleImportJobFolderOverrideTags[];
|
|
3929
|
+
Folders?: AssetBundleImportJobFolderOverrideTags[] | undefined;
|
|
3861
3930
|
}
|
|
3862
3931
|
/**
|
|
3863
3932
|
* <p>An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.</p>
|
|
@@ -3868,7 +3937,7 @@ export interface AssetBundleImportJobOverrideValidationStrategy {
|
|
|
3868
3937
|
* <p>A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.</p>
|
|
3869
3938
|
* @public
|
|
3870
3939
|
*/
|
|
3871
|
-
StrictModeForAllResources?: boolean;
|
|
3940
|
+
StrictModeForAllResources?: boolean | undefined;
|
|
3872
3941
|
}
|
|
3873
3942
|
/**
|
|
3874
3943
|
* @public
|
|
@@ -3896,27 +3965,27 @@ export interface AssetBundleImportJobSummary {
|
|
|
3896
3965
|
* <p>The current status of the import job.</p>
|
|
3897
3966
|
* @public
|
|
3898
3967
|
*/
|
|
3899
|
-
JobStatus?: AssetBundleImportJobStatus;
|
|
3968
|
+
JobStatus?: AssetBundleImportJobStatus | undefined;
|
|
3900
3969
|
/**
|
|
3901
3970
|
* <p>The ARN of the import job.</p>
|
|
3902
3971
|
* @public
|
|
3903
3972
|
*/
|
|
3904
|
-
Arn?: string;
|
|
3973
|
+
Arn?: string | undefined;
|
|
3905
3974
|
/**
|
|
3906
3975
|
* <p>The time that the import job was created.</p>
|
|
3907
3976
|
* @public
|
|
3908
3977
|
*/
|
|
3909
|
-
CreatedTime?: Date;
|
|
3978
|
+
CreatedTime?: Date | undefined;
|
|
3910
3979
|
/**
|
|
3911
3980
|
* <p>The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.</p>
|
|
3912
3981
|
* @public
|
|
3913
3982
|
*/
|
|
3914
|
-
AssetBundleImportJobId?: string;
|
|
3983
|
+
AssetBundleImportJobId?: string | undefined;
|
|
3915
3984
|
/**
|
|
3916
3985
|
* <p>The failure action for the import job.</p>
|
|
3917
3986
|
* @public
|
|
3918
3987
|
*/
|
|
3919
|
-
FailureAction?: AssetBundleImportFailureAction;
|
|
3988
|
+
FailureAction?: AssetBundleImportFailureAction | undefined;
|
|
3920
3989
|
}
|
|
3921
3990
|
/**
|
|
3922
3991
|
* <p>Describes a warning that occurred during an Asset Bundle import job.</p>
|
|
@@ -3927,12 +3996,12 @@ export interface AssetBundleImportJobWarning {
|
|
|
3927
3996
|
* <p>The ARN of the resource that the warning occurred for.</p>
|
|
3928
3997
|
* @public
|
|
3929
3998
|
*/
|
|
3930
|
-
Arn?: string;
|
|
3999
|
+
Arn?: string | undefined;
|
|
3931
4000
|
/**
|
|
3932
4001
|
* <p>A description of the warning that occurred during an Asset Bundle import job.</p>
|
|
3933
4002
|
* @public
|
|
3934
4003
|
*/
|
|
3935
|
-
Message?: string;
|
|
4004
|
+
Message?: string | undefined;
|
|
3936
4005
|
}
|
|
3937
4006
|
/**
|
|
3938
4007
|
* <p>The source of the asset bundle zip file that contains the data that you want to import. The file must be in <code>QUICKSIGHT_JSON</code> format.</p>
|
|
@@ -3946,13 +4015,13 @@ export interface AssetBundleImportSource {
|
|
|
3946
4015
|
* an SDK for a different language or receiving related errors, try to base64 encode your data.</p>
|
|
3947
4016
|
* @public
|
|
3948
4017
|
*/
|
|
3949
|
-
Body?: Uint8Array;
|
|
4018
|
+
Body?: Uint8Array | undefined;
|
|
3950
4019
|
/**
|
|
3951
4020
|
* <p>The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller
|
|
3952
4021
|
* has read access to. The file must be a zip format file and can't exceed 20 MB.</p>
|
|
3953
4022
|
* @public
|
|
3954
4023
|
*/
|
|
3955
|
-
S3Uri?: string;
|
|
4024
|
+
S3Uri?: string | undefined;
|
|
3956
4025
|
}
|
|
3957
4026
|
/**
|
|
3958
4027
|
* <p>A description of the import source that you provide at the start of an import job. This value is set to either <code>Body</code> or <code>S3Uri</code>, depending on how the <code>StartAssetBundleImportJobRequest</code> is configured.</p>
|
|
@@ -3963,12 +4032,12 @@ export interface AssetBundleImportSourceDescription {
|
|
|
3963
4032
|
* <p>An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call <code>DescribeAssetBundleExportJob</code> again for a fresh URL if needed. The downloaded asset bundle is a <code>.qs</code> zip file.</p>
|
|
3964
4033
|
* @public
|
|
3965
4034
|
*/
|
|
3966
|
-
Body?: string;
|
|
4035
|
+
Body?: string | undefined;
|
|
3967
4036
|
/**
|
|
3968
4037
|
* <p>The Amazon S3 URI that you provided at the start of the import job.</p>
|
|
3969
4038
|
* @public
|
|
3970
4039
|
*/
|
|
3971
|
-
S3Uri?: string;
|
|
4040
|
+
S3Uri?: string | undefined;
|
|
3972
4041
|
}
|
|
3973
4042
|
/**
|
|
3974
4043
|
* @public
|
|
@@ -4017,12 +4086,12 @@ export interface AuthorizedTargetsByService {
|
|
|
4017
4086
|
* <p>The name of the Amazon Web Services service.</p>
|
|
4018
4087
|
* @public
|
|
4019
4088
|
*/
|
|
4020
|
-
Service?: ServiceType;
|
|
4089
|
+
Service?: ServiceType | undefined;
|
|
4021
4090
|
/**
|
|
4022
4091
|
* <p>Aist of authorized targets that are represented by IAM Identity Center application ARNs.</p>
|
|
4023
4092
|
* @public
|
|
4024
4093
|
*/
|
|
4025
|
-
AuthorizedTargets?: string[];
|
|
4094
|
+
AuthorizedTargets?: string[] | undefined;
|
|
4026
4095
|
}
|
|
4027
4096
|
/**
|
|
4028
4097
|
* @public
|
|
@@ -4068,7 +4137,7 @@ export interface ContributionAnalysisFactor {
|
|
|
4068
4137
|
* <p>The field name of the <code>ContributionAnalysisFactor</code>.</p>
|
|
4069
4138
|
* @public
|
|
4070
4139
|
*/
|
|
4071
|
-
FieldName?: string;
|
|
4140
|
+
FieldName?: string | undefined;
|
|
4072
4141
|
}
|
|
4073
4142
|
/**
|
|
4074
4143
|
* @public
|
|
@@ -4116,17 +4185,17 @@ export interface FilterAggMetrics {
|
|
|
4116
4185
|
* <p>The metric operand of the <code>FilterAggMetrics</code>.</p>
|
|
4117
4186
|
* @public
|
|
4118
4187
|
*/
|
|
4119
|
-
MetricOperand?: Identifier;
|
|
4188
|
+
MetricOperand?: Identifier | undefined;
|
|
4120
4189
|
/**
|
|
4121
4190
|
* <p>The function for the <code>FilterAggMetrics</code>.</p>
|
|
4122
4191
|
* @public
|
|
4123
4192
|
*/
|
|
4124
|
-
Function?: AggType;
|
|
4193
|
+
Function?: AggType | undefined;
|
|
4125
4194
|
/**
|
|
4126
4195
|
* <p>The sort direction for <code>FilterAggMetrics</code>.</p>
|
|
4127
4196
|
* @public
|
|
4128
4197
|
*/
|
|
4129
|
-
SortDirection?: TopicSortDirection;
|
|
4198
|
+
SortDirection?: TopicSortDirection | undefined;
|
|
4130
4199
|
}
|
|
4131
4200
|
/**
|
|
4132
4201
|
* @public
|
|
@@ -4150,12 +4219,12 @@ export interface CollectiveConstantEntry {
|
|
|
4150
4219
|
* <p>The <code>ConstantType</code> of a <code>CollectiveConstantEntry</code>.</p>
|
|
4151
4220
|
* @public
|
|
4152
4221
|
*/
|
|
4153
|
-
ConstantType?: ConstantType;
|
|
4222
|
+
ConstantType?: ConstantType | undefined;
|
|
4154
4223
|
/**
|
|
4155
4224
|
* <p>The value of a <code>CollectiveConstantEntry</code>.</p>
|
|
4156
4225
|
* @public
|
|
4157
4226
|
*/
|
|
4158
|
-
Value?: string;
|
|
4227
|
+
Value?: string | undefined;
|
|
4159
4228
|
}
|
|
4160
4229
|
/**
|
|
4161
4230
|
* <p>The definition for a <code>TopicConstantValue</code>.</p>
|
|
@@ -4166,27 +4235,27 @@ export interface TopicConstantValue {
|
|
|
4166
4235
|
* <p>The constant type of a <code>TopicConstantValue</code>.</p>
|
|
4167
4236
|
* @public
|
|
4168
4237
|
*/
|
|
4169
|
-
ConstantType?: ConstantType;
|
|
4238
|
+
ConstantType?: ConstantType | undefined;
|
|
4170
4239
|
/**
|
|
4171
4240
|
* <p>The value of the <code>TopicConstantValue</code>.</p>
|
|
4172
4241
|
* @public
|
|
4173
4242
|
*/
|
|
4174
|
-
Value?: string;
|
|
4243
|
+
Value?: string | undefined;
|
|
4175
4244
|
/**
|
|
4176
4245
|
* <p>The minimum for the <code>TopicConstantValue</code>.</p>
|
|
4177
4246
|
* @public
|
|
4178
4247
|
*/
|
|
4179
|
-
Minimum?: string;
|
|
4248
|
+
Minimum?: string | undefined;
|
|
4180
4249
|
/**
|
|
4181
4250
|
* <p>The maximum for the <code>TopicConstantValue</code>.</p>
|
|
4182
4251
|
* @public
|
|
4183
4252
|
*/
|
|
4184
|
-
Maximum?: string;
|
|
4253
|
+
Maximum?: string | undefined;
|
|
4185
4254
|
/**
|
|
4186
4255
|
* <p>The value list of the <code>TopicConstantValue</code>.</p>
|
|
4187
4256
|
* @public
|
|
4188
4257
|
*/
|
|
4189
|
-
ValueList?: CollectiveConstantEntry[];
|
|
4258
|
+
ValueList?: CollectiveConstantEntry[] | undefined;
|
|
4190
4259
|
}
|
|
4191
4260
|
/**
|
|
4192
4261
|
* @public
|
|
@@ -4262,92 +4331,92 @@ export interface TopicIRFilterOption {
|
|
|
4262
4331
|
* <p>The filter type for the <code>TopicIRFilterOption</code>.</p>
|
|
4263
4332
|
* @public
|
|
4264
4333
|
*/
|
|
4265
|
-
FilterType?: TopicIRFilterType;
|
|
4334
|
+
FilterType?: TopicIRFilterType | undefined;
|
|
4266
4335
|
/**
|
|
4267
4336
|
* <p>The filter class for the <code>TopicIRFilterOption</code>.</p>
|
|
4268
4337
|
* @public
|
|
4269
4338
|
*/
|
|
4270
|
-
FilterClass?: FilterClass;
|
|
4339
|
+
FilterClass?: FilterClass | undefined;
|
|
4271
4340
|
/**
|
|
4272
4341
|
* <p>The operand field for the <code>TopicIRFilterOption</code>.</p>
|
|
4273
4342
|
* @public
|
|
4274
4343
|
*/
|
|
4275
|
-
OperandField?: Identifier;
|
|
4344
|
+
OperandField?: Identifier | undefined;
|
|
4276
4345
|
/**
|
|
4277
4346
|
* <p>The function for the <code>TopicIRFilterOption</code>.</p>
|
|
4278
4347
|
* @public
|
|
4279
4348
|
*/
|
|
4280
|
-
Function?: TopicIRFilterFunction;
|
|
4349
|
+
Function?: TopicIRFilterFunction | undefined;
|
|
4281
4350
|
/**
|
|
4282
4351
|
* <p>The constant for the <code>TopicIRFilterOption</code>.</p>
|
|
4283
4352
|
* @public
|
|
4284
4353
|
*/
|
|
4285
|
-
Constant?: TopicConstantValue;
|
|
4354
|
+
Constant?: TopicConstantValue | undefined;
|
|
4286
4355
|
/**
|
|
4287
4356
|
* <p>The inverse for the <code>TopicIRFilterOption</code>.</p>
|
|
4288
4357
|
* @public
|
|
4289
4358
|
*/
|
|
4290
|
-
Inverse?: boolean;
|
|
4359
|
+
Inverse?: boolean | undefined;
|
|
4291
4360
|
/**
|
|
4292
4361
|
* <p>The null filter for the <code>TopicIRFilterOption</code>.</p>
|
|
4293
4362
|
* @public
|
|
4294
4363
|
*/
|
|
4295
|
-
NullFilter?: NullFilterOption;
|
|
4364
|
+
NullFilter?: NullFilterOption | undefined;
|
|
4296
4365
|
/**
|
|
4297
4366
|
* <p>The aggregation for the <code>TopicIRFilterOption</code>.</p>
|
|
4298
4367
|
* @public
|
|
4299
4368
|
*/
|
|
4300
|
-
Aggregation?: AggType;
|
|
4369
|
+
Aggregation?: AggType | undefined;
|
|
4301
4370
|
/**
|
|
4302
4371
|
* <p>The aggregation function parameters for the <code>TopicIRFilterOption</code>.</p>
|
|
4303
4372
|
* @public
|
|
4304
4373
|
*/
|
|
4305
|
-
AggregationFunctionParameters?: Record<string, string
|
|
4374
|
+
AggregationFunctionParameters?: Record<string, string> | undefined;
|
|
4306
4375
|
/**
|
|
4307
4376
|
* <p>The <code>AggregationPartitionBy</code> for the <code>TopicIRFilterOption</code>.</p>
|
|
4308
4377
|
* @public
|
|
4309
4378
|
*/
|
|
4310
|
-
AggregationPartitionBy?: AggregationPartitionBy[];
|
|
4379
|
+
AggregationPartitionBy?: AggregationPartitionBy[] | undefined;
|
|
4311
4380
|
/**
|
|
4312
4381
|
* <p>The range for the <code>TopicIRFilterOption</code>.</p>
|
|
4313
4382
|
* @public
|
|
4314
4383
|
*/
|
|
4315
|
-
Range?: TopicConstantValue;
|
|
4384
|
+
Range?: TopicConstantValue | undefined;
|
|
4316
4385
|
/**
|
|
4317
4386
|
* <p>The inclusive for the <code>TopicIRFilterOption</code>.</p>
|
|
4318
4387
|
* @public
|
|
4319
4388
|
*/
|
|
4320
|
-
Inclusive?: boolean;
|
|
4389
|
+
Inclusive?: boolean | undefined;
|
|
4321
4390
|
/**
|
|
4322
4391
|
* <p>The time granularity for the <code>TopicIRFilterOption</code>.</p>
|
|
4323
4392
|
* @public
|
|
4324
4393
|
*/
|
|
4325
|
-
TimeGranularity?: TimeGranularity;
|
|
4394
|
+
TimeGranularity?: TimeGranularity | undefined;
|
|
4326
4395
|
/**
|
|
4327
4396
|
* <p>The last next offset for the <code>TopicIRFilterOption</code>.</p>
|
|
4328
4397
|
* @public
|
|
4329
4398
|
*/
|
|
4330
|
-
LastNextOffset?: TopicConstantValue;
|
|
4399
|
+
LastNextOffset?: TopicConstantValue | undefined;
|
|
4331
4400
|
/**
|
|
4332
4401
|
* <p>The agg metrics for the <code>TopicIRFilterOption</code>.</p>
|
|
4333
4402
|
* @public
|
|
4334
4403
|
*/
|
|
4335
|
-
AggMetrics?: FilterAggMetrics[];
|
|
4404
|
+
AggMetrics?: FilterAggMetrics[] | undefined;
|
|
4336
4405
|
/**
|
|
4337
4406
|
* <p>The <code>TopBottomLimit</code> for the <code>TopicIRFilterOption</code>.</p>
|
|
4338
4407
|
* @public
|
|
4339
4408
|
*/
|
|
4340
|
-
TopBottomLimit?: TopicConstantValue;
|
|
4409
|
+
TopBottomLimit?: TopicConstantValue | undefined;
|
|
4341
4410
|
/**
|
|
4342
4411
|
* <p>The sort direction for the <code>TopicIRFilterOption</code>.</p>
|
|
4343
4412
|
* @public
|
|
4344
4413
|
*/
|
|
4345
|
-
SortDirection?: TopicSortDirection;
|
|
4414
|
+
SortDirection?: TopicSortDirection | undefined;
|
|
4346
4415
|
/**
|
|
4347
4416
|
* <p>The anchor for the <code>TopicIRFilterOption</code>.</p>
|
|
4348
4417
|
* @public
|
|
4349
4418
|
*/
|
|
4350
|
-
Anchor?: Anchor;
|
|
4419
|
+
Anchor?: Anchor | undefined;
|
|
4351
4420
|
}
|
|
4352
4421
|
/**
|
|
4353
4422
|
* <p>The definition for the <code>ContributionAnalysisTimeRanges</code>.</p>
|
|
@@ -4358,12 +4427,12 @@ export interface ContributionAnalysisTimeRanges {
|
|
|
4358
4427
|
* <p>The start range for the <code>ContributionAnalysisTimeRanges</code>.</p>
|
|
4359
4428
|
* @public
|
|
4360
4429
|
*/
|
|
4361
|
-
StartRange?: TopicIRFilterOption;
|
|
4430
|
+
StartRange?: TopicIRFilterOption | undefined;
|
|
4362
4431
|
/**
|
|
4363
4432
|
* <p>The end range for the <code>ContributionAnalysisTimeRanges</code>.</p>
|
|
4364
4433
|
* @public
|
|
4365
4434
|
*/
|
|
4366
|
-
EndRange?: TopicIRFilterOption;
|
|
4435
|
+
EndRange?: TopicIRFilterOption | undefined;
|
|
4367
4436
|
}
|
|
4368
4437
|
/**
|
|
4369
4438
|
* <p>The definition for a <code>TopicIRContributionAnalysis</code>.</p>
|
|
@@ -4374,22 +4443,22 @@ export interface TopicIRContributionAnalysis {
|
|
|
4374
4443
|
* <p>The factors for a <code>TopicIRContributionAnalysis</code>.</p>
|
|
4375
4444
|
* @public
|
|
4376
4445
|
*/
|
|
4377
|
-
Factors?: ContributionAnalysisFactor[];
|
|
4446
|
+
Factors?: ContributionAnalysisFactor[] | undefined;
|
|
4378
4447
|
/**
|
|
4379
4448
|
* <p>The time ranges for the <code>TopicIRContributionAnalysis</code>.</p>
|
|
4380
4449
|
* @public
|
|
4381
4450
|
*/
|
|
4382
|
-
TimeRanges?: ContributionAnalysisTimeRanges;
|
|
4451
|
+
TimeRanges?: ContributionAnalysisTimeRanges | undefined;
|
|
4383
4452
|
/**
|
|
4384
4453
|
* <p>The direction for the <code>TopicIRContributionAnalysis</code>.</p>
|
|
4385
4454
|
* @public
|
|
4386
4455
|
*/
|
|
4387
|
-
Direction?: ContributionAnalysisDirection;
|
|
4456
|
+
Direction?: ContributionAnalysisDirection | undefined;
|
|
4388
4457
|
/**
|
|
4389
4458
|
* <p>The sort type for the <code>TopicIRContributionAnalysis</code>.</p>
|
|
4390
4459
|
* @public
|
|
4391
4460
|
*/
|
|
4392
|
-
SortType?: ContributionAnalysisSortType;
|
|
4461
|
+
SortType?: ContributionAnalysisSortType | undefined;
|
|
4393
4462
|
}
|
|
4394
4463
|
/**
|
|
4395
4464
|
* @public
|
|
@@ -4428,12 +4497,12 @@ export interface NegativeFormat {
|
|
|
4428
4497
|
* <p>The prefix for a negative format.</p>
|
|
4429
4498
|
* @public
|
|
4430
4499
|
*/
|
|
4431
|
-
Prefix?: string;
|
|
4500
|
+
Prefix?: string | undefined;
|
|
4432
4501
|
/**
|
|
4433
4502
|
* <p>The suffix for a negative format.</p>
|
|
4434
4503
|
* @public
|
|
4435
4504
|
*/
|
|
4436
|
-
Suffix?: string;
|
|
4505
|
+
Suffix?: string | undefined;
|
|
4437
4506
|
}
|
|
4438
4507
|
/**
|
|
4439
4508
|
* <p>A structure that represents additional options for display formatting.</p>
|
|
@@ -4444,47 +4513,47 @@ export interface DisplayFormatOptions {
|
|
|
4444
4513
|
* <p>A Boolean value that indicates whether to use blank cell format.</p>
|
|
4445
4514
|
* @public
|
|
4446
4515
|
*/
|
|
4447
|
-
UseBlankCellFormat?: boolean;
|
|
4516
|
+
UseBlankCellFormat?: boolean | undefined;
|
|
4448
4517
|
/**
|
|
4449
4518
|
* <p>Determines the blank cell format.</p>
|
|
4450
4519
|
* @public
|
|
4451
4520
|
*/
|
|
4452
|
-
BlankCellFormat?: string;
|
|
4521
|
+
BlankCellFormat?: string | undefined;
|
|
4453
4522
|
/**
|
|
4454
4523
|
* <p>Determines the <code>DateTime</code> format.</p>
|
|
4455
4524
|
* @public
|
|
4456
4525
|
*/
|
|
4457
|
-
DateFormat?: string;
|
|
4526
|
+
DateFormat?: string | undefined;
|
|
4458
4527
|
/**
|
|
4459
4528
|
* <p>Determines the decimal separator.</p>
|
|
4460
4529
|
* @public
|
|
4461
4530
|
*/
|
|
4462
|
-
DecimalSeparator?: TopicNumericSeparatorSymbol;
|
|
4531
|
+
DecimalSeparator?: TopicNumericSeparatorSymbol | undefined;
|
|
4463
4532
|
/**
|
|
4464
4533
|
* <p>Determines the grouping separator.</p>
|
|
4465
4534
|
* @public
|
|
4466
4535
|
*/
|
|
4467
|
-
GroupingSeparator?: string;
|
|
4536
|
+
GroupingSeparator?: string | undefined;
|
|
4468
4537
|
/**
|
|
4469
4538
|
* <p>A Boolean value that indicates whether to use grouping.</p>
|
|
4470
4539
|
* @public
|
|
4471
4540
|
*/
|
|
4472
|
-
UseGrouping?: boolean;
|
|
4541
|
+
UseGrouping?: boolean | undefined;
|
|
4473
4542
|
/**
|
|
4474
4543
|
* <p>Determines the number of fraction digits.</p>
|
|
4475
4544
|
* @public
|
|
4476
4545
|
*/
|
|
4477
|
-
FractionDigits?: number;
|
|
4546
|
+
FractionDigits?: number | undefined;
|
|
4478
4547
|
/**
|
|
4479
4548
|
* <p>The prefix value for a display format.</p>
|
|
4480
4549
|
* @public
|
|
4481
4550
|
*/
|
|
4482
|
-
Prefix?: string;
|
|
4551
|
+
Prefix?: string | undefined;
|
|
4483
4552
|
/**
|
|
4484
4553
|
* <p>The suffix value for a display format.</p>
|
|
4485
4554
|
* @public
|
|
4486
4555
|
*/
|
|
4487
|
-
Suffix?: string;
|
|
4556
|
+
Suffix?: string | undefined;
|
|
4488
4557
|
/**
|
|
4489
4558
|
* <p>The unit scaler. Valid values for this structure are: <code>NONE</code>,
|
|
4490
4559
|
* <code>AUTO</code>, <code>THOUSANDS</code>, <code>MILLIONS</code>,
|
|
@@ -4492,17 +4561,17 @@ export interface DisplayFormatOptions {
|
|
|
4492
4561
|
* and <code>TRILLIONS</code>.</p>
|
|
4493
4562
|
* @public
|
|
4494
4563
|
*/
|
|
4495
|
-
UnitScaler?: NumberScale;
|
|
4564
|
+
UnitScaler?: NumberScale | undefined;
|
|
4496
4565
|
/**
|
|
4497
4566
|
* <p>The negative format.</p>
|
|
4498
4567
|
* @public
|
|
4499
4568
|
*/
|
|
4500
|
-
NegativeFormat?: NegativeFormat;
|
|
4569
|
+
NegativeFormat?: NegativeFormat | undefined;
|
|
4501
4570
|
/**
|
|
4502
4571
|
* <p>The currency symbol, such as <code>USD</code>.</p>
|
|
4503
4572
|
* @public
|
|
4504
4573
|
*/
|
|
4505
|
-
CurrencySymbol?: string;
|
|
4574
|
+
CurrencySymbol?: string | undefined;
|
|
4506
4575
|
}
|
|
4507
4576
|
/**
|
|
4508
4577
|
* <p>The definition for a <code>NamedEntityRef</code>.</p>
|
|
@@ -4513,7 +4582,7 @@ export interface NamedEntityRef {
|
|
|
4513
4582
|
* <p>The <code>NamedEntityName</code> for the <code>NamedEntityRef</code>.</p>
|
|
4514
4583
|
* @public
|
|
4515
4584
|
*/
|
|
4516
|
-
NamedEntityName?: string;
|
|
4585
|
+
NamedEntityName?: string | undefined;
|
|
4517
4586
|
}
|
|
4518
4587
|
/**
|
|
4519
4588
|
* <p>The definition for a <code>TopicSortClause</code>.</p>
|
|
@@ -4524,12 +4593,12 @@ export interface TopicSortClause {
|
|
|
4524
4593
|
* <p>The operand for a <code>TopicSortClause</code>.</p>
|
|
4525
4594
|
* @public
|
|
4526
4595
|
*/
|
|
4527
|
-
Operand?: Identifier;
|
|
4596
|
+
Operand?: Identifier | undefined;
|
|
4528
4597
|
/**
|
|
4529
4598
|
* <p>The sort direction for the <code>TopicSortClause</code>.</p>
|
|
4530
4599
|
* @public
|
|
4531
4600
|
*/
|
|
4532
|
-
SortDirection?: TopicSortDirection;
|
|
4601
|
+
SortDirection?: TopicSortDirection | undefined;
|
|
4533
4602
|
}
|
|
4534
4603
|
/**
|
|
4535
4604
|
* <p>The definition for a <code>TopicIRGroupBy</code>.</p>
|
|
@@ -4540,32 +4609,32 @@ export interface TopicIRGroupBy {
|
|
|
4540
4609
|
* <p>The field name for the <code>TopicIRGroupBy</code>.</p>
|
|
4541
4610
|
* @public
|
|
4542
4611
|
*/
|
|
4543
|
-
FieldName?: Identifier;
|
|
4612
|
+
FieldName?: Identifier | undefined;
|
|
4544
4613
|
/**
|
|
4545
4614
|
* <p>The time granularity for the <code>TopicIRGroupBy</code>.</p>
|
|
4546
4615
|
* @public
|
|
4547
4616
|
*/
|
|
4548
|
-
TimeGranularity?: TopicTimeGranularity;
|
|
4617
|
+
TimeGranularity?: TopicTimeGranularity | undefined;
|
|
4549
4618
|
/**
|
|
4550
4619
|
* <p>The sort for the <code>TopicIRGroupBy</code>.</p>
|
|
4551
4620
|
* @public
|
|
4552
4621
|
*/
|
|
4553
|
-
Sort?: TopicSortClause;
|
|
4622
|
+
Sort?: TopicSortClause | undefined;
|
|
4554
4623
|
/**
|
|
4555
4624
|
* <p>The display format for the <code>TopicIRGroupBy</code>.</p>
|
|
4556
4625
|
* @public
|
|
4557
4626
|
*/
|
|
4558
|
-
DisplayFormat?: DisplayFormat;
|
|
4627
|
+
DisplayFormat?: DisplayFormat | undefined;
|
|
4559
4628
|
/**
|
|
4560
4629
|
* <p>A structure that represents additional options for display formatting.</p>
|
|
4561
4630
|
* @public
|
|
4562
4631
|
*/
|
|
4563
|
-
DisplayFormatOptions?: DisplayFormatOptions;
|
|
4632
|
+
DisplayFormatOptions?: DisplayFormatOptions | undefined;
|
|
4564
4633
|
/**
|
|
4565
4634
|
* <p>The named entity for the <code>TopicIRGroupBy</code>.</p>
|
|
4566
4635
|
* @public
|
|
4567
4636
|
*/
|
|
4568
|
-
NamedEntity?: NamedEntityRef;
|
|
4637
|
+
NamedEntity?: NamedEntityRef | undefined;
|
|
4569
4638
|
}
|
|
4570
4639
|
/**
|
|
4571
4640
|
* @public
|
|
@@ -4596,17 +4665,17 @@ export interface TopicIRComparisonMethod {
|
|
|
4596
4665
|
* <p>The type for the <code>TopicIRComparisonMethod</code>.</p>
|
|
4597
4666
|
* @public
|
|
4598
4667
|
*/
|
|
4599
|
-
Type?: ComparisonMethodType;
|
|
4668
|
+
Type?: ComparisonMethodType | undefined;
|
|
4600
4669
|
/**
|
|
4601
4670
|
* <p>The period for the <code>TopicIRComparisonMethod</code>.</p>
|
|
4602
4671
|
* @public
|
|
4603
4672
|
*/
|
|
4604
|
-
Period?: TopicTimeGranularity;
|
|
4673
|
+
Period?: TopicTimeGranularity | undefined;
|
|
4605
4674
|
/**
|
|
4606
4675
|
* <p>The window size for the <code>TopicIRComparisonMethod</code>.</p>
|
|
4607
4676
|
* @public
|
|
4608
4677
|
*/
|
|
4609
|
-
WindowSize?: number;
|
|
4678
|
+
WindowSize?: number | undefined;
|
|
4610
4679
|
}
|
|
4611
4680
|
/**
|
|
4612
4681
|
* <p>The definition for a <code>TopicIRMetric</code>.</p>
|
|
@@ -4617,47 +4686,47 @@ export interface TopicIRMetric {
|
|
|
4617
4686
|
* <p>The metric ID for the <code>TopicIRMetric</code>.</p>
|
|
4618
4687
|
* @public
|
|
4619
4688
|
*/
|
|
4620
|
-
MetricId?: Identifier;
|
|
4689
|
+
MetricId?: Identifier | undefined;
|
|
4621
4690
|
/**
|
|
4622
4691
|
* <p>The function for the <code>TopicIRMetric</code>.</p>
|
|
4623
4692
|
* @public
|
|
4624
4693
|
*/
|
|
4625
|
-
Function?: AggFunction;
|
|
4694
|
+
Function?: AggFunction | undefined;
|
|
4626
4695
|
/**
|
|
4627
4696
|
* <p>The operands for the <code>TopicIRMetric</code>.</p>
|
|
4628
4697
|
* @public
|
|
4629
4698
|
*/
|
|
4630
|
-
Operands?: Identifier[];
|
|
4699
|
+
Operands?: Identifier[] | undefined;
|
|
4631
4700
|
/**
|
|
4632
4701
|
* <p>The comparison method for the <code>TopicIRMetric</code>.</p>
|
|
4633
4702
|
* @public
|
|
4634
4703
|
*/
|
|
4635
|
-
ComparisonMethod?: TopicIRComparisonMethod;
|
|
4704
|
+
ComparisonMethod?: TopicIRComparisonMethod | undefined;
|
|
4636
4705
|
/**
|
|
4637
4706
|
* <p>The expression for the <code>TopicIRMetric</code>.</p>
|
|
4638
4707
|
* @public
|
|
4639
4708
|
*/
|
|
4640
|
-
Expression?: string;
|
|
4709
|
+
Expression?: string | undefined;
|
|
4641
4710
|
/**
|
|
4642
4711
|
* <p>The calculated field references for the <code>TopicIRMetric</code>.</p>
|
|
4643
4712
|
* @public
|
|
4644
4713
|
*/
|
|
4645
|
-
CalculatedFieldReferences?: Identifier[];
|
|
4714
|
+
CalculatedFieldReferences?: Identifier[] | undefined;
|
|
4646
4715
|
/**
|
|
4647
4716
|
* <p>The display format for the <code>TopicIRMetric</code>.</p>
|
|
4648
4717
|
* @public
|
|
4649
4718
|
*/
|
|
4650
|
-
DisplayFormat?: DisplayFormat;
|
|
4719
|
+
DisplayFormat?: DisplayFormat | undefined;
|
|
4651
4720
|
/**
|
|
4652
4721
|
* <p>A structure that represents additional options for display formatting.</p>
|
|
4653
4722
|
* @public
|
|
4654
4723
|
*/
|
|
4655
|
-
DisplayFormatOptions?: DisplayFormatOptions;
|
|
4724
|
+
DisplayFormatOptions?: DisplayFormatOptions | undefined;
|
|
4656
4725
|
/**
|
|
4657
4726
|
* <p>The named entity for the <code>TopicIRMetric</code>.</p>
|
|
4658
4727
|
* @public
|
|
4659
4728
|
*/
|
|
4660
|
-
NamedEntity?: NamedEntityRef;
|
|
4729
|
+
NamedEntity?: NamedEntityRef | undefined;
|
|
4661
4730
|
}
|
|
4662
4731
|
/**
|
|
4663
4732
|
* <p>The definition for a <code>VisualOptions</code>.</p>
|
|
@@ -4668,7 +4737,7 @@ export interface VisualOptions {
|
|
|
4668
4737
|
* <p>The type for a <code>VisualOptions</code>.</p>
|
|
4669
4738
|
* @public
|
|
4670
4739
|
*/
|
|
4671
|
-
type?: string;
|
|
4740
|
+
type?: string | undefined;
|
|
4672
4741
|
}
|
|
4673
4742
|
/**
|
|
4674
4743
|
* <p>The definition for a <code>TopicIR</code>.</p>
|
|
@@ -4679,32 +4748,32 @@ export interface TopicIR {
|
|
|
4679
4748
|
* <p>The metrics for the <code>TopicIR</code>.</p>
|
|
4680
4749
|
* @public
|
|
4681
4750
|
*/
|
|
4682
|
-
Metrics?: TopicIRMetric[];
|
|
4751
|
+
Metrics?: TopicIRMetric[] | undefined;
|
|
4683
4752
|
/**
|
|
4684
4753
|
* <p>The GroupBy list for the <code>TopicIR</code>.</p>
|
|
4685
4754
|
* @public
|
|
4686
4755
|
*/
|
|
4687
|
-
GroupByList?: TopicIRGroupBy[];
|
|
4756
|
+
GroupByList?: TopicIRGroupBy[] | undefined;
|
|
4688
4757
|
/**
|
|
4689
4758
|
* <p>The filters for the <code>TopicIR</code>.</p>
|
|
4690
4759
|
* @public
|
|
4691
4760
|
*/
|
|
4692
|
-
Filters?: TopicIRFilterOption[][];
|
|
4761
|
+
Filters?: TopicIRFilterOption[][] | undefined;
|
|
4693
4762
|
/**
|
|
4694
4763
|
* <p>The sort for the <code>TopicIR</code>.</p>
|
|
4695
4764
|
* @public
|
|
4696
4765
|
*/
|
|
4697
|
-
Sort?: TopicSortClause;
|
|
4766
|
+
Sort?: TopicSortClause | undefined;
|
|
4698
4767
|
/**
|
|
4699
4768
|
* <p>The contribution analysis for the <code>TopicIR</code>.</p>
|
|
4700
4769
|
* @public
|
|
4701
4770
|
*/
|
|
4702
|
-
ContributionAnalysis?: TopicIRContributionAnalysis;
|
|
4771
|
+
ContributionAnalysis?: TopicIRContributionAnalysis | undefined;
|
|
4703
4772
|
/**
|
|
4704
4773
|
* <p>The visual for the <code>TopicIR</code>.</p>
|
|
4705
4774
|
* @public
|
|
4706
4775
|
*/
|
|
4707
|
-
Visual?: VisualOptions;
|
|
4776
|
+
Visual?: VisualOptions | undefined;
|
|
4708
4777
|
}
|
|
4709
4778
|
/**
|
|
4710
4779
|
* @public
|
|
@@ -4730,12 +4799,12 @@ export interface Slot {
|
|
|
4730
4799
|
* <p>The slot ID of the slot.</p>
|
|
4731
4800
|
* @public
|
|
4732
4801
|
*/
|
|
4733
|
-
SlotId?: string;
|
|
4802
|
+
SlotId?: string | undefined;
|
|
4734
4803
|
/**
|
|
4735
4804
|
* <p>The visual ID for the slot.</p>
|
|
4736
4805
|
* @public
|
|
4737
4806
|
*/
|
|
4738
|
-
VisualId?: string;
|
|
4807
|
+
VisualId?: string | undefined;
|
|
4739
4808
|
}
|
|
4740
4809
|
/**
|
|
4741
4810
|
* <p>The definition for a <code>TopicTemplate</code>.</p>
|
|
@@ -4746,12 +4815,12 @@ export interface TopicTemplate {
|
|
|
4746
4815
|
* <p>The template type for the <code>TopicTemplate</code>.</p>
|
|
4747
4816
|
* @public
|
|
4748
4817
|
*/
|
|
4749
|
-
TemplateType?: string;
|
|
4818
|
+
TemplateType?: string | undefined;
|
|
4750
4819
|
/**
|
|
4751
4820
|
* <p>The slots for the <code>TopicTemplate</code>.</p>
|
|
4752
4821
|
* @public
|
|
4753
4822
|
*/
|
|
4754
|
-
Slots?: Slot[];
|
|
4823
|
+
Slots?: Slot[] | undefined;
|
|
4755
4824
|
}
|
|
4756
4825
|
/**
|
|
4757
4826
|
* @public
|
|
@@ -4779,12 +4848,12 @@ export interface InvalidTopicReviewedAnswer {
|
|
|
4779
4848
|
* <p>The answer ID for the <code>InvalidTopicReviewedAnswer</code>.</p>
|
|
4780
4849
|
* @public
|
|
4781
4850
|
*/
|
|
4782
|
-
AnswerId?: string;
|
|
4851
|
+
AnswerId?: string | undefined;
|
|
4783
4852
|
/**
|
|
4784
4853
|
* <p>The error that is returned for the <code>InvalidTopicReviewedAnswer</code>.</p>
|
|
4785
4854
|
* @public
|
|
4786
4855
|
*/
|
|
4787
|
-
Error?: ReviewedAnswerErrorCode;
|
|
4856
|
+
Error?: ReviewedAnswerErrorCode | undefined;
|
|
4788
4857
|
}
|
|
4789
4858
|
/**
|
|
4790
4859
|
* <p>The definition for a <code>SucceededTopicReviewedAnswer</code>.</p>
|
|
@@ -4795,7 +4864,7 @@ export interface SucceededTopicReviewedAnswer {
|
|
|
4795
4864
|
* <p>The answer ID for the <code>SucceededTopicReviewedAnswer</code>.</p>
|
|
4796
4865
|
* @public
|
|
4797
4866
|
*/
|
|
4798
|
-
AnswerId?: string;
|
|
4867
|
+
AnswerId?: string | undefined;
|
|
4799
4868
|
}
|
|
4800
4869
|
/**
|
|
4801
4870
|
* @public
|
|
@@ -4806,32 +4875,32 @@ export interface BatchCreateTopicReviewedAnswerResponse {
|
|
|
4806
4875
|
* for each Amazon Web Services account.</p>
|
|
4807
4876
|
* @public
|
|
4808
4877
|
*/
|
|
4809
|
-
TopicId?: string;
|
|
4878
|
+
TopicId?: string | undefined;
|
|
4810
4879
|
/**
|
|
4811
4880
|
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
4812
4881
|
* @public
|
|
4813
4882
|
*/
|
|
4814
|
-
TopicArn?: string;
|
|
4883
|
+
TopicArn?: string | undefined;
|
|
4815
4884
|
/**
|
|
4816
4885
|
* <p>The definition of Answers that are successfully created.</p>
|
|
4817
4886
|
* @public
|
|
4818
4887
|
*/
|
|
4819
|
-
SucceededAnswers?: SucceededTopicReviewedAnswer[];
|
|
4888
|
+
SucceededAnswers?: SucceededTopicReviewedAnswer[] | undefined;
|
|
4820
4889
|
/**
|
|
4821
4890
|
* <p>The definition of Answers that are invalid and not created.</p>
|
|
4822
4891
|
* @public
|
|
4823
4892
|
*/
|
|
4824
|
-
InvalidAnswers?: InvalidTopicReviewedAnswer[];
|
|
4893
|
+
InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined;
|
|
4825
4894
|
/**
|
|
4826
4895
|
* <p>The HTTP status of the request.</p>
|
|
4827
4896
|
* @public
|
|
4828
4897
|
*/
|
|
4829
|
-
Status?: number;
|
|
4898
|
+
Status?: number | undefined;
|
|
4830
4899
|
/**
|
|
4831
4900
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
4832
4901
|
* @public
|
|
4833
4902
|
*/
|
|
4834
|
-
RequestId?: string;
|
|
4903
|
+
RequestId?: string | undefined;
|
|
4835
4904
|
}
|
|
4836
4905
|
/**
|
|
4837
4906
|
* <p>An internal failure occurred.</p>
|
|
@@ -4840,12 +4909,12 @@ export interface BatchCreateTopicReviewedAnswerResponse {
|
|
|
4840
4909
|
export declare class InternalFailureException extends __BaseException {
|
|
4841
4910
|
readonly name: "InternalFailureException";
|
|
4842
4911
|
readonly $fault: "server";
|
|
4843
|
-
Message?: string;
|
|
4912
|
+
Message?: string | undefined;
|
|
4844
4913
|
/**
|
|
4845
4914
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
4846
4915
|
* @public
|
|
4847
4916
|
*/
|
|
4848
|
-
RequestId?: string;
|
|
4917
|
+
RequestId?: string | undefined;
|
|
4849
4918
|
/**
|
|
4850
4919
|
* @internal
|
|
4851
4920
|
*/
|
|
@@ -4858,12 +4927,12 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
4858
4927
|
export declare class InvalidParameterValueException extends __BaseException {
|
|
4859
4928
|
readonly name: "InvalidParameterValueException";
|
|
4860
4929
|
readonly $fault: "client";
|
|
4861
|
-
Message?: string;
|
|
4930
|
+
Message?: string | undefined;
|
|
4862
4931
|
/**
|
|
4863
4932
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
4864
4933
|
* @public
|
|
4865
4934
|
*/
|
|
4866
|
-
RequestId?: string;
|
|
4935
|
+
RequestId?: string | undefined;
|
|
4867
4936
|
/**
|
|
4868
4937
|
* @internal
|
|
4869
4938
|
*/
|
|
@@ -4895,17 +4964,17 @@ export type ExceptionResourceType = (typeof ExceptionResourceType)[keyof typeof
|
|
|
4895
4964
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
4896
4965
|
readonly name: "ResourceNotFoundException";
|
|
4897
4966
|
readonly $fault: "client";
|
|
4898
|
-
Message?: string;
|
|
4967
|
+
Message?: string | undefined;
|
|
4899
4968
|
/**
|
|
4900
4969
|
* <p>The resource type for this request.</p>
|
|
4901
4970
|
* @public
|
|
4902
4971
|
*/
|
|
4903
|
-
ResourceType?: ExceptionResourceType;
|
|
4972
|
+
ResourceType?: ExceptionResourceType | undefined;
|
|
4904
4973
|
/**
|
|
4905
4974
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
4906
4975
|
* @public
|
|
4907
4976
|
*/
|
|
4908
|
-
RequestId?: string;
|
|
4977
|
+
RequestId?: string | undefined;
|
|
4909
4978
|
/**
|
|
4910
4979
|
* @internal
|
|
4911
4980
|
*/
|
|
@@ -4918,12 +4987,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
4918
4987
|
export declare class ThrottlingException extends __BaseException {
|
|
4919
4988
|
readonly name: "ThrottlingException";
|
|
4920
4989
|
readonly $fault: "client";
|
|
4921
|
-
Message?: string;
|
|
4990
|
+
Message?: string | undefined;
|
|
4922
4991
|
/**
|
|
4923
4992
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
4924
4993
|
* @public
|
|
4925
4994
|
*/
|
|
4926
|
-
RequestId?: string;
|
|
4995
|
+
RequestId?: string | undefined;
|
|
4927
4996
|
/**
|
|
4928
4997
|
* @internal
|
|
4929
4998
|
*/
|
|
@@ -4947,7 +5016,7 @@ export interface BatchDeleteTopicReviewedAnswerRequest {
|
|
|
4947
5016
|
* <p>The Answer IDs of the Answers to be deleted.</p>
|
|
4948
5017
|
* @public
|
|
4949
5018
|
*/
|
|
4950
|
-
AnswerIds?: string[];
|
|
5019
|
+
AnswerIds?: string[] | undefined;
|
|
4951
5020
|
}
|
|
4952
5021
|
/**
|
|
4953
5022
|
* @public
|
|
@@ -4957,32 +5026,32 @@ export interface BatchDeleteTopicReviewedAnswerResponse {
|
|
|
4957
5026
|
* <p>The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
4958
5027
|
* @public
|
|
4959
5028
|
*/
|
|
4960
|
-
TopicId?: string;
|
|
5029
|
+
TopicId?: string | undefined;
|
|
4961
5030
|
/**
|
|
4962
5031
|
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
4963
5032
|
* @public
|
|
4964
5033
|
*/
|
|
4965
|
-
TopicArn?: string;
|
|
5034
|
+
TopicArn?: string | undefined;
|
|
4966
5035
|
/**
|
|
4967
5036
|
* <p>The definition of Answers that are successfully deleted.</p>
|
|
4968
5037
|
* @public
|
|
4969
5038
|
*/
|
|
4970
|
-
SucceededAnswers?: SucceededTopicReviewedAnswer[];
|
|
5039
|
+
SucceededAnswers?: SucceededTopicReviewedAnswer[] | undefined;
|
|
4971
5040
|
/**
|
|
4972
5041
|
* <p>The definition of Answers that are invalid and not deleted.</p>
|
|
4973
5042
|
* @public
|
|
4974
5043
|
*/
|
|
4975
|
-
InvalidAnswers?: InvalidTopicReviewedAnswer[];
|
|
5044
|
+
InvalidAnswers?: InvalidTopicReviewedAnswer[] | undefined;
|
|
4976
5045
|
/**
|
|
4977
5046
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
4978
5047
|
* @public
|
|
4979
5048
|
*/
|
|
4980
|
-
RequestId?: string;
|
|
5049
|
+
RequestId?: string | undefined;
|
|
4981
5050
|
/**
|
|
4982
5051
|
* <p>The HTTP status of the request.</p>
|
|
4983
5052
|
* @public
|
|
4984
5053
|
*/
|
|
4985
|
-
Status?: number;
|
|
5054
|
+
Status?: number | undefined;
|
|
4986
5055
|
}
|
|
4987
5056
|
/**
|
|
4988
5057
|
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
@@ -4991,12 +5060,12 @@ export interface BatchDeleteTopicReviewedAnswerResponse {
|
|
|
4991
5060
|
export declare class ConflictException extends __BaseException {
|
|
4992
5061
|
readonly name: "ConflictException";
|
|
4993
5062
|
readonly $fault: "client";
|
|
4994
|
-
Message?: string;
|
|
5063
|
+
Message?: string | undefined;
|
|
4995
5064
|
/**
|
|
4996
5065
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
4997
5066
|
* @public
|
|
4998
5067
|
*/
|
|
4999
|
-
RequestId?: string;
|
|
5068
|
+
RequestId?: string | undefined;
|
|
5000
5069
|
/**
|
|
5001
5070
|
* @internal
|
|
5002
5071
|
*/
|
|
@@ -5023,7 +5092,7 @@ export interface BorderStyle {
|
|
|
5023
5092
|
* <p>The option to enable display of borders for visuals.</p>
|
|
5024
5093
|
* @public
|
|
5025
5094
|
*/
|
|
5026
|
-
Show?: boolean;
|
|
5095
|
+
Show?: boolean | undefined;
|
|
5027
5096
|
}
|
|
5028
5097
|
/**
|
|
5029
5098
|
* <p>A calculated column for a dataset.</p>
|
|
@@ -5076,22 +5145,22 @@ export interface CancelIngestionResponse {
|
|
|
5076
5145
|
* <p>The Amazon Resource Name (ARN) for the data ingestion.</p>
|
|
5077
5146
|
* @public
|
|
5078
5147
|
*/
|
|
5079
|
-
Arn?: string;
|
|
5148
|
+
Arn?: string | undefined;
|
|
5080
5149
|
/**
|
|
5081
5150
|
* <p>An ID for the ingestion.</p>
|
|
5082
5151
|
* @public
|
|
5083
5152
|
*/
|
|
5084
|
-
IngestionId?: string;
|
|
5153
|
+
IngestionId?: string | undefined;
|
|
5085
5154
|
/**
|
|
5086
5155
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5087
5156
|
* @public
|
|
5088
5157
|
*/
|
|
5089
|
-
RequestId?: string;
|
|
5158
|
+
RequestId?: string | undefined;
|
|
5090
5159
|
/**
|
|
5091
5160
|
* <p>The HTTP status of the request.</p>
|
|
5092
5161
|
* @public
|
|
5093
5162
|
*/
|
|
5094
|
-
Status?: number;
|
|
5163
|
+
Status?: number | undefined;
|
|
5095
5164
|
}
|
|
5096
5165
|
/**
|
|
5097
5166
|
* <p>The resource specified already exists. </p>
|
|
@@ -5100,17 +5169,17 @@ export interface CancelIngestionResponse {
|
|
|
5100
5169
|
export declare class ResourceExistsException extends __BaseException {
|
|
5101
5170
|
readonly name: "ResourceExistsException";
|
|
5102
5171
|
readonly $fault: "client";
|
|
5103
|
-
Message?: string;
|
|
5172
|
+
Message?: string | undefined;
|
|
5104
5173
|
/**
|
|
5105
5174
|
* <p>The resource type for this request.</p>
|
|
5106
5175
|
* @public
|
|
5107
5176
|
*/
|
|
5108
|
-
ResourceType?: ExceptionResourceType;
|
|
5177
|
+
ResourceType?: ExceptionResourceType | undefined;
|
|
5109
5178
|
/**
|
|
5110
5179
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
5111
5180
|
* @public
|
|
5112
5181
|
*/
|
|
5113
|
-
RequestId?: string;
|
|
5182
|
+
RequestId?: string | undefined;
|
|
5114
5183
|
/**
|
|
5115
5184
|
* @internal
|
|
5116
5185
|
*/
|
|
@@ -5161,13 +5230,13 @@ export interface CastColumnTypeOperation {
|
|
|
5161
5230
|
* <p>The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.</p>
|
|
5162
5231
|
* @public
|
|
5163
5232
|
*/
|
|
5164
|
-
SubType?: ColumnDataSubType;
|
|
5233
|
+
SubType?: ColumnDataSubType | undefined;
|
|
5165
5234
|
/**
|
|
5166
5235
|
* <p>When casting a column from string to datetime type, you can supply a string in a
|
|
5167
5236
|
* format supported by Amazon QuickSight to denote the source data format.</p>
|
|
5168
5237
|
* @public
|
|
5169
5238
|
*/
|
|
5170
|
-
Format?: string;
|
|
5239
|
+
Format?: string | undefined;
|
|
5171
5240
|
}
|
|
5172
5241
|
/**
|
|
5173
5242
|
* @public
|
|
@@ -5203,12 +5272,12 @@ export interface CellValueSynonym {
|
|
|
5203
5272
|
* <p>The cell value.</p>
|
|
5204
5273
|
* @public
|
|
5205
5274
|
*/
|
|
5206
|
-
CellValue?: string;
|
|
5275
|
+
CellValue?: string | undefined;
|
|
5207
5276
|
/**
|
|
5208
5277
|
* <p>Other names or aliases for the cell value.</p>
|
|
5209
5278
|
* @public
|
|
5210
5279
|
*/
|
|
5211
|
-
Synonyms?: string[];
|
|
5280
|
+
Synonyms?: string[] | undefined;
|
|
5212
5281
|
}
|
|
5213
5282
|
/**
|
|
5214
5283
|
* <p>A structure that represents a collective constant.</p>
|
|
@@ -5219,7 +5288,7 @@ export interface CollectiveConstant {
|
|
|
5219
5288
|
* <p>A list of values for the collective constant.</p>
|
|
5220
5289
|
* @public
|
|
5221
5290
|
*/
|
|
5222
|
-
ValueList?: string[];
|
|
5291
|
+
ValueList?: string[] | undefined;
|
|
5223
5292
|
}
|
|
5224
5293
|
/**
|
|
5225
5294
|
* @public
|
|
@@ -5242,7 +5311,7 @@ export interface ColumnDescription {
|
|
|
5242
5311
|
* <p>The text of a description for a column.</p>
|
|
5243
5312
|
* @public
|
|
5244
5313
|
*/
|
|
5245
|
-
Text?: string;
|
|
5314
|
+
Text?: string | undefined;
|
|
5246
5315
|
}
|
|
5247
5316
|
/**
|
|
5248
5317
|
* @public
|
|
@@ -5269,7 +5338,7 @@ export interface GeoSpatialColumnGroup {
|
|
|
5269
5338
|
* <p>Country code.</p>
|
|
5270
5339
|
* @public
|
|
5271
5340
|
*/
|
|
5272
|
-
CountryCode?: GeoSpatialCountryCode;
|
|
5341
|
+
CountryCode?: GeoSpatialCountryCode | undefined;
|
|
5273
5342
|
/**
|
|
5274
5343
|
* <p>Columns in this hierarchy.</p>
|
|
5275
5344
|
* @public
|
|
@@ -5287,7 +5356,7 @@ export interface ColumnGroup {
|
|
|
5287
5356
|
* <p>Geospatial column group that denotes a hierarchy.</p>
|
|
5288
5357
|
* @public
|
|
5289
5358
|
*/
|
|
5290
|
-
GeoSpatialColumnGroup?: GeoSpatialColumnGroup;
|
|
5359
|
+
GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined;
|
|
5291
5360
|
}
|
|
5292
5361
|
/**
|
|
5293
5362
|
* <p>A structure describing the name, data type, and geographic role of the columns.</p>
|
|
@@ -5298,7 +5367,7 @@ export interface ColumnGroupColumnSchema {
|
|
|
5298
5367
|
* <p>The name of the column group's column schema.</p>
|
|
5299
5368
|
* @public
|
|
5300
5369
|
*/
|
|
5301
|
-
Name?: string;
|
|
5370
|
+
Name?: string | undefined;
|
|
5302
5371
|
}
|
|
5303
5372
|
/**
|
|
5304
5373
|
* <p>The column group schema.</p>
|
|
@@ -5309,12 +5378,12 @@ export interface ColumnGroupSchema {
|
|
|
5309
5378
|
* <p>The name of the column group schema.</p>
|
|
5310
5379
|
* @public
|
|
5311
5380
|
*/
|
|
5312
|
-
Name?: string;
|
|
5381
|
+
Name?: string | undefined;
|
|
5313
5382
|
/**
|
|
5314
5383
|
* <p>A structure containing the list of schemas for column group columns.</p>
|
|
5315
5384
|
* @public
|
|
5316
5385
|
*/
|
|
5317
|
-
ColumnGroupColumnSchemaList?: ColumnGroupColumnSchema[];
|
|
5386
|
+
ColumnGroupColumnSchemaList?: ColumnGroupColumnSchema[] | undefined;
|
|
5318
5387
|
}
|
|
5319
5388
|
/**
|
|
5320
5389
|
* <p>A rule defined to grant access on one or more restricted columns.
|
|
@@ -5330,12 +5399,12 @@ export interface ColumnLevelPermissionRule {
|
|
|
5330
5399
|
* <p>An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.</p>
|
|
5331
5400
|
* @public
|
|
5332
5401
|
*/
|
|
5333
|
-
Principals?: string[];
|
|
5402
|
+
Principals?: string[] | undefined;
|
|
5334
5403
|
/**
|
|
5335
5404
|
* <p>An array of column names.</p>
|
|
5336
5405
|
* @public
|
|
5337
5406
|
*/
|
|
5338
|
-
ColumnNames?: string[];
|
|
5407
|
+
ColumnNames?: string[] | undefined;
|
|
5339
5408
|
}
|
|
5340
5409
|
/**
|
|
5341
5410
|
* @public
|
|
@@ -5359,17 +5428,17 @@ export interface ColumnSchema {
|
|
|
5359
5428
|
* <p>The name of the column schema.</p>
|
|
5360
5429
|
* @public
|
|
5361
5430
|
*/
|
|
5362
|
-
Name?: string;
|
|
5431
|
+
Name?: string | undefined;
|
|
5363
5432
|
/**
|
|
5364
5433
|
* <p>The data type of the column schema.</p>
|
|
5365
5434
|
* @public
|
|
5366
5435
|
*/
|
|
5367
|
-
DataType?: string;
|
|
5436
|
+
DataType?: string | undefined;
|
|
5368
5437
|
/**
|
|
5369
5438
|
* <p>The geographic role of the column schema.</p>
|
|
5370
5439
|
* @public
|
|
5371
5440
|
*/
|
|
5372
|
-
GeographicRole?: string;
|
|
5441
|
+
GeographicRole?: string | undefined;
|
|
5373
5442
|
}
|
|
5374
5443
|
/**
|
|
5375
5444
|
* @public
|
|
@@ -5403,12 +5472,12 @@ export interface ColumnTag {
|
|
|
5403
5472
|
* <p>A geospatial role for a column.</p>
|
|
5404
5473
|
* @public
|
|
5405
5474
|
*/
|
|
5406
|
-
ColumnGeographicRole?: GeoSpatialDataRole;
|
|
5475
|
+
ColumnGeographicRole?: GeoSpatialDataRole | undefined;
|
|
5407
5476
|
/**
|
|
5408
5477
|
* <p>A description for a column.</p>
|
|
5409
5478
|
* @public
|
|
5410
5479
|
*/
|
|
5411
|
-
ColumnDescription?: ColumnDescription;
|
|
5480
|
+
ColumnDescription?: ColumnDescription | undefined;
|
|
5412
5481
|
}
|
|
5413
5482
|
/**
|
|
5414
5483
|
* @public
|
|
@@ -5443,17 +5512,17 @@ export interface ComparativeOrder {
|
|
|
5443
5512
|
* <p>The ordering type for a column. Valid values for this structure are <code>GREATER_IS_BETTER</code>, <code>LESSER_IS_BETTER</code> and <code>SPECIFIED</code>.</p>
|
|
5444
5513
|
* @public
|
|
5445
5514
|
*/
|
|
5446
|
-
UseOrdering?: ColumnOrderingType;
|
|
5515
|
+
UseOrdering?: ColumnOrderingType | undefined;
|
|
5447
5516
|
/**
|
|
5448
5517
|
* <p>The list of columns to be used in the ordering.</p>
|
|
5449
5518
|
* @public
|
|
5450
5519
|
*/
|
|
5451
|
-
SpecifedOrder?: string[];
|
|
5520
|
+
SpecifedOrder?: string[] | undefined;
|
|
5452
5521
|
/**
|
|
5453
5522
|
* <p>The treat of undefined specified values. Valid values for this structure are <code>LEAST</code> and <code>MOST</code>.</p>
|
|
5454
5523
|
* @public
|
|
5455
5524
|
*/
|
|
5456
|
-
TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType;
|
|
5525
|
+
TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType | undefined;
|
|
5457
5526
|
}
|
|
5458
5527
|
/**
|
|
5459
5528
|
* <p>A resource is already in a state that indicates an operation is happening that must complete
|
|
@@ -5463,8 +5532,8 @@ export interface ComparativeOrder {
|
|
|
5463
5532
|
export declare class ConcurrentUpdatingException extends __BaseException {
|
|
5464
5533
|
readonly name: "ConcurrentUpdatingException";
|
|
5465
5534
|
readonly $fault: "server";
|
|
5466
|
-
Message?: string;
|
|
5467
|
-
RequestId?: string;
|
|
5535
|
+
Message?: string | undefined;
|
|
5536
|
+
RequestId?: string | undefined;
|
|
5468
5537
|
/**
|
|
5469
5538
|
* @internal
|
|
5470
5539
|
*/
|
|
@@ -5483,7 +5552,7 @@ export interface CreateAccountCustomizationRequest {
|
|
|
5483
5552
|
* <p>The Amazon QuickSight namespace that you want to add customizations to.</p>
|
|
5484
5553
|
* @public
|
|
5485
5554
|
*/
|
|
5486
|
-
Namespace?: string;
|
|
5555
|
+
Namespace?: string | undefined;
|
|
5487
5556
|
/**
|
|
5488
5557
|
* <p>The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add
|
|
5489
5558
|
* these to an Amazon Web Services account and a QuickSight namespace. </p>
|
|
@@ -5500,7 +5569,7 @@ export interface CreateAccountCustomizationRequest {
|
|
|
5500
5569
|
* <p>A list of the tags that you want to attach to this resource.</p>
|
|
5501
5570
|
* @public
|
|
5502
5571
|
*/
|
|
5503
|
-
Tags?: Tag[];
|
|
5572
|
+
Tags?: Tag[] | undefined;
|
|
5504
5573
|
}
|
|
5505
5574
|
/**
|
|
5506
5575
|
* @public
|
|
@@ -5510,32 +5579,32 @@ export interface CreateAccountCustomizationResponse {
|
|
|
5510
5579
|
* <p>The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.</p>
|
|
5511
5580
|
* @public
|
|
5512
5581
|
*/
|
|
5513
|
-
Arn?: string;
|
|
5582
|
+
Arn?: string | undefined;
|
|
5514
5583
|
/**
|
|
5515
5584
|
* <p>The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.</p>
|
|
5516
5585
|
* @public
|
|
5517
5586
|
*/
|
|
5518
|
-
AwsAccountId?: string;
|
|
5587
|
+
AwsAccountId?: string | undefined;
|
|
5519
5588
|
/**
|
|
5520
5589
|
* <p>The namespace associated with the customization you're creating. </p>
|
|
5521
5590
|
* @public
|
|
5522
5591
|
*/
|
|
5523
|
-
Namespace?: string;
|
|
5592
|
+
Namespace?: string | undefined;
|
|
5524
5593
|
/**
|
|
5525
5594
|
* <p>The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. </p>
|
|
5526
5595
|
* @public
|
|
5527
5596
|
*/
|
|
5528
|
-
AccountCustomization?: AccountCustomization;
|
|
5597
|
+
AccountCustomization?: AccountCustomization | undefined;
|
|
5529
5598
|
/**
|
|
5530
5599
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5531
5600
|
* @public
|
|
5532
5601
|
*/
|
|
5533
|
-
RequestId?: string;
|
|
5602
|
+
RequestId?: string | undefined;
|
|
5534
5603
|
/**
|
|
5535
5604
|
* <p>The HTTP status of the request.</p>
|
|
5536
5605
|
* @public
|
|
5537
5606
|
*/
|
|
5538
|
-
Status?: number;
|
|
5607
|
+
Status?: number | undefined;
|
|
5539
5608
|
}
|
|
5540
5609
|
/**
|
|
5541
5610
|
* <p>This resource is currently unavailable.</p>
|
|
@@ -5544,17 +5613,17 @@ export interface CreateAccountCustomizationResponse {
|
|
|
5544
5613
|
export declare class ResourceUnavailableException extends __BaseException {
|
|
5545
5614
|
readonly name: "ResourceUnavailableException";
|
|
5546
5615
|
readonly $fault: "server";
|
|
5547
|
-
Message?: string;
|
|
5616
|
+
Message?: string | undefined;
|
|
5548
5617
|
/**
|
|
5549
5618
|
* <p>The resource type for this request.</p>
|
|
5550
5619
|
* @public
|
|
5551
5620
|
*/
|
|
5552
|
-
ResourceType?: ExceptionResourceType;
|
|
5621
|
+
ResourceType?: ExceptionResourceType | undefined;
|
|
5553
5622
|
/**
|
|
5554
5623
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
5555
5624
|
* @public
|
|
5556
5625
|
*/
|
|
5557
|
-
RequestId?: string;
|
|
5626
|
+
RequestId?: string | undefined;
|
|
5558
5627
|
/**
|
|
5559
5628
|
* @internal
|
|
5560
5629
|
*/
|
|
@@ -5594,7 +5663,7 @@ export interface CreateAccountSubscriptionRequest {
|
|
|
5594
5663
|
* </ul>
|
|
5595
5664
|
* @public
|
|
5596
5665
|
*/
|
|
5597
|
-
Edition?: Edition;
|
|
5666
|
+
Edition?: Edition | undefined;
|
|
5598
5667
|
/**
|
|
5599
5668
|
* <p>The method that you want to use to authenticate your Amazon QuickSight account.</p>
|
|
5600
5669
|
* <p>If you choose <code>ACTIVE_DIRECTORY</code>, provide an <code>ActiveDirectoryName</code>
|
|
@@ -5624,86 +5693,86 @@ export interface CreateAccountSubscriptionRequest {
|
|
|
5624
5693
|
* <p>The name of your Active Directory. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
5625
5694
|
* @public
|
|
5626
5695
|
*/
|
|
5627
|
-
ActiveDirectoryName?: string;
|
|
5696
|
+
ActiveDirectoryName?: string | undefined;
|
|
5628
5697
|
/**
|
|
5629
5698
|
* <p>The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
5630
5699
|
* @public
|
|
5631
5700
|
*/
|
|
5632
|
-
Realm?: string;
|
|
5701
|
+
Realm?: string | undefined;
|
|
5633
5702
|
/**
|
|
5634
5703
|
* <p>The ID of the Active Directory that is associated with your Amazon QuickSight account.</p>
|
|
5635
5704
|
* @public
|
|
5636
5705
|
*/
|
|
5637
|
-
DirectoryId?: string;
|
|
5706
|
+
DirectoryId?: string | undefined;
|
|
5638
5707
|
/**
|
|
5639
5708
|
* <p>The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminProGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
5640
5709
|
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5641
5710
|
* @public
|
|
5642
5711
|
*/
|
|
5643
|
-
AdminGroup?: string[];
|
|
5712
|
+
AdminGroup?: string[] | undefined;
|
|
5644
5713
|
/**
|
|
5645
5714
|
* <p>The author group associated with your Active Directory or IAM Identity Center account.</p>
|
|
5646
5715
|
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5647
5716
|
* @public
|
|
5648
5717
|
*/
|
|
5649
|
-
AuthorGroup?: string[];
|
|
5718
|
+
AuthorGroup?: string[] | undefined;
|
|
5650
5719
|
/**
|
|
5651
5720
|
* <p>The reader group associated with your Active Directory or IAM Identity Center account.</p>
|
|
5652
5721
|
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5653
5722
|
* @public
|
|
5654
5723
|
*/
|
|
5655
|
-
ReaderGroup?: string[];
|
|
5724
|
+
ReaderGroup?: string[] | undefined;
|
|
5656
5725
|
/**
|
|
5657
5726
|
* <p>The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p>
|
|
5658
5727
|
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5659
5728
|
* @public
|
|
5660
5729
|
*/
|
|
5661
|
-
AdminProGroup?: string[];
|
|
5730
|
+
AdminProGroup?: string[] | undefined;
|
|
5662
5731
|
/**
|
|
5663
5732
|
* <p>The author pro group associated with your Active Directory or IAM Identity Center account.</p>
|
|
5664
5733
|
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5665
5734
|
* @public
|
|
5666
5735
|
*/
|
|
5667
|
-
AuthorProGroup?: string[];
|
|
5736
|
+
AuthorProGroup?: string[] | undefined;
|
|
5668
5737
|
/**
|
|
5669
5738
|
* <p>The reader pro group associated with your Active Directory or IAM Identity Center account.</p>
|
|
5670
5739
|
* <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>
|
|
5671
5740
|
* @public
|
|
5672
5741
|
*/
|
|
5673
|
-
ReaderProGroup?: string[];
|
|
5742
|
+
ReaderProGroup?: string[] | undefined;
|
|
5674
5743
|
/**
|
|
5675
5744
|
* <p>The first name of the author of the Amazon QuickSight account to use for future
|
|
5676
5745
|
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
5677
5746
|
* edition of the new Amazon QuickSight account.</p>
|
|
5678
5747
|
* @public
|
|
5679
5748
|
*/
|
|
5680
|
-
FirstName?: string;
|
|
5749
|
+
FirstName?: string | undefined;
|
|
5681
5750
|
/**
|
|
5682
5751
|
* <p>The last name of the author of the Amazon QuickSight account to use for future
|
|
5683
5752
|
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
5684
5753
|
* edition of the new Amazon QuickSight account.</p>
|
|
5685
5754
|
* @public
|
|
5686
5755
|
*/
|
|
5687
|
-
LastName?: string;
|
|
5756
|
+
LastName?: string | undefined;
|
|
5688
5757
|
/**
|
|
5689
5758
|
* <p>The email address of the author of the Amazon QuickSight account to use for future
|
|
5690
5759
|
* communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected
|
|
5691
5760
|
* edition of the new Amazon QuickSight account.</p>
|
|
5692
5761
|
* @public
|
|
5693
5762
|
*/
|
|
5694
|
-
EmailAddress?: string;
|
|
5763
|
+
EmailAddress?: string | undefined;
|
|
5695
5764
|
/**
|
|
5696
5765
|
* <p>A 10-digit phone number for the author of the Amazon QuickSight account to use for
|
|
5697
5766
|
* future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the
|
|
5698
5767
|
* selected edition of the new Amazon QuickSight account.</p>
|
|
5699
5768
|
* @public
|
|
5700
5769
|
*/
|
|
5701
|
-
ContactNumber?: string;
|
|
5770
|
+
ContactNumber?: string | undefined;
|
|
5702
5771
|
/**
|
|
5703
5772
|
* <p>The Amazon Resource Name (ARN) for the IAM Identity Center instance.</p>
|
|
5704
5773
|
* @public
|
|
5705
5774
|
*/
|
|
5706
|
-
IAMIdentityCenterInstanceArn?: string;
|
|
5775
|
+
IAMIdentityCenterInstanceArn?: string | undefined;
|
|
5707
5776
|
}
|
|
5708
5777
|
/**
|
|
5709
5778
|
* <p>A <code>SignupResponse</code> object that contains a summary of a newly created account.</p>
|
|
@@ -5715,24 +5784,24 @@ export interface SignupResponse {
|
|
|
5715
5784
|
* authentication method.</p>
|
|
5716
5785
|
* @public
|
|
5717
5786
|
*/
|
|
5718
|
-
IAMUser?: boolean;
|
|
5787
|
+
IAMUser?: boolean | undefined;
|
|
5719
5788
|
/**
|
|
5720
5789
|
* <p>The user login name for your Amazon QuickSight account.</p>
|
|
5721
5790
|
* @public
|
|
5722
5791
|
*/
|
|
5723
|
-
userLoginName?: string;
|
|
5792
|
+
userLoginName?: string | undefined;
|
|
5724
5793
|
/**
|
|
5725
5794
|
* <p>The name of your Amazon QuickSight account.</p>
|
|
5726
5795
|
* @public
|
|
5727
5796
|
*/
|
|
5728
|
-
accountName?: string;
|
|
5797
|
+
accountName?: string | undefined;
|
|
5729
5798
|
/**
|
|
5730
5799
|
* <p>The type of Active Directory that is being used to authenticate the Amazon QuickSight
|
|
5731
5800
|
* account. Valid values are <code>SIMPLE_AD</code>, <code>AD_CONNECTOR</code>, and
|
|
5732
5801
|
* <code>MICROSOFT_AD</code>.</p>
|
|
5733
5802
|
* @public
|
|
5734
5803
|
*/
|
|
5735
|
-
directoryType?: string;
|
|
5804
|
+
directoryType?: string | undefined;
|
|
5736
5805
|
}
|
|
5737
5806
|
/**
|
|
5738
5807
|
* @public
|
|
@@ -5742,17 +5811,17 @@ export interface CreateAccountSubscriptionResponse {
|
|
|
5742
5811
|
* <p>A <code>SignupResponse</code> object that returns information about a newly created Amazon QuickSight account.</p>
|
|
5743
5812
|
* @public
|
|
5744
5813
|
*/
|
|
5745
|
-
SignupResponse?: SignupResponse;
|
|
5814
|
+
SignupResponse?: SignupResponse | undefined;
|
|
5746
5815
|
/**
|
|
5747
5816
|
* <p>The HTTP status of the request.</p>
|
|
5748
5817
|
* @public
|
|
5749
5818
|
*/
|
|
5750
|
-
Status?: number;
|
|
5819
|
+
Status?: number | undefined;
|
|
5751
5820
|
/**
|
|
5752
5821
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5753
5822
|
* @public
|
|
5754
5823
|
*/
|
|
5755
|
-
RequestId?: string;
|
|
5824
|
+
RequestId?: string | undefined;
|
|
5756
5825
|
}
|
|
5757
5826
|
/**
|
|
5758
5827
|
* <p>One or more preconditions aren't met.</p>
|
|
@@ -5761,12 +5830,12 @@ export interface CreateAccountSubscriptionResponse {
|
|
|
5761
5830
|
export declare class PreconditionNotMetException extends __BaseException {
|
|
5762
5831
|
readonly name: "PreconditionNotMetException";
|
|
5763
5832
|
readonly $fault: "client";
|
|
5764
|
-
Message?: string;
|
|
5833
|
+
Message?: string | undefined;
|
|
5765
5834
|
/**
|
|
5766
5835
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
5767
5836
|
* @public
|
|
5768
5837
|
*/
|
|
5769
|
-
RequestId?: string;
|
|
5838
|
+
RequestId?: string | undefined;
|
|
5770
5839
|
/**
|
|
5771
5840
|
* @internal
|
|
5772
5841
|
*/
|
|
@@ -5845,22 +5914,22 @@ export interface _Parameters {
|
|
|
5845
5914
|
* <p>The parameters that have a data type of string.</p>
|
|
5846
5915
|
* @public
|
|
5847
5916
|
*/
|
|
5848
|
-
StringParameters?: StringParameter[];
|
|
5917
|
+
StringParameters?: StringParameter[] | undefined;
|
|
5849
5918
|
/**
|
|
5850
5919
|
* <p>The parameters that have a data type of integer.</p>
|
|
5851
5920
|
* @public
|
|
5852
5921
|
*/
|
|
5853
|
-
IntegerParameters?: IntegerParameter[];
|
|
5922
|
+
IntegerParameters?: IntegerParameter[] | undefined;
|
|
5854
5923
|
/**
|
|
5855
5924
|
* <p>The parameters that have a data type of decimal.</p>
|
|
5856
5925
|
* @public
|
|
5857
5926
|
*/
|
|
5858
|
-
DecimalParameters?: DecimalParameter[];
|
|
5927
|
+
DecimalParameters?: DecimalParameter[] | undefined;
|
|
5859
5928
|
/**
|
|
5860
5929
|
* <p>The parameters that have a data type of date-time.</p>
|
|
5861
5930
|
* @public
|
|
5862
5931
|
*/
|
|
5863
|
-
DateTimeParameters?: DateTimeParameter[];
|
|
5932
|
+
DateTimeParameters?: DateTimeParameter[] | undefined;
|
|
5864
5933
|
}
|
|
5865
5934
|
/**
|
|
5866
5935
|
* <p>Permission for the resource.</p>
|
|
@@ -5941,7 +6010,7 @@ export interface CreateAnalysisRequest {
|
|
|
5941
6010
|
* any parameter type, and some parameters might accept multiple values. </p>
|
|
5942
6011
|
* @public
|
|
5943
6012
|
*/
|
|
5944
|
-
Parameters?: _Parameters;
|
|
6013
|
+
Parameters?: _Parameters | undefined;
|
|
5945
6014
|
/**
|
|
5946
6015
|
* <p>A structure that describes the principals and the resource-level permissions on an
|
|
5947
6016
|
* analysis. You can use the <code>Permissions</code> structure to grant permissions by
|
|
@@ -5950,7 +6019,7 @@ export interface CreateAnalysisRequest {
|
|
|
5950
6019
|
* <p>To specify no permissions, omit <code>Permissions</code>.</p>
|
|
5951
6020
|
* @public
|
|
5952
6021
|
*/
|
|
5953
|
-
Permissions?: ResourcePermission[];
|
|
6022
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
5954
6023
|
/**
|
|
5955
6024
|
* <p>A source entity to use for the analysis that you're creating. This metadata structure
|
|
5956
6025
|
* contains details that describe a source template and one or more datasets.</p>
|
|
@@ -5958,19 +6027,19 @@ export interface CreateAnalysisRequest {
|
|
|
5958
6027
|
* order for the request to be valid.</p>
|
|
5959
6028
|
* @public
|
|
5960
6029
|
*/
|
|
5961
|
-
SourceEntity?: AnalysisSourceEntity;
|
|
6030
|
+
SourceEntity?: AnalysisSourceEntity | undefined;
|
|
5962
6031
|
/**
|
|
5963
6032
|
* <p>The ARN for the theme to apply to the analysis that you're creating. To see the theme
|
|
5964
6033
|
* in the Amazon QuickSight console, make sure that you have access to it.</p>
|
|
5965
6034
|
* @public
|
|
5966
6035
|
*/
|
|
5967
|
-
ThemeArn?: string;
|
|
6036
|
+
ThemeArn?: string | undefined;
|
|
5968
6037
|
/**
|
|
5969
6038
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
5970
6039
|
* analysis.</p>
|
|
5971
6040
|
* @public
|
|
5972
6041
|
*/
|
|
5973
|
-
Tags?: Tag[];
|
|
6042
|
+
Tags?: Tag[] | undefined;
|
|
5974
6043
|
/**
|
|
5975
6044
|
* <p>The definition of an analysis.</p>
|
|
5976
6045
|
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
@@ -5978,17 +6047,17 @@ export interface CreateAnalysisRequest {
|
|
|
5978
6047
|
* order for the request to be valid.</p>
|
|
5979
6048
|
* @public
|
|
5980
6049
|
*/
|
|
5981
|
-
Definition?: AnalysisDefinition;
|
|
6050
|
+
Definition?: AnalysisDefinition | undefined;
|
|
5982
6051
|
/**
|
|
5983
6052
|
* <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
|
|
5984
6053
|
* @public
|
|
5985
6054
|
*/
|
|
5986
|
-
ValidationStrategy?: ValidationStrategy;
|
|
6055
|
+
ValidationStrategy?: ValidationStrategy | undefined;
|
|
5987
6056
|
/**
|
|
5988
6057
|
* <p>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</p>
|
|
5989
6058
|
* @public
|
|
5990
6059
|
*/
|
|
5991
|
-
FolderArns?: string[];
|
|
6060
|
+
FolderArns?: string[] | undefined;
|
|
5992
6061
|
}
|
|
5993
6062
|
/**
|
|
5994
6063
|
* @public
|
|
@@ -5998,27 +6067,27 @@ export interface CreateAnalysisResponse {
|
|
|
5998
6067
|
* <p>The ARN for the analysis.</p>
|
|
5999
6068
|
* @public
|
|
6000
6069
|
*/
|
|
6001
|
-
Arn?: string;
|
|
6070
|
+
Arn?: string | undefined;
|
|
6002
6071
|
/**
|
|
6003
6072
|
* <p>The ID of the analysis.</p>
|
|
6004
6073
|
* @public
|
|
6005
6074
|
*/
|
|
6006
|
-
AnalysisId?: string;
|
|
6075
|
+
AnalysisId?: string | undefined;
|
|
6007
6076
|
/**
|
|
6008
6077
|
* <p>The status of the creation of the analysis. </p>
|
|
6009
6078
|
* @public
|
|
6010
6079
|
*/
|
|
6011
|
-
CreationStatus?: ResourceStatus;
|
|
6080
|
+
CreationStatus?: ResourceStatus | undefined;
|
|
6012
6081
|
/**
|
|
6013
6082
|
* <p>The HTTP status of the request.</p>
|
|
6014
6083
|
* @public
|
|
6015
6084
|
*/
|
|
6016
|
-
Status?: number;
|
|
6085
|
+
Status?: number | undefined;
|
|
6017
6086
|
/**
|
|
6018
6087
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6019
6088
|
* @public
|
|
6020
6089
|
*/
|
|
6021
|
-
RequestId?: string;
|
|
6090
|
+
RequestId?: string | undefined;
|
|
6022
6091
|
}
|
|
6023
6092
|
/**
|
|
6024
6093
|
* <p>A limit is exceeded.</p>
|
|
@@ -6027,17 +6096,17 @@ export interface CreateAnalysisResponse {
|
|
|
6027
6096
|
export declare class LimitExceededException extends __BaseException {
|
|
6028
6097
|
readonly name: "LimitExceededException";
|
|
6029
6098
|
readonly $fault: "client";
|
|
6030
|
-
Message?: string;
|
|
6099
|
+
Message?: string | undefined;
|
|
6031
6100
|
/**
|
|
6032
6101
|
* <p>Limit exceeded.</p>
|
|
6033
6102
|
* @public
|
|
6034
6103
|
*/
|
|
6035
|
-
ResourceType?: ExceptionResourceType;
|
|
6104
|
+
ResourceType?: ExceptionResourceType | undefined;
|
|
6036
6105
|
/**
|
|
6037
6106
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
6038
6107
|
* @public
|
|
6039
6108
|
*/
|
|
6040
|
-
RequestId?: string;
|
|
6109
|
+
RequestId?: string | undefined;
|
|
6041
6110
|
/**
|
|
6042
6111
|
* @internal
|
|
6043
6112
|
*/
|
|
@@ -6053,12 +6122,12 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
6053
6122
|
export declare class UnsupportedUserEditionException extends __BaseException {
|
|
6054
6123
|
readonly name: "UnsupportedUserEditionException";
|
|
6055
6124
|
readonly $fault: "client";
|
|
6056
|
-
Message?: string;
|
|
6125
|
+
Message?: string | undefined;
|
|
6057
6126
|
/**
|
|
6058
6127
|
* <p>The Amazon Web Services request ID for this request.</p>
|
|
6059
6128
|
* @public
|
|
6060
6129
|
*/
|
|
6061
|
-
RequestId?: string;
|
|
6130
|
+
RequestId?: string | undefined;
|
|
6062
6131
|
/**
|
|
6063
6132
|
* @internal
|
|
6064
6133
|
*/
|
|
@@ -6085,7 +6154,7 @@ export interface DataPointDrillUpDownOption {
|
|
|
6085
6154
|
* <p>The status of the drill down options of data points.</p>
|
|
6086
6155
|
* @public
|
|
6087
6156
|
*/
|
|
6088
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6157
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6089
6158
|
}
|
|
6090
6159
|
/**
|
|
6091
6160
|
* <p>The data point menu options of a dashboard.</p>
|
|
@@ -6096,7 +6165,7 @@ export interface DataPointMenuLabelOption {
|
|
|
6096
6165
|
* <p>The status of the data point menu options.</p>
|
|
6097
6166
|
* @public
|
|
6098
6167
|
*/
|
|
6099
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6168
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6100
6169
|
}
|
|
6101
6170
|
/**
|
|
6102
6171
|
* <p>The data point tooltip options.</p>
|
|
@@ -6107,7 +6176,7 @@ export interface DataPointTooltipOption {
|
|
|
6107
6176
|
* <p>The status of the data point tool tip options.</p>
|
|
6108
6177
|
* @public
|
|
6109
6178
|
*/
|
|
6110
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6179
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6111
6180
|
}
|
|
6112
6181
|
/**
|
|
6113
6182
|
* <p>Export to .csv option.</p>
|
|
@@ -6118,7 +6187,7 @@ export interface ExportToCSVOption {
|
|
|
6118
6187
|
* <p>Availability status.</p>
|
|
6119
6188
|
* @public
|
|
6120
6189
|
*/
|
|
6121
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6190
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6122
6191
|
}
|
|
6123
6192
|
/**
|
|
6124
6193
|
* <p>Determines whether or not hidden fields are visible on exported dashbaords.</p>
|
|
@@ -6129,7 +6198,7 @@ export interface ExportWithHiddenFieldsOption {
|
|
|
6129
6198
|
* <p>The status of the export with hidden fields options.</p>
|
|
6130
6199
|
* @public
|
|
6131
6200
|
*/
|
|
6132
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6201
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6133
6202
|
}
|
|
6134
6203
|
/**
|
|
6135
6204
|
* @public
|
|
@@ -6152,7 +6221,7 @@ export interface SheetControlsOption {
|
|
|
6152
6221
|
* <p>Visibility state.</p>
|
|
6153
6222
|
* @public
|
|
6154
6223
|
*/
|
|
6155
|
-
VisibilityState?: DashboardUIState;
|
|
6224
|
+
VisibilityState?: DashboardUIState | undefined;
|
|
6156
6225
|
}
|
|
6157
6226
|
/**
|
|
6158
6227
|
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
@@ -6163,7 +6232,7 @@ export interface SheetLayoutElementMaximizationOption {
|
|
|
6163
6232
|
* <p>The status of the sheet layout maximization options of a dashbaord.</p>
|
|
6164
6233
|
* @public
|
|
6165
6234
|
*/
|
|
6166
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6235
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6167
6236
|
}
|
|
6168
6237
|
/**
|
|
6169
6238
|
* <p>The axis sort options for a visual.</p>
|
|
@@ -6174,7 +6243,7 @@ export interface VisualAxisSortOption {
|
|
|
6174
6243
|
* <p>The availaiblity status of a visual's axis sort options.</p>
|
|
6175
6244
|
* @public
|
|
6176
6245
|
*/
|
|
6177
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6246
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6178
6247
|
}
|
|
6179
6248
|
/**
|
|
6180
6249
|
* <p>Determines if hidden fields are included in an exported dashboard.</p>
|
|
@@ -6185,7 +6254,7 @@ export interface ExportHiddenFieldsOption {
|
|
|
6185
6254
|
* <p>The status of the export hidden fields options of a dashbaord.</p>
|
|
6186
6255
|
* @public
|
|
6187
6256
|
*/
|
|
6188
|
-
AvailabilityStatus?: DashboardBehavior;
|
|
6257
|
+
AvailabilityStatus?: DashboardBehavior | undefined;
|
|
6189
6258
|
}
|
|
6190
6259
|
/**
|
|
6191
6260
|
* <p>The visual publish options of a visual in a dashboard</p>
|
|
@@ -6196,7 +6265,7 @@ export interface DashboardVisualPublishOptions {
|
|
|
6196
6265
|
* <p>Determines if hidden fields are included in an exported dashboard.</p>
|
|
6197
6266
|
* @public
|
|
6198
6267
|
*/
|
|
6199
|
-
ExportHiddenFieldsOption?: ExportHiddenFieldsOption;
|
|
6268
|
+
ExportHiddenFieldsOption?: ExportHiddenFieldsOption | undefined;
|
|
6200
6269
|
}
|
|
6201
6270
|
/**
|
|
6202
6271
|
* <p>Dashboard publish options.</p>
|
|
@@ -6207,59 +6276,59 @@ export interface DashboardPublishOptions {
|
|
|
6207
6276
|
* <p>Ad hoc (one-time) filtering option.</p>
|
|
6208
6277
|
* @public
|
|
6209
6278
|
*/
|
|
6210
|
-
AdHocFilteringOption?: AdHocFilteringOption;
|
|
6279
|
+
AdHocFilteringOption?: AdHocFilteringOption | undefined;
|
|
6211
6280
|
/**
|
|
6212
6281
|
* <p>Export to .csv option.</p>
|
|
6213
6282
|
* @public
|
|
6214
6283
|
*/
|
|
6215
|
-
ExportToCSVOption?: ExportToCSVOption;
|
|
6284
|
+
ExportToCSVOption?: ExportToCSVOption | undefined;
|
|
6216
6285
|
/**
|
|
6217
6286
|
* <p>Sheet controls option.</p>
|
|
6218
6287
|
* @public
|
|
6219
6288
|
*/
|
|
6220
|
-
SheetControlsOption?: SheetControlsOption;
|
|
6289
|
+
SheetControlsOption?: SheetControlsOption | undefined;
|
|
6221
6290
|
/**
|
|
6222
6291
|
* @deprecated
|
|
6223
6292
|
*
|
|
6224
6293
|
* <p>The visual publish options of a visual in a dashboard.</p>
|
|
6225
6294
|
* @public
|
|
6226
6295
|
*/
|
|
6227
|
-
VisualPublishOptions?: DashboardVisualPublishOptions;
|
|
6296
|
+
VisualPublishOptions?: DashboardVisualPublishOptions | undefined;
|
|
6228
6297
|
/**
|
|
6229
6298
|
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
6230
6299
|
* @public
|
|
6231
6300
|
*/
|
|
6232
|
-
SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption;
|
|
6301
|
+
SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption | undefined;
|
|
6233
6302
|
/**
|
|
6234
6303
|
* <p>The menu options of a visual in a dashboard.</p>
|
|
6235
6304
|
* @public
|
|
6236
6305
|
*/
|
|
6237
|
-
VisualMenuOption?: VisualMenuOption;
|
|
6306
|
+
VisualMenuOption?: VisualMenuOption | undefined;
|
|
6238
6307
|
/**
|
|
6239
6308
|
* <p>The axis sort options of a dashboard.</p>
|
|
6240
6309
|
* @public
|
|
6241
6310
|
*/
|
|
6242
|
-
VisualAxisSortOption?: VisualAxisSortOption;
|
|
6311
|
+
VisualAxisSortOption?: VisualAxisSortOption | undefined;
|
|
6243
6312
|
/**
|
|
6244
6313
|
* <p>Determines if hidden fields are exported with a dashboard.</p>
|
|
6245
6314
|
* @public
|
|
6246
6315
|
*/
|
|
6247
|
-
ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption;
|
|
6316
|
+
ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption | undefined;
|
|
6248
6317
|
/**
|
|
6249
6318
|
* <p>The drill-down options of data points in a dashboard.</p>
|
|
6250
6319
|
* @public
|
|
6251
6320
|
*/
|
|
6252
|
-
DataPointDrillUpDownOption?: DataPointDrillUpDownOption;
|
|
6321
|
+
DataPointDrillUpDownOption?: DataPointDrillUpDownOption | undefined;
|
|
6253
6322
|
/**
|
|
6254
6323
|
* <p>The data point menu label options of a dashboard.</p>
|
|
6255
6324
|
* @public
|
|
6256
6325
|
*/
|
|
6257
|
-
DataPointMenuLabelOption?: DataPointMenuLabelOption;
|
|
6326
|
+
DataPointMenuLabelOption?: DataPointMenuLabelOption | undefined;
|
|
6258
6327
|
/**
|
|
6259
6328
|
* <p>The data point tool tip options of a dashboard.</p>
|
|
6260
6329
|
* @public
|
|
6261
6330
|
*/
|
|
6262
|
-
DataPointTooltipOption?: DataPointTooltipOption;
|
|
6331
|
+
DataPointTooltipOption?: DataPointTooltipOption | undefined;
|
|
6263
6332
|
}
|
|
6264
6333
|
/**
|
|
6265
6334
|
* <p>The contents of a dashboard.</p>
|
|
@@ -6276,41 +6345,41 @@ export interface DashboardVersionDefinition {
|
|
|
6276
6345
|
* <p>An array of sheet definitions for a dashboard.</p>
|
|
6277
6346
|
* @public
|
|
6278
6347
|
*/
|
|
6279
|
-
Sheets?: SheetDefinition[];
|
|
6348
|
+
Sheets?: SheetDefinition[] | undefined;
|
|
6280
6349
|
/**
|
|
6281
6350
|
* <p>An array of calculated field definitions for the dashboard.</p>
|
|
6282
6351
|
* @public
|
|
6283
6352
|
*/
|
|
6284
|
-
CalculatedFields?: CalculatedField[];
|
|
6353
|
+
CalculatedFields?: CalculatedField[] | undefined;
|
|
6285
6354
|
/**
|
|
6286
6355
|
* <p>The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.</p>
|
|
6287
6356
|
* <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>
|
|
6288
6357
|
* @public
|
|
6289
6358
|
*/
|
|
6290
|
-
ParameterDeclarations?: ParameterDeclaration[];
|
|
6359
|
+
ParameterDeclarations?: ParameterDeclaration[] | undefined;
|
|
6291
6360
|
/**
|
|
6292
6361
|
* <p>The filter definitions for a dashboard.</p>
|
|
6293
6362
|
* <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>
|
|
6294
6363
|
* @public
|
|
6295
6364
|
*/
|
|
6296
|
-
FilterGroups?: FilterGroup[];
|
|
6365
|
+
FilterGroups?: FilterGroup[] | undefined;
|
|
6297
6366
|
/**
|
|
6298
6367
|
* <p>An array of dashboard-level column configurations. Column configurations
|
|
6299
6368
|
* are used to set the default formatting for a column that
|
|
6300
6369
|
* is used throughout a dashboard. </p>
|
|
6301
6370
|
* @public
|
|
6302
6371
|
*/
|
|
6303
|
-
ColumnConfigurations?: ColumnConfiguration[];
|
|
6372
|
+
ColumnConfigurations?: ColumnConfiguration[] | undefined;
|
|
6304
6373
|
/**
|
|
6305
6374
|
* <p>The configuration for default analysis settings.</p>
|
|
6306
6375
|
* @public
|
|
6307
6376
|
*/
|
|
6308
|
-
AnalysisDefaults?: AnalysisDefaults;
|
|
6377
|
+
AnalysisDefaults?: AnalysisDefaults | undefined;
|
|
6309
6378
|
/**
|
|
6310
6379
|
* <p>An array of option definitions for a dashboard.</p>
|
|
6311
6380
|
* @public
|
|
6312
6381
|
*/
|
|
6313
|
-
Options?: AssetOptions;
|
|
6382
|
+
Options?: AssetOptions | undefined;
|
|
6314
6383
|
}
|
|
6315
6384
|
/**
|
|
6316
6385
|
* <p>A structure that contains the configuration of a shareable link to the dashboard.</p>
|
|
@@ -6321,7 +6390,7 @@ export interface LinkSharingConfiguration {
|
|
|
6321
6390
|
* <p>A structure that contains the permissions of a shareable link.</p>
|
|
6322
6391
|
* @public
|
|
6323
6392
|
*/
|
|
6324
|
-
Permissions?: ResourcePermission[];
|
|
6393
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
6325
6394
|
}
|
|
6326
6395
|
/**
|
|
6327
6396
|
* <p>Dashboard source template.</p>
|
|
@@ -6348,7 +6417,7 @@ export interface DashboardSourceEntity {
|
|
|
6348
6417
|
* <p>Source template.</p>
|
|
6349
6418
|
* @public
|
|
6350
6419
|
*/
|
|
6351
|
-
SourceTemplate?: DashboardSourceTemplate;
|
|
6420
|
+
SourceTemplate?: DashboardSourceTemplate | undefined;
|
|
6352
6421
|
}
|
|
6353
6422
|
/**
|
|
6354
6423
|
* @public
|
|
@@ -6375,7 +6444,7 @@ export interface CreateDashboardRequest {
|
|
|
6375
6444
|
* might accept multiple values. </p>
|
|
6376
6445
|
* @public
|
|
6377
6446
|
*/
|
|
6378
|
-
Parameters?: _Parameters;
|
|
6447
|
+
Parameters?: _Parameters | undefined;
|
|
6379
6448
|
/**
|
|
6380
6449
|
* <p>A structure that contains the permissions of the dashboard. You can use this structure
|
|
6381
6450
|
* for granting permissions by providing a list of IAM action information for each
|
|
@@ -6383,7 +6452,7 @@ export interface CreateDashboardRequest {
|
|
|
6383
6452
|
* <p>To specify no permissions, omit the permissions list.</p>
|
|
6384
6453
|
* @public
|
|
6385
6454
|
*/
|
|
6386
|
-
Permissions?: ResourcePermission[];
|
|
6455
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
6387
6456
|
/**
|
|
6388
6457
|
* <p>The entity that you are using as a source when you create the dashboard. In
|
|
6389
6458
|
* <code>SourceEntity</code>, you specify the type of object you're using as source. You
|
|
@@ -6403,18 +6472,18 @@ export interface CreateDashboardRequest {
|
|
|
6403
6472
|
* order for the request to be valid.</p>
|
|
6404
6473
|
* @public
|
|
6405
6474
|
*/
|
|
6406
|
-
SourceEntity?: DashboardSourceEntity;
|
|
6475
|
+
SourceEntity?: DashboardSourceEntity | undefined;
|
|
6407
6476
|
/**
|
|
6408
6477
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
6409
6478
|
* dashboard.</p>
|
|
6410
6479
|
* @public
|
|
6411
6480
|
*/
|
|
6412
|
-
Tags?: Tag[];
|
|
6481
|
+
Tags?: Tag[] | undefined;
|
|
6413
6482
|
/**
|
|
6414
6483
|
* <p>A description for the first version of the dashboard being created.</p>
|
|
6415
6484
|
* @public
|
|
6416
6485
|
*/
|
|
6417
|
-
VersionDescription?: string;
|
|
6486
|
+
VersionDescription?: string | undefined;
|
|
6418
6487
|
/**
|
|
6419
6488
|
* <p>Options for publishing the dashboard when you create it:</p>
|
|
6420
6489
|
* <ul>
|
|
@@ -6442,7 +6511,7 @@ export interface CreateDashboardRequest {
|
|
|
6442
6511
|
* </ul>
|
|
6443
6512
|
* @public
|
|
6444
6513
|
*/
|
|
6445
|
-
DashboardPublishOptions?: DashboardPublishOptions;
|
|
6514
|
+
DashboardPublishOptions?: DashboardPublishOptions | undefined;
|
|
6446
6515
|
/**
|
|
6447
6516
|
* <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
|
|
6448
6517
|
* you add a value for this field, it overrides the value that is used in the source
|
|
@@ -6450,7 +6519,7 @@ export interface CreateDashboardRequest {
|
|
|
6450
6519
|
* dashboard.</p>
|
|
6451
6520
|
* @public
|
|
6452
6521
|
*/
|
|
6453
|
-
ThemeArn?: string;
|
|
6522
|
+
ThemeArn?: string | undefined;
|
|
6454
6523
|
/**
|
|
6455
6524
|
* <p>The definition of a dashboard.</p>
|
|
6456
6525
|
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
@@ -6458,27 +6527,27 @@ export interface CreateDashboardRequest {
|
|
|
6458
6527
|
* order for the request to be valid.</p>
|
|
6459
6528
|
* @public
|
|
6460
6529
|
*/
|
|
6461
|
-
Definition?: DashboardVersionDefinition;
|
|
6530
|
+
Definition?: DashboardVersionDefinition | undefined;
|
|
6462
6531
|
/**
|
|
6463
6532
|
* <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
|
|
6464
6533
|
* @public
|
|
6465
6534
|
*/
|
|
6466
|
-
ValidationStrategy?: ValidationStrategy;
|
|
6535
|
+
ValidationStrategy?: ValidationStrategy | undefined;
|
|
6467
6536
|
/**
|
|
6468
6537
|
* <p>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</p>
|
|
6469
6538
|
* @public
|
|
6470
6539
|
*/
|
|
6471
|
-
FolderArns?: string[];
|
|
6540
|
+
FolderArns?: string[] | undefined;
|
|
6472
6541
|
/**
|
|
6473
6542
|
* <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
|
|
6474
6543
|
* @public
|
|
6475
6544
|
*/
|
|
6476
|
-
LinkSharingConfiguration?: LinkSharingConfiguration;
|
|
6545
|
+
LinkSharingConfiguration?: LinkSharingConfiguration | undefined;
|
|
6477
6546
|
/**
|
|
6478
6547
|
* <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
|
|
6479
6548
|
* @public
|
|
6480
6549
|
*/
|
|
6481
|
-
LinkEntities?: string[];
|
|
6550
|
+
LinkEntities?: string[] | undefined;
|
|
6482
6551
|
}
|
|
6483
6552
|
/**
|
|
6484
6553
|
* @public
|
|
@@ -6488,33 +6557,33 @@ export interface CreateDashboardResponse {
|
|
|
6488
6557
|
* <p>The ARN of the dashboard.</p>
|
|
6489
6558
|
* @public
|
|
6490
6559
|
*/
|
|
6491
|
-
Arn?: string;
|
|
6560
|
+
Arn?: string | undefined;
|
|
6492
6561
|
/**
|
|
6493
6562
|
* <p>The ARN of the dashboard, including the version number of the first version that is
|
|
6494
6563
|
* created.</p>
|
|
6495
6564
|
* @public
|
|
6496
6565
|
*/
|
|
6497
|
-
VersionArn?: string;
|
|
6566
|
+
VersionArn?: string | undefined;
|
|
6498
6567
|
/**
|
|
6499
6568
|
* <p>The ID for the dashboard.</p>
|
|
6500
6569
|
* @public
|
|
6501
6570
|
*/
|
|
6502
|
-
DashboardId?: string;
|
|
6571
|
+
DashboardId?: string | undefined;
|
|
6503
6572
|
/**
|
|
6504
6573
|
* <p>The status of the dashboard creation request.</p>
|
|
6505
6574
|
* @public
|
|
6506
6575
|
*/
|
|
6507
|
-
CreationStatus?: ResourceStatus;
|
|
6576
|
+
CreationStatus?: ResourceStatus | undefined;
|
|
6508
6577
|
/**
|
|
6509
6578
|
* <p>The HTTP status of the request.</p>
|
|
6510
6579
|
* @public
|
|
6511
6580
|
*/
|
|
6512
|
-
Status?: number;
|
|
6581
|
+
Status?: number | undefined;
|
|
6513
6582
|
/**
|
|
6514
6583
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6515
6584
|
* @public
|
|
6516
6585
|
*/
|
|
6517
|
-
RequestId?: string;
|
|
6586
|
+
RequestId?: string | undefined;
|
|
6518
6587
|
}
|
|
6519
6588
|
/**
|
|
6520
6589
|
* <p>The default values of a date time parameter.</p>
|
|
@@ -6525,7 +6594,7 @@ export interface DateTimeDatasetParameterDefaultValues {
|
|
|
6525
6594
|
* <p>A list of static default values for a given date time parameter.</p>
|
|
6526
6595
|
* @public
|
|
6527
6596
|
*/
|
|
6528
|
-
StaticValues?: Date[];
|
|
6597
|
+
StaticValues?: Date[] | undefined;
|
|
6529
6598
|
}
|
|
6530
6599
|
/**
|
|
6531
6600
|
* @public
|
|
@@ -6563,12 +6632,12 @@ export interface DateTimeDatasetParameter {
|
|
|
6563
6632
|
* <p>The time granularity of the date time parameter.</p>
|
|
6564
6633
|
* @public
|
|
6565
6634
|
*/
|
|
6566
|
-
TimeGranularity?: TimeGranularity;
|
|
6635
|
+
TimeGranularity?: TimeGranularity | undefined;
|
|
6567
6636
|
/**
|
|
6568
6637
|
* <p>A list of default values for a given date time parameter. This structure only accepts static values.</p>
|
|
6569
6638
|
* @public
|
|
6570
6639
|
*/
|
|
6571
|
-
DefaultValues?: DateTimeDatasetParameterDefaultValues;
|
|
6640
|
+
DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined;
|
|
6572
6641
|
}
|
|
6573
6642
|
/**
|
|
6574
6643
|
* <p>The default values of a decimal parameter.</p>
|
|
@@ -6579,7 +6648,7 @@ export interface DecimalDatasetParameterDefaultValues {
|
|
|
6579
6648
|
* <p>A list of static default values for a given decimal parameter.</p>
|
|
6580
6649
|
* @public
|
|
6581
6650
|
*/
|
|
6582
|
-
StaticValues?: number[];
|
|
6651
|
+
StaticValues?: number[] | undefined;
|
|
6583
6652
|
}
|
|
6584
6653
|
/**
|
|
6585
6654
|
* <p>A decimal parameter for a dataset.</p>
|
|
@@ -6605,7 +6674,7 @@ export interface DecimalDatasetParameter {
|
|
|
6605
6674
|
* <p>A list of default values for a given decimal parameter. This structure only accepts static values.</p>
|
|
6606
6675
|
* @public
|
|
6607
6676
|
*/
|
|
6608
|
-
DefaultValues?: DecimalDatasetParameterDefaultValues;
|
|
6677
|
+
DefaultValues?: DecimalDatasetParameterDefaultValues | undefined;
|
|
6609
6678
|
}
|
|
6610
6679
|
/**
|
|
6611
6680
|
* <p>The default values of an integer parameter.</p>
|
|
@@ -6616,7 +6685,7 @@ export interface IntegerDatasetParameterDefaultValues {
|
|
|
6616
6685
|
* <p>A list of static default values for a given integer parameter.</p>
|
|
6617
6686
|
* @public
|
|
6618
6687
|
*/
|
|
6619
|
-
StaticValues?: number[];
|
|
6688
|
+
StaticValues?: number[] | undefined;
|
|
6620
6689
|
}
|
|
6621
6690
|
/**
|
|
6622
6691
|
* <p>An integer parameter for a dataset.</p>
|
|
@@ -6642,7 +6711,7 @@ export interface IntegerDatasetParameter {
|
|
|
6642
6711
|
* <p>A list of default values for a given integer parameter. This structure only accepts static values.</p>
|
|
6643
6712
|
* @public
|
|
6644
6713
|
*/
|
|
6645
|
-
DefaultValues?: IntegerDatasetParameterDefaultValues;
|
|
6714
|
+
DefaultValues?: IntegerDatasetParameterDefaultValues | undefined;
|
|
6646
6715
|
}
|
|
6647
6716
|
/**
|
|
6648
6717
|
* <p>The default values of a string parameter.</p>
|
|
@@ -6653,7 +6722,7 @@ export interface StringDatasetParameterDefaultValues {
|
|
|
6653
6722
|
* <p>A list of static default values for a given string parameter.</p>
|
|
6654
6723
|
* @public
|
|
6655
6724
|
*/
|
|
6656
|
-
StaticValues?: string[];
|
|
6725
|
+
StaticValues?: string[] | undefined;
|
|
6657
6726
|
}
|
|
6658
6727
|
/**
|
|
6659
6728
|
* <p>A string parameter for a dataset.</p>
|
|
@@ -6679,7 +6748,7 @@ export interface StringDatasetParameter {
|
|
|
6679
6748
|
* <p>A list of default values for a given string dataset parameter type. This structure only accepts static values.</p>
|
|
6680
6749
|
* @public
|
|
6681
6750
|
*/
|
|
6682
|
-
DefaultValues?: StringDatasetParameterDefaultValues;
|
|
6751
|
+
DefaultValues?: StringDatasetParameterDefaultValues | undefined;
|
|
6683
6752
|
}
|
|
6684
6753
|
/**
|
|
6685
6754
|
* <p>A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.</p>
|
|
@@ -6690,22 +6759,22 @@ export interface DatasetParameter {
|
|
|
6690
6759
|
* <p>A string parameter that is created in the dataset.</p>
|
|
6691
6760
|
* @public
|
|
6692
6761
|
*/
|
|
6693
|
-
StringDatasetParameter?: StringDatasetParameter;
|
|
6762
|
+
StringDatasetParameter?: StringDatasetParameter | undefined;
|
|
6694
6763
|
/**
|
|
6695
6764
|
* <p>A decimal parameter that is created in the dataset.</p>
|
|
6696
6765
|
* @public
|
|
6697
6766
|
*/
|
|
6698
|
-
DecimalDatasetParameter?: DecimalDatasetParameter;
|
|
6767
|
+
DecimalDatasetParameter?: DecimalDatasetParameter | undefined;
|
|
6699
6768
|
/**
|
|
6700
6769
|
* <p>An integer parameter that is created in the dataset.</p>
|
|
6701
6770
|
* @public
|
|
6702
6771
|
*/
|
|
6703
|
-
IntegerDatasetParameter?: IntegerDatasetParameter;
|
|
6772
|
+
IntegerDatasetParameter?: IntegerDatasetParameter | undefined;
|
|
6704
6773
|
/**
|
|
6705
6774
|
* <p>A date time parameter that is created in the dataset.</p>
|
|
6706
6775
|
* @public
|
|
6707
6776
|
*/
|
|
6708
|
-
DateTimeDatasetParameter?: DateTimeDatasetParameter;
|
|
6777
|
+
DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined;
|
|
6709
6778
|
}
|
|
6710
6779
|
/**
|
|
6711
6780
|
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
@@ -6716,12 +6785,12 @@ export interface DataSetUsageConfiguration {
|
|
|
6716
6785
|
* <p>An option that controls whether a child dataset of a direct query can use this dataset as a source.</p>
|
|
6717
6786
|
* @public
|
|
6718
6787
|
*/
|
|
6719
|
-
DisableUseAsDirectQuerySource?: boolean;
|
|
6788
|
+
DisableUseAsDirectQuerySource?: boolean | undefined;
|
|
6720
6789
|
/**
|
|
6721
6790
|
* <p>An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.</p>
|
|
6722
6791
|
* @public
|
|
6723
6792
|
*/
|
|
6724
|
-
DisableUseAsImportedSource?: boolean;
|
|
6793
|
+
DisableUseAsImportedSource?: boolean | undefined;
|
|
6725
6794
|
}
|
|
6726
6795
|
/**
|
|
6727
6796
|
* <p>A FieldFolder element is a folder that contains fields and nested subfolders.</p>
|
|
@@ -6732,12 +6801,12 @@ export interface FieldFolder {
|
|
|
6732
6801
|
* <p>The description for a field folder.</p>
|
|
6733
6802
|
* @public
|
|
6734
6803
|
*/
|
|
6735
|
-
description?: string;
|
|
6804
|
+
description?: string | undefined;
|
|
6736
6805
|
/**
|
|
6737
6806
|
* <p>A folder has a list of columns. A column can only be in one folder.</p>
|
|
6738
6807
|
* @public
|
|
6739
6808
|
*/
|
|
6740
|
-
columns?: string[];
|
|
6809
|
+
columns?: string[] | undefined;
|
|
6741
6810
|
}
|
|
6742
6811
|
/**
|
|
6743
6812
|
* @public
|
|
@@ -6772,22 +6841,22 @@ export interface NewDefaultValues {
|
|
|
6772
6841
|
* <p>A list of static default values for a given string parameter.</p>
|
|
6773
6842
|
* @public
|
|
6774
6843
|
*/
|
|
6775
|
-
StringStaticValues?: string[];
|
|
6844
|
+
StringStaticValues?: string[] | undefined;
|
|
6776
6845
|
/**
|
|
6777
6846
|
* <p>A list of static default values for a given decimal parameter.</p>
|
|
6778
6847
|
* @public
|
|
6779
6848
|
*/
|
|
6780
|
-
DecimalStaticValues?: number[];
|
|
6849
|
+
DecimalStaticValues?: number[] | undefined;
|
|
6781
6850
|
/**
|
|
6782
6851
|
* <p>A list of static default values for a given date time parameter.</p>
|
|
6783
6852
|
* @public
|
|
6784
6853
|
*/
|
|
6785
|
-
DateTimeStaticValues?: Date[];
|
|
6854
|
+
DateTimeStaticValues?: Date[] | undefined;
|
|
6786
6855
|
/**
|
|
6787
6856
|
* <p>A list of static default values for a given integer parameter.</p>
|
|
6788
6857
|
* @public
|
|
6789
6858
|
*/
|
|
6790
|
-
IntegerStaticValues?: number[];
|
|
6859
|
+
IntegerStaticValues?: number[] | undefined;
|
|
6791
6860
|
}
|
|
6792
6861
|
/**
|
|
6793
6862
|
* <p>A transform operation that overrides the dataset parameter values that are defined in another dataset.</p>
|
|
@@ -6803,12 +6872,12 @@ export interface OverrideDatasetParameterOperation {
|
|
|
6803
6872
|
* <p>The new name for the parameter.</p>
|
|
6804
6873
|
* @public
|
|
6805
6874
|
*/
|
|
6806
|
-
NewParameterName?: string;
|
|
6875
|
+
NewParameterName?: string | undefined;
|
|
6807
6876
|
/**
|
|
6808
6877
|
* <p>The new default values for the parameter.</p>
|
|
6809
6878
|
* @public
|
|
6810
6879
|
*/
|
|
6811
|
-
NewDefaultValues?: NewDefaultValues;
|
|
6880
|
+
NewDefaultValues?: NewDefaultValues | undefined;
|
|
6812
6881
|
}
|
|
6813
6882
|
/**
|
|
6814
6883
|
* <p>A transform operation that projects columns. Operations that come after a projection
|
|
@@ -7042,7 +7111,7 @@ export interface JoinKeyProperties {
|
|
|
7042
7111
|
* a join key. This is used by Amazon QuickSight to optimize query performance.</p>
|
|
7043
7112
|
* @public
|
|
7044
7113
|
*/
|
|
7045
|
-
UniqueKey?: boolean;
|
|
7114
|
+
UniqueKey?: boolean | undefined;
|
|
7046
7115
|
}
|
|
7047
7116
|
/**
|
|
7048
7117
|
* @public
|
|
@@ -7077,12 +7146,12 @@ export interface JoinInstruction {
|
|
|
7077
7146
|
* <p>Join key properties of the left operand.</p>
|
|
7078
7147
|
* @public
|
|
7079
7148
|
*/
|
|
7080
|
-
LeftJoinKeyProperties?: JoinKeyProperties;
|
|
7149
|
+
LeftJoinKeyProperties?: JoinKeyProperties | undefined;
|
|
7081
7150
|
/**
|
|
7082
7151
|
* <p>Join key properties of the right operand.</p>
|
|
7083
7152
|
* @public
|
|
7084
7153
|
*/
|
|
7085
|
-
RightJoinKeyProperties?: JoinKeyProperties;
|
|
7154
|
+
RightJoinKeyProperties?: JoinKeyProperties | undefined;
|
|
7086
7155
|
/**
|
|
7087
7156
|
* <p>The type of join that it is.</p>
|
|
7088
7157
|
* @public
|
|
@@ -7104,17 +7173,17 @@ export interface LogicalTableSource {
|
|
|
7104
7173
|
* <p>Specifies the result of a join of two logical tables.</p>
|
|
7105
7174
|
* @public
|
|
7106
7175
|
*/
|
|
7107
|
-
JoinInstruction?: JoinInstruction;
|
|
7176
|
+
JoinInstruction?: JoinInstruction | undefined;
|
|
7108
7177
|
/**
|
|
7109
7178
|
* <p>Physical table ID.</p>
|
|
7110
7179
|
* @public
|
|
7111
7180
|
*/
|
|
7112
|
-
PhysicalTableId?: string;
|
|
7181
|
+
PhysicalTableId?: string | undefined;
|
|
7113
7182
|
/**
|
|
7114
7183
|
* <p>The Amazon Resource Number (ARN) of the parent dataset.</p>
|
|
7115
7184
|
* @public
|
|
7116
7185
|
*/
|
|
7117
|
-
DataSetArn?: string;
|
|
7186
|
+
DataSetArn?: string | undefined;
|
|
7118
7187
|
}
|
|
7119
7188
|
/**
|
|
7120
7189
|
* <p>A <i>logical table</i> is a unit that joins and that data
|
|
@@ -7133,7 +7202,7 @@ export interface LogicalTable {
|
|
|
7133
7202
|
* <p>Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. </p>
|
|
7134
7203
|
* @public
|
|
7135
7204
|
*/
|
|
7136
|
-
DataTransforms?: TransformOperation[];
|
|
7205
|
+
DataTransforms?: TransformOperation[] | undefined;
|
|
7137
7206
|
/**
|
|
7138
7207
|
* <p>Source of this logical table.</p>
|
|
7139
7208
|
* @public
|
|
@@ -7176,7 +7245,7 @@ export interface InputColumn {
|
|
|
7176
7245
|
* <p>The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.</p>
|
|
7177
7246
|
* @public
|
|
7178
7247
|
*/
|
|
7179
|
-
SubType?: ColumnDataSubType;
|
|
7248
|
+
SubType?: ColumnDataSubType | undefined;
|
|
7180
7249
|
}
|
|
7181
7250
|
/**
|
|
7182
7251
|
* <p>A physical table type built from the results of the custom SQL query.</p>
|
|
@@ -7202,7 +7271,7 @@ export interface CustomSql {
|
|
|
7202
7271
|
* <p>The column schema from the SQL query result set.</p>
|
|
7203
7272
|
* @public
|
|
7204
7273
|
*/
|
|
7205
|
-
Columns?: InputColumn[];
|
|
7274
|
+
Columns?: InputColumn[] | undefined;
|
|
7206
7275
|
}
|
|
7207
7276
|
/**
|
|
7208
7277
|
* <p>A physical table type for relational data sources.</p>
|
|
@@ -7218,12 +7287,12 @@ export interface RelationalTable {
|
|
|
7218
7287
|
* <p>The catalog associated with a table.</p>
|
|
7219
7288
|
* @public
|
|
7220
7289
|
*/
|
|
7221
|
-
Catalog?: string;
|
|
7290
|
+
Catalog?: string | undefined;
|
|
7222
7291
|
/**
|
|
7223
7292
|
* <p>The schema name. This name applies to certain relational database engines.</p>
|
|
7224
7293
|
* @public
|
|
7225
7294
|
*/
|
|
7226
|
-
Schema?: string;
|
|
7295
|
+
Schema?: string | undefined;
|
|
7227
7296
|
/**
|
|
7228
7297
|
* <p>The name of the relational table.</p>
|
|
7229
7298
|
* @public
|
|
@@ -7272,27 +7341,27 @@ export interface UploadSettings {
|
|
|
7272
7341
|
* <p>File format.</p>
|
|
7273
7342
|
* @public
|
|
7274
7343
|
*/
|
|
7275
|
-
Format?: FileFormat;
|
|
7344
|
+
Format?: FileFormat | undefined;
|
|
7276
7345
|
/**
|
|
7277
7346
|
* <p>A row number to start reading data from.</p>
|
|
7278
7347
|
* @public
|
|
7279
7348
|
*/
|
|
7280
|
-
StartFromRow?: number;
|
|
7349
|
+
StartFromRow?: number | undefined;
|
|
7281
7350
|
/**
|
|
7282
7351
|
* <p>Whether the file has a header row, or the files each have a header row.</p>
|
|
7283
7352
|
* @public
|
|
7284
7353
|
*/
|
|
7285
|
-
ContainsHeader?: boolean;
|
|
7354
|
+
ContainsHeader?: boolean | undefined;
|
|
7286
7355
|
/**
|
|
7287
7356
|
* <p>Text qualifier.</p>
|
|
7288
7357
|
* @public
|
|
7289
7358
|
*/
|
|
7290
|
-
TextQualifier?: TextQualifier;
|
|
7359
|
+
TextQualifier?: TextQualifier | undefined;
|
|
7291
7360
|
/**
|
|
7292
7361
|
* <p>The delimiter between values in the file.</p>
|
|
7293
7362
|
* @public
|
|
7294
7363
|
*/
|
|
7295
|
-
Delimiter?: string;
|
|
7364
|
+
Delimiter?: string | undefined;
|
|
7296
7365
|
}
|
|
7297
7366
|
/**
|
|
7298
7367
|
* <p>A physical table type for an S3 data source.</p>
|
|
@@ -7308,7 +7377,7 @@ export interface S3Source {
|
|
|
7308
7377
|
* <p>Information about the format for the S3 source file or files.</p>
|
|
7309
7378
|
* @public
|
|
7310
7379
|
*/
|
|
7311
|
-
UploadSettings?: UploadSettings;
|
|
7380
|
+
UploadSettings?: UploadSettings | undefined;
|
|
7312
7381
|
/**
|
|
7313
7382
|
* <p>A physical table type for an S3 data source.</p>
|
|
7314
7383
|
* <note>
|
|
@@ -7400,56 +7469,6 @@ export declare const RowLevelPermissionPolicy: {
|
|
|
7400
7469
|
* @public
|
|
7401
7470
|
*/
|
|
7402
7471
|
export type RowLevelPermissionPolicy = (typeof RowLevelPermissionPolicy)[keyof typeof RowLevelPermissionPolicy];
|
|
7403
|
-
/**
|
|
7404
|
-
* @public
|
|
7405
|
-
* @enum
|
|
7406
|
-
*/
|
|
7407
|
-
export declare const Status: {
|
|
7408
|
-
readonly DISABLED: "DISABLED";
|
|
7409
|
-
readonly ENABLED: "ENABLED";
|
|
7410
|
-
};
|
|
7411
|
-
/**
|
|
7412
|
-
* @public
|
|
7413
|
-
*/
|
|
7414
|
-
export type Status = (typeof Status)[keyof typeof Status];
|
|
7415
|
-
/**
|
|
7416
|
-
* <p>Information about a dataset that contains permissions for row-level security (RLS).
|
|
7417
|
-
* The permissions dataset maps fields to users or groups. For more information, see
|
|
7418
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User
|
|
7419
|
-
* Guide</i>.</p>
|
|
7420
|
-
* <p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is
|
|
7421
|
-
* not supported for new RLS datasets.</p>
|
|
7422
|
-
* @public
|
|
7423
|
-
*/
|
|
7424
|
-
export interface RowLevelPermissionDataSet {
|
|
7425
|
-
/**
|
|
7426
|
-
* <p>The namespace associated with the dataset that contains permissions for RLS.</p>
|
|
7427
|
-
* @public
|
|
7428
|
-
*/
|
|
7429
|
-
Namespace?: string;
|
|
7430
|
-
/**
|
|
7431
|
-
* <p>The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.</p>
|
|
7432
|
-
* @public
|
|
7433
|
-
*/
|
|
7434
|
-
Arn: string | undefined;
|
|
7435
|
-
/**
|
|
7436
|
-
* <p>The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code>
|
|
7437
|
-
* is included for backward compatibility only.</p>
|
|
7438
|
-
* @public
|
|
7439
|
-
*/
|
|
7440
|
-
PermissionPolicy: RowLevelPermissionPolicy | undefined;
|
|
7441
|
-
/**
|
|
7442
|
-
* <p>The user or group rules associated with the dataset that contains permissions for RLS.</p>
|
|
7443
|
-
* <p>By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are required, and <code>Namespace</code> must not exist.</p>
|
|
7444
|
-
* @public
|
|
7445
|
-
*/
|
|
7446
|
-
FormatVersion?: RowLevelPermissionFormatVersion;
|
|
7447
|
-
/**
|
|
7448
|
-
* <p>The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>. If disabled, the status is <code>DISABLED</code>.</p>
|
|
7449
|
-
* @public
|
|
7450
|
-
*/
|
|
7451
|
-
Status?: Status;
|
|
7452
|
-
}
|
|
7453
7472
|
/**
|
|
7454
7473
|
* @internal
|
|
7455
7474
|
*/
|